ente-cloudron/README.md

Ente Cloudron App

This repository contains the Cloudron packaging for Ente, an open-source, end-to-end encrypted alternative to Google Photos and Apple Photos.

Features

• Self-host your own encrypted photo backup service
• Automatically integrates with Cloudron's PostgreSQL database
• Configured to use Cloudron's mail service for sending emails
• Easy to deploy and manage through the Cloudron interface

Building and Installing

Option 1: Build and Install Manually

1. Clone this repository:

   git clone https://github.com/yourusername/ente-cloudron.git
   cd ente-cloudron
   

2. Download the Cloudron CLI:

   npm install -g cloudron
   

3. Build the app:

   cloudron build
   

4. Install the app:

   cloudron install --app ente.yourdomain.com
   

Option 2: Install from the Cloudron App Store

Once this app is accepted into the Cloudron App Store, you can install it directly:

1. Go to your Cloudron dashboard
2. Click "App Store"
3. Search for "Ente"
4. Click "Install"

Configuration

The app is configured automatically using Cloudron's environment variables for:

• PostgreSQL database connection
• SMTP mail service
• App origin URL

Cloudron Admin Notes

After installing on Cloudron remember to:

1. Open the File Manager for the app, edit /app/data/config/s3.env with your object storage endpoint/keys, and restart the app.
2. Add alias domains for auth.<app-domain>, accounts.<app-domain>, cast.<app-domain>, albums.<app-domain> and family.<app-domain> in the Cloudron Domains tab. Create matching DNS records pointing to the primary hostname (for example, if you installed at ente.cloudron.io, add auth.ente.cloudron.io, accounts.ente.cloudron.io, etc.).
3. Use the bundled Ente CLI for admin tasks via cloudron exec --app <location> -- sudo -u cloudron ente --help. The CLI stores its state in /app/data/cli-data (exposed inside the container at /cli-data) and already trusts your app’s API endpoint. Typical workflows:

   # Whitelist an administrator (see https://ente.io/help/self-hosting/administration/users )
   cloudron exec --app ente.cloudron.io -- sudo -u cloudron ente admin user whitelist --email admin@example.com
   
   # Increase a user’s storage quota (see https://ente.io/help/self-hosting/administration/cli )
   cloudron exec --app ente.cloudron.io -- sudo -u cloudron ente admin user quota set --email user@example.com --storage-gb 500
   

The main photos UI continues to live on the hostname you selected during installation.

Usage

Web Client

After installation, you can access the Ente web client at your app's URL. Create the first user and whitelist them as an administrator using the CLI if desired.

Mobile Apps

You can use the official Ente mobile apps with your self-hosted server:

1. Download the Ente app from the App Store or Google Play
2. During login, choose "Custom Server"
3. Enter your Cloudron app URL (e.g., https://ente.yourdomain.com)

Updating

To update to a newer version:

cloudron update --app ente.yourdomain.com

License

This Cloudron package is licensed under the same license as Ente (Apache 2.0).