Newer
Older
Castellum Scheduler -- an open source tool for scheduling appointments
Scheduler allows a group of people to coordinate so that everyone gets
at most one of the available time slots. In a way this is the opposite
of doodle where everyone agrees on the same time slot.
Scheduler is part of the [Castellum][1] project, but can be used with
other tools just as well.
# Installation
For development, a single `make` will install all dependencies and start
the server. You can log in as "admin" with password "password".
If you want to run the scheduler alongside castellum for development you
need to set the following settings in castellum:
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
token defined in `settings.API_TOKEN`.
You can use PUT/DELETE requests to create/delete invitations for a
schedule. PUT will always respond with 204. DELETE will respond with 404
if no matching invitation existed.
You can use a GET request to get the currently selected timeslot for an
invitation.
When an invitation is changed, a POST request is sent to the URL defined
in `settings.PING_URL`. This request is not authenticated and should not
be trusted, so it does not itself contain the new data. Instead, the
other service is expected to make an authenticated GET request as
described above.
Example:
```sh
$ curl -X PUT -H 'Authorization: token CHANGEME' http://localhost:8001/api/1/foo/
$ curl -X GET -H 'Authorization: token CHANGEME' http://localhost:8001/api/1/foo/
{"datetime": "2020-11-03T07:00:00"}
$ curl -X DELETE -H 'Authorization: token CHANGEME' http://localhost:8001/api/1/foo/
```
[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/