{"id":15089347,"url":"https://github.com/ethanc/salvage","last_synced_at":"2026-01-03T18:49:49.336Z","repository":{"id":178529360,"uuid":"652113769","full_name":"EthanC/Salvage","owner":"EthanC","description":"Backup Docker Compose files to GitHub and notify about changes.","archived":false,"fork":false,"pushed_at":"2025-03-11T07:49:51.000Z","size":128,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-11T08:34:05.134Z","etag":null,"topics":["backup","bot","compose","container","discord","docker","docker-compose","github","monitor","notifications","notifier","notify","python","script","stacks","watcher","webhook","yaml","yml"],"latest_commit_sha":null,"homepage":"https://hub.docker.com/r/ethanchrisp/salvage","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/EthanC.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yaml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"custom":["https://cash.app/$EthanChrisp","https://venmo.com/u/Mxtive"]}},"created_at":"2023-06-11T06:04:35.000Z","updated_at":"2025-03-11T07:49:54.000Z","dependencies_parsed_at":null,"dependency_job_id":"0538aece-4168-4373-8517-568a3a929e7a","html_url":"https://github.com/EthanC/Salvage","commit_stats":{"total_commits":13,"total_committers":1,"mean_commits":13.0,"dds":0.0,"last_synced_commit":"ba90e0d5483608b3f2d4e5e1abc9531831641f37"},"previous_names":["ethanc/salvage"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EthanC%2FSalvage","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EthanC%2FSalvage/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EthanC%2FSalvage/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EthanC%2FSalvage/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/EthanC","download_url":"https://codeload.github.com/EthanC/Salvage/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244814927,"owners_count":20514849,"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":["backup","bot","compose","container","discord","docker","docker-compose","github","monitor","notifications","notifier","notify","python","script","stacks","watcher","webhook","yaml","yml"],"created_at":"2024-09-25T08:45:03.684Z","updated_at":"2026-01-03T18:49:49.325Z","avatar_url":"https://github.com/EthanC.png","language":"Python","funding_links":["https://cash.app/$EthanChrisp","https://venmo.com/u/Mxtive"],"categories":[],"sub_categories":[],"readme":"# Salvage\n\n![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/EthanC/Salvage/ci.yaml?branch=main) ![Docker Pulls](https://img.shields.io/docker/pulls/ethanchrisp/salvage?label=Docker%20Pulls) ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/ethanchrisp/salvage/latest?label=Docker%20Image%20Size)\n\nSalvage backs up Docker Compose files to GitHub and notifies about changes.\n\n\u003cp align=\"center\"\u003e\n    \u003cimg src=\"https://i.imgur.com/sha3H6y.png\" draggable=\"false\"\u003e\n\u003c/p\u003e\n\n## Setup\n\nAlthough not required, a [Discord Webhook](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) is recommended for notifications.\n\nRegardless of your chosen setup method, Salvage is intended for use with a task scheduler, such as [cron](https://crontab.guru/).\n\n**Environment Variables:**\n\n-   `LOG_LEVEL`: [Loguru](https://loguru.readthedocs.io/en/stable/api/logger.html) severity level to write to the console.\n-   `LOG_DISCORD_WEBHOOK_URL`: [Discord Webhook](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) URL to receive log events.\n-   `LOG_DISCORD_WEBHOOK_LEVEL`: Minimum [Loguru](https://loguru.readthedocs.io/en/stable/api/logger.html) severity level to forward to Discord.\n-   `GITHUB_ACCESS_TOKEN` (Required): [Personal Access Token (Classic)](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#personal-access-tokens-classic) for GitHub.\n-   `GITHUB_REPOSITORY` (Required): Name of the private GitHub repository to store backups.\n-   `DISCORD_WEBHOOK_URL`: [Discord Webhook](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) URL to receive change notifications.\n-   `GLOB_PATTERNS`: Comma-separated [pathname pattern(s)](https://docs.python.org/3/library/glob.html) to match in local file discovery. Default is `**/compose.yaml`.\n-   `PROJECTS_DIRECTORY`: Directory in which projects are stored. Default is `./projects`.\n\n### Docker (Recommended)\n\nModify the following `compose.yaml` example file, then run `docker compose up`.\n\n```yaml\nservices:\n  salvage:\n    container_name: salvage\n    image: ethanchrisp/salvage:latest\n    environment:\n      LOG_LEVEL: INFO\n      LOG_DISCORD_WEBHOOK_URL: https://discord.com/api/webhooks/YYYYYYYY/YYYYYYYY\n      LOG_DISCORD_WEBHOOK_LEVEL: WARNING\n      GITHUB_ACCESS_TOKEN: XXXXXXXX\n      GITHUB_REPOSITORY: XXXXXXXX\n      DISCORD_WEBHOOK_URL: https://discord.com/api/webhooks/XXXXXXXX/XXXXXXXX\n    volumes:\n      - /home/username/projects:/salvage/projects:ro\n```\n\n### Standalone\n\nSalvage is built for [Python 3.13](https://www.python.org/) or greater.\n\n1. Install required dependencies using [uv](https://github.com/astral-sh/uv): `uv sync`\n2. Rename `.env.example` to `.env`, then provide the environment variables.\n3. Ensure the projects directory contains Docker Compose files.\n4. Start Salvage: `python salvage.py`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fethanc%2Fsalvage","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fethanc%2Fsalvage","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fethanc%2Fsalvage/lists"}