first
This commit is contained in:
67
README.md
Normal file
67
README.md
Normal file
@@ -0,0 +1,67 @@
|
||||
# Local Mail Notifier
|
||||
|
||||
Un serveur mail local qui envoie des notifications via Pushover quand des emails sont reçus.
|
||||
|
||||
## Structure du projet
|
||||
|
||||
```
|
||||
local-mail-notifier/
|
||||
├── config/
|
||||
│ ├── default.json # Configuration par défaut
|
||||
│ └── custom-environment-variables.json # Variables d'environnement
|
||||
├── public/ # Fichiers statiques pour l'interface web
|
||||
│ ├── css/
|
||||
│ │ └── style.css
|
||||
│ └── js/
|
||||
│ └── main.js
|
||||
├── src/
|
||||
│ ├── server.js # Point d'entrée principal
|
||||
│ ├── mail-server.js # Serveur SMTP
|
||||
│ ├── notifiers/
|
||||
│ │ └── pushover.js # Intégration Pushover
|
||||
│ ├── routes/
|
||||
│ │ ├── api.js # Routes API
|
||||
│ │ └── web.js # Routes web pour l'interface admin
|
||||
│ ├── models/
|
||||
│ │ ├── email.js # Modèle pour les emails
|
||||
│ │ └── settings.js # Modèle pour les paramètres
|
||||
│ └── db/
|
||||
│ └── database.js # Gestion de la base de données
|
||||
├── views/ # Templates EJS pour l'interface web
|
||||
│ ├── layouts/
|
||||
│ │ └── main.ejs
|
||||
│ ├── partials/
|
||||
│ │ ├── header.ejs
|
||||
│ │ └── footer.ejs
|
||||
│ ├── dashboard.ejs
|
||||
│ ├── emails.ejs
|
||||
│ └── settings.ejs
|
||||
└── package.json
|
||||
```
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
# Cloner le dépôt
|
||||
git clone https://github.com/votre-username/local-mail-notifier.git
|
||||
cd local-mail-notifier
|
||||
|
||||
# Installer les dépendances
|
||||
npm install
|
||||
|
||||
# Démarrer le serveur
|
||||
npm start
|
||||
```
|
||||
|
||||
## Utilisation
|
||||
|
||||
Ce serveur offre les fonctionnalités suivantes :
|
||||
- Réception d'emails sur un port SMTP configurable
|
||||
- Envoi automatique de notifications via Pushover à la réception d'emails
|
||||
- Interface web d'administration pour gérer les paramètres
|
||||
- Visualisation des emails reçus
|
||||
- Configuration des notifications (modèles, filtres, etc.)
|
||||
|
||||
## Configuration
|
||||
|
||||
Modifiez le fichier `config/default.json` selon vos besoins ou utilisez des variables d'environnement.
|
||||
Reference in New Issue
Block a user