Less direct links, to make wiki more work outside of GitHub.

Lauri Ojansivu 2022-07-11 18:12:48 +03:00
parent 30021454eb
commit f4003622b2
68 changed files with 349 additions and 350 deletions

9
AWS.md

@ -74,8 +74,7 @@ sudo systemctl start nginx
sudo systemctl enable nginx
```
Example nginx config at:
https://github.com/wekan/wekan/wiki/Nginx-Webserver-Config
[Example nginx config](Nginx-Webserver-Config)
Test nginx config with:
@ -99,7 +98,7 @@ For example Wekan v0.70, use in docker-compose.yml file:
image: quay.io/wekan/wekan:v0.70
Only use release version tags, because latest tag can be broken sometimes.
12) For email, in AWS SES add email address to domain, verify SPF and DKIM with Route53 wizard if you have domain at Route53 as I recommend. At SES create new SMTP credentials and add them to docker-compose.yml SMTP settings, see https://github.com/wekan/wekan/wiki/Troubleshooting-Mail
12) For email, in AWS SES add email address to domain, verify SPF and DKIM with Route53 wizard if you have domain at Route53 as I recommend. At SES create new SMTP credentials and [add them to docker-compose.yml SMTP settings](Troubleshooting-Mail)
13) Start wekan and mongodb database containers with command:
@ -111,7 +110,7 @@ So it goes nginx SSL port 443 => proxy to localhost port 8080 or any other => we
14) For different customers have different docker-compose.yml script in directories named by customer names. You may need to rename docker containers from wekan-app to wekan-customer1 etc, and probably also docker internal network names.
15) Backup, restore, and moving data outside/inside docker https://github.com/wekan/wekan/wiki/Export-Docker-Mongo-Data
15) [Backup, restore, and moving data outside/inside docker](Export-Docker-Mongo-Data)
16) Register as user at https://subdomain.yourdomain.com/customer1/sign-up and login at https://subdomain.yourdomain.com/customer1/sign-in , first user will be admin. Click your username at top right corner / Admin Panel, and there chang settings to invite only.
@ -184,4 +183,4 @@ docker-compose up -d
TODO:
- allow resend invites https://github.com/wekan/wekan/issues/1320
- changing logo everywhere, whitelabeling https://github.com/wekan/wekan/issues/1196
- changing logo everywhere, whitelabeling https://github.com/wekan/wekan/issues/1196

@ -6,7 +6,7 @@
Add all necessary settings that you find on code.
After doing all changes, [fix lint errors](https://github.com/wekan/wekan/wiki/Developer-Documentation#preventing-travis-ci-lint-errors-before-submitting-pull-requests) and if possible warnings too. You can silence errors if you really can't find solution.
After doing all changes, [fix lint errors](Developer-Documentation#preventing-travis-ci-lint-errors-before-submitting-pull-requests) and if possible warnings too. You can silence errors if you really can't find solution.
Submit pull request to Wekan edge branch https://github.com/wekan/wekan/tree/edge

@ -13,7 +13,7 @@ If you really want email sending, do for example:
sudo snap set wekan mail-url='smtps://user:pass@mailserver.example.com:457/'
sudo snap set wekan mail-from='Example Wekan Support <support@example.com>'
```
For more options see [Troubleshooting Email](https://github.com/wekan/wekan/wiki/Troubleshooting-Mail)
For more options see [Troubleshooting Email](Troubleshooting-Mail)
5) Login to Wekan at https://example.com/sign-in (your address + /sign-in)

