Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mishamyrt/rakun
🦝 A utility that syncs remote data to the local storage
https://github.com/mishamyrt/rakun
github-api nas
Last synced: 16 days ago
JSON representation
🦝 A utility that syncs remote data to the local storage
- Host: GitHub
- URL: https://github.com/mishamyrt/rakun
- Owner: mishamyrt
- License: gpl-3.0
- Created: 2022-05-09T08:48:35.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2022-05-14T23:22:14.000Z (over 2 years ago)
- Last Synced: 2024-12-31T07:30:24.009Z (24 days ago)
- Topics: github-api, nas
- Language: Go
- Homepage:
- Size: 33.2 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Rakun
Utility that synchronizes data from different services to local storage. It was developed because of concerns about blocking the GitHub account.
The first time you run the utility, it will download all available data. On subsequent runs it will only download what has been updated.
## Build
To build for all available platforms, run the `make` command.
```sh
make all
```
If you need only one particular platform, you can build it this way:
```sh
# make build///rakun
# For example, building arm32 binary for Zyxel NAS
make build/linux/arm32/rakun
```
The available build targets can be found in the [Makefile](./Makefile).
## Configuration
The utility loads configuration from a yaml file. The default is to check `config.yaml` in the current directory. To specify a custom configuration path, run the utility with the -c` flag.
```sh
rakun -c my_config.yaml
```
### Structure
```yaml
path: /local/path/where/repos/will/be/stored
git:
- https://github.com/mishamyrt/git-sync # Single repo from any Git server
- https://gitlab.com/mishamyrt/old_site
github:
users: # List of users whose repositories will be synchronized
- mishamyrt
organizations: # List of organizations whose repositories will be synchronized
- Paulownia-Group
token: your_github_access_token
ignore: # Ignore some repos
- mishamyrt/X01BD-kernel
- mishamyrt/X01BD-device
```
## Credits
* Raccoon Icon — [Sergey Chikin](http://sergeychikin.ru/)