108 lines
3.3 KiB
Markdown
108 lines
3.3 KiB
Markdown
# Mail-Comment
|
|
|
|
|
|
|
|
Prueba de concepto para añadir comentarios en sitios estáticos utilizando **correo electrónico**.
|
|
Prototype to add comments to static sites using **email**.
|
|
|
|
---
|
|
|
|
## 📋 Características / Features
|
|
|
|
- **Sin registro / No registration**: cualquier usuario con correo electrónico puede comentar / any user with email can comment.
|
|
- **Moderación / Moderation**: aprovecha filtros de spam del proveedor de correo / use existing spam filters.
|
|
- **Filtros / Filters**: palabras clave y dominios específicos / keywords and domain filters.
|
|
- **Exportación / Export options**: HTML, Markdown, RSS/XML.
|
|
- **Integración / Integration**:
|
|
- Hugo: añade comentarios al final de los posts / append comments to Hugo posts.
|
|
- WordPress: webhook para instancias *headless* / webhook for headless WordPress.
|
|
|
|
---
|
|
|
|
## ⚙️ Instalación / Installation
|
|
|
|
```bash
|
|
git clone https://git.interlan.ec/Drk0027/mail-comment.git
|
|
cd mail-comment
|
|
pip install -r requirements.txt
|
|
cp .env.example .env
|
|
python -m venv venv
|
|
source venv/bin/activate
|
|
python email-processor.py
|
|
```
|
|
|
|
## 📄 Configuración .env / .env Configuration
|
|
|
|
```python
|
|
env
|
|
DOMAIN_TO_SEARCH=midominio.com
|
|
IGNORE_KEYWORDS=publicidad,notificacion,spam
|
|
|
|
SAVE_HTML=True
|
|
SAVE_MARKDOWN=True
|
|
SAVE_XML=True
|
|
SEND_WEBHOOK=True
|
|
|
|
WP_WEBHOOK_URL=https://tusitio.com/wp-json/tudominio/v1/recibir-comentario
|
|
WEBHOOK_SECRET_TOKEN=mi_clave_secreta_123
|
|
|
|
HUGO_DIR=/home/user/quickstart/
|
|
APPEND_HUGO=True
|
|
```
|
|
|
|
## ▶️ Ejecución / Run
|
|
```bash
|
|
python email-processor.py
|
|
```
|
|
|
|
## El script / The script:
|
|
|
|
- Conecta al servidor IMAP / Connects to IMAP server.
|
|
- Revisa mensajes en INBOX / Checks INBOX messages.
|
|
- Valida dominio y asunto / Validates domain and subject.
|
|
- Filtra spam / Filters spam.
|
|
- Exporta comentarios / Exports comments.
|
|
- Integra en Hugo o WordPress / Integrates with Hugo or WordPress.
|
|
- Borra mensajes procesados / Deletes processed messages.
|
|
|
|
## ⚠️ Advertencia / Warning
|
|
|
|
Publicar tu correo puede exponerte a spam / Publishing your email may expose you to spam.
|
|
|
|
Se recomienda usar una cuenta dedicada / Use a dedicated account.
|
|
|
|
Gmail puede funcionar con claves de aplicación / Gmail may work with app passwords.
|
|
|
|
## 📚 Recursos / Resources
|
|
[Repositorio principal / Main repo](https://git.interlan.ec/Drk0027/mail-comment)
|
|
|
|
[Funciones WordPress / WordPress functions](https://git.interlan.ec/Drk0027/mail-comment/src/branch/main/functions.php)
|
|
|
|
[Delta Chat Providers](https://providers.delta.chat/)
|
|
|
|
[Entrada en el blog/ Blog Entry](https://interlan.ec/blog/2026/01/16/comentarios-en-sitios-estaticos/)
|
|
|
|
📌 Estado / Status
|
|
Prototipo en desarrollo / Prototype in development.
|
|
Pruebas con Hugo (QuickStart) y flujo básico de WordPress / Tested with Hugo (QuickStart) and basic WordPress flow.
|
|
|
|
## 📌 Autoría y versión
|
|
|
|
- Autor: ([Drk0027](https://interlan.ec/portafolio-de-drk0027/))
|
|
- Versión: 0.1.0 (prototipo inicial)
|
|
- Licencia: MIT
|
|
|
|
## 🤝 Contribuciones por correo
|
|
|
|
Este proyecto no acepta pull requests en línea.
|
|
Si deseas contribuir:
|
|
|
|
1. Haz tus cambios en una rama local.
|
|
2. Genera un parche con:
|
|
```bash
|
|
git format-patch origin/main
|
|
Envía el parche por correo a: drk0027@interlan.ec
|
|
|
|
El autor revisará y aplicará el parche si es aceptado.
|
|
|
|
Nota: recuerda incluir una descripción clara en el asunto del correo. |