mirror of
https://github.com/alexbelgium/hassio-addons.git
synced 2026-09-02 10:13:32 +02:00
a4b100feea
* fix(ente): base image moved to ghcr.io/ente/server Upstream renamed the GitHub org ente-io -> ente. github.com redirects, so the web-builder clone still worked, but GHCR does not redirect: the base image ghcr.io/ente-io/server:latest now resolves to 'not found' and every rebuild failed (run 31227202542). Points the base image and the web source clone at the new org, and lands the 4.4.25 bump the updater bot had reverted by the same failure. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * fix(ente): sync build.json and README to the renamed org, tidy changelog build.json still pinned ghcr.io/ente-io/server:927c6a31... — a dead reference after the org rename (the pinned digest does resolve under ente/server, verified 200 from the registry). It is inert today since this Dockerfile hardcodes its FROM rather than consuming ARG BUILD_FROM, but leaving a dead ref there is a trap for the next person. Also repoints the two README links and matches the changelog date format to the surrounding entries. Reported by Copilot on PR #2946. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
166 lines
7.8 KiB
Markdown
166 lines
7.8 KiB
Markdown
# Home assistant add-on: Ente
|
|
|
|
|
|
I maintain this and other Home Assistant add-ons in my free time: keeping up with upstream changes, HA changes, and testing on real hardware takes a lot of time (and some money). I use around 5-10 of my >110 addons so regularly I install test machines (and purchase some test services such as vpn) that I don't use myself to troubleshoot and improve the addons
|
|
|
|
If this add-on saves you time or makes your setup easier, I would be very grateful for your support!
|
|
|
|
[![Buy me a coffee][donation-badge]](https://www.buymeacoffee.com/alexbelgium)
|
|
[![Donate via PayPal][paypal-badge]](https://www.paypal.com/donate/?hosted_button_id=DZFULJZTP3UQA)
|
|
|
|
## Addon informations
|
|
|
|
|
|
|
|
|
|
|
|
[](https://www.codacy.com/gh/alexbelgium/hassio-addons/dashboard?utm_source=github.com&utm_medium=referral&utm_content=alexbelgium/hassio-addons&utm_campaign=Badge_Grade)
|
|
[](https://github.com/alexbelgium/hassio-addons/actions/workflows/weekly-supelinter.yaml)
|
|
[](https://github.com/alexbelgium/hassio-addons/actions/workflows/onpush_builder.yaml)
|
|
|
|
[donation-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee-%23d32f2f?logo=buy-me-a-coffee&style=flat&logoColor=white
|
|
[paypal-badge]: https://img.shields.io/badge/Donate%20via%20PayPal-0070BA?logo=paypal&style=flat&logoColor=white
|
|
|
|
_Thanks to everyone having starred my repo! To star it click on the image below, then it will be on top right. Thanks!_
|
|
|
|
[](https://github.com/alexbelgium/hassio-addons/stargazers)
|
|
|
|
|
|
|
|
## About
|
|
|
|
---
|
|
|
|
[Ente](https://github.com/ente/ente) is a self-hosted, end-to-end encrypted photo and video storage solution. This addon provides a complete Ente server setup including the museum API server and MinIO S3-compatible storage backend.
|
|
|
|
Ente offers:
|
|
- End-to-end encrypted photo and video backup
|
|
- Face recognition and search
|
|
- Cross-platform mobile and desktop apps
|
|
- Automatic photo backup from mobile devices
|
|
- Album sharing with family and friends
|
|
- Full control over your data with self-hosting
|
|
|
|
This addon is based on the official Ente server: https://github.com/ente/ente/tree/main/server
|
|
|
|
## Configuration
|
|
|
|
---
|
|
|
|
Webui can be found at <http://homeassistant:PORT>.
|
|
|
|
### Options
|
|
|
|
| Option | Type | Default | Description |
|
|
|--------|------|---------|-------------|
|
|
| `ENTE_ENDPOINT_URL` | str | `http://homeassistant.local:8280` | The URL where Ente API will be accessible (used by web UI) |
|
|
| `DB_PASSWORD` | str | `ente` | Database password for internal PostgreSQL |
|
|
| `USE_EXTERNAL_DB` | bool | `false` | Use external PostgreSQL database |
|
|
| `TZ` | str | `Europe/Paris` | Timezone setting |
|
|
|
|
### External Database Configuration
|
|
|
|
If you want to use an external PostgreSQL database, set `USE_EXTERNAL_DB: true` and configure:
|
|
|
|
| Option | Type | Description |
|
|
|--------|------|-------------|
|
|
| `DB_HOSTNAME` | str | PostgreSQL server hostname |
|
|
| `DB_PORT` | int | PostgreSQL server port (default: 5432) |
|
|
| `DB_USERNAME` | str | PostgreSQL username |
|
|
| `DB_DATABASE_NAME` | str | PostgreSQL database name |
|
|
|
|
### Example Configuration
|
|
|
|
```yaml
|
|
ENTE_ENDPOINT_URL: "http://homeassistant.local:8280"
|
|
DB_PASSWORD: "securepassword"
|
|
TZ: "America/New_York"
|
|
```
|
|
|
|
### Custom Scripts and Environment Variables
|
|
|
|
This addon supports custom scripts and environment variables through the `addon_config` mapping:
|
|
|
|
- **Custom scripts**: See [Running Custom Scripts in Addons](https://github.com/alexbelgium/hassio-addons/wiki/Running-custom-scripts-in-Addons)
|
|
- **env_vars option**: Use the add-on `env_vars` option to pass extra environment variables (uppercase or lowercase names). See https://github.com/alexbelgium/hassio-addons/wiki/Add-Environment-variables-to-your-Addon-2 for details.
|
|
|
|
### Mounting Drives
|
|
|
|
This addon supports mounting both local drives and remote SMB shares:
|
|
|
|
- **Local drives**: See [Mounting Local Drives in Addons](https://github.com/alexbelgium/hassio-addons/wiki/Mounting-Local-Drives-in-Addons)
|
|
- **Remote shares**: See [Mounting Remote Shares in Addons](https://github.com/alexbelgium/hassio-addons/wiki/Mounting-remote-shares-in-Addons)
|
|
|
|
## Installation
|
|
|
|
---
|
|
|
|
The installation of this add-on is pretty straightforward and not different in comparison to installing any other add-on.
|
|
|
|
1. Add my add-ons repository to your home assistant instance (in supervisor addons store at top right, or click button below if you have configured my HA)
|
|
[](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Falexbelgium%2Fhassio-addons)
|
|
1. Install this add-on.
|
|
1. Click the `Save` button to store your configuration.
|
|
1. Set the add-on options to your preferences
|
|
1. Start the add-on.
|
|
1. Check the logs of the add-on to see if everything went well.
|
|
|
|
## First Time Setup
|
|
|
|
---
|
|
|
|
After starting the addon for the first time:
|
|
|
|
1. Download the Ente mobile app from:
|
|
- [iOS App Store](https://apps.apple.com/app/ente-photos/id1542026904)
|
|
- [Google Play Store](https://play.google.com/store/apps/details?id=io.ente.photos)
|
|
- [F-Droid](https://f-droid.org/packages/io.ente.photos.fdroid/)
|
|
|
|
2. During app setup, select "Use custom server" and enter your addon URL: `http://your-homeassistant-ip:8280`
|
|
|
|
3. Create a new account using the mobile app
|
|
|
|
4. **Important**: Subscription codes cannot be sent by email for self-hosted instances. Check the addon logs for verification codes:
|
|
```
|
|
Verification code: xxxxxx
|
|
```
|
|
|
|
5. Use the verification code from the logs to complete account setup
|
|
|
|
## Ports
|
|
|
|
The addon exposes the following ports:
|
|
|
|
- **8300** (3000/tcp): Ente web UI
|
|
- **8305** (3005/tcp): Ente Share
|
|
- **8306** (3006/tcp): Ente Embed
|
|
- **8307** (3007/tcp): Ente Paste
|
|
- **8308** (3008/tcp): Ente Locker
|
|
- **8309** (3009/tcp): Ente Memories
|
|
- **8280** (8080/tcp): Ente API server (museum) - Main endpoint for apps
|
|
|
|
MinIO S3 is internal-only (127.0.0.1:3200) and not exposed externally since museum proxies all S3 operations.
|
|
|
|
## Data Storage
|
|
|
|
By default, photos and videos are stored in `/config/minio-data`. You can change this location using the `MINIO_DATA_LOCATION` option or mount external storage for larger capacity.
|
|
|
|
The addon includes:
|
|
- PostgreSQL database for metadata
|
|
- MinIO S3-compatible storage for actual photos/videos
|
|
- Ente museum API server for client communication
|
|
|
|
## Backup Recommendations
|
|
|
|
For data safety, regularly backup:
|
|
- `/config/minio-data` (or your custom storage location) - Contains all photos/videos
|
|
- PostgreSQL database (handled automatically by the addon)
|
|
- Addon configuration
|
|
|
|
## Support
|
|
|
|
Create an issue on github
|
|
|
|
[repository]: https://github.com/alexbelgium/hassio-addons
|
|
|