From 9e7a577cb7bf9d54a2a1990f281e23255b08f06e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marius=20Andr=C3=A9=20Elsfjordstrand=20Beck?= Date: Thu, 1 Dec 2022 16:34:52 +0100 Subject: [PATCH] Update README and example config --- README.md | 26 -------------------------- exampleconfig.yaml | 2 -- 2 files changed, 28 deletions(-) diff --git a/README.md b/README.md index d139720..1b54a4e 100644 --- a/README.md +++ b/README.md @@ -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 | diff --git a/exampleconfig.yaml b/exampleconfig.yaml index 2518cc8..a4a09a3 100644 --- a/exampleconfig.yaml +++ b/exampleconfig.yaml @@ -12,8 +12,6 @@ port: 8880 path-prefix: "" # log server requests log-requests: true -# index storage engine: "badger" or "tikv" -storage-engine: badger # INDEX