Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/LeslieLeung/reaper
REpository ArchivER(REAPER) is a tool to archive repositories from any Git servers.
https://github.com/LeslieLeung/reaper
git-backup github
Last synced: 13 days ago
JSON representation
REpository ArchivER(REAPER) is a tool to archive repositories from any Git servers.
- Host: GitHub
- URL: https://github.com/LeslieLeung/reaper
- Owner: LeslieLeung
- License: agpl-3.0
- Created: 2023-11-03T18:45:54.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-24T22:08:45.000Z (18 days ago)
- Last Synced: 2024-10-26T10:09:35.741Z (17 days ago)
- Topics: git-backup, github
- Language: Go
- Homepage:
- Size: 196 KB
- Stars: 92
- Watchers: 1
- Forks: 8
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# REAPER
English | [简体中文](README_zh.md)
REpository ArchivER(REAPER) is a tool to archive repositories from any Git servers.
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [rip](#rip)
- [run](#run)
- [bury](#bury)
- [daemon](#daemon)
- [Configuration](#configuration)
- [Storage](#storage)
- [Run as docker container](#run-as-docker-container)
- [Docker CLI](#docker-cli)
- [Docker Compose](#docker-compose)
## Features
- Archive repositories from any Git servers
- Archive repositories of a user/an organization (see [Configuration](https://github.com/LeslieLeung/reaper/wiki/Configuration#repository))
- Cron support
- Multiple storage types (see [Storage](#storage))
- Docker support (see [Run as docker container](#run-as-docker-container))
## Installation
```bash
curl -sSfL https://raw.githubusercontent.com/LeslieLeung/reaper/main/install.sh | sh -s -- -b /usr/local/bin
```
Or get from [Release](https://github.com/LeslieLeung/reaper/releases).
## Usage
You have to create a configuration file to use REAPER.
```yaml
repository:
- name: reaper
url: github.com/leslieleung/reaper
cron: "0 * * * *"
storage:
- localFile
- backblaze
useCache: True
storage:
- name: localFile
type: file
path: ./repo
- name: backblaze
type: s3
endpoint: s3.us-west-000.backblazeb2.com
region: us-west-000
bucket: your-bucket-name
accessKeyID: your-access-key-id
secretAccessKey: your-secret-access-key
```
Then you can run REAPER with the configuration file.
```bash
reaper -c config.yaml
# or simply call reaper if your configuration file is named config.yaml
reaper
```
### rip
`rip` archives a single repository defined in configuration.
```bash
reaper rip reaper
```
### run
`run` archives all repositories defined in configuration.
```bash
reaper run
```
Combined with cron, you can archive repositories periodically.
### bury
`bury` archives all release assets of a repository.
```bash
reaper bury reaper
```
### daemon
`daemon` runs REAPER as a daemon. It will archive all repositories defined in configuration periodically.
```bash
reaper daemon
# You might want to run it with something like nohup
nohup reaper daemon &
```
## Configuration
For configuration, you can check out this [example](config/example.config.yaml).
For more details, see [Configuration](https://github.com/LeslieLeung/reaper/wiki/Configuration) in wiki.
## Storage
REAPER supports multiple storage types.
- [x] File
- [x] AWS S3
## Run as docker container
### Docker CLI
One-off run.
- Change `${pwd}/config/example.config.yaml` to your config file path.
- Customize `${pwd}/repo:/repo` to be your desired storage path. The in-container path needs to be the same as the path in config file.
```bash
docker run --rm \
-v ${pwd}/config/example.config.yaml:/config.yaml \
-v ${pwd}/repo:/repo \
leslieleung/reaper:latest \
run
```
### Docker Compose
For example compose file, see [docker-compose.yml](docker-compose.yml).
```bash
docker compose up -d
```
## FAQ
See [FAQ](https://github.com/LeslieLeung/reaper/wiki/FAQ).
## Stargazers over time
[](https://starchart.cc/LeslieLeung/reaper)