elestio4test/wekan repository overview

⁠

⁠Wekan, verified and packaged by Elestio

Wekan⁠ Open-Source Kanban Experience efficient task management with WeKan - the Open-Source, customizable, and privacy-focused kanban.

Deploy a fully managed Wekan⁠ on elest.io⁠ if you want automated backups, reverse proxy with SSL termination, firewall, automated OS & Software updates, and a team of Linux experts and open source enthusiasts to ensure your services are always safe, and functional.

⁠Why use Elestio images?

• Elestio stays in sync with updates from the original source and quickly releases new versions of this image through our automated processes.
• Elestio images provide timely access to the most recent bug fixes and features.
• Our team performs quality control checks to ensure the products we release meet our high standards.

⁠Usage

⁠Git clone

You can deploy it easily with the following command:

git clone https://github.com/elestio-examples/wekan.git

Copy the .env file from tests folder to the project directory

cp ./tests/.env ./.env

Edit the .env file with your own values.

Create data folders with correct permissions

mkdir -p ./data
chown -R 1000:1000 ./data
mkdir -p ./wekan_data
chown -R 999:999 ./wekan_data

Run the project with the following command

docker-compose up -d

You can access the Web UI at: http://your-domain:7972

⁠Docker-compose

Here are some example snippets to help you get started creating a container.

version: '3.3'

services:

    wekandb:
        restart: always
        image: mongo:5
        command: mongod --logpath /dev/null --oplogSize 128 --quiet
        volumes:
          - ./wekan-db:/data/db
          - ./wekan-db-dump:/dump
          - /etc/localtime:/etc/localtime:ro
          - /etc/timezone:/etc/timezone:ro
    wekan:
        image: elestio4test/wekan:latest
        restart: always
        ports:
          - 172.17.0.1:7972:8080
        environment:
          - MONGO_URL=mongodb://wekandb:27017/wekan
          - ROOT_URL=${BASE_URL}
          - MAIL_URL=${EMAIL_URL}
          - MAIL_FROM=${EMAIL_FROM}
          - WITH_API=true
          - WRITABLE_PATH=/data
        volumes:
          - ./wekan_data:/data
          - /etc/localtime:/etc/localtime:ro
        depends_on:
          - wekandb

⁠Environment variables

⁠Maintenance

⁠Logging

The Elestio Wekan Docker image sends the container logs to stdout. To view the logs, you can use the following command:

docker-compose logs -f

To stop the stack you can use the following command:

docker-compose down

⁠Backup and Restore with Docker Compose

To make backup and restore operations easier, we are using folder volume mounts. You can simply stop your stack with docker-compose down, then backup all the files and subfolders in the folder near the docker-compose.yml file.

Creating a ZIP Archive For example, if you want to create a ZIP archive, navigate to the folder where you have your docker-compose.yml file and use this command:

zip -r myarchive.zip .

Restoring from ZIP Archive To restore from a ZIP archive, unzip the archive into the original folder using the following command:

unzip myarchive.zip -d /path/to/original/folder

Starting Your Stack Once your backup is complete, you can start your stack again with the following command:

docker-compose up -d

That's it! With these simple steps, you can easily backup and restore your data volumes using Docker Compose.

⁠Links

• Wekan documentation⁠

• Wekan Github repository⁠

• Elestio/wekan Github repository⁠