relay-git-sync/git_connectors.example.toml at main · No-Instructions/relay-git-sync · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
# Git Connector Configuration
# Configure git repositories to sync with shared folders

# SSH known host keys for Git providers
# These are used for host verification when using SSH Git URLs
# GitHub keys are included by default, add others as needed
#
# To get host keys for other providers:
# - GitLab: ssh-keyscan gitlab.com
# - Bitbucket: ssh-keyscan bitbucket.org
# - Your server: ssh-keyscan your-git-server.com
#
# Example:
# known_hosts = [
#     "gitlab.com ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAI...",
#     "bitbucket.org ssh-rsa AAAAB3NzaC1yc2EAAAABI...",
#     "your-git-server.com ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAI..."
# ]

# Example 1: Public GitHub repository (sync to root)
[[git_connector]]
shared_folder_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"
relay_id = "6ba7b810-9dad-11d1-80b4-00c04fd430c8"
url = "https://github.com/example/repository.git"
branch = "main"
remote_name = "origin"
prefix = ""  # Sync to repository root

# Example 2: Private repository with SSH authentication (sync to subdirectory)
[[git_connector]]
shared_folder_id = "12345678-1234-5678-9abc-123456789abc"
relay_id = "6ba7b810-9dad-11d1-80b4-00c04fd430c8"
url = "git@github.com:example/private-repo.git"
branch = "develop"
remote_name = "origin"
prefix = "content/docs"  # Sync to content/docs/ subdirectory

# Example 3: GitLab repository (sync to docs folder)
[[git_connector]]
shared_folder_id = "87654321-4321-8765-cba9-987654321cba"
relay_id = "another-relay-uuid-here-12345678"
url = "https://gitlab.com/example/project.git"
branch = "main"
remote_name = "gitlab"
prefix = "documentation"  # Sync to documentation/ subdirectory

# Configuration Notes:
# - shared_folder_id: UUID of the shared folder in the relay
# - relay_id: UUID of the relay server instance
# - url: Git repository URL (supports HTTPS and SSH)
# - branch: Target branch for pushes (default: "main")
# - remote_name: Name of the git remote (default: "origin")
# - prefix: Subdirectory within repository for content (default: "", optional)
#
# Prefix Examples:
# - prefix = ""            # Sync to repository root
# - prefix = "docs"        # Sync to docs/ subdirectory
# - prefix = "content/posts" # Sync to content/posts/ subdirectory
#
# SSH Authentication:
# Set SSH_PRIVATE_KEY environment variable with your private key
# Use: python cli.py ssh show-pubkey to get the public key
#
# HTTPS Authentication:
# For private repos, you may need to embed credentials in the URL
# or configure git credentials separately