Cadoles/fake-smtp
Cadoles
/
fake-smtp
21
0
Fork 0
Code Issues 1 Pull Requests 1 Releases Wiki Activity

doc: Mise à jour readme lancement en mode readonly

This commit is contained in:
Valentin Carroy 2024-03-18 14:34:03 +01:00
parent 4d2ca6bd3a
commit c3f64c8f1f
3 changed files with 44 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.gitignore vendored
View File

@ -1,5 +1,5 @@
/release /release
/data data/fakesmtp.db
/vendor /vendor
/bin /bin
/node_modules /node_modules

56
README.md
View File

@ -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
View File