danieloliver / bardview5 Goto Github PK

The BardView5 Server application uses Gin. Currently CORS is set using gin-contrib/cors default.

For the convenience of anyone who wishes to do the extra configuration, CORS should be configurable from environment variables. If none set, default should be the fallback.

1. Disabled by default.
2. Enabled by configuration flag.
3. Add probes and establish criteria.

https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/

Database migrations should be aggregated into versions.

1. Add documentation for how to condense migration files for a versioned release.
2. Add documentation for creating a new migration file
3. Aggregate existing migration files into a versioned migration file for 0000001 release.

An example configuration and any code updates required to enable BardView5 to run with Ory Kratos using OAuth2 and OIDC would enable more deployment and self-hosted flexibility and options.

Dnd5e Monster user tags should become a json object in the database so that more advanced scenarios of tagging, filtering, sorting can be enabled later.

The API exposed should remain a string array. The keys stored in the json object should become the set of elements exposed in the string array. Any elements in the string array should be stored as empty json keys.

The BardView5 Server application uses Gin. Currently when running behind a proxy, Gin trusts all proxies by default which is unsafe.

For the convenience and security of anyone who is willing to do the extra configuration when hosting BV5 themselves, the trusted proxies using Gin's SetTrustedProxies should be configurable from environment variables. If none set, default of trusting all should be the fallback.

For the safety and convenience of anyone who wishes to have insights and visibility into the application performance, Prometheus endpoint should be disabled by default and then a configurable environment variable should be able to enable Prometheus endpoint.