doc: Mise à jour readme lancement en mode readonly #5
2
.gitignore
vendored
2
.gitignore
vendored
@ -1,5 +1,5 @@
|
|||||||
/release
|
/release
|
||||||
/data
|
data/fakesmtp.db
|
||||||
/vendor
|
/vendor
|
||||||
/bin
|
/bin
|
||||||
/node_modules
|
/node_modules
|
||||||
|
74
README.md
74
README.md
@ -58,15 +58,15 @@ data:
|
|||||||
|
|
||||||
# Configuration du relais SMTP
|
# Configuration du relais SMTP
|
||||||
relay:
|
relay:
|
||||||
enabled: false # Activer/désactiver le relais SMTP
|
enabled: false # Activer/désactiver le relais SMTP
|
||||||
address: "" # Adresse du serveur au format "host:port"
|
address: "" # Adresse du serveur au format "host:port"
|
||||||
identity: "" # Identité du compte utilisateur, peut être laissé vide
|
identity: "" # Identité du compte utilisateur, peut être laissé vide
|
||||||
username: "" # Identifiant du compte SMTP, non utilisé sur anonymous = true
|
username: "" # Identifiant du compte SMTP, non utilisé sur anonymous = true
|
||||||
password: "" # Mot de passe du compte SMTP, non utilisé sur anonymous = true
|
password: "" # Mot de passe du compte SMTP, non utilisé sur anonymous = true
|
||||||
anonymous: false # Utiliser le mode d'authentification "anonyme"
|
anonymous: false # Utiliser le mode d'authentification "anonyme"
|
||||||
useTLS: false # Utiliser TLS pour se connecter au serveur SMTP
|
useTLS: false # Utiliser TLS pour se connecter au serveur SMTP
|
||||||
insecureSkipVerify: true # Ne pas vérifier le certificat du serveur pour les connexions TLS/STARTTLS
|
insecureSkipVerify: true # Ne pas vérifier le certificat du serveur pour les connexions TLS/STARTTLS
|
||||||
fromOverride: "" # Surcharger l'adresse émetteur des courriels transmis
|
fromOverride: "" # Surcharger l'adresse émetteur des courriels transmis
|
||||||
```
|
```
|
||||||
|
|
||||||
### Variables d'environnement
|
### Variables d'environnement
|
||||||
@ -75,30 +75,38 @@ La configuration de FakeSMTP peut être personnalisée via des variables d'envir
|
|||||||
|
|
||||||
Les valeurs des variables d'environnement surchargent les valeurs présentes dans le fichier de configuration.
|
Les valeurs des variables d'environnement surchargent les valeurs présentes dans le fichier de configuration.
|
||||||
|
|
||||||
|Variable|Correspondance dans le fichier de configuration|
|
| Variable | Correspondance dans le fichier de configuration |
|
||||||
|--------|-----------------------------------------------|
|
| ------------------------------------- | ----------------------------------------------- |
|
||||||
|`FAKESMTP_HTTP_ADDRESS`|`http.address`|
|
| `FAKESMTP_HTTP_ADDRESS` | `http.address` |
|
||||||
|`FAKESMTP_HTTP_TEMPLATEDIR`|`http.templateDir`|
|
| `FAKESMTP_HTTP_TEMPLATEDIR` | `http.templateDir` |
|
||||||
|`FAKESMTP_HTTP_PUBLICDIR`|`http.publicDir`|
|
| `FAKESMTP_HTTP_PUBLICDIR` | `http.publicDir` |
|
||||||
|`FAKESMTP_SMTP_ADDRESS`|`smtp.address`|
|
| `FAKESMTP_SMTP_ADDRESS` | `smtp.address` |
|
||||||
|`FAKESMTP_SMTP_USERNAME`|`smtp.username`|
|
| `FAKESMTP_SMTP_USERNAME` | `smtp.username` |
|
||||||
|`FAKESMTP_SMTP_PASSWORD`|`smtp.password`|
|
| `FAKESMTP_SMTP_PASSWORD` | `smtp.password` |
|
||||||
|`FAKESMTP_SMTP_DOMAIN`|`smtp.domain`|
|
| `FAKESMTP_SMTP_DOMAIN` | `smtp.domain` |
|
||||||
|`FAKESMTP_SMTP_READTIMEOUT`|`smtp.readTimeout`|
|
| `FAKESMTP_SMTP_READTIMEOUT` | `smtp.readTimeout` |
|
||||||
|`FAKESMTP_SMTP_WRITETIMEOUT`|`smtp.writeTimeout`|
|
| `FAKESMTP_SMTP_WRITETIMEOUT` | `smtp.writeTimeout` |
|
||||||
|`FAKESMTP_SMTP_MAXMESSAGEBYTES`|`smtp.maxMessageBytes`|
|
| `FAKESMTP_SMTP_MAXMESSAGEBYTES` | `smtp.maxMessageBytes` |
|
||||||
|`FAKESMTP_SMTP_MAXRECIPIENTS`|`smtp.maxRecipients`|
|
| `FAKESMTP_SMTP_MAXRECIPIENTS` | `smtp.maxRecipients` |
|
||||||
|`FAKESMTP_SMTP_ALLOWINSECUREAUTH`|`smtp.allowInsecureAuth`|
|
| `FAKESMTP_SMTP_ALLOWINSECUREAUTH` | `smtp.allowInsecureAuth` |
|
||||||
|`FAKESMTP_SMTP_DEBUG`|`smtp.debug`|
|
| `FAKESMTP_SMTP_DEBUG` | `smtp.debug` |
|
||||||
|`FAKESMTP_DATA_PATH`|`data.path`|
|
| `FAKESMTP_DATA_PATH` | `data.path` |
|
||||||
|`FAKESMTP_RELAY_ENABLED`|`relay.enabled`|
|
| `FAKESMTP_RELAY_ENABLED` | `relay.enabled` |
|
||||||
|`FAKESMTP_RELAY_ADDRESS`|`relay.address`|
|
| `FAKESMTP_RELAY_ADDRESS` | `relay.address` |
|
||||||
|`FAKESMTP_RELAY_IDENTITY`|`relay.identity`|
|
| `FAKESMTP_RELAY_IDENTITY` | `relay.identity` |
|
||||||
|`FAKESMTP_RELAY_USERNAME`|`relay.username`|
|
| `FAKESMTP_RELAY_USERNAME` | `relay.username` |
|
||||||
|`FAKESMTP_RELAY_PASSWORD`|`relay.password`|
|
| `FAKESMTP_RELAY_PASSWORD` | `relay.password` |
|
||||||
|`FAKESMTP_RELAY_ANONYMOUS`|`relay.anonymous`|
|
| `FAKESMTP_RELAY_ANONYMOUS` | `relay.anonymous` |
|
||||||
|`FAKESMTP_RELAY_INSECURE_SKIP_VERIFY`|`relay.insecureSkipVerify`|
|
| `FAKESMTP_RELAY_INSECURE_SKIP_VERIFY` | `relay.insecureSkipVerify` |
|
||||||
|`FAKESMTP_RELAY_FROM_OVERRIDE`|`relay.fromOverride`|
|
| `FAKESMTP_RELAY_FROM_OVERRIDE` | `relay.fromOverride` |
|
||||||
|
|
||||||
|
### Lancer en mode read-only
|
||||||
|
|
||||||
|
Pour lancer le conteneur en mode read-only, la variable `FAKESMTP_DATA_PATH` doit être définie et un volume doit être créé à cet emplacement. Exemple avec docker :
|
||||||
|
|
||||||
|
```sh
|
||||||
|
docker run -it --rm -p 8080:8080 -p 2525:2525 --env FAKESMTP_DATA_PATH='/app/data/fakesmtp.db' --read-only -v $(pwd)/data:/app/data bornholm/fake-smtp
|
||||||
|
```
|
||||||
|
|
||||||
## Démarrer avec les sources
|
## Démarrer avec les sources
|
||||||
|
|
||||||
|
0
data/.gitkeep
Normal file
0
data/.gitkeep
Normal file
Loading…
Reference in New Issue
Block a user