There is some basic infrastructure plus app modules for users, authentication, ingest, archive, etc.
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:
Behave for behaviour testing:
Flake8 for style check:
Running Dev Server
Use honchu to run the app - it will start api server on port
5000, websocket server on port
5100 and celery.
$ honcho start
Running Docker containers with fig
Fig is configured to create and start Docker container not only for Superdesk application itself but also for the depended services (mongodb, redis, elasticsearch).
It will mount git repo root inside the container so all the local changes will be reflected there.
So after running this command server will start listening on
localhost:5000 for REST API and on
localhost:5100 for WebSockets:
$ fig up
To create user you can run that command (it will start container instance for command execution and start depended service if needed):
fig run web python3 manage.py users:create -u admin -p admin -e "email@example.com" --admin=true
To rebuild environment(ie changes to environemnt or dependencies):
fig build && fig up
For more commandline magic go to their docs: http://www.fig.sh/cli.html
You can see API Documentation on apiary.
Running cli commands
$ python manage.py
This will give you list of available commands.
Creating admin user
This command will create an administrator user.
$ python manage.py users:create -u <username> -p <password> -e <email>