mirror of
https://github.com/wekan/wekan.git
synced 2025-08-15 16:53:57 -04:00
Page:
Source
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
No results
16
Source
Lauri Ojansivu edited this page 2023-09-25 17:50:05 +03:00
Build from source on Mac
Build from source on VirtualBox
At Virtual Appliance there is build scripts and all dependencies installed already.
Build from source on Linux
To have Node 100% CPU fixes: Increase ulimit for node in systemd config to 100 000
Wekan:
- On any x64 hardware that has Ubuntu 14.04 or Debian 9 or newer installed directly or in VM: Build from source scripts
Wekan Meteor Bundle:
- Build from source scripts built on Wekan VirtualBox Ubuntu 14.04 64bit
- Copy arhive directory wekan/.build/bundle to .zip file so it includes bundle directory and subdirectories as wekan-1.xx.tar.gz
Wekan for Sandstorm:
- Install above Wekan from source
- Install Sandstorm locally with
curl https://install.sandstorm.io | bash
, select dev install - Install meteor-spk
- Get 100% CPU issue fibers fixed node, and copy it to spk directory:
wget https://releases.wekan.team/node
chmod +x node
mv node ~/projects/meteor-spk/meteor-spk-0.4.0/meteor-spk.deps/bin/
- Add to your /home/username/.bashrc :
export PATH=$PATH:$HOME/projects/meteor-spk/meteor-spk-0.4.0
- Close and open your terminal, or read settings from .bashrc with
source ~/.bashrc
cd wekan && meteor-spk dev
- Then Wekan will be visible at local sandstorm at http://local.sandstorm.io:6080/
- Sandstorm commands:
sudo sandstorm
. Release scripts. Official releases require publishing key that only xet7 has.
Docker:
git clone https://github.com/wekan/wekan
cd wekan
- Edit docker-compose.yml script ROOT_URL etc like documented at https://github.com/wekan/wekan-mongodb docker-compose.yml script
docker-compose up -d --build
Wekan on Windows:
(Optional) Run Wekan as service with startup script
Build from source scripts - from there run node-allow-port-80.sh and add etc-rc.local.txt before last line in your /etc/rc.local
(Optional) Run Wekan as service with SystemD on Linux
This may need testing, does this work.
Add to to /etc/systemd/system/wekan@.service
; see `man systemd.unit` for configuration details
; the man section also explains *specifiers* `%x`
; update <username> with username below
[Unit]
Description=Wekan server %I
Documentation=https://github.com/wekan/wekan
After=network-online.target
Wants=network-online.target
Wants=systemd-networkd-wait-online.service
[Service]
ExecStart=/usr/local/bin/node /home/<username>/repos/wekan/.build/bundle/main.js
Restart=on-failure
StartLimitInterval=86400
StartLimitBurst=5
RestartSec=10
ExecReload=/bin/kill -USR1 $MAINPID
RestartSec=10
StandardOutput=syslog
StandardError=syslog
SyslogIdentifier=Wekan
User=<username>
Group=<username>
Environment=NODE_ENV=production
Environment=PWD=/home/<username>/repos/wekan/.build/bundle
Environment=PORT=3000
Environment=HTTP_FORWARDED_COUNT=1
Environment=MONGO_URL=mongodb://127.0.0.1:27017/admin
; https://example.com/wekan for deployment
Environment=ROOT_URL=http://localhost/wekan
Environment=MAIL_URL='smtp://user:pass@mailserver.example.com:25/'
[Install]
WantedBy=multi-user.target
To start Wekan and enable service, change to your username where Wekan files are:
sudo systemctl daemon-reload
sudo systemctl start wekan@<username>
sudo systemctl enable wekan@<username>
To stop Wekan and disable service, change to your username where Wekan files are:
sudo systemctl daemon-reload
sudo systemctl stop wekan@<username>
sudo systemctl disable wekan@<username>
Checkout instructions for setup with Caddy Webserver Config and Nginx Webserver Config respectively.
Windows
Building on Windows (if it works) is a lot slower than on Linux/Mac.
Wekan
General
- 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
Fake: Not WeKan kanban
Security
- Allow private boards only: Disable Public Boards
- Security Disclosure and details of Security in Wekan
- Security issues
- Password Hashing
Scaling
- Cron: Hourly restart WeKan, because of memory leaks
- Maybe: 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
Migrating
- 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
Support priorities for new features and bugfixes
Backup
Repair
- Repair MongoDB
- Using Meteor MongoDB to repair files
- If board does not open and keeps loading
- Repair Docker
Themes
Markdown Syntax
- Wekan Markdown
- Emoji
- Mermaid Diagram DOES NOT WORK ANYMORE
- Numbered text
Login Auth
- 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
Metrics, Logs, Stats
Integrations
Time
Features
- Multiline
- Linked Cards
- 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
Required Settings
Download
- Download Wekan for various Platforms: Supported by xet7, Operating Systems, NAS, Cloud
- Helm Chart for Kubernetes
Webservers
- Caddy
- Nginx
- Apache
- OpenLiteSpeed
- Local self signed TLS
- Let's Encrypt and Google Auth
- TLS with Node.js
- Traefik and self-signed SSL certs
REST API Docs
REST API issue
REST API client code
- 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
Webhooks
- 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
Case Studies
Development
- Kadira integration
- Debugging
- Developer Docs for Standalone Wekan
- Developer Docs for Sandstorm Wekan
- Adding new Snap setting to code
- Directory Structure
- Building Wekan for Sandstorm
- Docs - Sandstorm etc
- Beginner
- Maintainer FAQ
Issues
Wekan - OpenSource Kanban