diff --git a/README.md b/README.md index 2589cb7..d0019ae 100644 --- a/README.md +++ b/README.md @@ -74,18 +74,18 @@ go run ./cmd/dcbot/main.go db create go migration 1 Configuration options can be specified via environment variables. -| Env variable | Default | Description | -|--------------------------------|-----------------|----------------------------------------------------------------------------------------------------------------| -| ``APP_MODE`` | ``development`` | Whether to use development or production settings | -| ``DB_DSN`` | | **Required.** Syntax: ``postgres://user:password@host:5432/db?sslmode=disable``. Only Postgres is supported. | -| ``DB_MAX_OPEN_CONNECTIONS`` | ``5`` | Maximum number of open connections to the database (https://pkg.go.dev/database/sql#DB.SetMaxOpenConns) | -| ``DB_MAX_IDLE_CONNECTIONS`` | ``2`` | Maximum number of connections in the idle connection pool (https://pkg.go.dev/database/sql#DB.SetMaxIdleConns) | -| ``DB_CONNECTION_MAX_LIFETIME`` | ``3m`` | Maximum amount of time a connection may be reused (https://pkg.go.dev/database/sql#DB.SetConnMaxLifetime) | -| ``TWHELP_URL`` | | **Required.** API URL (e.g. https://tribalwarshelp.com) | -| ``TWHELP_TIMEOUT`` | ``10s`` | Time limit for requests to TWHelp | -| ``BOT_TOKEN`` | | **Required.** https://discord.com/developers/docs/topics/oauth2#bots | -| ``BOT_MAX_GROUPS_PER_SERVER`` | ``10`` | Max number of groups per server | -| ``BOT_MAX_MONITORS_PER_GROUP`` | ``10`` | Max number of monitors per group | +| Env variable | Default | Description | +|--------------------------------|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ``APP_MODE`` | ``development`` | Whether to use development or production settings | +| ``DB_DSN`` | | **Required.** Only Postgres is supported. Example: ``postgres://user:password@host:5432/dbname?sslmode=disable`` (https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING) | +| ``DB_MAX_OPEN_CONNECTIONS`` | ``5`` | Maximum number of open connections to the database (https://pkg.go.dev/database/sql#DB.SetMaxOpenConns) | +| ``DB_MAX_IDLE_CONNECTIONS`` | ``2`` | Maximum number of connections in the idle connection pool (https://pkg.go.dev/database/sql#DB.SetMaxIdleConns) | +| ``DB_CONNECTION_MAX_LIFETIME`` | ``3m`` | Maximum amount of time a connection may be reused (https://pkg.go.dev/database/sql#DB.SetConnMaxLifetime) | +| ``TWHELP_URL`` | | **Required.** API URL (e.g. https://tribalwarshelp.com) | +| ``TWHELP_TIMEOUT`` | ``10s`` | Time limit for requests to TWHelp | +| ``BOT_TOKEN`` | | **Required.** https://discord.com/developers/docs/topics/oauth2#bots | +| ``BOT_MAX_GROUPS_PER_SERVER`` | ``10`` | Max number of groups per server | +| ``BOT_MAX_MONITORS_PER_GROUP`` | ``10`` | Max number of monitors per group | ## License