Ente Help

Appearance

Ente CLI for self-hosted instance ​

This page covers the previous CLI. For the current CLI, see Administration. To switch versions, follow Migration.

If you are self-hosting, you can configure Ente CLI to export data & perform basic administrative actions.

TIP

Installing Ente CLI

For instructions on installing the Ente CLI, see the README available on Github.

Step 1: Configure endpoint ​

To do this, first configure the CLI to use your server's endpoint.

Define config.yaml and place it in ~/.ente/ or the directory specified by ENTE_CLI_CONFIG_DIR.

ENTE_CLI_CONFIG_DIR selects both configuration and saved accounts; ENTE_CLI_CONFIG_PATH is the legacy fallback. Use the existing account directory, e.g. ENTE_CLI_CONFIG_DIR=/path/to/existing-cli-directory ente export. Network commands stop if a separate working-directory config exists. If it contains your intended Ente settings, migrate them into that existing directory and remove or rename the old file; otherwise run from another directory. Local account commands remain available. Invalid trusted configuration must be corrected first.

yaml
# Set the API endpoint to your domain where Museum is being served.
endpoint:
    api: http://localhost:8080

Step 2: Whitelist admins ​

You can whitelist administrator users by following this guide.

Step 3: Add an account ​

NOTE

You can not create new accounts using Ente CLI.

You can only log in to your existing accounts.

To create a new account, use Ente Photos (or Ente Auth) web application, desktop or mobile.

You can add your existing account using Ente CLI.

sh
ente account add

This should prompt you for authentication details and export directory. Your account should be added after successful authentication.

It can be used for exporting data (for plain-text backup), managing Ente Auth and performing administrative actions.

Step 4: Increase storage and account validity ​

You can use ente admin update-subscription to increase storage quota and account validity (duration).

For infinite storage and validity, use the following command:

sh
ente admin update-subscription -a <admin-user-mail> -u <user-email-to-update> --no-limit True

# Set a limit
ente admin update-subscription -a <admin-user-mail> -u <user-email-to-update> --no-limit False

NOTE

The users must be registered on the server with same e-mail address.

If the commands are failing, ensure:

  1. <admin-user-mail> is whitelisted as administrator user in museum.yaml. For more information, check this guide.
  2. <user-email-to-update> is a registered user with completed verification.

For more information, check out the documentation for setting storage and account validity using the CLI.

References ​

  1. Ente CLI Documentation