Files
ente-cloudron/POSTINSTALL.md

2.5 KiB

Your Ente installation is almost ready!

Required: External Object Storage

Before using Ente, configure an S3-compatible object storage provider:

  1. Open the Cloudron dashboard and select your Ente app.
  2. Launch the web terminal.
  3. Edit /app/data/config/s3.env and provide values for all required keys:
    nano /app/data/config/s3.env
    
  4. Save the file and restart the app from the Cloudron dashboard.

Supported variables:

  • S3_ENDPOINT (e.g. https://<account>.r2.cloudflarestorage.com)
  • S3_REGION
  • S3_BUCKET
  • S3_ACCESS_KEY
  • S3_SECRET_KEY
  • S3_PREFIX (optional path prefix)

Required: DNS Subdomains

Ente now serves supporting apps on dedicated hosts. Create DNS records (CNAME or A) for:

  • accounts.<root-domain>
  • auth.<root-domain>
  • cast.<root-domain>
  • albums.<root-domain>
  • family.<root-domain>

For example, if you installed the app at ente.due.ren, create records for accounts.due.ren, auth.due.ren, etc., all pointing to ente.due.ren. After adding the DNS records, open the Cloudron dashboard → Ente app → Domains tab and add each hostname as an alias. DNS propagation must complete before the /accounts and /auth apps will accept sessions.

Next Steps

  • Visit the app URL and create the first administrator account.
  • Configure the Ente mobile apps to use your custom server (Settings → Advanced → Custom Server).
  • Optional: set the environment variables CLOUDRON_OIDC_IDENTIFIER, CLOUDRON_OIDC_CLIENT_ID, and CLOUDRON_OIDC_CLIENT_SECRET to enable Cloudron SSO in the generated Museum config.
  • Administrative CLI tooling is available inside the container. Open a terminal and run:
    cloudron exec --app ente.due.ren -- sudo -u cloudron ente --help
    cloudron exec --app ente.due.ren -- sudo -u cloudron ente admin --help
    
    The CLI stores its state at /app/data/cli-data (inside the container it is available at /cli-data). Consult the upstream CLI guide for per-command usage, including storage quota adjustments.

Administration Helpers

  • The Ente CLI binary is shipped at /app/code/ente. Run it via the Cloudron web terminal.
  • CLI configuration lives at /app/data/home/.ente/config.yaml and already points to https://<your-domain>/api.
  • The main Museum configuration is generated at /app/data/museum/configurations/local.yaml. Delete this file to regenerate it with updated environment variables.

Logs are streamed to the Cloudron dashboard. For deeper inspection use:

cloudron logs --app <location> -f