81 lines
1.5 KiB
Markdown
81 lines
1.5 KiB
Markdown
|
# 📱 FakeSMS
|
||
|
|
|
||
|
|
Serveur d'envoi de SMS factice pour le développement avec interface web.
|
||
|
|
|
||
|
|
## Utilisation
|
||
|
|
|
||
|
|
### Avec Docker
|
||
|
|
|
||
|
|
```bash
|
||
|
|
docker run -it --rm -p 8080:8080 -p 2525:2525 bornholm/fake-sms
|
||
|
|
```
|
||
|
|
|
||
|
|
L'interface Web sera accessible à l'adresse http://localhost:8080/.
|
||
|
|
|
||
|
|
Voir la section "[Variables d'environnement](#variables-denvironnement)" pour voir comment personnaliser la configuration du service.
|
||
|
|
|
||
|
|
### Avec les binaires
|
||
|
|
|
||
|
|
> TODO
|
||
|
|
|
||
|
|
## Configuration
|
||
|
|
|
||
|
|
## Fichier de configuration
|
||
|
|
|
||
|
|
Le fichier de configuration de FakeSMTP est au format [YAML](https://yaml.org/).
|
||
|
|
|
||
|
|
Voici la structure du fichier par défaut:
|
||
|
|
|
||
|
|
```yaml
|
||
|
|
# Configuration HTTP
|
||
|
|
http:
|
||
|
|
address: :8080
|
||
|
|
templateDir: template
|
||
|
|
publicDir: public
|
||
|
|
|
||
|
|
# Configuration du stockage
|
||
|
|
data:
|
||
|
|
path: fakesms.db
|
||
|
|
```
|
||
|
|
|
||
|
|
### Variables d'environnement
|
||
|
|
|
||
|
|
La configuration de FakeSMTP peut être personnalisée via des variables d'environnement.
|
||
|
|
|
||
|
|
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`|
|
||
|
|
|
||
|
|
## Démarrer avec les sources
|
||
|
|
|
||
|
|
### Dépendances
|
||
|
|
|
||
|
|
- Go 1.13
|
||
|
|
- modd
|
||
|
|
- make
|
||
|
|
- NodeJS/npm
|
||
|
|
|
||
|
|
### Compiler et démarrer le serveur de développement
|
||
|
|
|
||
|
|
Dans un terminal:
|
||
|
|
|
||
|
|
```
|
||
|
|
npm install
|
||
|
|
make watch
|
||
|
|
```
|
||
|
|
|
||
|
|
## FAQ
|
||
|
|
|
||
|
|
### Générer une version de distribution
|
||
|
|
|
||
|
|
```
|
||
|
|
make release
|
||
|
|
```
|
||
|
|
|
||
|
|
## Licence
|
||
|
|
|
||
|
|
AGPL-3.0
|