Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
Castellum
castellum_scheduler
Commits
1c390ebb
Commit
1c390ebb
authored
Jul 12, 2021
by
Bengfort
Browse files
README: add section on production deployment
parent
6905e274
Changes
1
Hide whitespace changes
Inline
Side-by-side
README.md
View file @
1c390ebb
...
...
@@ -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/
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment