Best Way To Install Wekan Server on Debian 12 – OrcaCore

Posted on

Best Way To Install Wekan Server on Debian 12 - OrcaCore

Best Way To Install Wekan Server on Debian 12 – OrcaCore

In this article, you will learn to Install Wekan Server on Debian 12 Bookworm. Wekan server is a web-based Kanban board application. It allows users to visually organize tasks. Wekan server enables collaboration among team members by providing features such as task assignment, due dates, labels, and comments. It can be self-hosted on a server, making it suitable for teams looking for a flexible and customizable project management solution.

Now you can follow the steps below on the Orcacore website to Install Wekan Server on Debian 12 Bookworm.

Before you start your Wekan Kanban setup, you must access your server as a non-root user with sudo privileges. For this purpose, you can check the Initial Server Setup with Debian 12.

Then, proceed to the next steps to start your Wekan server installation on Debian 12 Bookworm.

Step 1 – Install Wekan Server on Debian 12 with Snapd

In this guide, we use the Snap package manager to install the latest Wekan. First, run the system update with the command below:

sudo apt update

Then, install Snapd on Debian 12 by running:

sudo apt install snapd -y

Once your installation is completed, reboot your system:

sudo reboot

Now you can use Snap to install Wekan packages:

sudo snap install wekan
**Output**
wekan 6.09 from Lauri Ojansivu (xet7) installed

Step 2 – Wekan Server Configuration on Debian 12

At this point, you need to configure the root of the web URL for the Wekan server. To do this, you can use the following command:

sudo snap set wekan root-url="http://your_server_ip"

Next, you need to set a port number on Debian 12 to access the Wekan server through your browser. To do this, you can run the command below:

sudo snap set wekan port='3001'

Note: Remember to set a port number that isn’t in use. Here we use port 3001.

To apply the changes, restart the Wekan services with the commands below:

# sudo systemctl restart snap.wekan.mongodb
# sudo systemctl restart snap.wekan.wekan

Then, enable the Wekan server to start on boot and reload the Snapd:

# sudo snap enable wekan
# sudo snap refresh

Step 3 – Access Wekan Kanban Board

At this point, you can access your Wekan web interface by typing your server’s IP address in your web browser followed by the port that you have defined before.

http://server-ip:3001

You will see the Wekan sign-in screen. If you are logging in for the first time, click on Register.

Wekan sign-in screen

Here you will see the Create an Account page. Complete the information and click on Register.

Create an Account for Wekan

At this point, you will see your Wekan dashboard on Debian 12.

Wekan dashboard - Install Wekan Server on Debian 12

The usage of the Wekan Kanban Board involves several key steps:

  • Creating Boards: Users can create multiple boards to represent different projects or areas of work. Each board serves as a dedicated space for organizing tasks and workflows.
  • Adding Lists: Within each board, users can add lists to represent different stages of a workflow, such as "To Do," "In Progress," and "Done." These lists help visualize the progress of tasks as they move through the workflow.
  • Creating Cards: Cards represent individual tasks or items of work. Users can create cards within lists and add details such as descriptions, due dates, assignees, labels, and attachments.
  • Moving Cards: Users can drag and drop cards between lists to update their status and track their progress. This allows for easy visualization of the workflow and identification of bottlenecks.
  • Collaborating: Wekan supports collaboration among team members by allowing users to assign tasks, add comments, and receive notifications about updates. This promotes communication and coordination within the team.

With these key steps, teams can effectively manage projects, streamline workflows, and enhance productivity. For more information, you can visit the official website.

Conclusion

At this point, you have learned to Install Wekan Server on Debian 12 Bookworm by using the Snap package manager. Then, easily access your dashboard from a web browser and start working with your Kanban board.

Hope you enjoy using it. Also, you may like to read the following articles:

Set up Clang LLVM on Debian 12

Install Webmin on Debian 12 From the Command Line

Install Sublime Text Editor on Debian 12

GlassFish Server Setup on Debian 12 Bookworm

Alternative Installation Methods for Wekan on Debian 12

While Snap offers a convenient way to Install Wekan Server on Debian 12, it’s not the only method. Some users prefer to avoid Snap due to personal preferences or concerns about resource usage. Here are two alternative methods for installing Wekan, offering more control and customization.

1. Installing Wekan using Docker Compose

Docker provides a containerization solution that allows you to run applications in isolated environments. Docker Compose simplifies the process of defining and managing multi-container Docker applications. This method is particularly useful for those familiar with Docker and who prefer a more isolated and reproducible environment.

Prerequisites:

  • Docker installed on Debian 12.
  • Docker Compose installed on Debian 12.

Steps:

  1. Create a docker-compose.yml file: Create a new directory for your Wekan installation and create a docker-compose.yml file within it.

    mkdir wekan-docker
    cd wekan-docker
    nano docker-compose.yml
  2. Define the Wekan service in docker-compose.yml: Add the following content to the docker-compose.yml file. This configuration uses the official Wekan Docker image and sets up the necessary environment variables. It also utilizes a MongoDB instance.

    version: "3.9"
    services:
      wekan:
        image: wekanteam/wekan
        restart: always
        ports:
          - "3001:3001"
        environment:
          MONGO_URL: mongodb://mongo:27017/wekan
          ROOT_URL: http://your_server_ip:3001
          PORT: 3001
        depends_on:
          - mongo
      mongo:
        image: mongo:latest
        restart: always
        volumes:
          - wekan-data:/data/db
    volumes:
      wekan-data:

    Explanation:

    • version: "3.9": Specifies the Docker Compose file version.
    • services: Defines the services that make up the application.
      • wekan: Defines the Wekan service.
        • image: wekanteam/wekan: Specifies the official Wekan Docker image.
        • restart: always: Ensures that the container restarts automatically if it crashes.
        • ports: - "3001:3001": Maps port 3001 on the host to port 3001 in the container.
        • environment: Sets environment variables for the Wekan container:
          • MONGO_URL: Specifies the URL of the MongoDB database.
          • ROOT_URL: Specifies the root URL for the Wekan application. Remember to replace your_server_ip with your actual server IP or domain.
          • PORT: The port Wekan will listen on.
        • depends_on: - mongo: Ensures that the MongoDB container starts before the Wekan container.
      • mongo: Defines the MongoDB service.
        • image: mongo:latest: Specifies the official MongoDB Docker image.
        • restart: always: Ensures that the container restarts automatically if it crashes.
        • volumes: - wekan-data:/data/db: Mounts a volume to persist the MongoDB data.
    • volumes: Defines the volumes used by the services.
      • wekan-data: A named volume for persistent storage of the MongoDB data.
  3. Start the Wekan application: Run the following command to start the Wekan application using Docker Compose.

    docker-compose up -d

    This command will download the necessary images, create the containers, and start the Wekan application in detached mode (-d).

  4. Access Wekan: After the containers have started, you can access Wekan by navigating to http://your_server_ip:3001 in your web browser.

2. Installing Wekan from Source (Advanced)

Installing Wekan from source provides the greatest level of customization and control. However, it’s also the most complex method and requires a good understanding of Node.js, MongoDB, and Linux system administration.

Prerequisites:

  • Node.js (version 14 or higher) and npm installed on Debian 12.
  • MongoDB installed and running on Debian 12.
  • Git installed on Debian 12.

Steps:

  1. Clone the Wekan repository: Clone the Wekan repository from GitHub.

    git clone https://github.com/wekan/wekan.git
    cd wekan
  2. Install dependencies: Install the required Node.js dependencies.

    npm install
  3. Configure Wekan: Create a settings.json file in the root directory of the Wekan project. This file will contain the configuration settings for your Wekan instance. A minimal example might look like this:

    {
      "mongoUrl": "mongodb://localhost:27017/wekan",
      "port": 3001,
      "rootURL": "http://your_server_ip:3001"
    }

    Remember to replace your_server_ip with your actual server IP or domain. You may need to create the settings.json file if it doesn’t exist.

  4. Build Wekan (Optional but Recommended): Build the client-side assets for production:

    npm run build
  5. Start Wekan: Start the Wekan server.

    npm start

    Alternatively, you can use a process manager like pm2 to keep Wekan running in the background and automatically restart it if it crashes. First install pm2 globally:

    npm install -g pm2

    Then start Wekan with pm2:

    pm2 start npm --name "wekan" -- start
  6. Access Wekan: After the server has started, you can access Wekan by navigating to http://your_server_ip:3001 in your web browser.

These alternative methods provide flexibility in how you choose to Install Wekan Server on Debian 12. Docker Compose offers a relatively simple and contained approach, while installing from source grants you maximum control over every aspect of the application. Remember to choose the method that best suits your technical expertise and requirements.

Leave a Reply

Your email address will not be published. Required fields are marked *