Update README
This commit is contained in:
parent
57f568bdca
commit
c1b26a5747
22
README.md
22
README.md
|
@ -2,7 +2,7 @@
|
|||
|
||||
![Docker Cloud Build Status](https://img.shields.io/docker/cloud/build/3wordchant/adaptauthoring)
|
||||
|
||||
Authoring SCORM-compatible training using the [Adapt Authoring](https://github.com/adaptlearning/adapt_authoring) tool.
|
||||
Authoring SCORM-compatible training using the [Adapt Authoring tool](https://github.com/adaptlearning/adapt_authoring).
|
||||
|
||||
## How to use this image
|
||||
|
||||
|
@ -30,10 +30,28 @@ You can configure Adapt's initial set-up using these variables:
|
|||
- `ADMIN_PASSWORD` - password for the default superuser account
|
||||
- `FROM_EMAIL` - `From:` email address for notifications
|
||||
|
||||
(If you edit these settings after set-up, you'll need to manually edit
|
||||
`/adapt_authoring/conf/config.json` with the new values as well)
|
||||
|
||||
## Docker secrets
|
||||
|
||||
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
|
||||
`ADMIN_PASSWORD` from files, which is helpful if you want to keep secret data in
|
||||
[Docker swarm mode secrets](https://docs.docker.com/engine/swarm/secrets).
|
||||
|
||||
Simply set `SESSION_SECRET_FILE` / `ADMIN_PASSWORD_FILE`.
|
||||
|
||||
## Docker Swarm
|
||||
|
||||
See [`compose-stacks/adapt_authoring`] for an example Docker "swarm mode"
|
||||
configuration, including secrets, SSL reverse proxy, and continuous integration
|
||||
tests of the stack deployment.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
- If you run the installer script many times in quick succession, you might get
|
||||
rate-limited by Github (the script checks Github for the latest Adapt
|
||||
Authoring version, and to clone the Authoring Framework and plug-ins). Wait
|
||||
an hour, or use a VPN.
|
||||
|
||||
[`compose-stacks/adapt_authoring`]: https://git.autonomic.zone/compose-stacks/adapt_authoring/
|
||||
|
|
Loading…
Reference in New Issue