[docs] omit dead links for bucket CORS

This commit is contained in:
Keerthana
2025-07-25 11:39:12 +05:30
parent 75d919e815
commit bd58becd38
11 changed files with 50 additions and 122 deletions

View File

@@ -22,15 +22,15 @@ At the minimum, a functional Ente backend needs three things:
When thinking about backups, this translates into backing up the relevant state
from each of these:
1. For museum, you'd want to backup your `museum.yaml`, `credentials.yaml` or
1. For Museum, you'd want to backup your `museum.yaml`, `credentials.yaml` or
any other custom configuration that you created. In particular, you should
backup the
[secrets that are specific to your instance](https://github.com/ente-io/ente/blob/74377a93d8e20e969d9a2531f32f577b5f0ef090/server/configurations/local.yaml#L188)
(`key.encryption`, `key.hash` and `jwt.secret`).
2. For postgres, the entire data volume needs to be backed up.
2. For PostgreSQL, the entire data volume needs to be backed up.
3. For object storage, the entire data volume needs to be backed up.
3. For Object Storage, the entire data volume needs to be backed up.
A common oversight is taking a lot of care for backing up the object storage,
even going as far as enabling replication and backing up the the multiple object
@@ -56,8 +56,7 @@ keeping a plaintext backup of your photos.
[You can use the CLI or the desktop app to automate this](/photos/faq/export).
Once you get more comfortable with the various parts, you can try backing up
your instance. As a reference,
[this document outlines how Ente itself treats backups](https://ente.io/reliability).
your instance.
If you stop doing plaintext backups and instead rely on your instance backup,
ensure that you do the full restore process also to verify you can get back your

View File

@@ -37,7 +37,7 @@ MinIO uses the port `3200` for API Endpoints and their web app runs over
browser.
If you face any issues related to uploads then checkout
[Troubleshooting bucket CORS](/self-hosting/troubleshooting/bucket-cors) and
[Troubleshooting bucket CORS] and
[Frequently encountered S3 errors].
## Web apps

View File

@@ -5,9 +5,13 @@ Description: Configuring reverse proxy for Museum and other services
# Reverse proxy
We highly recommend using HTTPS for Museum (`8080`). For security reasons, Museum
will not accept incoming HTTP traffic.
Configuring reverse proxy is a way to make the service accessible via the public
Internet without exposing multiple ports for various services.
It also allows configuration of HTTPS through SSL certificate management.
We highly recommend using HTTPS for Museum (Ente's server). For security reasons, Museum
will not accept incoming HTTP traffic.
## Pre-requisites
@@ -36,21 +40,22 @@ although you can use other alternatives such as NGINX, Traefik, etc.
Set up the appropriate records for the endpoints in your DNS
management dashboard (usually associated with your domain registrar).
`A` or `AAAA` records targeting towards your server's IP address should
be sufficient.
`A` or `AAAA` records pointing to your server's IP address are sufficient.
DNS propagation can take a few minutes to take effect.
![cloudflare](/cloudflare.png)
## Step 2: Configure reverse proxy
Once Caddy is installed on system, a `Caddyfile` is created on the path
After installing Caddy, a `Caddyfile` is created on the path
`/etc/caddy/`. Edit `/etc/caddy/Caddyfile` to configure reverse proxies.
Here is a ready-to-use configuration that can be used with your own domain.
```groovy
# yourdomain.tld is an example. Replace it with your own domain
> yourdomain.tld is an example. Replace it with your own domain
```groovy
# For Museum
api.ente.yourdomain.tld {
reverse_proxy http://localhost:8080
@@ -80,14 +85,9 @@ auth.ente.yourdomain.tld {
cast.ente.yourdomain.tld {
reverse_proxy http://localhost:3004
}
# For Museum
api.ente.yourdomain.tld {
reverse_proxy http://localhost:8080
}
```
## Step 3: Start reverse proxy
## Step 3: Reload reverse proxy
Reload Caddy for changes to take effect
@@ -95,8 +95,12 @@ Reload Caddy for changes to take effect
sudo systemctl caddy reload
```
## Step 4: Verify the setup
Ente Photos web app should be up on https://web.ente.yourdomain.tld.
Museum should be accessible at https://api.ente.yourdomain.tld.
> [!TIP]
> If you are using other reverse proxy servers such as NGINX,
> Traefik, etc., please check out their documentation.

View File

@@ -3,18 +3,21 @@ title: CLI for Self Hosted Instance
description: Guide to configuring Ente CLI for Self Hosted Instance
---
## Self Hosting
# Ente CLI for self-hosted instance
If you are self-hosting the server, you can still configure CLI to export data &
perform basic admin actions.
If you are self-hosting, you can configure CLI to export data &
perform basic administrative actions.
To do this, first configure the CLI to point to your server. Define a
config.yaml and put it either in the same directory as CLI binary or path
defined in env variable `ENTE_CLI_CONFIG_DIR`
## Step 1: Configure endpoint
```yaml
To do this, first configure the CLI to use your server's endpoint.
Define `config.yaml` and place it in `~/.ente/` directory or directory
specified by `ENTE_CLI_CONFIG_DIR` or CLI's directory.
``` yaml
endpoint:
api: "http://localhost:8080"
api: http://localhost:8080
```
You should be able to
@@ -24,7 +27,7 @@ and subsequently increase the
using the CLI.
For administrative actions, you first need to whitelist admin users.
You can create `server/museum.yaml`, and whitelist add the admin userID `internal.admins`. See
You can create `server/museum.yaml`, and whitelist add the admin user ID `internal.admins`. See
[local.yaml](https://github.com/ente-io/ente/blob/main/server/configurations/local.yaml#L211C1-L232C1)
in the server source code for details about how to define this.
@@ -35,5 +38,5 @@ command to find the user id of any account.
```yaml
internal:
admins:
# - 1580559962386440
- 1580559962386440
```

View File

@@ -1,88 +0,0 @@
---
title: Server admin
description: Administering your custom self-hosted Ente instance using the CLI
---
## Becoming an admin
By default, the first user (and only the first user) created on the system is
considered as an admin.
This facility is provided as a convenience for people who are getting started
with self hosting. For more serious deployments, we recommend creating an
explicit whitelist of admins.
> [!NOTE]
>
> The first user is only treated as the admin if the list of admins in the
> configuration is empty.
>
> Also, if at some point you delete the first user, then you will need to define
> a whitelist to make some other user as the admin if you wish (since the first
> account has been deleted).
To whitelist the user IDs that can perform admin actions on the server, use the
following steps:
- Create a `museum.yaml` in the directory where you're starting museum from. For
example, if you're running using `docker compose up`, then this file should be
in the same directory as `compose.yaml` (generally, `server/museum.yaml`).
> Docker might've created an empty `museum.yaml` _directory_ on your machine
> previously. If so, delete that empty directory and create a new file named
> `museum.yaml`.
- In this `museum.yaml` we can add overrides over the default configuration.
For whitelisting the admin userIDs we need to define an `internal.admins`. See
the "internal" section in
[local.yaml](https://github.com/ente-io/ente/blob/main/server/configurations/local.yaml)
in the server source code for details about how to define this.
Here is an example. Suppose we wanted to whitelist a user with ID
`1580559962386440`, we can create the following `museum.yaml`
```yaml
internal:
admins:
- 1580559962386440
```
You can use
[account list](https://github.com/ente-io/ente/blob/main/cli/docs/generated/ente_account_list.md)
command to find the user id of any account.
# Administering your custom server
> [!NOTE] For the first user (admin) to perform administrative actions using the
> CLI, their userID must be whitelisted in the `museum.yaml` configuration file
> under `internal.admins`. While the first user is automatically granted admin
> privileges on the server, this additional step is required for CLI operations.
You can use
[Ente's CLI](https://github.com/ente-io/ente/releases?q=tag%3Acli-v0) to
administer your self hosted server.
First we need to get your CLI to connect to your custom server. Define a
config.yaml and put it either in the same directory as CLI or path defined in
env variable `ENTE_CLI_CONFIG_PATH`
```yaml
endpoint:
api: "http://localhost:8080"
```
Now you should be able to
[add an account](https://github.com/ente-io/ente/blob/main/cli/docs/generated/ente_account_add.md),
and subsequently increase the
[storage and account validity](https://github.com/ente-io/ente/blob/main/cli/docs/generated/ente_admin_update-subscription.md)
using the CLI.
> [!NOTE]
>
> The CLI command to add an account does not create Ente accounts. It only adds
> existing accounts to the list of (existing) accounts that the CLI can use.
## Backups
See this [document](/self-hosting/administration/backup).

View File

@@ -14,7 +14,7 @@ See the sidebar for existing guides. In particular:
[configure custom server].
- For various admin related tasks, e.g. increasing the storage quota on your
self hosted instance, see [administering your custom server](admin).
self hosted instance, see [administering your custom server].
- For configuring your S3 buckets to get the object storage to work from your
mobile device or for fixing an upload errors, see

View File

@@ -51,5 +51,5 @@ docker compose up --build
This builds Museum and web applications based on the Dockerfile and starts the containers needed for Ente.
::: tip
Check out [post-installation steps](/self-hosting/install/post-install) for further usage.
Check out [post-installation steps](/self-hosting/install/post-install/) for further usage.
:::

View File

@@ -31,5 +31,5 @@ The data accessed by Museum is stored in `./data` folder inside `my-ente` direct
It contains extra configuration files that is to be used (push notification credentials, etc.)
::: tip
Check out [post-installations steps](/self-hosting/install/post-install) for further usage.
Check out [post-installations steps](/self-hosting/install/post-install/) for further usage.
:::

View File

@@ -0,0 +1,10 @@
---
title: Upgrading - Self-hosting
description: Upgradation of self-hosted Ente
---
# Upgrading
A list of steps that should be done after installing Ente are described below:
## Step 1:

View File

@@ -191,5 +191,5 @@ relative to `server` directory
The web application for Ente Photos should be accessible at http://localhost:3000, check out the [default ports](/self-hosting/install/env-var#ports) for more information.
::: tip
Check out [post-installation steps](/self-hosting/install/post-install) for further usage.
Check out [post-installation steps](/self-hosting/install/post-install/) for further usage.
:::

View File

@@ -15,7 +15,7 @@ for any minor misconfigurations.
It is also suggested that the user setups bucket CORS or global CORS on MinIO or
any external S3 service provider they are connecting to. To setup bucket CORS,
please [read this](/self-hosting/troubleshooting/bucket-cors).
please [read this].
## 403 Forbidden