summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorFrederic Guillot <fred@kanboard.net>2015-07-12 15:38:40 -0400
committerFrederic Guillot <fred@kanboard.net>2015-07-12 15:38:40 -0400
commit12f2ffb66381f441ac34c1497e78c02f97695e7d (patch)
tree8dbeb512bd881b0122eaa1014927f2c711f802df /docs
parent99a341761053f42223aea674f36ab914c996b7f1 (diff)
Update docs
Diffstat (limited to 'docs')
-rw-r--r--docs/config.markdown7
-rw-r--r--docs/faq.markdown19
-rw-r--r--docs/index.markdown2
-rw-r--r--docs/nice-urls.markdown36
-rw-r--r--docs/recommended-configuration.markdown36
5 files changed, 81 insertions, 19 deletions
diff --git a/docs/config.markdown b/docs/config.markdown
index 081f9c71..ed9f5508 100644
--- a/docs/config.markdown
+++ b/docs/config.markdown
@@ -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
-------------------
diff --git a/docs/faq.markdown b/docs/faq.markdown
index b4cf9148..3d542a30 100644
--- a/docs/faq.markdown
+++ b/docs/faq.markdown
@@ -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
---------------------------------------------------------
diff --git a/docs/index.markdown b/docs/index.markdown
index 410cc402..70ff0ec4 100644
--- a/docs/index.markdown
+++ b/docs/index.markdown
@@ -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
diff --git a/docs/nice-urls.markdown b/docs/nice-urls.markdown
new file mode 100644
index 00000000..38f7c41d
--- /dev/null
+++ b/docs/nice-urls.markdown
@@ -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.
diff --git a/docs/recommended-configuration.markdown b/docs/recommended-configuration.markdown
new file mode 100644
index 00000000..93b49723
--- /dev/null
+++ b/docs/recommended-configuration.markdown
@@ -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