Skip to content

Install Wekan Docker for testing

Jeremy Bandini edited this page Jan 10, 2017 · 17 revisions

Purpose: just to try Wekan on your own Linux workstation

  1. Install Docker
  2. Install Docker-Compose
  3. Say we want to save our Wekan data on the host in directory /home/johndoe/wekan/data
  4. In a given directory (say /home/johndoe/wekan), create a docker-compose.yml file with:
version: '2'
services:
  wekan:
    image: mquandalle/wekan
    links:
      - wekandb
    environment:
      - MONGO_URL=mongodb://wekandb/wekan
      - ROOT_URL=http://localhost:80
    ports:
      - 80:80

  wekandb:
    image: mongo
    volumes:
      - /home/johndoe/wekan/data:/data/db

Then, from the directory containing the docker-compose.yml (i.e. /home/johndoe/wekan), simply run docker-compose up. If you want it to be deamonized, you could run docker-compose up -d.

Your wekan data are in /home/johndoe/wekan/data and thus can be backed up.

Note If the default host port 80 has been used and you would like to set up Wekan for another port, say, 1234, the configuration above

  ports:
    - 80:80

can be replaced by

  ports:
    - 1234:80

Also need to change

  ROOT_URL=http://localhost:1234

(This procedure has been tested on Linux Ubuntu 14.04 and Mac OS 10.11.6.)

Testing with mail server

Above method will create an instance of Wekan without mailing features (users inviting, password recovery, neat registration) because MAIL_URL env var isn't set. This docker-compose.yml solves that problem by adding mailserver container.

wekan:
  image: mquandalle/wekan
  links:
    - wekandb
    - mailserver
  environment:
    - MONGO_URL=mongodb://wekandb/wekan
    - ROOT_URL=http://10.2.0.180:8081
    - MAIL_URL=smtp://wekan:wekan@mailserver:25
  ports:
    - 8081:80

wekandb:
   image: mongo
   volumes:
     - /home/wekan/data:/data/db

mailserver:
  image: marvambass/versatile-postfix
  volumes:
    - /home/wekan/dkim:/etc/postfix/dkim/
    - /home/wekan/maildirs:/var/mail
  command: wekan.com wekan:wekan
  environment:
    - ALIASES=postmaster:root;hostmaster:root;webmaster:root

Several additional steps needed.

  1. Create dirs /home/wekan/dkim, /home/wekan/maildirs that are used by mailserver container

    mkdir /home/wekan/dkim
    mkdir /home/wekan/maildirs
  2. Generate DKIM key

    apt-get install opendkim-tools
    cd /home/wekan/maildirs
    opendkim-genkey -s mail -d example.com
    mv mail.private dkim.key

Wekan

General

Support priorities for new features and bugfixes

  1. Commercial Support
  2. Community Support
  3. Debugging

Security

Backup

Repair

Themes

Features

Email

Logs and Stats

Migrating

Required Settings

Download

Webservers

REST API Docs

REST API issue

REST API client code

Webhooks

Case Studies

Development

Issues

Clone this wiki locally