Commit ead75f7d authored by Richard Glosner's avatar Richard Glosner
Browse files

Merge branch 'update-env-docs' into 'main'

Update env docs

See merge request inject/frontend!362
parents 520bcf6b bb93324b
Loading
Loading
Loading
Loading
+3 −0
Original line number Diff line number Diff line
@@ -32,6 +32,8 @@ INJECT_SECRET_KEY=your-at-least-fifty-or-more-characters-long-secret-key

- INJECT_DOMAIN: Defines the hostname for the Nginx server. This should be set to the **domain name** that points to your server's IP address.
- INJECT_SECRET_KEY: Used to provide cryptographic signing. Must be at least 50 characters long. Can be anything.
- INJECT_LINK: The URL (link) of the deployed instance fo the INJECT platform with used protocol (http or https). The following URL is an example: _https://my-inject-domain.com_. This link is used in the welcome email.
- INJECT_MAX_UPLOAD_SIZE: Specifies the maximum body size of requests, including file uploads. The unit of this variable is bytes. The default value is set to 10MB (10485760 bytes).

#### Authentication, Authorization and Identification (AAI)

@@ -57,6 +59,7 @@ INJECT_EMAIL_PROTOCOL=
- INJECT_EMAIL_HOST_PASSWORD: Password for the SMTP server.
- INJECT_EMAIL_SENDER_ADDRESS: Email address used as the sender for outgoing emails.
- INJECT_EMAIL_PROTOCOL: Preferred protocol for communication with SMTP server. The choices (values) can be _ssl_ or _tls_ (case insensitive). This variable can also be left undefined - no encryption will be used. Please note, that setting of `INJECT_EMAIL_PROTOCOL` does not automatically set the port and port must be always set.
- INJECT_EMAIL_TIMEOUT: Specifies a timeout in seconds for blocking operations tied to emails like the connection attempt to SMTP. The default value is 10 seconds.

In the current release, AAI can be disabled by setting `INJECT_NOAUTH` to any arbitrary value. 
This feature will be deprecated in upcoming release.
+1 −0
Original line number Diff line number Diff line
@@ -18,6 +18,7 @@ INJECT_EMAIL_HOST_USER=
INJECT_EMAIL_HOST_PASSWORD=
INJECT_EMAIL_SENDER_ADDRESS=
INJECT_EMAIL_PROTOCOL=
INJECT_LINK=http://${INJECT_DOMAIN}/

# enable logging to a specific file
# INJECT_LOGS=data/
+1 −0
Original line number Diff line number Diff line
@@ -18,6 +18,7 @@ INJECT_EMAIL_HOST_USER=
INJECT_EMAIL_HOST_PASSWORD=
INJECT_EMAIL_SENDER_ADDRESS=
INJECT_EMAIL_PROTOCOL=
INJECT_LINK=https://${INJECT_DOMAIN}/

# enable logging to a specific file
# INJECT_LOGS=data/
+1 −0
Original line number Diff line number Diff line
@@ -18,6 +18,7 @@ INJECT_EMAIL_HOST_USER=
INJECT_EMAIL_HOST_PASSWORD=
INJECT_EMAIL_SENDER_ADDRESS=
INJECT_EMAIL_PROTOCOL=
INJECT_LINK=https://${INJECT_DOMAIN}/

# enable logging to a specific file
# INJECT_LOGS=data/