Configuration Options
Note: These are not all of the configuration options, only the most used ones, feel free to open a PR if you see any missing. For a more in-depth look at all the available options check out here.
Environment Variable | Default | Options | Description |
---|---|---|---|
ALLOW_REGISTRATION | true | true , false | Allows new users to register |
DB_CONNECTION | sqlite | sqlite ,mysql ,pgsql ,sqlsrv | Indicates what database connection will be used |
DB_HOST | 127.0.0.1 | N/A | Not required if using sqlite , indicates the database host |
DB_PORT | 3306 | N/A | Not required if using sqlite , indicates the database port |
DB_DATABASE | shotshare | N/A | Not required if using sqlite , indicates the database database |
DB_USERNAME | shotshare | N/A | Not required if using sqlite , indicates the database username |
DB_PASSWORD | none | N/A | Not required if using sqlite , indicates the database password |
FEATURE_REACTIONS | true | true , false | Adds shot reactions (ability to upvote/downvote shots) |
FEATURE_UUID_ROUTES | false | true , false | Utilizes UUIDs instead of IDs, will be the default in 2.0.0 |
FEATURE_FOOTER | true | true , false | Adds credits footer ("Made with love" + "Check out source code"), leaving these should help generate additional traffic to this project, keeping it alive |
HOST | localhost | N/A | Public host used by Caddy, thanks to caddy, this host will automatically be issued a SSL certificate |
SHOTS_LINKS_SHARE_LINK | true | true , false | Indicates if the "Share Link" will be displayed on the shot screen |
SHOTS_LINKS_DIRECT_LINK | true | true , false | Indicates if the "Direct Link" will be displayed on the shot screen |
SHOTS_LINKS_MARKDOWN_REDDIT | true | true , false | Indicates if the "Markdown (Reddit)" link will be displayed on the shot screen |
SHOTS_LINKS_MARKDOWN_OTHER | true | true , false | Indicates if the "Markdown (GitHub & StackOverflow)" link will be displayed on the shot screen |
SHOTS_LINKS_BBCODE | true | true , false | Indicates if the "BBCode" link will be displayed on the shot screen |
SHOTS_LINKS_HTML | true | true , false | Indicates if the "HTML" link will be displayed on the shot screen |