Reorganized docs Platforms etc.

Thanks to xet7 !
This commit is contained in:
Lauri Ojansivu committed 2026-08-03 13:07:12 +03:00
1 parent 3cb4cab095
commit f628a69889
213 files changed
+490 -464

No files matched your search

+1 -1
View File
@@ -581,7 +581,7 @@ services:
#-----------------------------------------------------------------
# ==== LDAP: UNCOMMENT ALL TO ENABLE LDAP ====
# https://github.com/wekan/wekan/blob/main/docs/Login/LDAP.md
# For Snap settings see https://github.com/wekan/wekan/blob/main/docs/Platforms/FOSS/Snap/Supported-settings-keys.md
# For Snap settings see https://github.com/wekan/wekan/blob/main/docs/Platforms/FOSS/Container/Snap/Supported-settings-keys.md
# Most settings work both on Snap and Docker below.
# Note: Do not add single quotes '' to variables. Having spaces still works without quotes where required.
#
+1 -1
View File
@@ -583,7 +583,7 @@ services:
#-----------------------------------------------------------------
# ==== LDAP: UNCOMMENT ALL TO ENABLE LDAP ====
# https://github.com/wekan/wekan/blob/main/docs/Login/LDAP.md
# For Snap settings see https://github.com/wekan/wekan/blob/main/docs/Platforms/FOSS/Snap/Supported-settings-keys.md
# For Snap settings see https://github.com/wekan/wekan/blob/main/docs/Platforms/FOSS/Container/Snap/Supported-settings-keys.md
# Most settings work both on Snap and Docker below.
# Note: Do not add single quotes '' to variables. Having spaces still works without quotes where required.
#
+1 -1
View File
@@ -570,7 +570,7 @@ services:
#-----------------------------------------------------------------
# ==== LDAP: UNCOMMENT ALL TO ENABLE LDAP ====
# https://github.com/wekan/wekan/blob/main/docs/Login/LDAP.md
# For Snap settings see https://github.com/wekan/wekan/blob/main/docs/Platforms/FOSS/Snap/Supported-settings-keys.md
# For Snap settings see https://github.com/wekan/wekan/blob/main/docs/Platforms/FOSS/Container/Snap/Supported-settings-keys.md
# Most settings work both on Snap and Docker below.
# Note: Do not add single quotes '' to variables. Having spaces still works without quotes where required.
#
+1 -1
View File
@@ -587,7 +587,7 @@ services:
#-----------------------------------------------------------------
# ==== LDAP: UNCOMMENT ALL TO ENABLE LDAP ====
# https://github.com/wekan/wekan/blob/main/docs/Login/LDAP.md
# For Snap settings see https://github.com/wekan/wekan/blob/main/docs/Platforms/FOSS/Snap/Supported-settings-keys.md
# For Snap settings see https://github.com/wekan/wekan/blob/main/docs/Platforms/FOSS/Container/Snap/Supported-settings-keys.md
# Most settings work both on Snap and Docker below.
# Note: Do not add single quotes '' to variables. Having spaces still works without quotes where required.
#
+1 -1
View File
@@ -477,7 +477,7 @@ services:
#-----------------------------------------------------------------
# ==== LDAP: UNCOMMENT ALL TO ENABLE LDAP ====
# https://github.com/wekan/wekan/blob/main/docs/Login/LDAP.md
# For Snap settings see https://github.com/wekan/wekan/blob/main/docs/Platforms/FOSS/Snap/Supported-settings-keys.md
# For Snap settings see https://github.com/wekan/wekan/blob/main/docs/Platforms/FOSS/Container/Snap/Supported-settings-keys.md
# Most settings work both on Snap and Docker below.
# Note: Do not add single quotes '' to variables. Having spaces still works without quotes where required.
#
+1 -1
View File
@@ -711,7 +711,7 @@ services:
#-----------------------------------------------------------------
# ==== LDAP: UNCOMMENT ALL TO ENABLE LDAP ====
# https://github.com/wekan/wekan/blob/main/docs/Login/LDAP.md
# For Snap settings see https://github.com/wekan/wekan/blob/main/docs/Platforms/FOSS/Snap/Supported-settings-keys.md
# For Snap settings see https://github.com/wekan/wekan/blob/main/docs/Platforms/FOSS/Container/Snap/Supported-settings-keys.md
# Most settings work both on Snap and Docker below.
# Note: Do not add single quotes '' to variables. Having spaces still works without quotes where required.
#
+1 -1
View File
@@ -21,7 +21,7 @@
# opened exclusively. Give each service its own internal port via
# METEOR_SETTINGS and they coexist cleanly.
#
# Reference: see docs/Platforms/FOSS/Docker/Meteor3/multitenancy.md
# Reference: see docs/Platforms/FOSS/Container/Docker/Meteor3/multitenancy.md
# and https://docs.meteor.com/performance/ddp-transport#multitenancy
#
# Setup:
+1 -1
View File
@@ -541,7 +541,7 @@ services:
#-----------------------------------------------------------------
# ==== LDAP: UNCOMMENT ALL TO ENABLE LDAP ====
# https://github.com/wekan/wekan/blob/main/docs/Login/LDAP.md
# For Snap settings see https://github.com/wekan/wekan/blob/main/docs/Platforms/FOSS/Snap/Supported-settings-keys.md
# For Snap settings see https://github.com/wekan/wekan/blob/main/docs/Platforms/FOSS/Container/Snap/Supported-settings-keys.md
# Most settings work both on Snap and Docker below.
# Note: Do not add single quotes '' to variables. Having spaces still works without quotes where required.
#
+6 -6
View File
@@ -5,7 +5,7 @@
# Upgrade Sandstorm WeKan
[Upgrade Sandstorm WeKan ](../Platforms/FOSS/Sandstorm/Sandstorm.md)
[Upgrade Sandstorm WeKan ](../Platforms/FOSS/Container/Sandstorm)
# Backup Docker
@@ -523,7 +523,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](../Platforms/FOSS/Sandstorm/Export-from-Wekan-Sandstorm-grain-.zip-file.md). Files are base64 encoded in JSON files.
You can [save all MongoDB database content as JSON files](../Platforms/FOSS/Container/Sandstorm/Export-from-Wekan-Sandstorm-grain-.zip-file.md). 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.
@@ -765,7 +765,7 @@ makesRestore $1
## Docker Backup and Restore
[Docker Backup and Restore](../Platforms/FOSS/Docker/Export-Docker-Mongo-Data.md)
[Docker Backup and Restore](../Platforms/FOSS/Container/Docker/Export-Docker-Mongo-Data.md)
[Wekan Docker Upgrade](https://github.com/wekan/wekan-mongodb#backup-before-upgrading)
@@ -779,11 +779,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](../Platforms/FOSS/Sandstorm/Export-from-Wekan-Sandstorm-grain-.zip-file.md)
[Export data from Wekan Sandstorm grain .zip file](../Platforms/FOSS/Container/Sandstorm/Export-from-Wekan-Sandstorm-grain-.zip-file.md)
## <a name="cloudron">Cloudron
If those [Backup](Backup.md) ways are not easily found at [Cloudron](../Platforms/Propietary/Cloud/Cloudron/Cloudron.md), one way is to install [Redash](https://redash.io/) and then backup this way:
If those [Backup](Backup.md) ways are not easily found at [Cloudron](../Platforms/Propietary/SaaS/Cloudron), one way is to install [Redash](https://redash.io/) and then backup this way:
Redash works with this kind of queries:
```json
@@ -844,7 +844,7 @@ 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](../Platforms/FOSS/Sandstorm/Export-from-Wekan-Sandstorm-grain-.zip-file.md)
8) Remove from downloaded .json files extra query related data, so that it is similar like [any other Wekan database backup JSON files](../Platforms/FOSS/Container/Sandstorm/Export-from-Wekan-Sandstorm-grain-.zip-file.md)
9) Insert data to some other Wekan install with nosqlbooster like mentioned at page [Backup](Backup.md)
+1 -1
View File
@@ -93,7 +93,7 @@ Related, for creating apps to other appstores: [Browser compatibility matrix](Br
3. Clone WeKan repo, add favicons etc from step 2 to wekan/public/ , and build WeKan bundle from source like at [Emoji](../Features/Editor/Emoji.md) . Note: Currently WeKan does not have feature for custom favicons, it would require a lot of work for 100+ favicons etc customizations.
4. Run bundle at server like [Offline](../Platforms/Propietary/Windows/Offline.md) or [Raspberry Pi](../Platforms/FOSS/RaspberryPi/Raspberry-Pi.md)
4. Run bundle at server like [Offline](../Platforms/Propietary/OS/Windows/Offline.md) or [Raspberry Pi](../Platforms/FOSS/HW/RaspberryPi/Raspberry-Pi.md)
5. Install Caddy like [Caddy Webserver Config](../Webserver/Caddy.md) , with this config for PWA at https://boards.example.com , there add assetlinks.json details you got when you downloaded Android .zip file from https://pwabuilder.com , see assetlinks issue about where at Play Console those 2 SHA256 keys https://github.com/pwa-builder/PWABuilder/issues/3867#issuecomment-1450826565
+2 -2
View File
@@ -161,10 +161,10 @@ For SSL/TLS, I run Caddy at front of Node.js:
[Caddy](../../../Webserver/Caddy.md)
Related is docs about Raspberry Pi:
[Raspberry Pi](../../../Platforms/FOSS/RaspberryPi/Raspberry-Pi.md)
[Raspberry Pi](../../../Platforms/FOSS/HW/RaspberryPi/Raspberry-Pi.md)
And also about Windows bundle:
[Offline](../../../Platforms/Propietary/Windows/Offline.md)
[Offline](../../../Platforms/Propietary/OS/Windows/Offline.md)
## Notes
+2 -2
View File
@@ -63,7 +63,7 @@ MONGO_OPLOG_URL=mongodb://<username>:<password>@<host>/local?authSource=admin&re
### ✅ Cloud Deployments
**Documentation Already Exists:**
- `docs/Platforms/Propietary/Cloud/AWS.md` - AWS MONGO_OPLOG_URL configuration
- `docs/Platforms/Propietary/Cloud/AWS` - AWS MONGO_OPLOG_URL configuration
- `docs/Databases/ToroDB/PostgreSQL/docker-compose.yml` - ToroDB oplog settings
### ✅ Documentation
@@ -162,7 +162,7 @@ top -p $(pgrep node)
## Related Documentation
- [Oplog-Configuration.md](Oplog-Configuration.md) - Full setup guide
- [AWS.md](../../Platforms/Propietary/Cloud/AWS.md) - AWS oplog configuration
- [AWS.md](../../Platforms/Propietary/Cloud/AWS) - AWS oplog configuration
- [LDAP.md](../../Login/LDAP.md) - LDAP with oplog setup
- [ToroDB-PostgreSQL](../ToroDB/PostgreSQL/docker-compose.yml) - ToroDB oplog config
+1 -1
View File
@@ -79,7 +79,7 @@ docker-compose up -d
9) Wekan and databases bind to address 0.0.0.0 so could be also available to other
computers in network. I have not tested this.
10) [Restore your MongoDB data](../../../Platforms/FOSS/Docker/Export-Docker-Mongo-Data.md).
10) [Restore your MongoDB data](../../../Platforms/FOSS/Container/Docker/Export-Docker-Mongo-Data.md).
## Feedback
+1 -1
View File
@@ -15,7 +15,7 @@ sudo apt -y install ntpdate
sudo ntpdate ntp.ubuntu.com
```
5. Now local time shows correctly at webbrowser, like for example at Friend Desktop [Friend](../Platforms/FOSS/Friend/Friend.md)
5. Now local time shows correctly at webbrowser, like for example at Friend Desktop [Friend](../Platforms/FOSS/Container/Friend)
For testing any other time related code, that it shows correct local time, compare time functions results to this:
+1 -1
View File
@@ -137,4 +137,4 @@ The macOS analogue of Windows Intune/SCCM/PDQ — the most Snap-like *fleet* aut
- Windows equivalent: [Windows.md](Windows.md)
- Linux Snap auto-refresh & multi-arch snap builds: [Snap-Core.md](../Forks/Snap-Core.md)
- macOS install docs: [Mac.md](../../../Platforms/Propietary/Mac/Mac.md)
- macOS install docs: [Mac.md](../../../Platforms/Propietary/OS/Mac)
+1 -1
View File
@@ -167,4 +167,4 @@ without the user re-running an installer.
- Linux Snap auto-refresh, and why the exotic-arch snap builds differ:
[Snap-Core.md](../Forks/Snap-Core.md)
- [Install WeKan on Windows](../../../Platforms/Propietary/Windows/Install-Windows.md) · [Windows.md](../../../Platforms/Propietary/Windows/Windows.md)
- [Install WeKan on Windows](../../../Platforms/Propietary/OS/Windows/Install-Windows.md) · [Windows.md](../../../Platforms/Propietary/OS/Windows)
+2 -2
View File
@@ -1,6 +1,6 @@
# Dev: releasing WeKan to Univention Corporate Server (UCS) from release-all.yml
Based on [docs/Platforms/FOSS/UCS/UCS.md](../../Platforms/FOSS/UCS/UCS.md) and the
Based on [docs/Platforms/FOSS/Container/UCS](../../Platforms/FOSS/Container/UCS) and the
[wekan/univention](https://github.com/wekan/univention) app repo.
Goal: from `wekan/wekan`'s **release-all.yml**, also release the **Docker-based UCS App
@@ -244,7 +244,7 @@ is safe.
## See also
- [docs/Platforms/FOSS/UCS/UCS.md](../../Platforms/FOSS/UCS/UCS.md) — the user-facing UCS page.
- [docs/Platforms/FOSS/Container/UCS](../../Platforms/FOSS/Container/UCS) — the user-facing UCS page.
- [Snap-Core.md](Forks/Snap-Core.md) — the snap build that already runs the same MongoDB→FerretDB migration.
- [Snap-Ondra-Gantt.md](Snap-Ondra-Gantt.md) — the same "push to a downstream repo + publish"
pattern for variant snaps.
+3 -3
View File
@@ -33,9 +33,9 @@ https://www.youtube.com/watch?v=ke-mbnZM3zE
## Meteor WeKan Server
- Meteor.js 2.x, Node.js 14.x https://github.com/wekan/node-v14-esm/releases/tag/v14.21.4 , MongoDB 6.x
- CPU: amd64, arm64, s390x, Source Bundle at [Raspberry Pi](../Platforms/FOSS/RaspberryPi/Raspberry-Pi.md)
- Windows On-Premise: [Offline](../Platforms/Propietary/Windows/Offline.md)
- Mac: Docker, or at [Mac](../Platforms/Propietary/Mac/Mac.md)
- CPU: amd64, arm64, s390x, Source Bundle at [Raspberry Pi](../Platforms/FOSS/HW/RaspberryPi/Raspberry-Pi.md)
- Windows On-Premise: [Offline](../Platforms/Propietary/OS/Windows/Offline.md)
- Mac: Docker, or at [Mac](../Platforms/Propietary/OS/Mac)
- Newest at platforms: Source Bundle, Snap Candidate, Docker, Kubernetes https://wekan.fi
- Platforms that will be updated to be up-to-date: Snap Stable, Sandstorm, UCS https://wekan.fi
+3 -3
View File
@@ -19,9 +19,9 @@
- On-Premise:
- Linux amd64/arm64/s390x
- https://wekan.fi/install/
- [Raspberry Pi](../Platforms/FOSS/RaspberryPi/Raspberry-Pi.md)
- Windows [Offline](../Platforms/Propietary/Windows/Offline.md)
- Mac [Mac](../Platforms/Propietary/Mac/Mac.md)
- [Raspberry Pi](../Platforms/FOSS/HW/RaspberryPi/Raspberry-Pi.md)
- Windows [Offline](../Platforms/Propietary/OS/Windows/Offline.md)
- Mac [Mac](../Platforms/Propietary/OS/Mac)
- Not like other software:
- But note that design of all software changes often, when they are in active development.
- Not bad parts of Trello:
+3 -3
View File
@@ -2,7 +2,7 @@
Today, hosting *n* customers means running *n* WeKan servers: *n* Node.js
processes, *n* `ROOT_URL`s, *n* databases, *n* upgrades. That is what
[`docs/Platforms/FOSS/Docker/Meteor3/`](../../Platforms/FOSS/Docker/Meteor3/README.md)
[`docs/Platforms/FOSS/Container/Docker/Meteor3/`](../../Platforms/FOSS/Container/Docker/Meteor3)
sets up and it works.
This page designs the **alternatives**: what it would take for **one** WeKan
@@ -23,8 +23,8 @@ Everything the question touches. Paths are from the repository root.
| File Path | File Type | Description |
| --- | --- | --- |
| `docs/Platforms/FOSS/Docker/Meteor3/README.md` | `.md` guide | The shipped topology: Caddy in front, one WeKan container per customer, one MongoDB, one database per customer. |
| `docs/Platforms/FOSS/Docker/Meteor3/multitenancy.md` | `.md` guide | The two supported transports for that topology, and why each instance in one network namespace needs its own internal `uws.port`. |
| `docs/Platforms/FOSS/Container/Docker/Meteor3` | `.md` guide | The shipped topology: Caddy in front, one WeKan container per customer, one MongoDB, one database per customer. |
| `docs/Platforms/FOSS/Container/Docker/Meteor3/multitenancy.md` | `.md` guide | The two supported transports for that topology, and why each instance in one network namespace needs its own internal `uws.port`. |
| `docker-compose-multitenancy.yml` | `.yml` compose file | The working example: per-tenant `PORT`, `ROOT_URL`, `MONGO_URL` database and `uws.port`. |
| `models/lib/universalUrlGenerator.js` | `.js` module | Builds attachment/avatar URLs that do **not** depend on `ROOT_URL`. Already tenant-safe, and the model the rest of the code should follow. |
| `server/routes/universalFileServer.js` | `.js` route | Serves `/cdn/storage/…` for any host. Two `Meteor.absoluteUrl()` calls are the only `ROOT_URL` dependency left in it. |
@@ -249,7 +249,7 @@ https://github.com/wekan/php/blob/main/page/allboardschar.php
- Redbean amd64 binary works at Win/Mac/Linux/BSD/BIOS without any modifications, because it is based on Cosmopolitan https://github.com/jart/cosmopolitan
- Uses HTMX https://htmx.org at UI
- Saves to SQLite database
- Petclinic fork, using Blink to run at s390x [s390x](../../Platforms/FOSS/s390x.md#petclinic-s390x)
- Petclinic fork, using Blink to run at s390x [s390x](../../Platforms/FOSS/HW/s390x.md#petclinic-s390x)
### PHP
@@ -290,7 +290,7 @@ https://github.com/wekan/php/blob/main/page/allboardschar.php
- Deno also includes Node.js as Deno's Node.js compatibility layer.
- Node.js supports many CPU/OS
- Node.js is used in production and has traceability. https://changelog.com/jsparty/294
- [s390x](../../Platforms/FOSS/s390x.md)
- [s390x](../../Platforms/FOSS/HW/s390x.md)
- https://nodejs.org/dist/latest-v20.x/
- https://github.com/wekan/node-v14-esm/releases/tag/v14.21.4
@@ -43,7 +43,7 @@ Price | Free and Open Source, [MIT license](../../LICENSE). Free for Commercial
Whitelabeling | Yes. Admin Panel/Layout: Hide Logo, Custom Product Name. | No | $ Yes
Theming | [Yes](../Theme/Custom-CSS-themes.md) | No | $ Yes
Redistributing | Yes | No | $ Yes
Hosting | [Self-host or SaaS provider](../Platforms/FOSS/Platforms.md) | SaaS | Self-host
Hosting | [Self-host or SaaS provider](../Platforms) | SaaS | Self-host
## Basic features: Board
@@ -280,7 +280,7 @@ Support Desk | No | No | $ Yes
Card Template App | Copy Checklist Template to Multiple Cards | Yes | $ Yes
Slack | [Yes](../Webhooks/Discord/Outgoing-Webhook-to-Discord.md) | Yes | $ Yes
Amazon Echo | No | No | $ Yes
Collaborate/TogetherJS | [Not yet](../Platforms/FOSS/Friend/Friend.md) | No | Yes
Collaborate/TogetherJS | [Not yet](../Platforms/FOSS/Container/Friend) | No | Yes
Gmail Add-on | No | Yes | Yes
Hangouts Chat bot | No | Yes | $ Yes
Print board | No | No | $ Yes
@@ -296,7 +296,7 @@ SEO Checklist | No | No | $ Yes
Features | Wekan | Trello | Restyaboard
------------ | ------------- | ------------- | -------------
iOS Mobile App | [Not yet](../Platforms/FOSS/Friend/Friend.md). Mobile Chrome browser works. | Yes | Yes
iOS Mobile App | [Not yet](../Platforms/FOSS/Container/Friend). Mobile Chrome browser works. | Yes | Yes
Android Mobile App | [Yes](../Browsers/Browser-compatibility-matrix.md) | Yes | Yes
Windows Microsoft Store App | [Yes](../Browsers/Browser-compatibility-matrix.md) | ? | ?
Ubuntu Touch OpenStore App | [Yes](../Browsers/Browser-compatibility-matrix.md) | ? | ?
+1 -1
View File
@@ -76,7 +76,7 @@ meteor run --exclude-archs web.browser.legacy,web.cordova --port 4000 --extra-pa
## Scaling to thousands of users
[Production setup at AWS](../Platforms/Propietary/Cloud/AWS.md)
[Production setup at AWS](../Platforms/Propietary/Cloud/AWS)
## Current versions of dependencies
@@ -43,7 +43,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](../Platforms/Propietary/Mac/Mac.md). Sametime maybe on [Windows](../Platforms/Propietary/Windows/Windows.md) 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](../Platforms/Propietary/OS/Mac). Sametime maybe on [Windows](../Platforms/Propietary/OS/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](../../.meteor/release) in use, other versions mentioned at [Dockerfile](../../Dockerfile)
+9 -9
View File
@@ -93,22 +93,22 @@ Files in this directory are served by meteor as-is to the client. It hosts some
* **[authentication.js](../../server/authentication.js)** add the `Authentication`object to Meteor that provides methods for checking access rights.
* **[lib/utils.js](../../server/lib/utils.js)** defines some checks used by [checklists.js](../../models/checklists.js)** model. <span style="color:red">*XXX: these methods are defined in server-only code by are used in models, which are visible by the client (in Checklists.allow)?*</span>
* **[notifications](../../server/notifications)**
* **[notifications.js](../../server/notifications/notifications.js)**: defines the `Notifications` object that supports [Activities](models/activities.js) and holds a list of functions to call when its `notify()` method is called along with convenience methods to subscribe, unsubscribe and a way to filter recipients according to user settings for notification;
* **[notifications.js](../../server/notifications/notifications.js)**: defines the `Notifications` object that supports [Activities](../../models/activities.js) and holds a list of functions to call when its `notify()` method is called along with convenience methods to subscribe, unsubscribe and a way to filter recipients according to user settings for notification;
* **[email.js](../../server/notifications/email.js)**: makes use of the notification system to send an email to a user;
* **[profile.js](../../server/notifications/profile.js)**: *stub*; will allow associating notifications with user ids to be consumed by mobile apps;
* **[notifications.js](../../server/notifications/notifications.js)**: adds the `watch()` Meteor server-only [method](https://guide.meteor.com/methods.html) that may watch boards, lists or cards using [models/watchable.js](../../models/watchable.js);
* **[outgoing.js](../../server/notifications/outgoing.js)**: adds the `outgoingWebhooks()` Meteor server-only [method](https://guide.meteor.com/methods.html) that can call external API <span style="color:red">*XXX: I guess*</span>
* **[publications](../../server/publications)** defines sets of records that are [published](https://docs.meteor.com/api/pubsub.html#Meteor-publish) by the server and how clients can subscribe to those:
* **[accountSettings.js](../../server/publications/accountSettings.js)**: [AccountSettings](models/accountSettings.js) collection;
* **[activities.js](../../server/publications/activities.js)**: [Activities](models/activities.js) collection filtered and paginated;
* **[announcements.js](../../server/publications/announcements.js)**: [Announcements](models/announcements.js) collection;
* **[avatars.js](../../server/publications/avatars.js)**: [Avatars](models/avatars.js) collection for current user;
* **[boards.js](../../server/publications/boards.js)**: [Boards](models/boards.js) collection for current user, archived boards collection and individual board as a [relation](https://atmospherejs.com/cottz/publish-relations);
* **[accountSettings.js](../../server/publications/accountSettings.js)**: [AccountSettings](../../models/accountSettings.js) collection;
* **[activities.js](../../server/publications/activities.js)**: [Activities](../../models/activities.js) collection filtered and paginated;
* **[announcements.js](../../server/publications/announcements.js)**: [Announcements](../../models/announcements.js) collection;
* **[avatars.js](../../server/publications/avatars.js)**: [Avatars](../../models/avatars.js) collection for current user;
* **[boards.js](../../server/publications/boards.js)**: [Boards](../../models/boards.js) collection for current user, archived boards collection and individual board as a [relation](https://atmospherejs.com/cottz/publish-relations);
* **[cards.js](../../server/publications/cards.js)**: a [Card](../../models/cards.js) by its id;
* **[fast-render.js](https://github.com/wekan/wekan/tree/main/server/publications/fast-render.js)**: configures [FastRender](https://github.com/kadirahq/fast-render) to use the board data; <span style="color:red">*XXX: FastRender docs say "Make sure you're using Meteor.subscribe and not this.subscribe"*</span>
* **[people.js](../../server/publications/people.js)**: [Users](models/users.js) collection;
* **[settings.js](../../server/publications/settings.js)**: [Settings](models/settings.js) collection and, separately, the mail server;
* **[unsavedEdits.js](../../server/publications/unsavedEdits.js)**: [UnsavedEdits](models/unsavedEdits.js) collection;
* **[people.js](../../server/publications/people.js)**: [Users](../../models/users.js) collection;
* **[settings.js](../../server/publications/settings.js)**: [Settings](../../models/settings.js) collection and, separately, the mail server;
* **[unsavedEdits.js](../../server/publications/unsavedEdits.js)**: [UnsavedEdits](../../models/unsavedEdits.js) collection;
* **[users.js](../../server/publications/users.js)**: provides a "mini-profile" for individual users and a [way](https://docs.meteor.com/api/collections.html#fieldspecifiers) to check if current user is admin.
# Models
+2 -2
View File
@@ -1,5 +1,5 @@
- Read [Wekan new release ChangeLog](../../CHANGELOG.md)
- [Install Meteor.js](https://www.meteor.com/install). Note: Windows install is very slow, please use other option at [Windows wiki page](../Platforms/Propietary/Windows/Windows.md)
- [Install Meteor.js](https://www.meteor.com/install). Note: Windows install is very slow, please use other option at [Windows wiki page](../Platforms/Propietary/OS/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](../Platforms/FOSS/Source/Source.md)
[Build Meteor bundle from source](../Platforms/FOSS/Source)
[Install from source without root](../Platforms/FOSS/Source/Install-from-source-without-root.md)
+1 -1
View File
@@ -137,7 +137,7 @@ docker-compose up -d --build
1) Install local development version of Sandstorm to your laptop from https://sandstorm.io/install
2) Download and install experimental version to your local Sandstorm:
[Sandstorm](../Platforms/FOSS/Sandstorm/Sandstorm.md)
[Sandstorm](../Platforms/FOSS/Container/Sandstorm)
Local sandstorm is at http://local.sandstorm.io:6080/ .
3) Download your production Wekan grain .zip file with down arrow button. Upload to your dev local Sandstorm.
File renamed without changes.

Before

Width:  |  Height:  |  Size: 259 KiB

After

Width:  |  Height:  |  Size: 259 KiB

+2 -2
View File
@@ -526,7 +526,7 @@ They are moved here from https://github.com/wekan/wekan/issues/961
Sample:
### Wekan with TLS/SSL
To run Wekan secured with TLS/SSL do the following steps:
1. Setup a Web-Server/-Proxy with TLS/SSL support that maps requests to wekan. [Link](url)
1. Setup a Web-Server/-Proxy with TLS/SSL support that maps requests to wekan.
2. Set protocol to http**s**.
`export ROOT_URL='https://example.com/'`
3. Set Wekan to an internal port.
@@ -535,7 +535,7 @@ To run Wekan secured with TLS/SSL do the following steps:
### Wekan at subpath
To run Wekan to appear at a subpath of your domain:
1. Setup a Web-Server/-Proxy that maps requests to wekan. [Link](url)
1. Setup a Web-Server/-Proxy that maps requests to wekan.
2. Append subpath to domain, without trailing slash.
`export ROOT_URL='http://example.com/mywekan'`
3. Set Wekan to an internal port.
+4 -4
View File
@@ -19,7 +19,7 @@ that by providing one-click installation on various platforms.
- Wekan largest user has 30k users using Wekan in their company.
- Wekan has been [translated](https://app.transifex.com/wekan/) to about 70+ languages.
- [Features](../Features/Features.md): Wekan has real-time user interface.
- [Platforms](../Platforms/FOSS/Platforms.md): Wekan supports many platforms.
- [Platforms](../Platforms): Wekan supports many platforms.
Wekan is critical part of new platforms Wekan is currently being integrated to.
- [Integrations](../ImportExport/Integrations.md): Current possible integrations and future plans.
@@ -41,8 +41,8 @@ It's a very specific niche, with limited amount competitors, with all of this ap
## Requirements
- 64bit: Linux [Snap](https://github.com/wekan/wekan-snap/wiki/Install) or [Sandstorm](https://sandstorm.io) /
[Mac](../Platforms/Propietary/Mac/Mac.md) / [Windows](../Platforms/Propietary/Windows/Install-Wekan-from-source-on-Windows.md).
[More Platforms](../Platforms/FOSS/Platforms.md). [ARM progress](https://github.com/wekan/wekan/issues/1053#issuecomment-410919264).
[Mac](../Platforms/Propietary/OS/Mac) / [Windows](../Platforms/Propietary/OS/Windows/Install-Wekan-from-source-on-Windows.md).
[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](../../docker-compose.yml): 3 frontend servers,
each having 2 CPU and 2 wekan-app containers. One backend wekan-db server with many CPUs.
@@ -119,7 +119,7 @@ Usually:
* Slowest: Once a month.
* One release contains anything from one typo fix to many major features and bugfixes.
For [Wekan Platforms](../Platforms/FOSS/Platforms.md), 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
+1 -1
View File
@@ -38,7 +38,7 @@ Maxime Quandalle, original author of Wekan
* [EthKan](https://github.com/EthKan)
* [Friend](../Platforms/FOSS/Friend/Friend.md)
* [Friend](../Platforms/FOSS/Container/Friend)
# In Spanish
@@ -80,7 +80,7 @@ files. The pane, its menu entry, its helpers and its handler are commented out i
The grain migration itself is unchanged: it runs in `sandstorm-src/start.js` before
the app boots — see
[Sandstorm migration](../../../Platforms/FOSS/Sandstorm/Meteor3/Migration.md).
[Sandstorm migration](../../../Platforms/FOSS/Container/Sandstorm/Meteor3/Migration.md).
## Related
+1 -1
View File
@@ -11,5 +11,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)
- [Sandstorm CSV related Python code](../../Platforms/FOSS/Sandstorm/Wekan-Sandstorm-cards-to-CSV-using-Python.md)
- [Sandstorm CSV related Python code](../../Platforms/FOSS/Container/Sandstorm/Wekan-Sandstorm-cards-to-CSV-using-Python.md)
- [Trello API test code](../../ImportExport/trello)
+1 -1
View File
@@ -107,5 +107,5 @@ are now implemented (see the topic pages above).
## More
- [Platforms](../Platforms/FOSS/Platforms.md)
- [Platforms](../Platforms)
- [Integrations](../ImportExport/Integrations.md)
+1 -1
View File
@@ -18,4 +18,4 @@ Previous GPLv2 WeKan Gantt is deprecated https://github.com/wekan/wekan-gantt-gp
# UCS
[Gantt feature at UCS](../../Platforms/FOSS/UCS/UCS.md#gantt)
[Gantt feature at UCS](../../Platforms/FOSS/Container/UCS#gantt)
@@ -20,7 +20,7 @@
margin-top: 10px;
}
</style>
<script defer src="pretty-json-custom-element.js"></script>
<!-- <script defer src="pretty-json-custom-elements-js.txt"></script> -->
</head>
<body>
<h1>JSON Viewer</h1>
+3 -3
View File
@@ -1,6 +1,6 @@
### Install for example from:
- [Snap](../../Platforms/FOSS/Snap/Snap.md)
- [Docker](../../Platforms/FOSS/Docker/Docker.md)
- [Snap](../../Platforms/FOSS/Container/Snap)
- [Docker](../../Platforms/FOSS/Container/Docker)
*Make sure you are running at least **v2.21***
@@ -177,4 +177,4 @@ You may also find it useful to look at the following configuration information:
https://login.microsoftonline.com/**the-tenant-name-for-your-organization**/v2.0/.well-known/openid-configuration
Some Azure links also at wiki page about moving from Sandstorm to Docker/Snap , and using Docker Swarm:
- [Export from Wekan Sandstorm grain ](../../Platforms/FOSS/Sandstorm/Export-from-Wekan-Sandstorm-grain-.zip-file.md).zip-file#azure-links
- [Export from Wekan Sandstorm grain ](../../Platforms/FOSS/Container/Sandstorm/Export-from-Wekan-Sandstorm-grain-.zip-file.md).zip-file#azure-links
+2 -2
View File
@@ -17,7 +17,7 @@ sudo snap set wekan password-login-enabled='false'
## Windows On-Premise
[Offline](../Platforms/Propietary/Windows/Offline.md)
[Offline](../Platforms/Propietary/OS/Windows/Offline.md)
```
SET PASSWORD_LOGIN_ENABLED=false
```
@@ -25,7 +25,7 @@ SET PASSWORD_LOGIN_ENABLED=false
## Linux On-Premise
[Raspberry Pi](../Platforms/FOSS/RaspberryPi/Raspberry-Pi.md)
[Raspberry Pi](../Platforms/FOSS/HW/RaspberryPi/Raspberry-Pi.md)
```
export PASSWORD_LOGIN_ENABLED=false
```
+1 -1
View File
@@ -136,7 +136,7 @@ exit
More info:
- [Backup](../Backup/Backup.md)
- [Docker](../Platforms/FOSS/Docker/Docker.md)
- [Docker](../Platforms/FOSS/Container/Docker)
***
+1 -1
View File
@@ -224,7 +224,7 @@ services:
wekandb:
# All Wekan data is stored in MongoDB. For backup and restore, see:
# [Export Docker Mongo Data](../Platforms/FOSS/Docker/Export-Docker-Mongo-Data.md)
# [Export Docker Mongo Data](../Platforms/FOSS/Container/Docker/Export-Docker-Mongo-Data.md)
image: mongo:4.0.3
container_name: wekan-db
restart: always
+1 -1
View File
@@ -1,6 +1,6 @@
Tested on Ubuntu 16.04 based distro.
Wekan installed with [Export Docker Mongo Data](../Platforms/FOSS/Docker/Export-Docker-Mongo-Data.md)
Wekan installed with [Export Docker Mongo Data](../Platforms/FOSS/Container/Docker/Export-Docker-Mongo-Data.md)
## A) Let's Encrypt support, without Google Auth:
+1 -1
View File
@@ -5,7 +5,7 @@ Related Meteor SAML code, not in WeKan yet:
Sandstorm has SAML login, and old WeKan that will be updated someday:
- [Sandstorm](../Platforms/FOSS/Sandstorm/Sandstorm.md)
- [Sandstorm](../Platforms/FOSS/Container/Sandstorm)
How SAML works:
File renamed without changes.
File renamed without changes.
@@ -1,4 +1,4 @@
# Different wiki page: [Production setup for thousands of users at AWS](../../Propietary/Cloud/AWS.md)
# Different wiki page: [Production setup for thousands of users at AWS](../../../Propietary/Cloud/AWS)
***
@@ -22,13 +22,13 @@ https://github.com/wekan/wekan-mongodb
## 3. Email
[Troubleshooting Email](../../../Email/Troubleshooting-Mail.md)
[Troubleshooting Email](../../../../Email/Troubleshooting-Mail.md)
## 4. Configure webserver as a front-end proxy
* [Caddy](../../../Webserver/Caddy.md)
* [Nginx](../../../Webserver/Nginx.md)
* [Apache](../../../Webserver/Apache.md)
* [Caddy](../../../../Webserver/Caddy.md)
* [Nginx](../../../../Webserver/Nginx.md)
* [Apache](../../../../Webserver/Apache.md)
## 5. Launch Wekan
@@ -1,6 +1,6 @@
More complete Docker info at:
* [Docker](Docker.md)
* [Docker](README.md)
Tested to work on AWS cloud:
@@ -29,7 +29,7 @@ This will speed up loading attachments a lot.
Note: Only `Oplog sockjs` works with multitenancy, see [multitenancy.md](multitenancy.md).
For the alternatives to running one Node.js server per tenant — one server for
many `ROOT_URL`s, and what each option costs — see
[Multitenancy design](../../../../Design/Multitenancy/Multitenancy.md).
[Multitenancy design](../../../../../Design/Multitenancy/Multitenancy.md).
Migrating from Parallel Snap setup, because `snap set wekan root-url=...`
etc commands are slow to run, and did not get Parallel Snap working properly yet.
File renamed without changes.

Before

Width:  |  Height:  |  Size: 78 KiB

After

Width:  |  Height:  |  Size: 78 KiB

File renamed without changes.

Before

Width:  |  Height:  |  Size: 171 KiB

After

Width:  |  Height:  |  Size: 171 KiB

@@ -13,7 +13,7 @@ its own administrators, and can be backed up and restored on its own. It is enab
with `MULTITENANCY=true` (and `MULTITENANCY_TRUST_PROXY_HOST=true` when a trusted
proxy sets `X-Forwarded-Host`). What it isolates — and what it deliberately does not,
which is why the per-process topology below stays supported — is
[Multitenancy design](../../../../Design/Multitenancy/Multitenancy.md), option D.
[Multitenancy design](../../../../../Design/Multitenancy/Multitenancy.md), option D.
## a) Recommended — one host, many WeKan domains, `uws` + `changeStreams`
@@ -36,7 +36,7 @@ internal WebSocket proxy server on a dedicated TCP port (default
The internal listen socket is opened exclusively, so each instance
in the same kernel netns must declare its own internal port.
Working example: see [`docker-compose-multitenancy.yml`](../../../../../docker-compose-multitenancy.yml)
Working example: see [`docker-compose-multitenancy.yml`](../../../../../../docker-compose-multitenancy.yml)
in the repository root.
Sketch of the per-tenant environment block:
@@ -25,7 +25,7 @@ For building custom image, and then running it, uncomment these lines,
that are currently here, but line numbers could change, if that docker-compose.yml
is later modified:
[docker-compose.yml](../../../../docker-compose.yml#L144-L146)
[docker-compose.yml](../../../../../docker-compose.yml#L144-L146)
After your above modifications, text should look like this:
@@ -39,7 +39,7 @@ After your above modifications, text should look like this:
#-------------------------------------------------------------------------------------
```
Then modify ROOT_URL, etc settings as needed, see [Settings](../../../Webserver/Settings.md)
Then modify ROOT_URL, etc settings as needed, see [Settings](../../../../Webserver/Settings.md)
Start WeKan with custom built Dockerfile with this command:
```
@@ -70,7 +70,7 @@ Then start WeKan with:
docker compose up -d
```
SSL/TLS info at [Settings](../../../Webserver/Settings.md)
SSL/TLS info at [Settings](../../../../Webserver/Settings.md)
## Please only use Docker release tags
@@ -97,7 +97,7 @@ If you like to build from source, clone Wekan repo:
```
git clone https://github.com/wekan/wekan
```
Then edit docker-compose.yml with [these lines uncommented](../../../../docker-compose.yml#L132-L142) this way:
Then edit docker-compose.yml with [these lines uncommented](../../../../../docker-compose.yml#L132-L142) this way:
```
#-------------------------------------------------------------------------------------
# ==== BUILD wekan-app DOCKER CONTAINER FROM SOURCE, if you uncomment these ====
@@ -203,7 +203,7 @@ TODO: [Docker Compose: Wekan <=> MongoDB <=> ToroDB => MySQL read-only mirroring
## OpenShift
[OpenShift](../OpenShift/OpenShift.md)
[OpenShift](../../Cloud/OpenShift/OpenShift.md)
## SLES
@@ -219,7 +219,7 @@ TODO: [Docker Compose: Wekan <=> MongoDB <=> ToroDB => MySQL read-only mirroring
## Production
[Production setup for thousands of users with Docker at AWS](../../Propietary/Cloud/AWS.md)
[Production setup for thousands of users with Docker at AWS](../../../Propietary/Cloud/AWS)
[Other way to do production](Install-Wekan-Docker-in-production.md)
@@ -230,7 +230,7 @@ TODO: [Docker Compose: Wekan <=> MongoDB <=> ToroDB => MySQL read-only mirroring
## Admin Panel
First registered Wekan user will get Admin Panel on new Docker and source based
installs. You can also [enable Admin Panel manually](../../../../CHANGELOG.md#v0111-rc2-2017-03-05-wekan-prerelease)
installs. You can also [enable Admin Panel manually](../../../../../CHANGELOG.md#v0111-rc2-2017-03-05-wekan-prerelease)
## Docker Hub - sometimes broken
@@ -292,6 +292,6 @@ sudo docker compose up -d --build
## Webserver Config
* [Caddy Webserver Config](../../../Webserver/Caddy.md)
* [Nginx Webserver Config](../../../Webserver/Nginx.md)
* [Apache Webserver Config](../../../Webserver/Apache.md)
* [Caddy Webserver Config](../../../../Webserver/Caddy.md)
* [Nginx Webserver Config](../../../../Webserver/Nginx.md)
* [Apache Webserver Config](../../../../Webserver/Apache.md)
@@ -1,6 +1,6 @@
## 1) Create Backups first
[Backup](../../../Backup/Backup.md)
[Backup](../../../../Backup/Backup.md)
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](../../../Backup/Repair-MongoDB.md)
a) [Repair MongoDB](../../../../Backup/Repair-MongoDB.md)
b) [Using Meteor MongoDB to repair files](../Sandstorm/Export-from-Wekan-Sandstorm-grain-.zip-file.md)
## 6) Trying to upgrade Wekan?
### 1) [Backup](../../../Backup/Backup.md)
### 1) [Backup](../../../../Backup/Backup.md)
### 2a) Nice way:
```
@@ -73,4 +73,4 @@ Start Wekan
```
docker-compose up -d
```
[Restore](../../../Backup/Backup.md)
[Restore](../../../../Backup/Backup.md)
File renamed without changes.

Before

Width:  |  Height:  |  Size: 11 KiB

After

Width:  |  Height:  |  Size: 11 KiB

File renamed without changes.

Before

Width:  |  Height:  |  Size: 117 KiB

After

Width:  |  Height:  |  Size: 117 KiB

File renamed without changes.

Before

Width:  |  Height:  |  Size: 223 KiB

After

Width:  |  Height:  |  Size: 223 KiB

File renamed without changes.

Before

Width:  |  Height:  |  Size: 591 KiB

After

Width:  |  Height:  |  Size: 591 KiB

File renamed without changes.

Before

Width:  |  Height:  |  Size: 75 KiB

After

Width:  |  Height:  |  Size: 75 KiB

File renamed without changes.

Before

Width:  |  Height:  |  Size: 136 KiB

After

Width:  |  Height:  |  Size: 136 KiB

File renamed without changes.

Before

Width:  |  Height:  |  Size: 159 KiB

After

Width:  |  Height:  |  Size: 159 KiB

@@ -15,7 +15,7 @@ Kin 2.0 Meta OS:
WeKan:
- integration to Friend TODO list https://github.com/FriendUPCloud/friendup/issues/114
- timezone [Timezone](../../../Date/Timezone.md)
- timezone [Timezone](../../../../Date/Timezone.md)
Friend Desktop Cloud OS:
- Secure encrypted skinnable fast Open Source desktop in webbrowser/mobile/desktop app
@@ -27,7 +27,7 @@ https://www.youtube.com/watch?v=SB4dNC7u2MU
## Roadmap
- It's possible to use Wekan with Friend. At 2019-06-30 Wekan also works at [Raspberry Pi](../RaspberryPi/Raspberry-Pi.md) like Friend already works, it makes possible local RasPi-only network.
- It's possible to use Wekan with Friend. At 2019-06-30 Wekan also works at [Raspberry Pi](../../HW/RaspberryPi/Raspberry-Pi.md) like Friend already works, it makes possible local RasPi-only network.
- Then on local network you can use RasPi Cromium or Friend mobile/tablet Android/iOS app to connect to local network Friend desktop, also possible without connection to Internet.
- If using RasPi4 with 4 GB RAM or more, it's possible to run Wekan+Friend+Desktop etc on same RasPi4, servers+client webbrowser.
- Alternative to RasPi is Orange Pi 5 that can have 16 GB RAM http://www.orangepi.org/html/hardWare/computerAndMicrocontrollers/details/Orange-Pi-5-plus.html
@@ -161,7 +161,7 @@ ln -s ~/repos/mysupermodule mysupermodule
sudo apt-get -y install snapd
sudo snap install wekan --channel=latest/candidate
```
### 13. [ROOT_URL settings](../../../Webserver/Settings.md) to your server IP address
### 13. [ROOT_URL settings](../../../../Webserver/Settings.md) to your server IP address
```
sudo snap set wekan root-url='http://192.168.0.100:5000'
sudo snap set wekan port='5000'
@@ -204,7 +204,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](Friend.md).
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](README.md).
# Adding app icons to Friend desktop menus
File renamed without changes.

Before

Width:  |  Height:  |  Size: 177 KiB

After

Width:  |  Height:  |  Size: 177 KiB

File renamed without changes.

Before

Width:  |  Height:  |  Size: 1.1 MiB

After

Width:  |  Height:  |  Size: 1.1 MiB

Loaded 100 of 213 files, more files were not shown because too many files have changed in this diff. Show more