writefreely/README.md

44 lines
1.2 KiB
Markdown
Raw Permalink Normal View History

2021-12-09 13:03:46 +00:00
# writefreely
> An open source platform for building a writing space on the web.
<!-- metadata -->
2021-12-26 01:31:15 +00:00
* **Category**: Apps
* **Status**: 2, beta
* **Image**: [`writeas/writefreely`](https://hub.docker.com/r/writeas/writefreely), 4, upstream
* **Healthcheck**: 3
* **Backups**: 1
* **Email**: 3
* **Tests**: No
* **SSO**: 1
2021-12-09 13:03:46 +00:00
<!-- endmetadata -->
## Basic usage
1. Set up Docker Swarm and [`abra`]
2. Deploy [`coop-cloud/traefik`]
3. `abra app new writefreely --secrets` (optionally with `--pass` if you'd like
to save secrets in `pass`)
4. `abra app config YOURAPPDOMAIN` - be sure to change `DOMAIN` to something that resolves to
2021-12-09 13:03:46 +00:00
your Docker swarm box
5. `abra app deploy YOURAPPDOMAIN`
2021-12-09 13:03:46 +00:00
6. Open the configured domain in your browser to finish set-up
## Post-install
```
2021-12-09 15:16:23 +00:00
passwd=`abra app run pen.lumbung.space db cat /run/secrets/db_password`
abra app run pen.lumbung.space db mysql -u writeas -p$passwd writefreely
ALTER TABLE `oauth_users` MODIFY `access_token` varchar(2048);
2021-12-09 13:03:46 +00:00
```
## Keycloak setup
For the **OAUTH_HOST** config, it uses this format: `https://keycloak.domain.here/auth/realms/<your realm>/protocol/openid-connect`.
## Acknowledgements
Thanks to [@knoflook](https://git.coopcloud.tech/knoflook) for packaging work :heart: