From 98b26537a166d653df2941d0434d5226208e4a50 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 | 53 +++++++++----------------------------------------- 2 files changed, 17 insertions(+), 47 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..27ea1e8 100644 --- a/README.md +++ b/README.md @@ -9,28 +9,6 @@ This repository contains the Cloudron packaging for [Ente](https://ente.io), an - Configured to use Cloudron's mail service for sending emails - Easy to deploy and manage through the Cloudron interface -## Requirements - -### Browser Compatibility - -Ente uses modern web technologies for its end-to-end encryption: - -- **WebAssembly**: Required for cryptographic operations -- **IndexedDB**: Required for client-side data storage - -Most modern browsers support these features, but they may be blocked by: -- Browser privacy settings -- Content Security Policies -- Certain browser extensions - -This package includes custom Caddy configuration with appropriate security headers to ensure these features work correctly. - -### S3-Compatible Storage - -Ente requires an S3-compatible object storage service. You can use: -- Cloudron's built-in object storage -- External services like AWS S3, Wasabi, or MinIO - ## Building and Installing ### Option 1: Build and Install Manually @@ -73,21 +51,20 @@ The app is configured automatically using Cloudron's environment variables for: - SMTP mail service - App origin URL -### Additional Configuration - -The package includes several enhancements to ensure proper functionality: - -1. **Security Headers**: Custom Content-Security-Policy headers that allow WebAssembly and IndexedDB -2. **API Configuration**: Dynamic runtime configuration to ensure the frontend connects to the correct API endpoint -3. **CORS Headers**: Proper CORS configuration for API access - ### Cloudron Admin Notes 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. @@ -95,7 +72,7 @@ The main photos UI continues to live on the hostname you selected during install ### Web Client -After installation, you can access the Ente web client at your app's URL. Create an admin account on first use. +After installation, you can access the Ente web client at your app's URL. Create the first user and whitelist them as an administrator using the CLI if desired. ### Mobile Apps @@ -113,18 +90,6 @@ To update to a newer version: cloudron update --app ente.yourdomain.com ``` -## Troubleshooting - -### Common Issues - -1. **"Failed to fetch" errors**: Check if your browser is blocking API requests to your domain -2. **WebAssembly errors**: Ensure your browser supports and allows WebAssembly (try using Chrome or Firefox) -3. **IndexedDB errors**: Make sure your browser allows IndexedDB (not in private/incognito mode) - -For issues specific to the Cloudron packaging, please open an issue in this repository. - -For issues with Ente itself, please refer to the [main Ente repository](https://github.com/ente-io/ente). - ## License This Cloudron package is licensed under the same license as Ente (Apache 2.0).