https://github.com/eikoshelev/git-sync
Keeps local repository up to date
https://github.com/eikoshelev/git-sync
clone docker fetch git git-sync golang pull synchronization
Last synced: 5 months ago
JSON representation
Keeps local repository up to date
- Host: GitHub
- URL: https://github.com/eikoshelev/git-sync
- Owner: eikoshelev
- Created: 2018-09-20T01:06:00.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-04-19T06:41:23.000Z (over 2 years ago)
- Last Synced: 2024-06-20T15:46:27.273Z (over 1 year ago)
- Topics: clone, docker, fetch, git, git-sync, golang, pull, synchronization
- Language: Go
- Homepage:
- Size: 19.2 MB
- Stars: 6
- Watchers: 0
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# git-sync
> **Warning**
> The use of flags is deprecated! All configuration using environment variables only!
:recycle: Easy to use and stable update of your repository.
### Description
Real-time local repository update (every N time):
0. `Auth` - Authorization by HTTP (login/password) or SSH (private key);
1. `Clone` - When starting, it checks the presence of the repository at the specified path (if the repository already exists, it starts checking for updates, if not, it will first clone);
2. `Fetch` - Checks repository updates every N time;
3. `Pull` - As soon as the remote repository is updated - makes pull in the specified directory.
### Build and run locally
```bash
git clone https://github.com/eikoshelev/git-sync.git
```
```bash
cd git-sync && go build ./cmd/git-sync
```
```bash
./git-sync
```
### Docker container
You can run it like this:
```bash
docker run -d --name git-sync eikoshelev/git-sync:v2.0.0
```
..or build your own container:
```bash
git clone https://github.com/eikoshelev/git-sync.git
```
```bash
cd git-sync && docker build -t eikoshelev/git-sync:v2.0.0 --platform / .
```
### Usage
| **Environment variable** | **Description** |
| :--- | :--- |
|`GSYNC_REPO_URL` | URL to remote repository, example: `git@github.com:eikoshelev/git-sync.git` (SSH),`https://github.com/eikoshelev/git-sync.git` (HTTP)
|`GSYNC_REPO_LOCAL_PATH` | Path to local directory for repository: `/path/to/your/local/directory`
|`GSYNC_FETCH_TIMEOUT` | Timeout for check update (fetch), default `5m`, for example `1s`, `2m`, `3h`, etc.
|`GSYNC_SSH_KEY_PATH` | Path to **private SSH key** for auth to the remote repository, default `/$HOME/.ssh/id_rsa`
|`GSYNC_SSH_KNOWN_HOSTS` | Path to **known_hosts** file for work with remote repository, default `/$HOME/.ssh/known_hosts`
|`GSYNC_HTTP_LOGIN` | Login for HTTP auth to the remote repository
|`GSYNC_HTTP_PASSWORD` | Password for HTTP auth to the remote repository
|`GSYNC_FORCE_PULL` | Forced pull with changed local repository: allowed - `true`, not allowed - `false` (default)
|`GSYNC_REPO_BRANCH` | Remote branch for pull, for example: `main`, `develop`, etc. **NOTE: If the 'tag' is specified, the 'branch' will be ignored!**
|`GSYNC_REPO_TAG` | Remote tag for clone, for example: `"v1.0.0"`, `"v2.0-rc"`, `"v3.0-stable"`, etc. **NOTE: If the 'tag' is specified, the specified 'branch' will be ignored!**
### What else?
Open an issue or PR if you have more suggestions, questions or ideas about what to add.