From 5156a87233ea76be724d556927892b21b7225288 Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Fri, 2 Jun 2023 18:29:27 +0300 Subject: [PATCH] Add "Email configuration" section to Infisical docs --- docs/services/infisical.md | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/docs/services/infisical.md b/docs/services/infisical.md index aac4486..29c5e7c 100644 --- a/docs/services/infisical.md +++ b/docs/services/infisical.md @@ -52,7 +52,28 @@ Hosting Infisical under a subpath (by configuring the `infisical_path_prefix` va Public registration can be enabled/disabled using the `infisical_backend_environment_variable_invite_only_signup` variable. -We recommend installing with public registration enabled at first (which is the default value for this variable), creating your first user account, and then disabling public registration by explicitly setting `infisical_backend_environment_variable_invite_only_signup` to `true`. +We recommend installing with public registration enabled at first (which is the default value for this variable), creating your first user account, and then disabling public registration by explicitly setting `infisical_backend_environment_variable_invite_only_signup` to `true`. Enabling invite-only signup requires that you configure [Email configuration](#email-configuration) + + +### Email configuration + +As described in the Infisical documentation about [Email](https://infisical.com/docs/self-hosting/configuration/email), some important functionality requires email-sending to be configured. + +Here are some additional variables you can add to your `vars.yml` file: + +```yaml +infisical_backend_environment_variable_smtp_host: smtp.example.com +infisical_backend_environment_variable_smtp_port: 587 +infisical_backend_environment_variable_smtp_secure: false + +infisical_backend_environment_variable_smtp_username: infisical@example.com +infisical_backend_environment_variable_smtp_password: '' + +infisical_backend_environment_variable_smtp_address: infisical@example.com +infisical_backend_environment_variable_smtp_name: Infisical +``` + +For additional SMTP-related variables, consult the [`defaults/main.yml` file](https://github.com/mother-of-all-self-hosting/ansible-role-infisical/blob/main/defaults/main.yml) in the [ansible-role-infisical](https://github.com/mother-of-all-self-hosting/ansible-role-infisical) Ansible role. ## Usage @@ -61,4 +82,4 @@ After installation, you can go to the Infisical URL, as defined in `infisical_ho As mentioned in [Authentication](#authentication) above, you can create the first user from the web interface. -If you'd like to prevent other users from registering, consider disabling public registration by explicitly setting `infisical_backend_environment_variable_invite_only_signup` variable to `true` in your configuration and re-running the playbook (`just install-service infisical`). +If you'd like to prevent other users from registering, consider disabling public registration as described in the [Authentication](#authentication) section and re-running the playbook (`just install-service infisical`).