TerribleDev/ente
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[docs] separate all sections from getting-started (revamp part x/x) (#5692)

Browse Source
This commit is contained in:
mangesh
2025-04-23 09:14:21 +05:30
committed by GitHub
parent be84e1856d c170384607
commit 7ec0c6dbdb
6 changed files with 147 additions and 115 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/docs/.vitepress/sidebar.ts
View File

@@ -241,12 +241,25 @@ export const sidebar = [
text: "Connect to custom server",
link: "/self-hosting/guides/custom-server/",
},
{
text: "Creating Accounts",
link: "/self-hosting/creating-accounts",
},
{
text: "Reverse Proxy",
link: "/self-hosting/reverse-proxy",
},
{
text: "Building your museum.yaml",
link: "/self-hosting/museum",
},
{
text: "Configuring S3",
link: "/self-hosting/guides/configuring-s3",
},
{
text: "Guides",
collapsed: true,
items: [
{ text: "Introduction", link: "/self-hosting/guides/" },
{

BIN
docs/docs/public/otp.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 438 KiB

26
docs/docs/self-hosting/creating-accounts.md Normal file
View File

@@ -0,0 +1,26 @@
---
title: Creating Accounts
description: Creating accounts on your deployment
---
# Creating Accounts
Once the docker containers are up and running on their desired ports. The Ente Photos
web app will be accessible on `http://localhost:3000`. Open the URL in your browser
and proceed with creating an account. By default, the API Endpoint will be `localhost:8080`
as Museum (our server endpoint) will listen on `:8080`.
![endpoint](/endpoint.png)
To complete your account registration you need to enter a 6-digit verification code.
This can be found in the server logs, which should already be shown in your quickstart
terminal. Alternatively, you can open the server logs with the following command from
inside the `my-ente` folder:
```sh
sudo docker compose logs
```
It should look something like the below
![otp](/otp.png)

115
docs/docs/self-hosting/index.md
View File

@@ -36,121 +36,6 @@ containers required to run Ente on your system.
![quickstart](/quickstart.png)
The docker containers will be up and listening on their desired ports. The Ente Photos
web app will be accessible on `http://localhost:3000`. Open the URL in your browser
and proceed with creating an account. By default, the API Endpoint will be `localhost:8080`
as Museum (our server endpoint) will listen on `:8080`.
![endpoint](/endpoint.png)
To complete your account registration you need to enter a 6-digit verification code.
This can be found in the server logs, which should already be shown in your quickstart
terminal. Alternatively, you can open the server logs with the following command from
inside the `my-ente` folder:
```sh
sudo docker compose logs
```
## Reverse Proxy
This step isn't really the direct next step after creating an account. It is
one of the most essential steps to avoid certain CORS errors and will help you through
the configuration coming ahead.
Museum runs on port `:8080`, Ente Photos web app runs on `:3000` and so on the other apps
are lined up after each other from ports `3001-3004`.
We highly recommend using HTTPS for Museum (`8080`). Primarily, because for security reasons Museum
won't accept any incoming HTTP traffic. Hence, all the requests will fail.
Head over to your DNS Management Dashboard and setup the appropriate records for the endpoints.
Mostly, `A` or `AAAA` records targeting towards your server's IP address should be sufficient. The rest of the work
will be done by the web server sitting on your server machine.
![cloudflare](/cloudflare.png)
### With Caddy
Setting up a reverse proxy with Caddy is pretty easy and straightforward. Firstly, install Caddy
on your server machine.
```sh
sudo apt install caddy
```
After the installation is complete, a `Caddyfile` is created on the path `/etc/caddy/`. This file is
used to configure reverse proxies and a whole lot of different things.
```yaml
# Caddyfile - myente.xyz is just an example.
api.myente.xyz {
reverse_proxy http://localhost:8080
}
ente.myente.xyz {
reverse_proxy http://localhost:3000
}
```
After a few hard-reloads, Ente Photos web app should be working on https://ente.myente.xyz. You can check out
the documentation for any other reverse proxy tool (like nginx) you want to use.
## Configuring `museum.yaml`
`Museum.yaml` is a YAML configuration file used to configure various things for museum.
By default, [`local.yaml`](https://github.com/ente-io/ente/tree/main/server/configurations/local.yaml)
is also available, but it is overridden if `museum.yaml` file is found. We highly
recommend creating and building your own `museum.yaml` instead of editing `configurations/local.yaml`.
The `my-ente` directory will include a `museum.yaml` file with some configurations around encryption
keys and secrets, postgres DB, and MinIO.
> [!TIP]
> Always do `docker compose down` inside `my-ente` directory, if you've made any changes to `museum.yaml`
> and then restart the containers with `docker compose up -d ` to see the changes in action.
### S3 Buckets
By default, the `s3` section is configured to use local minIO buckets and for the same reason
`are_local_buckets` is set to `true`. If you wish to bring any external S3 provider,
you just have to edit the configuration with appropriate credentails and details given by the provider.
And set `are_local_buckets` to false. Check out [Configuring S3](/self-hosting/guides/configuring-s3.md)
to understand more on how to configure S3 buckets and how the communication happens.
MinIO makes use of the port `3200` for API Endpoints and the Client Web App is run over `:3201`
(both on localhost). You can login to MinIO Console Web UI by accessing `localhost:3201` in your web-browser
and setting up all the things related to regions there itself.
If you face any issues related to uploads then checkout
[Troubleshooting Bucket CORS](/self-hosting/troubleshooting/bucket-cors) and
[Frequently Answered Error related to S3](/self-hosting/guides/configuring-s3#fae-frequently-answered-errors)
### App Endpoints
Ente Photos Web app is divided into multiple sub-apps like albums, cast, auth, etc.
These endpoints are configurable in the museum.yaml under the `apps.*` section.
For example,
```yaml
apps:
public-albums: albums.myente.xyz
cast: cast.myente.xyz
accounts: accounts.myente.xyz
family: family.myente.xyz
```
By default, all the values redirect to our publicly hosted production services.
After you are done with filling the values, restart museum and the App will start utilizing
those endpoints for everything instead of the Ente's prod instances.
Once you configure all the necessary endpoints, `cd` into `my-ente` and stop all the docker
containers with `docker compose down` to completely stop all the containers and restart them
with `docker compose up -d`.
Similarly, you can read the default [`local.yaml`](https://github.com/ente-io/ente/tree/main/server/configurations/local.yaml)
and build a functioning `museum.yaml` for many other functionalities like SMTP, Discord
Notifications, Hardcoded-OTT's, etc.
## Queries?
If you need any help or support, do not hesitate to drop your queries on our community

60
docs/docs/self-hosting/museum.md Normal file
View File

@@ -0,0 +1,60 @@
---
title: Building your Museum.yaml
description: Guide to writing a museum.yaml
---
## Configuring `museum.yaml`
`Museum.yaml` is a YAML configuration file used to configure various things for museum.
By default, [`local.yaml`](https://github.com/ente-io/ente/tree/main/server/configurations/local.yaml)
is also available, but it is overridden if `museum.yaml` file is found. We highly
recommend creating and building your own `museum.yaml` instead of editing `configurations/local.yaml`.
The `my-ente` directory will include a `museum.yaml` file with some configurations around encryption
keys and secrets, postgres DB, and MinIO.
> [!TIP]
> Always do `docker compose down` inside `my-ente` directory, if you've made any changes to `museum.yaml`
> and then restart the containers with `docker compose up -d ` to see the changes in action.
### S3 Buckets
By default, the `s3` section is configured to use local minIO buckets and for the same reason
`are_local_buckets` is set to `true`. If you wish to bring any external S3 provider,
you just have to edit the configuration with appropriate credentails and details given by the provider.
And set `are_local_buckets` to false. Check out [Configuring S3](/self-hosting/guides/configuring-s3.md)
to understand more on how to configure S3 buckets and how the communication happens.
MinIO makes use of the port `3200` for API Endpoints and the Client Web App is run over `:3201`
(both on localhost). You can login to MinIO Console Web UI by accessing `localhost:3201` in your web-browser
and setting up all the things related to regions there itself.
If you face any issues related to uploads then checkout
[Troubleshooting Bucket CORS](/self-hosting/troubleshooting/bucket-cors) and
[Frequently Answered Error related to S3](/self-hosting/guides/configuring-s3#fae-frequently-answered-errors)
### App Endpoints
Ente Photos Web app is divided into multiple sub-apps like albums, cast, auth, etc.
These endpoints are configurable in the museum.yaml under the `apps.*` section.
For example,
```yaml
apps:
public-albums: albums.myente.xyz
cast: cast.myente.xyz
accounts: accounts.myente.xyz
family: family.myente.xyz
```
By default, all the values redirect to our publicly hosted production services.
After you are done with filling the values, restart museum and the App will start utilizing
those endpoints for everything instead of the Ente's prod instances.
Once you configure all the necessary endpoints, `cd` into `my-ente` and stop all the docker
containers with `docker compose down` to completely stop all the containers and restart them
with `docker compose up -d`.
Similarly, you can read the default [`local.yaml`](https://github.com/ente-io/ente/tree/main/server/configurations/local.yaml)
and build a functioning `museum.yaml` for many other functionalities like SMTP, Discord
Notifications, Hardcoded-OTT's, etc.

48
docs/docs/self-hosting/reverse-proxy.md Normal file
View File

@@ -0,0 +1,48 @@
---
Title: Configuring Reverse Proxy
Description: configuring reverse proxy for Museum and other endpoints
---
## Reverse Proxy
This step isn't really the direct next step after creating an account. It is
one of the most essential steps to avoid certain CORS errors and will help you through
the configuration coming ahead.
Museum runs on port `:8080`, Ente Photos web app runs on `:3000` and so on the other apps
are lined up after each other from ports `3001-3004`.
We highly recommend using HTTPS for Museum (`8080`). Primarily, because for security reasons Museum
won't accept any incoming HTTP traffic. Hence, all the requests will fail.
Head over to your DNS Management Dashboard and setup the appropriate records for the endpoints.
Mostly, `A` or `AAAA` records targeting towards your server's IP address should be sufficient. The rest of the work
will be done by the web server sitting on your server machine.
![cloudflare](/cloudflare.png)
### With Caddy
Setting up a reverse proxy with Caddy is pretty easy and straightforward. Firstly, install Caddy
on your server machine.
```sh
sudo apt install caddy
```
After the installation is complete, a `Caddyfile` is created on the path `/etc/caddy/`. This file is
used to configure reverse proxies and a whole lot of different things.
```yaml
# Caddyfile - myente.xyz is just an example.
api.myente.xyz {
reverse_proxy http://localhost:8080
}
ente.myente.xyz {
reverse_proxy http://localhost:3000
}
#...and so on for other endpoints
```
After a few hard-reloads, Ente Photos web app should be up on https://ente.myente.xyz. You can check out
the documentation for any other reverse proxy tool (like nginx) you want to use.