create-kelpie 0.7.0 → 0.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/templates/README.md +14 -1
package/package.json
CHANGED
package/templates/README.md
CHANGED
|
@@ -6,6 +6,10 @@ These files are yours. Kelpie itself arrives as `@kelpie/server` and
|
|
|
6
6
|
`@kelpie/ui` in `node_modules`; what is checked in here is the assembly that
|
|
7
7
|
composes them: which modules are on, and how the service starts.
|
|
8
8
|
|
|
9
|
+
Full documentation, including production deployment and the complete
|
|
10
|
+
configuration reference, lives at
|
|
11
|
+
<https://github.com/velvet-tiger/kelpie/tree/main/docs>.
|
|
12
|
+
|
|
9
13
|
## Running it
|
|
10
14
|
|
|
11
15
|
```bash
|
|
@@ -60,7 +64,9 @@ on an unknown id or an unmet dependency rather than starting without it.
|
|
|
60
64
|
|
|
61
65
|
Everything below is required unless marked optional or conditional on another
|
|
62
66
|
variable's value. A missing or invalid value stops the service at boot and
|
|
63
|
-
lists every problem at once.
|
|
67
|
+
lists every problem at once. The full reference — including reverse-proxy,
|
|
68
|
+
egress, module-locking, and per-account login-limit settings — is
|
|
69
|
+
[docs/self-hosting/configuration.md](https://github.com/velvet-tiger/kelpie/blob/main/docs/self-hosting/configuration.md).
|
|
64
70
|
|
|
65
71
|
| Variable | Values |
|
|
66
72
|
| --- | --- |
|
|
@@ -85,6 +91,7 @@ lists every problem at once.
|
|
|
85
91
|
| `RATE_LIMIT_FORMS_LIMIT` / `RATE_LIMIT_FORMS_WINDOW_SECONDS` | Optional. Requests per window per IP on a public form submit, default 20 / 60 |
|
|
86
92
|
| `RATE_LIMIT_AUTH_LIMIT` / `RATE_LIMIT_AUTH_WINDOW_SECONDS` | Optional. Requests per window per IP on signup, login, and password reset, default 10 / 60 |
|
|
87
93
|
| `RATE_LIMIT_API_LIMIT` / `RATE_LIMIT_API_WINDOW_SECONDS` | Optional. Requests per window per API key on the rest of `/v1`, default 600 / 60 |
|
|
94
|
+
| `TRUSTED_PROXY_HOP_COUNT` | Optional, default 0. The number of reverse proxies in front of the service. Set the real hop count so rate limits meter the actual client from `X-Forwarded-For`, not your proxy |
|
|
88
95
|
|
|
89
96
|
### Rotating the encryption key
|
|
90
97
|
|
|
@@ -99,6 +106,9 @@ unreadable, so rotate rather than replace:
|
|
|
99
106
|
Safe to run more than once.
|
|
100
107
|
4. Remove `SECRET_ENCRYPTION_KEY_PREVIOUS` and deploy again.
|
|
101
108
|
|
|
109
|
+
More detail, including backups and what is sealed under the key:
|
|
110
|
+
[docs/self-hosting/production.md](https://github.com/velvet-tiger/kelpie/blob/main/docs/self-hosting/production.md).
|
|
111
|
+
|
|
102
112
|
## Deploying
|
|
103
113
|
|
|
104
114
|
`npm run dev` runs two processes. Vite builds the pages as you edit them and
|
|
@@ -120,6 +130,9 @@ Migrations apply at boot. Running more than one instance makes that a race, so
|
|
|
120
130
|
migrate once with `npm run migrate` in a release step, then start the instances
|
|
121
131
|
with `--no-migrate`. That command is forward-only and safe to re-run.
|
|
122
132
|
|
|
133
|
+
TLS, reverse proxies, systemd, health checks, and backups:
|
|
134
|
+
[docs/self-hosting/production.md](https://github.com/velvet-tiger/kelpie/blob/main/docs/self-hosting/production.md).
|
|
135
|
+
|
|
123
136
|
## Upgrading
|
|
124
137
|
|
|
125
138
|
```bash
|