From 4d078c094c28e53d12c87c5b59fdf0ad88c6a05e Mon Sep 17 00:00:00 2001 From: Keerthana Date: Fri, 11 Jul 2025 09:27:49 +0530 Subject: [PATCH] [docs] restructure self-hosting navigation --- docs/docs/.vitepress/sidebar.ts | 67 +++++++++++++----- docs/docs/index.md | 2 +- docs/docs/self-hosting/index.md | 44 +----------- .../custom-server/custom-server.png | Bin .../custom-server/index.md | 0 .../web-custom-endpoint-indicator.png | Bin .../custom-server/web-dev-settings.png | Bin .../{faq => install}/environment.md | 0 .../docs/self-hosting/install/post-install.md | 0 docs/docs/self-hosting/install/quickstart.md | 0 .../docs/self-hosting/install/requirements.md | 24 +++++++ docs/docs/self-hosting/quickstart.md | 46 ++++++++++++ .../mail-templates/family_nudge_paid_sub.html | 0 server/quickstart.sh | 6 ++ 14 files changed, 127 insertions(+), 62 deletions(-) rename docs/docs/self-hosting/{guides => install}/custom-server/custom-server.png (100%) rename docs/docs/self-hosting/{guides => install}/custom-server/index.md (100%) rename docs/docs/self-hosting/{guides => install}/custom-server/web-custom-endpoint-indicator.png (100%) rename docs/docs/self-hosting/{guides => install}/custom-server/web-dev-settings.png (100%) rename docs/docs/self-hosting/{faq => install}/environment.md (100%) create mode 100644 docs/docs/self-hosting/install/post-install.md create mode 100644 docs/docs/self-hosting/install/quickstart.md create mode 100644 docs/docs/self-hosting/install/requirements.md create mode 100644 docs/docs/self-hosting/quickstart.md create mode 100644 server/mail-templates/family_nudge_paid_sub.html diff --git a/docs/docs/.vitepress/sidebar.ts b/docs/docs/.vitepress/sidebar.ts index a90caad19b..6715ef1303 100644 --- a/docs/docs/.vitepress/sidebar.ts +++ b/docs/docs/.vitepress/sidebar.ts @@ -242,26 +242,61 @@ export const sidebar = [ text: "Self hosting", collapsed: true, items: [ - { text: "Getting started", link: "/self-hosting/" }, { - text: "Connecting to custom server", - link: "/self-hosting/guides/custom-server/", + text: "Introduction", + link: "/self-hosting/", }, { - text: "Creating accounts", - link: "/self-hosting/creating-accounts", + text: "Quickstart", + link: "/self-hosting/quickstart", }, { - text: "Configuring your server", - link: "/self-hosting/museum", + text: "Install", + collapsed: true, + items: [ + { + text: "Requirements", + link: "/self-hosting/install/requirements", + }, + { + text: "Quickstart Script (recommended)", + link: "/self-hosting/install/quickstart", + }, + { + text: "Environment variables", + link: "/self-hosting/install/environment", + }, + { + text: "Post-installation Steps", + link: "/self-hosting/install/post-install", + }, + { + text: "Connecting to Custom Server", + link: "/self-hosting/install/custom-server/" + } + ], }, { - text: "Configuring S3", - link: "/self-hosting/guides/configuring-s3", - }, - { - text: "Reverse proxy", - link: "/self-hosting/reverse-proxy", + text: "Administration", + collapsed: true, + items: [ + { + text: "Creating accounts", + link: "/self-hosting/creating-accounts", + }, + { + text: "Configuring your server", + link: "/self-hosting/museum", + }, + { + text: "Configuring S3", + link: "/self-hosting/guides/configuring-s3", + }, + { + text: "Reverse proxy", + link: "/self-hosting/reverse-proxy", + }, + ], }, { text: "Guides", @@ -342,11 +377,7 @@ export const sidebar = [ { text: "Backups", link: "/self-hosting/faq/backup", - }, - { - text: "Environment variables", - link: "/self-hosting/faq/environment", - }, + } ], }, ], diff --git a/docs/docs/index.md b/docs/docs/index.md index 6bf6d18275..04685abcae 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -6,7 +6,7 @@ description: > # Welcome! -![Ducky: Ente's Mascot](/public/ducky.png){width=50% style="margin: 0 auto"} +![Ducky: Ente's Mascot](/ducky.png){width=50% style="margin: 0 auto"} ## Introduction diff --git a/docs/docs/self-hosting/index.md b/docs/docs/self-hosting/index.md index f371747114..7b10688264 100644 --- a/docs/docs/self-hosting/index.md +++ b/docs/docs/self-hosting/index.md @@ -1,6 +1,6 @@ --- title: Self Hosting -description: Getting started self hosting Ente Photos and/or Ente Auth +description: Overview of self-hosting Ente --- # Self Hosting @@ -9,48 +9,6 @@ The entire source code for Ente is open source, [including the servers](https://ente.io/blog/open-sourcing-our-server/). This is the same code we use for our own cloud service. -## Requirements - -### Hardware - -The server is capable of running on minimal resource requirements as a -lightweight Go binary, since most of the intensive computational tasks are done -on the client. It performs well on small cloud instances, old laptops, and even -[low-end embedded devices](https://github.com/ente-io/ente/discussions/594). - -### Software - -#### Operating System - -Any Linux or \*nix operating system, Ubuntu or Debian is recommended to have a -good Docker experience. Non-Linux operating systems tend to provide poor -experience with Docker and difficulty with troubleshooting and assistance. - -#### Docker - -Required for running Ente's server, web application and dependent services -(database and object storage) - -## Getting started - -Run this command on your terminal to setup Ente. - -```sh -sh -c "$(curl -fsSL https://raw.githubusercontent.com/ente-io/ente/main/server/quickstart.sh)" -``` - -The above `curl` command pulls the Docker image, creates a directory `my-ente` -in the current working directory, prompts to start the cluster and starts all the containers required to run Ente. - -![quickstart](/quickstart.png) - -![self-hosted-ente](/web-app.webp) - -> [!TIP] Important: -> If you have used quickstart for self-hosting Ente and are facing issues while > trying to run the cluster due to MinIO buckets not being created, please check [troubleshooting MinIO](/self-hosting/troubleshooting/docker#minio-provisioning-error) -> -> - ## Queries? If you need support, please ask on our community diff --git a/docs/docs/self-hosting/guides/custom-server/custom-server.png b/docs/docs/self-hosting/install/custom-server/custom-server.png similarity index 100% rename from docs/docs/self-hosting/guides/custom-server/custom-server.png rename to docs/docs/self-hosting/install/custom-server/custom-server.png diff --git a/docs/docs/self-hosting/guides/custom-server/index.md b/docs/docs/self-hosting/install/custom-server/index.md similarity index 100% rename from docs/docs/self-hosting/guides/custom-server/index.md rename to docs/docs/self-hosting/install/custom-server/index.md diff --git a/docs/docs/self-hosting/guides/custom-server/web-custom-endpoint-indicator.png b/docs/docs/self-hosting/install/custom-server/web-custom-endpoint-indicator.png similarity index 100% rename from docs/docs/self-hosting/guides/custom-server/web-custom-endpoint-indicator.png rename to docs/docs/self-hosting/install/custom-server/web-custom-endpoint-indicator.png diff --git a/docs/docs/self-hosting/guides/custom-server/web-dev-settings.png b/docs/docs/self-hosting/install/custom-server/web-dev-settings.png similarity index 100% rename from docs/docs/self-hosting/guides/custom-server/web-dev-settings.png rename to docs/docs/self-hosting/install/custom-server/web-dev-settings.png diff --git a/docs/docs/self-hosting/faq/environment.md b/docs/docs/self-hosting/install/environment.md similarity index 100% rename from docs/docs/self-hosting/faq/environment.md rename to docs/docs/self-hosting/install/environment.md diff --git a/docs/docs/self-hosting/install/post-install.md b/docs/docs/self-hosting/install/post-install.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/docs/self-hosting/install/quickstart.md b/docs/docs/self-hosting/install/quickstart.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/docs/self-hosting/install/requirements.md b/docs/docs/self-hosting/install/requirements.md new file mode 100644 index 0000000000..37ac281eae --- /dev/null +++ b/docs/docs/self-hosting/install/requirements.md @@ -0,0 +1,24 @@ +--- +title: Requirements +description: Requirements for self-hosting Ente +--- + +# Requirements + +The server is capable of running on minimal resource requirements as a +lightweight Go binary, since most of the intensive computational tasks are done +on the client. It performs well on small cloud instances, old laptops, and even +[low-end embedded devices](https://github.com/ente-io/ente/discussions/594). + +## Software + +### Operating System + +Any Linux or \*nix operating system, Ubuntu or Debian is recommended to have a +good Docker experience. Non-Linux operating systems tend to provide poor +experience with Docker and difficulty with troubleshooting and assistance. + +### Docker + +Required for running Ente's server, web application and dependent services +(database and object storage) diff --git a/docs/docs/self-hosting/quickstart.md b/docs/docs/self-hosting/quickstart.md new file mode 100644 index 0000000000..7267990bf5 --- /dev/null +++ b/docs/docs/self-hosting/quickstart.md @@ -0,0 +1,46 @@ +--- +title: Quickstart +description: Getting started with self-hosting Ente +--- + +# Quickstart + +For a quick preview of running Ente on your server, make sure you have the following installed on your system and meets the requirements mentioned below: + +## Requirements + +The server is capable of running on minimal resource requirements as a +lightweight Go binary, since most of the intensive computational tasks are done +on the client. It performs well on small cloud instances, old laptops, and even +[low-end embedded devices](https://github.com/ente-io/ente/discussions/594). + +### Software + +#### Operating System + +Any Linux or \*nix operating system, Ubuntu or Debian is recommended to have a +good Docker experience. Non-Linux operating systems tend to provide poor +experience with Docker and difficulty with troubleshooting and assistance. + +#### Docker + +Required for running Ente's server, web application and dependent services +(database and object storage) + +## Getting started + +Run this command on your terminal to setup Ente. + +```sh +sh -c "$(curl -fsSL https://raw.githubusercontent.com/ente-io/ente/main/server/quickstart.sh)" +``` + +The above `curl` command pulls the Docker image, creates a directory `my-ente` +in the current working directory, prompts to start the cluster and starts all the containers required to run Ente. + +![quickstart](/quickstart.png) + +![self-hosted-ente](/web-app.webp) + +> [!TIP] Important: +> If you have used quickstart for self-hosting Ente and are facing issues while trying to run the cluster due to MinIO buckets not being created, please check [troubleshooting MinIO](/self-hosting/troubleshooting/docker#minio-provisioning-error). diff --git a/server/mail-templates/family_nudge_paid_sub.html b/server/mail-templates/family_nudge_paid_sub.html new file mode 100644 index 0000000000..e69de29bb2 diff --git a/server/quickstart.sh b/server/quickstart.sh index 4c2a58f871..74535d437e 100755 --- a/server/quickstart.sh +++ b/server/quickstart.sh @@ -79,6 +79,12 @@ services: volumes: - ./museum.yaml:/museum.yaml:ro - ./data:/data:ro + healthcheck: + test: ["CMD", "curl", "--fail", "http://localhost:8080/ping"] + interval: 60s + timeout: 5s + retries: 3 + start_period: 5s # Resolve "localhost:3200" in the museum container to the minio container. socat: