diff --git a/.env.docker b/.env.docker new file mode 100644 index 0000000000..4309285e8d --- /dev/null +++ b/.env.docker @@ -0,0 +1,72 @@ +######################################################################## +# ------------ MANDATORY (CHANGE ACCORDING TO YOUR SETUP) ------------# +######################################################################## + + +############ +# Basics # +############ + +NEXTAUTH_SECRET=RANDOM_STRING + +NEXTAUTH_URL=http://localhost:3000 + +DATABASE_URL='postgresql://postgres:postgres@postgres:5432/snoopforms?schema=public' + +################ +# Mail Setup # +################ + +# Necessary if email verification and password reset are enabled. +# See optional configurations below if you want to disable these features. + +# MAIL_FROM=noreply@example.com +# SMTP_HOST=localhost +# SMTP_PORT=1025 +# SMTP_SECURE_ENABLED=0 # Enable for TLS (port 465) +# SMTP_USER=smtpUser +# SMTP_PASSWORD=smtpPassword + + +######################################################################## +# ------------------------------ OPTIONAL -----------------------------# +######################################################################## + +# Uncomment the variables you would like to use and customize the values. + +##################### +# Disable Features # +##################### + +# Email Verification. If you enable Email Verification you have to setup SMTP-Settings, too. +EMAIL_VERIFICATION_DISABLED=1 + +# Password Reset. If you enable Password Reset functionality you have to setup SMTP-Settings, too. +PASSWORD_RESET_DISABLED=1 + +####################### +# Additional Options # +####################### + +# TERMS_URL=https://www.example.com/terms +# PRIVACY_URL=https://www.example.com/privacy +# PUBLIC_IMPRINT_URL=https://www.example.com/imprint +# PUBLIC_PRIVACY_URL=https://www.example.com/enduserPrivacy + +###################### +# Posthog Tracking # +###################### + +# POSTHOG_API_HOST=https://app.posthog.com +# POSTHOG_API_KEY= + +############### +# Telemetry # +############### + +# We also track anononymous usage telemetry on the server to improve snoopForms. +# That way we can see how many people use snoopForms. +# We can't identify you, or your users and only receive the number of submissions on your instance. +# You help us a lot, if you leave this activated. +# If you still want to opt-out, uncomment the next line. +# TELEMETRY_DISABLED=1 \ No newline at end of file diff --git a/README.md b/README.md index 06710a4140..917ddced2a 100644 --- a/README.md +++ b/README.md @@ -126,13 +126,13 @@ git clone https://github.com/formbricks/snoopforms.git && cd snoopforms ``` -Create a `.env` file based on `.env.example` and change all fields according to your setup. You need to uncomment the right line for the `DATABASE_URL` for the database connection to work. Also you need to configure the SMTP settings for the signup process with verification emails to work. If you don't have a mail server for sending email, you need to disable email verification (`EMAIL_VERIFICATION_DISABLED=1`) and password reset (`PASSWORD_RESET_DISABLED=1`). +Create a `.env` file based on `.env.docker` and change all fields according to your setup. This file comes with a basic setup and snoopForms works without making any changes to the file. To enable email sending functionality you need to configure the SMTP settings in the `.env` file. If you configured your email credentials, you can also comment the following lines to enable email verification (`# EMAIL_VERIFICATION_DISABLED=1`) and password reset (`# PASSWORD_RESET_DISABLED=1`). -Copy the `.env.example` file to `.env` and edit it with an editor of your choice. +Copy the `.env.docker` file to `.env` and edit it with an editor of your choice if needed. ``` -cp .env.example .env +cp .env.docker .env ```