{"id":22441230,"url":"https://github.com/vanvanni/gorestic","last_synced_at":"2025-10-14T01:31:49.520Z","repository":{"id":266636879,"uuid":"898048037","full_name":"vanvanni/gorestic","owner":"vanvanni","description":"GORestic provides a simple dashboard for monitoring your Restic backup statistics. It offers a simple yet powerful way to track backup sizes, file counts, and snapshot statistics across multiple backup sources.","archived":false,"fork":false,"pushed_at":"2024-12-05T23:37:38.000Z","size":106,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-13T19:52:34.611Z","etag":null,"topics":["api","backup","bash","docker","golang","interface","restic","web-ui"],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vanvanni.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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,"zenodo":null}},"created_at":"2024-12-03T17:36:45.000Z","updated_at":"2025-02-01T19:03:18.000Z","dependencies_parsed_at":"2025-04-13T19:40:24.196Z","dependency_job_id":"db9ce68c-b899-49e2-bc81-17d8b5ad8576","html_url":"https://github.com/vanvanni/gorestic","commit_stats":null,"previous_names":["vanvanni/gorestic"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/vanvanni/gorestic","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vanvanni%2Fgorestic","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vanvanni%2Fgorestic/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vanvanni%2Fgorestic/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vanvanni%2Fgorestic/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vanvanni","download_url":"https://codeload.github.com/vanvanni/gorestic/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vanvanni%2Fgorestic/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279017492,"owners_count":26086083,"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","status":"online","status_checked_at":"2025-10-13T02:00:06.723Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["api","backup","bash","docker","golang","interface","restic","web-ui"],"created_at":"2024-12-06T02:13:28.535Z","updated_at":"2025-10-14T01:31:49.485Z","avatar_url":"https://github.com/vanvanni.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 📊 GORestic\nGORestic provides a simple dashboard for monitoring your Restic backup statistics. It offers a simple yet powerful way to track backup sizes, file counts, and snapshot statistics across multiple backup sources.\n\n![screenshot](.static/dashboard.png)\n\n## Features\nEvery feature in GORestic is designed with simplicity and efficiency in mind:\n\n- 📊 Real-time visualization of backup statistics\n- 📈 Historical data tracking with interactive charts\n- 🔑 Multiple API key support for different backup sources\n- 🔄 Automatic data refresh\n- 🎯 Source filtering capabilities\n- 🐳 Docker support for containerized environments\n\n## Install\n\n### Binary\nDownload and run the binary:\n\n```bash\n# Download the latest release\ncurl -L -o gorestic https://github.com/vanvanni/gorestic/releases/latest/download/gorestic\n\n# Make it executable\nchmod +x gorestic\n\n# Run it\n./gorestic\n```\n\nOn first run, GORestic will create a default configuration file at `~/.config/gorestic/config.toml`.\n\n### Docker (SOON)\nRun using Docker:\n\n```bash\ndocker run -d \\\n  --name gorestic \\\n  -p 2010:2010 \\\n  -v $HOME/.config/gorestic:/config \\\n  vanvanni/gorestic\n```\n\n## Configuration\nGORestic uses a TOML configuration file located at `~/.config/gorestic/config.toml`:\n\n```toml\n[server]\nport = 2010\nusername = 'admin'\npassword = '2cb18a05653b8cad'\n\n[storage]\npath = '/root/.config/gorestic/stats.json'\n\n[api_keys]\n[api_keys.example]\nkey = 'e20b98bf9144ad5ef093fdcdb439dedd'\nname = 'Example Backup'\ndescription = 'Default API key generated on first run'\ncreated_at = '2024-12-03'\n```\n\n### API Usage\nSend backup statistics using curl:\n\n```bash\ncurl -X POST \"http://localhost:2010/api/stats\" \\\n    -H \"X-API-Key: your-api-key\" \\\n    -H \"Content-Type: application/json\" \\\n    -d '{\n        \"total_size\": 636249527,\n        \"total_file_count\": 1842,\n        \"snapshots_count\": 1\n    }'\n```\n\n### Restic Integration\nAdd this to your backup script:\n\n```bash\n# Get statistics\nSTATS=$(restic stats --json latest)\n\n# Send to GORestic\ncurl -X POST \"http://localhost:2010/api/stats\" \\\n    -H \"X-API-Key: your-api-key\" \\\n    -H \"Content-Type: application/json\" \\\n    -d \"$STATS\"\n```\n\n## Security\n- Use HTTPS if exposing to the internet\n- Change default admin password\n- Use strong API keys\n- Keep backup statistics separate from backup data\n\n## License\nMIT License - feel free to use and modify as you like!","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvanvanni%2Fgorestic","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvanvanni%2Fgorestic","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvanvanni%2Fgorestic/lists"}