🎉 monetr is going live in January of 2025!

DocumentationConfiguration

Configure

Configure your monetr installation using the following guides. monetr offers many configuration options, make sure to read the documentation of each option thoroughly before customizing monetr.

monetr is configured via a YAML file, typically located at /etc/monetr/config.yaml. This file allows many of the features that monetr offers to be tweaked and adjusted for your use case, or for development.

The root structure of this YAML file is:

config.yaml
environment: "<string>"
allowSignUp: <true|false>
 
cors: { ... }          # CORS configuration
email: { ... }         # Email/SMTP configuration
keyManagement: { ... } # KMS/Encryption configuration
links: { ... }         # Connected/Manual Links configuration
logging: { ... }       # Logging configuration
plaid: { ... }         # Plaid bank data provider configuration
postgreSql: { ... }    # Primary database configuration
reCAPTCHA: { ... }     # Anti-Bot, spam mitigation configuration
redis: { ... }         # In-memory cache configuration
security: { ... }      # Authentication, token configuration
sentry: { ... }        # Error/trace reporting configuration
server: { ... }        # HTTP/listener configuration
storage: { ... }       # File/object storage
NameTypeDefaultDescription
environmentStringdevelopmentEnvironment name, used by the Sentry integration.
allowSignUpBooleantrueAre people allowed to create new users on the server?

The two values that are at the root level of the configuration can also be specified via the following environment variables:

VariableConfig File Field
MONETR_ENVIRONMENTenvironment
MONETR_ALLOW_SIGN_UPallowSignUp

Each of the sub-configurations noted above are documented in more detail in the following guides: