Compare commits
5 Commits
4f8167a4ef
...
doc_readon
Author | SHA1 | Date | |
---|---|---|---|
3a46451271 | |||
1688b316a0 | |||
816f939555 | |||
30874a6de7 | |||
84759ef783 |
32
README.md
32
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).
|
||||
|
||||
@ -75,10 +83,10 @@ Un exemple d'appel à l'API est disponible dans le fichier [`misc/powow.http`](.
|
||||
|
||||
### Dépendances
|
||||
|
||||
- Go 1.13
|
||||
- Go 1.17
|
||||
- modd
|
||||
- make
|
||||
- NodeJS/npm
|
||||
- NodeJS (20.x) / npm
|
||||
|
||||
### Compiler et démarrer le serveur de développement
|
||||
|
||||
@ -99,4 +107,4 @@ make release
|
||||
|
||||
## Licence
|
||||
|
||||
AGPL-3.0
|
||||
AGPL-3.0
|
||||
|
@ -7,7 +7,7 @@ ARG https_proxy=
|
||||
|
||||
RUN apt-get update && apt-get install -y build-essential git bash curl python2
|
||||
|
||||
RUN curl -sL https://deb.nodesource.com/setup_14.x | bash - \
|
||||
RUN curl -sL https://deb.nodesource.com/setup_20.x | bash - \
|
||||
&& apt-get install -y nodejs
|
||||
|
||||
COPY . /src
|
||||
|
22
package.json
22
package.json
@ -11,21 +11,21 @@
|
||||
"author": "Cadoles <contact@cadoles.com>",
|
||||
"license": "AGPL-3.0",
|
||||
"devDependencies": {
|
||||
"@babel/core": "^7.20.7",
|
||||
"@babel/core": "^7.23.9",
|
||||
"@babel/plugin-proposal-class-properties": "^7.18.6",
|
||||
"@babel/preset-env": "^7.20.2",
|
||||
"babel-loader": "^9.1.0",
|
||||
"@babel/preset-env": "^7.23.9",
|
||||
"babel-loader": "^9.1.3",
|
||||
"bulma": "^0.9.4",
|
||||
"bulma-switch": "^2.0.4",
|
||||
"css-loader": "^6.7.3",
|
||||
"css-loader": "^6.10.0",
|
||||
"file-loader": "^6.2.0",
|
||||
"mini-css-extract-plugin": "^2.7.2",
|
||||
"node-sass": "~8.0",
|
||||
"mini-css-extract-plugin": "^2.8.0",
|
||||
"node-sass": "~9.0",
|
||||
"resolve-url-loader": "^5.0.0",
|
||||
"sass-loader": "^13.2.0",
|
||||
"stimulus": "^3.2.1",
|
||||
"style-loader": "^3.3.1",
|
||||
"webpack": "^5.75.0",
|
||||
"webpack-cli": "^5.0.1"
|
||||
"sass-loader": "^14.1.1",
|
||||
"stimulus": "^3.2.2",
|
||||
"style-loader": "^3.3.4",
|
||||
"webpack": "^5.90.3",
|
||||
"webpack-cli": "^5.1.4"
|
||||
}
|
||||
}
|
||||
|
Reference in New Issue
Block a user