Add info for automatic indexing to Readme

This commit is contained in:
Seednode 2024-01-30 04:38:29 -06:00
parent c87453d2f8
commit 36e813aa2d
1 changed files with 2 additions and 0 deletions

View File

@ -67,6 +67,8 @@ This will slightly increase the delay before the application begins responding t
The index can be regenerated at any time by accessing the `/index/rebuild` endpoint. The index can be regenerated at any time by accessing the `/index/rebuild` endpoint.
Automatic index rebuilds can be enabled via the `--index-interval` flag, which accepts [time.Duration](https://pkg.go.dev/time#ParseDuration) strings.
If `--index-file` is set, the index will be loaded from the specified file on start, and written to the file whenever it is re-generated. If `--index-file` is set, the index will be loaded from the specified file on start, and written to the file whenever it is re-generated.
The index file consists of (optionally compressed) [gobs](https://pkg.go.dev/encoding/gob). The index file consists of (optionally compressed) [gobs](https://pkg.go.dev/encoding/gob).