diff --git a/README.md b/README.md new file mode 100644 index 0000000..f74f0bc --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# notea + +Self hosted note taking app stored on S3 + + +* **Category**: Apps +* **Status**: ❹💣 +* **Image**: [`notea`](https://hub.docker.com/r/cinwell/notea) +* **Healthcheck**: No +* **Backups**: No +* **Email**: No +* **Tests**: No +* **SSO**: No + + +## Basic usage + +1. Set up Docker Swarm and [`abra`] +2. Deploy [`coop-cloud/traefik`] +3. `abra app new notea` +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 + +[`abra`]: https://git.autonomic.zone/autonomic-cooperative/abra +[`coop-cloud/traefik`]: https://git.autonomic.zone/coop-cloud/traefik