From cdeb1f8ed9997788381a27f1267534181f950755 Mon Sep 17 00:00:00 2001 From: LRVT <21357789+l4rm4nd@users.noreply.github.com> Date: Mon, 20 Jul 2026 17:42:16 +0200 Subject: [PATCH] Create env.example --- examples/kutt/env.example | 49 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 examples/kutt/env.example diff --git a/examples/kutt/env.example b/examples/kutt/env.example new file mode 100644 index 0000000..9291f65 --- /dev/null +++ b/examples/kutt/env.example @@ -0,0 +1,49 @@ +DOCKER_VOLUME_STORAGE=/mnt/docker-volumes + +# Required in production +KUTT_JWT_SECRET=replace-with-a-long-random-secret + +# General configuration +KUTT_SITE_NAME=Kutt +KUTT_DEFAULT_DOMAIN=kutt.example.com +KUTT_LINK_LENGTH=6 +#KUTT_LINK_CUSTOM_ALPHABET=abcdefghkmnpqrstuvwxyzABCDEFGHKMNPQRSTUVWXYZ23456789 + +# Authentication and registration +KUTT_DISALLOW_REGISTRATION=true +KUTT_DISALLOW_LOGIN_FORM=false +KUTT_DISALLOW_ANONYMOUS_LINKS=true + +# Proxy and HTTPS configuration +KUTT_TRUST_PROXY=true +KUTT_CUSTOM_DOMAIN_USE_HTTPS=true + +# Rate limiting +KUTT_ENABLE_RATE_LIMIT=true + +# Optional server information shown in the UI +#KUTT_SERVER_IP_ADDRESS=1.2.3.4 +#KUTT_SERVER_CNAME_ADDRESS=custom.kutt.example.com + +# Email configuration +KUTT_MAIL_ENABLED=false +#KUTT_MAIL_HOST=mail.example.com +#KUTT_MAIL_PORT=587 +#KUTT_MAIL_USER=kutt@example.com +#KUTT_MAIL_PASSWORD=replace-with-mail-password +#KUTT_MAIL_FROM=kutt@example.com +#KUTT_MAIL_SECURE=false + +# OpenID Connect configuration +KUTT_OIDC_ENABLED=false +#KUTT_OIDC_ISSUER=https://auth.example.com/realms/example +#KUTT_OIDC_POMPT=login +#KUTT_OIDC_CLIENT_ID=kutt +#KUTT_OIDC_CLIENT_SECRET=replace-with-oidc-client-secret +#KUTT_OIDC_SCOPE=openid profile email +#KUTT_OIDC_EMAIL_CLAIM=email +#KUTT_OIDC_BUTTON_TEXT=Log in with OIDC + +# Reporting and contact information +#KUTT_REPORT_EMAIL=reports@example.com +#KUTT_CONTACT_EMAIL=support@example.com