Docker Compose

Quality Gate Status Discord Website GitHub contributors

Currently, the project is in very early stages; some bugs may exist. If you find any, please log an issue

Compatibility

You need a x86 processor, and it is recommended to have 8GBs of RAM.

ARM

You can run this on an ARM processor using the ARM compose templates. Due to limited ram & processing power it will not be as fast. ARM Development is still in progress - expect bugs.

ARM install instructions can be found here

Size

You will need at least 10 GB of HDD Space for the docker images. It needs that space because of the machine learning models. Librephotos will also create a database and thumbnails which will need additional space.

Docker

LibrePhotos comes with separate backend and frontend servers. The backend serves the restful API, and the frontend serves, well, the frontend. They are connected via a proxy. The easiest way to do it is using Docker.

Clone the repo: git clone https://github.com/LibrePhotos/librephotos-docker.git

Copy the template variable file (containing options such as the location of your photos): cp librephotos.env .env

Open .env in your favorite text editor and make the required changes. E.g., using nano: nano .env

Do not forget to create the directories you specified in the .env file if they do not exist.

Start LibrePhotos with docker-compose up -d

You should have LibrePhotos accessible after a few minutes of boot-up on localhost:3000 unless you changed this in the .env file. The username is admin & the password is admin unless you changed them in the .env file. It is recommended you change the admin username and password if LibrePhotos is going to be publicly accessible. This is done via the .env file.

First steps after setting up

You need to log in as the admin user, and set up the directory for the users. To do this, click the top right button, and go to Admin Area. On this page, it will show a list of users. Manually set the Scan Directory for the desired user. Only an admin can do this. Then, go to Dashboard > Library and click the green Scan photos (file system) button. If you have a Nextcloud instance, you can also input login details for it in the Dashboard > Library page. Once logged in (the little circle next to Nextcloud Scan Directory will be green), you can choose a top level directory in your logged in Nextcloud account. Once this has been configured, you can click the blue Scan photos (Nextcloud) button. This will copy the contents of the specified Nextcloud directory to the local filesystem.

The basic idea is this:

  • For scanning photos that reside in the local file system
    • Only the admin user can change the “scan directory” of the users, including the admin itself.
    • Normal users cannot change his/her own “scan directory”
    • Only the admin can find the page to control this under the “user icon (top right) - admin area”
  • For scanning photos that reside in external Nextcloud instances
    • Any user can change his/her own Nextcloud endpoint, and choose a top level directory in the Nextcloud account.

Auto scan all folders

You can start a scan with the following command:

sudo docker exec --user root CONTAINER_NAME python3 manage.py scan

You can just create a cron job to regularly call this command

# Every day at 3 AM
0 3 * * * sudo docker exec --user root CONTAINER_NAME python3 manage.py scan >/dev/null 2>&1

Contributions

  • Librephotos is in development. Contributions are welcome!
  • Join our Discord server or open a pull request to start contributing.

Updated: