|
@@ -4,17 +4,13 @@
|
|
|
|
|
|
[![Wekan chat][vanila_badge]][vanila_chat]
|
|
|
|
|
|
-2017-02-08 News: 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][fork_announcement]
|
|
|
-
|
|
|
-[Wefork FAQ][fork_faq]
|
|
|
-
|
|
|
[Translate Wekan at Transifex][translate_wekan]
|
|
|
|
|
|
-Wekan is an open-source and collaborative kanban board application.
|
|
|
+Please read [FAQ](https://github.com/wekan/wekan/wiki/FAQ).
|
|
|
+Please don't feed the trolls and spammers that are mentioned in the FAQ :)
|
|
|
+
|
|
|
+Wekan is an completely [Open Source][open_source] and [Free software][free_software]
|
|
|
+collaborative kanban board application with MIT license.
|
|
|
|
|
|
Whether you’re maintaining a personal todo list, planning your holidays with
|
|
|
some friends, or working in a team on your next revolutionary idea, Kanban
|
|
@@ -22,21 +18,15 @@ boards are an unbeatable tool to keep your things organized. They give you a
|
|
|
visual overview of the current state of your project, and make you productive by
|
|
|
allowing you to focus on the few items that matter the most.
|
|
|
|
|
|
-Wekan supports most features you would expect of it including a real-time user
|
|
|
-interface.
|
|
|
+Wekan has real-time user interface. Not all features are implemented.
|
|
|
|
|
|
[Features][features]
|
|
|
|
|
|
[Integrations][integrations]
|
|
|
|
|
|
-Wekan supports many platforms, and plan is to add more.
|
|
|
+[Team](https://github.com/wekan/wekan/wiki/Team)
|
|
|
|
|
|
-SSO options like LDAP, passwordless email, SAML, GitHub and Google Auth are
|
|
|
-already available on [Sandstorm](https://sandstorm.io), not standalone Wekan.
|
|
|
-Sandstorm is Enterprise scale highly secure platform with grains, logging,
|
|
|
-admin settings, server clustering, App Market and it's now fully Open Source.
|
|
|
-Sandstorm is preferred platform for Wekan, as it would take a lot of work to
|
|
|
-reimplement everything in standalone Wekan.
|
|
|
+Wekan supports many [Platforms][platforms], and plan is to add more.
|
|
|
|
|
|
You don’t have to trust us with your data and can install Wekan on your own
|
|
|
computer or server. In fact we encourage you to do that by providing
|
|
@@ -52,9 +42,9 @@ page at wiki, please add them.
|
|
|
We are very welcoming to new developers and teams to submit new pull
|
|
|
requests to devel branch to make this Wekan App Development Platform possible
|
|
|
faster. Please see [Developer Documentation][dev_docs] to get started.
|
|
|
-We also welcome sponsors for features. By working directly with Wekan you
|
|
|
-get the benefit of active maintenance and new features added by
|
|
|
-growing Wekan developer community.
|
|
|
+We also welcome sponsors for features, although we don't have any yet.
|
|
|
+By working directly with Wekan you get the benefit of active maintenance
|
|
|
+and new features added by growing Wekan developer community.
|
|
|
|
|
|
[Roadmap is self-hosted on Wekan][roadmap_wefork]
|
|
|
|
|
@@ -74,81 +64,28 @@ Since Wekan is a free software, you don’t have to trust us with your data and
|
|
|
install Wekan on your own computer or server. In fact we encourage you to do
|
|
|
that by providing one-click installation on various platforms.
|
|
|
|
|
|
-## Supported Platforms
|
|
|
-
|
|
|
-Automatic generated newest builds are available for Docker, and some others that
|
|
|
-install directly from this repo. Automatic builds will be added later for more
|
|
|
-platforms.
|
|
|
+## Cleanup and stats
|
|
|
|
|
|
[Wekan database cleanup script][wekan_cleanup]
|
|
|
|
|
|
+[Docker cleanup](https://github.com/wekan/wekan/issues/985)
|
|
|
+
|
|
|
[Daily export of Wekan changes as JSON to Logstash and
|
|
|
ElasticSearch / Kibana (ELK)][wekan_logstash]
|
|
|
|
|
|
[Wekan stats][wekan_stats]
|
|
|
|
|
|
-First registered Wekan user will get Admin Panel on new Docker and source based
|
|
|
-installs. You can also [enable Admin Panel manually][enable_adminpanel].
|
|
|
-
|
|
|
-[Import/Export MongoDB data to/from Docker container][importexport_docker]
|
|
|
-
|
|
|
-### Docker: [Docker image][docker_image], [Docs at wiki][wekan_wiki]
|
|
|
-
|
|
|
-Docker example, running latest Wekan using docker-compose:
|
|
|
-
|
|
|
-#### Running from remote dockerhub images
|
|
|
-
|
|
|
-Recommended:
|
|
|
-
|
|
|
-* [Wekan <=> MongoDB][wekan_mongodb] - contains the only required Docker Compose file
|
|
|
-
|
|
|
-Development:
|
|
|
-
|
|
|
-* Clone this wekan repo and run from dockerhub without building:
|
|
|
-
|
|
|
-```
|
|
|
-sudo docker-compose up -d --nobuild
|
|
|
-```
|
|
|
-
|
|
|
-#### PostgreSQL read-only mirroring using dockerhub images
|
|
|
-
|
|
|
-[Wekan <=> MongoDB <=> ToroDB => PostgreSQL read-only mirroring][wekan_postgresql]
|
|
|
-for SQL access with any programming language or Office package that has PostgreSQL support, like
|
|
|
-newest LibreOffice 3.5.
|
|
|
-
|
|
|
-#### Running from locally built dockerhub images
|
|
|
-```
|
|
|
-sudo docker-compose up -d --build
|
|
|
-```
|
|
|
-
|
|
|
-#### Running from locally built dockerhub images and modified `ARG` variables (not recommended)
|
|
|
-```
|
|
|
-echo 'NODE_VERSION=v6.6.0' >> .env && \
|
|
|
-echo 'METEOR_RELEASE=1.4.2.3' >> .env && \
|
|
|
-echo 'NPM_VERSION=4.1.2' >> .env && \
|
|
|
-echo 'ARCHITECTURE=linux-x64' >> .env && \
|
|
|
-echo 'SRC_PATH=./' >> .env && \
|
|
|
-sudo docker-compose up -d --build
|
|
|
-```
|
|
|
-
|
|
|
-Docker example, running latest Wekan using docker run commands alone:
|
|
|
-```
|
|
|
-docker run -d --restart=always --name wekan-db mongo:3.4.3
|
|
|
-
|
|
|
-docker run -d --restart=always --name wekan --link "wekan-db:db" -e "MONGO_URL=mongodb://db" -e "ROOT_URL=http://localhost:8080" -p 8080:80 wekanteam/wekan:meteor-1.4
|
|
|
-```
|
|
|
-
|
|
|
-[Docker on SUSE Linux Enterprise Server 12 SP1][sles]
|
|
|
-
|
|
|
-[Docker environment for Wekan development][wekan_dev]
|
|
|
-
|
|
|
-[Install from source][install_source]
|
|
|
+## Supported Platforms
|
|
|
|
|
|
-[Install from source on Windows][installsource_windows]
|
|
|
+Automatic generated newest builds are available for Docker, and platforms that
|
|
|
+install directly from this repo. Automatic builds will be added later for more
|
|
|
+platforms.
|
|
|
|
|
|
-[VirtualBox][virtualbox]
|
|
|
+First registered Wekan user will get [Admin Panel][features] on new
|
|
|
+Docker and source based installs. You can also
|
|
|
+[enable Admin Panel manually][enable_adminpanel].
|
|
|
|
|
|
-[Debian Wheezy 64bit][debian_wheezy]
|
|
|
+[Docker](https://github.com/wekan/wekan/wiki/Docker)
|
|
|
|
|
|
[![Deploy][heroku_button]][heroku_deploy]
|
|
|
[![SignUp][indiehosters_button]][indiehosters_saas]
|
|
@@ -156,25 +93,15 @@ docker run -d --restart=always --name wekan --link "wekan-db:db" -e "MONGO_URL=m
|
|
|
[![Install on Cloudron][cloudron_button]][cloudron_install]
|
|
|
[![Try on Sandstorm][sandstorm_button]][sandstorm_appdemo]
|
|
|
|
|
|
+[VirtualBox][virtualbox]
|
|
|
|
|
|
-## Upcoming Platforms
|
|
|
-
|
|
|
-[Autoinstall script][autoinstall] based on [this issue][autoinstall_issue]
|
|
|
-
|
|
|
-[Create Sandstorm .spk file from source][sandstorm_spk]
|
|
|
-
|
|
|
-Email to work on already working Heroku: Use 3rd party
|
|
|
-email like SendGrid, update process.env.MAIL_URL ,
|
|
|
-change from email at Accounts.emailTeamplates.from ,
|
|
|
-new file in server folder called smtp.js on code
|
|
|
-`Meteor.startup(function () });` .
|
|
|
-TODO: Test and find a way to use API keys instead.
|
|
|
+[Install from source][install_source]
|
|
|
|
|
|
-Azure: Install from source. Azure endpoint needs to be added. Not tested yet.
|
|
|
+[Install from source on Windows][installsource_windows]
|
|
|
|
|
|
-OpenShift: Not tested yet.
|
|
|
+[Debian Wheezy 64bit][debian_wheezy]
|
|
|
|
|
|
-Google Cloud: Needs info how to enable websockets.
|
|
|
+[More Platforms, and Upcoming Platforms](https://github.com/wekan/wekan/wiki/Platforms)
|
|
|
|
|
|
## License
|
|
|
|
|
@@ -183,8 +110,6 @@ with [Meteor](https://www.meteor.com).
|
|
|
|
|
|
[vanila_badge]: https://vanila.io/img/join-chat-button2.png
|
|
|
[vanila_chat]: https://chat.vanila.io/channel/wekan
|
|
|
-[fork_faq]: https://github.com/wefork/wekan/wiki/FAQ
|
|
|
-[fork_announcement]: https://github.com/wekan/wekan/issues/640#issuecomment-276383458
|
|
|
[screenshot_wekan]: http://i.imgur.com/cI4jW2h.png
|
|
|
[screenshot_wefork]: http://i.imgur.com/lzvpeS9.png
|
|
|
[features]: https://github.com/wekan/wekan/wiki/Features
|
|
@@ -209,11 +134,8 @@ with [Meteor](https://www.meteor.com).
|
|
|
[travis_status]: https://travis-ci.org/wekan/wekan
|
|
|
[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
|
|
|
-[sles]: https://github.com/wekan/wekan/wiki/Install-Wekan-Docker-on-SUSE-Linux-Enterprise-Server-12-SP1
|
|
|
[virtualbox]: https://github.com/wekan/wekan/wiki/virtual-appliance
|
|
|
-[sandstorm_spk]: https://github.com/wekan/wekan/issues/823
|
|
|
[docker_image]: https://hub.docker.com/r/wekanteam/wekan/
|
|
|
-[importexport_docker]: https://github.com/wekan/wekan/wiki/Export-Docker-Mongo-Data
|
|
|
[wekan_wiki]: https://github.com/wekan/wekan/wiki
|
|
|
[translate_wekan]: https://www.transifex.com/wekan/wekan/
|
|
|
[autoinstall]: https://github.com/wekan/wekan-autoinstall
|
|
@@ -224,6 +146,8 @@ with [Meteor](https://www.meteor.com).
|
|
|
[wekan_cleanup]: https://github.com/wekan/wekan-cleanup
|
|
|
[wekan_logstash]: https://github.com/wekan/wekan-logstash
|
|
|
[wekan_stats]: https://github.com/wekan/wekan-stats
|
|
|
-[wekan_dev]: https://github.com/wekan/wekan-dev
|
|
|
[logstash_issue]: https://github.com/wekan/wekan/issues/855
|
|
|
[enable_adminpanel]: https://github.com/wekan/wekan/blob/devel/CHANGELOG.md#v0111-rc2-2017-03-05-wekan-prerelease
|
|
|
+[open_source]: https://en.wikipedia.org/wiki/Open-source_software
|
|
|
+[free_software]: https://en.wikipedia.org/wiki/Free_software
|
|
|
+[platforms]: https://github.com/wekan/wekan/wiki/Platforms
|