Skip to content

Commit c31cf04

Browse files
committed
readme
1 parent 0594cb9 commit c31cf04

1 file changed

Lines changed: 6 additions & 92 deletions

File tree

README.md

Lines changed: 6 additions & 92 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
[![Go](https://github.com/Notifuse/notifuse/actions/workflows/go.yml/badge.svg)](https://github.com/Notifuse/notifuse/actions/workflows/go.yml)
55
[![codecov](https://codecov.io/gh/Notifuse/notifuse/graph/badge.svg?token=VZ0HBEM9OZ)](https://codecov.io/gh/Notifuse/notifuse)
66

7+
**[🎯 Try the Live Demo](https://demo.notifuse.com/signin?email=demo@notifuse.com)**
8+
79
**The open-source alternative to Mailchimp, Brevo, Mailjet, Listmonk, Mailerlite, and Klaviyo, Loop.so, etc.**
810

911
Notifuse is a modern, self-hosted email marketing platform that allows you to send newsletters and transactional emails at a fraction of the cost. Built with Go and React, it provides enterprise-grade features with the flexibility of open-source software.
@@ -75,97 +77,9 @@ Notifuse follows clean architecture principles with clear separation of concerns
7577
└── config/ # Configuration files
7678
```
7779

78-
## 🚀 Quick Start
79-
80-
### Using Docker Compose (Recommended)
81-
82-
```bash
83-
# Clone the repository
84-
git clone https://github.com/Notifuse/notifuse.git
85-
cd notifuse
86-
87-
# Start with Docker Compose
88-
docker-compose up -d
89-
90-
# Access the console
91-
open http://localhost:8080
92-
```
93-
94-
### Manual Installation
95-
96-
```bash
97-
# Install dependencies
98-
go mod download
99-
cd console && npm install
100-
101-
# Build the application
102-
make build
80+
## 🚀 Getting Started
10381

104-
# Run the server
105-
./bin/notifuse
106-
```
107-
108-
## 🔧 Configuration
109-
110-
Notifuse can be configured through environment variables or configuration files:
111-
112-
```env
113-
# Server configuration
114-
SERVER_PORT=8080
115-
SERVER_HOST=0.0.0.0
116-
ROOT_EMAIL=your-email@example.com
117-
CORS_ALLOW_ORIGIN=*
118-
ENVIRONMENT=production
119-
API_ENDPOINT=notifuse.your_website.com
120-
121-
# Database configuration
122-
DB_HOST=localhost
123-
DB_PORT=5432
124-
DB_USER=postgres
125-
DB_PASSWORD=
126-
DB_PREFIX=notifuse
127-
DB_NAME=${DB_PREFIX}_system
128-
DB_SSLMODE=require
129-
130-
# Other configurations can be added here
131-
SMTP_HOST=smtp.example.com
132-
SMTP_PORT=587
133-
SMTP_USERNAME=your-username
134-
SMTP_PASSWORD=your-password
135-
SMTP_FROM_EMAIL=noreply@example.com
136-
SMTP_FROM_NAME=Notifuse
137-
138-
# Security
139-
PASETO_PRIVATE_KEY="base64:your-private-key"
140-
PASETO_PUBLIC_KEY="base64:your-public-key"
141-
SECRET_KEY="your_secret_key_for_db_secrets_encryption"
142-
143-
# Tracing
144-
TRACING_ENABLED=true
145-
TRACING_SERVICE_NAME=notifuse
146-
TRACING_SAMPLING_PROBABILITY=
147-
# Trace exporter configuration: jaeger | zipkin | stackdriver | datadog | xray | none
148-
TRACING_TRACE_EXPORTER="none"
149-
# Jaeger settings
150-
TRACING_JAEGER_ENDPOINT="http://localhost:14268/api/traces"
151-
# Zipkin settings
152-
TRACING_ZIPKIN_ENDPOINT="http://localhost:9411/api/v2/spans"
153-
# Stackdriver settings
154-
TRACING_STACKDRIVER_PROJECT_ID=""
155-
# Azure Monitor settings
156-
TRACING_AZURE_INSTRUMENTATION_KEY=""
157-
# Datadog settings
158-
TRACING_DATADOG_AGENT_ADDRESS="localhost:8126"
159-
TRACING_DATADOG_API_KEY=""
160-
# AWS X-Ray settings
161-
TRACING_XRAY_REGION="us-west-2"
162-
# General agent endpoint (for exporters that support a common agent)
163-
TRACING_AGENT_ENDPOINT="localhost:6831"
164-
# Metrics exporter configuration: stackdriver | prometheus | datadog
165-
TRACING_METRICS_EXPORTER="prometheus"
166-
# Prometheus settings
167-
TRACING_PROMETHEUS_PORT=9464
168-
```
82+
For installation instructions, configuration options, and detailed setup guides, visit our comprehensive documentation at **[docs.notifuse.com](https://docs.notifuse.com)**.
16983

17084
## 📚 Documentation
17185

@@ -183,7 +97,7 @@ We welcome contributions! Please see our [Contributing Guide](https://docs.notif
18397

18498
## 📄 License
18599

186-
Notifuse is released under the [Elastic License 2.0](LICENSE).
100+
Notifuse is released under the [GNU Affero General Public License v3.0](LICENSE).
187101

188102
## 🆘 Support
189103

@@ -202,4 +116,4 @@ Notifuse is released under the [Elastic License 2.0](LICENSE).
202116

203117
---
204118

205-
**Ready to get started?** [Try the live demo](https://demo.notifuse.com) or [deploy your own instance](https://docs.notifuse.com) in minutes.
119+
**Ready to get started?** [Try the live demo](https://demo.notifuse.com/signin?email=demo@notifuse.com) or [deploy your own instance](https://docs.notifuse.com) in minutes.

0 commit comments

Comments
 (0)