Foxnouns.NET/Foxnouns.Backend/config.example.ini

; The host the server will listen on
Host = localhost
; The port the server will listen on
Port = 6000
; The base *external* URL
BaseUrl = https://pronouns.localhost
; The base URL for media, without a trailing slash. This must be publicly accessible.
MediaBaseUrl = https://cdn-staging.pronouns.localhost

[Logging]
; The level to log things at. Valid settings: Verbose, Debug, Information, Warning, Error, Fatal
LogEventLevel = Debug
; The URL to the Seq instance (optional)
SeqLogUrl = http://localhost:5341
; The Sentry DSN to log to (optional)
SentryUrl = https://examplePublicKey@o0.ingest.sentry.io/0
; Whether to trace performance with Sentry (optional)
SentryTracing = true
; Percentage of performance traces to send to Sentry (optional). Defaults to 0.0 (no traces at all)
SentryTracesSampleRate = 1.0
; Whether to log SQL queries. Note that this is very verbose. Defaults to false.
LogQueries = false
; Whether metrics are enabled. If this is set to true, Foxnouns.NET will rely on Prometheus scraping metrics to update stats.
; If set to false, a background service will be used instead. Does not actually disable the /metrics endpoint.
; Defaults to false.
EnableMetrics = true
; The port the /metrics endpoint will listen on. Defaults to 5001.
MetricsPort = 5001

[Database]
; The database URL in ADO.NET format.
Url = "Host=localhost;Database=foxnouns_net;Username=pronouns;Password=pronouns"
; Whether to enable connection pooling. This should be turned off if using pgbouncer. Defaults to true.
EnablePooling = true
; The timeout for opening new connections. Defaults to 5.
Timeout = 5
; The maximum number of open connections. Defaults to 50.
MaxPoolSize = 50

[Storage]
Endpoint = <s3EndpointHere>
AccessKey = <s3AccessKey>
SecretKey = <s3SecretKey>
Bucket = pronounscc

[EmailAuth]
; The address that emails will be sent from. If not set, email auth is disabled.
From = noreply@accounts.pronouns.cc

; The Coravel mail driver configuration. Keys should be self-explanatory.
[Coravel:Mail]
Host = localhost
Port = 1025
Username = smtp-username
Password = smtp-password

[DiscordAuth]
ClientId = <clientIdHere>
ClientSecret = <clientSecretHere>
init 2024-05-27 15:53:54 +02:00			`; The host the server will listen on`
			`Host = localhost`
			`; The port the server will listen on`
fix: replace port 5000 in example docs with port 6000 macOS runs a service on port 5000 by default. this doesn't actually prevent the backend server from starting, or the rate limiter proxy from working, but it does mean that when the backend restarts, if the proxy sends a request, it will stop working until it's restarted. the easiest way to work around this is by just changing the port the backend listens on. this does not change the ports used in the docker configuration. 2024-12-25 20:03:15 +01:00			`Port = 6000`
init 2024-05-27 15:53:54 +02:00			`; The base external URL`
			`BaseUrl = https://pronouns.localhost`
feat: add PATCH request support, expand PATCH /users/@me, serialize enums correctly 2024-07-12 17:12:24 +02:00			`; The base URL for media, without a trailing slash. This must be publicly accessible.`
			`MediaBaseUrl = https://cdn-staging.pronouns.localhost`
init 2024-05-27 15:53:54 +02:00
too many things to list (notably, user avatar update) 2024-07-08 19:03:04 +02:00			`[Logging]`
init 2024-05-27 15:53:54 +02:00			`; The level to log things at. Valid settings: Verbose, Debug, Information, Warning, Error, Fatal`
too many things to list (notably, user avatar update) 2024-07-08 19:03:04 +02:00			`LogEventLevel = Debug`
			`; The URL to the Seq instance (optional)`
init 2024-05-27 15:53:54 +02:00			`SeqLogUrl = http://localhost:5341`
too many things to list (notably, user avatar update) 2024-07-08 19:03:04 +02:00			`; The Sentry DSN to log to (optional)`
			`SentryUrl = https://examplePublicKey@o0.ingest.sentry.io/0`
			`; Whether to trace performance with Sentry (optional)`
			`SentryTracing = true`
			`; Percentage of performance traces to send to Sentry (optional). Defaults to 0.0 (no traces at all)`
			`SentryTracesSampleRate = 1.0`
feat: add deleted user columns in database 2024-07-13 03:09:00 +02:00			`; Whether to log SQL queries. Note that this is very verbose. Defaults to false.`
			`LogQueries = false`
feat: add actual metrics using prometheus-net 2024-09-03 17:00:14 +02:00			`; Whether metrics are enabled. If this is set to true, Foxnouns.NET will rely on Prometheus scraping metrics to update stats.`
			`; If set to false, a background service will be used instead. Does not actually disable the /metrics endpoint.`
			`; Defaults to false.`
			`EnableMetrics = true`
			`; The port the /metrics endpoint will listen on. Defaults to 5001.`
feat(backend): start work on metrics 2024-07-13 17:23:52 +02:00			`MetricsPort = 5001`
init 2024-05-27 15:53:54 +02:00
			`[Database]`
			`; The database URL in ADO.NET format.`
			`Url = "Host=localhost;Database=foxnouns_net;Username=pronouns;Password=pronouns"`
feat(backend): add option to disable postgres connection pooling 2024-09-10 18:52:13 +02:00			`; Whether to enable connection pooling. This should be turned off if using pgbouncer. Defaults to true.`
			`EnablePooling = true`
init 2024-05-27 15:53:54 +02:00			`; The timeout for opening new connections. Defaults to 5.`
			`Timeout = 5`
			`; The maximum number of open connections. Defaults to 50.`
feat: add debug registration endpoint, fix snowflake serialization 2024-06-04 17:38:59 +02:00			`MaxPoolSize = 50`
feat(backend): start authentication controllers 2024-06-12 03:47:20 +02:00
too many things to list (notably, user avatar update) 2024-07-08 19:03:04 +02:00			`[Storage]`
			`Endpoint = <s3EndpointHere>`
			`AccessKey = <s3AccessKey>`
			`SecretKey = <s3SecretKey>`
			`Bucket = pronounscc`

start (actual) email auth, add CancellationToken to most async methods 2024-09-09 14:37:59 +02:00			`[EmailAuth]`
			`; The address that emails will be sent from. If not set, email auth is disabled.`
			`From = noreply@accounts.pronouns.cc`

			`; The Coravel mail driver configuration. Keys should be self-explanatory.`
feat(backend): email registration 2024-09-10 02:39:07 +02:00			`[Coravel:Mail]`
start (actual) email auth, add CancellationToken to most async methods 2024-09-09 14:37:59 +02:00			`Host = localhost`
			`Port = 1025`
			`Username = smtp-username`
			`Password = smtp-password`

feat(backend): start authentication controllers 2024-06-12 03:47:20 +02:00			`[DiscordAuth]`
			`ClientId = <clientIdHere>`
			`ClientSecret = <clientSecretHere>`