diff --git a/docs/docs/.vitepress/config.ts b/docs/docs/.vitepress/config.ts index 4914ab6251..a1196f4c9e 100644 --- a/docs/docs/.vitepress/config.ts +++ b/docs/docs/.vitepress/config.ts @@ -1,6 +1,7 @@ import { defineConfig } from "vitepress"; import { sidebar } from "./sidebar"; + // https://vitepress.dev/reference/site-config export default defineConfig({ title: "Ente Help", @@ -26,6 +27,9 @@ export default defineConfig({ }, }, sidebar: sidebar, + outline: { + level: [2, 3] + }, socialLinks: [ { icon: "github", link: "https://github.com/ente-io/ente/" }, { icon: "twitter", link: "https://twitter.com/enteio" }, diff --git a/docs/docs/self-hosting/index.md b/docs/docs/self-hosting/index.md index 13fadbaa6c..4ea0156d60 100644 --- a/docs/docs/self-hosting/index.md +++ b/docs/docs/self-hosting/index.md @@ -16,7 +16,7 @@ ways of self-hosting Ente on your server as described in the documentation. ## Requirements - A system with at least 1 GB of RAM and 1 CPU core -- [Docker Compose v2](https://docs.docker.com/compose/) +- [Docker Compose](https://docs.docker.com/compose/) > For more details, check out the > [requirements page](/self-hosting/install/requirements). diff --git a/docs/docs/self-hosting/install/requirements.md b/docs/docs/self-hosting/install/requirements.md index 95b4699e8f..d0ac50b18b 100644 --- a/docs/docs/self-hosting/install/requirements.md +++ b/docs/docs/self-hosting/install/requirements.md @@ -8,25 +8,23 @@ description: Requirements for self-hosting Ente ## 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 +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). +- **Storage:** An Unix-compatible filesystem such as ZFS, EXT4, BTRFS, etc. if using PostgreSQL container as it requires a filesystem that supports user/group permissions. +- **RAM:** A minimum of 1 GB of RAM is required for running the cluster (if using quickstart script). +- **CPU:** A minimum of 1 CPU core is required. + ## Software -### Operating System +- **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. -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). Ente also requires **Docker Compose plugin** to be installed. -### Docker - -Required for running Ente's server, web application and dependent services -(database and object storage). Ente also requires **Docker Compose plugin** to -be installed. - -> [!NOTE] Ente requires **Docker Compose version 2.25 or higher**. +> [!NOTE] +> +> Ente requires **Docker Compose version 2.25 or higher**. > > Furthermore, Ente uses the command `docker compose`, `docker-compose` is no > longer supported.