2021-11-21 19:23:23 +00:00
|
|
|
# Outline
|
2021-10-28 18:33:56 +00:00
|
|
|
|
2021-11-21 19:23:23 +00:00
|
|
|
Wiki and knowledge base for growing teams
|
2021-10-28 18:33:56 +00:00
|
|
|
|
|
|
|
|
<!-- metadata -->
|
|
|
|
|
|
2021-11-22 11:42:04 +00:00
|
|
|
* **Category**: Apps
|
|
|
|
|
* **Status**:
|
|
|
|
|
* **Image**: [outlinewiki/outline](https://hub.docker.com/r/outlinewiki/outline)
|
|
|
|
|
* **Healthcheck**:
|
|
|
|
|
* **Backups**:
|
|
|
|
|
* **Email**:
|
|
|
|
|
* **Tests**:
|
|
|
|
|
* **SSO**:
|
2021-10-28 18:33:56 +00:00
|
|
|
|
|
|
|
|
<!-- endmetadata -->
|
|
|
|
|
|
|
|
|
|
## 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`)
|
2021-11-21 19:23:23 +00:00
|
|
|
4. `abra app config YOURAPPNAME` - be sure to change `$DOMAIN` to something that resolves to
|
2021-10-28 18:33:56 +00:00
|
|
|
your Docker swarm box
|
2021-11-21 19:23:23 +00:00
|
|
|
5. `abra app deploy YOURAPPNAME`
|
2021-11-24 20:01:33 +00:00
|
|
|
7. Open the configured domain in your browser to finish set-up
|
2021-10-28 18:33:56 +00:00
|
|
|
|
|
|
|
|
[`abra`]: https://git.coopcloud.tech/coop-cloud/abra
|
|
|
|
|
[`coop-cloud/traefik`]: https://git.coopcloud.tech/coop-cloud/traefik
|
2022-01-06 11:38:58 +00:00
|
|
|
|
|
|
|
|
## Tips & Tricks
|
|
|
|
|
|
|
|
|
|
### Post-deploy migration
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
abra app run YOURAPPNAME app sh
|
|
|
|
|
export DATABASE_PASSWORD=$(cat /run/secrets/db_password)
|
|
|
|
|
export DATABASE_URL="postgres://outline:${DATABASE_PASSWORD}@${STACK_NAME}_postgres:5432/outline"
|
|
|
|
|
yarn db:migrate --env=production-ssl-disabled
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Setting up your `.env` config
|
|
|
|
|
|
2022-01-06 12:48:39 +00:00
|
|
|
Avoid the use of quotes (`"..."`) as much as possible, the NodeJS scripts flip out for some reason on some vars.
|
2022-01-07 08:05:45 +00:00
|
|
|
|
|
|
|
|
### Multiple users logging in & generic oauth
|
|
|
|
|
|
|
|
|
|
`COMPOSE_FILE="compose.yml:compose.patch.yml"`
|
