fallen/platform/.env.development.example at main · hackclub/fallen · 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
# Copy to .env.development (gitignored). Loaded by dotenv-rails and script/slack_socket_mode.mjs.

# Postgres. `docker compose up -d` provides one matching this URL.
DATABASE_URL=postgresql://postgres:postgres@localhost:5432/fallen_development

# Public URL of this app (used for OAuth callbacks and the Slack manifest).
APP_URL=http://localhost:3000

# Hack Club Auth. Create an app at https://auth.hackclub.com (dev uses the staging instance).
# Callback URL: http://localhost:3000/auth/hca/callback
HCA_CLIENT_ID=
HCA_CLIENT_SECRET=

# Slack app. Create one from `bin/slack-manifest --socket-mode` at https://api.slack.com/apps
SLACK_BOT_TOKEN=            # xoxb-… (OAuth & Permissions -> Bot User OAuth Token)
SLACK_SIGNING_SECRET=       # Basic Information -> App Credentials
SLACK_APP_TOKEN=            # xapp-… with connections:write (Basic Information -> App-Level Tokens). Enables Socket Mode locally.
SLACK_JOURNALS_CHANNEL_ID=  # C… of the journals channel. Invite the bot to it. Project threads and journals live here.
SLACK_MEMBERS_CHANNEL_ID=   # C… of the channel everyone is added to once signed in with Slack linked. Invite the bot to it.
SLACK_LULU_CHANNEL_ID=      # C… of #fallen-lulu, where Lulu people are added. Invite the bot to it.
SLACK_SAMI_CHANNEL_ID=      # C… of #fallen-sami, the same for Sami.
SLACK_CLIENT_ID=            # Basic Information -> App Credentials. Lets people connect Slack so web journals post as them.
SLACK_CLIENT_SECRET=
SLACK_LOOKUP_TOKEN=         # xoxb-… of a second app with users:read and users:read.email. Finds the landing page's "Get started as" picture.
SLACK_JOIN_SECRET=          # Shared secret for the Slack "join" button's webhook, POST /api/slack/join (Api::SlackJoinsController)
SLACK_TEAM_ID=                # T… of the workspace people authorise against (Enterprise Grid asks otherwise)
LAPSE_CLIENT_ID=              # lapse.hackclub.com/developer/apps, redirect URI {APP_URL}/auth/lapse/callback. Lets journals take hours from a timelapse.
LAPSE_CLIENT_SECRET=
HACKATIME_ADMIN_API_KEY=      # Hackatime admin API key. Lets a transfer's Lapse review read the person's Lapse and Lookout heartbeats.
SLACK_BROWSER_TOKEN=        # xoxc-… of an account in the journals channel. bin/slack-typing uses it to see who is typing.
SLACK_BROWSER_COOKIE=       # that account's `d` cookie (xoxd-…)
SLACK_HUDDLE_CHANNEL_ID=    # C… of a channel that account is in. script/slack_huddle.mjs keeps it in a huddle there around the clock.
SLACK_HUDDLE_LULU_CHANNEL_ID=   # C… of Team Lulu's channel and Team Sami's, where each team huddles while the main huddle is full
SLACK_HUDDLE_SAMI_CHANNEL_ID=
PROMETHEUS_API_KEY=         # Prometheus key for the journals channel. Without it stray posts are pointed at the site, not deleted.
PANGRAM_API_KEY=            # pangram.com Developers plan. Checks journals for AI writing before they post, once the writing_check flag is on.
SLACK_AI_FLAGS_CHANNEL_ID=  # C… of a private staff channel for flagged journals. Invite the bot to it. Empty posts nothing.
SLACK_REVIEWERS_CHANNEL_ID= # C… of the journal reviewers' channel, for a daily nudge when the queue backs up. Invite the bot. Empty posts nothing.

# Optional
# HASHID_SALT=change-me
# SENTRY_DSN=