Add unified docker-compose, README_INSTALL and .env.example for easy setup
This commit is contained in:
60
README_INSTALL.md
Normal file
60
README_INSTALL.md
Normal file
@@ -0,0 +1,60 @@
|
||||
# 🚀 AyrisMail - Hepsi Bir Arada Kurulum Rehberi
|
||||
|
||||
Bu proje, Mailcow sunucunuzdaki mailleri anlık olarak izleyen ve Telegram üzerinden bildirim gönderen akıllı bir bildirim sistemidir.
|
||||
|
||||
## 📦 Sistem Bileşenleri
|
||||
1. **Next.js Web Paneli:** Mailbox eşleşmelerini ve bildirim loglarını yönettiğiniz arayüz.
|
||||
2. **PostgreSQL:** Tüm kullanıcı ve log verilerinin saklandığı veritabanı.
|
||||
3. **Ayris Worker:** Sunucu seviyesinde mailleri anlık çözen ve Next.js'e sinyal atan motor.
|
||||
|
||||
---
|
||||
|
||||
## 🛠️ Kurulum Adımları
|
||||
|
||||
### 1. Dosya Yapısını Hazırlayın
|
||||
Projeyi şu klasör yapısında olacak şekilde sunucunuza yerleştirin:
|
||||
```text
|
||||
/ayris-project
|
||||
├── mailserver/ # Bu repo (Next.js)
|
||||
├── ayristech-worker/ # Worker repo
|
||||
└── docker-compose.unified.yml
|
||||
```
|
||||
|
||||
### 2. Çevre Değişkenlerini Ayarlayın
|
||||
`mailserver` klasörü içindeki `.env` dosyasını şu değişkenlerle doldurun:
|
||||
|
||||
```env
|
||||
# Veritabanı (Docker içinde otomatik bağlanır)
|
||||
DATABASE_URL="postgresql://postgres:ayris_pass_123@db:5432/ayrismail"
|
||||
|
||||
# Mailcow Bilgileri
|
||||
MAILCOW_API_URL="https://mail.alanadiniz.com"
|
||||
MAILCOW_API_KEY="your-api-key"
|
||||
|
||||
# Telegram
|
||||
TELEGRAM_BOT_TOKEN="your-bot-token"
|
||||
|
||||
# Güvenlik
|
||||
WEBHOOK_SIGNAL_SECRET="guclu-bir-sifre"
|
||||
AUTH_SECRET="auth-secret-key"
|
||||
NEXTAUTH_URL="http://localhost:3000"
|
||||
```
|
||||
|
||||
### 3. Sistemi Başlatın
|
||||
Terminalden ana dizine girin ve şu komutu çalıştırın:
|
||||
|
||||
```bash
|
||||
docker compose -f docker-compose.unified.yml up -d --build
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔒 Güvenlik Notları
|
||||
- `/var/run/docker.sock` dosyasının bağlanması, Worker'ın Dovecot konteynerine komut göndermesini sağlar.
|
||||
- `WEBHOOK_SIGNAL_SECRET` bilgisinin hem `.env` hem de Worker konfigürasyonunda aynı olduğundan emin olun.
|
||||
|
||||
## 📝 Kullanım
|
||||
1. `http://sunucu-ip:3000` adresinden panele giriş yapın.
|
||||
2. Kullanıcı oluşturun ve Telegram ID'sini girin.
|
||||
3. Mailbox Mapping kısmından hangi mailin kime gideceğini tanımlayın.
|
||||
4. Worker mailleri yakaladıkça bildirimler anında Telegram'a düşecektir.
|
||||
Reference in New Issue
Block a user