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. 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:

<Directory /var/www/kanboard/>
    AllowOverride FileInfo Options=All,MultiViews AuthConfig
</Directory>

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.

Nginx configuration example

In the section server of your Nginx config file you can use this example:

index index.php;

location / {
    try_files $uri $uri/ /index.php$is_args$args;

    # If Kanboard is under a subfolder
    # try_files $uri $uri/ /kanboard/index.php;
}

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;
}

# Deny access to the directory data
location ~* /data {
    deny all;
    return 404;
}

# Deny access to .htaccess
location ~ /\.ht {
    deny all;
    return 404;
}

In your Kanboard config.php:

define('ENABLE_URL_REWRITE', true);

Adapt the example above according to your own configuration.

IIS configuration example

  1. Download and install the Rewrite module for IIS: Download link
  2. Create a web.config in you installation folder:
<?xml version="1.0"?>
<configuration>
    <system.webServer>
        <defaultDocument>
            <files>
                <clear />
                <add value="index.php" />
            </files>
        </defaultDocument>
        <rewrite>
            <rules>
                <rule name="Kanboard URL Rewrite" 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:

define('ENABLE_URL_REWRITE', true);

Adapt the example above according to your own configuration.