diff --git a/README.md b/README.md index ac59618..4ce21f2 100644 --- a/README.md +++ b/README.md @@ -15,34 +15,18 @@ Fully automated luxury Nextcloud via docker-swarm. * **SSO**: 1 (OAuth) -## Basic usage - -1. Set up Docker Swarm and [`abra`] -2. Deploy [`coop-cloud/traefik`] -3. `abra app new nextcloud --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 - your Docker swarm box -5. `abra app deploy YOURAPPDOMAIN` - -## How do I customise the default home page when logging in? - -- Delete the dashboard app since it is so corporate -- Follow [these docs](https://docs.nextcloud.com/server/latest/admin_manual/configuration_files/default_files_configuration.html) to set the default files list for each user in the Files app -- Configure a `defaultapp` in your `config.php` or use [apporder](https://apps.nextcloud.com/apps/apporder) - -## Running `occ` - -`abra app cmd YOURAPPDOMAIN app run_occ '"user:list --help"'` - -## Upgrading Nextcloud apps - -`abra app cmd YOURAPPDOMAIN app run_occ '"app:update --all"'` +## Quick start -## Onlyoffice Integrating +* `abra app new nextcloud` +* `abra app config ` +* `abra app secret insert smtp_password v1 ` +* `abra app secret generate -a ` +* `abra app deploy ` -`abra app config ` +### Onlyoffice Integration + +`abra app config ` Configure the following envs: ``` COMPOSE_FILE="$COMPOSE_FILE:compose.apps.yml" @@ -50,12 +34,12 @@ ONLYOFFICE_URL=https://onlyoffice.example.com SECRET_ONLYOFFICE_JWT_VERSION=v1 ``` -`abra app secret insert onlyoffice_jwt v1 ` -`abra app cmd app install_onlyoffice` +`abra app secret insert onlyoffice_jwt v1 ` +`abra app cmd app install_onlyoffice` -## BBB Integrating +### BBB Integration -`abra app config ` +`abra app config ` Configure the following envs: ``` COMPOSE_FILE="$COMPOSE_FILE:compose.apps.yml" @@ -63,8 +47,50 @@ BBB_URL=https://talk.example.org/bigbluebutton/ # trailing slash! SECRET_BBB_SECRET_VERSION=v1 ``` -`abra app secret insert bbb_secret v1 ` -`abra app cmd app install_bbb` +`abra app secret insert bbb_secret v1 ` +`abra app cmd app install_bbb` + +### Authentik Integration + + +`abra app config ` +Configure the following envs: +``` +COMPOSE_FILE="$COMPOSE_FILE:compose.authentik.yml" +AUTHENTIK_USER_PREFIX=authentik +AUTHENTIK_DOMAIN=authentik.example.com +AUTHENTIK_SECRET_NAME=authentik_example_com_nextcloud_secret_v1 # the same as in authentik +AUTHENTIK_ID_NAME=authentik_example_com_nextcloud_id_v1 # the same as in authentik +``` + +`abra app cmd app set_authentik` + +### Disable Dashboard + +Disable dashboard app since it is so corporate: + +`abra app config ` +Configure the following envs: +``` +OCC_CMDS="app:disable dashboard" +``` +`abra app cmd app post_install_occ` + +## Running `occ` + +`abra app cmd app run_occ '"user:list --help"'` + +## Default user files + +- Follow [these docs](https://docs.nextcloud.com/server/latest/admin_manual/configuration_files/default_files_configuration.html) to set the default files list for each user in the Files app + +## Default App + +- Configure a `defaultapp` in your `config.php` or use [apporder](https://apps.nextcloud.com/apps/apporder) + +## Upgrading Nextcloud apps + +`abra app cmd app run_occ '"app:update --all"'` ## How do I fix a Nextcloud version snafu?