3.1 KiB
title, description
| title | description |
|---|---|
| Self Hosting | Getting started self hosting Ente Photos and/or Ente Auth |
Self Hosting
The entire source code for Ente is open source, including the servers. This is the same code we use for our own cloud service.
Tip
To get some context, you might find our blog post announcing the open sourcing of our server useful.
Getting started - Quickstart
Install Docker. Then, paste the following command in a your terminal:
sh -c "$(curl -fsSL https://raw.githubusercontent.com/ente-io/ente/main/server/quickstart.sh)"
Tip
For more details about what this does, see the quickstart README.
That's about it. If you open http://localhost:3000, you will be able to create
an account on a Ente Photos web app running on your machine, and this web app
will be connecting to the server running on your local machine at
localhost:8080. The verification code will be shown in the server logs.
For the mobile or desktop apps, you don't even need to build, and can install normal Ente apps and configure them to use your custom self-hosted server.
Getting started - From source
The quickstart method above uses pre-built images. Alternatively, if you want to build the self hosted server images from source, you can use the steps in this section.
Installing Docker
Refer to How to install Docker from the APT repository for detailed instructions.
Start the server
git clone https://github.com/ente-io/ente
cd ente/server
docker compose up --build
Install the necessary dependencies for running the web client
# installing npm and yarn
sudo apt update
sudo apt install nodejs npm
sudo npm install -g yarn // to install yarn globally
Then in a separate terminal, you can run (e.g) the web client
cd ente/web
yarn install
NEXT_PUBLIC_ENTE_ENDPOINT=http://localhost:8080 yarn dev
If you want to build the mobile apps from source, see the instructions here.
Next steps
-
More details about the server are in its README
-
More details about running the server (with or without Docker) are in RUNNING
-
If you have questions around self-hosting that are not answered in any of the existing documentation, you can ask in our GitHub Discussions. Please remember to search first if the query has been already asked and answered.
Contributing!
One particular way in which you can help is by adding new guides on this help site. The documentation is written in Markdown and adding new pages is easy. Editing existing pages is even easier: at the bottom of each page is an Edit this page link.