Skip to content

Commit 8672f0c

Browse files
committed
Update README
add some new information about signal handling.
1 parent 8643737 commit 8672f0c

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ want.
2525
|Config validation |X | | | |
2626
|Prometheus metrics |X | | | |
2727
|Hot config reloading |X | | | |
28-
|Force syncing without process restart | | |X | |
28+
|Force syncing without process restart |X | | | |
2929
|Add unit tests | | |X | |
3030
|Add file watching for push repos | | | |X |
3131
|Populate some cgit metadata |X | | | |
@@ -91,6 +91,15 @@ Validate your config
9191
git-sync -validate
9292
```
9393

94+
## Signals
95+
96+
You can reload the config file for your git-sync process with the use of usr1. This will validate
97+
the config before doing the reload so if you have a bad config it will just output an error but
98+
keep running with the old config.
99+
100+
If you are excited to have something pushed out or want a new update you can hit git-sync with usr2.
101+
This will cause it to sync all repositories again that it knows about.
102+
94103
## Development
95104

96105
You can use nix-shell to setup the environment that I used however using golang 1.11 and up should work fine.

0 commit comments

Comments
 (0)