[docs] restructure installation and guides section
This commit is contained in:
@@ -243,12 +243,8 @@ export const sidebar = [
|
|||||||
collapsed: true,
|
collapsed: true,
|
||||||
items: [
|
items: [
|
||||||
{
|
{
|
||||||
text: "Introduction",
|
text: "Get Started",
|
||||||
link: "/self-hosting/",
|
link: "/self-hosting/get-started",
|
||||||
},
|
|
||||||
{
|
|
||||||
text: "Quickstart",
|
|
||||||
link: "/self-hosting/quickstart",
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
text: "Install",
|
text: "Install",
|
||||||
@@ -262,10 +258,22 @@ export const sidebar = [
|
|||||||
text: "Quickstart Script (recommended)",
|
text: "Quickstart Script (recommended)",
|
||||||
link: "/self-hosting/install/quickstart",
|
link: "/self-hosting/install/quickstart",
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
text: "Running Ente from source",
|
||||||
|
link: "/self-hosting/install/from-source",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
text: "Running Ente without Docker",
|
||||||
|
link: "/self-hosting/install/standalone-ente",
|
||||||
|
},
|
||||||
{
|
{
|
||||||
text: "Environment variables",
|
text: "Environment variables",
|
||||||
link: "/self-hosting/install/environment",
|
link: "/self-hosting/install/environment",
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
text: "Default Configuration",
|
||||||
|
link: "/self-hosting/install/defaults",
|
||||||
|
},
|
||||||
{
|
{
|
||||||
text: "Post-installation Steps",
|
text: "Post-installation Steps",
|
||||||
link: "/self-hosting/install/post-install",
|
link: "/self-hosting/install/post-install",
|
||||||
@@ -310,15 +318,7 @@ export const sidebar = [
|
|||||||
{
|
{
|
||||||
text: "Configuring CLI for your instance",
|
text: "Configuring CLI for your instance",
|
||||||
link: "/self-hosting/guides/selfhost-cli",
|
link: "/self-hosting/guides/selfhost-cli",
|
||||||
},
|
}
|
||||||
{
|
|
||||||
text: "Running Ente from source",
|
|
||||||
link: "/self-hosting/guides/from-source",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
text: "Running Ente without Docker",
|
|
||||||
link: "/self-hosting/guides/standalone-ente",
|
|
||||||
},
|
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -19,7 +19,7 @@ have been developed and made available for mobile, web and desktop, namely:
|
|||||||
|
|
||||||
## History
|
## History
|
||||||
|
|
||||||
Ente was the founded by Vishnu Mohandas (he's also Ente's CEO) in response to
|
Ente was the founded by Vishnu Mohandas (Ente's CEO) in response to
|
||||||
privacy concerns with major tech companies. The underlying motivation was the
|
privacy concerns with major tech companies. The underlying motivation was the
|
||||||
understanding that big tech had no incentive to fix their act, but with
|
understanding that big tech had no incentive to fix their act, but with
|
||||||
end-to-end encrypted cross platform apps, there was a way for people to take
|
end-to-end encrypted cross platform apps, there was a way for people to take
|
||||||
|
|||||||
42
docs/docs/self-hosting/get-started.md
Normal file
42
docs/docs/self-hosting/get-started.md
Normal file
@@ -0,0 +1,42 @@
|
|||||||
|
---
|
||||||
|
title: Get Started - Self-hosting
|
||||||
|
description: Getting started with self-hosting Ente
|
||||||
|
---
|
||||||
|
|
||||||
|
# Get Started
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
- A system with at least 2 GB of RAM and 1 CPU core
|
||||||
|
- [Docker Compose v2](https://docs.docker.com/compose/)
|
||||||
|
|
||||||
|
> For more details, check out [requirements page](/self-hosting/install/requirements)
|
||||||
|
|
||||||
|
## Set up the server
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
|
||||||
|
## Queries?
|
||||||
|
|
||||||
|
If you need support, please ask on our community
|
||||||
|
[Discord](https://ente.io/discord) or start a discussion on
|
||||||
|
[GitHub](https://github.com/ente-io/ente/discussions/).
|
||||||
@@ -1,14 +0,0 @@
|
|||||||
---
|
|
||||||
title: System requirements
|
|
||||||
description: System requirements for running Ente's server
|
|
||||||
---
|
|
||||||
|
|
||||||
# System requirements
|
|
||||||
|
|
||||||
There aren't any "minimum" system requirements as such, the server process is
|
|
||||||
very light weight - it's just a single go binary, and it doesn't do any server
|
|
||||||
side ML, so I feel it should be able to run on anything reasonable.
|
|
||||||
|
|
||||||
We've used the server quite easily on small cloud instances, old laptops etc. A
|
|
||||||
community member also reported being able to run the server on
|
|
||||||
[very low-end embedded devices](https://github.com/ente-io/ente/discussions/594).
|
|
||||||
@@ -1,16 +0,0 @@
|
|||||||
---
|
|
||||||
title: Self Hosting
|
|
||||||
description: Overview of self-hosting Ente
|
|
||||||
---
|
|
||||||
|
|
||||||
# Self Hosting
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
## Queries?
|
|
||||||
|
|
||||||
If you need support, please ask on our community
|
|
||||||
[Discord](https://ente.io/discord) or start a discussion on
|
|
||||||
[GitHub](https://github.com/ente-io/ente/discussions/).
|
|
||||||
22
docs/docs/self-hosting/install/defaults.md
Normal file
22
docs/docs/self-hosting/install/defaults.md
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
---
|
||||||
|
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,`<host-port>:<container-port>`
|
||||||
|
|
||||||
|
| 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 |
|
||||||
@@ -1,16 +1,21 @@
|
|||||||
---
|
---
|
||||||
title: "Environment Variables and Ports"
|
title: "Environment Variables"
|
||||||
description:
|
description:
|
||||||
"Information about all the Environment Variables needed to run Ente"
|
"Information about all the Environment Variables needed to run Ente"
|
||||||
---
|
---
|
||||||
|
|
||||||
# Environment variables and ports
|
# Environment Variables
|
||||||
|
|
||||||
A self-hosted Ente instance requires specific endpoints in both Museum (the
|
A self-hosted Ente instance requires specific endpoints in both Museum (the
|
||||||
server) and web apps. This document outlines the essential environment variables
|
server) and web apps. This document outlines the essential environment variables
|
||||||
and port mappings of the web apps.
|
and port mappings of the web apps.
|
||||||
|
|
||||||
Here's the list of important variables that a self hoster should know about:
|
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
|
### Museum
|
||||||
|
|
||||||
@@ -39,14 +44,3 @@ information about and connects to other web apps like albums, cast, etc.
|
|||||||
|
|
||||||
This environment variable is used to configure and declare the endpoint for the
|
This environment variable is used to configure and declare the endpoint for the
|
||||||
Albums web app.
|
Albums web app.
|
||||||
|
|
||||||
## Ports
|
|
||||||
|
|
||||||
The below format is according to how ports are mapped in Docker.
|
|
||||||
Typically,`<host>:<container-port>`
|
|
||||||
|
|
||||||
1. `8080:8080`: Museum (Ente's server)
|
|
||||||
2. `3000:3000`: Ente Photos web app
|
|
||||||
3. `3001:3001`: Ente Accounts web app
|
|
||||||
4. `3003:3003`: [Ente Auth web app](https://ente.io/auth/)
|
|
||||||
5. `3004:3004`: [Ente Cast web app](http://ente.io/cast)
|
|
||||||
|
|||||||
@@ -0,0 +1,27 @@
|
|||||||
|
---
|
||||||
|
title: Quickstart Script
|
||||||
|
description: Self-hosting Ente with quickstart script
|
||||||
|
---
|
||||||
|
|
||||||
|
# Quickstart
|
||||||
|
|
||||||
|
We provide a quickstart script which can be used for self-hosting Ente on your machine.
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
|
||||||
|
Check out the [requirements](/self-hosting/install/requirements) page to get started.
|
||||||
|
|
||||||
|
## 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.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|

|
||||||
|
|||||||
@@ -1,46 +0,0 @@
|
|||||||
---
|
|
||||||
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.
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
> [!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).
|
|
||||||
Reference in New Issue
Block a user