From 9efa0e7af47e016323508bec42841f37b7ea3123 Mon Sep 17 00:00:00 2001
From: Hugo SUBTIL <ext.sopra.husubtil@grandlyon.com>
Date: Mon, 12 Jul 2021 16:03:43 +0200
Subject: [PATCH] feat: add smtp documentation
---
docs/easycozy/config.md | 48 +++++++++++++++++++++++++++++++++++++++++
mkdocs.yml | 5 +++--
2 files changed, 51 insertions(+), 2 deletions(-)
create mode 100644 docs/easycozy/config.md
diff --git a/docs/easycozy/config.md b/docs/easycozy/config.md
new file mode 100644
index 0000000..0a525ca
--- /dev/null
+++ b/docs/easycozy/config.md
@@ -0,0 +1,48 @@
+# Easy Cozy configuration
+
+This section includes all configurations available for the stack.
+
+## Configuration File
+
+The configuration file of the stack is located at `.easy-cozy/cozystack/cozy.yml`. It can be edit in order to changes various parameters, smtp, logs ...
+
+## SMTP
+
+### Install a specific version of an app
+
+Modif the `cozy.yml` responsible for the configuration :
+
+```yml
+mail:
+ # mail noreply address - flags: --mail-noreply-address
+ noreply_address: noreply@localhost
+ noreply_name: My Cozy
+ reply_to: support@cozycloud.cc
+ # mail smtp host - flags: --mail-host
+ host: smtp.home
+ # mail smtp port - flags: --mail-port
+ port: 465
+ # mail smtp username - flags: --mail-username
+ username: {{.Env.COZY_MAIL_USERNAME}}
+ # mail smtp password - flags: --mail-password
+ password: {{.Env.COZY_MAIL_PASSWORD}}
+ # disable mail tls - flags: --mail-disable-tls
+ disable_tls: false
+ # skip the certificate validation (may be useful on localhost)
+ skip_certificate_validation: false
+```
+
+According to cozy-stack issue: https://github.com/cozy/cozy-stack/issues/2009 you might need to change above configuration with :
+
+```yml
+mail:
+ # mail smtp port - flags: --mail-port
+ port: 587
+ # disable mail tls - flags: --mail-disable-tls
+ disable_tls: true
+```
+
+After updating configuration don't forget to restart your cozy-stack :
+```bash
+docker-compose restart cozy
+```
diff --git a/mkdocs.yml b/mkdocs.yml
index c1c42eb..fab28c3 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -25,10 +25,11 @@ extra_css:
nav:
- Home: index.md
- Easy Cozy:
- - Scripts: easycozy/scripts.md
+ - Configuration: easycozy/config.md
- Commands: easycozy/commands.md
- - Tips: easycozy/tips.md
- Known errors: easycozy/known_errors.md
+ - Scripts: easycozy/scripts.md
+ - Tips: easycozy/tips.md
- Ecolyo:
- Introduction: ecolyo/index.md
- Getting started:
--
GitLab