thearqsz/gitsync repository overview

⁠gitsync

gitsync is a lightweight bash-based tool designed to automatically check for remote changes in a specified Git repository and pull updates if necessary. The tool is containerized using Docker, allowing easy deployment in various environments. It can be used as a module in Docker Compose setups for seamless synchronization of repositories.

⁠Table of Contents

• Features⁠
• Installation⁠
• Environment Variables⁠
• Usage with Docker Compose⁠
• License⁠

⁠Features

• Monitors a Git repository for remote changes and automatically pulls updates.
• Supports both SSH and HTTP/HTTPS Git remotes.
• Can handle private repositories with SSH keys or basic authentication.
• Easy integration into Docker Compose environments.

⁠Installation and usage

To build and run gitsync locally using Docker:

1. Clone this repository:

git clone https://github.com/TheArqsz/gitsync.git
cd gitsync

1. Build the Docker image:

docker build -t gitsync .

1. Run the container:

docker run -e BASIC_AUTH=1 -e USERNAME=YourUsername -e PASSWORD_OR_KEY_FILE=/run/secrets/password_or_key_secret -v /path/to/your/repo:/workspace -v git_password:/run/secrets/password_or_key_secret gitsync

or

docker run  -e SSH_PRIVATE_KEY_FILE=/id_rsa -v /path/to/your/repo:/workspace -v ~/.ssh/id_rsa:/id_rsa -e TIMEOUT=10 gitsync

etc.

The Docker image runs a bash script (entrypoint.sh) that will:

• Check if the provided directory is a valid Git repository.
• Fetch and pull changes from the remote repository, supporting both SSH and HTTPS remotes.
• Continuously check for updates at regular intervals defined by environment variables.

⁠Environment Variables

⁠Usage with Docker Compose

gitsync can be easily integrated as a module in a docker-compose.yml setup. Below is an example configuration:

services:
  gitsync:
    image: thearqsz/gitsync:latest
    container_name: gitsync
    volumes:
      - $HOME/example-repo:/workspace
    environment:
      - BASIC_AUTH=1
      - USERNAME=GithubUser
      - PASSWORD_OR_KEY_FILE=/run/secrets/password_or_key_secret
    secrets:
      - password_or_key_secret

secrets:
  password_or_key_secret:
    environment: PASSWORD_OR_KEY

In this example:

• The local repository at $HOME/example-repo is mounted to the container's /workspace directory.
• The necessary credentials for Git authentication (username and password/API key) are passed via Docker secrets for enhanced security.

Other examples:

• docker-compose.yml.example1⁠
• docker-compose.yml.example2⁠

⁠License

This project is licensed under the MIT License. See the LICENSE⁠ file for details.