From 8f93067afd5a2903a1a0f3cdecd23d9725def893 Mon Sep 17 00:00:00 2001 From: Malanius Date: Sun, 9 Sep 2018 12:50:14 +0200 Subject: [PATCH] Update readme --- CHANGELOG.md | 174 --------------------------------------------------- README.md | 161 ++++++++++++++++++++++++++--------------------- 2 files changed, 88 insertions(+), 247 deletions(-) delete mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index 0d9e4ce..0000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,174 +0,0 @@ -# v0.33 2018-08-25 - -- Remove friend, that branch is not in Wekan anymore. Options for iframe are at devel and master branches. -- Add OAuth2. - -Thanks to GitHub users salleman33 and xet7 for their contributions. - -# v0.22 2018-08-22 - -- Make the attributes that the webhook sends configurable. - -Thanks to GitHub users omarsy and xet7 for their contributions. - -# v0.21 2018-08-14 - -* Add trusted URL and browser-policy optios. -* Fix quotes. - -Thanks to GitHub user xet7 for contributions. - -# v0.20 2018-08-10 - -* Add note to beginning of docker-compose.yml that - using docker-compose is not required, you can - also use [Docker commands](https://github.com/wekan/wekan/wiki/Docker#quay). - -Thanks to GitHub user xet7 for contributions. - -# v0.19 2018-08-03 - -* Update wekan-app container internal port to 8080 - -Thanks to GitHub user xet7 for contributions. - -# v0.18 2018-08-01 - -* Enable API by default, so that Export Board works. -* Add Matomo options. - -Thanks to GitHub user xet7 for contributions. - -# v0.17 2018-05-19 - -* Use MongoDB 3.2.20 - -Thanks to GitHub user xet7 for contributions. - -# v0.16 2018-04-04 - -* Change back to use MongoDB 3.2.19. -* Add info about MongoDB oplog for large scale usage. -* Reorder docs to be above settings. - -Thanks to GitHub user xet7 for contributions. - -# v0.15 2018-03-15 - -Change snap to previous MongoDB version 3.2.18 because of data loss: -https://github.com/wekan/wekan-mongodb/issues/9 - -Thanks to GitHub user xet7 for contributions. - -# v0.14 2018-03-06 - -* Use MongoDB 3.2.19 - -Thanks to GitHub user xet7 for contributions. - -# v0.13 2017-01-28 - -* Use quay.io Docker image that builds faster than Docker Hub - -Thanks to GitHub user xet7 for contributions. - -# v0.12 2017-12-03 - -* Add commented out instructions for Docker image of new Wekan that has Node v6.12 and Meteor v1.6 - -Thanks to GitHub user xet7 for contributions. - -# v0.11 2017-12-02 - -* Use MongoDB 3.2.18 -* Added backup and upgrade instructions to readme. - -Thanks to GitHub user xet7 for contributions. - -# v0.10 2017-10-14 - -Thise release add following new features: - -* Use MongoDB 3.2.17 -* Add more documentation to docker-compose.yml - -Thanks to GitHub user xet7 for contributions. - -# v0.9 2017-09-02 - -This release adds following new features: - -* Use MongoDB 3.2.16 - -Thanks to GitHub user xet7 for contributions. - -# v0.8 2017-07-14 - -This release adds following new features: - -* Use MongoDB 3.2.15 - -Thanks to GitHub user xet7 for contributions. - -# v0.7 2017-06-19 - -This release adds following new features: - -* Use MongoDB 3.2.14 - -Thanks to GitHub user xet7 for contributions. - -# v0.6 2017-05-18 - -This release adds following new features: - -* Use latest tag of Docker Hub image. - -Thanks to GitHub user xet7 for contributions. - -# v0.5 2017-05-06 - -This release adds following new features: - -* Use MongoDB 3.2.13 - -Thanks to GitHub user xet7 for contributions. - -# v0.4 2017-04-13 - -This release fixes following bugs: - -* Upload images does not work correctly because - of bug in MongoDB 3.4.x, so going back to - MongoDB 3.2.12. - -Thanks to GitHub user n00b42 for reporting issue. - -# v0.3 2017-04-06 - -This release adds following new features: - -* Use Meteor 1.4 based Docker image. - -Thanks to GitHub users brylie and stephenmoloney for -their contributions. - -# v0.2 2017-02-19 - -This release adds following new documentation: - -* Added Docker Compose option to run as detached - to readme. - -Thanks to GitHub user stephenmoloney for his -contributions. - -# v0.1 2017-02-13 - -This release adds following new features: - -* Docker: Wekan <=> MongoDB - as separate repo. - -Thanks to GitHub users mquandalle, stephenmoloney and xet7 -for their contributions. diff --git a/README.md b/README.md index b5539be..050ba16 100644 --- a/README.md +++ b/README.md @@ -1,91 +1,106 @@ -# Docker: Wekan <=> MongoDB +# brmkan -* [Wekan kanban board, made with Meteor.js framework, running on - Node.js](https://wekan.io) -- [GitHub](https://github.com/wekan/wekan) -* [MongoDB NoSQL database](https://www.mongodb.com) +## Test -## Screenshot +Test instace is currently running on AWS EC2 instance: https://brmkan.malanius.net/ managed by **malanius**. +Content of this branch reflects that instance and it's settings. -![Screenshot of Wekan][screenshot] +## Useful links + +* [wekan-mongo in AWS](https://github.com/wekan/wekan/wiki/AWS) +* [wekan-mongo repository](https://github.com/wekan/wekan-mongodb) +* [example nginx conf](https://github.com/wekan/wekan/wiki/Nginx-Webserver-Config) +* [letsencrypt certbot](https://certbot.eff.org/) +* [test SSL configuratioon](https://www.ssllabs.com/ssltest/index.html) ## Install -1) Install docker-compose. +1. Install docker-compose. +1. Clone this repo: + ```bash + git clone https://github.com/brmlab/brmkan.git + cd brmkan + ``` +1. Checkout `brmkan` branch: + ```bash + git checkout brmkan + ``` +1. Generate letsencrypt certificate with certbot. +1. Generate SSL dhparam + ```bash + sudo openssl dhparam -out /etc/ssl/dh_param.pem 2048 + ``` +1. Copy nginx configuration files. +1. Create a dedicated user for Wekan, for example: + ```bash + sudo useradd -d /home/wekan -m -s /bin/bash wekan + ``` +1. Add this user to the docker group: + ```bash + sudo usermod -aG docker wekan + ``` +1. Switch login as user wekan: + ```bash + sudo su - wekan + ``` +1. Copy docker-compose.yml file to /home/wekan/docker-compose.yml +1. Modify the ROOT_URL and MAIL_* parameters as required. +1. Run in detached mode: + ```bash + docker-compose up -d + ``` -2) Clone this repo. +## Maitenance -```bash -git clone https://github.com/wekan/wekan-mongodb.git -cd wekan-mongodb -``` - -3a) Detached mode: - -```bash -docker-compose up -d -``` - -3b) Running attached to console, so Ctrl-c stops it: - -```bash -docker-compose up -``` - -4) Wekan is at http://localhost (port 80) - -5) MongoDB is at 127.0.0.1:27017 - -6) 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. - -7) [Restore your MongoDB data](https://github.com/wekan/wekan/wiki/Export-Docker-Mongo-Data). - -## Backup before upgrading - -[Backup all data from MongoDB](https://github.com/wekan/wekan/wiki/Export-Docker-Mongo-Data) - -## Upgrading Wekan - -1) In wekan-mongodb directory, stop Wekan: - -```bash -docker-compose stop -``` - -2) Check what is CONTAINER ID of wekanteam/wekan:latest container. Then remove container. - -```bash -docker ps -docker rm CONTAINER-ID-HERE -``` - -3) Check Docker images, what is IMAGE ID of quay.io/wekan/wekan, and remove quay.io/wekan/wekan image: - -```bash -docker images -docker rmi IMAGE-ID-HERE -``` - -4) If you have made backups of MongoDB container to outside of Docker, and want to upgrade MongoDB, you could also delete MongoDB container and image. - -5) Start Wekan again in background: - -```bash -docker-compose up -d -``` - -6) You can also check container logs: +### Check the logs ```bash docker ps docker logs CONTAINER-ID-OF-Wekan-or-MongoDB-HERE ``` -7) Restore MongoDB data if needed. +### Data save/restore -## Feedback +* [Backup all data from MongoDB](https://github.com/wekan/wekan/wiki/Export-Docker-Mongo-Data) +* [Restore MongoDB data](https://github.com/wekan/wekan/wiki/Export-Docker-Mongo-Data) -[Create GitHub issue](https://github.com/wekan/wekan/issues) +### Upgrading wekan -[screenshot]: https://wekan.github.io/screenshot.png +1. Always backup the db before upgrading (see above)! +2. In brmkan directory, stop the running services: + ```bash + docker-compose stop + ``` +3. Remove wekan container: + ```bash + docker-compose rm wekan + ``` +4. Update the wekan image + ```bash + docker-compose pull wekan + ``` +5. Start it again: + ```bash + docker-compose up -d + ``` +### Upgrading MonmgoDB + +1. Always backup the db before upgrading (see above)! +1. In brmkan directory, stop the running services: + ```bash + docker-compose stop + ``` +1. Remove wekan container: + ```bash + docker-compose rm wekandb + ``` +1. Update the MongoDB image + ```bash + docker-compose pull wekandb + ``` +1. Start it again: + ```bash + docker-compose up -d + ``` +1. Restore the data from created backup