Skip to content

Commit

Permalink
Update README and example config
Browse files Browse the repository at this point in the history
  • Loading branch information
@maeb
maeb committed Dec 8, 2022
1 parent 6ef0747 commit 9e7a577
Show file tree
Hide file tree
Showing 2 changed files with 0 additions and 28 deletions.
26 changes: 0 additions & 26 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,29 +28,3 @@ following the steps described in
golangci-lint's [local installation](https://golangci-lint.run/usage/install/#local-installation) guide. Note that on **linux** the guide expects you to have `$GOPATH/bin` included in your `PATH` variable.

golangci-lint run -E "bodyclose" -E "dogsled" -E "durationcheck" -E "errorlint" -E "forcetypeassert" -E "noctx" -E "exhaustive" -E "exportloopref" --timeout 3m0s

## Configuration

gowarcserver can be configured with a config file, environment variables and flags. Flags has precedence over
environment variables that has precedence over config file entries. An environment variable match the uppercased flag
name with underscore in place of dash.

| Name | Type | Description | Default | Sub command |
| ------------- | ------------- | ----------- | ------- | ------- |
| config | string | Path to configuration file | ./config.yaml | global |
| log-level | string | Log level. Legal values are "trace" , "debug", "info", "warn" or "error" | "info" | global |
| port | int | Server port | 9999 | serve |
| index | bool | Enable indexing when running server | true | serve |
| watch | bool | Update index when files change | false | serve |
| log-requests | bool | Enable request logging | false | serve |
| dirs | list of paths | Comma separated list of directories to index | ["."] | index, serve |
| db-dir | path | Location of index database | "." | index, serve |
| max-depth | int | Maximum index recursion depth | 4 | index, serve |
| include | list of suffixes | Only index files that match one of these suffixes | [] | index, serve |
| workers | int | Number of index workers | 8 | index, serve |
| compression | string | Database compression type. Legal values are: 'none', 'snappy', 'zstd' | "snappy" | index, serve |
| bloom | bool | Enable bloom filter when indexing with "toc" format | true | index |
| bloom-capacity | uint | Estimated bloom filter capacity | 1000 | index |
| bloom-fp | float64 | Estimated bloom filter false positive rate | 0.01 | index |
| child-urls | []string | Urls pointing to other gowarcserver processes running a server | [] | proxy |
| child-query-timeout | Duration | Child query timeout a request to a child can take before resulting in timeout | 300ms | proxy |
2 changes: 0 additions & 2 deletions exampleconfig.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@ port: 8880
path-prefix: ""
# log server requests
log-requests: true
# index storage engine: "badger" or "tikv"
storage-engine: badger

# INDEX

Expand Down

0 comments on commit 9e7a577

Please sign in to comment.