Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
225 lines (144 sloc) 6.99 KB
.. author:: stratmaster <https://github.com/stratmaster>
.. tag:: lang-php
.. tag:: project-management
.. tag:: web

Logo

Kanboard

.. tag_list::

Kanboard is a free and open source Kanban project management software.


License

The software is licensed under MIT License. All relevant information can be found in the GitHub repository of the project.

Prerequisites

We're using :manual:`PHP <lang-php>` in the stable version 7.1:

[isabell@stardust ~]$ uberspace tools version show php
Using 'PHP' version: '7.1'
[isabell@stardust ~]$

The domain you want to use must be set up:

Installation

Download and extract TAR.GZ archive

Check the Kanboard website or GitHub for the latest release and copy the download link to the TAR.GZ file. Then cd to your :manual:`DocumentRoot <web-documentroot>` and use wget to download it. Replace the URL with the one you just copied.

Untar the archive to the html folder and then delete it. Replace the version in the file name with the one you downloaded.

Configuration

Setup your database

We recommend setting up a new MySQL database for Kanboard.

Configuration

Copy the config.default.php to config.php:

Now edit config.php file, change the Database driver to mysql and provide your MySQL credentials.

Go to https://isabell.uber.space/ and log in to your installation with the default login admin and password admin.

Warning

Do not forget to change the default user/password!

Check out the official Kanboard documentation for explanation of further configuration parameters.

Cron job

To work properly, Kanboard requires that a background job runs on a daily basis. Edit your cron tab using the crontab -e command and insert this cron job to execute the daily cronjob at 8am. Make sure to replace isabell with your own user name.

0 8 * * * cd /var/www/virtual/isabell/html && ./cli cronjob >/dev/null 2>&1

Best practices

Plugins

Get an overview of all available Plugins for Kanboard and install them from the user interface. More (unofficial) plugins may also be available, just browse GitHub.

Email Notifications

To receive email notifications, users of Kanboard must have:

  • Activated notifications in their profile
  • Have a valid email address in their profile
  • Be a member of the project that will trigger notifications

Set the email address used for the "From" header by changing the value in config.php:

Specify the URL of your Kanboard installation in your Application Settings to display a link to the task in notifications: https://isabell.uber.space/. By default, nothing is defined, so no links will be displayed in notifications.

Note

Don’t forget the ending slash /.

Debugging

Enable debug mode by setting the following two values in config.php:

The file debug.log will be found in the data folder of your Kanboard directory.

Updates

Note

Check the update Feed regularly to stay informed about the newest version.

Check the GitHub's Atom Feed for any new Kanboard releases and copy the link to the .tar.gz archive. In this example the version is v42.23.2, which does not exist of course. Change the version to the latest one in the highlighted lines.

Check the Kanboard documentation if the configuration changed between config.default.php and your config.php (happens very rarely). Also check .htaccess if further adjustments needed to be made.


Tested with Kanboard 1.2.6, Uberspace 7.1.14.0

.. author_list::
You can’t perform that action at this time.