Update docs

This commit is contained in:
Frederic Guillot 2015-07-12 15:38:40 -04:00
parent 99a3417610
commit 12f2ffb663
5 changed files with 81 additions and 19 deletions

View File

@ -32,6 +32,13 @@ define('FILES_DIR', 'data/files/');
Don't forget the trailing slash.
Enable/disable url rewrite
--------------------------
```php
define('ENABLE_URL_REWRITE', false);
```
Email configuration
-------------------

View File

@ -10,25 +10,6 @@ Kanboard works well with any great VPS hosting provider such as [Digital Ocean](
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.
Which web browsers are supported?
---------------------------------
Kanboard have been tested on the following devices:
### Desktop
- Mozilla Firefox
- Safari
- Google Chrome
- Internet Explorer 11
### Tablets
- iPad (iOS)
- Nexus 7 (Android/Chrome)
I get a blank page after installing or upgrading Kanboard
---------------------------------------------------------

View File

@ -82,6 +82,7 @@ Technical details
### Installation
- [Recommended configuration](recommended-configuration.markdown)
- [Installation instructions](installation.markdown)
- [Upgrade Kanboard to a new version](update.markdown)
- [Installation on Ubuntu](ubuntu-installation.markdown)
@ -97,6 +98,7 @@ Technical details
### Configuration
- [Email configuration](email-configuration.markdown)
- [URL rewriting](nice-urls.markdown)
### Database

36
docs/nice-urls.markdown Normal file
View File

@ -0,0 +1,36 @@
URL rewriting
=============
Kanboard is able to work indifferently with url rewriting enabled or not.
- Example of URL rewritten: `/board/123`
- Otherwise: `?controller=board&action=show&project_id=123`
If you use Kanboard with Apache and with the mode rewrite enabled, nice urls will be used automatically.
URL Shortcuts
-------------
- Go to the task #123: **/t/123**
- Go to the board of the project #2: **/b/2**
- Go to the project calendar #5: **/c/5**
- Go to the list view of the project #8: **/l/8**
- Go to the project settings for the project id #42: **/p/42**
Configuration
-------------
By default, Kanboard will check if the Apache mode rewrite is enabled.
To avoid the automatic detection of url rewriting from the web server, you can enable this feature in your config file:
```
define('ENABLE_URL_REWRITE', true);
```
When this constant is at `true`:
- URLs generated from command line tools will be also converted
- If you use another web server than Apache, by example Nginx or Microsoft IIS, you have to configure yourself the url rewriting
Note: Kanboard always fallback to old school urls when it's not configured, this configuration is optional.

View File

@ -0,0 +1,36 @@
Recommended Configuration
=========================
Server side
-----------
- Modern Linux/Unix operating system: **Ubuntu/Debian or FreeBSD**
- Most recent version of PHP and Apache
- Use the Sqlite database only when you have a disk with fast I/O (SSD disks) otherwise use Mysql or Postgresql
Client side
-----------
- Use a modern browser: **Mozilla Firefox or Google Chrome or Safari**
Tested configurations
---------------------
The following configurations are tested with Kanboard but that doesn't mean all features are available:
### Server
- Ubuntu 14.04 LTS
- Debian 6, 7 and 8
- Centos 6.5 and 7.0
- Windows 2012 Server
- Windows 2008 Server
### Desktops
- Last version of Mozilla Firefox, Safari and Google Chrome
- Microsoft Internet Explorer 11
### Tablets
- iPad mini 3