Split

docs/docs/.vitepress/sidebar.ts

@@ -97,6 +97,11 @@ export const sidebar = [
                         text: "Connect to custom server",
                         link: "/self-hosting/guides/custom-server/",
                     },
+                    {
+                        text: "Administering your server",
+                        link: "/self-hosting/guides/admin",
+                    },
+
                     {
                         text: "Mobile build",
                         link: "/self-hosting/guides/mobile-build",

docs/docs/self-hosting/guides/admin.md

@@ -0,0 +1,43 @@
+---
+title: Server admin
+description: Administering your custom self-hosted Ente instance using the CLI
+---
+
+# Administering your custom server
+
+You can use [Ente's
+CLI](https://github.com/ente-io/ente/releases?q=tag%3Acli-v0) to administer your
+self hosted server.
+
+First we need to get your CLI to connect to your custom server. Define a
+config.yaml and put it either in the same directory as CLI or path defined in
+env variable `ENTE_CLI_CONFIG_PATH`
+
+```yaml
+endpoint:
+    api: "http://localhost:8080"
+```
+
+Now you should be able to [add an
+account](https://github.com/ente-io/ente/blob/main/cli/docs/generated/ente_account_add.md),
+and subsequently increase the [storage and account
+validity](https://github.com/ente-io/ente/blob/main/cli/docs/generated/ente_admin_update-subscription.md)
+using the CLI.
+
+For the admin actions, you can create `server/museum.yaml`, and whitelist add
+the admin userID `internal.admins`. See
+[local.yaml](https://github.com/ente-io/ente/blob/main/server/configurations/local.yaml#L211C1-L232C1)
+in the server source code for details about how to define this.
+
+```yaml
+....
+internal:
+  admins:
+    # - 1580559962386440
+
+....
+```
+
+You can use
+[account list](https://github.com/ente-io/ente/blob/main/cli/docs/generated/ente_account_list.md)
+command to find the user id of any account.

docs/docs/self-hosting/guides/index.md

@@ -13,5 +13,8 @@ See the sidebar for existing guides. In particular:
 -   If you're just looking to get started, see
     [configure custom server](custom-server/).
 
+-   For various admin related tasks, e.g. increasing the storage quota on your
+    self hosted instance, see [administering your custom server](admin).
+
 -   For self hosting both the server and web app using external S3 buckets for
     object storage, see [using external S3](external-s3).