Docs/docs/api/configuration.md
profitroll 7c5dd326bd
All checks were successful
Tests / test (3.10) (push) Successful in 9s
Tests / test (3.11) (push) Successful in 8s
Tests / test (3.9) (push) Successful in 8s
Tests / test (3.10) (pull_request) Successful in 9s
Tests / test (3.11) (pull_request) Successful in 9s
Tests / test (3.9) (pull_request) Successful in 9s
Added index and API docs. Fixed accent color
2024-05-13 23:41:45 +02:00

656 B

API configuration

The API server stores all config keys in JSON format in the file config.json located under the project's root. On this page you can find all config sections and keys that can be set.

database

Configuration section where all database-related keys are stored.

name

MongoDB database name.

Defaults to: "garbage_api"

host

MongoDB database host.

Defaults to: "127.0.0.1"

port

MongoDB database port.

Defaults to: 27017

user

MongoDB database user. Can be string or null.

Defaults to: null

password

MongoDB database password. Can be string or null.

Defaults to: null