{"id":26490067,"url":"https://github.com/guysoft/photoprismpi","last_synced_at":"2025-03-20T07:55:07.521Z","repository":{"id":42674642,"uuid":"237765636","full_name":"guysoft/PhotoPrismPi","owner":"guysoft","description":"An out of the box Raspberry distro based on Ubuntu with PhotoPrism installed","archived":false,"fork":false,"pushed_at":"2022-07-07T08:57:41.000Z","size":35,"stargazers_count":25,"open_issues_count":1,"forks_count":3,"subscribers_count":5,"default_branch":"devel","last_synced_at":"2024-05-01T18:57:57.447Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/guysoft.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-02-02T12:09:41.000Z","updated_at":"2023-07-24T19:39:07.000Z","dependencies_parsed_at":"2022-07-09T02:01:15.455Z","dependency_job_id":null,"html_url":"https://github.com/guysoft/PhotoPrismPi","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guysoft%2FPhotoPrismPi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guysoft%2FPhotoPrismPi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guysoft%2FPhotoPrismPi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guysoft%2FPhotoPrismPi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/guysoft","download_url":"https://codeload.github.com/guysoft/PhotoPrismPi/tar.gz/refs/heads/devel","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244574733,"owners_count":20474818,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-03-20T07:55:06.892Z","updated_at":"2025-03-20T07:55:07.510Z","avatar_url":"https://github.com/guysoft.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"PhotoPrismPi\n============\n\nAn out of the box `Raspberry Pi \u003chttp://www.raspberrypi.org/\u003e`_ Raspbian distro with `PhotoPrism \u003chttps://photoprism.org/\u003e`_ installed. \n\nPhotoPrismPi uses `CustomPiOS \u003chttps://github.com/guysoft/CustomPiOS\u003e`_, which supported building variant images and customisation.\n\nWhere to get it?\n----------------\n\nOfficial mirror is `here \u003chttp://unofficialpi.org/Distros/PhotoPrismPi\u003e`_\n\nHow to use it?\n--------------\n\n#. Unzip the image and install it to an SD card `like any other Raspberry Pi image \u003chttps://www.raspberrypi.org/documentation/installation/installing-images/README.md\u003e`_\n#. Configure your WiFi by editing ``photoprismpi-wpa-supplicant.txt`` at the root of the flashed card when using it like a flash drive\n#. Boot the Pi from the SD card\n#. Hostname is ``photoprismpi`` (not ``raspberrypi`` as usual), username: ``ubuntu`` and inital password is: ``ubuntu``\n#. After a few mintues you should be able to access ``http://photoprismpi.local/``\n#. If you attach a usb storage device it should be avilable for indexing automatically.\n#. You can change the settings of photoprism in the file located at ``/boot/firmware/docker-compose/photoprism/docker-compose.yml``\n\n\nRequirements\n------------\n* Raspberrypi 3/3B+/3A+/4B\n* 2A power supply\n\nFeatures\n--------\n\n* PhotoPrisim insatalled, upgrades automatically via docker\n* Automatically mountes media storages using fat32 and ext4 filesystems.\n\n\nDeveloping\n----------\n\nRequirements\n~~~~~~~~~~~~\n\n#. Docker or Vagrant, docker recommended\n#. Docker-compose - recommended if using docker build method, instructions assume you have it\n#. Downloaded `Ubuntu ARM 64bit image \u003chttps://wiki.ubuntu.com/ARM/RaspberryPi/\u003e`_ image.\n#. root privileges for chroot\n#. Bash\n#. sudo (the script itself calls it, running as root without sudo won't work)\n\nBuild PhotoPrismPi\n~~~~~~~~~~~~~~~~~~\n\nPhotoPrismPi can be built using docker running either on an intel or RaspberryPi (supported ones listed).\nBuild requires about 4.5 GB of free space available.\nYou can build it assuming you already have docker and docker-compose installed issuing the following commands::\n\n    \n    git clone https://github.com/guysoft/PhotoPrismPi.git\n    cd PhotoPrismPi/src/image\n    wget -c --trust-server-names 'http://cdimage.ubuntu.com/releases/eoan/release/ubuntu-19.10.1-preinstalled-server-arm64+raspi3.img.xz'\n    cd ..\n    sudo docker-compose up -d\n    sudo docker exec -it photoprismpi-build build\n    \nBuilding PhotoPrismPi Variants\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nPhotoPrismPi supports building variants, which are builds with changes from the main release build. An example and other variants are available in the folder ``src/variants/example``.\n\nTo build a variant use::\n\n    sudo docker exec -it photoprismpi-build build [Variant]\n    \nBuilding Using Vagrant\n~~~~~~~~~~~~~~~~~~~~~~\nThere is a vagrant machine configuration to let build PhotoPrismPi in case your build environment behaves differently. Unless you do extra configuration, vagrant must run as root to have nfs folder sync working.\n\nTo use it::\n\n    sudo apt-get install vagrant nfs-kernel-server\n    sudo vagrant plugin install vagrant-nfs_guest\n    sudo modprobe nfs\n    cd PhotoPrismPi/src/vagrant\n    sudo vagrant up\n\nAfter provisioning the machine, its also possible to run a nightly build which updates from devel using::\n\n    cd PhotoPrismPi/src/vagrant\n    run_vagrant_build.sh\n    \nTo build a variant on the machine simply run::\n\n    cd PhotoPrismPi/src/vagrant\n    run_vagrant_build.sh [Variant]\n\nUsage\n~~~~~\n\n#. If needed, override existing config settings by creating a new file ``src/config.local``. You can override all settings found in ``src/config``. If you need to override the path to the Raspbian image to use for building PhotoPrismPi, override the path to be used in ``ZIP_IMG``. By default, the most recent file matching ``*-raspbian.zip`` found in ``src/image`` will be used.\n#. Run ``src/build_dist`` as root.\n#. The final image will be created in ``src/workspace``\n\nCode contribution would be appreciated!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fguysoft%2Fphotoprismpi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fguysoft%2Fphotoprismpi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fguysoft%2Fphotoprismpi/lists"}