Skip to content

Segelzwerg/FamilyFoto

Repository files navigation

codecov Python Check Total alerts Language grade: Python

Lines of code GitHub repo size Docker Image Size (tag) Docker Image Size (tag) GitHub release (latest by date)

FamilyFoto

A self hosting photo sharing server.

Setup

Currently we provide docker images for amd64 and arm64 architectures. They easiest way to deploy your own instance is to download one of the two docker-compose files. After that you need to create a folder where the app can store it's data. By default it execpts this path to be /media/usb /familyfoto, but you can change that by changing the path in the docker-compose file

volumes:
     - /media/usb/familyfoto:/app/instance

to

volumes:
     - /path/you/like:/app/instance

After that you can start it by

docker-compose -f docker-compose.ARCHITECTURE.yml up

with ARCHITECTURE being one of {"amd64", "arm64"}.

⚠️ This will use the latest version of Family Foto, if you want to use a specific version change the image tag in the docker-compose file to

   image: segelzwerg/family-foto:ARCH-X.X.X

However this is only supported for up from v0.3.1. All tags can be found here.

Development Setup

# Create venv
python3 -m venv venv
source venv/bin/activate
pip install -U pip setuptools wheel

# Install with 'testing' extras
pip install -e .[testing]

# Run tests
python -m pytest

Trouble Shooting

Grafana

Permission

GF_PATHS_DATA='/var/lib/grafana' is not writable.
You may have issues with file permissions, more information here: http://docs.grafana.org/installation/docker/#migration-from-a-previous-version-of-the-docker-container-to-5-1-or-later
mkdir: cannot create directory '/var/lib/grafana/plugins': Permission denied

The you try to run docker-compose with sudo. If that does not work, add folder permission to /media/usb/grafana.