mirror of
https://github.com/wekan/wekan.git
synced 2025-12-16 07:20:12 +01:00
Fix links from devel to master branch.
parent
057df76b30
commit
eca0b89677
22 changed files with 30 additions and 30 deletions
10
Debugging.md
10
Debugging.md
|
|
@ -32,7 +32,7 @@
|
|||
|
||||
1) Increase ulimit system wide to 100 000 in systemd config.
|
||||
|
||||
2) Wekan Javascript code has [increaded fiber poolsize](https://github.com/wekan/wekan/blob/devel/server/authentication.js#L5-L9).
|
||||
2) Wekan Javascript code has [increaded fiber poolsize](https://github.com/wekan/wekan/blob/master/server/authentication.js#L5-L9).
|
||||
|
||||
3) There is [on-going 100% CPU usage Meteor issue](https://github.com/meteor/meteor/issues/9796#issuecomment-400079380) and hopefully [fixes to Node.js will land in Node v8.12](https://github.com/nodejs/node/pull/21593#issuecomment-403636667) sometime. Node 8.12 is now released and official version included at Wekan.
|
||||
|
||||
|
|
@ -42,13 +42,13 @@
|
|||
|
||||
## Current versions of dependencies
|
||||
|
||||
[Dockerfile](https://github.com/wekan/wekan/blob/devel/Dockerfile), versions of Meteor.js, Node etc listed at beginning.
|
||||
[Dockerfile](https://github.com/wekan/wekan/blob/master/Dockerfile), versions of Meteor.js, Node etc listed at beginning.
|
||||
|
||||
[Included Meteor packages](https://github.com/wekan/wekan/blob/devel/.meteor/packages)
|
||||
[Included Meteor packages](https://github.com/wekan/wekan/blob/master/.meteor/packages)
|
||||
|
||||
[Included Meteor package versions](https://github.com/wekan/wekan/blob/devel/.meteor/versions)
|
||||
[Included Meteor package versions](https://github.com/wekan/wekan/blob/master/.meteor/versions)
|
||||
|
||||
[Added packages at package.json](https://github.com/wekan/wekan/blob/devel/package.json)
|
||||
[Added packages at package.json](https://github.com/wekan/wekan/blob/master/package.json)
|
||||
|
||||
## Build from source
|
||||
|
||||
|
|
|
|||
|
|
@ -20,14 +20,14 @@ When you run this, you see .jade template files where is search input box, and .
|
|||
- Currently Wekan development is done mainly at Ubuntu 16.04 64bit, but building Wekan does work on any Debian 9 64bit or Ubuntu 14.04 64bit or newer.
|
||||
- Install [Wekan from source](https://github.com/wekan/wekan) with rebuild-wekan.sh script, with options 1 to install dependencies and 2 to rebuild source, to your Linux computer (Debian 9 or Ubuntu 14.04 or newer), or try installing it via the [[virtual appliance|virtual-appliance]]
|
||||
- You can use for example [Visual Studio Code](https://code.visualstudio.com/) for editing code, it has Meteor.js etc plugins
|
||||
- When changing database schema, [migrations can be used](https://github.com/wekan/wekan/blob/devel/server/migrations.js).
|
||||
- When changing database schema, [migrations can be used](https://github.com/wekan/wekan/blob/master/server/migrations.js).
|
||||
- [Excellent example how pull requests are improved and integrated, and not needed commits removed](https://github.com/wekan/wekan/pull/1470)
|
||||
- Ask questions at [![Wekan chat][vanila_badge]][vanila_chat]
|
||||
- We used to be at ~~[Rocket.Chat][rocket_chat]~~ but that's been discontinued.
|
||||
- You can ask anything, we are here to help. But also consult the sources that are already available.
|
||||
- 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/devel/.meteor/release) in use, other versions mentioned at [Dockerfile](https://github.com/wekan/wekan/blob/devel/Dockerfile)
|
||||
- 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)
|
||||
- Docker up-to-date way: You can clone wekan/wekan repo and update docker-compose.yml file ROOT_URL etc as documented at https://github.com/wekan/wekan-mongodb commented docker-compose.yml file, install docker, and build from source with docker with "docker-compose up -d --build"
|
||||
- Docker not up-to-date way: [Docker environment for Wekan development](https://github.com/wekan/wekan-dev).
|
||||
|
||||
|
|
|
|||
|
|
@ -88,7 +88,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](https://github.com/wekan/wekan/blob/devel/CHANGELOG.md#v0111-rc2-2017-03-05-wekan-prerelease)
|
||||
installs. You can also [enable Admin Panel manually](https://github.com/wekan/wekan/blob/master/CHANGELOG.md#v0111-rc2-2017-03-05-wekan-prerelease)
|
||||
|
||||
## Docker Hub - sometimes broken
|
||||
|
||||
|
|
|
|||
4
FAQ.md
4
FAQ.md
|
|
@ -29,14 +29,14 @@ that by providing one-click installation on various platforms.
|
|||
[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).
|
||||
- 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/devel/docker-compose.yml): 3 frontend servers,
|
||||
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.
|
||||
- Enough disk space and alerts about low disk space. If you run out disk space, MongoDB database gets corrupted.
|
||||
- SECURITY: Updating to newest Wekan version very often. Please check you do not have automatic updates of Sandstorm or Snap turned off.
|
||||
Old versions have security issues because of old versions Node.js etc. Only newest Wekan is supported.
|
||||
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/devel/CHANGELOG.md).
|
||||
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.
|
||||
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.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Current
|
||||
|
||||
Not all from [CHANGELOG](https://github.com/wekan/wekan/blob/devel/CHANGELOG.md) are added to here yet.
|
||||
Not all from [CHANGELOG](https://github.com/wekan/wekan/blob/master/CHANGELOG.md) are added to here yet.
|
||||
|
||||
## Kanban
|
||||
|
||||
|
|
@ -105,7 +105,7 @@ Tip: Normally you archive a card so you can restore it back. If you want to dele
|
|||
|
||||
NOTE: There is user admin as "People" in Admin Panel, but no screenshot here yet.
|
||||
|
||||
* Source and Docker platforms: [Admin Panel](https://github.com/wekan/wekan/blob/devel/CHANGELOG.md#v0111-rc2-2017-03-05-wekan-prerelease): Self-registration, or change to invite-only and inviting users to boards. SMTP Settings.
|
||||
* Source and Docker platforms: [Admin Panel](https://github.com/wekan/wekan/blob/master/CHANGELOG.md#v0111-rc2-2017-03-05-wekan-prerelease): Self-registration, or change to invite-only and inviting users to boards. SMTP Settings.
|
||||
|
||||

|
||||
|
||||
|
|
@ -184,7 +184,7 @@ ElasticSearch / Kibana (ELK)](https://github.com/wekan/wekan-logstash)
|
|||
|
||||
# Already merged, will be at next version
|
||||
|
||||
* [Changelog](https://github.com/wekan/wekan/blob/devel/CHANGELOG.md)
|
||||
* [Changelog](https://github.com/wekan/wekan/blob/master/CHANGELOG.md)
|
||||
|
||||
# Wishes for pull requests
|
||||
|
||||
|
|
|
|||
|
|
@ -252,7 +252,7 @@ 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)
|
||||
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/devel/CHANGELOG.md#v295-2019-07-01-wekan-release).
|
||||
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).
|
||||
|
||||
***
|
||||
### Q: Board cleanup?
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ Anyone: If you get this working, edit this wiki and add remaining to be installe
|
|||
- 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
|
||||
|
||||
## Related info
|
||||
- Node.js and npm version downloaded at [Dockerfile](https://github.com/wekan/wekan/blob/devel/Dockerfile)
|
||||
- Node.js and npm version downloaded at [Dockerfile](https://github.com/wekan/wekan/blob/master/Dockerfile)
|
||||
- https://gist.github.com/isaacs/579814
|
||||
- http://linuxbrew.sh
|
||||
|
||||
|
|
|
|||
|
|
@ -37,7 +37,7 @@ sudo systemctl status snap.wekan.wekan
|
|||
|
||||
## Docker
|
||||
|
||||
[docker-compose.yml](https://github.com/wekan/wekan/blob/devel/docker-compose.yml)
|
||||
[docker-compose.yml](https://github.com/wekan/wekan/blob/master/docker-compose.yml)
|
||||
```
|
||||
- DEBUG=true
|
||||
- OAUTH2_ENABLED=true
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
- Read [Wekan new release ChangeLog](https://github.com/wekan/wekan/blob/devel/CHANGELOG.md)
|
||||
- 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)
|
||||
- Download newest bundle from https://releases.wekan.team
|
||||
- Unarchive bundle .tar.gz file: `tar -zxvf wekan-VERSION.tar.gz`
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@ sed -i 's|FindThisText|ReplaceWithThisText|g' *
|
|||
|
||||
### Newest
|
||||
- Schema https://github.com/wekan/wekan/tree/devel/models
|
||||
- Migrations https://github.com/wekan/wekan/blob/devel/server/migrations.js
|
||||
- Migrations https://github.com/wekan/wekan/blob/master/server/migrations.js
|
||||
|
||||
## 5) Some migrations could be missing
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ Downloading and installing Wekan on various platforms.
|
|||
|
||||
## Related
|
||||
|
||||
* [Wekan new release ChangeLog](https://github.com/wekan/wekan/blob/devel/CHANGELOG.md)
|
||||
* [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)
|
||||
|
|
|
|||
|
|
@ -53,4 +53,4 @@ curl -H "Authorization: Bearer t7iYB86mXoLfP_XsMegxF41oKT7iiA9lDYiKVtXcctl" \
|
|||
|
||||
## In Wekan code
|
||||
|
||||
If you believe that code is the best documentation, be our guest: [models/cards.js](https://github.com/wekan/wekan/blob/devel/models/boards.js "Board API code")
|
||||
If you believe that code is the best documentation, be our guest: [models/cards.js](https://github.com/wekan/wekan/blob/master/models/boards.js "Board API code")
|
||||
|
|
@ -91,4 +91,4 @@ The card's ID is returned in the format:
|
|||
|
||||
# In Wekan code
|
||||
|
||||
If you believe that code is the best documentation, be our guest: [models/cards.js](https://github.com/wekan/wekan/blob/devel/models/cards.js "Card API code")
|
||||
If you believe that code is the best documentation, be our guest: [models/cards.js](https://github.com/wekan/wekan/blob/master/models/cards.js "Card API code")
|
||||
|
|
@ -51,4 +51,4 @@ The swimlane's ID is returned in the format:
|
|||
|
||||
# In Wekan code
|
||||
|
||||
If you believe that code is the best documentation, be our guest: [models/cards.js](https://github.com/wekan/wekan/blob/devel/models/swimlanes.js "Swimlane API code")
|
||||
If you believe that code is the best documentation, be our guest: [models/cards.js](https://github.com/wekan/wekan/blob/master/models/swimlanes.js "Swimlane API code")
|
||||
|
|
@ -332,4 +332,4 @@ curl -H "Authorization: Bearer t7iYB86mXoLfP_XsMegxF41oKT7iiA9lDYiKVtXcctl" \
|
|||
|
||||
# In Wekan code
|
||||
|
||||
If you believe that code is the best documentation, be our guest: [models/cards.js](https://github.com/wekan/wekan/blob/devel/models/users.js "User API code")
|
||||
If you believe that code is the best documentation, be our guest: [models/cards.js](https://github.com/wekan/wekan/blob/master/models/users.js "User API code")
|
||||
|
|
|
|||
|
|
@ -68,7 +68,7 @@ mongorestore --drop --noIndexRestore
|
|||
```
|
||||
And maybe [run as service](https://www.certdepot.net/rhel7-install-wekan/)
|
||||
|
||||
Or start at boot, by having [at bottom of /etc/rc.local](https://github.com/wekan/wekan/blob/devel/releases/virtualbox/etc-rc.local.txt).
|
||||
Or start at boot, by having [at bottom of /etc/rc.local](https://github.com/wekan/wekan/blob/master/releases/virtualbox/etc-rc.local.txt).
|
||||
|
||||
7) On other computer, with webbrowser go to http://192.168.0.12 (or other of your IP address you changed to start-wekan.sh)
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
Wekan works on x64. There is not yet version for [Raspberry Pi](https://github.com/wekan/wekan/issues/1053).
|
||||
|
||||
Wekan requires MongoDB 3.2.x . For other requirements and versions see [VirtualBox scripts](https://github.com/wekan/wekan-maintainer/tree/master/virtualbox) or [Dockerfile](https://github.com/wekan/wekan/blob/devel/Dockerfile).
|
||||
Wekan requires MongoDB 3.2.x . For other requirements and versions see [VirtualBox scripts](https://github.com/wekan/wekan-maintainer/tree/master/virtualbox) or [Dockerfile](https://github.com/wekan/wekan/blob/master/Dockerfile).
|
||||
|
||||
Known bugs with other versions:
|
||||
- Node 6.x: 100% CPU usage.
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ GitHub Username | Feature | Status | Sponsor
|
|||
[xet7](https://github.com/xet7) | [Calendar View](https://github.com/wekan/wekan/issues/808) | In Progress | [Bountysource](https://www.bountysource.com/issues/41780513-add-feature-calendar-view)
|
||||
[GhassenRjab](https://github.com/GhassenRjab) | [Search](https://github.com/wekan/wekan/issues/552) | In Progress | [Bountysource](https://www.bountysource.com/issues/32132712-feature-request-search-items) and nm11
|
||||
[Serubin](https://github.com/Serubin) | [Top-level projects](https://github.com/wekan/wekan/issues/641) | In Progress | [Bountysource](https://www.bountysource.com/issues/36035028-top-level-projects)
|
||||
[xet7](https://github.com/xet7), [thuanpq ](https://github.com/thuanpq) | [Teams/Organizations similar to Trello](https://github.com/wekan/wekan/issues/802) . Beginnings of user admin [already implemented](https://github.com/wekan/wekan/pull/1325) at [Wekan v0.55](https://github.com/wekan/wekan/blob/devel/CHANGELOG.md#v055-2017-11-19-wekan-release) | In Progress | [FUUG.fi](https://fuug.fi/2017/wekan-kanban-taulun-perustoimintojen-kehitys-alkuun/) and [Bountysource](https://www.bountysource.com/issues/41780380-add-feature-teams-organizations-similar-to-trello)
|
||||
[xet7](https://github.com/xet7), [thuanpq ](https://github.com/thuanpq) | [Teams/Organizations similar to Trello](https://github.com/wekan/wekan/issues/802) . Beginnings of user admin [already implemented](https://github.com/wekan/wekan/pull/1325) at [Wekan v0.55](https://github.com/wekan/wekan/blob/master/CHANGELOG.md#v055-2017-11-19-wekan-release) | In Progress | [FUUG.fi](https://fuug.fi/2017/wekan-kanban-taulun-perustoimintojen-kehitys-alkuun/) and [Bountysource](https://www.bountysource.com/issues/41780380-add-feature-teams-organizations-similar-to-trello)
|
||||
[andresmanelli](https://github.com/andresmanelli) | [Gogs issue/commit integration](https://github.com/wekan/wekan/issues/253) | [Part 1 in Wekan already](https://github.com/wekan/wekan/pull/1189) |
|
||||
[papoola](https://github.com/papoola) | [Custom Fields](https://github.com/wekan/wekan/issues/807) | In Progress |
|
||||
[mfshiu](https://github.com/mfshiu) | [Custom Fields, Moving card on mobile phone, Filter cards by keyword](https://github.com/wekan/wekan/issues/1022#issuecomment-337646110), Integrate Wekan with [RIOT](http://riot.im) so user can be notified immediately on cell phone when Wekan cards change | Works, no pull request yet
|
||||
|
|
|
|||
|
|
@ -1 +1 @@
|
|||
Moved to [SECURITY.md](https://github.com/wekan/wekan/blob/devel/SECURITY.md)
|
||||
Moved to [SECURITY.md](https://github.com/wekan/wekan/blob/master/SECURITY.md)
|
||||
|
|
@ -35,7 +35,7 @@ Wekan runs http server on local port, so it is without SSL. To get SSL, some web
|
|||
|
||||
First registered Wekan user will get [Admin Panel](https://github.com/wekan/wekan/wiki/Features) on new
|
||||
Docker and source based installs. You can also on MongoDB
|
||||
[enable Admin Panel](https://github.com/wekan/wekan/blob/devel/CHANGELOG.md#v0111-rc2-2017-03-05-wekan-prerelease) and [change you as board admin](https://github.com/wekan/wekan/issues/1060#issuecomment-310545976).
|
||||
[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).
|
||||
|
||||
## LAN + VPN
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ At [Virtual Appliance](https://github.com/wekan/wekan/wiki/virtual-appliance) th
|
|||
|
||||
## Build from source on Linux
|
||||
|
||||
To have [Node 100% CPU fixes](https://github.com/wekan/wekan/blob/devel/CHANGELOG.md#v084-2018-04-16-wekan-release): Increase ulimit for node in systemd config to 100 000
|
||||
To have [Node 100% CPU fixes](https://github.com/wekan/wekan/blob/master/CHANGELOG.md#v084-2018-04-16-wekan-release): Increase ulimit for node in systemd config to 100 000
|
||||
|
||||
Wekan:
|
||||
- On any x64 hardware that has Ubuntu 14.04 or Debian 9 or newer installed directly or in VM:
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ Anyone, please feel free correct if there is anything wrong or outdated info bel
|
|||
|
||||
Features | Wekan | Trello | Restyaboard
|
||||
------------ | ------------- | ------------- | -------------
|
||||
Price | Free and Open Source, [MIT license](https://github.com/wekan/wekan/blob/devel/LICENSE). Free for Commercial Use. | Free, Monthly payment, Annual Subscription, Quote-based | Open Core
|
||||
Price | Free and Open Source, [MIT license](https://github.com/wekan/wekan/blob/master/LICENSE). Free for Commercial Use. | Free, Monthly payment, Annual Subscription, Quote-based | Open Core
|
||||
Whitelabeling | Yes. Admin Panel/Layout: Hide Logo, Custom Product Name. | No | $ Yes
|
||||
Theming | [Not yet](https://github.com/wekan/wekan/issues/781) | No | $ Yes
|
||||
Redistributing | Yes | No | $ Yes
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue