From adb77d9a11019dcc0ae919907d4120f44a5c243d Mon Sep 17 00:00:00 2001 From: Dmitry Verkhoturov Date: Wed, 11 May 2022 19:35:45 +0200 Subject: [PATCH] sync server parameters with their description --- backend/app/cmd/server.go | 8 +++---- .../docs/configuration/parameters/index.md | 21 +++++++++++++++---- 2 files changed, 21 insertions(+), 8 deletions(-) diff --git a/backend/app/cmd/server.go b/backend/app/cmd/server.go index 3f081d1c..9dab9ef1 100644 --- a/backend/app/cmd/server.go +++ b/backend/app/cmd/server.go @@ -77,7 +77,7 @@ type ServerCommand struct { RestrictedWords []string `long:"restricted-words" env:"RESTRICTED_WORDS" description:"words prohibited to use in comments" env-delim:","` RestrictedNames []string `long:"restricted-names" env:"RESTRICTED_NAMES" description:"names prohibited to use by user" env-delim:","` EnableEmoji bool `long:"emoji" env:"EMOJI" description:"enable emoji"` - SimpleView bool `long:"simpler-view" env:"SIMPLE_VIEW" description:"minimal comment editor mode"` + SimpleView bool `long:"simple-view" env:"SIMPLE_VIEW" description:"minimal comment editor mode"` ProxyCORS bool `long:"proxy-cors" env:"PROXY_CORS" description:"disable internal CORS and delegate it to proxy"` AllowedHosts []string `long:"allowed-hosts" env:"ALLOWED_HOSTS" description:"limit hosts/sources allowed to embed comments"` SubscribersOnly bool `long:"subscribers-only" env:"SUBSCRIBERS_ONLY" description:"enable commenting only for Patreon subscribers"` @@ -155,7 +155,7 @@ type ImageGroup struct { } `group:"fs" namespace:"fs" env-namespace:"FS"` Bolt struct { File string `long:"file" env:"FILE" default:"./var/pictures.db" description:"images bolt file location"` - } `group:"bolt" namespace:"bolt" env-namespace:"bolt"` + } `group:"bolt" namespace:"bolt" env-namespace:"BOLT"` MaxSize int `long:"max-size" env:"MAX_SIZE" default:"5000000" description:"max size of image file"` ResizeWidth int `long:"resize-width" env:"RESIZE_WIDTH" default:"2400" description:"width of a resized image"` ResizeHeight int `long:"resize-height" env:"RESIZE_HEIGHT" default:"900" description:"height of a resized image"` @@ -170,7 +170,7 @@ type AvatarGroup struct { } `group:"fs" namespace:"fs" env-namespace:"FS"` Bolt struct { File string `long:"file" env:"FILE" default:"./var/avatars.db" description:"avatars bolt file location"` - } `group:"bolt" namespace:"bolt" env-namespace:"bolt"` + } `group:"bolt" namespace:"bolt" env-namespace:"BOLT"` URI string `long:"uri" env:"URI" default:"./var/avatars" description:"avatars store URI"` RszLmt int `long:"rsz-lmt" env:"RESIZE" default:"0" description:"max image size for resizing avatars on save"` } @@ -237,7 +237,7 @@ type NotifyGroup struct { Webhook struct { URL string `long:"url" env:"URL" description:"webhook URL for admin notifications"` Template string `long:"template" env:"TEMPLATE" description:"webhook authentication template" default:"{\"text\": \"{{.Text}}\"}"` - Headers []string `long:"headers" description:"webhook authentication headers in format --notify.webhook.headers=Header1:Value1,Value2,..."` // env NOTIFY_WEBHOOK_HEADERS split in code bellow to allow , inside "" + Headers []string `long:"headers" description:"webhook authentication headers in format --notify.webhook.headers=Header1:Value1,Value2,... [$NOTIFY_WEBHOOK_HEADERS]"` // env NOTIFY_WEBHOOK_HEADERS split in code bellow to allow , inside "" Timeout time.Duration `long:"timeout" env:"TIMEOUT" description:"webhook timeout" default:"5s"` } `group:"webhook" namespace:"webhook" env-namespace:"WEBHOOK"` } diff --git a/site/src/docs/configuration/parameters/index.md b/site/src/docs/configuration/parameters/index.md index 1c3c61b7..c9bf6f5c 100644 --- a/site/src/docs/configuration/parameters/index.md +++ b/site/src/docs/configuration/parameters/index.md @@ -40,6 +40,15 @@ services: | store.type | STORE_TYPE | `bolt` | type of storage, `bolt` or `rpc` | | store.bolt.path | STORE_BOLT_PATH | `./var` | parent directory for the bolt files | | store.bolt.timeout | STORE_BOLT_TIMEOUT | `30s` | boltdb access timeout | +| store.rpc.api | STORE_RPC_API | | rpc extension api url | +| store.rpc.timeout | STORE_RPC_TIMEOUT | | http timeout (default: 5s) | +| store.rpc.auth_user | STORE_RPC_AUTH_USER | | basic auth user name | +| store.rpc.auth_passwd | STORE_RPC_AUTH_PASSWD | | basic auth user password | +| admin.type | ADMIN_TYPE | `shared` | type of admin store, `shared` or `rpc` | +| admin.rpc.api | ADMIN_RPC_API | | rpc extension api url | +| admin.rpc.timeout | ADMIN_RPC_TIMEOUT | | http timeout (default: 5s) | +| admin.rpc.auth_user | ADMIN_RPC_AUTH_USER | | basic auth user name | +| admin.rpc.auth_passwd | ADMIN_RPC_AUTH_PASSWD | | basic auth user password | | admin.shared.id | ADMIN_SHARED_ID | | admin IDs (list of user IDs), _multi_ | | admin.shared.email | ADMIN_SHARED_EMAIL | `admin@${REMARK_URL}` | admin emails, _multi_ | | backup | BACKUP_PATH | `./var/backup` | backups location | @@ -53,13 +62,17 @@ services: | avatar.fs.path | AVATAR_FS_PATH | `./var/avatars` | avatars location for `fs` store | | avatar.bolt.file | AVATAR_BOLT_FILE | `./var/avatars.db` | avatars `bolt` file location | | avatar.uri | AVATAR_URI | `./var/avatars` | avatars store URI | -| avatar.rsz-lmt | AVATAR_RSZ_LMT | `0` (disabled) | max image size for resizing avatars on save | +| avatar.rsz-lmt | AVATAR_RESIZE | `0` (disabled) | max image size for resizing avatars on save | | image.type | IMAGE_TYPE | `fs` | type of image storage, `fs`, `bolt` | -| image.max-size | IMAGE_MAX_SIZE | `5000000` | max size of image file | | image.fs.path | IMAGE_FS_PATH | `./var/pictures` | permanent location of images | | image.fs.staging | IMAGE_FS_STAGING | `./var/pictures.staging` | staging location of images | | image.fs.partitions | IMAGE_FS_PARTITIONS | `100` | number of image partitions | | image.bolt.file | IMAGE_BOLT_FILE | `/var/pictures.db` | images bolt file location | +| image.rpc.api | IMAGE_RPC_API | | rpc extension api url | +| image.rpc.timeout | IMAGE_RPC_TIMEOUT | | http timeout (default: 5s) | +| image.rpc.auth_user | IMAGE_RPC_AUTH_USER | | basic auth user name | +| image.rpc.auth_passwd | IMAGE_RPC_AUTH_PASSWD | | basic auth user password | +| image.max-size | IMAGE_MAX_SIZE | `5000000` | max size of image file | | image.resize-width | IMAGE_RESIZE_WIDTH | `2400` | width of a resized image | | image.resize-height | IMAGE_RESIZE_HEIGHT | `900` | height of a resized image | | auth.ttl.jwt | AUTH_TTL_JWT | `5m` | JWT TTL | @@ -97,7 +110,7 @@ services: | notify.webhook.template | NOTIFY_WEBHOOK_TEMPLATE | `{"text": "{{.Text}}"}` | Webhook payload template | | notify.webhook.headers | NOTIFY_WEBHOOK_HEADERS | | HTTP header in format Header1:Value1,Header2:Value2,... | | notify.webhook.timeout | NOTIFY_WEBHOOK_TIMEOUT | `5s` | Webhook connection timeout | -| notify.email.fromAddress | NOTIFY_EMAIL_FROM | | from email address | +| notify.email.from_address | NOTIFY_EMAIL_FROM | | from email address | | notify.email.verification_subj | NOTIFY_EMAIL_VERIFICATION_SUBJ | `Email verification` | verification message subject | | telegram.token | TELEGRAM_TOKEN | | Telegram token (used for auth and Telegram notifications) | | telegram.timeout | TELEGRAM_TIMEOUT | `5s` | Telegram connection timeout | @@ -106,7 +119,7 @@ services: | smtp.username | SMTP_USERNAME | | SMTP user name | | smtp.password | SMTP_PASSWORD | | SMTP password | | smtp.tls | SMTP_TLS | `false` | enable TLS for SMTP | -| smtp.starttls | SMTP_STARTTLS | `false` | enable StartTLS for SMTP | +| smtp.starttls | SMTP_STARTTLS | `false` | enable StartTLS for SMTP | | smtp.timeout | SMTP_TIMEOUT | `10s` | SMTP TCP connection timeout | | ssl.type | SSL_TYPE | none | `none`-HTTP, `static`-HTTPS, `auto`-HTTPS + le | | ssl.port | SSL_PORT | `8443` | port for HTTPS server |