github-mirrors/wekan
1
0
Fork 0
mirror of https://github.com/wekan/wekan.git synced 2025-08-15 16:53:57 -04:00
Code Issues Projects Releases Packages Wiki Activity
Page: Install Wekan Docker for testing
Pages
ADFS AWS Accounts Lockout Adding new Snap settings to code Adding users Allow private boards only Android Apache Archive and Delete Asana AsyncAwait Azure B2C Backup Browser compatibility matrix Burndown and Velocity Chart CAS CSV Caddy Webserver Config Calendar Change Language Chromebook Cloud Foundry CloudFlare Cloudron Converting Meteor Stylus to CSS Cover Cron Custom CSS themes Custom Fields Custom Logo Customize Translations Dark Mode Day of week start Debian Debugging Deep Dive Into WeKan Delete Board Design Principles Developer Documentation Directory Structure Disable Password Login Docker Dome Drag Drop Due Date Emoji Excel and VBA Export Docker Mongo Data Export from Wekan Sandstorm grain .zip file FAQ Features Forgot Password FreeBSD Friend From Previous Export Gantt Google Cloud Google login Hall of Shame Helm Heroku Home IFTTT IRC FAQ If board does not open and keeps loading Impersonate user Install Wekan Docker for testing Install Wekan Docker in production Install Wekan Docker on SUSE Linux Enterprise Server 12 SP1 Install Wekan from source on Windows Install Windows Install and Update Install from source without root Install latest Wekan release on Uberspace Install source without sudo on Linux Integrations Java Jira Keycloak LDAP AD Simple Auth LDAP LaTeX Leo Let's Encrypt and Google Auth Linked Cards Local self signed TLS Logs Mac Mermaid Diagram Metal Meteor bundle Meteor Metrics Migrating from Trello Migrating from old Wekan manually Monkey Proof Software Move Docker containers to other computer Multiline Multitenancy NOT related to Wekan New card with Python3 and REST API Nextcloud Nginx Webserver Config Numbered text OAuth2 OVH Offline OpenShift OpenSuse OpenVZ Oracle Identity Cloud Oracle OIM Outgoing Webhook to Discord PWA Password Hashing PikaPods Planning Poker Platforms PostgreSQL Press Python Qnap NAS REST API Boards REST API Cards REST API Checklists REST API Code REST API Custom Fields REST API Integrations REST API Lists REST API Role REST API Swimlanes REST API User REST API Rancher Rancher Active Proxy Wekan MongoDB Docker Raspberry Pi Rclone Receiving Webhooks Repair Docker Repair MongoDB Requirements Roadmap RocketChat SAML Sandstorm Scaling Scalingo Secure Boot Security Disclosure Settings SmartOS Snap Source Subtasks Swimlanes Sync Team Templates Test Edge Time Tracking Timezone Touch Screen support Traefik and self signed SSL certs Translations Troubleshooting Mail UCS Ubuntu Core Upgrade Vagrant Vultr WSL Wait Spinners WeKan Multiverse Roadmap WebHook And CA Webhook data Wekan Markdown Wekan Sandstorm cards to CSV using Python Wekan vs Sandstorm Wekan vs Trello vs Restyaboard Windows ZenKit Zitadel autologin ppc s390x virtual appliance
17 Install Wekan Docker for testing
Lauri Ojansivu edited this page 2018-11-19 15:19:41 +02:00
Table of Contents

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:

Use this docker-compose.yml:

https://raw.githubusercontent.com/wekan/wekan/devel/docker-compose.yml

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:8080

can be replaced by

  ports:
    - 1234:8080

also need to change

 - ROOT_URL=http://localhost

to the new port

 - ROOT_URL=http://localhost:1234

(This procedure has been tested on Linux Ubuntu 14.04 and Mac OS 10.11.6.) (Tested on Docker for Windows 17.06.2-ce-win27, MongoDB does not support using mounted Windows volumes, simply remove volumes: from wekandb:)

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: quay.io/wekan/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:3.2.21
   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

Show mails with a Docker image, without mail configuration

When you did NOT setup the MAIL_URL environment variable in Wekan, the mail message will be 'sent' to the terminal output instead of sending an actual e-mail. If you are using Docker images, list the containers via:

docker ps

Then display the process output:

docker logs -f <container_id>

With the -f flag (f for follow), you will see the real-time output of the process. You can exit with CTRL + C without affecting the Wekan process.

Via the web-interface press the 'forgot your password?' link and trigger a reset mail. And watch the terminal output for the e-mail.

Wekan

General

Fake: Not WeKan kanban

Security

Scaling

Migrating

Support priorities for new features and bugfixes

  1. Commercial Support
  2. Community Support
  3. Debugging

Backup

Repair

Themes

Markdown Syntax

Login Auth

Metrics, Logs, Stats

Integrations

Time

Features

Email

Required Settings

Download

Webservers

REST API Docs

REST API issue

REST API client code

Webhooks

Case Studies

Development

Issues

Wekan - OpenSource Kanban