Cadoles/fake-sms
Cadoles/fake-sms
21
0
Fork 0
Code Issues 2 Pull Requests 3 Releases Wiki Activity

doc: Mise à jour readme lancement en mode readonly

Browse Source
This commit is contained in:
Valentin Carroy 2024-03-18 15:15:18 +01:00
parent 1688b316a0
commit 3a46451271
1 changed files with 18 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -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).
@ -99,4 +107,4 @@ make release
## Licence
AGPL-3.0
AGPL-3.0