[docs] restructure self-hosting navigation

This commit is contained in:
Keerthana
2025-07-11 09:27:49 +05:30
parent cbfcbe8da2
commit 4d078c094c
14 changed files with 127 additions and 62 deletions

View File

@@ -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",
},
}
],
},
],

View File

@@ -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

View File

@@ -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

View File

Before

Width:  |  Height:  |  Size: 246 KiB

After

Width:  |  Height:  |  Size: 246 KiB

View File

Before

Width:  |  Height:  |  Size: 138 KiB

After

Width:  |  Height:  |  Size: 138 KiB

View File

@@ -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)

View File

@@ -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).

View File

@@ -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: