From 3a46451271ddb6033eaa2b3ddc80abdde91cff15 Mon Sep 17 00:00:00 2001 From: vcarroy Date: Mon, 18 Mar 2024 15:15:18 +0100 Subject: [PATCH] =?UTF-8?q?doc:=20Mise=20=C3=A0=20jour=20readme=20lancemen?= =?UTF-8?q?t=20en=20mode=20readonly?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 28 ++++++++++++++++++---------- 1 file changed, 18 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 2d646c1..557f07e 100644 --- a/README.md +++ b/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:///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 \ No newline at end of file +AGPL-3.0