mirror of
https://github.com/funkypenguin/geek-cookbook/
synced 2025-12-13 09:46:23 +00:00
151 lines
5.1 KiB
Markdown
151 lines
5.1 KiB
Markdown
# Wekan
|
|
|
|
Wekan is an open-source kanban board which allows a card-based task and to-do management, similar to tools like WorkFlowy or Trello.
|
|
|
|
|
|
|
|
Wekan allows to create Boards, on which Cards can be moved around between a number of Columns. Boards can have many members, allowing for easy collaboration, just add everyone that should be able to work with you on the board to it, and you are good to go! You can assign colored Labels to cards to facilitate grouping and filtering, additionally you can add members to a card, for example to assign a task to someone.
|
|
|
|
There's a [video](https://www.youtube.com/watch?v=N3iMLwCNOro) of the developer showing off the app, as well as a f[unctional demo](https://wekan.indie.host/b/t2YaGmyXgNkppcFBq/wekan-fork-roadmap).
|
|
|
|
!!! note
|
|
For added privacy, this design secures wekan behind an [oauth2 proxy](/reference/oauth_proxy/), so that in order to gain access to the wekan UI at all, oauth2 authentication (_to GitHub, GitLab, Google, etc_) must have already occurred.
|
|
|
|
## Ingredients
|
|
|
|
1. [Docker swarm cluster](/ha-docker-swarm/design/) with [persistent shared storage](/ha-docker-swarm/shared-storage-ceph.md)
|
|
2. [Traefik](/ha-docker-swarm/traefik) configured per design
|
|
|
|
## Preparation
|
|
|
|
### Setup data locations
|
|
|
|
We'll need several directories to bind-mount into our container, so create them in /var/data/wekan:
|
|
|
|
```
|
|
mkdir /var/data/wekan
|
|
cd /var/data/wekan
|
|
mkdir -p {wekan-db,wekan-db-dump}
|
|
```
|
|
|
|
### Prepare environment
|
|
|
|
You'll need to know the following:
|
|
|
|
1. Choose an oauth provider, and obtain a client ID and secret
|
|
2. Create wekan.env, and populate with the following variables
|
|
```
|
|
OAUTH2_PROXY_CLIENT_ID=
|
|
OAUTH2_PROXY_CLIENT_SECRET=
|
|
OAUTH2_PROXY_COOKIE_SECRET=
|
|
MONGO_URL=mongodb://wekandb:27017/wekan
|
|
ROOT_URL=https://wekan.example.com
|
|
MAIL_URL=smtp://wekan@wekan.example.com:password@mail.example.com:587/
|
|
MAIL_FROM="Wekan <wekan@wekan.example.com>"
|
|
|
|
# Mongodb specific database dump details
|
|
BACKUP_NUM_KEEP=7
|
|
BACKUP_FREQUENCY=1d
|
|
```
|
|
|
|
### Setup Docker Swarm
|
|
|
|
Create a docker swarm config file in docker-compose syntax (v3), something like this:
|
|
|
|
!!! tip
|
|
I share (_with my [patreon patrons](https://www.patreon.com/funkypenguin)_) a private "_premix_" git repository, which includes necessary docker-compose and env files for all published recipes. This means that patrons can launch any recipe with just a ```git pull``` and a ```docker stack deploy``` 👍
|
|
|
|
```
|
|
version: '3'
|
|
|
|
services:
|
|
|
|
wekandb:
|
|
image: mongo:latest
|
|
command: mongod --smallfiles --oplogSize 128
|
|
networks:
|
|
- internal
|
|
volumes:
|
|
- /var/data/runtime/wekan/database:/data/db
|
|
- /var/data/wekan/database-dump:/dump
|
|
|
|
proxy:
|
|
image: zappi/oauth2_proxy
|
|
env_file: /var/data/config/wekan/wekan.env
|
|
networks:
|
|
- traefik
|
|
- internal
|
|
volumes:
|
|
- /var/data/oauth_proxy/authenticated-emails.txt:/authenticated-emails.txt
|
|
deploy:
|
|
labels:
|
|
- traefik.frontend.rule=Host:wekan.example.com
|
|
- traefik.docker.network=traefik
|
|
- traefik.port=4180
|
|
command: |
|
|
-cookie-secure=false
|
|
-upstream=http://wekan:80
|
|
-redirect-url=https://wekan.example.com
|
|
-http-address=http://0.0.0.0:4180
|
|
-email-domain=example.com
|
|
-provider=github
|
|
-authenticated-emails-file=/authenticated-emails.txt
|
|
|
|
wekan:
|
|
image: wekanteam/wekan:latest
|
|
networks:
|
|
- internal
|
|
env_file: /var/data/config/wekan/wekan.env
|
|
|
|
db-backup:
|
|
image: mongo:latest
|
|
env_file : /var/data/config/wekan/wekan.env
|
|
volumes:
|
|
- /var/data/wekan/database-dump:/dump
|
|
- /etc/localtime:/etc/localtime:ro
|
|
entrypoint: |
|
|
bash -c 'bash -s <<EOF
|
|
trap "break;exit" SIGHUP SIGINT SIGTERM
|
|
sleep 2m
|
|
while /bin/true; do
|
|
mongodump -h db --gzip --archive=/dump/dump_\`date +%d-%m-%Y"_"%H_%M_%S\`.mongo.gz
|
|
(ls -t /dump/dump*.mongo.gz|head -n $$BACKUP_NUM_KEEP;ls /dump/dump*.mongo.gz)|sort|uniq -u|xargs rm -- {}
|
|
sleep $$BACKUP_FREQUENCY
|
|
done
|
|
EOF'
|
|
networks:
|
|
- internal
|
|
|
|
networks:
|
|
traefik:
|
|
external: true
|
|
internal:
|
|
driver: overlay
|
|
ipam:
|
|
config:
|
|
- subnet: 172.16.3.0/24
|
|
```
|
|
|
|
!!! note
|
|
Setup unique static subnets for every stack you deploy. This avoids IP/gateway conflicts which can otherwise occur when you're creating/removing stacks a lot. See [my list](/reference/networks/) here.
|
|
|
|
|
|
|
|
## Serving
|
|
|
|
### Launch Wekan stack
|
|
|
|
Launch the Wekan stack by running ```docker stack deploy wekan -c <path -to-docker-compose.yml>```
|
|
|
|
Log into your new instance at https://**YOUR-FQDN**, with user "root" and the password you specified in gitlab.env.
|
|
|
|
## Chef's Notes
|
|
|
|
1. If you wanted to expose the Wekan UI directly, you could remove the oauth2_proxy from the design, and move the traefik-related labels directly to the wekan container. You'd also need to add the traefik network to the wekan container.
|
|
|
|
### Tip your waiter (donate) 👏
|
|
|
|
Did you receive excellent service? Want to make your waiter happy? (_..and support development of current and future recipes!_) See the [support](/support/) page for (_free or paid)_ ways to say thank you! 👏
|
|
|
|
### Your comments? 💬
|