diff --git a/README.md b/README.md new file mode 100644 index 0000000..6d276bf --- /dev/null +++ b/README.md @@ -0,0 +1,41 @@ +# Jupyter Lab + +Extensible environment for interactive and reproducible computing + + + +- **Category**: +- **Status**: +- **Image**: +- **Healthcheck**: +- **Backups**: +- **Email**: +- **Tests**: +- **SSO**: + + + +## Basic usage + +1. Set up Docker Swarm and [`abra`] +2. Deploy [`coop-cloud/traefik`] +3. `abra app new ${REPO_NAME} --secrets` (optionally with `--pass` if you'd like + to save secrets in `pass`) +4. `abra app YOURAPPDOMAIN config` - be sure to change `$DOMAIN` to something that resolves to + your Docker swarm box +5. `abra app YOURAPPDOMAIN deploy` +6. Open the configured domain in your browser to finish set-up + +Currently, you have to manually run a command to generate an initial +configuration: + +`abra app YOURAPPDOMAIN run app jupyter notebook --generate-config` + +And then run this command to get a token for initial login (or to set your own +password): + +`abra app YOURAPPDOMAIN run app jupyter notebook list` + +[`abra`]: https://git.coopcloud.tech/coop-cloud/abra +[`coop-cloud/traefik`]: https://git.coopcloud.tech/coop-cloud/traefik +cloud/traefik