voidhash/.env.example at main · voidhashcom/voidhash · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
# Voidhash Community — self-hosting configuration.
#
# The Community deployment runs on Cloudflare Workers, composed by Alchemy
# (`apps/backend/stack.ts`). Hyperdrive fronts PostgreSQL, R2 stores public
# files and paywall artifacts, and Cloudflare Workflows run the workflow
# registry. See docs/cloudflare-deployment.md.
#
#   cp .env.example .env
#   pnpm db:migrate
#   pnpm dev

# ---------------------------------------------------------------------------
# Cloudflare deployment
# ---------------------------------------------------------------------------
# Read by the Alchemy CLI itself, not by repository source — do not remove them
# as "unused". Required for any live `pnpm alchemy deploy`; unnecessary for
# local development, which runs Workers in a local workerd sidecar.
# CLOUDFLARE_ACCOUNT_ID=
# CLOUDFLARE_API_TOKEN=

# Custom hostnames for live deployments. Hostnames only — the Cloudflare zones
# must already exist in the account. Unset means no custom domain is attached.
# VOIDHASH_BACKEND_DOMAIN=api.example.com
# VOIDHASH_WWW_DOMAIN=app.example.com

# Whether live Workers also keep their `workers.dev` URLs.
VOIDHASH_WORKERS_DEV_ENABLED=true

# ---------------------------------------------------------------------------
# Database
# ---------------------------------------------------------------------------
# Development-only database selector. When omitted (or set to `pglite`),
# Alchemy provisions PGlite and no DATABASE_* settings are needed. Set it to
# `pg` to use the PostgreSQL origin below during `pnpm dev`.
# DATABASE_MODE=pglite

# The PostgreSQL origin behind Hyperdrive. Live deployments always use it;
# local development uses it only when DATABASE_MODE=pg.
DATABASE_HOST=127.0.0.1
DATABASE_PORT=5432
DATABASE_USERNAME=voidhash
DATABASE_PASSWORD=password
DATABASE_NAME=voidhash
DATABASE_SSL=false

# Direct-TCP migration overrides used by `pnpm db:migrate` and by Alchemy when
# DATABASE_MODE=pg. Each falls back to its `DATABASE_*` counterpart. Set them
# when DATABASE_HOST names a proxy or broker that only resolves inside the
# runtime serving requests.
# DATABASE_DIRECT_HOST=
# DATABASE_DIRECT_PORT=
# DATABASE_DIRECT_NAME=
# DATABASE_DIRECT_USERNAME=
# DATABASE_DIRECT_PASSWORD=
# DATABASE_DIRECT_SSL=

# ---------------------------------------------------------------------------
# Analytics storage
# ---------------------------------------------------------------------------
# PostgreSQL is the default and requires no analytics-specific service. To use
# an operator-managed ClickHouse database, select it and set its HTTP endpoint
# and credentials. The backend creates the idempotent analytics tables at boot.
ANALYTICS_STORAGE=postgres
# ANALYTICS_CLICKHOUSE_URL=https://clickhouse.example.com:8443
# ANALYTICS_CLICKHOUSE_DATABASE=default
# ANALYTICS_CLICKHOUSE_USERNAME=default
# ANALYTICS_CLICKHOUSE_PASSWORD=

# ---------------------------------------------------------------------------
# Root account and session signing
# ---------------------------------------------------------------------------
# Replace every value below for a live deployment; these defaults are public
# knowledge and are only appropriate for loopback development.
VOIDHASH_ROOT_USERNAME=root
VOIDHASH_ROOT_PASSWORD=voidhash
VOIDHASH_ROOT_EMAIL=root@voidhash.local
VOIDHASH_AUTH_SECRET=local-development-secret-at-least-32-chars

# Public backend origin advertised to paywall clients. Defaults to
# `https://<VOIDHASH_BACKEND_DOMAIN>` in live deployments and
# http://localhost:8787 in local development. Set it when deploying without a
# custom domain.
# PAYWALL_PUBLIC_BASE_URL=https://api.example.com

# ---------------------------------------------------------------------------
# Optional integrations
# ---------------------------------------------------------------------------
# Every value here is optional; the feature it configures stays inert when the
# value is empty.

# Apple push delivery, and whether push credentials must be encrypted at rest.
APNS_DELIVERY_ENABLED=false
PUSH_REQUIRE_ENCRYPTION=true

# Symmetric key for payment-provider and push credentials at rest.
ENCRYPTION_KEY=

# Currency conversion for revenue reporting.
EXCHANGE_RATE_API_KEY=

# Google Play developer notifications, delivered over Pub/Sub push.
GOOGLE_PUBSUB_PUSH_AUDIENCE=
GOOGLE_PUBSUB_PUSH_SERVICE_ACCOUNT_EMAIL=

# In-product feedback relay.
SLACK_BOT_TOKEN=
SLACK_FEEDBACK_CHANNEL_ID=