Repository navigation
Expand file tree
/
Copy path.env.example
More file actions
119 lines (93 loc) · 5.47 KB
/
Copy path.env.example
File metadata and controls
119 lines (93 loc) · 5.47 KB
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
108
109
110
111
112
113
114
115
116
117
118
119
# codeforphilly-rewrite — local development environment
# Copy this file to .env and fill in values for your machine.
# Lines starting with # are comments. Never commit your .env.
# ---------------------------------------------------------------------------
# Core
# ---------------------------------------------------------------------------
# TCP port the Fastify API listens on.
PORT=3001
# Runtime mode. Controls logger format, cookie Secure flag, CORS permissiveness.
# One of: development | test | production
NODE_ENV=development
# ---------------------------------------------------------------------------
# Public gitsheets data repo
# ---------------------------------------------------------------------------
# Path to a BARE clone of codeforphilly-data (the API refuses a non-bare
# clone). Relative paths are resolved from the API workspace dir
# (`apps/api/`) — prefer absolute paths in dev. For a small seed:
# git clone --bare --branch fixture https://github.com/CodeForPhilly/codeforphilly-data.git ../codeforphilly-data
# (`--branch published` for the full laddr import.)
CFP_DATA_REPO_PATH=../codeforphilly-data
# Git remote URL to push public data commits to. Optional in dev; required in prod.
# This is the production private data repo — the public snapshot is published separately.
# CFP_DATA_REMOTE=git@github.com:CodeForPhilly/codeforphilly-data.git
# ---------------------------------------------------------------------------
# Private storage
# ---------------------------------------------------------------------------
# Which private-storage backend to use. Use 'filesystem' for local dev.
# One of: filesystem | s3
STORAGE_BACKEND=filesystem
# Filesystem backend: path to the directory holding profiles.jsonl and passwords.jsonl.
# Required when STORAGE_BACKEND=filesystem.
CFP_PRIVATE_STORAGE_PATH=./private-storage
# S3 backend — only needed when STORAGE_BACKEND=s3.
# S3_ENDPOINT=https://s3.us-east-1.amazonaws.com
# S3_BUCKET=cfp-private-storage
# S3_REGION=us-east-1
# S3_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE
# S3_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
# ---------------------------------------------------------------------------
# Auth
# ---------------------------------------------------------------------------
# GitHub OAuth app credentials. Create one at https://github.com/settings/developers.
# Callback URL for dev: http://localhost:3001/api/auth/github/callback
# GITHUB_OAUTH_CLIENT_ID=Iv1.a1b2c3d4e5f6g7h8
# GITHUB_OAUTH_CLIENT_SECRET=secret_abc123
# HS256 signing key for session JWTs. Generate a random string ≥ 32 chars.
# In production use a securely-generated secret; in dev any 32+ char string works.
CFP_JWT_SIGNING_KEY=change-me-to-a-random-string-at-least-32-chars
# ---------------------------------------------------------------------------
# SAML IdP (Slack integration) — only needed in production
# ---------------------------------------------------------------------------
# PEM-encoded private key for the SAML IdP certificate.
# SAML_PRIVATE_KEY=-----BEGIN RSA PRIVATE KEY-----\n...\n-----END RSA PRIVATE KEY-----
# PEM-encoded certificate matching SAML_PRIVATE_KEY.
# SAML_CERTIFICATE=-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----
# Stable IdP entity ID — also the <Issuer> on every assertion. Slack stores
# this at setup, so it must NOT change when CFP_SITE_HOST flips at cutover.
# Leave unset unless registering a separate IdP with a different workspace.
# See specs/api/saml.md#idp-identity-and-hosts.
# SAML_ENTITY_ID=https://codeforphilly.org/api/saml/slack/metadata
# Slack workspace host. Drives the ACS URL, NameID NameQualifier, and the
# /chat + /launch redirects. Never used for our own entity ID or endpoints.
# SLACK_TEAM_HOST=codeforphilly.slack.com
# ---------------------------------------------------------------------------
# Static SPA serving (production only)
# ---------------------------------------------------------------------------
# Absolute path to the built apps/web/dist directory. When set, the API
# serves the SPA as a fallthrough for non-/api/* routes (single-image
# deploy per specs/architecture.md). Leave unset in dev — Vite owns 5173.
# CFP_WEB_DIST_PATH=/app/apps/web/dist
# ---------------------------------------------------------------------------
# Markdown rendering
# ---------------------------------------------------------------------------
# Public-facing host. Used by the server-side markdown renderer's
# external-link transform — anchors with a host different from this one
# get target="_blank" rel="noopener nofollow". See
# specs/behaviors/markdown-rendering.md. Sandbox: next-v2.codeforphilly.org.
# Production: codeforphilly.org (the default).
# CFP_SITE_HOST=codeforphilly.org
# ---------------------------------------------------------------------------
# Outbound notifications (Postmark)
# ---------------------------------------------------------------------------
# Postmark server token for the email notifier (help-wanted, welcome,
# password-reset). When unset, the notifier falls back to a no-op
# LoggingNotifier so dev + tests work without an account. See
# plans/postmark-notifier.md and docs/operations/secrets.md.
# POSTMARK_SERVER_TOKEN=…
# Postmark message stream to send on. Defaults to `outbound`, the
# transactional stream every Postmark server ships with.
# POSTMARK_MESSAGE_STREAM=outbound
# From-address for outbound notifications. RFC 5322 form.
# Only used when POSTMARK_SERVER_TOKEN is set.
# CFP_NOTIFICATION_FROM="Code for Philly <notifications@codeforphilly.org>"