bunker-admin
a77306fac2
Phase 1-14 complete: - Unified Express.js API (TypeScript, Prisma ORM, PostgreSQL 16) - React Admin GUI (Vite + Ant Design + Zustand) - JWT auth with refresh tokens - Influence: Campaigns, Representatives, Responses, Email Queue - Map: Locations, Cuts, Shifts, Canvassing System - NAR data import infrastructure (2025 format) - Listmonk newsletter integration - Landing page builder (GrapesJS) - MkDocs + Code Server integration - Volunteer portal with GPS tracking - Monitoring stack (Prometheus, Grafana, Alertmanager) - Pangolin tunnel integration Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
69 lines
2.0 KiB
Markdown
69 lines
2.0 KiB
Markdown
# Listmonk
|
|
|
|
<div class="github-widget" data-repo="knadh/listmonk"></div>
|
|
|
|
Self-hosted newsletter and mailing list manager.
|
|
|
|
## Overview
|
|
|
|
Listmonk is a modern, feature-rich newsletter and mailing list manager designed for high performance and easy management. It provides a complete solution for email campaigns, subscriber management, and analytics.
|
|
|
|
## Features
|
|
|
|
- Newsletter and email campaign management
|
|
- Subscriber list management
|
|
- Template system with HTML/markdown support
|
|
- Campaign analytics and tracking
|
|
- API for integration
|
|
- Multi-list support
|
|
- Bounce handling
|
|
- Privacy-focused design
|
|
|
|
## Access
|
|
|
|
- **Default Port**: 9000
|
|
- **URL**: `http://localhost:9000`
|
|
- **Admin User**: Set via `LISTMONK_ADMIN_USER` environment variable
|
|
- **Admin Password**: Set via `LISTMONK_ADMIN_PASSWORD` environment variable
|
|
|
|
## Configuration
|
|
|
|
### Environment Variables
|
|
|
|
- `LISTMONK_ADMIN_USER`: Admin username
|
|
- `LISTMONK_ADMIN_PASSWORD`: Admin password
|
|
- `POSTGRES_USER`: Database username
|
|
- `POSTGRES_PASSWORD`: Database password
|
|
- `POSTGRES_DB`: Database name
|
|
|
|
### Database
|
|
|
|
Listmonk uses PostgreSQL as its backend database. The database is automatically configured through the docker-compose setup.
|
|
|
|
### Uploads
|
|
|
|
- Upload directory: `./assets/uploads`
|
|
- Used for media files, templates, and attachments
|
|
|
|
## Getting Started
|
|
|
|
1. Access Listmonk at `http://localhost:9000`
|
|
2. Log in with your admin credentials
|
|
3. Set up your first mailing list
|
|
4. Configure SMTP settings for sending emails
|
|
5. Import subscribers or create subscription forms
|
|
6. Create your first campaign
|
|
|
|
## Important Notes
|
|
|
|
- Configure SMTP settings before sending emails
|
|
- Set up proper domain authentication (SPF, DKIM) for better deliverability
|
|
- Regularly backup your subscriber data and campaigns
|
|
- Monitor bounce rates and maintain list hygiene
|
|
|
|
## Official Documentation
|
|
|
|
For comprehensive guides and API documentation, visit:
|
|
- [Listmonk Documentation](https://listmonk.app/docs/)
|
|
- [GitHub Repository](https://github.com/knadh/listmonk)
|