diff --git a/docs/docs/.vitepress/sidebar.ts b/docs/docs/.vitepress/sidebar.ts index 1eee23a223..fe2f5c7405 100644 --- a/docs/docs/.vitepress/sidebar.ts +++ b/docs/docs/.vitepress/sidebar.ts @@ -259,20 +259,16 @@ export const sidebar = [ link: "/self-hosting/install/quickstart", }, { - text: "Running Ente from source", + text: "Docker Compose", link: "/self-hosting/install/from-source", }, { - text: "Running Ente without Docker", + text: "Without Docker", link: "/self-hosting/install/standalone-ente", }, { - text: "Environment variables", - link: "/self-hosting/install/environment", - }, - { - text: "Default Configuration", - link: "/self-hosting/install/defaults", + text: "Configuration", + link: "/self-hosting/install/config", }, { text: "Post-installation Steps", @@ -290,11 +286,11 @@ export const sidebar = [ items: [ { text: "Creating accounts", - link: "/self-hosting/creating-accounts", + link: "/self-hosting/administration/creating-accounts", }, { text: "Configuring your server", - link: "/self-hosting/museum", + link: "/self-hosting/administration/museum", }, { text: "Configuring S3", @@ -302,7 +298,7 @@ export const sidebar = [ }, { text: "Reverse proxy", - link: "/self-hosting/reverse-proxy", + link: "/self-hosting/administration/reverse-proxy", }, ], }, diff --git a/docs/docs/self-hosting/creating-accounts.md b/docs/docs/self-hosting/administration/creating-accounts.md similarity index 94% rename from docs/docs/self-hosting/creating-accounts.md rename to docs/docs/self-hosting/administration/creating-accounts.md index 550409106e..2cdfd7e8ba 100644 --- a/docs/docs/self-hosting/creating-accounts.md +++ b/docs/docs/self-hosting/administration/creating-accounts.md @@ -1,5 +1,5 @@ --- -title: Creating accounts +title: Creating Accounts - Self-hosting description: Creating accounts on your deployment --- diff --git a/docs/docs/self-hosting/museum.md b/docs/docs/self-hosting/administration/museum.md similarity index 100% rename from docs/docs/self-hosting/museum.md rename to docs/docs/self-hosting/administration/museum.md diff --git a/docs/docs/self-hosting/reverse-proxy.md b/docs/docs/self-hosting/administration/reverse-proxy.md similarity index 100% rename from docs/docs/self-hosting/reverse-proxy.md rename to docs/docs/self-hosting/administration/reverse-proxy.md diff --git a/docs/docs/self-hosting/install/config.md b/docs/docs/self-hosting/install/config.md new file mode 100644 index 0000000000..0fd4f8e468 --- /dev/null +++ b/docs/docs/self-hosting/install/config.md @@ -0,0 +1,43 @@ +--- +title: "Configuration - Self-hosting" +description: + "Information about all the configuration variables needed to run Ente along + with description on default configuration" +--- + +# Configuration + +The environment variables needed for running Ente, configuration variables +present in Museum's configuration file and the default configuration are +documented below: + +## Environment Variables + +A self-hosted Ente instance requires specific endpoints in both Museum (the +server) and web apps. This document outlines the essential environment variables +and port mappings of the web apps. + +Here's the list of environment variables that need to be configured: + +| Service | Environment Variable | Description | Default Value | +| ------- | -------------------- | ------------------------------------------------ | --------------------- | +| Web | `ENTE_API_ORIGIN` | API Endpoint for Ente's API (Museum) | http://localhost:8080 | +| Web | `ENTE_ALBUMS_ORIGIN` | Base URL for Ente Album, used for public sharing | http://localhost:3002 | + +## Config File + +## Default Configuration + +### Ports + +The below format is according to how ports are mapped in Docker when using quickstart script. +The mapping is of the format `- :` in `ports`. + +| Service | Type | Host Port | Container Port | +| ---------------------------------- | ------ | --------- | -------------- | +| Museum | Server | 8080 | 8080 | +| Ente Photos | Web | 3000 | 3000 | +| Ente Accounts | Web | 3001 | 3001 | +| Ente Albums | Web | 3002 | 3002 | +| [Ente Auth](https://ente.io/auth/) | Web | 3003 | 3003 | +| [Ente Cast](http://ente.io/cast) | Web | 3004 | 3004 | diff --git a/docs/docs/self-hosting/install/defaults.md b/docs/docs/self-hosting/install/defaults.md deleted file mode 100644 index e36f9df7a2..0000000000 --- a/docs/docs/self-hosting/install/defaults.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: "Default Configuration" -description: - "Detailed description of default configuration - ports, bucket, database, - etc." ---- - -# Default Configuration - -## Ports - -The below format is according to how ports are mapped in Docker. -Typically,`:` - -| Service | Type | Host Port | Container Port | -| ---------------------------------- | ------ | --------- | -------------- | -| Museum | Server | 8080 | 8080 | -| Ente Photos | Web | 3000 | 3000 | -| Ente Accounts | Web | 3001 | 3001 | -| Ente Albums | Web | 3002 | 3002 | -| [Ente Auth](https://ente.io/auth/) | Web | 3003 | 3003 | -| [Ente Cast](http://ente.io/cast) | Web | 3004 | 3004 | diff --git a/docs/docs/self-hosting/install/environment.md b/docs/docs/self-hosting/install/environment.md deleted file mode 100644 index c1e5dd6910..0000000000 --- a/docs/docs/self-hosting/install/environment.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: "Environment Variables" -description: - "Information about all the Environment Variables needed to run Ente" ---- - -# Environment Variables - -A self-hosted Ente instance requires specific endpoints in both Museum (the -server) and web apps. This document outlines the essential environment variables -and port mappings of the web apps. - -Here's the list of environment variables that need to be configured: - -| Service | Environment Variable | Description | Default Value | -| ------- | -------------------- | ------------------------------------ | --------------------- | -| Web | ENTE_API_ORIGIN | API Endpoint for Ente's API (Museum) | http://localhost:8080 | -| Web | ENTE_ALBUMS_ORIGIN | Base URL for album | http://localhost:3002 | - -### Museum - -1. `NEXT_PUBLIC_ENTE_ENDPOINT` - -The above environment variable is used to configure Museums endpoint. Where -Museum is running and which port it is listening on. This endpoint should be -configured for all the apps to connect to your self hosted endpoint. - -All the apps (regardless of platform) by default connect to api.ente.io - which -is our production instance of Museum. - -### Web Apps - -> [!IMPORTANT] Web apps don't need to be configured with the below endpoints. -> Web app environment variables are being documented here just so that the users -> know everything in detail. Checkout -> [Configuring your Server](/self-hosting/museum) to configure endpoints for -> particular app. - -In Ente, all the web apps are separate NextJS applications. Therefore, they are -all configured via environment variables. The photos app (Ente Photos) has -information about and connects to other web apps like albums, cast, etc. - -1. `NEXT_PUBLIC_ENTE_ALBUMS_ENDPOINT` - -This environment variable is used to configure and declare the endpoint for the -Albums web app. diff --git a/docs/docs/self-hosting/install/quickstart.md b/docs/docs/self-hosting/install/quickstart.md index 0ae37572ca..00d3de1373 100644 --- a/docs/docs/self-hosting/install/quickstart.md +++ b/docs/docs/self-hosting/install/quickstart.md @@ -1,5 +1,5 @@ --- -title: Quickstart Script +title: Quickstart Script (Recommended) - Self-hosting description: Self-hosting Ente with quickstart script --- diff --git a/docs/docs/self-hosting/install/standalone-ente.md b/docs/docs/self-hosting/install/standalone-ente.md index af1b3172e9..96db394cd5 100644 --- a/docs/docs/self-hosting/install/standalone-ente.md +++ b/docs/docs/self-hosting/install/standalone-ente.md @@ -1,9 +1,9 @@ --- -title: Installing Ente Standalone (without Docker) -description: Installing and setting up Ente standalone without docker. +title: Running Ente Without Docker - Self-hosting +description: Installing and setting up Ente without Docker --- -# Installing and Deploying Ente Standalone (without Docker) +# Running Ente without Docker ## Running Museum (Ente's server) without Docker