diff --git a/doc/book/connect/apps/index.md b/doc/book/connect/apps/index.md index a533ca60..ffd387a4 100644 --- a/doc/book/connect/apps/index.md +++ b/doc/book/connect/apps/index.md @@ -572,7 +572,7 @@ Other configuration options can be found in the ## Ente -Ente is an alternative for Google Photos and Apple Photos. It can be selfhosted and is working fine with Garage. +Ente is an alternative for Google Photos and Apple Photos. It [can be selfhosted](https://help.ente.io/self-hosting/) and is working fine with Garage as of May 2024. As a first step we need to create a bucket and a key for Ente: ```bash @@ -588,8 +588,8 @@ export CORS='{"CORSRules":[{"AllowedHeaders":["*"],"AllowedMethods":["GET"],"All aws s3api put-bucket-cors --bucket ente --cors-configuration $CORS ``` -Now we need to configure ente-server to use our bucket. -Prepare a configuration file for ente `museum.yaml` +Now we need to configure ente-server to use our bucket. This is explained [in the Ente S3 documentation](https://help.ente.io/self-hosting/guides/external-s3). +Prepare a configuration file for ente's backend as `museum.yaml`: ```yaml credentials-file: /credentials.yaml @@ -598,35 +598,66 @@ apps: internal: hardcoded-ott: local-domain-suffix: "@example.com" # Your domain - local-domain-value: 123456 # Custom OTP since not sending mail by default + local-domain-value: 123456 # Custom One-Time Password since we are not sending mail by default key: - encryption: yvmG/RnzKrbCb9L3mgsmoxXr9H7i2Z4qlbT0mL3ln4w= # You might want to change those next 3 which are the default one - hash: KXYiG07wC7GIgvCSdg+WmyWdXDAn6XKYJtp/wkEU7x573+byBRAYtpTP0wwvi8i/4l37uicX1dVTUzwH3sLZyw== # Someone has made an image that can do it for you : https://github.com/EdyTheCow/ente-selfhost/blob/main/images/ente-server-tools/Dockerfile + # You might want to change those next 3 which are the default one + encryption: yvmG/RnzKrbCb9L3mgsmoxXr9H7i2Z4qlbT0mL3ln4w= + # Someone has made an image that can do it for you : https://github.com/EdyTheCow/ente-selfhost/blob/main/images/ente-server-tools/Dockerfile + hash: KXYiG07wC7GIgvCSdg+WmyWdXDAn6XKYJtp/wkEU7x573+byBRAYtpTP0wwvi8i/4l37uicX1dVTUzwH3sLZyw== jwt: - secret: i2DecQmfGreG6q1vBj5tCokhlN41gcfS2cjOs9Po-u8= # Simply build it yourself or run docker run --rm ghcr.io/edythecow/ente-server-tools go run tools/gen-random-keys/main.go + # Simply build it yourself or run docker run --rm ghcr.io/edythecow/ente-server-tools go run tools/gen-random-keys/main.go + secret: i2DecQmfGreG6q1vBj5tCokhlN41gcfS2cjOs9Po-u8= ``` -Full configuration file can be found [here](https://github.com/ente-io/ente/blob/main/server/configurations/local.yaml) - -Prepare a credentials file for ente `credentials.yaml` +The full configuration file can be found [here](https://github.com/ente-io/ente/blob/main/server/configurations/local.yaml) +Then prepare a credentials file as `credentials.yaml` ```yaml db: host: postgres port: 5432 - name: ente_db - user: pguser - password: pgpass + name: + user: + password: s3: - are_local_buckets: true ## Put that to false if you want to use https - b2-eu-cen: ## Don't change this key it seems to be hardcoded - key: keyID - secret: keySecret + # Override the primary and secondary hot storage. The commented out values + # are the defaults. + # + hot_storage: + primary: b2-eu-cen + # secondary: wasabi-eu-central-2-v3 + + # If true, enable some workarounds to allow us to use a local minio instance + # for object storage. + # + # 1. Disable SSL. + # 2. Use "path" style S3 URLs (see `use_path_style_urls` below). + # 3. Directly download the file during replication instead of going via the + # Cloudflare worker. + # 4. Do not specify storage classes when uploading objects (since minio does + # not support them, specifically it doesn't support GLACIER). + are_local_buckets: true + + # To use "path" style S3 URLs instead of DNS-based bucket access + # default to true if you set "are_local_buckets: true" + # use_path_style_urls: true + + b2-eu-cen: # Don't change this key, it seems to be hardcoded + key: + secret: endpoint: garage:3900 - region: region - bucket: bucketName + region: garage + bucket: use_path_style: true + # you can specify secondary locations, names are hardcoded as well + # wasabi-eu-central-2-v3: + # scw-eu-fr-v3: + + # and you can also specify a bucket to be used for embeddings, preview etc.. + # default to the first bucket + # derived-storage: wasabi-eu-central-2-derived + ``` Finally you can run it with Docker : @@ -637,7 +668,6 @@ docker run -d --name ente-server --restart unless-stopped -v /path/to/museum.yam For more information on deployment you can check the [ente documentation](https://help.ente.io/self-hosting/) - ## Pixelfed [Pixelfed Technical Documentation > Configuration](https://docs.pixelfed.org/technical-documentation/env.html#filesystem)