update readme

This commit is contained in:
2025-08-09 16:04:39 +05:00
parent deeea7952c
commit 9c4303cf4d

View File

@@ -13,10 +13,14 @@ It supports wildcard certificates and multiple domains per certificate.
### 1. Set up environment file
Copy `.env.example` to `.env` and fill in your details:
Generate `.env` file [View example](/raw/branch/main/.env.example)
```bash
cp .env.example .env
**Example .env file:**
```env
CLOUDFLARE_EMAIL=user@example.com
CLOUDFLARE_API_KEY=your_global_api_key_here
CERTBOT_EMAIL=admin@example.com
DOMAINS=example.com,*.example.com,api.example.com
```
**Environment Variables:**
@@ -28,13 +32,6 @@ cp .env.example .env
- Supports wildcards: `*.example.com,example.com`
- Multiple domains: `example.com,api.example.com,*.sub.example.com`
**Example .env file:**
```env
CLOUDFLARE_EMAIL=user@example.com
CLOUDFLARE_API_KEY=your_global_api_key_here
CERTBOT_EMAIL=admin@example.com
DOMAINS=example.com,*.example.com,api.example.com
```
### 2. Create Docker Compose file
@@ -135,14 +132,6 @@ Certificates are valid for 90 days. To renew:
- **"Invalid credentials"**: Verify your Cloudflare email and API key
- **"Domain not found"**: Ensure domains are managed by your Cloudflare account
- **"Rate limited"**: Let's Encrypt has rate limits (50 certificates per week per domain)
- **"DNS propagation failed"**: Wait a few minutes and retry
## Security Notes
- Keep your `.env` file secure and never commit it to version control
- Use API tokens instead of Global API Key when possible
- Restrict API token permissions to only necessary zones
- Regularly rotate your API credentials
## Supported Features