summaryrefslogtreecommitdiff
path: root/doc/faq.markdown
blob: 76ee07aba5f8ea4a676430b5e798913efb9b99bb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
Frequently Asked Questions
==========================

Can you recommend a web hosting provider for Kanboard?
------------------------------------------------------

Kanboard works well with any great VPS hosting provider such as [Digital Ocean](https://www.digitalocean.com/?refcode=4b541f47aae4),
[Linode](https://www.linode.com/?r=4e381ac8a61116f40c60dc7438acc719610d8b11) or [Gandi](https://www.gandi.net/).

To have the best performances, choose a provider with fast disk I/O because Kanboard use Sqlite by default.
Avoid hosting providers that use a shared NFS mount point.


I get a blank page after installing or upgrading Kanboard
---------------------------------------------------------

- Check if you have installed all requirements on your server
- Check the PHP and Apache error logs
- Check if the files have the correct permission
- If you use an aggressive OPcode caching, reload your web-server or php-fpm


I have the error "There is no suitable CSPRNG installed on your system"
-----------------------------------------------------------------------

If you use PHP < 7.0, you need to have the openssl extension enabled or `/dev/urandom` accessible from the application if restricted by an `open_basedir` restriction.


Page not found and the URL seems wrong (&amp;amp;)
--------------------------------------------------

- The URL looks like `/?controller=auth&amp;action=login&amp;redirect_query=` instead of `?controller=auth&action=login&redirect_query=`
- Kanboard returns a "Page not found" error

This issue comes from your PHP configuration, the value of `arg_separator.output` is not the PHP's default, there is different ways to fix that:

Change the value directly in your `php.ini` if you can:

```
arg_separator.output = "&"
```

Override the value with a `.htaccess`:

```
php_value arg_separator.output "&"
```

Otherwise Kanboard will try to override the value directly in PHP.


Authentication failure with the API and Apache + PHP-FPM
--------------------------------------------------------

php-cgi under Apache does not pass HTTP Basic user/pass to PHP by default.
For this workaround to work, add these lines to your `.htaccess` file:

```
RewriteCond %{HTTP:Authorization} ^(.+)$
RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization}]
```


Known issues with eAccelerator
------------------------------

Kanboard doesn't work very well with [eAccelerator](http://eaccelerator.net).
The issue caused can be a blank page or an Apache crash:

```
[Wed Mar 05 21:36:56 2014] [notice] child pid 22630 exit signal Segmentation fault (11)
```

The best way to avoid this issue is to disable eAccelerator or define manually which files you want to cache with the config parameter `eaccelerator.filter`.

The project [eAccelerator seems dead and not updated since 2012](https://github.com/eaccelerator/eaccelerator/commits/master).
We recommend to switch to the last version of PHP because it's bundled with [OPcache](http://php.net/manual/en/intro.opcache.php).


Why the minimum requirement is PHP 5.3.3?
-----------------------------------------

Kanboard uses the function `password_hash()` to crypt passwords but it's available only for PHP >= 5.5.

However, there is a back-port for [older versions of PHP](https://github.com/ircmaxell/password_compat#requirements).
This library requires at least PHP 5.3.7 to work correctly.

Apparently, Centos and Debian back-ports security patches so PHP 5.3.3 should be ok.

Kanboard v1.0.10 and v1.0.11 requires at least PHP 5.3.7 but this change has been reverted to be compatible with PHP 5.3.3 with Kanboard >= v1.0.12


How to test Kanboard with the PHP built-in web server?
------------------------------------------------------

If you don't want to install a web server like Apache on localhost. You can test with the [embedded web server of PHP](http://www.php.net/manual/en/features.commandline.webserver.php):

```bash
unzip kanboard-VERSION.zip
cd kanboard
php -S localhost:8000
open http://localhost:8000/
```


How to install Kanboard on Yunohost?
------------------------------------

[YunoHost](https://yunohost.org/) is a server operating system aiming to make self-hosting accessible to everyone.

There is a [package to install Kanboard on Yunohost easily](https://github.com/mbugeia/kanboard_ynh).


Where can I find a list of related projects?
--------------------------------------------

- [Kanboard API python client by @freekoder](https://github.com/freekoder/kanboard-py)
- [Kanboard Presenter by David Eberlein](https://github.com/davideberlein/kanboard-presenter)
- [CSV2Kanboard by @ashbike](https://github.com/ashbike/csv2kanboard)
- [Kanboard for Yunohost by @mbugeia](https://github.com/mbugeia/kanboard_ynh)
- [Trello import script by @matueranet](https://github.com/matueranet/kanboard-import-trello)
- [Chrome extension by Timo](https://chrome.google.com/webstore/detail/kanboard-quickmenu/akjbeplnnihghabpgcfmfhfmifjljneh?utm_source=chrome-ntp-icon), [Source code](https://github.com/BlueTeck/kanboard_chrome_extension)
- [Python client script by @dzudek](https://gist.github.com/fguillot/84c70d4928eb1e0cb374)
- [Shell script for SQLite to MySQL/MariaDB migration by @oliviermaridat](https://github.com/oliviermaridat/kanboard-sqlite2mysql)
- [Git hooks for integration with Kanboard by Gene Pavlovsky](https://github.com/gene-pavlovsky/kanboard-git-hooks)


Are there some tutorials about Kanboard in other languages?
-----------------------------------------------------------

- [German article series about Kanboard](http://demaya.de/wp/2014/07/kanboard-eine-jira-alternative-im-detail-installation/)


Tips
----

- [Easy way to remove name constraint in SQLite database](https://github.com/kanboard/kanboard/issues/1508)