✨feature: Add remote git support
This commit is contained in:
26
README.md
26
README.md
@@ -93,6 +93,26 @@ To stop:
|
||||
docker compose down
|
||||
```
|
||||
|
||||
#### Docker + Private Git Remote Sync
|
||||
|
||||
Ironpad can automatically sync the `data/` git repo with a private remote over SSH.
|
||||
|
||||
1. Put your SSH key files on the host (example: `./deploy/ssh/id_ed25519` and `./deploy/ssh/id_ed25519.pub`).
|
||||
2. Uncomment the SSH volume mount and git env vars in `docker-compose.yml`.
|
||||
3. Set:
|
||||
- `IRONPAD_GIT_REMOTE_URL` (example: `git@github.com:your-org/ironpad-data.git`)
|
||||
- `IRONPAD_GIT_SSH_PRIVATE_KEY` (path inside container)
|
||||
- `IRONPAD_GIT_SYNC_INTERVAL_SECS` (example: `300`)
|
||||
4. Recreate the stack:
|
||||
|
||||
```bash
|
||||
docker compose up -d --build
|
||||
```
|
||||
|
||||
Sync behavior:
|
||||
- Every cycle: `fetch -> safe fast-forward if possible -> push`
|
||||
- If local and remote diverge, auto fast-forward is skipped and a warning is logged.
|
||||
|
||||
## Tech Stack
|
||||
|
||||

|
||||
@@ -150,6 +170,12 @@ Read about the method:
|
||||
| Fixed port | disabled | Set `IRONPAD_PORT` to force a specific port |
|
||||
| Disable tray mode | `false` | Set `IRONPAD_DISABLE_TRAY=1` to run headless in production static mode |
|
||||
| Auto-commit | Every 60 seconds | Git commits when changes exist |
|
||||
| Git remote URL | not set | `IRONPAD_GIT_REMOTE_URL` creates/updates `origin` |
|
||||
| Git sync interval | `0` (disabled) | Set `IRONPAD_GIT_SYNC_INTERVAL_SECS` to enable scheduled sync |
|
||||
| Git SSH private key | not set | `IRONPAD_GIT_SSH_PRIVATE_KEY` path to private key in container |
|
||||
| Git SSH public key | not set | Optional `IRONPAD_GIT_SSH_PUBLIC_KEY` path |
|
||||
| Git SSH username | `git` | Override with `IRONPAD_GIT_SSH_USERNAME` if needed |
|
||||
| Git SSH passphrase | not set | Optional `IRONPAD_GIT_SSH_PASSPHRASE` |
|
||||
| Auto-save | 1 second debounce | Frontend saves after typing stops |
|
||||
|
||||
## Documentation
|
||||
|
||||
Reference in New Issue
Block a user