Superdesk Server

Superdesk Server provides a REST API server for Superdesk project. It's a python app, built on top of eve/flask framework.

There is some basic infrastructure plus app modules for users, authentication, ingest, archive, etc.

Requirements

We support python version 3.3+.

Other requirements are mongodb server and elasticsearch instance. Both can be configured via environment variables (see settings.py).

Using virtualenv is recommended for installing python requirements. So once activated, run:

$ pip install -r requirements.txt

For image processing you will need some extra packages:

Use nosetests for unit tests:

$ nosetests

Behave for behaviour testing:

$ behave

Flake8 for style check:

$ flake8

This will start a dev server on port 5000 with auto reaload feature. Don't use in production..

$ python app.py

Prefered way is using nginx + gunicorn:

$ gunicorn -w 4 -b :5000 wsgi

You can also run server with documentation on /docs url.

$ python docs.py

$ python manage.py

This will give you list of available commands.

This command will create an administrator user.

$ python manage.py users:create -u <username> -p <password>