Files
ente-cloudron/POSTINSTALL.md

53 lines
1.9 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
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:
```bash
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) and add matching alias domains in Cloudron for:
- `auth.<app-domain>`
- `accounts.<app-domain>`
- `cast.<app-domain>`
- `albums.<app-domain>`
- `family.<app-domain>`
For example, if you installed the app at `ente.cloudron.io`, create records for `auth.ente.cloudron.io`, `accounts.ente.cloudron.io`, etc., all pointing to `ente.cloudron.io`, then add each hostname as an alias in the Cloudron dashboard.
## Administration
- 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 users 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
```
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
cloudron logs --app <location> -f
```