Skip to content

Commit 0ea9b5e

Browse files
committed
v15
1 parent 41dc3d4 commit 0ea9b5e

File tree

3 files changed

+12
-34
lines changed

3 files changed

+12
-34
lines changed

assets/screenshots/setup.png

72.6 KB
Loading

installation.mdx

Lines changed: 12 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,7 @@ Notifuse includes an interactive **Setup Wizard** that makes installation easy.
1717
- Enter your root administrator email
1818
- Configure your API endpoint
1919
- Set up SMTP settings
20-
- PASETO keys will be automatically generated
21-
4. Save the displayed PASETO keys securely
22-
5. Start using Notifuse!
20+
4. Start using Notifuse!
2321

2422
### One-click Deployments
2523

@@ -61,23 +59,6 @@ On first launch, you'll be guided through the Setup Wizard to configure your ins
6159

6260
**Note**: You'll need to provide your own PostgreSQL database.
6361

64-
### PASETO keys
65-
66-
PASETO keys are automatically generated during the Setup Wizard. The keys will be displayed at the end of setup - make sure to save them securely.
67-
68-
If you prefer to generate keys manually or need to pre-configure via environment variables:
69-
70-
- Generate keys online: https://paseto.notifuse.com
71-
- Or use the built-in keygen command:
72-
73-
```bash
74-
# If you have the source code
75-
make keygen
76-
77-
# Or directly with Go
78-
go run cmd/keygen/main.go
79-
```
80-
8162
### PostgreSQL database (Option 2 only)
8263

8364
If using the standalone Docker option, you can use any PostgreSQL database **with root credentials**. Notifuse automatically creates a system database for itself.
@@ -135,18 +116,16 @@ This limitation only applies to `.env` files. Environment variables set directly
135116

136117
These variables can be configured via the Setup Wizard on first launch, or set as environment variables. Environment variables always override wizard settings.
137118

138-
| Variable | Description |
139-
| -------------------- | ------------------------------------------------------------------------------------------------------- |
140-
| `ROOT_EMAIL` | Root administrator email (e.g., `[email protected]`) |
141-
| `API_ENDPOINT` | Public API endpoint URL (e.g., `https://emails.yourcompany.com`) |
142-
| `PASETO_PRIVATE_KEY` | Base64 encoded PASETO private key (auto-generated in wizard or generate at https://paseto.notifuse.com) |
143-
| `PASETO_PUBLIC_KEY` | Base64 encoded PASETO public key (auto-generated in wizard or generate at https://paseto.notifuse.com) |
144-
| `SMTP_HOST` | SMTP server host (e.g., `smtp.gmail.com`) |
145-
| `SMTP_PORT` | SMTP server port (e.g., `587` or `465`) |
146-
| `SMTP_USERNAME` | SMTP username (e.g., `[email protected]`) |
147-
| `SMTP_PASSWORD` | SMTP password (e.g., `your_smtp_password`) |
148-
| `SMTP_FROM_EMAIL` | From email address (e.g., `[email protected]`) |
149-
| `SMTP_FROM_NAME` | From name (e.g., `Your Company Name`) |
119+
| Variable | Description |
120+
| ----------------- | ---------------------------------------------------------------- |
121+
| `ROOT_EMAIL` | Root administrator email (e.g., `[email protected]`) |
122+
| `API_ENDPOINT` | Public API endpoint URL (e.g., `https://emails.yourcompany.com`) |
123+
| `SMTP_HOST` | SMTP server host (e.g., `smtp.gmail.com`) |
124+
| `SMTP_PORT` | SMTP server port (e.g., `587` or `465`) |
125+
| `SMTP_USERNAME` | SMTP username (e.g., `[email protected]`) |
126+
| `SMTP_PASSWORD` | SMTP password (e.g., `your_smtp_password`) |
127+
| `SMTP_FROM_EMAIL` | From email address (e.g., `[email protected]`) |
128+
| `SMTP_FROM_NAME` | From name (e.g., `Your Company Name`) |
150129

151130
### Optional Variables
152131

@@ -197,4 +176,4 @@ These variables can be configured via the Setup Wizard on first launch, or set a
197176
- **Environment Variables**: Recommended for production deployments. Provides better security for sensitive data and allows configuration management through your deployment pipeline.
198177
- **Priority**: Environment variables always take precedence over database settings when both are present.
199178

200-
**For Production Deployments**: We recommend using environment variables for sensitive configuration (SMTP credentials, PASETO keys) and the Setup Wizard or admin interface for non-sensitive settings (API endpoint, etc.).
179+
**For Production Deployments**: We recommend using environment variables for sensitive configuration (SMTP credentials, SECRET_KEY) and the Setup Wizard or admin interface for non-sensitive settings (API endpoint, etc.).

openapi.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -797,7 +797,6 @@
797797
"BearerAuth": {
798798
"type": "http",
799799
"scheme": "bearer",
800-
"bearerFormat": "PASETO",
801800
"description": "API token for authentication"
802801
}
803802
},

0 commit comments

Comments
 (0)