Skip to content

armgit / ente

Public Imported from GitHub
0

πŸ’š End-to-end encrypted cloud for everything.

4.3 KB
Raw Blame

quickstart.sh

quickstart.sh is the easiest way to try self-hosting Ente. It creates a ready-to-run Docker Compose setup from pre-built images, so you do not need to clone the repository or build anything yourself.

Copy and paste this command into a terminal:

sh -c "$(curl -fsSL https://raw.githubusercontent.com/ente/ente/main/server/quickstart.sh)"

[!TIP]

You can also download quickstart.sh first, make it executable, and then run it:

curl -o quickstart.sh https://raw.githubusercontent.com/ente/ente/main/server/quickstart.sh
chmod +x quickstart.sh
./quickstart.sh

After the services start, open Ente Photos at http://localhost:3000. Public album links are served from http://localhost:3002.

[!TIP]

Account verification codes appear in the logs. See the self-hosting documentation for other ways to retrieve them.

Details

The only requirement the script has is for a recent-ish version of Docker.

The script creates a my-ente directory in the current folder and keeps the setup files there.

[!TIP]

"Ente" (pronounced en-tay) means "mine" in Malayalam, our Founder's mother tongue (the product literally thus means "My Photos"), so our quickstart directory name my-ente means "my-my".

Inside my-ente, it creates compose.yaml and museum.yaml with fresh autogenerated credentials.

It then starts the following services. Four ports are exposed:

Service Port Notes
museum :8080 Ente's API server
web :3000 Ente Photos web app
web :3002 Ente public albums app
postgres Database
minio :3200 Object storage

Docker downloads the required images automatically the first time.

You can do a quick smoke test by pinging the API:

curl localhost:8080/ping

During the first run, the terminal continues showing logs. Press Ctrl-C to stop the services.

To start Ente again later, return to the same directory:

cd /path/to/my-ente
docker compose up

To keep the services running after closing the terminal:

cd /path/to/my-ente
docker compose up -d

To stop the services after starting them in the background:

cd /path/to/my-ente
docker compose down

Apart from this my-ente directory, the script does not install anything else on your system. Settings and credentials are saved in my-ente, while other persistent data is saved in volumes managed by Docker.

[!IMPORTANT]

Keep museum.yaml safe. It contains the unique credentials for your instance; without them, Ente cannot access the data stored in the volumes.

[!CAUTION]

If you delete the my-ente folder, the volumes will still persist. So if you want to recreate everything from scratch, you can clear these volumes by

cd /path/to/my-ente
docker compose down --volumes

Be careful to run this command in the correct directory. It permanently removes the volumes, including photos added to your self-hosted instance.

[!TIP]

If you're getting errors like pq: password authentication failed when starting museum, one possibility is that you're recreating the my-ente folder but still have leftover volumes (my-ente_postgres-data and my-ente_minio-data from a previous attempt).

Caveat

This sample setup is only intended to make it easy for people to get started. If you're intending to use your self hosted instance for serious purposes, we strongly recommend understanding all the moving parts, and consider if you should use an external object storage (S3) and database instead of the quickstart samples.

[!IMPORTANT]

Keep a plaintext backup of your photos until you are sure of what you are doing and have a backup strategy worked out.

Next steps

See ente.com/help/self-hosting for guides on connecting to your self hosted instance using your mobile app, modifying your setup to allow uploading from your mobile app, and other customizations.