Skip to content

Commit 6e6348e

Browse files
committed
feat(docs): update sample.env with full documentation
1 parent 6de64b4 commit 6e6348e

1 file changed

Lines changed: 90 additions & 5 deletions

File tree

‎sample.env‎

Lines changed: 90 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,96 @@
1-
FRIENDLY_CAPTCHA_SITE_KEY=ABCD1234…
2-
FRIENDLY_CAPTCHA_API_KEY=EFGH5678…
1+
# This file is the minimal configuration file used by Dotenv to define the
2+
# environment variables on localhost.
3+
#
4+
# Instructions:
5+
# 1. copy this file as `.env`
6+
# 2. edit the `.env` file with working values
7+
# 3. uncomment the lines to activate or configure associated features
8+
#
9+
# Sections:
10+
# - friendly captcha
11+
# - freescout
12+
# - emailing
313

4-
FREESCOUT_API_URL=<Use your freescout instance URL here, e.g. https://freescout.example.pix.net>
5-
FREESCOUT_API_KEY=<follow instructions at https://api-docs.freescout.net/>
14+
# =======
15+
# FRIENDLY CAPTCHA
16+
# =======
617

18+
# Site key provided by Friendly Captcha (account needs to be created). Used to render captcha.
19+
#
20+
# If not present, captcha verification will be skipped.
21+
#
22+
# presence: optional
23+
# type: String
24+
FRIENDLY_CAPTCHA_SITE_KEY=SITEKEY123456
25+
26+
# API key provided by Friendly Captcha (account needs to be created). Used to verify captcha
27+
# when submitting form.
28+
#
29+
# Needs to be present if FRIENDLY_CAPTCHA_SITE_KEY is present. Error will be thrown
30+
# when submitting form if not present.
31+
#
32+
# presence: optional but mandatory if FRIENDLY_CAPTCHA_SITE_KEY is present
33+
# type: String
34+
FRIENDLY_CAPTCHA_API_KEY=APIKEY123456
35+
36+
# Url to Freescout API
37+
#
38+
# If not present, no conversation will be created to Freescout when submitting forms of type "freescout sending".
39+
# An error will be displayed in console.
40+
#
41+
# presence: optional
42+
# type: Url
43+
FREESCOUT_API_URL=https://freescout.example.pix.net
44+
45+
# API key required to call Freescout API
46+
#
47+
# If not present, no conversation will be created to Freescout when submitting forms of type "freescout sending".
48+
# An error will be displayed in console.
49+
#
50+
# presence: optional but mandatory if FREESCOUT_API_URL is present
51+
# type: String
52+
FREESCOUT_API_KEY=1234
53+
54+
# =======
55+
# Emailing
56+
# =======
57+
58+
# SMTP host Url for mail server
59+
#
60+
# If not present, submitting forms of type "email sending" will throw an error.
61+
#
62+
# presence: required
63+
# type: Url
764
SMTP_HOST=localhost
65+
66+
# SMTP Port for mail server
67+
#
68+
# If not present, submitting forms of type "email sending" will throw an error.
69+
#
70+
# presence: required
71+
# type: Number
872
SMTP_PORT=1025
73+
74+
# SMTP Secure for mail server
75+
#
76+
# If not present, submitting forms of type "email sending" will throw an error.
77+
#
78+
# presence: required
79+
# type: Boolean
980
SMTP_SECURE=false
81+
82+
# SMTP User for mail server
83+
#
84+
# If not present, submitting forms of type "email sending" will throw an error.
85+
#
86+
# presence: required
87+
# type: String
1088
SMTP_USER=root
11-
SMTP_PASS=pass
89+
90+
# SMTP Password for mail server
91+
#
92+
# If not present, submitting forms of type "email sending" will throw an error.
93+
#
94+
# presence: required
95+
# type: String
96+
SMTP_PASS=pass

0 commit comments

Comments
 (0)