70 lines
2.1 KiB
Markdown
70 lines
2.1 KiB
Markdown
# Deployment Examples
|
|
|
|
This directory contains practical deployment examples and scripts for the C Nostr Relay with event-based configuration.
|
|
|
|
## Directory Structure
|
|
|
|
```
|
|
examples/deployment/
|
|
├── README.md # This file
|
|
├── simple-vps/ # Basic VPS deployment
|
|
├── nginx-proxy/ # Nginx reverse proxy configurations
|
|
├── monitoring/ # Monitoring and alerting examples
|
|
└── backup/ # Backup and recovery scripts
|
|
```
|
|
|
|
## Quick Start Examples
|
|
|
|
### 1. Simple VPS Deployment
|
|
For a basic Ubuntu VPS deployment:
|
|
```bash
|
|
cd examples/deployment/simple-vps
|
|
chmod +x deploy.sh
|
|
sudo ./deploy.sh
|
|
```
|
|
|
|
### 2. SSL Proxy Setup
|
|
For nginx reverse proxy with SSL:
|
|
```bash
|
|
cd examples/deployment/nginx-proxy
|
|
chmod +x setup-ssl-proxy.sh
|
|
sudo ./setup-ssl-proxy.sh -d relay.example.com -e admin@example.com
|
|
```
|
|
|
|
### 3. Monitoring Setup
|
|
For continuous monitoring:
|
|
```bash
|
|
cd examples/deployment/monitoring
|
|
chmod +x monitor-relay.sh
|
|
sudo ./monitor-relay.sh -c -e admin@example.com
|
|
```
|
|
|
|
### 4. Backup Setup
|
|
For automated backups:
|
|
```bash
|
|
cd examples/deployment/backup
|
|
chmod +x backup-relay.sh
|
|
sudo ./backup-relay.sh -s my-backup-bucket -e admin@example.com
|
|
```
|
|
|
|
## Configuration Examples
|
|
|
|
All examples assume the event-based configuration system where:
|
|
- No config files are needed
|
|
- Configuration is stored as kind 33334 events in the database
|
|
- Admin keys are generated on first startup
|
|
- Database naming uses relay pubkey (`<relay_pubkey>.nrdb`)
|
|
|
|
## Security Notes
|
|
|
|
- **Save Admin Keys**: All deployment examples emphasize capturing the admin private key on first startup
|
|
- **Firewall Configuration**: Examples include proper firewall rules
|
|
- **SSL/TLS**: Production examples include HTTPS configuration
|
|
- **User Isolation**: Service runs as dedicated `c-relay` system user
|
|
|
|
## Support
|
|
|
|
For detailed documentation, see:
|
|
- [`docs/deployment_guide.md`](../../docs/deployment_guide.md) - Comprehensive deployment guide
|
|
- [`docs/user_guide.md`](../../docs/user_guide.md) - User guide
|
|
- [`docs/configuration_guide.md`](../../docs/configuration_guide.md) - Configuration reference |