Compare commits
1 Commits
develop
...
doc_readon
Author | SHA1 | Date |
---|---|---|
Valentin Carroy | 3a46451271 |
26
README.md
26
README.md
|
@ -50,12 +50,20 @@ 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.
|
||||
|
||||
|Variable|Correspondance dans le fichier de configuration|
|
||||
|--------|-----------------------------------------------|
|
||||
|`FAKESMS_HTTP_ADDRESS`|`http.address`|
|
||||
|`FAKESMS_HTTP_TEMPLATEDIR`|`http.templateDir`|
|
||||
|`FAKESMS_HTTP_PUBLICDIR`|`http.publicDir`|
|
||||
|`FAKESMS_POWOW_API_KEY`|`powow.apiKey`|
|
||||
| Variable | Correspondance dans le fichier de configuration |
|
||||
| -------------------------- | ----------------------------------------------- |
|
||||
| `FAKESMS_HTTP_ADDRESS` | `http.address` |
|
||||
| `FAKESMS_HTTP_TEMPLATEDIR` | `http.templateDir` |
|
||||
| `FAKESMS_HTTP_PUBLICDIR` | `http.publicDir` |
|
||||
| `FAKESMS_POWOW_API_KEY` | `powow.apiKey` |
|
||||
|
||||
### 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 3000:3000 --env FAKESMS_DATA_PATH='/app/data/fakesms.db' --read-only -v $(pwd)/data:/app/data cadoles/fake-sms
|
||||
```
|
||||
|
||||
## Mocks
|
||||
|
||||
|
@ -65,9 +73,9 @@ Un mock de l'API Powow est disponible via l'URL `http://<fake_sms_host>/api/v1/m
|
|||
|
||||
Les commandes suivantes sont implémentées:
|
||||
|
||||
|Commande|Documentation officiele|Notes|
|
||||
|--------|-----------------------|-----------|
|
||||
|`TransactionalSms.Send`|https://powow4.iroquois.fr/user/docs/api/#send-transactional-sms|La définition des modèles de SMS s'effectue via la configuration.|
|
||||
| Commande | Documentation officiele | Notes |
|
||||
| ----------------------- | ---------------------------------------------------------------- | ----------------------------------------------------------------- |
|
||||
| `TransactionalSms.Send` | https://powow4.iroquois.fr/user/docs/api/#send-transactional-sms | La définition des modèles de SMS s'effectue via la configuration. |
|
||||
|
||||
Un exemple d'appel à l'API est disponible dans le fichier [`misc/powow.http`](./misc/powow.http).
|
||||
|
||||
|
|
Loading…
Reference in New Issue