Skip to content

Commit 0eaa243

Browse files
Update README.md
1 parent 2511caa commit 0eaa243

1 file changed

Lines changed: 17 additions & 1 deletion

File tree

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ services:
1717
environment:
1818
ENDPOINT: https://mydomain.com/ENDPOINT
1919
ENDPOINT_KEY: MY_VERY_SECURE_KEY
20+
ALIVE_UPDATE_INTERVAL: 60
2021
SERVER_NAME: server-1
2122
volumes:
2223
- /var/run/docker.sock:/var/run/docker.sock
@@ -99,7 +100,22 @@ If no Key is provided ServDiscovery will leave out the Authorization Header.
99100

100101
### DISCOVERY_INTERVAL
101102

102-
The Discovery Interval sets the Interval of which ServDiscovery will update the Endpoint, etc.
103+
The Discovery Interval sets the Interval (in seconds) of which ServDiscovery will update the provided Endpoint.
104+
105+
Default: `60`
106+
107+
### FULL_DISCOVERY_INTERVAL
108+
109+
Sets the Interval for Full Disoveries.
110+
This tells ServDiscovery to send a Full Update of all the activate Containers in the `added` JSON Key.
111+
112+
> [!IMPORTANT]
113+
> Must be set to a **fraction of** DISCOVERY_INTERVAL.
114+
> (example: `DISCOVERY_INTERVAL * 2`)
115+
> `FULL_DISCOVERY_INTERVAL / DISCOVERY_INTERVAL` must result in an int.
116+
> `FULL_DISCOVERY_INTERVAL` must be bigger than `DISCOVERY_INTERVAL`.
117+
118+
Default: **Disabled**
103119

104120
## Contributing
105121

0 commit comments

Comments
 (0)