From 0210acec435e23d69f18455bc16abf611035840f Mon Sep 17 00:00:00 2001 From: Andreas Dueren Date: Thu, 30 Oct 2025 13:36:01 -0600 Subject: [PATCH] Document admin whitelist and quota commands --- POSTINSTALL.md | 11 ++++++++--- README.md | 9 ++++++++- 2 files changed, 16 insertions(+), 4 deletions(-) diff --git a/POSTINSTALL.md b/POSTINSTALL.md index 3d6878a..d570147 100644 --- a/POSTINSTALL.md +++ b/POSTINSTALL.md @@ -34,12 +34,17 @@ For example, if you installed the app at `ente.cloudron.io`, create records for ## Administration -- Use the bundled CLI from the Cloudron web terminal: +- Use the bundled CLI from the Cloudron web terminal (CLI state lives in `/app/data/cli-data`): ```bash cloudron exec --app ente.cloudron.io -- sudo -u cloudron ente --help + + # Whitelist an administrator + cloudron exec --app ente.cloudron.io -- sudo -u cloudron ente admin user whitelist --email admin@example.com + + # Increase a user’s storage allocation (in GB) + cloudron exec --app ente.cloudron.io -- sudo -u cloudron ente admin user quota set --email user@example.com --storage-gb 500 ``` - CLI state lives at `/app/data/cli-data` (available inside the container at `/cli-data`). -- Follow Ente’s upstream guides to [whitelist administrative accounts](https://ente.io/help/self-hosting/administration/users#whitelist-admins) and to [adjust user storage quotas](https://ente.io/help/self-hosting/administration/cli). + See the upstream admin guides for further context: [user administration](https://ente.io/help/self-hosting/administration/users) and [CLI reference](https://ente.io/help/self-hosting/administration/cli). Logs are streamed to the Cloudron dashboard. For deeper inspection use: ```bash diff --git a/README.md b/README.md index af77b93..32f41f8 100644 --- a/README.md +++ b/README.md @@ -87,7 +87,14 @@ After installing on Cloudron remember to: 1. Open the File Manager for the app, edit `/app/data/config/s3.env` with your object storage endpoint/keys, and restart the app. 2. Add alias domains for `auth.`, `accounts.`, `cast.`, `albums.` and `family.` in the Cloudron **Domains** tab. Create matching DNS records pointing to the primary hostname (for example, if you installed at `ente.cloudron.io`, add `auth.ente.cloudron.io`, `accounts.ente.cloudron.io`, etc.). -3. Use the bundled Ente CLI for admin tasks via `cloudron exec --app -- sudo -u cloudron ente --help`. The CLI stores its state in `/app/data/cli-data` (exposed inside the container at `/cli-data`) and already trusts your app’s API endpoint. Follow the upstream admin guides to [whitelist administrators](https://ente.io/help/self-hosting/administration/users#whitelist-admins) and [adjust user quotas](https://ente.io/help/self-hosting/administration/cli). +3. Use the bundled Ente CLI for admin tasks via `cloudron exec --app -- sudo -u cloudron ente --help`. The CLI stores its state in `/app/data/cli-data` (exposed inside the container at `/cli-data`) and already trusts your app’s API endpoint. Typical workflows: + ```bash + # Whitelist an administrator (see https://ente.io/help/self-hosting/administration/users ) + cloudron exec --app ente.cloudron.io -- sudo -u cloudron ente admin user whitelist --email admin@example.com + + # Increase a user’s storage quota (see https://ente.io/help/self-hosting/administration/cli ) + cloudron exec --app ente.cloudron.io -- sudo -u cloudron ente admin user quota set --email user@example.com --storage-gb 500 + ``` The main photos UI continues to live on the hostname you selected during installation.