-
-
Notifications
You must be signed in to change notification settings - Fork 2.8k
Install Wekan Docker for testing
Purpose: just to try Wekan on your own Linux workstation
- Install Docker
- Install Docker-Compose
- Say we want to save our Wekan data on the host in directory
/home/johndoe/wekan/data
- In a given directory (say
/home/johndoe/wekan
), create adocker-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:)
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.
-
Create dirs
/home/wekan/dkim
,/home/wekan/maildirs
that are used by mailserver containermkdir /home/wekan/dkim mkdir /home/wekan/maildirs
-
Generate DKIM key
apt-get install opendkim-tools cd /home/wekan/maildirs opendkim-genkey -s mail -d example.com mv mail.private dkim.key
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 - OpenSource Kanban
- Deep Dive Into WeKan
- Meteor WeKan Roadmap - board at Wekan demo
- Multiverse WeKan Roadmap
- Docs/Manual
- Change Language
- Forgot Password
- About
- Test Edge
- WeKan Design Principles
- FAQ
- IRC FAQ - answers to questions asked at IRC
- Team
- Press
- Blog
- Wekan vs Trello vs Restyaboard
- Results of Survey 2020-01
- Allow private boards only: Disable Public Boards
- Security Disclosure and details of Security in Wekan
- Security issues
- Password Hashing
- Add more RAM to Node.js to prevent crash
- Clustering AWS etc
- Scaling
- Kubernetes
- Redis Oplog
- Meteor Scaling at Meteor Cloud
- Scaling at Meteor forums
- From Previous Export, paste big WeKan JSON
- Progress: Import/Export/Sync
- From CSV/TSV
- From Trello
- From Jira
- From Asana
- From Zenkit
- From old Wekan manually
- Converting Meteor Stylus to CSS
- Repair MongoDB
- Using Meteor MongoDB to repair files
- If board does not open and keeps loading
- Repair Docker
- Wekan Markdown
- Emoji
- Mermaid Diagram DOES NOT WORK ANYMORE
- Numbered text
- Automatic login
- Disable Password Login
- Forgot Password
- Admin: Impersonate user
- Adding Users
- Active users Presence
- Accounts Lockout: Brute force login protection
- LDAP
- LDAP AD Simple Auth
- Keycloak
- Google login
- Azure
- OAuth2, Auth0, GitLab, RocketChat
- Oracle OIM on premise using OAuth2
- ADFS 4.0 using OAuth2 and OpenID
- Azure AD B2C using OAuth2
- Nextcloud
- CAS Please test
- SAML Please test
- Zitadel
- Drag Drop on Mobile and Desktop
- Rclone: Store attachments to cloud storage like S3, MinIO, etc
- Python based features
- Burndown and Velocity Chart
- Wait Spinners
- Translations
- Default Language for All Users
- Roadmap
- Features
- Planning Poker
- Scaling
- Custom Logo
- Subtasks <== Has fix
- Templates
- Cover
- Archive and Delete
- Custom Fields
- Fix Export board menu not visible on some boards
- RAM usage
- Demo
- Swimlane Documentation
- Customize Translations
- Download Wekan for various Platforms: Supported by xet7, Operating Systems, NAS, Cloud
- Helm Chart for Kubernetes
- Caddy
- Nginx
- Apache
- OpenLiteSpeed
- Local self signed TLS
- Let's Encrypt and Google Auth
- TLS with Node.js
- Traefik and self-signed SSL certs
- Example: New card with Python3 and REST API
- Python client to REST API
- Go client to REST API
- Java
- Wekan Sandstorm cards to CSV using Python
- Excel and VBA
- Global Webhook
- Limiting Webhook data
- Receiving Webhooks
- Outgoing Webhook to Discord/Slack/RocketChat/Riot
- Outgoing Webhook to NodeRed
- Outgoing Webhook to PowerShell
- Security: Webhook and CA
- Outgoing Webhooks Data
- Outgoing Webhooks and Let's Encrypt
- Outgoing Webhooks Original Pull Request, multiple Webhooks, more parameters and response order