Documentation

Learn how to install, configure, and get the most out of Kanban for Redmine.

Getting Started

Welcome to the official documentation for Kanban for Redmine. This guide will help you download, install, and configure the desktop application on your system step by step.

Important: This is a native desktop application. You do not need to install any additional plugins on your Redmine server for it to work. All processing is done locally on your computer.

Windows Installation

We offer two installation formats for Windows ecosystems. We recommend using the standard .exe installer for most cases.

Standard Installer (.exe)

The classic and fastest method for individual users.

  1. Download the Windows (x64).exe file from the downloads section.
  2. Double-click the downloaded file to start the setup wizard.
  3. Follow the on-screen instructions to choose the installation path.
  4. Once finished, search for "Kanban for Redmine" in the Start menu to open the application.

MSI Installer (.msi)

Ideal for IT administrators who need to deploy the application to multiple corporate machines silently (via Group Policy or SCCM).

  1. Download the Windows (x64).msi file.
  2. For manual installation, double-click it.
  3. For silent installations from the terminal, use:
msiexec /i installer.msi /quiet /qn /norestart

Linux Installation

We support major Linux distributions with specifically packaged formats, as well as a universal portable format.

Ubuntu / Debian (.deb)

The most native way to install on Debian-based systems (like Ubuntu, Linux Mint, Pop!_OS).

  1. Download the Linux (.deb) file.
  2. Open your terminal in the folder where you downloaded it.
  3. Run the following command to install it:
sudo dpkg -i package-name.deb

If the system reports missing dependencies, you can fix it by running: sudo apt-get install -f

Fedora / Red Hat (.rpm)

For enterprise or Red Hat-based distributions (Fedora, CentOS, RHEL).

  1. Download the Linux (.rpm) file.
  2. Open your terminal and run:
sudo dnf install package-name.rpm

On older operating systems, substitute dnf with yum.

Universal Format (.AppImage)

The fastest option if you don't have administrator privileges or don't want to install anything directly into the root file system. It works on virtually any modern Linux distribution.

  1. Download the Linux (.appImage) file.
  2. Right-click on the downloaded file, go to Properties > Permissions and check the box that says "Allow executing file as program".
  3. Double-click the file to run the application instantly.

Terminal alternative: chmod +x filename.AppImage && ./filename.AppImage

Initial Configuration

Once you have installed and opened the application for the first time, you will see the welcome screen. Follow these steps to connect your account:

  1. In the Server URL field, enter the exact web address of your Redmine server (example: https://redmine.mycompany.com). Make sure to include http:// or https://.
  2. In the credentials field, you can enter your username and password, or preferably, your API Access Key.
    • To find your API Key: Log in to your Redmine via the web, click on your username at the top right ("My account"), and on the right sidebar you will find the "API access key". Click "Show" and copy it.
  3. Click the "Connect" button.

And that's it! The application will automatically download your projects and tasks, and you'll be ready to start organizing your work at lightning speed.