andreas/ente-cloudron
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Document CLI bootstrap steps

Browse Source
This commit is contained in:
Andreas Dueren
2025-11-04 17:49:15 -06:00
parent 5549f03f6e
commit 0652dde795
2 changed files with 32 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
POSTINSTALL.md
View File

@@ -23,13 +23,25 @@ The installer now asks for dedicated hostnames for the Auth/Accounts/Cast/Albums
## Administration ## Administration
- Use the bundled CLI from the Cloudron web terminal (CLI state lives in `/app/data/cli-data`): - Use the bundled CLI from the Cloudron web terminal (CLI state lives in `/app/data/cli-data`). On a new deployment initialise it once:
```bash ```bash
ente --help # from the Cloudron terminal, logged in as root
cat <<'EOF' >/cli-data/config.yaml
endpoint:
api: https://<your-app-domain>/api
log:
http: false
EOF
mkdir -p /cli-data/export
chown cloudron:cloudron /cli-data /cli-data/config.yaml /cli-data/export
# List users (requires an existing admin account) # store your account (enter the OTP emailed to you)
ente admin list-users --admin-user admin@example.com sudo -u cloudron ente account add
# inspect available commands
sudo -u cloudron ente --help
``` ```
Once the account is added you can follow the upstream admin docs for tasks like whitelisting and quota adjustments.
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). 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).
- To persist custom Museum settings (for example, seeding super-admin email addresses), create `/app/data/config/museum.override.yaml`. The file is appended to `museum/configurations/local.yaml` on each startup. - To persist custom Museum settings (for example, seeding super-admin email addresses), create `/app/data/config/museum.override.yaml`. The file is appended to `museum/configurations/local.yaml` on each startup.

17
README.md
View File

@@ -64,7 +64,22 @@ After installing on Cloudron remember to:
super-admins: super-admins:
- admin@example.com - admin@example.com
``` ```
4. Use the bundled Ente CLI for admin tasks via `cloudron exec --app <location> -- 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 workflow: 4. Use the bundled Ente CLI for admin tasks via `cloudron exec --app <location> -- sudo -u cloudron ente --help`. On a fresh install run the following once (this initialises the CLI’s container-specific config and keystore):
```bash
cloudron exec --app ente.cloudron.io -- bash -lc \
'cat <<EOF >/cli-data/config.yaml
endpoint:
api: https://ente.cloudron.io/api
log:
http: false
EOF
mkdir -p /cli-data/export
chown cloudron:cloudron /cli-data /cli-data/config.yaml /cli-data/export'
# add your account (respond to prompts with the OTP sent to your email)
cloudron exec --app ente.cloudron.io -- sudo -u cloudron ente account add
```
Afterwards the usual admin commands work as documented. Example:
```bash ```bash
cloudron exec --app ente.cloudron.io -- sudo -u cloudron ente admin list-users --admin-user admin@example.com cloudron exec --app ente.cloudron.io -- sudo -u cloudron ente admin list-users --admin-user admin@example.com
``` ```