summaryrefslogtreecommitdiff
path: root/doc/nice-urls.markdown
diff options
context:
space:
mode:
authorGerardo Zamudio <gerardozamudio@users.noreply.github.com>2016-02-24 23:48:50 -0600
committerGerardo Zamudio <gerardozamudio@users.noreply.github.com>2016-02-24 23:48:50 -0600
commite4de6b3898b64b26d29aff31f21df5fda8055686 (patch)
tree575f8a65440f291d70a070d168eafca8c82a6459 /doc/nice-urls.markdown
parentd9ffbea174ea6524d0a22f8375ca8b3aa04a3c96 (diff)
parenta6540bc604c837d92c9368540c145606723e97f7 (diff)
Merge pull request #1 from fguillot/master
Update from upstream
Diffstat (limited to 'doc/nice-urls.markdown')
-rw-r--r--doc/nice-urls.markdown47
1 files changed, 41 insertions, 6 deletions
diff --git a/doc/nice-urls.markdown b/doc/nice-urls.markdown
index 82292889..9fbb3510 100644
--- a/doc/nice-urls.markdown
+++ b/doc/nice-urls.markdown
@@ -1,12 +1,12 @@
URL rewriting
=============
-Kanboard is able to work indifferently with url rewriting enabled or not.
+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.
+If you use Kanboard with Apache and with the mode rewrite enabled, nice URLs will be used automatically.
In case you get a "404 Not Found", you might need to set at least the following overrides for your DocumentRoot to get the .htaccess files working:
```sh
@@ -29,7 +29,7 @@ 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:
+To avoid the automatic detection of URL rewriting from the web server, you can enable this feature in your config file:
```php
define('ENABLE_URL_REWRITE', true);
@@ -38,9 +38,9 @@ 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
+- 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.
+Note: Kanboard always fallback to old school URLs when it's not configured, this configuration is optional.
Nginx configuration example
---------------------------
@@ -51,7 +51,7 @@ In the section `server` of your Nginx config file you can use this example:
index index.php;
location / {
- try_files $uri $uri/ /index.php;
+ try_files $uri $uri/ /index.php$is_args$args;
# If Kanboard is under a subfolder
# try_files $uri $uri/ /kanboard/index.php;
@@ -61,6 +61,7 @@ location ~ \.php$ {
try_files $uri =404;
fastcgi_split_path_info ^(.+\.php)(/.+)$;
fastcgi_pass unix:/var/run/php5-fpm.sock;
+ fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
fastcgi_index index.php;
include fastcgi_params;
}
@@ -85,3 +86,37 @@ define('ENABLE_URL_REWRITE', true);
```
Adapt the example above according to your own configuration.
+
+IIS configuration example
+---------------------------
+
+Create a web.config in you installation folder:
+
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<configuration>
+ <system.webServer>
+ <rewrite>
+ <rules>
+ <rule name="Imported Rule 1" stopProcessing="true">
+ <match url="^" ignoreCase="false" />
+ <conditions logicalGrouping="MatchAll">
+ <add input="{REQUEST_FILENAME}" matchType="IsFile" ignoreCase="false" negate="true" />
+ </conditions>
+ <action type="Rewrite" url="index.php" appendQueryString="true" />
+ </rule>
+ </rules>
+ </rewrite>
+ </system.webServer>
+</configuration>
+
+```
+
+In your Kanboard `config.php`:
+
+```php
+define('ENABLE_URL_REWRITE', true);
+```
+
+Adapt the example above according to your own configuration.
+