feat: add docs for setting ENCRYPTION_KEY in .env in contributing guide (#1088)

Co-authored-by: Matthias Nannt <mail@matthiasnannt.com>
This commit is contained in:
Shubham Palriwala
2023-10-11 14:54:28 +05:30
committed by GitHub
parent 311df18315
commit 820680d7e7
2 changed files with 20 additions and 6 deletions
+9 -6
View File
@@ -15,6 +15,15 @@ SURVEY_BASE_URL=http://localhost:3000/i
# Set this if you want to have a shorter link for surveys
SHORT_SURVEY_BASE_URL=
# Encryption keys
# Please set both for now, we will change this in the future
# You can use: `openssl rand -base64 16` to generate one
FORMBRICKS_ENCRYPTION_KEY=
# You can use: `openssl rand -base64 24` to generate one
ENCRYPTION_KEY=
##############
# DATABASE #
##############
@@ -93,12 +102,6 @@ GOOGLE_CLIENT_SECRET=
# Cron Secret
CRON_SECRET=
# Encryption key
# You can use: `openssl rand -base64 16` to generate one
FORMBRICKS_ENCRYPTION_KEY=
# You can use: `openssl rand -base64 24` to generate one
ENCRYPTION_KEY=
# Configure this when you want to ship JS & CSS files from a complete URL instead of the current domain
# ASSET_PREFIX_URL=
@@ -53,6 +53,17 @@ To get the project running locally on your machine you need to have the followin
</CodeGroup>
1. Generate a secret value mandatory to be set for the key ENCRYPTION_KEY in the .env file. You can use the following command to generate the random string of required length:
<CodeGroup title="Set value of ENCRYPTION_KEY">
```bash
openssl rand -base64 24
```
</CodeGroup>
1. Make sure you have [`Docker`](https://docs.docker.com/compose/) & [`docker-compose`](https://docs.docker.com/compose/) installed and running on your machine. Then run the following command to start the formbricks dev setup:
<CodeGroup title="Start Formbricks Dev Setup">