Andreas/wekan
1
0
Fork 0
mirror of https://github.com/wekan/wekan.git synced 2025-12-16 23:40:13 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Updated Install and Update (markdown)

Lauri Ojansivu 2018-06-25 05:08:15 +03:00
parent 77b3386206
commit f8f302e4c9
1 changed files with 1 additions and 421 deletions
Download patch file Download diff file Expand all files Collapse all files

422
Install-and-Update.md

@ -1,421 +1 @@
# Install
_Note: Developers looking to contribute to Wekan should follow the instructions on [Installing from Source](#install-manually-from-source) to setup a development environment._
### Installing a new instance of Wekan
There are several options for deploying Wekan. Docker and sandstorm are by far the easiest, but manual installations are supported for those who prefer to customize their installation.
* [Installing with Docker](#install-using-docker)
* [Installing with Sandstorm](#install-with-sandstorm)
* [Installing with Cloudron](#install-with-cloudron)
* [Installing with Ubuntu snap](https://github.com/wekan/wekan-snap/wiki)
* [Installing with Official Binaries](#install-manually-releases)
* [Installing with Unofficial Debian Packages](https://github.com/soohwa/apt)
* [Installing from Source](#install-manually-from-source)
### Upgrading an existing instance
Wekan will automatically migrate your data on first launch. Steps for upgrading depends on the type of installation being upgraded. See the below options.
* [Upgrading Docker](#updating-docker)
* [Upgrading Sandstorm](#updating-sandstorm)
* [Upgrading Cloudron](#updating-cloudron)
* [Upgrading Unofficial Debian Packages](#updating-unofficial-debian-packages)
* [Upgrading Manual Installs](#updating-manual-installs)
* [Backing Up Mongo Data](#backup-mongo-data)
***
## Install using Docker
You can install using the official Docker repository located [here][docker-repo].
* [[Install Wekan Docker for testing|Install-Wekan-Docker-for-testing]]
* [[Install Wekan Docker in production|Install-Wekan-Docker-in-production]]
## Install with Sandstorm
Sandstorm is a platform that you can install of your server and it lets you install a variety of apps easily, most of the with a one-click installation.
For instructions how to install Sandstorm, check out the [guide][sandstorm-guide] on their website! After you have installed Sandstorm, just go to the Admin panel and install the Wekan app! That's all!
## Install with Cloudron
[Cloudron](https://cloudron.io) is a self-hosting platform with a focus on effortless app installation and keeping them up-to-date. You can install Wekan from the app library [here](https://cloudron.io/store/io.wekan.cloudronapp.html). It comes with LDAP integration with the Cloudron user management.
The Wekan app package is developed at https://git.cloudron.io/cloudron/wekan-app
## Install manually (Releases)
This is the best option currently if you want to get Wekan running with as few tools as possible.
**Heads up:**
For now this works not on Ubuntu 14.04. You need 16.04 (It needs newer libstdc++ version)
There are three options:
* [Bash Install Script](#bash-install-script)
* [Virtual Appliance](virtual-appliance)
* [Manual install](#manual-installation-steps)
## Bash Install Script
[Scripts from virtual appliance](https://github.com/wekan/wekan-maintainer/tree/master/virtualbox), can be used on any Ubuntu 14.04 64bit install like native or VM.
[wekan-autoinstall](https://github.com/wekan/wekan-autoinstall) - may not be up-to-date.
## Manual Installation Steps
### Install Node.js
Make sure Node.js is installed (currently Version 4.8.6 is required). If you don't have this version, you can use the [node packages][node-packages].
Max supported version is Node 8.11.1 or newer 8.x, currently using performance patched version from https://releases.wekan.team
### Install MongoDB
In order to run Wekan you need to have MongoDB installed. You can either install your distributions package, if they offer any or see the [MongoDB website][mongodb-website] how to install it.
Max supported version is MongoDB 3.2.x
### Install a Wekan release
Now you need to download the release you want to install, usually this is the latest release which you can find [here][latest-release] (you need the `.tar.gz` one).
Extract it:
```sh
tar xzvf wekan-VERSION.tar.gz
```
Move to the server directory and install the dependencies:
```sh
cd wekan-VERSION/bundle/programs/server && sudo npm install
```
Now go back to the base Wekan bundle directory:
```sh
cd ../../
```
Now we just need to make some settings through env variables:
```sh
export MONGO_URL='mongodb://127.0.0.1:27017/wekan'
export ROOT_URL='https://example.com'
export MAIL_URL='smtp://user:pass@mailserver.example.com:25/'
export MAIL_FROM='wekan-admin@example.com'
export PORT=8080
```
Now you are ready to run:
```sh
node main.js
```
Note that it is expected that this command will not exit, and this is not an error.
[latest-release]: https://github.com/wekan/wekan/releases/latest
## Install manually from Source
**NEW**
Install Wekan from source https://github.com/wekan/wekan-maintainer/tree/master/virtualbox with rebuild-wekan-meteor-1.6.sh script, with options 1 to install and 3 to rebuild source.
**OLD INFO BELOW**
Note: Support for source install is only developers, not for production use. It is much easier and faster to update production versions with Docker/Snap/Sandstorm, because Node/Meteor/package versions/build scripts changes sometimes.
This is the most complex way, suitable if you know what you are doing and want to have the most flexibility to adapt the installation to your needs. Let's go!
### Notes
If you haven't already, you need to install Node.js, given that we need node version 4.8.6, make sure to either use the [custom packages][node-packages] (the ones of your OS are likely too old) or install the correct version from the Node.js [website][node-web].
* Uses Ubuntu 16.04 VM. You need websockets enabled on your VM.
* For Caddy webserver, ports 80 and 443 need to be open. Caddy has automatic Let's Encrypt,
* for Nginx config you need to configure SSL yourself.
### Install MongoDB
_Note: Installing MongoDB version 3.2.x. This is because 3.4.1 released 2016-12-20 broke something so uploading images did not work, see:
https://github.com/wefork/wekan/issues/58_
```bash
# MongoDB for Ubuntu 16.04
sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv EA312927
echo "deb http://repo.mongodb.org/apt/ubuntu xenial/mongodb-org/3.2 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-3.2.list
sudo apt update
sudo apt install -y mongodb-org mongodb-org-server mongodb-org-shell mongodb-org-mongos mongodb-org-tools
sudo systemctl start mongod
sudo systemctl enable mongod
```
### Install Meteor
As you might have noticed already, Wekan is built using the Meteor web framework, so we need to install this as well. This can be done easily using their install script ([read it][meteor-script] if you don't trust it).
Max supported version is Meteor 1.6.0.1
```bash
curl https://install.meteor.com/ | sh
```
### Install and Build Wekan
```bash
# If you get build errors, clean old node modules
sudo rm -rf /usr/local/lib/node_modules
sudo rm -rf ~/.npm
# Download Wekan
git clone https://github.com/wekan/wekan
cd wekan
mkdir packages
cd packages
git clone https://github.com/wekan/flow-router.git kadira-flow-router
git clone https://github.com/meteor-useraccounts/core.git meteor-useraccounts-core
sed -i 's/api\.versionsFrom/\/\/api.versionsFrom/' ~/.meteor/packages/meteor-useraccounts-core/package.js
cd ..
# When rebuilding, delete npm 5.x package-lock.json file because it gives Base64 package errors
rm package-lock.json
#### OPTIONAL: test pull request
## git checkout -b dwrensha-profile-bugfix devel
## git pull https://github.com/dwrensha/wekan.git profile-bugfix
# Install Node.js 4.8.6
sudo apt install build-essential g++ capnproto nodejs nodejs-legacy npm git curl
sudo npm -g install n
## if the previous fails (and asks you to run as sudo) just rm /home/<username>/node_modules and retry
sudo n 4.8.6
sudo npm -g install npm@4.6.1
sudo npm -g install node-gyp
sudo npm -g install node-pre-gyp
sudo npm -g install fibers@1.0.15
# install wekan npm dependancies
npm install
```
#### For Development and Testing
```bash
meteor
```
When running with command `meteor`, any saved modification of HTML/CSS/JS Wekan code
will make changes also on the browser automatically. NPM package C/C++ code is probably
not recompiled though, that needs full rebuild.
#### In production
```bash
# When rebuilding, delete npm 5.x package-lock.json file because it gives Base64 package errors
rm package-lock.json
rm -rf .build
meteor build .build --directory
cp fix-download-unicode/cfs_access-point.txt .build/bundle/programs/server/packages/cfs_access-point.js
sed -i "s|build\/Release\/bson|browser_build\/bson|g" .build/bundle/programs/server/npm/node_modules/meteor/cfs_gridfs/node_modules/mongodb/node_modules/bson/ext/index.js
cd .build/bundle/programs/server/npm/node_modules/meteor/npm-bcrypt
rm -rf node_modules/bcrypt
npm install bcrypt
cd .build/bundle/programs/server
npm install
cd ~/repos
```
#### Run Wekan manually (if you've built for production)
Add to ~/repos/run-wekan.sh
```bash
cd ~/repos/wekan/.build/bundle
export MONGO_URL='mongodb://127.0.0.1:27017/admin'
# Production: https://example.com/wekan
# Local: http://localhost:3000
export ROOT_URL='http://localhost:3000'
export MAIL_URL='smtp://user:pass@mailserver.example.com:25/'
# This is local port where Wekan Node.js runs, same as below on Caddyfile settings.
export PORT=3000
node main.js
```
TIP. If you use a public URL for your ROOT_URL instead of a local URL or an IP address make sure the URL is the same when visiting your Wekan URL in your browser for the first time and make sure you add the port number similar to the PORT number you defined. Ie. when visiting your Wekan url like 'http(s)://your-domain.com' this would need a ROOT_URL setting like 'http(s)://your-domain.com:3000'. IF your ROOT_URL setting would be 'http(s)://www.your-domain.com:3000' when visiting the url in your browser without www you will run into url problems when trying to access Card details due to the fact the www is added to the url! The correct ROOT_URL setting is 'http(s)://your-domain.com:3000'.
If you are running it in an IP address, you may need for example
```bash
export ROOT_URL='http://192.168.1.100:3000'
export PORT=3000
```
Make it executeable:
```bash
chmod +x ~/repos/run-wekan.sh
```
You could run it manually with:
```bash
cd ~/repos
./run-wekan.sh
```
Done!
### (Optional) Run Wekan as service
Add to to /etc/systemd/system/wekan@.service
```bash
; see `man systemd.unit` for configuration details
; the man section also explains *specifiers* `%x`
; update <username> with username below
[Unit]
Description=Wekan server %I
Documentation=https://github.com/wekan/wekan
After=network-online.target
Wants=network-online.target
Wants=systemd-networkd-wait-online.service
[Service]
ExecStart=/usr/local/bin/node /home/<username>/repos/wekan/.build/bundle/main.js
Restart=on-failure
StartLimitInterval=86400
StartLimitBurst=5
RestartSec=10
ExecReload=/bin/kill -USR1 $MAINPID
RestartSec=10
StandardOutput=syslog
StandardError=syslog
SyslogIdentifier=Wekan
User=<username>
Group=<username>
Environment=NODE_ENV=production
Environment=PWD=/home/<username>/repos/wekan/.build/bundle
Environment=PORT=3000
Environment=HTTP_FORWARDED_COUNT=1
Environment=MONGO_URL=mongodb://127.0.0.1:27017/admin
; https://example.com/wekan for deployment
Environment=ROOT_URL=http://localhost/wekan
Environment=MAIL_URL='smtp://user:pass@mailserver.example.com:25/'
[Install]
WantedBy=multi-user.target
```
#### To start Wekan and enable service, change to your username where Wekan files are:
```bash
sudo systemctl daemon-reload
sudo systemctl start wekan@<username>
sudo systemctl enable wekan@<username>
```
#### To stop Wekan and disable service, change to your username where Wekan files are:
```bash
sudo systemctl daemon-reload
sudo systemctl stop wekan@<username>
sudo systemctl disable wekan@<username>
```
Checkout instructions for setup with [[Caddy Webserver Config]] and [[Nginx Webserver Config]] respectively.
# Update
## Updating Docker
If you installed Wekan via Docker, you'll have one Docker container for the database and one container for the application. You'll need to stop the old application container, replace it by the new one and start it again.
If you have newer Mongo version, you need to backup your MongoDB data (as shown here: [[Export Mongo Data|Export-Docker-Mongo-Data]]) and use similar commands as below to replace your Mongo container with version 3.2.x, and then restore data.
See running containers:
```sh
docker ps
```
To stop the running wekan container (not wekan-db that is MongoDB container):
```sh
docker stop CONTAINER-ID-HERE
```
Remove the container:
```sh
docker rm CONTAINER-ID-HERE
```
See previously downloaded Docker images, that are used to start containers:
```sh
docker images
```
Remove old previously downloaded Docker image:
```sh
docker rmi wekanteam/wekan:latest
```
Download and run latest version:
```sh
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:latest
```
More information about [setup Wekan Docker](https://github.com/wekan/wekan/wiki/Install-Wekan-Docker-in-production).
## Updating Sandstorm
Sandstorm updates work automatically. You need to go the the sandstom app market and click on the install button of Wekan. Then Sandstorm will tell you that this application is already installed on your server and ask you if you want to upgrade it.
## Updating Cloudron
If you have a Cloudron subscription, the app will be kept up-to-date automatically, otherwise follow this [guide](https://git.cloudron.io/cloudron/box/wikis/UpdatingApps) for manual updates.
## Updating Unofficial Debian Packages
If you are using the Unofficial Debian Packages you can upgrade with
```sh
apt-get update
apt-get dist-upgrade
```
## Updating Manual Installs
If you installed Wekan manually, you need to stop the Node.js server, download the wekan application and restart the Node.js server.
```sh
sudo systemctl stop wekan@wekan
cd ~/repos/wekan
git pull
# When rebuilding, delete npm 5.x package-lock.json file because it gives Base64 package errors
rm package-lock.json
npm install
rm -rf .build
meteor build .build --directory
cp fix-download-unicode/cfs_access-point.txt .build/bundle/programs/server/packages/cfs_access-point.js
sed -i "s|build\/Release\/bson|browser_build\/bson|g" .build/bundle/programs/server/npm/node_modules/meteor/cfs_gridfs/node_modules/mongodb/node_modules/bson/ext/index.js
cd .build/bundle/programs/server/npm/node_modules/meteor/npm-bcrypt
rm -rf node_modules/bcrypt
npm install bcrypt
cd .build/bundle/programs/server
npm install
cd ~/repos
sudo systemctl start wekan@wekan
```
The first and last line are incase you've installed [wekan as a service](#optional-run-wefork-as-service). Comment them out if not.
## Backup Mongo Data
```sh
#!/bin/bash
now=$(date +'%Y-%m-%d_%H.%M.%S')
mkdir -p backups/$now
cd backups/$now
mongodump
cd ..
zip -r $now.zip $now
cd ../..
echo "\nBACKUP DONE."
echo "Backup is at directory backups/${now}."
echo "Backup is also archived to .zip file backups/${now}.zip"
```
[bash-install-script]: https://github.com/anselal/wekan
[virtual-appliance]: https://github.com/anselal/wekan#wekan-virtual-appliance
[contributors-page]: https://github.com/wekan/wekan/blob/devel/Contributing.md#installation
[docker-repo]: https://hub.docker.com/r/wekanteam/wekan/
[sandstorm-guide]: https://sandstorm.io/install/
[node-packages]: https://github.com/joyent/node/wiki/Installing-Node.js-via-package-manager
[node-web]: https://nodejs.org/download
[meteor-script]: https://install.meteor.com/
[mongodb-website]: https://www.mongodb.org/downloads
Moved to [Platforms](https://github.com/wekan/wekan/wiki/Platforms)