Merge pull request #11 from tracim/feature/automated_setup_and_better_uwsgi_doc

backend/README.md

@@ -81,21 +81,33 @@ create wsgidav configuration file for webdav:
 
     cp wsgidav.conf.sample wsgidav.conf
 
-## Run Tracim_backend ##
+## Run Tracim_backend With Uwsgi : great for production ##
 
-### With Uwsgi ###
 
-Run all services with uwsgi
+#### Install Uwsgi
+
+You can either install uwsgi with pip or with you distrib package manager:
 
     # install uwsgi with pip ( unneeded if you already have uwsgi with python3 plugin enabled)
     sudo pip3 install uwsgi
+
+or on debian 9 :
+
+    # install uwsgi on debian 9
+    sudo apt install uwsgi uwsgi-plugin-python3
+
+### All in terminal way ###
+
+
+Run all services with uwsgi
+
     # set tracim_conf_file path
     export TRACIM_CONF_PATH="$(pwd)/development.ini"
     export TRACIM_WEBDAV_CONF_PATH="$(pwd)/wsgidav.conf"
     # pyramid webserver
-    uwsgi -d /tmp/tracim_web.log --http-socket :6543 --wsgi-file wsgi/web.py -H env --pidfile /tmp/tracim_web.pid
+    uwsgi -d /tmp/tracim_web.log --http-socket :6543 --plugin python3 --wsgi-file wsgi/web.py -H env --pidfile /tmp/tracim_web.pid
     # webdav wsgidav server
-    uwsgi -d /tmp/tracim_webdav.log --http-socket :3030 --wsgi-file wsgi/webdav.py -H env --pidfile /tmp/tracim_webdav.pid
+    uwsgi -d /tmp/tracim_webdav.log --http-socket :3030 --plugin python3 --wsgi-file wsgi/webdav.py -H env --pidfile /tmp/tracim_webdav.pid
 
 to stop them:
 
@@ -104,7 +116,37 @@ to stop them:
     # webdav wsgidav server
     uwsgi --stop /tmp/tracim_webdav.pid
 
-### With Waitress (legacy way, usefull for debug) ###
+## With Uwsgi ini script file ##
+
+You can also preset uwsgi config for tracim, this way, creating this kind of .ini file:
+
+    # You need to replace <PATH> with correct absolute path
+    [uwsgi]
+    plugins = python3
+    chdir = <PATH>/tracim_v2/backend/
+    module = wsgi.web:application
+    home = <PATH>/tracim_v2/backend/env/
+    env = TRACIM_CONF_PATH=<PATH>/tracim_v2/backend/development.ini
+
+and :
+
+    # You need to replace <PATH> with correct absolute path
+    [uwsgi]
+    plugins = python3
+    chdir = <PATH>/tracim_v2/backend/
+    module = wsgi.webdav:application
+    home = <PATH>/tracim_v2/backend/env/
+    env = TRACIM_CONF_PATH=<PATH>/tracim_v2/backend/development.ini
+    env = TRACIM_WEBDAV_CONF_PATH=<PATH>/tracim_v2/backend/wsgidav.conf
+
+You can then run the process this way :
+
+    # You need to replace <WSGI_CONF_WEB> with correct path
+    uwsgi --ini <WSGI_CONF_WEB>.ini --http-socket :6543
+    # You need to replace <WSGI_CONF_WEBDAV> with correct path
+    uwsgi --ini <WSGI_CONF_WEBDAV>.ini --http-socket :3030
+
+### Run Tracim_Backend with Waitress : legacy way, usefull for debug and dev ###
 
 run tracim_backend web api:
 
@@ -159,4 +201,8 @@ For example, with default config:
 
 In Tracim, only some user can access to some informations, this is also true in
 Tracim REST API. you can check the [roles documentation](doc/roles.md) to check
-what a specific user can do.
+what a specific user can do.
+
+# Known issues
+
+see [here](doc/known_issues.md)

backend/doc/known_issues.md

@@ -0,0 +1,23 @@
+# Known issue with Tracim Backend
+
+## Uwsgi
+
+### plaster.exceptions.LoaderNotFound
+
+If you obtain error with :
+
+
+    plaster.exceptions.LoaderNotFound: Could not find a matching loader for the scheme "file+ini"".
+
+
+you most probably don't set correctly TRACIM_CONF_PATH or TRACIM_WEBDAV_CONF_PATH.
+You have to set a correct absolute path.
+be careful for uwsgi ini file :
+
+
+    # incorrect
+    env = TRACIM_CONF_PATH="/home/me/tracim_v2/backend/development.ini"
+
+    # correct
+    env = TRACIM_CONF_PATH=/home/me/tracim_v2/backend/development.ini
+

backend_lib.sh

@@ -0,0 +1,52 @@
+. bash_library.sh # source bash_library.sh
+
+function install_backend_system_dep {
+    log "install base debian-packaged-dep for backend..."
+    sudo apt update
+    sudo apt install -y python3 python3-venv python3-dev python3-pip
+    sudo apt install -y redis-server
+
+    log "install deps for dealing with most preview..."
+    sudo apt install -y zlib1g-dev libjpeg-dev
+    sudo apt install -y imagemagick libmagickwand-dev ghostscript
+    sudo apt install -y libreoffice # most office documents file and text format
+    sudo apt install -y inkscape # for .svg files.
+}
+
+function setup_pyenv {
+   log "setup python3 env.."
+   python3 -m venv env
+   source env/bin/activate
+}
+
+function install_backend_python_packages {
+    pip install --upgrade pip setuptools
+
+    log "install tracim-backend (sqlite_backend)..."
+    pip install -e ".[testing]"
+}
+
+function setup_config_file {
+    log "configure tracim with default conf..."
+    if [ ! -f development.ini ]; then
+       log "generate missing development.ini ..."
+       cp development.ini.sample development.ini
+    fi
+
+    if [ ! -f wsgidav.conf ]; then
+       log "generate missing wsgidav.conf ..."
+       cp wsgidav.conf.sample wsgidav.conf
+    fi
+}
+
+function setup_db {
+    result=$(alembic -c development.ini current)
+    if [ $? -eq 0 ] && [ ! "$result" == '' ]; then
+       log "check database migration..."
+       alembic -c development.ini upgrade head
+    else
+       log "database seems missing, init it..."
+       tracimcli db init
+       alembic -c development.ini stamp head
+    fi
+}

setup_default_backend.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+. bash_library.sh # source bash_library.sh
+. backend_lib.sh # source backend_lib.sh
+
+install_backend_system_deb
+
+log "go to backend subdir.."
+cd backend || exit 1;
+
+
+install_backend_system_dep
+setup_pyenv
+install_backend_python_packages
+setup_config_file
+setup_db
+
+log "backend of tracim was correctly set-up."