Sisyphe

bdh

Installation

Requirements

On a Debian-based host - running at least Debian Stretch, you will need the following packages:

• python3
• virtualenv
• python3-psycopg2 (optional, in case of a PostgreSQL database)

Note: if you're serving the application with uWSGI and NGINX on a sub location, ensure that you've added route-run = fixpathinfo: to your uWSGI configuration (from v2.0.11).

Building deployment environnement (production or development)

Note: make help will show Makefile target

Steps:

• prepare environment (database, web/wsgi entry point - nginx + uwsgi for example)
• config your application by creating and editing config.env from config.env.example
• alternatively, you can set (export) environnement variable READ_CONFIG_FILE=0 and set the configuration variable in the environnement.
• run make init
• if you forgot to setup config.env, make init will create it and launch an interactive editor on it

Update

• cd to the project directory with user credential
• run git pull
• run make update

Automatic development environnement

maybe suitable for C.I.

• export READ_CONFIG_FILE=0 DJANGO_SETTINGS_MODULE=sisyphe.settings.development
• make init
• make tests
• create a development instance: make init (it's a shortcut for make create-venv, make config.env, make update)
• run the test: make test
• run the development server: make serve

Step by step

Behind the scene Makefile make the following step

It assumes that you have downloaded the last release of Sisyphe, extracted it and that you moved to that folder.

1. Start by creating a new virtual environment under ./venv and activate it:

   $ virtualenv --system-site-packages ./venv
   $ source ./venv/bin/activate
   

2. Install the required Python packages depending on your environment:

   $ pip install -r requirements/production.txt
   ... or ...
   $ pip install -r requirements/development.txt
   

3. Configure the application by setting the proper environment variables depending on your environment. You can use the config.env.example which give you the main variables with example values.

   $ cp config.env.example config.env
   $ nano config.env
   $ chmod go-rwx config.env
   

   Note that this ./config.env file will be loaded by default when the application starts. If you don't want that, just move this file away or set the READ_CONFIG_FILE environment variable to 0.

4. Create the database tables - it assumes that you have created the database and set the proper configuration to use it:

   $ ./manage.py migrate
   

That's it! You should now be able to start the Django development server to check that everything is working fine with:

$ ./manage.py runserver

Structure

Overview

All the application files - e.g. Django code including settings, templates and statics - are located into the sisyphe/. It should permit in a near future to distribute the application as a Python package and install it system-wide.

Two environments are defined - either for requirements and settings:

• development: for local application development and testing. It uses a SQLite3 database and enable debugging by default, add some useful settings and applications for development purpose - i.e. the django-debug-toolbar.
• production: for production. It checks that configuration is set and correct, try to optimize performances and enforce some settings - i.e. HTTPS related ones.

Local changes

You can override and extend statics and templates locally. This can be useful if you have to change the logo for a specific instance for example. For that, just put your files under the local/static/ and local/templates/ folders.

Regarding the statics, do not forget to collect them after that. Note also that the local/ folder is ignored by git.

Variable content

All the variable content - e.g. user-uploaded media, collected statics - are stored inside the var/ folder. It is also ignored by git as it's specific to each application installation.

So, you will have to configure your Web server to serve the var/media/ and var/static/ folders, which should point to /media/ and /static/, respectively.

License

Sisyphe is developed by Cliss XXI and licensed under the AGPLv3+.