databull 0.0.0-stage → 1.1.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/README.md +46 -2
- package/dist/databull.mjs +3677 -0
- package/package.json +21 -4
package/README.md
CHANGED
|
@@ -1,3 +1,47 @@
|
|
|
1
|
-
#
|
|
1
|
+
# databull
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
The installer for [DataBull](https://databull.app), revenue-first web analytics that runs on your own
|
|
4
|
+
Cloudflare account.
|
|
5
|
+
|
|
6
|
+
```sh
|
|
7
|
+
npx databull@latest
|
|
8
|
+
```
|
|
9
|
+
|
|
10
|
+
That's it. It asks for your license key, logs you in to Cloudflare (a browser tab opens; click **Allow**),
|
|
11
|
+
and sets everything up: the Worker, the D1 database and the dashboard. About two minutes, start to finish.
|
|
12
|
+
At the end it opens your new dashboard so you can create your login.
|
|
13
|
+
|
|
14
|
+
You need Node.js 22 or newer and a Cloudflare account (the free plan works).
|
|
15
|
+
|
|
16
|
+
## Commands
|
|
17
|
+
|
|
18
|
+
| Command | What it does |
|
|
19
|
+
|---|---|
|
|
20
|
+
| `npx databull@latest` | Install DataBull (same as `install`) |
|
|
21
|
+
| `npx databull@latest update` | Update to the latest version. Your data and settings stay put |
|
|
22
|
+
| `npx databull@latest reset-password` | Get a one-time link to set a new password |
|
|
23
|
+
| `npx databull@latest domain` | Move to your own domain, e.g. `analytics.example.com` |
|
|
24
|
+
| `npx databull@latest status` | See your installs, their versions and whether they're online |
|
|
25
|
+
| `npx databull@latest license` | Show your license; `--deactivate` frees the activation |
|
|
26
|
+
| `npx databull@latest uninstall` | Remove DataBull from Cloudflare (your data is kept unless you say otherwise) |
|
|
27
|
+
|
|
28
|
+
## Options
|
|
29
|
+
|
|
30
|
+
Every question has a flag, so the installer can run unattended:
|
|
31
|
+
|
|
32
|
+
```sh
|
|
33
|
+
npx databull@latest install --key <license key> --account <id> --name databull --domain workers.dev --yes --no-open
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
`--key`, `--account <id|name>`, `--name <worker>`, `--domain <host|workers.dev>`, `--yes`, `--no-open`,
|
|
37
|
+
`--bundle <file.tgz>`, `--api <url>`, `--home <dir>` (default `~/.databull`), `--version`, `--help`.
|
|
38
|
+
|
|
39
|
+
## Good to know
|
|
40
|
+
|
|
41
|
+
- DataBull keeps its local state in `~/.databull` (readable only by you): the list of your installs, a private
|
|
42
|
+
copy of Cloudflare's `wrangler`, and logs. If something fails, the message tells you what to do and points at
|
|
43
|
+
the log.
|
|
44
|
+
- Something went wrong half-way? Run the same command again. It picks up where it stopped.
|
|
45
|
+
- Docs: https://databull.app/docs · Help: adgan.business@gmail.com
|
|
46
|
+
|
|
47
|
+
License: see https://databull.app/terms.
|