Wekan#

Wekan Open source Kanban board with MIT license

amd64
arm64
armv7

Information#

Docker Image: !!! LINK TO DOCKER IMAGE/ DOCKER HUB !!!
Current Image Version: latest

SETUP#

Enabling wekan#

Command:#

vlab set wekan.enable True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

wekan
enable: True

Finalising changes:#

run: vlab update_one service=wekan

FIRST RUN#

!!! DEVELOPERS: make sure that you include any information that the user requires to get started, below. !!!
!!! Below are some examples with headings, and with some example instructions !!!

ADMINISTRATOR SETUP#

Navigate to https://False/admin

Create an account with your desired username; as this is the first user, wekan makes this account the administrator.

SMTP/ MAIL#

  1. run vlab decrypt to decrypt the vault.yml file
  2. make some changes

SMTP Settings#

smtp:
host:
port:
user:
pass:
from_email:
from_name:
  1. run vlab update_one service=wekan to complete the changes

ACCESS#

wekan (HTTPS) link: https://wekan.vivumlab.xyz/ wekan (HTTP) link: http://wekan.vivumlab.xyz/

OPTIONS#

HTTPS_ONLY#

Default: False
Options: True/False

Command:#

vlab set wekan.https_only True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

wekan
https_only: True
Finalising changes:#

run: vlab update_one service=wekan

AUTH#

Default: False
Options: True/False

Command:#

vlab set wekan.auth True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

wekan
auth: True
Finalising changes:#

run: vlab update_one service=wekan

DOMAIN#

Default: False
NOTE: include the sitename and top level domain suffix. eg. name.com, site.net

Command:#

vlab set wekan.domain wekan.com

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

wekan
domain: wekan.com
Finalising changes:#

run: vlab update_one service=wekan

SUBDOMAIN#

Default: wekan
NOTE: Periods/ delimiters are not required. eg. 'media' will set the full URL as 'media.vivumlab.xyz'

Command:#

vlab set wekan.subdomain media

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

wekan
subdomain: media
Finalising changes:#

run: vlab update_one service=wekan

VERSION#

Default: latest
NOTE: Ensure that the version exists

Command:#

vlab set wekan.version 2.7

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

wekan
version: 2.7
Finalising changes:#

run: vlab update_one service=wekan

Need more help?#

Further information regarding services can be found.
General Information can be found in the documentation.
Additional assistance can be found on our Contact Us page.