GitSync

This project is functional but under development !

GitSync is a comprehensive tool designed to automate the synchronization of multiple Git repositories. It provides a robust solution for periodically updating repositories based on various triggers, such as new commits, specific commit patterns, or regular intervals. GitSync also includes a web interface for managing repositories, updating configuration parameters, and viewing repository details.

Features

• Automatic Repository Updates:

  • Update repositories periodically based on a specified interval.
  • Update repositories when new commits are pushed.
  • Update repositories based on specific commit message patterns.
  • Run custom commands after updating repositories.
  • ntfy notification when repository is updated.

• Web Interface:

  • View and manage repositories.
  • Change repository parameters.
  • Add new repositories by scann.
  • Delete repositories.
  • Update GitHub access tokens.
  • Information of Repositories.
  • Scan your system to find new repositories.
  • Configure ntfy notification.

• Logging:

  • Detailed logging of update actions.
  • Separate logs for informational messages, errors, and actions.

Prerequisites

• Docker and Docker Compose installed on your system.
• GitHub access token with appropriate permissions.
• Debian or Ubuntu operating system.
• Git installed on your system.
• python3
• pip3

Setup

Step 1: Clone the Repository

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

Step 3: Start gitsync

Run the following command to start the containers:

chmod +x start.sh
./start.sh

This will start the web service (React frontend and Node.js backend) and the gitsync service (Python script for syncing repositories).

Step 4: Access the Web Interface

Open your browser and go to http://localhost:9002 to access the GitSync web interface.

Chang web port

edit docker-compose.yml

nano docker-compose.yml

and replace first 9002 to your port, ex:

- "your_new_port:don't_chnage_this_port"
- "8080:9002"

Usage

Web Interface

1. Put your acces token:

   • click "Create new token"
   • configure your token with the appropriate permissions (min: repo full, user full)
   • copy your token and paste it in the box below
   • click "Save"

2. View Repositories:

   • See a list of all configured repositories.
   • Click on a repository to view its details and branches.

3. Update Repository Parameters:

   • Modify branch, update interval, update on new push, update on commit pattern, and run command.
   • Save changes to apply the new configuration.

4. Add New Repository:

   • Use the "Scan repo" to add a new repository.

5. Delete Repository:

   • Remove a repository from the configuration.

6. Update GitHub Token:

   • Change the GitHub access token if needed.

Logging

• Info Log: /gitsync/data/info.log
• Error Log: /gitsync/data/error.log
• Action Log: /gitsync/data/action.log

These logs provide detailed information about the synchronization process, including any errors that occur.

Source code

See the source code of the GitSync project on dev branch.

Contact

For any questions or issues, please open an issue on the GitHub repository or send mail to hugo.bunelier54@gmail.com.