Home

Welcome to the wekan-snap wiki!

https://uappexplorer.com/snap/ubuntu/wekan

Install

sudo snap install wekan

Help

wekan.help

It produces this help text:

Wekan: The open-source Trello-like kanban.

Make sure you have connected all interfaces, check more by calling

$ snap interfaces

Wekan has two services, to check status/restart/stop use systemd commands:

You can use these service commands:

• status
• start
• stop
• restart

MongoDB service:

$ sudo systemctl status snap.wekan.mongodb

Wekan service:

$ sudo systemctl status snap.wekan.wekan

Backup

$ wekan.database-backup BACKUPFILENAME

Backup file is optional parameter, if not passed backup is created in directory:

/var/snap/wekan/common/db-backups

To list existing backups in default directory:

$ wekan.database-list-backups

Restore backup

$ wekan.database-restore <path to backup>

Share MongoDB to other snaps

• connect mongodb-slot with plug from corresponding snap(s)
• configure corresponding service to use mongodb unix socket in shared directory, socket file name is: mongodb-.sock

Sharing MongoDB from other snap to wekan

• connect mongodb-plug with slot from snap providing mongodb
• disable mongodb in wekan by calling:

$ snap set wekan set disable-mongodb='true'

• set mongodb-bind-unix-socket to point to serving mongodb. Use relative path inside shared directory, e.g run/mongodb-27017.sock

Wekan supports settings keys

values can be changed by calling

$ snap set wekan <key name>='<key value>'

list of supported keys:

mongodb-bind-unix-socket:   mongodb binding unix socket:
		Default behaviour will preffer binding over unix socket, to
		disable unix socket binding set value to 'nill' string
		To bind to instance of mongo provided through contect
		interface set to relative path to the socket inside
		shared directory.
		No value set, using default value: '/var/snap/wekan/8/share'
mongodb-bind-ip:mongodb binding ip address: eg 127.0.0.1 for localhost
		If not defined default unix socket is used instead
		No value set, using default value: ''
mongodb-port:   mongodb binding port: eg 27017 when using localhost
		No value set, using default value: '27019'
mail-url:	wekan mail binding
		No value set, using default value:
		'smtp://user:[email protected]:25/'
mail-from:	wekan's admin mail from name email address
		No value set, using default value: '[email protected]'
root-url:	wekan's root url, eg http://127.0.0.1, https://example.com,
		https://wekan.example.com, http://example.com/wekan
		No value set, using default value: 'http://127.0.0.1'
	port:   port wekan is exposed at
		No value set, using default value: '8080'
	disable-mongodb:   Disable mongodb service: use only if binding to
		database outside of the snap. Valid values: [true,false]
		No value set, using default value: 'false'

For changes to take effect restart wekan service, if mongodb key was change also restart mongodb service, before restarting wekan to restart mongodb:

$ sudo systemctl restart snap.wekan.mongodb

To restart wekan:

$ sudo systemctl restart snap.wekan.wekan

Additional help

If you install the snap version of Wekan, probably you'll need to setup it for your IP and port. Just follow these steps:

$ sudo snap set wekan root-url="http://<your_ip>:<your_port>"
$ sudo snap set wekan port="<your_port>"
$ sudo systemctl restart snap.wekan.wekan

If it's not working, probably you'll use the mongodb port for another app, then, change it too:

sudo snap set wekan mongodb-port=27019
sudo snap disable wekan
sudo snap enable wekan

Wekan then is at http://localhost:8080