docker-adaptauthoring/README.md

38 lines
1.4 KiB
Markdown
Raw Normal View History

2020-10-02 12:51:34 +00:00
# docker-adaptauthoring
2020-10-02 12:51:34 +00:00
Authoring SCORM-compatible training using the [Adapt Authoring](https://github.com/adaptlearning/adapt_authoring) tool.
2020-10-02 12:51:34 +00:00
## How to use this image
2020-10-02 12:51:34 +00:00
Because Adapt requires a database to run, the easiest way to get started is to use `docker-compose` to set up Adapt and MongoDB automatically.
2020-10-02 12:51:34 +00:00
Fetch the example `docker-compose.yml`:
2020-10-02 12:51:34 +00:00
wget https://github.com/3-w-c/docker-adaptauthoring/blob/master/docker-compose.yml
2020-10-02 12:51:34 +00:00
Edit the variables under `services.app.environment`, then push the button!
2020-10-02 12:51:34 +00:00
docker-compose up
2020-10-02 12:51:34 +00:00
## Environment variables
2020-10-02 12:51:34 +00:00
You can configure Adapt's initial set-up using these variables:
2020-10-02 12:51:34 +00:00
- `DOMAIN` - hostname for the Adapt service
- `PORT` (default `5000`) - TCP port for the Adapt service
- `DB_HOST` - MongoDB server hostname
- `DB_USER` - MongoDB username
- `DB_NAME` - MongoDB database name
- `SESSION_SECRET` - HTTP session secret key (set to something random)
- `ADMIN_EMAIL` - email address for the default superuser account
- `ADMIN_PASSWORD` - password for the default superuser account
- `FROM_EMAIL` - `From:` email address for notifications
2020-10-02 12:51:34 +00:00
## Docker secrets
2020-10-02 12:51:34 +00:00
As well as environment variables, you can also load `SESSION_SECRET` and
`ADMIN_PASSWORD` from files, which is helpful if want to keep secret data in
[Docker swarm mode secrets](https://docs.docker.com/engine/swarm/secrets).
2020-10-02 12:51:34 +00:00
Simply set `SESSION_SECRET_FILE` / `ADMIN_PASSWORD_FILE`.