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 VariableDefaultOptionsDescription
ALLOW_REGISTRATIONtruetrue, falseAllows new users to register
DB_CONNECTIONsqlitesqlite,mysql,pgsql,sqlsrvIndicates what database connection will be used
DB_HOST127.0.0.1N/ANot required if using sqlite, indicates the database host
DB_PORT3306N/ANot required if using sqlite, indicates the database port
DB_DATABASEshotshareN/ANot required if using sqlite, indicates the database database
DB_USERNAMEshotshareN/ANot required if using sqlite, indicates the database username
DB_PASSWORDnoneN/ANot required if using sqlite, indicates the database password
FEATURE_REACTIONStruetrue, falseAdds shot reactions (ability to upvote/downvote shots)
FEATURE_UUID_ROUTESfalsetrue, falseUtilizes UUIDs instead of IDs, will be the default in 2.0.0
FEATURE_FOOTERtruetrue, falseAdds credits footer ("Made with love" + "Check out source code"), leaving these should help generate additional traffic to this project, keeping it alive
HOSTlocalhostN/APublic host used by Caddy, thanks to caddy, this host will automatically be issued a SSL certificate
SHOTS_LINKS_SHARE_LINKtruetrue, falseIndicates if the "Share Link" will be displayed on the shot screen
SHOTS_LINKS_DIRECT_LINKtruetrue, falseIndicates if the "Direct Link" will be displayed on the shot screen
SHOTS_LINKS_MARKDOWN_REDDITtruetrue, falseIndicates if the "Markdown (Reddit)" link will be displayed on the shot screen
SHOTS_LINKS_MARKDOWN_OTHERtruetrue, falseIndicates if the "Markdown (GitHub & StackOverflow)" link will be displayed on the shot screen
SHOTS_LINKS_BBCODEtruetrue, falseIndicates if the "BBCode" link will be displayed on the shot screen
SHOTS_LINKS_HTMLtruetrue, falseIndicates if the "HTML" link will be displayed on the shot screen