From 92d1a9d3357ab3ff394f64ee8ff0a93fdc670bb0 Mon Sep 17 00:00:00 2001 From: Keerthana Date: Tue, 10 Jun 2025 14:10:22 +0530 Subject: [PATCH] [docs] refactor requirements --- docs/docs/self-hosting/guides/from-source.md | 2 +- docs/docs/self-hosting/index.md | 28 ++++++++++++++------ 2 files changed, 21 insertions(+), 9 deletions(-) diff --git a/docs/docs/self-hosting/guides/from-source.md b/docs/docs/self-hosting/guides/from-source.md index 557c5b5adc..9d010190dc 100644 --- a/docs/docs/self-hosting/guides/from-source.md +++ b/docs/docs/self-hosting/guides/from-source.md @@ -197,7 +197,7 @@ ports). The web server of choice in this guide is [Caddy](https://caddyserver.com) because with caddy you don't have to manually configure/setup SSL ceritifcates as caddy will take care of that. -``` groovy +```groovy photos.yourdomain.com { reverse_proxy http://localhost:3001 # for logging diff --git a/docs/docs/self-hosting/index.md b/docs/docs/self-hosting/index.md index c0eef22f2c..2e7cbbe812 100644 --- a/docs/docs/self-hosting/index.md +++ b/docs/docs/self-hosting/index.md @@ -5,20 +5,32 @@ description: Getting started self hosting Ente Photos and/or Ente Auth # Self Hosting -The entire source code for Ente is open source, including the servers. This is +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. -> [!TIP] -> -> You might find our [blog post](https://ente.io/blog/open-sourcing-our-server/) -> announcing the open sourcing of our server useful. +## Requirements -## System requirements +### Hardware -The server has minimal resource requirements, running as a lightweight Go -binary. It performs well on small cloud instances, old laptops, and even +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, preferably Ubuntu or Debian is recommended +to have a good Docker experience. The reason being poor experience on non-Linux +systems 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.