@ -34,7 +34,7 @@ Edit start-wekan.sh so you can start Wekan for example:
ROOT_URL=http://IP-ADDRESS:2000
PORT=2000
```
Then you can use any computer or mobile phone Javascript capable webbrowser at WLAN to use Wekan at http://IP-ADDRESS:2000 like http://192.168.0.100:2000 . [More info about ROOT_URL](https://github.com/wekan/wekan/wiki/Settings).
Then you can use any computer or mobile phone Javascript capable webbrowser at WLAN to use Wekan at http://IP-ADDRESS:2000 like http://192.168.0.100:2000 . [More info about ROOT_URL](Settings).
## 4) Optional: Mobile Linux Desktop

@ -1,6 +1,6 @@
### Install for example from:
- [Snap](https://github.com/wekan/wekan/wiki/Snap)
- [Docker](https://github.com/wekan/wekan/wiki/Docker)
- [Snap](Snap)
- [Docker](Docker)
*Make sure you are running at least **v2.21***

@ -1,4 +1,4 @@
[Sandstorm](https://github.com/wekan/wekan/wiki/Sandstorm) - [Sandstorm Backup](https://github.com/wekan/wekan/wiki/Export-from-Wekan-Sandstorm-grain-.zip-file)
[Sandstorm](Sandstorm) - [Sandstorm Backup](Export-from-Wekan-Sandstorm-grain-.zip-file)
# Backup Docker
@ -136,7 +136,7 @@ https://nosqlbooster.com/downloads
For below scheduled backup scripts, no info from above of this wiki page is required. Backup scripts below have the required settings.
This does backup of [Wekan+RocketChat snap databases](https://github.com/wekan/wekan/wiki/OAuth2) and php website etc.
This does backup of [Wekan+RocketChat snap databases](OAuth2) and php website etc.
If you need to backup some remote server or cloud, you can use scp, or read [rclone docs](https://rclone.org/docs/) about how to configure saving to some other remote server or cloud.
@ -445,7 +445,7 @@ cat board.json | xclip -se c
```
Then paste to webbrowser Wekan Add Board / Import / From previous export.
You can [save all MongoDB database content as JSON files](https://github.com/wekan/wekan/wiki/Export-from-Wekan-Sandstorm-grain-.zip-file). Files are base64 encoded in JSON files.
You can [save all MongoDB database content as JSON files](Export-from-Wekan-Sandstorm-grain-.zip-file). Files are base64 encoded in JSON files.
Export board to Wekan JSON, and import as Wekan JSON can make some part of board to load, but you should check is some data missing.
@ -687,7 +687,7 @@ makesRestore $1
## Docker Backup and Restore
[Docker Backup and Restore](https://github.com/wekan/wekan/wiki/Export-Docker-Mongo-Data)
[Docker Backup and Restore](Export-Docker-Mongo-Data)
[Wekan Docker Upgrade](https://github.com/wekan/wekan-mongodb#backup-before-upgrading)
@ -701,11 +701,11 @@ makesRestore $1
Download Wekan grain with arrow down download button to .zip file. You can restore it later.
[Export data from Wekan Sandstorm grain .zip file](https://github.com/wekan/wekan/wiki/Export-from-Wekan-Sandstorm-grain-.zip-file)
[Export data from Wekan Sandstorm grain .zip file](Export-from-Wekan-Sandstorm-grain-.zip-file)
## <a name="cloudron">Cloudron
If those [Backup](https://github.com/wekan/wekan/wiki/Backup) ways are not easily found at [Cloudron](https://github.com/wekan/wekan/wiki/Cloudron), one way is to install [Redash](https://redash.io/) and then backup this way:
If those [Backup](Backup) ways are not easily found at [Cloudron](Cloudron), one way is to install [Redash](https://redash.io/) and then backup this way:
Redash works with this kind of queries:
```json
@ -766,8 +766,8 @@ but downloading with API script still works:
7) Repeat steps 1-4 and 6 for every collection/table like boards,cards, etc
8) Remove from downloaded .json files extra query related data, so that it is similar like [any other Wekan database backup JSON files](https://github.com/wekan/wekan/wiki/Export-from-Wekan-Sandstorm-grain-.zip-file)
8) Remove from downloaded .json files extra query related data, so that it is similar like [any other Wekan database backup JSON files](Export-from-Wekan-Sandstorm-grain-.zip-file)
9) Insert data to some other Wekan install with nosqlbooster like mentioned at page [Backup](https://github.com/wekan/wekan/wiki/Backup)
9) Insert data to some other Wekan install with nosqlbooster like mentioned at page [Backup](Backup)

@ -2,13 +2,13 @@ If you know updates to this, please add new issue about it.
## Webkit based
Browser | [PWA](https://github.com/wekan/wekan/wiki/PWA) | Mobile | Desktop | OS
Browser | [PWA](PWA) | Mobile | Desktop | OS
------- | ----| ------ | ------- | -------
Safari | iOS Yes | iOS Newest | Newest | iOS, macOS
## Firefox based
Browser | [PWA](https://github.com/wekan/wekan/wiki/PWA) | Mobile | Desktop | OS
Browser | [PWA](PWA) | Mobile | Desktop | OS
------- | ----| ------ | ------- | -------
[Mypal](https://feodor2.github.io/Mypal/) | No | No | Newest | [Mypal on WinXP works](https://feodor2.github.io/Mypal/), [issue](https://github.com/wekan/wekan/issues/3132), [Other XP browsers probably not](http://www.xpbrowsers.com/)
Firefox | Android Yes | Android Newest | Newest | Win 7 and newer, macOS, Linux, RasPi
@ -17,7 +17,7 @@ Morph Browser | No | Yes | Yes | [Ubuntu Touch](https://ubports.com) (based on U
## Chromium based
Browser | [PWA](https://github.com/wekan/wekan/wiki/PWA) | Mobile | Desktop | OS
Browser | [PWA](PWA) | Mobile | Desktop | OS
------- | ----| ------ | ------- | -------
Chrome | Android Yes | Android Newest | Newest | Win 7 and newer, macOS, Linux
Chromium | Android Yes | Android Newest | Newest | Win 7 and newer, macOS, Linux, RasPi
@ -28,13 +28,13 @@ Credge | Android Yes. Microsoft Store App sometime later (currently EdgeHTML). |
## EdgeHTML based
Browser | [PWA](https://github.com/wekan/wekan/wiki/PWA) | Mobile | Desktop | OS
Browser | [PWA](PWA) | Mobile | Desktop | OS
------- | ----| ------ | ------- | -------
Legacy Edge | Yes | Yes | Yes | Windows (maybe others also?) with Wekan v4.19 and newer
[Microsoft Store App](https://www.microsoft.com/fi-fi/p/wekan/9p2mrxvd087r#activetab=pivot:overviewtab) | Yes | Yes | Yes | At Microsoft Store of Windows 10 desktop. Based on [Wekan PWA](https://boards.wekan.team/b/D2SzJKZDS4Z48yeQH/wekan-open-source-kanban-board-with-mit-license/s7SkzYviC2e963FkT), uses Legacy Edge browser with Wekan demo & development server https://boards.wekan.team . Sometime in future there will be possible to create CredgeHTML based app.
## MSHTML based
Browser | [PWA](https://github.com/wekan/wekan/wiki/PWA) | Mobile | Desktop | OS
Browser | [PWA](PWA) | Mobile | Desktop | OS
------- | ----| ------ | ------- | -------
Internet Explorer | No | No | No | No | No

@ -1,4 +1,4 @@
[Caddy OAuth2 with Let's Encrypt SSL example](https://github.com/wekan/wekan/wiki/OAuth2)
[Caddy OAuth2 with Let's Encrypt SSL example](OAuth2)
***

@ -222,7 +222,7 @@ So then you can browse to http://wekan.example.com:2000 from Chromebook Ubuntu F
#### Mobile app icon
For iOS and Android, you can [create app PWA icon this way](https://github.com/wekan/wekan/wiki/PWA).
For iOS and Android, you can [create app PWA icon this way](PWA).
## 7) Optional: Change Linux desktop apps language and install Firefox

@ -16,4 +16,4 @@ You can also test the wekan installation on the demo Cloudron instance - https:/
# Backup
[Backup Cloudron](https://github.com/wekan/wekan/wiki/Backup#Cloudron)
[Backup Cloudron](Backup#Cloudron)

@ -18,7 +18,7 @@ https://github.com/wekan/wekan-snap/wiki/Automatic-update-schedule
***
Also see: [Dark Mode](https://github.com/wekan/wekan/wiki/Dark-Mode)
Also see: [Dark Mode](Dark-Mode)
All Wekan themes are directly integrated to Wekan. You can add pull request to master branch to add custom theme, you can see from [from this commit](https://github.com/wekan/wekan/commit/34b2168d0dda253dedabbee47031873efa4ae446) required new color/theme name and changes to these files 3 files listed below. In that commit is also changes to other files, you don't need to change those files.
- `wekan/client/components/boards/boardColors.styl`

@ -1,6 +1,6 @@
- [Snap](https://github.com/wekan/wekan/wiki/Snap)
- [Docker](https://github.com/wekan/wekan/wiki/Docker)
- [Source](https://github.com/wekan/wekan/wiki/Source)
- [Snap](Snap)
- [Docker](Docker)
- [Source](Source)
- [Unofficial debian package](https://github.com/soohwa/wekan-deb/releases) with build and installation instructions [here](https://github.com/soohwa/wekan-deb)
### Old install scripts

@ -38,7 +38,7 @@
## Scaling to thousands of users
[Production setup at AWS](https://github.com/wekan/wekan/wiki/AWS)
[Production setup at AWS](AWS)
## Current versions of dependencies

@ -16,7 +16,7 @@ Please read the meteor style guide before making any significant contribution.
## Building code and submitting pull request
- [Building code and submitting pull request](https://github.com/wekan/wekan/wiki/emoji#how-you-could-add-another-plugin)
- [Building code and submitting pull request](emoji#how-you-could-add-another-plugin)
- When you start `meteor` command, it watches for changes to files in wekan directory and subdirectories, and if it detects changed code, it starts rebuilding bundle and then reloads webbrowser after that automatically
- Also look at meteor changelog mentioned new feature `hot reload` how that could make reloading faster
@ -37,7 +37,7 @@ When you run this, you see .jade template files where is search input box, and .
## Getting Started
- Currently Wekan development is done mainly at Ubuntu 20.10 64bit, but building Wekan does work on any Debian, Ubuntu, WSL Ubuntu 20.04, [Mac](https://github.com/wekan/wekan/wiki/Mac). Sametime maybe on [Windows](https://github.com/wekan/wekan/wiki/Windows) with `choco install -y meteor` and installing packages it then asks for with `meteor add ...` or `meteor npm install --save ...` and then running meteor again.
- Currently Wekan development is done mainly at Ubuntu 20.10 64bit, but building Wekan does work on any Debian, Ubuntu, WSL Ubuntu 20.04, [Mac](Mac). Sametime maybe on [Windows](Windows) with `choco install -y meteor` and installing packages it then asks for with `meteor add ...` or `meteor npm install --save ...` and then running meteor again.
- Look through old [pull requests](https://github.com/wekan/wekan/pulls)
- Read Wekan source code, you can use some git history viewer GUI like gitk
- Read [Meteor documentation](https://docs.meteor.com/) for [Meteor version](https://github.com/wekan/wekan/blob/master/.meteor/release) in use, other versions mentioned at [Dockerfile](https://github.com/wekan/wekan/blob/master/Dockerfile)
@ -89,7 +89,7 @@ It's possible to import your existing boards from Trello. Instructions [[here|mi
# Directory Structure Details
[Directory Structure](https://github.com/wekan/wekan/wiki/Directory-Structure)
[Directory Structure](Directory-Structure)
# Chat

@ -2,7 +2,7 @@
## Repair Docker
[Repair Docker](https://github.com/wekan/wekan/wiki/Repair-Docker)
[Repair Docker](Repair-Docker)
## Using only Docker commands
@ -71,9 +71,9 @@ quay.io/wekan/wekan
## Backup and Upgrade
[Import/Export MongoDB data to/from Docker container](https://github.com/wekan/wekan/wiki/Export-Docker-Mongo-Data)
[Import/Export MongoDB data to/from Docker container](Export-Docker-Mongo-Data)
[Move Docker containers to other computer](https://github.com/wekan/wekan/wiki/Move-Docker-containers-to-other-computer), needs more details
[Move Docker containers to other computer](Move-Docker-containers-to-other-computer), needs more details
### Backup before upgrade
```
@ -129,25 +129,25 @@ TODO: [Docker Compose: Wekan <=> MongoDB <=> ToroDB => MySQL read-only mirroring
## OpenShift
[OpenShift](https://github.com/wekan/wekan/wiki/OpenShift)
[OpenShift](OpenShift)
## SLES
[SLES SP1](https://github.com/wekan/wekan/wiki/Install-Wekan-Docker-on-SUSE-Linux-Enterprise-Server-12-SP1)
[SLES SP1](Install-Wekan-Docker-on-SUSE-Linux-Enterprise-Server-12-SP1)
## Rancher
[Rancher Rancher Active Proxy](https://github.com/wekan/wekan/wiki/Rancher---Rancher-Active-Proxy---Wekan-MongoDB-Docker)
[Rancher Rancher Active Proxy](Rancher---Rancher-Active-Proxy---Wekan-MongoDB-Docker)
## Testing
[Install for testing](https://github.com/wekan/wekan/wiki/Install-Wekan-Docker-for-testing)
[Install for testing](Install-Wekan-Docker-for-testing)
## Production
[Production setup for thousands of users with Docker at AWS](https://github.com/wekan/wekan/wiki/AWS)
[Production setup for thousands of users with Docker at AWS](AWS)
[Other way to do production](https://github.com/wekan/wekan/wiki/Install-Wekan-Docker-in-production)
[Other way to do production](Install-Wekan-Docker-in-production)
## External MongoDB auth
@ -218,6 +218,6 @@ sudo docker-compose up -d --build
## Webserver Config
* [Caddy Webserver Config](https://github.com/wekan/wekan/wiki/Caddy-Webserver-Config)
* [Nginx Webserver Config](https://github.com/wekan/wekan/wiki/Nginx-Webserver-Config)
* [Apache Webserver Config](https://github.com/wekan/wekan/wiki/Apache)
* [Caddy Webserver Config](Caddy-Webserver-Config)
* [Nginx Webserver Config](Nginx-Webserver-Config)
* [Apache Webserver Config](Apache)

@ -56,7 +56,7 @@ For example:
```
meteor --port 4000
```
And then [register and login](https://github.com/wekan/wekan/wiki/Adding-users) at http://localhost:4000
And then [register and login](Adding-users) at http://localhost:4000
### 7. Test

@ -147,7 +147,7 @@ In Wekan Snap, database files are in directory `/var/snap/wekan/common` - if you
[Snap Backup and Restore](https://github.com/wekan/wekan-snap/wiki/Backup-and-restore)
[Docker Backup and Restore](https://github.com/wekan/wekan/wiki/Export-Docker-Mongo-Data)
[Docker Backup and Restore](Export-Docker-Mongo-Data)
## 6) Change database file permissions to root user
@ -185,7 +185,7 @@ Wekan Docker: If you have MongoDB exposed to outside Docker, Connect with Robo3T
[Snap Backup and Restore](https://github.com/wekan/wekan-snap/wiki/Backup-and-restore)
[Docker Backup and Restore](https://github.com/wekan/wekan/wiki/Export-Docker-Mongo-Data)
[Docker Backup and Restore](Export-Docker-Mongo-Data)
## 10) Browse data in Robo 3T

18
FAQ.md

@ -18,16 +18,16 @@ that by providing one-click installation on various platforms.
- Wekan is used in [most countries of the world](https://snapcraft.io/wekan).
- Wekan largest user has 13k users using Wekan in their company.
- Wekan has been [translated](https://transifex.com/wekan/wekan) to about 50 languages.
- [Features](https://github.com/wekan/wekan/wiki/Features): Wekan has real-time user interface.
- [Platforms](https://github.com/wekan/wekan/wiki/Platforms): Wekan supports many platforms.
- [Features](Features): Wekan has real-time user interface.
- [Platforms](Platforms): Wekan supports many platforms.
Wekan is critical part of new platforms Wekan is currently being integrated to.
- [Integrations](https://github.com/wekan/wekan/Integrations): Current possible integrations and future plans.
- [Integrations](Integrations): Current possible integrations and future plans.
## Requirements
- 64bit: Linux [Snap](https://github.com/wekan/wekan-snap/wiki/Install) or [Sandstorm](https://sandstorm.io) /
[Mac](https://github.com/wekan/wekan/wiki/Mac) / [Windows](https://github.com/wekan/wekan/wiki/Install-Wekan-from-source-on-Windows).
[More Platforms](https://github.com/wekan/wekan/wiki/Platforms). [ARM progress](https://github.com/wekan/wekan/issues/1053#issuecomment-410919264).
[Mac](Mac) / [Windows](Install-Wekan-from-source-on-Windows).
[More Platforms](Platforms). [ARM progress](https://github.com/wekan/wekan/issues/1053#issuecomment-410919264).
- 1 GB RAM minimum free for Wekan. Production server should have miminum total 4 GB RAM.
For thousands of users, for example with [Docker](https://github.com/wekan/wekan/blob/master/docker-compose.yml): 3 frontend servers,
each having 2 CPU and 2 wekan-app containers. One backend wekan-db server with many CPUs.
@ -37,7 +37,7 @@ that by providing one-click installation on various platforms.
Wekan on Sandstorm is not usually affected by any Standalone Wekan (Snap/Docker/Source) security issues.
- [Reporting all new bugs immediately](https://github.com/wekan/wekan/issues).
New features and fixes are added to Wekan [many times a day](https://github.com/wekan/wekan/blob/master/CHANGELOG.md).
- [Backups](https://github.com/wekan/wekan/wiki/Backup) of Wekan database once a day miminum.
- [Backups](Backup) of Wekan database once a day miminum.
Bugs, updates, users deleting list or card, harddrive full, harddrive crash etc can eat your data. There is no undo yet.
Some bug can cause Wekan board to not load at all, requiring manual fixing of database content.
@ -76,7 +76,7 @@ Usually:
* Slowest: Once a month.
* One release contains anything from one typo fix to many major features and bugfixes.
For [Wekan Platforms](https://github.com/wekan/wekan/wiki/Platforms), it means these choices:
For [Wekan Platforms](Platforms), it means these choices:
* Snap: You get updates automatically immediately, or updates automatically scheduled at midnight
* Source/Docker/VirtualBox: You need to test and install new Wekan version yourself
@ -107,7 +107,7 @@ c) Develop feature yourself and submit it as pull requests to devel [Wekan repo]
For Sandstorm-specific features, have the feature enabled in Sandstorm by using environment variable isSandstorm = true like is at wekan/sandstorm.js .
In wiki there is [Developer Documentation](https://github.com/wekan/wekan/wiki/Developer-Documentation).
In wiki there is [Developer Documentation](Developer-Documentation).
## Will you accept my pull request?
We totally rely on pull requests for new features and bug fixes. If your pull request works, it's very likely to be accepted by xet7.
@ -133,7 +133,7 @@ Yes, Libreboard was the old project name, which superseded the even older projec
After renaming it to Libreboard, a [new logo] was designed and the project continued to live on as Libreboard. Unfortunately it turned out, that the new logo was apparently ripped-off from a [concept] published at Dribbble, and so a new logo had to be found. There were a lot of [ideas from the community][logo-ticket], and at the end Maxime [proposed][wekan-proposal] a completely new name, Wekan, together with a design proposal for a new logo.
## What was Wekan fork / Wefork?
After 2016-09-02 there were no pull requests reviewed and integrated for nearly 2 months. At 2016-10-20 Wekan community created fork and started merging many bugfixes and new features into Wefork. 2017-01-29 Wekan author mquandalle gave access to Wekan and at 2017-01-31 xet7 started merging Wefork back to Wekan. 2017-02-08 All of Wefork is now merged and moved back to official Wekan. Wefork will not accept any new issues and pull requests. All development happens on Wekan. [Wefork announcement and merging back](https://github.com/wekan/wekan/issues/640#issuecomment-276383458), more info: [Team](https://github.com/wekan/wekan/wiki/Team)
After 2016-09-02 there were no pull requests reviewed and integrated for nearly 2 months. At 2016-10-20 Wekan community created fork and started merging many bugfixes and new features into Wefork. 2017-01-29 Wekan author mquandalle gave access to Wekan and at 2017-01-31 xet7 started merging Wefork back to Wekan. 2017-02-08 All of Wefork is now merged and moved back to official Wekan. Wefork will not accept any new issues and pull requests. All development happens on Wekan. [Wefork announcement and merging back](https://github.com/wekan/wekan/issues/640#issuecomment-276383458), more info: [Team](Team)
## What is the difference between Wekan and Trello?
The main difference between the two is that Wekan is completely open source and available under the permissive MIT license. That makes it possible to host it on your own server (or your company's or organization's server) and you keep the full control over all data. No need to fear it will disappear some day, like a commercial service like Trello could.

@ -129,9 +129,9 @@ NOTE: There is user admin as "People" in Admin Panel, but no screenshot here yet
## API
* [REST API Issue](https://github.com/wekan/wekan/issues/1037)
* [REST API Docs](https://github.com/wekan/wekan/wiki/REST-API)
* [REST API Docs](REST-API)
* [Python client to REST API](https://github.com/wekan/wekan-python-api-client)
* [Wekan Sandstorm cards to CSV using Python](https://github.com/wekan/wekan/wiki/Wekan-Sandstorm-cards-to-CSV-using-Python)
* [Wekan Sandstorm cards to CSV using Python](Wekan-Sandstorm-cards-to-CSV-using-Python)
## Webhooks
Sending notifications for board activities. Tested with [Slack](https://slack.com/) and [Rocket.chat](https://rocket.chat/).
@ -143,7 +143,7 @@ Content-type: application/json
}
```
Different activities send different webhook data. You can find the details in the wiki page [Webhook data](https://github.com/wekan/wekan/wiki/Webhook-data)
Different activities send different webhook data. You can find the details in the wiki page [Webhook data](Webhook-data)
* [Outgoing Webhooks](https://github.com/wekan/wekan/pull/1119)
@ -223,6 +223,6 @@ ElasticSearch / Kibana (ELK)](https://github.com/wekan/wekan-logstash)
# More
[Platforms](https://github.com/wekan/wekan/wiki/Platforms)
[Platforms](Platforms)
[Integrations](https://github.com/wekan/wekan/wiki/Integrations)
[Integrations](Integrations)

@ -111,7 +111,7 @@ More info:
## OLD INFO BELOW:
1) Download [Robo 3T](https://robomongo.org) on your Linux or Mac computer. Or, using ssh shell to server, [login to MongoDB database using mongo cli](https://github.com/wekan/wekan/wiki/Backup#mongodb-shell-on-wekan-snap)
1) Download [Robo 3T](https://robomongo.org) on your Linux or Mac computer. Or, using ssh shell to server, [login to MongoDB database using mongo cli](Backup#mongodb-shell-on-wekan-snap)
2) Make SSH tunnel to your server, from your local port 9000 (or any other) to server MongoDB port 27019:
```
@ -139,7 +139,7 @@ d) Backup, New install, Create User, Copy Password, Restore:
1. [Backup Snap](https://github.com/wekan/wekan-snap/wiki/Backup-and-restore)
2. stop wekan `sudo snap stop wekan.wekan`
3a. Empty database by dropping wekan database in Mongo 3T
3b. Empty database in [mongo cli](mongo cli](https://github.com/wekan/wekan/wiki/Backup#mongodb-shell-on-wekan-snap):
3b. Empty database in [mongo cli](mongo cli](Backup#mongodb-shell-on-wekan-snap):
```
mongo --port 27019
```

@ -24,7 +24,7 @@ https://www.youtube.com/watch?v=SB4dNC7u2MU
## Roadmap
It's possible to use Wekan with Friend and [there will be more Wekan integration to Friend](https://github.com/wekan/wekan/milestone/60) so [now 2019-06-30 that Wekan also works at RasPi3](https://github.com/wekan/wekan/wiki/Raspberry-Pi) like Friend already works, it makes possible local RasPi3-only network.
It's possible to use Wekan with Friend and [there will be more Wekan integration to Friend](https://github.com/wekan/wekan/milestone/60) so [now 2019-06-30 that Wekan also works at RasPi3](Raspberry-Pi) like Friend already works, it makes possible local RasPi3-only network.
Then on local network you can use RasPi3 Cromium or Friend mobile/tablet Android/iOS app to connect to local network Friend desktop, also possible without connection to Internet.
@ -172,7 +172,7 @@ ln -s ~/repos/mysupermodule mysupermodule
sudo apt-get -y install snapd
sudo snap install wekan
```
### 13. [ROOT_URL settings](https://github.com/wekan/wekan/wiki/Settings)
### 13. [ROOT_URL settings](Settings)
```
sudo snap set wekan root-url='http://localhost:5000'
sudo snap set wekan port='5000'
@ -225,7 +225,7 @@ iOS App Store for iPhone/iPad: If not at App Store, ask
Using Friend Android app to connect to your Friend server URL.
There is also Friend iOS app, but I think it's not yet officially released. If someone is interested, invite to iOS Testflight can be had from [Friend chat](https://github.com/wekan/wekan/wiki/Friend).
There is also Friend iOS app, but I think it's not yet officially released. If someone is interested, invite to iOS Testflight can be had from [Friend chat](Friend).
# Adding app icons to Friend desktop menus

@ -120,4 +120,4 @@ sudo snap start wekan.wekan
# UCS
[Gantt feature at UCS](https://github.com/wekan/wekan/wiki/UCS#gantt)
[Gantt feature at UCS](UCS#gantt)

@ -145,9 +145,9 @@ A:
- Do you have time to be Wekan co-maintainer?
- What is URL to your fork? Please send it to me with email to x@xet7.org . Thanks! Currently there is about 2200 forks of Wekan, it would be hard to find without exact URL.
- What features and fixes have you implemented to Wekan?
- [What usually happens when Wekan gets broken](https://github.com/wekan/wekan/wiki/Test-Edge#what-usually-happens-when-wekan-gets-broken).
- [What usually happens when Wekan gets broken](Test-Edge#what-usually-happens-when-wekan-gets-broken).
- [Benefits of contributing your features to upstream Wekan](https://blog.wekan.team/2018/02/benefits-of-contributing-your-features-to-upstream-wekan/index.html).
- [What was Wekan fork](https://github.com/wekan/wekan/wiki/FAQ#what-was-wekan-fork--wefork).
- [What was Wekan fork](FAQ#what-was-wekan-fork--wefork).
***
### Q: Other mobile browsers?
@ -312,7 +312,7 @@ Without that info it's kind of hard to debug.
You could try export that board to Wekan JSON, and then import that Wekan JSON.
I do have server at AWS LightSail that has 4 GB RAM and 60 GB SSD,
running [Snap versions of Wekan and RocketChat installed this way](https://github.com/wekan/wekan/wiki/OAuth2)
running [Snap versions of Wekan and RocketChat installed this way](OAuth2)
on same server, and it does not crash.
BTW, I did yesterday release [Wekan v2.95 with these new features](https://github.com/wekan/wekan/blob/master/CHANGELOG.md#v295-2019-07-01-wekan-release).
@ -338,7 +338,7 @@ for answers a little later
[02:25:24] <Rojola1> xet7?
[02:25:27] <Rojola1> anyone?
```
A: I was at meeting or sleeping when you asked. When I came back to IRC you were not online. Anyway, you can [make backup](https://github.com/wekan/wekan/wiki/Backup) and do some [cleanup](https://github.com/wekan/wekan-cleanup) to delete 1,5 years worth of activities etc. Next time, if you have questions, you get faster answers at [GitHub issues](https://github.com/wekan/wekan/issues), because I get email notifications of all new issues and comments on issues.
A: I was at meeting or sleeping when you asked. When I came back to IRC you were not online. Anyway, you can [make backup](Backup) and do some [cleanup](https://github.com/wekan/wekan-cleanup) to delete 1,5 years worth of activities etc. Next time, if you have questions, you get faster answers at [GitHub issues](https://github.com/wekan/wekan/issues), because I get email notifications of all new issues and comments on issues.
***
### Q: Rules as code?
@ -405,7 +405,7 @@ from one card to another.
### Q: LDAP?
A: [LDAP for Standalone is now available](https://github.com/wekan/wekan/wiki/LDAP).
A: [LDAP for Standalone is now available](LDAP).
```
[17:56:10] <regdude> Hi! I'm trying to setup Wekan with LDAP,
@ -476,7 +476,7 @@ from Snap on Ubuntu 18.04.
[17:38:51] <k_sze> Like, I get 502 Bad Gateway from my nginx reverse proxy
```
A: Did you set your domain SPF records (as TXT records) and DKIM records on your domain that your SMTP server uses? Problem is not in Wekan, it's your SMTP server. For example AWS SES works. Also see [Troubleshooting Email](https://github.com/wekan/wekan/wiki/Troubleshooting-Mail).
A: Did you set your domain SPF records (as TXT records) and DKIM records on your domain that your SMTP server uses? Problem is not in Wekan, it's your SMTP server. For example AWS SES works. Also see [Troubleshooting Email](Troubleshooting-Mail).
***
@ -487,7 +487,7 @@ other applications
[03:32:50] <ajay> i am want to integrate it in QGIS for task management
[03:33:01] <ajay> *i want
```
A: Use [Wekan REST API](https://github.com/wekan/wekan/wiki/REST-API). For example, see [Wekan Gogs integration](https://github.com/wekan/wekan-gogs). You can also use [Outgoing Webhooks](https://github.com/wekan/wekan/wiki/Outgoing-Webhook-to-Discord) to send data to some Incoming Webhook. There is also [IFTTT Rules](https://github.com/wekan/wekan/wiki/IFTTT) for some automations.
A: Use [Wekan REST API](REST-API). For example, see [Wekan Gogs integration](https://github.com/wekan/wekan-gogs). You can also use [Outgoing Webhooks](Outgoing-Webhook-to-Discord) to send data to some Incoming Webhook. There is also [IFTTT Rules](IFTTT) for some automations.
***
@ -602,7 +602,7 @@ yogab> Hi! How are you today ? Can i ask
a docker x reverse proxy x wekan question here ?
```
A: Hmm, it seems you did not ask. Just guessing, maybe it's about [Traefik reverse proxy and Docker](https://github.com/wekan/wekan/wiki/Traefik-and-self-signed-SSL-certs).
A: Hmm, it seems you did not ask. Just guessing, maybe it's about [Traefik reverse proxy and Docker](Traefik-and-self-signed-SSL-certs).
***

@ -1,4 +1,4 @@
# Different wiki page: [Production setup for thousands of users at AWS](https://github.com/wekan/wekan/wiki/AWS)
# Different wiki page: [Production setup for thousands of users at AWS](AWS)
***
@ -22,13 +22,13 @@ https://github.com/wekan/wekan-mongodb
## 3. Email
[Troubleshooting Email](https://github.com/wekan/wekan/wiki/Troubleshooting-Mail)
[Troubleshooting Email](Troubleshooting-Mail)
## 4. Configure webserver as a front-end proxy
* [Caddy](https://github.com/wekan/wekan/wiki/Caddy-Webserver-Config)
* [Nginx](https://github.com/wekan/wekan/wiki/Nginx-Webserver-Config)
* [Apache](https://github.com/wekan/wekan/wiki/Apache)
* [Caddy](Caddy-Webserver-Config)
* [Nginx](Nginx-Webserver-Config)
* [Apache](Apache)
## 5. Launch Wekan

@ -1,6 +1,6 @@
More complete Docker info at:
* [Docker](https://github.com/wekan/wekan/wiki/Docker)
* [Docker](Docker)
Tested to work on AWS cloud:

@ -1,4 +1,4 @@
Also see: [Excel and VBA](https://github.com/wekan/wekan/wiki/Excel-and-VBA)
Also see: [Excel and VBA](Excel-and-VBA)
# THIS WORKS

@ -1 +1 @@
Moved to [Platforms](https://github.com/wekan/wekan/wiki/Platforms)
Moved to [Platforms](Platforms)

@ -3,10 +3,10 @@ In-progress script for installing npm modules locally. Not tested.
Anyone: If you get this working, edit this wiki and add remaining to be installed locally.
## TODO
- Add MongoDB running locally like at wiki page [Install from source](https://github.com/wekan/wekan/wiki/Install-and-Update#install-mongodb-1)
- Add MongoDB running locally like at wiki page [Install from source](Install-and-Update#install-mongodb-1)
- Add node.js, npm etc installed locally
- Update [wekan-autoinstall](https://github.com/wekan/wekan-autoinstall), please send pull requests
- Update [Install from source](https://github.com/wekan/wekan/wiki/Install-and-Update#install-mongodb-1) so then this temporary page can possibly be removed later
- Update [Install from source](Install-and-Update#install-mongodb-1) so then this temporary page can possibly be removed later
## Related info
- Node.js and npm version downloaded at [Dockerfile](https://github.com/wekan/wekan/blob/master/Dockerfile)
@ -54,4 +54,4 @@ npm -g install fibers@1.0.15
## Install meteor
Continue at [Install from source](https://github.com/wekan/wekan/wiki/Install-and-Update#install-manually-from-source)
Continue at [Install from source](Install-and-Update#install-manually-from-source)

@ -1,7 +1,7 @@
# Current
* [PostgreSQL](https://github.com/wekan/wekan/tree/master/torodb-postgresql)
* [Webhooks](https://github.com/wekan/wekan/wiki/Features#webhooks), works by showing board activities with [Slack](https://slack.com/), [Rocket.chat](https://rocket.chat/) and others that supports Webhooks.
* [Webhooks](Features#webhooks), works by showing board activities with [Slack](https://slack.com/), [Rocket.chat](https://rocket.chat/) and others that supports Webhooks.
* [Gogs Integration](https://github.com/wekan/wekan-gogs) as separate project.
# Wishes for pull requests
@ -50,4 +50,4 @@ Following are for Source/Docker installs:
# More
[Features](https://github.com/wekan/wekan/wiki/Features)
[Features](Features)

@ -4,13 +4,13 @@ Wekan is made with Javascript and uses MongoDB database.
## Using Wekan REST API
With Jython, you can use Wekan REST API [like with Python](https://github.com/wekan/wekan/wiki/New-card-with-Python3-and-REST-API)
With Jython, you can use Wekan REST API [like with Python](New-card-with-Python3-and-REST-API)
## Global Webhooks
For Global Webhooks in Admin Panel, Wekan sends all events in all boards to webhook URL, like add card. Although, sending some messages for some events is not yet implemented, more could be added later.
Data is sent in [this kind of JSON format](https://github.com/wekan/wekan/wiki/Webhook-data).
Data is sent in [this kind of JSON format](Webhook-data).
[You can receive webhook data in Java like this](https://github.com/Esri/webhooks-samples/tree/master/java/receiver).

@ -1,4 +1,4 @@
- [**OTHER LDAP Settings**](https://github.com/wekan/wekan/wiki/LDAP-AD-Simple-Auth) and [**RELATED Search Filter Settings**](https://github.com/wekan/wekan/issues/3908#issuecomment-887545168):
- [**OTHER LDAP Settings**](LDAP-AD-Simple-Auth) and [**RELATED Search Filter Settings**](https://github.com/wekan/wekan/issues/3908#issuecomment-887545168):
```
- LDAP_USER_SEARCH_FILTER=(objectClass=user)

@ -1,6 +1,6 @@
## LDAP info
- [**LDAP AD Simple Auth**](https://github.com/wekan/wekan/wiki/LDAP-AD-Simple-Auth) 2021-07-24 and related [Search Filter Settings](https://github.com/wekan/wekan/issues/3908#issuecomment-887545168):
- [**LDAP AD Simple Auth**](LDAP-AD-Simple-Auth) 2021-07-24 and related [Search Filter Settings](https://github.com/wekan/wekan/issues/3908#issuecomment-887545168):
```
- LDAP_USER_SEARCH_FILTER=(objectClass=user)
@ -24,9 +24,9 @@ You see all settings with:
```
wekan.help | less
```
For root-url, see [Settings](https://github.com/wekan/wekan/wiki/Settings)
For root-url, see [Settings](Settings)
For Caddy/Wekan/RocketChat Snap settings, see [Snap install page](https://github.com/wekan/wekan-snap/wiki/Install), [OAuth2 page](https://github.com/wekan/wekan/wiki/OAuth2#snap) and [Caddy page](https://github.com/wekan/wekan/wiki/Caddy-Webserver-Config). Instead of Caddy you can also use [Nginx](https://github.com/wekan/wekan/wiki/Nginx-Webserver-Config) or [Apache](https://github.com/wekan/wekan/wiki/Apache).
For Caddy/Wekan/RocketChat Snap settings, see [Snap install page](https://github.com/wekan/wekan-snap/wiki/Install), [OAuth2 page](OAuth2#snap) and [Caddy page](Caddy-Webserver-Config). Instead of Caddy you can also use [Nginx](Nginx-Webserver-Config) or [Apache](Apache).
## LDAP Filter settings

8
Mac.md

@ -5,7 +5,7 @@
## ChangeLog
- Previously:
- Below info about Wekan on Mac x64
- [Wekan PWA on iOS Safari](https://github.com/wekan/wekan/wiki/PWA)
- [Wekan PWA on iOS Safari](PWA)
- Many mobile web fixes
- 2021-05-14 Wekan maintainer [xet7](https://github.com/xet7) got donated hardware [OpenSource MacStadium](https://www.macstadium.com/opensource) remote access to Mac Mini M1 that has 16 GB RAM and 1 TB SSD.
- 2021-05-15 xet7 bought Apple Developer access for 99 euro/year. Trying to figure out how to sign some test app for iPhone, did not get it working yet.
@ -56,7 +56,7 @@ export ROOT_URL=http://localhost:2000
export PORT=2000
export MONGO_URL=mongodb://127.0.0.1:27017/wekan
```
[More info about ROOT_URL](https://github.com/wekan/wekan/wiki/Settings)
[More info about ROOT_URL](Settings)
8. Edit `start-wekan.sh` so that it starts in bundle directory command `node main.js`
@ -69,8 +69,8 @@ export MONGO_URL=mongodb://127.0.0.1:27017/wekan
Note: With Docker, please don't use latest tag. Only use release tags. See https://github.com/wekan/wekan/issues/3874
- [Repair Docker](https://github.com/wekan/wekan/wiki/Repair-Docker)
- [Docker](https://github.com/wekan/wekan/wiki/Docker)
- [Repair Docker](Repair-Docker)
- [Docker](Docker)
- [Docker Dev Environment](https://github.com/wekan/wekan-dev)
If you don't need to build Wekan, use prebuilt container with docker-compose.yml from https://github.com/wekan/wekan like this:

@ -1,5 +1,5 @@
- Read [Wekan new release ChangeLog](https://github.com/wekan/wekan/blob/master/CHANGELOG.md)
- [Install Meteor.js](https://www.meteor.com/install). Note: Windows install is very slow, please use other option at [Windows wiki page](https://github.com/wekan/wekan/wiki/Windows)
- [Install Meteor.js](https://www.meteor.com/install). Note: Windows install is very slow, please use other option at [Windows wiki page](Windows)
- Download newest bundle from https://releases.wekan.team
- Unarchive bundle .tar.gz file: `tar -zxvf wekan-VERSION.tar.gz`
- `cd bundle`
@ -8,6 +8,6 @@
[Wekan for Meteor.js bundle bug reports and feature requests](https://github.com/wekan/wekan/issues)
[Build Meteor bundle from source](https://github.com/wekan/wekan/wiki/Source)
[Build Meteor bundle from source](Source)
[Install from source without root](https://github.com/wekan/wekan/wiki/Install-from-source-without-root)
[Install from source without root](Install-from-source-without-root)

@ -8,7 +8,7 @@ If you're already a Trello user, migrating to Wekan is easy:
# 1. Install Wekan
Detailed instructions are on this wiki at the page [Install and Update](https://github.com/wekan/wekan/wiki/Install-and-Update)
Detailed instructions are on this wiki at the page [Install and Update](Install-and-Update)
# 2. Create users

@ -41,6 +41,6 @@ Some of the database schema can be different. If you see difference in these fil
- [Add issue](https://github.com/wekan/wekan/issues)
### b) Create pull request
- [Build from source or build on VirtualBox image](https://github.com/wekan/wekan/wiki/Platforms)
- [Please try to fix lint error before creating pull request](https://github.com/wekan/wekan/wiki/Developer-Documentation#preventing-travis-ci-lint-errors-before-submitting-pull-requests)
- [Build from source or build on VirtualBox image](Platforms)
- [Please try to fix lint error before creating pull request](Developer-Documentation#preventing-travis-ci-lint-errors-before-submitting-pull-requests)
- [Making Pull Request](https://help.github.com/articles/creating-a-pull-request/)

@ -1,5 +1,5 @@
Also see:
- [API Login to get Bearer token](https://github.com/wekan/wekan/wiki/REST-API#example-call---as-form-data)
- [API Login to get Bearer token](REST-API#example-call---as-form-data)
- [API docs and examples for various programming languages](https://wekan.github.io/api/), there is Boards / Export for exporting board with API
- In the right menu, scroll down REST API Docs etc links =====>
- Wekan-Gogs integration with Node.js https://github.com/wekan/wekan-gogs

@ -2,9 +2,9 @@
From https://github.com/wekan/wekan/issues/3190
I installed Nginx using the instructions on the [AWS wiki](https://github.com/wekan/wekan/wiki/AWS)
I installed Nginx using the instructions on the [AWS wiki](AWS)
I followed the [the Nginx wiki](https://github.com/wekan/wekan/wiki/Nginx-Webserver-Config) and reached a point where everything was installed correctly and 'sudo nginx -t' was passing (with warnings), but when I went to the root-url I was still getting the generic welcome screen from nginx saying 'Welcome to nginx! If you see this page, the nginx web server is successfully installed and working. Further configuration is required'
I followed the [the Nginx wiki](Nginx-Webserver-Config) and reached a point where everything was installed correctly and 'sudo nginx -t' was passing (with warnings), but when I went to the root-url I was still getting the generic welcome screen from nginx saying 'Welcome to nginx! If you see this page, the nginx web server is successfully installed and working. Further configuration is required'
I got stuck here for a very long time, fiddling with my config files, until I found [this answer](https://stackoverflow.com/questions/11426087/nginx-error-conflicting-server-name-ignored). In my install, 'default' files had been automatically created in /etc/nginx/conf.d/ and in /etc/nginx/sites-available/

@ -3,11 +3,11 @@
# OAuth2 providers
You can use some OAuth2 providers for logging into Wekan, for example:
- [Auth0](https://github.com/wekan/wekan/wiki/OAuth2#auth0) - works
- [Rocket.Chat](https://github.com/wekan/wekan/wiki/OAuth2#rocketchat-providing-oauth2-login-to-wekan) - works
- [GitLab](https://github.com/wekan/wekan/wiki/OAuth2#gitlab-providing-oauth2-login-to-wekan) - works
- [Auth0](OAuth2#auth0) - works
- [Rocket.Chat](OAuth2#rocketchat-providing-oauth2-login-to-wekan) - works
- [GitLab](OAuth2#gitlab-providing-oauth2-login-to-wekan) - works
- Google - not tested yet
- [LemonLDAP::NG](https://github.com/wekan/wekan/wiki/OAuth2#lemonldapng) - works
- [LemonLDAP::NG](OAuth2#lemonldapng) - works
You can ask your identity provider (LDAP, SAML etc) do they support adding OAuth2 application like Wekan.
@ -74,7 +74,7 @@ sudo snap set wekan port='3001'
sudo snap set core refresh.schedule=02:00-04:00
sudo snap set wekan with-api='true'
```
Email settings [ARE NOT REQUIRED](https://github.com/wekan/wekan/wiki/Troubleshooting-Mail), Wekan works without setting up Email.
Email settings [ARE NOT REQUIRED](Troubleshooting-Mail), Wekan works without setting up Email.
```
sudo snap set wekan mail-url='smtps://user:pass@MAILSERVER.YOURDOMAIN.COM:453'
sudo snap set wekan mail-from='Wekan Boards <support@YOURDOMAIN.COM>'
@ -83,7 +83,7 @@ Edit Caddyfile:
```
sudo nano /var/snap/wekan/common/Caddyfile
```
Add Caddy config. This uses free Let's Encrypt SSL. You can also use [free CloudFlare wildcard SSL or any other SSL cert](https://github.com/wekan/wekan/wiki/Caddy-Webserver-Config).
Add Caddy config. This uses free Let's Encrypt SSL. You can also use [free CloudFlare wildcard SSL or any other SSL cert](Caddy-Webserver-Config).
```
boards.yourdomain.com {
proxy / localhost:3001 {
@ -304,4 +304,4 @@ You need to set a new OpenID Connect Relay Party (RP) with theses parameters :
* name: session attribute containing the user's full name
* email: session attribute containing the user's email or _singleMail
See LLNG doc for more details
See LLNG doc for more details

2
OVH.md

@ -1,3 +1,3 @@
Currently only way is to get Wekan working at OVH is [install from source](https://github.com/wekan/wekan/wiki/Source).
Currently only way is to get Wekan working at OVH is [install from source](Source).
OVH and Kimsufi servers have restricted OVH kernels, so you can't run Snap or Docker.

@ -1,4 +1,4 @@
Also see: [Windows](https://github.com/wekan/wekan/wiki/Windows)
Also see: [Windows](Windows)
## a) Wekan Windows version offline
@ -32,7 +32,7 @@ Then Wekan will be at http://192.168.0.100:2000/sign-in
9. Double click `start-wekan.bat` to run it. (It may need right click, Run as Administrator).
10. For mobile devices, you can [create PWA app icon](https://github.com/wekan/wekan/wiki/PWA) using that http://192.168.0.100:2000/sign-in
10. For mobile devices, you can [create PWA app icon](PWA) using that http://192.168.0.100:2000/sign-in
## b) Wekan to VirtualBox Ubuntu offline

@ -1,3 +1,3 @@
Only [install from Source](https://github.com/wekan/wekan/wiki/Source) works.
Only [install from Source](Source) works.
OpenVZ does usually have 2.x kernel that would [support Snap](https://github.com/wekan/wekan-snap/issues/30) or [Docker](https://github.com/wekan/wekan/wiki/Docker).
OpenVZ does usually have 2.x kernel that would [support Snap](https://github.com/wekan/wekan-snap/issues/30) or [Docker](Docker).

@ -34,4 +34,4 @@ Wekan boards have Outgoing Webhooks for board change messages, those can be brid
https://github.com/vector-im/riot-web/issues/4978
If you have some Riot bot, you can make it call Wekan REST API to make changes to Wekan.
First [login to API as form data, with admin username and password](https://github.com/wekan/wekan/wiki/REST-API#example-call---as-form-data). Then use that Bearer token [to edit Wekan](https://wekan.github.io/api/).
First [login to API as form data, with admin username and password](REST-API#example-call---as-form-data). Then use that Bearer token [to edit Wekan](https://wekan.github.io/api/).

2
PWA.md

@ -1,4 +1,4 @@
[Browser compatibility matrix](https://github.com/wekan/wekan/wiki/Browser-compatibility-matrix)
[Browser compatibility matrix](Browser-compatibility-matrix)
## Install your Wekan server as an app

@ -7,12 +7,12 @@ Only newest Wekan is supported. Please check you are running newest Wekan, becau
## Related
* [Wekan new release ChangeLog](https://github.com/wekan/wekan/blob/master/CHANGELOG.md)
* [Adding Users](https://github.com/wekan/wekan/wiki/Adding-users)
* [Forgot Password](https://github.com/wekan/wekan/wiki/Forgot-Password)
* [Settings](https://github.com/wekan/wekan/wiki/Settings)
* [Email](https://github.com/wekan/wekan/wiki/Troubleshooting-Mail)
* **[Backup and Restore](https://github.com/wekan/wekan/wiki/Backup) <=== VERY CRITICAL. DO AUTOMATICALLY OFTEN !!**
* [Logs and Stats](https://github.com/wekan/wekan/wiki/Logs)
* [Adding Users](Adding-users)
* [Forgot Password](Forgot-Password)
* [Settings](Settings)
* [Email](Troubleshooting-Mail)
* **[Backup and Restore](Backup) <=== VERY CRITICAL. DO AUTOMATICALLY OFTEN !!**
* [Logs and Stats](Logs)
* [Wekan bug reports and feature requests](https://github.com/wekan/wekan/issues)
* [Proxy](https://github.com/wekan/wekan/issues/1480)
@ -35,31 +35,31 @@ Only newest Wekan is supported. Please check you are running newest Wekan, becau
***
* Cloud: Some additional info
* [AWS](https://github.com/wekan/wekan/wiki/AWS)
* [Azure](https://github.com/wekan/wekan/wiki/Azure)
* [OpenShift](https://github.com/wekan/wekan/wiki/OpenShift)
* [AWS](AWS)
* [Azure](Azure)
* [OpenShift](OpenShift)
***
## Production: SaaS, Wekan ready paid services, just start using.
* [Wekan Team](https://wekan.team/commercial-support/) - Snap Gantt Gpl Automatic Updates. Supports Wekan maintenance and development.
* [Cloudron](https://github.com/wekan/wekan/wiki/Cloudron) - Standalone Wekan
* [PikaPods](https://github.com/wekan/wekan/wiki/PikaPods) - Standalone Wekan with managed updates and backups.
* [Scalingo](https://github.com/wekan/wekan/wiki/Scalingo) - Standalone Wekan
* [Cloudron](Cloudron) - Standalone Wekan
* [PikaPods](PikaPods) - Standalone Wekan with managed updates and backups.
* [Scalingo](Scalingo) - Standalone Wekan
## <a name="ProductionDocker"></a>Not exposed to Internet: Docker. No automatic upgrades.
Keep backups, Docker is more complex than others above. Use only if you have time to test new release first, and it's critical nothing gets broken. Because Docker does not have automatic updates, please keep behind firewall, without any ports open to Internet, because Wekan gets new security etc updates to Node.js and other dependencies often.
* [Docker](https://github.com/wekan/wekan/wiki/Docker)
* [Windows](https://github.com/wekan/wekan/wiki/Windows) + build from source
* [Mac](https://github.com/wekan/wekan/wiki/Mac)
* [SLES 64bit](https://github.com/wekan/wekan/wiki/Install-Wekan-Docker-on-SUSE-Linux-Enterprise-Server-12-SP1)
* [Docker](Docker)
* [Windows](Windows) + build from source
* [Mac](Mac)
* [SLES 64bit](Install-Wekan-Docker-on-SUSE-Linux-Enterprise-Server-12-SP1)
* [Proxy](https://github.com/wekan/wekan/issues/1480)
***
## Not exposed to Internet: Bundle for [RasPi 3, arm64, Windows and any Node+Mongo CPU architectures](https://github.com/wekan/wekan/wiki/Raspberry-Pi). No automatic updates, no sandboxing.
## Not exposed to Internet: Bundle for [RasPi 3, arm64, Windows and any Node+Mongo CPU architectures](Raspberry-Pi). No automatic updates, no sandboxing.
New at 2019-06-30. If CPU architecture has enough RAM and fast harddisk, it can be used, but there
is no automatic updates and no sandboxing.
@ -91,22 +91,22 @@ npm install node-gyp node-pre-gyp fibers
cd ../../..
```
Then modify `start-wekan.sh` or `start-wekan.bat` for Node and MongoDB paths.
See [Raspberry Pi page](https://github.com/wekan/wekan/wiki/Raspberry-Pi) for info about systemd etc.
See [Raspberry Pi page](Raspberry-Pi) for info about systemd etc.
***
## <a name="Development"></a>Development: Not updated automatically.
* [Virtual appliance](https://github.com/wekan/wekan/wiki/virtual-appliance) - old
* [Source](https://github.com/wekan/wekan/wiki/Source) for development usage only. Source, Snap, Docker, Sandstorm, Meteor bundle and Windows build instructions.
* [Vagrant](https://github.com/wekan/wekan/wiki/Vagrant)
* [Virtual appliance](virtual-appliance) - old
* [Source](Source) for development usage only. Source, Snap, Docker, Sandstorm, Meteor bundle and Windows build instructions.
* [Vagrant](Vagrant)
* Upcoming:
* [Friend](https://github.com/wekan/wekan/wiki/Friend) - Snap Standalone Wekan
* [Friend](Friend) - Snap Standalone Wekan
## Operating Systems
* [Debian 64bit](https://github.com/wekan/wekan/wiki/Debian)
* [SmartOS](https://github.com/wekan/wekan/wiki/SmartOS)
* [FreeBSD](https://github.com/wekan/wekan/wiki/FreeBSD)
* [Debian 64bit](Debian)
* [SmartOS](SmartOS)
* [FreeBSD](FreeBSD)
## NAS
@ -114,12 +114,12 @@ See [Raspberry Pi page](https://github.com/wekan/wekan/wiki/Raspberry-Pi) for in
## Other Clouds. Can have some restrictions, like: Requires from source install, has restricted 2.x kernel, does not support websockets, or not tested yet.
* [Uberspace](https://github.com/wekan/wekan/wiki/Install-latest-Wekan-release-on-Uberspace)
* [OVH and Kimsufi](https://github.com/wekan/wekan/wiki/OVH)
* [OpenVZ](https://github.com/wekan/wekan/wiki/OpenVZ)
* [Heroku](https://github.com/wekan/wekan/wiki/Heroku) ?
* [Google Cloud](https://github.com/wekan/wekan/wiki/Google-Cloud) ?
* [Cloud Foundry](https://github.com/wekan/wekan/wiki/Cloud-Foundry) ?
* [Uberspace](Install-latest-Wekan-release-on-Uberspace)
* [OVH and Kimsufi](OVH)
* [OpenVZ](OpenVZ)
* [Heroku](Heroku) ?
* [Google Cloud](Google-Cloud) ?
* [Cloud Foundry](Cloud-Foundry) ?
## Does not work yet: [DEB/RPM packages at Packager.io](https://packager.io/gh/wekan/wekan)
@ -128,9 +128,9 @@ New at 2019-08-04. For Ubuntu, Debian, CentOS and SLES.
# More
[Features](https://github.com/wekan/wekan/wiki/Features)
[Features](Features)
[Integrations](https://github.com/wekan/wekan/wiki/Integrations)
[Integrations](Integrations)
[install_source]: https://github.com/wekan/wekan/wiki/Install-and-Update#install-manually-from-source
[installsource_windows]: https://github.com/wekan/wekan/wiki/Install-Wekan-from-source-on-Windows
@ -151,4 +151,4 @@ New at 2019-08-04. For Ubuntu, Debian, CentOS and SLES.
[wekan_logstash]: https://github.com/wekan/wekan-logstash
[autoinstall]: https://github.com/wekan/wekan-autoinstall
[autoinstall_issue]: https://github.com/anselal/wekan/issues/18
[debian_wheezy_devuan_jessie]: https://github.com/wekan/sps
[debian_wheezy_devuan_jessie]: https://github.com/wekan/sps

@ -38,7 +38,7 @@ Maxime Quandalle, original author of Wekan
* [EthKan](https://github.com/EthKan)
* [Friend](https://github.com/wekan/wekan/wiki/Friend)
* [Friend](Friend)
# In Spanish

@ -1,6 +1,6 @@
Some Python etc code in WeKan, that is not yet added directly to WeKan:
- [Prometheus Exporter](https://github.com/wekan/wekan-prometheus-exporter)
- [Burndown Chart](https://github.com/wekan/wekan/wiki/Burndown-and-Velocity-Chart)
- [Burndown Chart](Burndown-and-Velocity-Chart)
- [Scheduler](https://github.com/wekan/wekan-scheduler)
- [Cleanup](https://github.com/wekan/wekan-cleanup)
- [API client, most complete](https://github.com/wekan/python-wekan) (modelled after Trello API client)
@ -9,5 +9,5 @@ Some Python etc code in WeKan, that is not yet added directly to WeKan:
- [Stats](https://github.com/wekan/wekan-stats)
- [Logstash and ElasticSearch](https://github.com/wekan/wekan-logstash)
- iCal server in [Python](https://github.com/wekan/wekan-ical-server) and [PHP](https://github.com/wekan/wekan-ical-php)
- [Sandstorm CSV related Python code](https://github.com/wekan/wekan/wiki/Wekan-Sandstorm-cards-to-CSV-using-Python)
- [Trello API test code](https://github.com/wekan/wekan/tree/master/trello)
- [Sandstorm CSV related Python code](Wekan-Sandstorm-cards-to-CSV-using-Python)
- [Trello API test code](https://github.com/wekan/wekan/tree/master/trello)

@ -10,7 +10,7 @@ curl -H "Authorization: Bearer a6DM_gOPRwBdynfXaGBaiiEwTiAuigR_Fj_81QmNpnf" \
## Add/Remove Board Member and Change Role
[Add/Remove Board Member and Change Role admin/normal/nocomments/commentonly](https://github.com/wekan/wekan/wiki/REST-API-Role).
[Add/Remove Board Member and Change Role admin/normal/nocomments/commentonly](REST-API-Role).
## The admin takes the ownership of ALL boards of the user (archived and not archived) where the user is admin on.

@ -6,7 +6,7 @@ This page tries to be as up to date as possible. If you see something wrong here
Please somebody add example by looking this:
[Issue](https://github.com/wekan/wekan/issues/1934) and [code](https://github.com/wekan/wekan/pull/1944/commits/be42b8d4cbdfa547ca019ab2dc9a590a115cc0e2). Also add to [Cards page](https://github.com/wekan/wekan/wiki/REST-API-Cards)
[Issue](https://github.com/wekan/wekan/issues/1934) and [code](https://github.com/wekan/wekan/pull/1944/commits/be42b8d4cbdfa547ca019ab2dc9a590a115cc0e2). Also add to [Cards page](REST-API-Cards)
# Add Swimlane to Board

@ -31,21 +31,21 @@ When calling a production Wekan server, ensure it is running via HTTPS and has a
### Users
| HTTP Method | Url | Short Description |
| :--- | :--- | :--- |
| `POST` | `/users/register` | [Register a new user.](https://github.com/wekan/wekan/wiki/REST-API-User#user-register) |
| `POST` | `/api/users` | [Create a new user.](https://github.com/wekan/wekan/wiki/REST-API-User#user-create) |
| `PUT` | `/api/users/:id` | [Disable an existing user.](https://github.com/wekan/wekan/wiki/REST-API-User#disable-a-user-the-user-is-not-allowed-to-login-and-his-login-tokens-are-purged) |
| `PUT` | `/api/users/:id` | [Enable an existing user.](https://github.com/wekan/wekan/wiki/REST-API-User#enable-a-user) |
| `PUT` | `/api/users/:id` | [Admin takes the ownership.](https://github.com/wekan/wekan/wiki/REST-API-User#the-admin-takes-the-ownership-of-all-boards-of-the-user-archived-and-not-archived-where-the-user-is-admin-on) |
| `DELETE` | `/api/users/:id` | [Delete an existing user.](https://github.com/wekan/wekan/wiki/REST-API-User#user-delete) ([Warning](https://github.com/wekan/wekan/issues/1289))|
| `GET` | `/api/users/:id` | [Gets a user's information.](https://github.com/wekan/wekan/wiki/REST-API-User#user-information) |
| `GET` | `/api/users` | [All of the users.](https://github.com/wekan/wekan/wiki/REST-API-User#user-list) |
| `GET` | `/api/user` | [Gets a logged-in user.](https://github.com/wekan/wekan/wiki/REST-API-User#user-logged-in) |
| `POST` | `/users/register` | [Register a new user.](REST-API-User#user-register) |
| `POST` | `/api/users` | [Create a new user.](REST-API-User#user-create) |
| `PUT` | `/api/users/:id` | [Disable an existing user.](REST-API-User#disable-a-user-the-user-is-not-allowed-to-login-and-his-login-tokens-are-purged) |
| `PUT` | `/api/users/:id` | [Enable an existing user.](REST-API-User#enable-a-user) |
| `PUT` | `/api/users/:id` | [Admin takes the ownership.](REST-API-User#the-admin-takes-the-ownership-of-all-boards-of-the-user-archived-and-not-archived-where-the-user-is-admin-on) |
| `DELETE` | `/api/users/:id` | [Delete an existing user.](REST-API-User#user-delete) ([Warning](https://github.com/wekan/wekan/issues/1289))|
| `GET` | `/api/users/:id` | [Gets a user's information.](REST-API-User#user-information) |
| `GET` | `/api/users` | [All of the users.](REST-API-User#user-list) |
| `GET` | `/api/user` | [Gets a logged-in user.](REST-API-User#user-logged-in) |
### Cards
| HTTP Method | Url | Short Description |
| :--- | :--- | :--- |
| `POST` | `/api/boards/:boardId/lists/:listId/cards` | [Add a card to a list, board, and swimlane.](https://github.com/wekan/wekan/wiki/REST-API-Cards#add-card-to-list-board-swimlane) |
| `PUT` | `/api/boards/:boardId/lists/:fromListId/cards/:cardId` | [Update a card.](https://github.com/wekan/wekan/wiki/REST-API-Cards#update-a-card) |
| `DELETE` | `/api/boards/:boardId/lists/:listId/cards/:cardId` | [Delete a card.](https://github.com/wekan/wekan/wiki/REST-API-Cards#update-a-card) |
| `POST` | `/api/boards/:boardId/lists/:listId/cards` | [Add a card to a list, board, and swimlane.](REST-API-Cards#add-card-to-list-board-swimlane) |
| `PUT` | `/api/boards/:boardId/lists/:fromListId/cards/:cardId` | [Update a card.](REST-API-Cards#update-a-card) |
| `DELETE` | `/api/boards/:boardId/lists/:listId/cards/:cardId` | [Delete a card.](REST-API-Cards#update-a-card) |
---

@ -1,6 +1,6 @@
NOTE: If you use MongoDB Snap package below, most likely it works with many distro versions, like newest distros also. But if installing without Snap from https://www.mongodb.com/try/download/community , those packages are not for so many distros and versions.
This page is NOT only about Raspberry Pi. This page IS about install without container for ANY Linux/BSD/[macOS](https://github.com/wekan/wekan/wiki/Mac)/[Windows](https://github.com/wekan/wekan/wiki/Offline) using CPU of amd64/arm64/s390x/ppc64le.
This page is NOT only about Raspberry Pi. This page IS about install without container for ANY Linux/BSD/[macOS](Mac)/[Windows](Offline) using CPU of amd64/arm64/s390x/ppc64le.
WeKan only requires:
- WeKan bundle .zip file of Javascript etc for that CPU. Only difference per CPU is that fibers package is compiled for that CPU. Those .zip files are built this way, for example:
@ -15,7 +15,7 @@ WeKan only requires:
- init.d script
- any other script, that sets environment variables and in bundle directory does `node main.js`
- most important environment settings are:
- `ROOT_URL=http://192.168.0.200` for WeKan server IP address at local network or `ROOT_URL=https://kanban.example.com` if [Caddy](https://github.com/wekan/wekan/wiki/Caddy-Webserver-Config)/[Nginx](https://github.com/wekan/wekan/wiki/Nginx-Webserver-Config)/[Apache2](https://github.com/wekan/wekan/wiki/Apache) proxies from HTTPS to WeKan http://127.0.0.1:4000 etc, see https://github.com/wekan/wekan/wiki/Settings
- `ROOT_URL=http://192.168.0.200` for WeKan server IP address at local network or `ROOT_URL=https://kanban.example.com` if [Caddy](Caddy-Webserver-Config)/[Nginx](Nginx-Webserver-Config)/[Apache2](Apache) proxies from HTTPS to WeKan http://127.0.0.1:4000 etc, see https://github.com/wekan/wekan/wiki/Settings
- `PORT=80` or `PORT=4000` or some other port where WeKan Nodejs runs.
- `MONGO_URL=mongodb://127.0.0.1:27017/wekan` where MongoDB server is, like localhost port 27017 using database name wekan. (Snap usually has MongoDB port at 27019, if it's not changed for example with `sudo snap set wekan mongodb-port='27020'`)
- Some other settings are at [start-wekan.sh](https://raw.githubusercontent.com/wekan/wekan/master/start-wekan.sh) (and at https://github.com/wekan/wekan-snap/wiki/Supported-settings-keys#list-of-supported-keys but Snap settings have lowercase minus like `root-url`, where `.sh` scripts and services have uppercase underline like `ROOT_URL`)
@ -28,9 +28,9 @@ Bundle for amd64 is at https://releases.wekan.team filename wekan-VERSION.zip
Bundle for arm64 is at https://releases.wekan.team/raspi3/ filename wekan-VERSION-arm64.zip
Bundle for [s390x](https://github.com/wekan/wekan/wiki/s390x) is at https://releases.wekan.team/s390x/ filename wekan-VERSION-s390x.zip
Bundle for [s390x](s390x) is at https://releases.wekan.team/s390x/ filename wekan-VERSION-s390x.zip
Bundle for [ppc64el](https://github.com/wekan/wekan/wiki/ppc) is at https://releases.wekan.team/ppc64le/ filename wekan-VERSION-ppc64le.zip
Bundle for [ppc64el](ppc) is at https://releases.wekan.team/ppc64le/ filename wekan-VERSION-ppc64le.zip
## Related wiki pages
@ -117,7 +117,7 @@ mongo
## Please store MongoDB database etc Wekan files to external SSD hardrive (or HDD)
It's very easy to corrupt microSD card with a lot of writes. Please make [at least daily backups](https://github.com/wekan/wekan/wiki/Backup).
It's very easy to corrupt microSD card with a lot of writes. Please make [at least daily backups](Backup).
## Install Wekan to RasPi3, RasPi4 or any arm64 server
@ -331,7 +331,7 @@ you could install [postfix](https://github.com/wekan/wekan-bash-install-autoupgr
MAIL_URL='smtp://127.0.0.1:25/'
MAIL_FROM='Board Support <wekan@example.com>'
```
It is much more recommended to use [email sending service like AWS SES or some other service](https://github.com/wekan/wekan/wiki/Troubleshooting-Mail) that can ensure delivering email correctly, for Wekan email notifications etc.
It is much more recommended to use [email sending service like AWS SES or some other service](Troubleshooting-Mail) that can ensure delivering email correctly, for Wekan email notifications etc.
## 8. Optional: Nginx and Let's Encrypt SSL
@ -510,7 +510,7 @@ sudo systemctl enable mongodb
wget https://releases.wekan.team/raspi3/start-wekan.sh
nano start-wekan.sh
```
There edit [ROOT_URL to have your IP address or domain, and PORT for your localhost port](https://github.com/wekan/wekan/wiki/Settings).
There edit [ROOT_URL to have your IP address or domain, and PORT for your localhost port](Settings).
You can also allow node to run on port 80, when you check where node is:
```
@ -520,7 +520,7 @@ and then allow it:
```
sudo setcap cap_net_bind_service=+ep /usr/local/bin/node
```
[Adding users](https://github.com/wekan/wekan/wiki/Adding-users)
[Adding users](Adding-users)
#### Upgrade bundle

@ -1,6 +1,6 @@
## 1) Create Backups first
[Backup](https://github.com/wekan/wekan/wiki/Backup)
[Backup](Backup)
Docker data is usually at `/var/lib/docker` or `/var/snap/docker/common/` (in Snap version of Docker).
@ -31,13 +31,13 @@ docker-compose up -d
```
## 5) MongoDB corruption?
a) [Repair MongoDB](https://github.com/wekan/wekan/wiki/Repair-MongoDB)
a) [Repair MongoDB](Repair-MongoDB)
b) [Using Meteor MongoDB to repair files](https://github.com/wekan/wekan/wiki/Export-from-Wekan-Sandstorm-grain-.zip-file)
b) [Using Meteor MongoDB to repair files](Export-from-Wekan-Sandstorm-grain-.zip-file)
## 6) Trying to upgrade Wekan?
### 1) [Backup](https://github.com/wekan/wekan/wiki/Backup)
### 1) [Backup](Backup)
### 2a) Nice way:
```
@ -73,4 +73,4 @@ Start Wekan
```
docker-compose up -d
```
[Restore](https://github.com/wekan/wekan/wiki/Backup)
[Restore](Backup)

@ -26,7 +26,7 @@ apt install ntfs-3g
```
mount /dev/sdd1 /mnt
```
4. Stop WeKan Docker containers. If copying raw database files, WeKan and MongoDB should not be running, so that MongoDB would not be even more corrupted. (If MongoDB is running, and you have mongodump backup, you can [Backup with mongorestore](https://github.com/wekan/wekan/wiki/Backup)
4. Stop WeKan Docker containers. If copying raw database files, WeKan and MongoDB should not be running, so that MongoDB would not be even more corrupted. (If MongoDB is running, and you have mongodump backup, you can [Backup with mongorestore](Backup)
```
docker stop wekan-db wekan-app
```

@ -1,4 +1,4 @@
Please read Etiquette at [FAQ](https://github.com/wekan/wekan/wiki/FAQ) and [Developer Documentation](https://github.com/wekan/wekan/wiki/Developer-Documentation).
Please read Etiquette at [FAQ](FAQ) and [Developer Documentation](Developer-Documentation).
# New Roadmap

@ -14,14 +14,14 @@ Install to your own server. Automatic updates, tested before release. Sandstorm
- Google/GitHub/LDAP/SAML/Passwordless email login.
- Import from Wekan JSON.
- Free SSL at https://yourservername.sandcats.io domain.
- [Rescuing MongoDB data from Sandstorm Grain .zip file to Standalone Wekan](https://github.com/wekan/wekan/wiki/Export-from-Wekan-Sandstorm-grain-.zip-file)
- [Rescuing MongoDB data from Sandstorm Grain .zip file to Standalone Wekan](Export-from-Wekan-Sandstorm-grain-.zip-file)
**Does not work**
- [Sandstorm open issues](https://github.com/wekan/wekan/issues?q=is%3Aissue+is%3Aopen+sandstorm+label%3ATargets%3ASandstorm)
- Import from Trello does not import attachments, because Sandstorm-compatible HTTP-access from Wekan to outside of Wekan grain sandbox is not implemented yet
- [Copying/Moving card to another board](https://github.com/wekan/wekan/issues/1729).
- [REST API](https://github.com/wekan/wekan/issues/1279)
- [Outgoing Webhooks](https://github.com/wekan/wekan/wiki/Outgoing-Webhook-to-Discord)
- [Outgoing Webhooks](Outgoing-Webhook-to-Discord)
- [Email from Wekan](https://github.com/wekan/wekan/issues/2208#issuecomment-469290305)
## Demo
@ -31,7 +31,7 @@ Install to your own server. Automatic updates, tested before release. Sandstorm
## Keep backups
- Keep backups. Download your Wekan grains.
- It's possible to [Export from Wekan Sandstorm grain .zip file to rescue data](https://github.com/wekan/wekan/wiki/Export-from-Wekan-Sandstorm-grain-.zip-file)
- It's possible to [Export from Wekan Sandstorm grain .zip file to rescue data](Export-from-Wekan-Sandstorm-grain-.zip-file)
## Wekan App
@ -51,7 +51,7 @@ Newest Wekap app .spk file download at https://releases.wekan.team/sandstorm/
## Wekan Sandstorm cards to CSV using Python
[Wekan Sandstorm cards to CSV using Python](https://github.com/wekan/wekan/wiki/Wekan-Sandstorm-cards-to-CSV-using-Python)
[Wekan Sandstorm cards to CSV using Python](Wekan-Sandstorm-cards-to-CSV-using-Python)
## Importing to Trello workaround

@ -2,21 +2,21 @@
Recommended specs:
- Try to add [Redis Oplog](https://github.com/cult-of-coders/redis-oplog) like [this](https://github.com/wekan/wekan/wiki/Emoji#how-you-could-add-another-plugin)
- Try to add [Redis Oplog](https://github.com/cult-of-coders/redis-oplog) like [this](Emoji#how-you-could-add-another-plugin)
- One bare metal server (or VM on server that does not have oversubscription), for example [Fastest: UpCloud](https://upcloud.com), [Hetzner](https://www.hetzner.com/?country=en), [Packet](https://packet.com).
- NVME or SSD disk. Speed difference when opening Wekan board: SSD 2 seconds, HDD 5 minutes.
- Minimum 60 GB total disk space, 40 GB free disk space, [Daily Backups](https://github.com/wekan/wekan/wiki/Backup) to elsewhere, monitoring and alerting if server has low disk space, because disk full causes database corruption.
- Minimum 60 GB total disk space, 40 GB free disk space, [Daily Backups](Backup) to elsewhere, monitoring and alerting if server has low disk space, because disk full causes database corruption.
- Newest Ubuntu 64bit
- 4GB RAM minimum. See with `free -h` is server is using any swap. If it is, add more RAM.
- some performance optimized CPUs/cores. 2 minimum, 4 is better. See with `nproc` how many CPUs you have. Look with `top` or `htop` is server using max 100% CPUs, if it is, add higher performance optimized CPUs (or more CPUs). But if it looks like Wekan not using some of those added CPUs, then adding more CPUs is not useful.
- Do not store attachments at database, like uploading file to card. Have markdown links to files, like `[Document](https://example.com/files/document.doc)`. Click `Wekan board` => `☰` => `⚙` => `Board Settings` => `Card Settings`. There uncheck `[_] Attachments` to hide attachments at card.
- Click Wekan `Admin Panel / Settings / Accounts / Hide System Messages of All Users`. If someone needs to show system messages, they can click slider at opened card to show them. Sometime later, if many have manually enabled showing system messages, click that same button at Admin Panel again.
- Check Webhooks: Do you have `Admin Panel / Settings / Global Webhooks` (that sends most board actions to webhook) or at each board, per-board webhooks (that sends most one board actions to webhook, more info at [wiki right menu Webhooks](https://github.com/wekan/wekan/wiki)) at `Wekan board` => `☰` => `⚙` => `Outgoing Webhooks`. You also see this with [DBGate](https://github.com/wekan/wekan/wiki/Backup#dbgate-open-source-mongodb-gui) at port localhost:27019 / database: wekan / table: integrations. Each webhook should [immediately return 200 response before processing any data](https://github.com/wekan/wekan/issues/3575), because otherwise it will slow down Wekan a lot.
- Check Webhooks: Do you have `Admin Panel / Settings / Global Webhooks` (that sends most board actions to webhook) or at each board, per-board webhooks (that sends most one board actions to webhook, more info at [wiki right menu Webhooks](https://github.com/wekan/wekan/wiki)) at `Wekan board` => `☰` => `⚙` => `Outgoing Webhooks`. You also see this with [DBGate](Backup#dbgate-open-source-mongodb-gui) at port localhost:27019 / database: wekan / table: integrations. Each webhook should [immediately return 200 response before processing any data](https://github.com/wekan/wekan/issues/3575), because otherwise it will slow down Wekan a lot.
- In future Wekan version will be added as default:
- [Setting `NODE_OPTIONS: --max_old_space_size=4096`](https://github.com/wekan/wekan/issues/3585#issuecomment-782431177)
Minimum specs:
- [RasPi3](https://github.com/wekan/wekan/wiki/Raspberry-Pi), 1 GB RAM, external SSD disk for Wekan and MongoDB.
- [RasPi3](Raspberry-Pi), 1 GB RAM, external SSD disk for Wekan and MongoDB.
- While it works, it's only for minimal usage.
- Newer RasPi recommended for minimum use.
@ -62,6 +62,6 @@ Related to docker-compose.yml at https://github.com/wekan/wekan , using Docker S
[MongoDB compatible databases](https://github.com/wekan/wekan/issues/2852)
[AWS](https://github.com/wekan/wekan/wiki/AWS)
[AWS](AWS)
[Azure OIDC](https://github.com/wekan/wekan/wiki/Azure)
[Azure OIDC](Azure)

@ -1,16 +1,16 @@
## Standalone Wekan Settings: Snap, Docker, Source etc (not Sandstorm)
## Webserver config
* [Nginx](https://github.com/wekan/wekan/wiki/Nginx-Webserver-Config)
* [Apache](https://github.com/wekan/wekan/wiki/Apache)
* [Caddy](https://github.com/wekan/wekan/wiki/Caddy-Webserver-Config)
* [Nginx](Nginx-Webserver-Config)
* [Apache](Apache)
* [Caddy](Caddy-Webserver-Config)
Examples:
1) nginx SSL or without SSL, available at internet:
- root-url='https://example.com' or https://example.com/something or https://something.example.com , or with http
- port='3001'
- [Nginx example, proxying to local port 3001](https://github.com/wekan/wekan/wiki/Nginx-Webserver-Config)
- [Nginx example, proxying to local port 3001](Nginx-Webserver-Config)
=> Wekan at https://example.com
2) only wekan, no SSL, internal lan, caddy not enabled:
@ -33,7 +33,7 @@ Wekan runs http server on local port, so it is without SSL. To get SSL, some web
## Admin Panel
First registered Wekan user will get [Admin Panel](https://github.com/wekan/wekan/wiki/Features) on new
First registered Wekan user will get [Admin Panel](Features) on new
Docker and source based installs. You can also on MongoDB
[enable Admin Panel](https://github.com/wekan/wekan/blob/master/CHANGELOG.md#v0111-rc2-2017-03-05-wekan-prerelease) and [change you as board admin](https://github.com/wekan/wekan/issues/1060#issuecomment-310545976).
@ -47,7 +47,7 @@ Docker and source based installs. You can also on MongoDB
## Email
[Troubleshooting Mail](https://github.com/wekan/wekan/wiki/Troubleshooting-Mail). For Exchange, you can use [DavMail](http://davmail.sourceforge.net), Wekan SMTP => DavMail => Exchange.
[Troubleshooting Mail](Troubleshooting-Mail). For Exchange, you can use [DavMail](http://davmail.sourceforge.net), Wekan SMTP => DavMail => Exchange.
## RAM usage

@ -1,10 +1,10 @@
## Build from source on Mac
[Build from source on Mac](https://github.com/wekan/wekan/wiki/Mac)
[Build from source on Mac](Mac)
## Build from source on VirtualBox
At [Virtual Appliance](https://github.com/wekan/wekan/wiki/virtual-appliance) there is build scripts and all dependencies installed already.
At [Virtual Appliance](virtual-appliance) there is build scripts and all dependencies installed already.
## Build from source on Linux
@ -15,7 +15,7 @@ Wekan:
[Build from source scripts](https://github.com/wekan/wekan/tree/edge/releases/virtualbox)
Wekan Meteor Bundle:
1. [Build from source scripts](https://github.com/wekan/wekan/tree/edge/releases/virtualbox) built on [Wekan VirtualBox Ubuntu 14.04 64bit](https://github.com/wekan/wekan/wiki/virtual-appliance)
1. [Build from source scripts](https://github.com/wekan/wekan/tree/edge/releases/virtualbox) built on [Wekan VirtualBox Ubuntu 14.04 64bit](virtual-appliance)
2. 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:
@ -39,7 +39,7 @@ Docker:
- `docker-compose up -d --build`
Wekan on Windows:
- [Docker, Windows Subsystem for Linux, and compile from source on Windows](https://github.com/wekan/wekan/wiki/Windows)
- [Docker, Windows Subsystem for Linux, and compile from source on Windows](Windows)
### (Optional) Run Wekan as service with startup script
@ -109,4 +109,4 @@ Checkout instructions for setup with [[Caddy Webserver Config]] and [[Nginx Webs
Building on Windows (if it works) is a lot slower than on Linux/Mac.
[Windows](https://github.com/wekan/wekan/wiki/Windows)
[Windows](Windows)

@ -52,7 +52,7 @@ GitHub Username | Chat Username | Location | Position | Details
[liske](https://github.com/liske) | Germany | Contributor | Added card REST API fix, card time fix etc.
[rhelsing](https://github.com/rhelsing) | ryan.helsing | USA | Contributor | [Comment permissions](https://github.com/wekan/wekan/pull/1008)
[BaobabCoder](https://github.com/BaobabCoder) | BaobabCoder | France | Contributor | [Delete List](https://github.com/wekan/wekan/pull/1050)
[whodafly](https://github.com/whodafly) | superfly | USA | Contributor | [Troubleshooting Mail](https://github.com/wekan/wekan/wiki/Troubleshooting-Mail), [Import Checklists from Trello](https://github.com/wekan/wekan/pull/894)
[whodafly](https://github.com/whodafly) | superfly | USA | Contributor | [Troubleshooting Mail](Troubleshooting-Mail), [Import Checklists from Trello](https://github.com/wekan/wekan/pull/894)
[stephenmoloney](https://github.com/stephenmoloney) | - | Ireland | Contributor | Dockerfile and Travis config, Meteor 1.4 and Node 4.x port
[GhassenRjab](https://github.com/GhassenRjab) | ghassen.rjab | Universe | Contributor | [Fix Export Board](https://github.com/wekan/wekan/pull/1067), [Fix "W" shortcut](https://github.com/wekan/wekan/pull/1066), [Sort languages](https://github.com/wekan/wekan/pull/1070), [Add Breton language name](https://github.com/wekan/wekan/pull/1071), [Edit card description with invalid markdown](https://github.com/wekan/wekan/pull/1073), [Fix importing Trello board](https://github.com/wekan/wekan/pull/1080), [Import due date from Trello](https://github.com/wekan/wekan/pull/1082), [Import Wekan board](https://github.com/wekan/wekan/pull/1117), [Export and import attachments as base64 encoded files](https://github.com/wekan/wekan/pull/1134), [Export and import checklists](https://github.com/wekan/wekan/pull/1140), [Export and import boards in Sandstorm](https://github.com/wekan/wekan/pull/1144), [FIX SECURITY ISSUE Files accessible without authentication](https://github.com/wekan/wekan/issues/1105)
[nztqa](https://github.com/nztqa) | - | Universe | Contributor | [Delete card when deleting list](https://github.com/wekan/wekan/pull/1054), [Disable unnecessary link feature](https://github.com/wekan/wekan/pull/1042), [Fix IE 11 drag board to scroll](https://github.com/wekan/wekan/pull/1052), [Fix filter reset on moving between starred boards](https://github.com/wekan/wekan/pull/1074), [Fix Admin Panel link available to all users, only link is hidden](https://github.com/wekan/wekan/pull/1076), [Fix Case-sensitive email handling](https://github.com/wekan/wekan/issues/675), [Fix admin panel route for subfolder](https://github.com/wekan/wekan/pull/1084), [Fix i18n route for subfolder](https://github.com/wekan/wekan/pull/1085), [Fix incorrect attachment link with subfolder in the url](https://github.com/wekan/wekan/pull/1086), [Fix link to card](https://github.com/wekan/wekan/pull/1087), [Fix duplicate id generation](https://github.com/wekan/wekan/pull/1093), [When finished input of checklist item, open new checklist item](https://github.com/wekan/wekan/pull/1099), [Fix Possible to add empty item to checklist](https://github.com/wekan/wekan/pull/1107), [Improve UI design of checklist items](https://github.com/wekan/wekan/pull/1108), [Outgoing Webhooks](https://github.com/wekan/wekan/pull/1119), [Adding user to board causes node.js to crash](https://github.com/wekan/wekan/issues/1131), [Fix double shashes](https://github.com/wekan/wekan/issues/962), [GitHub Issue template](https://github.com/wekan/wekan/pull/1146), [Fix showing card activity history in IE11](https://github.com/wekan/wekan/pull/1152), [Add display Wekan version number and runtime environment to Admin Panel](https://github.com/wekan/wekan/pull/1156), [Change Email address](https://github.com/wekan/wekan/pull/1161)

@ -22,7 +22,7 @@ Email.send({
## Debugging your SMTP mail server
If you can't get your email server working with smtp/stmps or MAIL_SERVICE, look is there more config options for your email server at https://nodemailer.com docs, and add new issue about your email server to https://github.com/wekan/wekan/issues or [pull request](https://github.com/wekan/wekan/wiki/Emoji#how-you-could-add-another-plugin).
If you can't get your email server working with smtp/stmps or MAIL_SERVICE, look is there more config options for your email server at https://nodemailer.com docs, and add new issue about your email server to https://github.com/wekan/wekan/issues or [pull request](Emoji#how-you-could-add-another-plugin).
For example, for https://nodemailer.com/smtp/
@ -274,7 +274,7 @@ Mail configuration if done by settings of `MAIL_URL` & `MAIL_FROM` environment p
## No mail server
You can choose to _NOT_ configure a mail server, by not providing the `MAIL_URL` & `MAIL_FROM` environment parameters. Instead the mail message will be send to the terminal output. See [FAQ](https://github.com/wekan/wekan/wiki/FAQ#show-mails-with-a-docker-image-without-mail-configuration) for more info.
You can choose to _NOT_ configure a mail server, by not providing the `MAIL_URL` & `MAIL_FROM` environment parameters. Instead the mail message will be send to the terminal output. See [FAQ](FAQ#show-mails-with-a-docker-image-without-mail-configuration) for more info.
## Email servers: SMTP or Exchange

2
UCS.md

@ -22,7 +22,7 @@
## Gantt
[How to use Gantt](https://github.com/wekan/wekan/wiki/Gantt)
[How to use Gantt](Gantt)
UCS WeKan v5.71 and newer is using WeKan Gantt GPL version. [Source](https://github.com/wekan/wekan/issues/2870#issuecomment-954598565).

@ -13,7 +13,7 @@ snap set wekan port='80'
```
Then Wekan is visible at http://localhost:8090
[Adding users](https://github.com/wekan/wekan/wiki/Adding-users)
[Adding users](Adding-users)
List of Wekan Snap settings:
```

@ -1,4 +1,4 @@
UPDATE: Wekan now uses markdown-it and markdown-it-emoji plugin, see [Emoji page](https://github.com/wekan/wekan/wiki/Emoji)
UPDATE: Wekan now uses markdown-it and markdown-it-emoji plugin, see [Emoji page](Emoji)
## Numbered text

@ -10,9 +10,9 @@ Features | Wekan | Trello | Restyaboard
------------ | ------------- | ------------- | -------------
Price | Free and Open Source, [MIT license](https://github.com/wekan/wekan/blob/master/LICENSE). Free for Commercial Use. | Free with limitations, Monthly payment, Annual Subscription, Quote-based | Open Core
Whitelabeling | Yes. Admin Panel/Layout: Hide Logo, Custom Product Name. | No | $ Yes
Theming | [Yes](https://github.com/wekan/wekan/wiki/Custom-CSS-themes) | No | $ Yes
Theming | [Yes](Custom-CSS-themes) | No | $ Yes
Redistributing | Yes | No | $ Yes
Hosting | [Self-host or SaaS provider](https://github.com/wekan/wekan/wiki/Platforms) | SaaS | Self-host
Hosting | [Self-host or SaaS provider](Platforms) | SaaS | Self-host
## Basic features: Board
@ -25,7 +25,7 @@ Boards | Yes | Yes | Yes
Closed boards listing | Yes, at Archive | Yes | Yes
Starred boards listing | No, starred and non-starred at All Boards | No | Yes
Add board with predefined templates | Personal templates, Import Board from Trello or Wekan | No | Yes
Board stats | [Yes](https://github.com/wekan/wekan/wiki/Features#stats) | No | Yes
Board stats | [Yes](Features#stats) | No | Yes
Board - Add members | Yes | Yes | Yes
Board - Remove members | Yes | Yes | Yes
Close board | Yes, move to Archive | Yes | Yes
@ -160,10 +160,10 @@ Features | Wekan | Trello | Restyaboard
API explorer | No | No | Yes
OpenAPI | [Yes](https://github.com/wekan/wekan/tree/master/openapi) [here](https://wekan.github.io/api/) | ? | ?
Developer applications | Yes, using REST API | Yes | Yes
Authorized OAuth applications | No, REST API [login as admin to get Bearer token](https://github.com/wekan/wekan/wiki/REST-API#example-call---as-form-data) | Yes | Yes
Authorized OAuth applications | No, REST API [login as admin to get Bearer token](REST-API#example-call---as-form-data) | Yes | Yes
Webhooks | Yes, per board or global at Admin Panel | Yes | Yes
Zapier (IFTTT like workflow automation with 500+ websites) | Yes | Yes | $ Yes
Integrated IFTTT | [Yes](https://github.com/wekan/wekan/wiki/IFTTT) | No | No
Integrated IFTTT | [Yes](IFTTT) | No | No
## Basic features: Email and Notifications
@ -184,7 +184,7 @@ Features | Wekan | Trello | Restyaboard
Additional settings | No in Web UI, most settings at CLI | Yes | Yes (Basic only)
Profile | Yes | Yes | Yes
Add a new email address | Register / Invite | Yes | No
Roles management | On web board+[API](https://github.com/wekan/wekan/wiki/REST-API-Role) | No | Yes
Roles management | On web board+[API](REST-API-Role) | No | Yes
Settings management | Only some at Web UI, most settings at CLI | No | Yes
Users management | Add/Remove Orgs/Teams/Users | Yes? | Yes
Permanently delete your entire account forever? | No | Yes | Yes (Admin can delete)
@ -194,10 +194,10 @@ Permanently delete your entire account forever? | No | Yes | Yes (Admin can dele
Features | Wekan | Trello | Restyaboard
------------ | ------------- | ------------- | -------------
Login with username or email | Yes | Yes | Yes
LDAP login | Standalone: [Yes](https://github.com/wekan/wekan/wiki/LDAP). Sandstorm: Yes. | No | $ Yes
LDAP login | Standalone: [Yes](LDAP). Sandstorm: Yes. | No | $ Yes
SAML login | Standalone: [Not yet](https://github.com/wekan/wekan/issues/708). Sandstorm: Yes | No | No
Google login | Not yet, needs fixes to [OAuth2](https://github.com/wekan/wekan/wiki/OAuth2) | Yes | No
GitHub login | Standalone: Not yet, needs fixes to [OAuth2](https://github.com/wekan/wekan/wiki/OAuth2). Sandstorm: Yes. | No | No
Google login | Not yet, needs fixes to [OAuth2](OAuth2) | Yes | No
GitHub login | Standalone: Not yet, needs fixes to [OAuth2](OAuth2). Sandstorm: Yes. | No | No
Passwordless email login | Standalone: No. Sandstorm: Yes. | No | No
## Apps for productivity: Import / Export
@ -226,7 +226,7 @@ Show attachments in board | No, only at each card | No | Yes
Features | Wekan | Trello | Restyaboard
------------ | ------------- | ------------- | -------------
Apps (Power-ups) | All integrated in, no separate plugin/app install | Yes | Yes
Custom Field App | [Yes](https://github.com/wekan/wekan/wiki/Custom-Fields) | Yes | $ Yes
Custom Field App | [Yes](Custom-Fields) | Yes | $ Yes
Estimated Time Custom Field App / Time Tracking | Reveived/Start/End/Due/End Date, Spent time, Requested By, Assigned By. No reports. For more advanced, [Not yet](https://github.com/wekan/wekan/issues/812) | Yes, 3rd party Burndown, Harvest etc | $ Yes
Analytics | [Magento integration](https://github.com/wekan/wekan-snap/wiki/Supported-settings-keys) | No | No
Hide card additional information | Yes, card and board activities | Yes, card activities | Yes, card activities
@ -239,7 +239,7 @@ Introduction video | No | No | Yes
List sorting by due date | No | No | Yes
Home screen | No | No | Yes
Apps Integration | All integrated in | Yes | Yes
Chat | No. You could use [Rocket.Chat](https://github.com/wekan/wekan/wiki/OAuth2) | No | $ Yes
Chat | No. You could use [Rocket.Chat](OAuth2) | No | $ Yes
Dashboard Charts | [Not yet](https://github.com/wekan/wekan-dashing-go) | No | $ Yes
Hide Card Created Date App | No | No | Yes
Hide Card ID App | No | No | Yes
@ -247,9 +247,9 @@ Canned Response App | No | No | $ Yes
Auto Archive Expired Cards App | No | No | $ Yes
Support Desk | No | No | $ Yes
Card Template App | Copy Checklist Template to Multiple Cards | Yes | $ Yes
Slack | [Yes](https://github.com/wekan/wekan/wiki/Outgoing-Webhook-to-Discord) | Yes | $ Yes
Slack | [Yes](Outgoing-Webhook-to-Discord) | Yes | $ Yes
Amazon Echo | No | No | $ Yes
Collaborate/TogetherJS | [Not yet](https://github.com/wekan/wekan/wiki/Friend) | No | Yes
Collaborate/TogetherJS | [Not yet](Friend) | No | Yes
Gmail Add-on | No | Yes | Yes
Hangouts Chat bot | No | Yes | $ Yes
Print board | No | No | $ Yes
@ -265,8 +265,8 @@ SEO Checklist | No | No | $ Yes
Features | Wekan | Trello | Restyaboard
------------ | ------------- | ------------- | -------------
iOS Mobile App | [Not yet](https://github.com/wekan/wekan/wiki/Friend). Mobile Chrome browser works. | Yes | Yes
Android Mobile App | [Yes](https://github.com/wekan/wekan/wiki/Browser-compatibility-matrix) | Yes | Yes
Windows Microsoft Store App | [Yes](https://github.com/wekan/wekan/wiki/Browser-compatibility-matrix) | ? | ?
Ubuntu Touch OpenStore App | [Yes](https://github.com/wekan/wekan/wiki/Browser-compatibility-matrix) | ? | ?
iOS Mobile App | [Not yet](Friend). Mobile Chrome browser works. | Yes | Yes
Android Mobile App | [Yes](Browser-compatibility-matrix) | Yes | Yes
Windows Microsoft Store App | [Yes](Browser-compatibility-matrix) | ? | ?
Ubuntu Touch OpenStore App | [Yes](Browser-compatibility-matrix) | ? | ?

@ -1,4 +1,4 @@
Use these instructions instead: [Offline](https://github.com/wekan/wekan/wiki/Offline)
Use these instructions instead: [Offline](Offline)
***
@ -8,7 +8,7 @@ Use these instructions instead: [Offline](https://github.com/wekan/wekan/wiki/Of
This has **highest performance and lowest RAM usage**, because there is no virtualization like Docker, Windows Subsystem for Linux, etc. Wekan is run with Windows native version of Node.js and MongoDB, directly at Windows filesystem.
1. If you have important data in Wekan, do [backup](https://github.com/wekan/wekan/wiki/Backup).
1. If you have important data in Wekan, do [backup](Backup).
2. Install newest Node.js LTS v12.x for Windows from https://nodejs.org . When installing, checkmark "Install additional tools" that will install also Chocolatey etc.
@ -21,7 +21,7 @@ choco install -y mongodb
5. Unzip wekan-x.xx.zip, it has directory name `bundle`
6. Download [start-wekan.bat](https://raw.githubusercontent.com/wekan/wekan/master/start-wekan.bat) to your bundle directory. Default settins are: `ROOT_URL=http://localhost` and `PORT=80`, so it works only in local [compatible browser](https://github.com/wekan/wekan/wiki/Browser-compatibility-matrix). You can edit [ROOT_URL](https://github.com/wekan/wekan/wiki/Settings) to be or `http://YOUR-IP-ADDRESS` so it works on local network with `http://YOUR-IP-ADDRESS` .
6. Download [start-wekan.bat](https://raw.githubusercontent.com/wekan/wekan/master/start-wekan.bat) to your bundle directory. Default settins are: `ROOT_URL=http://localhost` and `PORT=80`, so it works only in local [compatible browser](Browser-compatibility-matrix). You can edit [ROOT_URL](Settings) to be or `http://YOUR-IP-ADDRESS` so it works on local network with `http://YOUR-IP-ADDRESS` .
7. Start Wekan in cmd.exe as Administrator:
```
@ -79,7 +79,7 @@ List databases again to show that database testing is not there anymore:
```
show dbs
```
Also see [Forgot Password](https://github.com/wekan/wekan/wiki/Forgot-Password)
Also see [Forgot Password](Forgot-Password)
Exit MongoDB CLI:
```
@ -89,18 +89,18 @@ You should not backup Windows MongoDB RAW database files that are here, when you
```
C:\ProgramData\MongoDB\data\db
```
[More info about MongoDB](https://github.com/wekan/wekan/wiki/Export-from-Wekan-Sandstorm-grain-.zip-file)
[More info about MongoDB](Export-from-Wekan-Sandstorm-grain-.zip-file)
9. [Add users](https://github.com/wekan/wekan/wiki/Adding-users).
9. [Add users](Adding-users).
***
## b) [Docker](https://github.com/wekan/wekan/wiki/Docker)
## b) [Docker](Docker)
Note: With Docker, please don't use latest tag. Only use release tags. See https://github.com/wekan/wekan/issues/3874
[Repair Docker](https://github.com/wekan/wekan/wiki/Repair-Docker)
[Repair Docker](Repair-Docker)
If you don't need to build Wekan, use prebuilt container with docker-compose.yml from https://github.com/wekan/wekan like this:
```
@ -166,9 +166,9 @@ Currently Snap works only when installed to Ubuntu 19.10 64bit running on Virtua
https://github.com/wekan/wekan-snap/wiki/Install
[Related VM info how to expose port with bridged networking](https://github.com/wekan/wekan/wiki/Virtual-Appliance)
[Related VM info how to expose port with bridged networking](Virtual-Appliance)
[UCS has prebuilt VirtualBox VM](https://github.com/wekan/wekan/wiki/Platforms#production-univention-platform-many-apps-and-wekan)
[UCS has prebuilt VirtualBox VM](Platforms#production-univention-platform-many-apps-and-wekan)
***
@ -176,7 +176,7 @@ https://github.com/wekan/wekan-snap/wiki/Install
## e) Probaby does not work
[Install from source directly on Windows](https://github.com/wekan/wekan/wiki/Install-Wekan-from-source-on-Windows) to get Wekan running natively on Windows. [git clone on Windows has been fixed](https://github.com/wekan/wekan/issues/977). Related: [running standalone](https://github.com/wekan/wekan/issues/883) and [nexe](https://github.com/wekan/wekan/issues/710).
[Install from source directly on Windows](Install-Wekan-from-source-on-Windows) to get Wekan running natively on Windows. [git clone on Windows has been fixed](https://github.com/wekan/wekan/issues/977). Related: [running standalone](https://github.com/wekan/wekan/issues/883) and [nexe](https://github.com/wekan/wekan/issues/710).
## f) Install Meteor on Windows - does not build correctly, gives errors

@ -4,31 +4,31 @@
* [Docs/Manual](https://github.com/wekan/wekan/discussions/4522)
* [Change Language](https://github.com/wekan/wekan/issues/4518#issuecomment-1133763518)
* [Forgot Password](https://github.com/wekan/wekan/wiki/Forgot-Password)
* [Forgot Password](Forgot-Password)
* [About](https://github.com/wekan/wekan/wiki)
* [Test Edge](https://github.com/wekan/wekan/wiki/Test-Edge)
* [FAQ](https://github.com/wekan/wekan/wiki/FAQ)
* [IRC FAQ](https://github.com/wekan/wekan/wiki/IRC-FAQ) - answers to questions asked at IRC
* [Test Edge](Test-Edge)
* [FAQ](FAQ)
* [IRC FAQ](IRC-FAQ) - answers to questions asked at IRC
* [Roadmap](https://boards.wekan.team/b/D2SzJKZDS4Z48yeQH/wekan-open-source-kanban-board-with-mit-license) - board at Wekan demo
* [Team](https://github.com/wekan/wekan/wiki/Team)
* [Press](https://github.com/wekan/wekan/wiki/Press)
* [Team](Team)
* [Press](Press)
* [Blog](https://blog.wekan.team)
* [NOT related to Wekan](https://github.com/wekan/wekan/wiki/NOT-related-to-Wekan)
* [NOT related to Wekan](NOT-related-to-Wekan)
* [Wekan vs Trello vs Restyaboard](Wekan-vs-Trello-vs-Restyaboard)
* [Results of Survey 2020-01](https://blog.wekan.team/2020/06/results-of-wekan-survey-2020-01/)
# <a name="Security"></a>Security
* [Allow private boards only: Disable Public Boards](https://github.com/wekan/wekan/wiki/Allow-private-boards-only)
* [Allow private boards only: Disable Public Boards](Allow-private-boards-only)
* [Security Disclosure and details of Security in Wekan](https://github.com/wekan/wekan/blob/master/SECURITY.md)
* [Security issues](https://github.com/wekan/wekan/issues?q=is%3Aissue+is%3Aopen+label%3ASecurity)
* [Password Hashing](https://github.com/wekan/wekan/wiki/Password-Hashing)
* [Password Hashing](Password-Hashing)
# <a name="Scaling"></a>Scaling
* [Add more RAM to Node.js to prevent crash](https://github.com/wekan/wekan/issues/3585)
* [Clustering AWS etc](https://github.com/wekan/wekan/wiki/AWS)
* [Scaling](https://github.com/wekan/wekan/wiki/Scaling)
* [Clustering AWS etc](AWS)
* [Scaling](Scaling)
* [Kubernetes](https://github.com/wekan/wekan/tree/master/helm/wekan)
* [Redis Oplog](https://github.com/cult-of-coders/redis-oplog)
* [Meteor Scaling](https://galaxy-guide.meteor.com/scaling.html) at [Meteor Cloud](https://www.meteor.com/cloud)
@ -36,139 +36,139 @@
# <a name="Migrating"></a>Migrating
* [From CSV/TSV](https://github.com/wekan/wekan/wiki/CSV)
* [From Trello](https://github.com/wekan/wekan/wiki/Migrating-from-Trello)
* [From Jira](https://github.com/wekan/wekan/wiki/Jira)
* [From Asana](https://github.com/wekan/wekan/wiki/Asana)
* [From CSV/TSV](CSV)
* [From Trello](Migrating-from-Trello)
* [From Jira](Jira)
* [From Asana](Asana)
* [From Zenkit](https://github.com/wekan/wekan/discussions/4487)
* [From old Wekan manually](https://github.com/wekan/wekan/wiki/Migrating-from-old-Wekan-manually)
* [Converting Meteor Stylus to CSS](https://github.com/wekan/wekan/wiki/Converting-Meteor-Stylus-to-CSS)
* [From old Wekan manually](Migrating-from-old-Wekan-manually)
* [Converting Meteor Stylus to CSS](Converting-Meteor-Stylus-to-CSS)
# <a name="Support"></a>Support priorities for new features and bugfixes
1) [Commercial Support](https://wekan.team/commercial-support/)
2) [Community Support](https://github.com/wekan/wekan/issues)
3) [Debugging](https://github.com/wekan/wekan/wiki/Debugging)
3) [Debugging](Debugging)
# Backup
* [Backup and Restore](https://github.com/wekan/wekan/wiki/Backup)
* [Backup and Restore](Backup)
# <a name="Repair"></a>Repair
* [Repair MongoDB](https://github.com/wekan/wekan/wiki/Repair-MongoDB)
* [Using Meteor MongoDB to repair files](https://github.com/wekan/wekan/wiki/Export-from-Wekan-Sandstorm-grain-.zip-file)
* [If board does not open and keeps loading](https://github.com/wekan/wekan/wiki/If-board-does-not-open-and-keeps-loading)
* [Repair Docker](https://github.com/wekan/wekan/wiki/Repair-Docker)
* [Repair MongoDB](Repair-MongoDB)
* [Using Meteor MongoDB to repair files](Export-from-Wekan-Sandstorm-grain-.zip-file)
* [If board does not open and keeps loading](If-board-does-not-open-and-keeps-loading)
* [Repair Docker](Repair-Docker)
# <a name="Themes"></a> Themes
* [Themes](https://github.com/wekan/wekan/wiki/Custom-CSS-themes)
* [Dark Mode](https://github.com/wekan/wekan/wiki/Dark-Mode)
* [Themes](Custom-CSS-themes)
* [Dark Mode](Dark-Mode)
# <a name="MarkdownSyntax"></a>Markdown Syntax
* [Wekan Markdown](https://github.com/wekan/wekan/wiki/Wekan-Markdown)
* [Emoji](https://github.com/wekan/wekan/wiki/Emoji)
* [Mermaid Diagram](https://github.com/wekan/wekan/wiki/Mermaid-Diagram)
* [Numbered text](https://github.com/wekan/wekan/wiki/Numbered-text)
* [Wekan Markdown](Wekan-Markdown)
* [Emoji](Emoji)
* [Mermaid Diagram](Mermaid-Diagram)
* [Numbered text](Numbered-text)
# <a name="LoginAuth"></a>Login Auth
* [Automatic login](autologin)
* [Forgot Password](https://github.com/wekan/wekan/wiki/Forgot-Password)
* [Admin: Impersonate user](https://github.com/wekan/wekan/wiki/Impersonate-user)
* [Adding Users](https://github.com/wekan/wekan/wiki/Adding-users)
* [Forgot Password](Forgot-Password)
* [Admin: Impersonate user](Impersonate-user)
* [Adding Users](Adding-users)
* [Active users Presence](https://github.com/wekan/wekan/issues/3734)
* [Accounts Lockout: Brute force login protection](https://github.com/wekan/wekan/wiki/Accounts-Lockout)
* [LDAP](https://github.com/wekan/wekan/wiki/LDAP)
* [LDAP AD Simple Auth](https://github.com/wekan/wekan/wiki/LDAP-AD-Simple-Auth)
* [Keycloak](https://github.com/wekan/wekan/wiki/Keycloak)
* [Google login](https://github.com/wekan/wekan/wiki/Google-login)
* [Azure](https://github.com/wekan/wekan/wiki/Azure)
* [OAuth2](https://github.com/wekan/wekan/wiki/OAuth2), Auth0, GitLab, RocketChat
* [Oracle OIM on premise using OAuth2](https://github.com/wekan/wekan/wiki/Oracle-OIM)
* [ADFS 4.0 using OAuth2 and OpenID](https://github.com/wekan/wekan/wiki/ADFS)
* [Nextcloud](https://github.com/wekan/wekan/wiki/Nextcloud)
* [CAS](https://github.com/wekan/wekan/wiki/CAS) Please test
* [SAML](https://github.com/wekan/wekan/wiki/SAML) Please test
* [Accounts Lockout: Brute force login protection](Accounts-Lockout)
* [LDAP](LDAP)
* [LDAP AD Simple Auth](LDAP-AD-Simple-Auth)
* [Keycloak](Keycloak)
* [Google login](Google-login)
* [Azure](Azure)
* [OAuth2](OAuth2), Auth0, GitLab, RocketChat
* [Oracle OIM on premise using OAuth2](Oracle-OIM)
* [ADFS 4.0 using OAuth2 and OpenID](ADFS)
* [Nextcloud](Nextcloud)
* [CAS](CAS) Please test
* [SAML](SAML) Please test
# <a name="Integrations"></a>Integrations
* [IFTTT](https://github.com/wekan/wekan/wiki/IFTTT)
* [IFTTT](IFTTT)
* [n8n Wekan docs](https://docs.n8n.io/nodes/n8n-nodes-base.wekan/#example-usage) - [n8n GitHub](https://github.com/n8n-io/n8n)
* [Integrations](https://github.com/wekan/wekan/wiki/Integrations)
* [Integrations](Integrations)
* [Gogs](https://github.com/wekan/wekan-gogs)
# <a name="Time"></a>Time
* [Time Tracking](https://github.com/wekan/wekan/wiki/Time-Tracking)
* [Gantt Chart](https://github.com/wekan/wekan/wiki/Gantt)
* [Due Date](https://github.com/wekan/wekan/wiki/Due-Date)
* [Time Tracking](Time-Tracking)
* [Gantt Chart](Gantt)
* [Due Date](Due-Date)
# <a name="Features"></a>Features
* [Python based features](https://github.com/wekan/wekan/wiki/Python)
* [Burndown and Velocity Chart](https://github.com/wekan/wekan/wiki/Burndown-and-Velocity-Chart)
* [Wait Spinners](https://github.com/wekan/wekan/wiki/Wait-Spinners)
* [Translations](https://github.com/wekan/wekan/wiki/Translations)
* [Python based features](Python)
* [Burndown and Velocity Chart](Burndown-and-Velocity-Chart)
* [Wait Spinners](Wait-Spinners)
* [Translations](Translations)
* [Default Language for All Users](https://github.com/wekan/wekan/issues/3927)
* [Roadmap](https://github.com/wekan/wekan/wiki/Roadmap)
* [Features](https://github.com/wekan/wekan/wiki/Features)
* [Planning Poker](https://github.com/wekan/wekan/wiki/Planning-Poker)
* [Scaling](https://github.com/wekan/wekan/wiki/Scaling)
* [Custom Logo](https://github.com/wekan/wekan/wiki/Custom-Logo)
* [Subtasks](https://github.com/wekan/wekan/wiki/Subtasks) <== Has fix
* [Templates](https://github.com/wekan/wekan/wiki/Templates)
* [Archive and Delete](https://github.com/wekan/wekan/wiki/Archive-and-Delete)
* [Custom Fields](https://github.com/wekan/wekan/wiki/Custom-Fields)
* [Roadmap](Roadmap)
* [Features](Features)
* [Planning Poker](Planning-Poker)
* [Scaling](Scaling)
* [Custom Logo](Custom-Logo)
* [Subtasks](Subtasks) <== Has fix
* [Templates](Templates)
* [Archive and Delete](Archive-and-Delete)
* [Custom Fields](Custom-Fields)
* [Fix Export board menu not visible on some boards](https://github.com/wekan/wekan/issues/1060)
* [RAM usage](https://github.com/wekan/wekan/issues/1088#issuecomment-311843230)
* [Demo](https://wekan.indie.host/b/t2YaGmyXgNkppcFBq/wekan-fork-roadmap)
* [Swimlane Documentation](https://github.com/wekan/wekan/wiki/Swimlanes)
* [Swimlane Documentation](Swimlanes)
# <a name="Email"></a>Email
* [Email](https://github.com/wekan/wekan/wiki/Troubleshooting-Mail)
* [Email](Troubleshooting-Mail)
# <a name="Logs"></a>Logs and Stats
* [Logs](https://github.com/wekan/wekan/wiki/Logs)
* [Stats](https://github.com/wekan/wekan/wiki/Features#stats)
* [Logs](Logs)
* [Stats](Features#stats)
# <a name="Settings"></a>Required Settings
* [Requirements](https://github.com/wekan/wekan/wiki/Requirements)
* [Requirements](Requirements)
* [Ports, hostsfile, how Internet works](https://github.com/wekan/wekan/issues/2896)
* [ROOT_URL Settings](https://github.com/wekan/wekan/wiki/Settings)
* [ROOT_URL Settings](Settings)
# <a name="Platforms"></a>Download
* [Download Wekan for various Platforms](https://github.com/wekan/wekan/wiki/Platforms): Supported by xet7, Operating Systems, NAS, Cloud
* [Helm Chart for Kubernetes](https://github.com/wekan/wekan/wiki/Helm)
* [Download Wekan for various Platforms](Platforms): Supported by xet7, Operating Systems, NAS, Cloud
* [Helm Chart for Kubernetes](Helm)
# <a name="Webservers"></a>Webservers
* [Caddy](https://github.com/wekan/wekan/wiki/Caddy-Webserver-Config)
* [Nginx](https://github.com/wekan/wekan/wiki/Nginx-Webserver-Config)
* [Apache](https://github.com/wekan/wekan/wiki/Apache)
* [Caddy](Caddy-Webserver-Config)
* [Nginx](Nginx-Webserver-Config)
* [Apache](Apache)
* [OpenLiteSpeed](https://github.com/wekan/wekan/issues/3334#issuecomment-723651328)
* [Let's Encrypt and Google Auth](https://github.com/wekan/wekan/wiki/Let's-Encrypt-and-Google-Auth)
* [Let's Encrypt and Google Auth](Let's-Encrypt-and-Google-Auth)
* [TLS with Node.js](https://github.com/wekan/wekan/issues/916)
* [Traefik and self-signed SSL certs](https://github.com/wekan/wekan/wiki/Traefik-and-self-signed-SSL-certs)
* [Traefik and self-signed SSL certs](Traefik-and-self-signed-SSL-certs)
# <a name="API"></a>REST API Docs
* [Login](https://github.com/wekan/wekan/wiki/REST-API)
* [User](https://github.com/wekan/wekan/wiki/REST-API-User)
* [Role](https://github.com/wekan/wekan/wiki/REST-API-Role)
* [Boards](https://github.com/wekan/wekan/wiki/REST-API-Boards)
* [Lists](https://github.com/wekan/wekan/wiki/REST-API-Lists)
* [Cards](https://github.com/wekan/wekan/wiki/REST-API-Cards)
* [Checklists](https://github.com/wekan/wekan/wiki/REST-API-Checklists)
* [Swimlanes](https://github.com/wekan/wekan/wiki/REST-API-Swimlanes)
* [Custom Fields](https://github.com/wekan/wekan/wiki/REST-API-Custom-Fields)
* [Integrations](https://github.com/wekan/wekan/wiki/REST-API-Integrations)
* [Login](REST-API)
* [User](REST-API-User)
* [Role](REST-API-Role)
* [Boards](REST-API-Boards)
* [Lists](REST-API-Lists)
* [Cards](REST-API-Cards)
* [Checklists](REST-API-Checklists)
* [Swimlanes](REST-API-Swimlanes)
* [Custom Fields](REST-API-Custom-Fields)
* [Integrations](REST-API-Integrations)
# <a name="api-issue"></a>REST API issue
@ -176,37 +176,37 @@
# <a name="api-client-code"></a>REST API client code
* [Example: New card with Python3 and REST API](https://github.com/wekan/wekan/wiki/New-card-with-Python3-and-REST-API)
* [Example: New card with Python3 and REST API](New-card-with-Python3-and-REST-API)
* [Python client to REST API](https://github.com/wekan/wekan-python-api-client)
* [Java](https://github.com/wekan/wekan/wiki/Java)
* [Wekan Sandstorm cards to CSV using Python](https://github.com/wekan/wekan/wiki/Wekan-Sandstorm-cards-to-CSV-using-Python)
* [Excel and VBA](https://github.com/wekan/wekan/wiki/Excel-and-VBA)
* [Java](Java)
* [Wekan Sandstorm cards to CSV using Python](Wekan-Sandstorm-cards-to-CSV-using-Python)
* [Excel and VBA](Excel-and-VBA)
# <a name="Webhooks"></a>Webhooks
* [Global Webhook](https://github.com/wekan/wekan/pull/2665)
* [Limiting Webhook data](https://github.com/wekan/wekan/issues/2830)
* [Receiving Webhooks](https://github.com/wekan/wekan/wiki/Receiving-Webhooks)
* [Outgoing Webhook to Discord/Slack/RocketChat/Riot](https://github.com/wekan/wekan/wiki/Outgoing-Webhook-to-Discord)
* [Receiving Webhooks](Receiving-Webhooks)
* [Outgoing Webhook to Discord/Slack/RocketChat/Riot](Outgoing-Webhook-to-Discord)
* [Outgoing Webhook to NodeRed](https://github.com/wekan/wekan/issues/2017)
* [Outgoing Webhook to PowerShell](https://github.com/wekan/wekan/issues/2518)
* [Security: Webhook and CA](https://github.com/wekan/wekan/wiki/WebHook-And-CA)
* [Outgoing Webhooks Data](https://github.com/wekan/wekan/wiki/Webhook-data)
* [Outgoing Webhooks and Let's Encrypt](https://github.com/wekan/wekan/wiki/WebHook-And-CA)
* [Security: Webhook and CA](WebHook-And-CA)
* [Outgoing Webhooks Data](Webhook-data)
* [Outgoing Webhooks and Let's Encrypt](WebHook-And-CA)
* Outgoing Webhooks [Original Pull Request](https://github.com/wekan/wekan/pull/1119), [multiple Webhooks](https://github.com/wekan/wekan/pull/1199), [more parameters and response order](https://github.com/wekan/wekan/pull/1263)
# <a name="Case-Studies"></a>Case Studies
* [Implementing GDPR](https://github.com/wekan/wekan/wiki/GDPR)
* [Implementing GDPR](GDPR)
# <a name="Development"></a>Development
* [Kadira integration](https://github.com/wekan/wekan/issues/2152)
* [Debugging](https://github.com/wekan/wekan/wiki/Debugging)
* [Developer Docs for Standalone Wekan](https://github.com/wekan/wekan/wiki/Developer-Documentation)
* [Debugging](Debugging)
* [Developer Docs for Standalone Wekan](Developer-Documentation)
* [Developer Docs for Sandstorm Wekan](https://github.com/wekan/wekan-maintainer/wiki/Developing-Wekan-for-Sandstorm)
* [Adding new Snap setting to code](https://github.com/wekan/wekan/wiki/Adding-new-Snap-settings-to-code)
* [Directory Structure](https://github.com/wekan/wekan/wiki/Directory-Structure)
* [Adding new Snap setting to code](Adding-new-Snap-settings-to-code)
* [Directory Structure](Directory-Structure)
* [Building Wekan for Sandstorm](https://github.com/wekan/wekan-maintainer/wiki/Building-Wekan-for-Sandstorm)
* [Docs - Sandstorm etc](https://github.com/wekan/wekan/labels/Documentation)
* [Beginner](https://github.com/wekan/wekan/labels/Beginner)

2
ppc.md

@ -4,7 +4,7 @@
- [University of Campinas - Unicamp Minicloud](https://openpower.ic.unicamp.br)
[xet7](https://github.com/xet7), as maintainer of [Wekan](https://wekan.github.io), got access to ppc64le at
at University of Campinas - Unicamp Minicloud. Unicamp is member of [OpenPOWER Foundation](https://openpowerfoundation.org). At Minicloud OpenStack, xet7 created Ubuntu 20.10 VM, and at 2020-12-22 ported Wekan to ppc64le very similarly like previously for [s390x](https://github.com/wekan/wekan/wiki/s390x).
at University of Campinas - Unicamp Minicloud. Unicamp is member of [OpenPOWER Foundation](https://openpowerfoundation.org). At Minicloud OpenStack, xet7 created Ubuntu 20.10 VM, and at 2020-12-22 ported Wekan to ppc64le very similarly like previously for [s390x](s390x).
## Installing MongoDB on OpenPower Ubuntu 20.04 ppc64le

@ -71,7 +71,7 @@ New info 2022-01-18:
sudo snap install mongo36-configurable
```
4. Install WeKan s390x bundle from:
- https://github.com/wekan/wekan/wiki/Raspberry-Pi
- [Raspberry Pi](Raspberry-Pi)
- https://releases.wekan.team/s390x/
Old info:
@ -107,15 +107,15 @@ For example files can be like these filenames:
## Install
Installing is similar like at https://github.com/wekan/wekan/wiki/Raspberry-Pi
Installing is similar like at [Raspberry Pi](Raspberry-Pi)
You can start it with start-wekan.sh from https://github.com/wekan/wekan or add SystemD service.
Setup ROOT_URL like described at https://github.com/wekan/wekan/wiki/Settings
Setup ROOT_URL like described at [Settings](Settings)
At https://github.com/wekan/wekan/wiki is also info about Caddy/Nginx/Apache etc.
At wiki is also info about Caddy/Nginx/Apache etc.
Some related links also at https://github.com/wekan/wekan/wiki/Platforms
Some related links also at [Platforms](Platforms)
## How this s390x bundle package was created for RHEL 7