Update README to reflect removal of password reset functionality
This commit is contained in:
parent
abd7e3a97f
commit
aba8801d21
1 changed files with 8 additions and 19 deletions
27
README.md
27
README.md
|
|
@ -9,7 +9,7 @@ A self-sufficient web application to manage an ISPmail (Postfix, Dovecot, Rspamd
|
|||
- **Alias Management** - Create and manage email aliases per domain
|
||||
- **Mail Queue** - View, requeue, and delete queued emails
|
||||
- **Mail Logs** - View postfix logs with filtering
|
||||
- **Password Reset** - SMTP-based password reset functionality
|
||||
- **Password Management** - Change password for admin users
|
||||
|
||||
## Tech Stack
|
||||
|
||||
|
|
@ -33,12 +33,12 @@ A self-sufficient web application to manage an ISPmail (Postfix, Dovecot, Rspamd
|
|||
make build
|
||||
```
|
||||
|
||||
### 2. Setup Admin User
|
||||
### 2. Create Admin User
|
||||
|
||||
```bash
|
||||
./build/imc-vibe --setup
|
||||
# Or with custom credentials:
|
||||
./build/imc-vibe --setup --admin-user=admin --admin-password=yourpassword
|
||||
./build/imc-vibe --reset-admin-password
|
||||
# This creates an admin user or resets the password
|
||||
# Output: Username: admin, Password: (randomly generated)
|
||||
```
|
||||
|
||||
### 3. Run
|
||||
|
|
@ -64,13 +64,7 @@ Open `http://your-server:8080` and login with the admin credentials.
|
|||
| `DB_NAME` | Database name | `mailserver` |
|
||||
| `BIND` | IP to bind to | `0.0.0.0` |
|
||||
| `PORT` | Port to listen on | `8080` |
|
||||
| `JWT_SECRET` | JWT signing secret | (required) |
|
||||
| `SMTP_HOST` | SMTP server for password reset | `localhost` |
|
||||
| `SMTP_PORT` | SMTP port | `587` |
|
||||
| `SMTP_USER` | SMTP username | |
|
||||
| `SMTP_PASSWORD` | SMTP password | |
|
||||
| `SMTP_FROM` | From address for emails | `noreply@localhost` |
|
||||
| `BASE_URL` | Base URL for password reset links | `http://localhost:8080` |
|
||||
| `JWT_SECRET` | JWT signing secret (min 32 chars) | (required) |
|
||||
|
||||
### CLI Flags
|
||||
|
||||
|
|
@ -79,16 +73,12 @@ Open `http://your-server:8080` and login with the admin credentials.
|
|||
```
|
||||
|
||||
```
|
||||
-admin-password string
|
||||
Admin password for setup (required with --setup)
|
||||
-admin-user string
|
||||
Admin username for setup (default "admin")
|
||||
-bind string
|
||||
IP address to bind to (default: 0.0.0.0)
|
||||
-port string
|
||||
Port to listen on (default: 8080)
|
||||
-setup
|
||||
Create admin user and exit
|
||||
-reset-admin-password
|
||||
Reset admin password to a random value and exit
|
||||
```
|
||||
|
||||
## Database Tables
|
||||
|
|
@ -98,7 +88,6 @@ The app creates these tables automatically:
|
|||
- `imc_users` - App admin users
|
||||
- `imc_login_attempts` - Brute force protection
|
||||
- `imc_users2domains` - User-domain permissions
|
||||
- `imc_password_reset_tokens` - Password reset tokens
|
||||
|
||||
Existing ISPmail tables (`virtual_domains`, `virtual_users`, `virtual_aliases`) are used for mail data.
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue