Commit 1c390ebb authored by Bengfort's avatar Bengfort
Browse files

README: add section on production deployment

parent 6905e274
......@@ -9,11 +9,11 @@ other tools just as well.
# Installation
## Development
For development, a single `make` will install all dependencies and start
the server. You can log in as "admin" with password "password".
# Development with Castellum
If you want to run the scheduler alongside castellum for development you
need to set the following settings in castellum:
......@@ -22,6 +22,21 @@ SCHEDULER_URL = 'http://localhost:8001'
SCHEDULER_TOKEN = 'CHANGEME'
```
## Production
There are many different ways to deploy a django application. Please see
the [django documentation][2] for details. A complete example is also
availabe in the [castellum documentation][3].
Most important steps:
- Create a settings file and set `DJANGO_SETTINGS_MODULE` accordingly
- Provide values `SECRET_KEY`, `PING_URL`, and `API_TOKEN` in the
settings file you just created
- Setup a database and add the relevant information to the settings
file
- Configure authentication, e.g. [LDAP][4]
# API
All API requests must send an `Authorization` header with the secret
......@@ -50,3 +65,6 @@ $ curl -X DELETE -H 'Authorization: token CHANGEME' http://localhost:8001/api/1/
```
[1]: https://www.mpib-berlin.mpg.de/research-data/castellum
[2]: https://docs.djangoproject.com/en/stable/howto/deployment/
[3]: https://git.mpib-berlin.mpg.de/castellum/castellum/-/tree/main/docs/example_deployment
[4]: https://django-auth-ldap.readthedocs.io/en/latest/
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment