Skip to content

Commit beadb7e

Browse files
Update README.md
1 parent 625e2b4 commit beadb7e

File tree

1 file changed

+51
-1
lines changed

1 file changed

+51
-1
lines changed

README.md

Lines changed: 51 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,52 @@
11
# Directadmin-Emailforwarder - UNDER DEVELOPMENT
2-
Direct Admin Alias and Forwarder Management
2+
3+
# DirectAdmin Email Forwarder Manager
4+
5+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
6+
[![Python 3.11](https://img.shields.io/badge/python-3.11-blue.svg)](https://www.python.org/downloads/)
7+
8+
A secure web application for managing email forwarders through the DirectAdmin API. Features a clean web interface with authentication, 2FA support, and Docker deployment options.
9+
10+
## ✨ Features
11+
12+
- **🔐 Secure Authentication**: Built-in user authentication system with session management
13+
- **📱 Two-Factor Authentication**: Optional TOTP-based 2FA for enhanced security
14+
- **📧 Email Forwarder Management**:
15+
- Create email forwarders with intuitive interface
16+
- List all existing forwarders
17+
- Delete forwarders with confirmation
18+
- Auto-refresh forwarders list every 60 seconds
19+
- **🎨 Modern Web UI**: Clean, responsive interface built with vanilla JavaScript
20+
- **🐳 Docker Support**:
21+
- Multi-architecture images (amd64, arm64)
22+
- Configurable UID/GID for proper file permissions
23+
- Available on GitHub Container Registry
24+
- **🔄 DirectAdmin Integration**: Direct API integration with DirectAdmin servers
25+
- **📊 Real-time Updates**: Automatic refresh of forwarder list
26+
27+
</details>
28+
29+
## 📚 Prerequisites
30+
31+
- **DirectAdmin Server**: Access to a DirectAdmin server with API enabled
32+
- **DirectAdmin API Credentials**: Username and password with email management permissions
33+
- **Docker** (recommended): Docker Engine 20.10+ and Docker Compose 2.0+
34+
- **Python** (for manual installation): Python 3.11+
35+
36+
## 🚀 Quick Start
37+
38+
```bash
39+
# Pull and run the Docker image
40+
docker run -d \
41+
--name email-forwarder \
42+
-p 5000:5000 \
43+
-e SECRET_KEY=$(openssl rand -hex 32) \
44+
-e DA_SERVER=https://your-directadmin-server.com:2222 \
45+
-e DA_USERNAME=your_username \
46+
-e DA_PASSWORD=your_password \
47+
-e DA_DOMAIN=yourdomain.com \
48+
-v email-forwarder-data:/app/data \
49+
ghcr.io/gittimeraider/directadmin-emailforwarder:latest
50+
```
51+
52+

0 commit comments

Comments
 (0)