{"id":26490107,"url":"https://github.com/guysoft/backupfriendpi","last_synced_at":"2025-03-20T07:55:16.808Z","repository":{"id":48429034,"uuid":"321435033","full_name":"guysoft/BackupFriendPi","owner":"guysoft","description":"A raspsberrypi distro you can put in your friend's house, or anywhere else, and it will let you backup your computer with history","archived":false,"fork":false,"pushed_at":"2021-07-26T20:46:29.000Z","size":44,"stargazers_count":9,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"devel","last_synced_at":"2024-05-01T18:56:47.839Z","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-12-14T18:18:07.000Z","updated_at":"2022-09-22T02:22:41.000Z","dependencies_parsed_at":"2022-09-10T00:23:29.400Z","dependency_job_id":null,"html_url":"https://github.com/guysoft/BackupFriendPi","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%2FBackupFriendPi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guysoft%2FBackupFriendPi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guysoft%2FBackupFriendPi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guysoft%2FBackupFriendPi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/guysoft","download_url":"https://codeload.github.com/guysoft/BackupFriendPi/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:16.350Z","updated_at":"2025-03-20T07:55:16.797Z","avatar_url":"https://github.com/guysoft.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"BackupFriendPi\n==============\n\nAn out of the box `Raspberry Pi \u003chttp://www.raspberrypi.org/\u003e`_ Raspbian distro that runs `BackupFriend \u003chttps://github.com/guysoft/BackupFriend-docker\u003e`_ using Docker and Nginx-proxy as a reverse proxy, with letsencrypt.\nBackupFriend lets you put a Raspberry Pi in your friend and family, or anywhere else, and backup your files with history, and then access them over a web service, or by physically taking the drive back.\n\nWhere to get it?\n----------------\n\nOfficial mirror is `here \u003chttp://unofficialpi.org/Distros/BackupFriendPi\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 ``backupfriendpi-wpa-supplicant.txt`` at the root of the flashed card when using it like a flash drive\n\n#. ssh to sync rdiff-backup is at port at 8022: http://backupfriend:8022\n#. Boot the Pi from the SD card\n#. Hostname is ``backupfriend`` (not ``raspberrypi`` as usual), username: ``pi`` and inital password is: ``raspberry``\n#. After a few mintues you should be able to access `http://backupfriend/ \u003chttp://backupfriend/\u003e`_ or `http://backupfriend.local \u003chttp://backupfriend.local/\u003e`_.\n#. Default password for the Web UI is ``admin`` password ``admin123``.\n\nConfiguration notes\n-------------------\n* Configure the BackFriend server settings are at ``/boot/docker-compose/02_backupfriend/docker-compose.yml``\n* rdiffweb instance also avilable port 8082: http://backupfriend:8082\n* You can change the settings of the Backupfriend/nginx-proxy stack in the files located at ``/boot/docker-compose/backupfriend/`` and ``/boot/docker-compose/01_nginx-proxy/``.\n\nRequirements\n------------\n* A domain pointing to your Pi's IP.\n* 2A power supply\n* RaspberryPi 2, 3B, 3B+, 4B (not 1 and zero)\n\nFeatures\n--------\n\n* `Backupfriend-docker \u003chttps://github.com/guysoft/BackupFriend-docker\u003e`_ Pre-installed using docker\n* Nginx-proxy to manage reverse proxy and certificates if you have a domain to set up (optional, but recommended)\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 `Raspberry Pi OS \u003chttps://downloads.raspberrypi.org/raspios_lite_armhf/images/\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 BackupFriendPi\n~~~~~~~~~~~~~~~~~~~~\n\nBackupFriendPi 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/BackupFriendPi.git\n    cd BackupFriendPi/src/image\n    wget -c --trust-server-names 'https://downloads.raspberrypi.org/raspios_lite_armhf_latest'\n    cd ..\n    sudo docker-compose up -d\n    sudo docker exec -it backupfriendpi-build build\n    \nBuilding BackupFriendPi Variants\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nBackupFriendPi 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 backupfriendpi-build build [Variant]\n    \nBuilding Using Vagrant\n~~~~~~~~~~~~~~~~~~~~~~\nThere is a vagrant machine configuration to let build BackupFriendPi 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 BackupFriendPi/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 BackupFriendPi/src/vagrant\n    run_vagrant_build.sh\n    \nTo build a variant on the machine simply run::\n\n    cd BackupFriendPi/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 BackupFriendPi, 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%2Fbackupfriendpi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fguysoft%2Fbackupfriendpi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fguysoft%2Fbackupfriendpi/lists"}