improve documentation of mscolab

A user pointed that the link in “steps to run” is invalid. It may point to the config below.

https://mss.readthedocs.io/en/stable/mscolab.html

‌

In a mail I decribed the needed steps. The one who fixes this, please verify my findings about hardcoded pathes. If that is reproduced file an additional bugreport.

It is welcome to improve the documentation. Usually someone new finds problems we just escaped automaticly.

‌

That’s from my answer of the mail.

You need sqlite3 or postgres on your system. The example is defined for
sqlite3 and comments show the setup for postgres.

\$ apt install sqlite3

Currently this mscolab_settings.py file need to be stored in $HOME/mss
and also the paths for the DATA_DIR should not become changed. This is
somewhere hard coded. We will improve this. This is only for now.

export PYTHONPATH=to the absolute path of $HOME/mss

Then you can start the server by

https://mss.readthedocs.io/en/stable/mscolab.html#instructions-to-use-mscolab-wsgi

gunicorn -b 0.0.0.0:8083 server:app

or call the builtin server mscolab

In the mss gui you have to use the server url and first add yourself as
user. Then login as this user. Afterwards add a project. The project is
shown in the list, double click it.
Important!! enable autosave

The common navigation elements of the views are on the bottom.

Comments (6)