Resources
Nephthys Plus
-
db
postgres
Ready
-
app
hackclub/nephthys-plus
Running
-
ingress
help.example.com
Live
Parameters
Deploy Nephthys Plus
Public domain Slack will send events to
Log channel (optional)
Tickets will be posted here
Helper channel
Where users ask questions
The person that gets pung when bot breaks
Points to program transcript
Link to your program's FAQ (optional)
Powers ticket titles and automatic category tags (optional)
Any OpenAI-compatible API. Use one that does not train on your prompts
Let AI pick a category tag for each new ticket
Show the BETA ask ai button to users with at least this many past tickets. -1 turns it off
Requires a provider with a Jev endpoint
Turns on socket mode, so Slack does not need a public URL (optional)
Ask the poster for feedback after their ticket is resolved
Post the daily stats in the team channel
Most open tickets listed in the daily summary, posted in thread to avoid clutter
Credit anyone who resolves a ticket, not only helpers, using jev
Auto-close tickets inactive this many days. Leave empty to turn off (optional)
For threadrips (optional)
Set all three helper OAuth fields to let helpers connect their Slack accounts (optional)
Slack app client secret, used with helper OAuth (optional)
Fernet key for encrypting helper tokens. Generate one using the setup guide (optional)
Hack Club Auth OAuth app for the Lobby and API keys. Set the redirect URI to your domain + /oauth/callback (optional)
Needed together with the client ID (optional)
Signs Lobby login cookies. Generated if left empty (optional)
README
Nephthys Plus
Nephthys, but built for the community. It runs support channels like #help in a Slack workspace: tickets get tagged (by AI or by hand), assigned to whoever replies, and resolved with a button or a macro.
Before you deploy
Create the Slack app first, as a workspace admin (otherwise it can't fully delete threads):
- Go to https://api.slack.com/apps and pick Create New App > From a manifest.
- Paste
manifest.ymlfrom the nephthys-plus repo and swap thehttps://nephthys.hackclub.com/URLs for the domain you'll use below. - Install the app and copy the bot token, user token and signing secret.
- Invite the bot to the heartbeat, tickets, behind-the-scenes and help channels, and add yourself to the tickets channel.
After you deploy
A message shows up in the heartbeat channel, and the bot starts answering in the help channel. If it doesn't, check the logs and make sure the request URLs in the Slack app match your domain.
Everything past the Slack basics is optional:
- AI key and base URL for ticket titles and category tags. Pick a provider that doesn't train on your prompts.
- Slack app token for socket mode, so Slack doesn't need a public URL.
- Helper OAuth client ID, client secret and token encryption key let helpers connect their Slack accounts so macros can delete their own trigger messages. Set all three and add
https://your-domain/slack/oauth/callbackto your Slack app's redirect URLs. Generate the Fernet key withpython -c "from cryptography.fernet import Fernet; print(Fernet.generate_key().decode())". - HCA client ID and secret for the Lobby and API keys. Create an OAuth app on Hack Club Auth with the
slack_idscope and set the redirect URI to your domain +/oauth/callback. Set both or neither. The session secret is generated for you. - Feedback, daily summary, stale ticket auto-close, log level and a few other switches. See the repo's
docs/configuration.md.
YAML
apiVersion: leaf/v1
kind: Template
metadata:
name: nephthys-plus
displayName: Nephthys Plus
description: Support and ticket manager, for any program
icon: https://github.com/hackclub.png?size=256
version: '1.0.0'
category: bot
tags: ['slack', 'bot', 'python', 'support', 'postgres']
keywords: ['slack', 'bot', 'helpdesk', 'support', 'tickets', 'chat', 'nephthys', 'community']
homepage: https://github.com/hackclub/nephthys-plus
license: MIT
parameters:
- name: appName
displayName: App Name
type: string
default: nephthys-plus
required: true
validation:
pattern: '^[a-z][a-z0-9-]{1,58}[a-z0-9]$'
message: Must be lowercase alphanumeric with hyphens, 3-60 chars
- name: domain
displayName: Domain
description: Public domain Slack will send events to
type: string
required: true
placeholder: 'help.example.com'
- name: enableTls
displayName: Enable HTTPS
type: boolean
default: true
- name: slackBotToken
displayName: Slack Bot Token
type: string
required: true
placeholder: 'xoxb-...'
- name: slackUserToken
displayName: Slack User Token
type: string
required: true
placeholder: 'xoxp-...'
- name: slackSigningSecret
displayName: Slack Signing Secret
type: string
required: true
- name: slackHeartbeatChannel
displayName: Heartbeat Channel ID
description: Log channel (optional)
type: string
default: ''
placeholder: 'C...'
- name: slackTicketChannel
displayName: Ticket Channel ID
description: Tickets will be posted here
type: string
required: true
placeholder: 'C...'
- name: slackBtsChannel
displayName: Behind-the-scenes Channel ID
description: Helper channel
type: string
required: true
placeholder: 'C...'
- name: slackHelpChannel
displayName: Help Channel ID
description: Where users ask questions
type: string
required: true
placeholder: 'C...'
- name: slackMaintainerId
displayName: Maintainer User ID
description: The person that gets pung when bot breaks
type: string
required: true
placeholder: 'U...'
- name: program
displayName: Program
description: Points to program transcript
type: string
default: help
- name: appTitle
displayName: App Title
type: string
default: helper heidi
- name: faqLink
displayName: FAQ URL
description: Link to your program's FAQ (optional)
type: string
- name: aiApiKey
displayName: Hack Club AI API Key
description: Powers ticket titles and automatic category tags (optional)
type: string
placeholder: 'sk-hc-v1-...'
- name: aiBaseUrl
displayName: AI Base URL
description: Any OpenAI-compatible API. Use one that does not train on your prompts
type: string
default: 'https://ai.hackclub.com/proxy/v1'
- name: aiCategoryTagging
displayName: AI Category Tagging
description: Let AI pick a category tag for each new ticket
type: select
default: 'true'
options:
- label: 'Yes'
value: 'true'
- label: 'No'
value: 'false'
- name: aiHelpMinTickets
displayName: Ask AI Button Threshold
description: Show the BETA ask ai button to users with at least this many past tickets. -1 turns it off
type: string
default: '4'
- name: aiTitleModel
displayName: AI Title Model
type: string
default: anthropic/claude-haiku-5.5
- name: aiCategoryModel
displayName: AI Category Model
description: Requires a provider with a Jev endpoint
type: string
default: jev-latest
- name: aiHelpModel
displayName: AI Help Model
type: string
default: anthropic/claude-haiku-5.5
- name: slackAppToken
displayName: Slack App Token
description: Turns on socket mode, so Slack does not need a public URL (optional)
type: string
default: ''
placeholder: 'xapp-...'
- name: enableFeedback
displayName: Ticket Feedback
description: Ask the poster for feedback after their ticket is resolved
type: select
default: 'true'
options:
- label: 'Yes'
value: 'true'
- label: 'No'
value: 'false'
- name: dailySummary
displayName: Daily Summary
description: Post the daily stats in the team channel
type: select
default: 'true'
options:
- label: 'Yes'
value: 'true'
- label: 'No'
value: 'false'
- name: dailySummaryMaxTickets
displayName: Daily Summary Max Tickets
description: Most open tickets listed in the daily summary, posted in thread to avoid clutter
type: string
default: '50'
- name: creditNonHelpers
displayName: Credit Non-Helpers
description: Credit anyone who resolves a ticket, not only helpers, using jev
type: select
default: 'true'
options:
- label: 'Yes'
value: 'true'
- label: 'No'
value: 'false'
- name: staleTicketDays
displayName: Stale Ticket Days
description: Auto-close tickets inactive this many days. Leave empty to turn off (optional)
type: string
placeholder: '10'
- name: logLevel
displayName: Log Level
type: string
default: 'INFO'
- name: prometheusApiKey
displayName: Prometheus API Key
description: For threadrips (optional)
type: string
- name: helperOauthClientId
displayName: Helper OAuth Client ID
description: Set all three helper OAuth fields to let helpers connect their Slack accounts (optional)
type: string
- name: helperOauthClientSecret
displayName: Helper OAuth Client Secret
description: Slack app client secret, used with helper OAuth (optional)
type: string
- name: tokenEncryptionKey
displayName: Helper Token Encryption Key
description: Fernet key for encrypting helper tokens. Generate one using the setup guide (optional)
type: string
- name: hcaClientId
displayName: HCA Client ID
description: Hack Club Auth OAuth app for the Lobby and API keys. Set the redirect URI to your domain + /oauth/callback (optional)
type: string
- name: hcaClientSecret
displayName: HCA Client Secret
description: Needed together with the client ID (optional)
type: string
- name: sessionSecret
displayName: Session Secret
description: Signs Lobby login cookies. Generated if left empty (optional)
type: secret
validation:
min: 32
resources:
- name: db
type: database
config:
name: '{{ params.appName }}-db'
resources:
cpu: 100m
memory: 512Mi
- name: app
type: deployment
config:
name: '{{ params.appName }}'
resources:
cpu: 100m
memory: 512Mi
repo: https://github.com/hackclub/nephthys-plus
branch: main
buildType: dockerfile
dockerfilePath: Dockerfile
ports:
- name: http
containerPort: 3000
servicePort: 3000
protocol: TCP
env:
- key: ENVIRONMENT
value: production
- key: PORT
value: '3000'
- key: DATABASE_URL
value: '{{ resources.db.connectionString }}'
secret: true
- key: SLACK_BOT_TOKEN
value: '{{ params.slackBotToken }}'
secret: true
- key: SLACK_USER_TOKEN
value: '{{ params.slackUserToken }}'
secret: true
- key: SLACK_SIGNING_SECRET
value: '{{ params.slackSigningSecret }}'
secret: true
- key: SLACK_HEARTBEAT_CHANNEL
value: '{{ params.slackHeartbeatChannel }}'
- key: SLACK_TICKET_CHANNEL
value: '{{ params.slackTicketChannel }}'
- key: SLACK_BTS_CHANNEL
value: '{{ params.slackBtsChannel }}'
- key: SLACK_HELP_CHANNEL
value: '{{ params.slackHelpChannel }}'
- key: SLACK_MAINTAINER_ID
value: '{{ params.slackMaintainerId }}'
- key: PROGRAM
value: '{{ params.program }}'
- key: APP_TITLE
value: '{{ params.appTitle }}'
- key: FAQ_LINK
value: '{{ params.faqLink }}'
- key: BASE_URL
value: 'https://{{ params.domain }}'
- key: AI_API_KEY
value: '{{ params.aiApiKey }}'
secret: true
- key: AI_BASE_URL
value: '{{ params.aiBaseUrl }}'
- key: AI_CATEGORY_TAGGING
value: '{{ params.aiCategoryTagging }}'
- key: AI_HELP_MIN_TICKETS
value: '{{ params.aiHelpMinTickets }}'
- key: AI_TITLE_MODEL
value: '{{ params.aiTitleModel }}'
- key: AI_CATEGORY_MODEL
value: '{{ params.aiCategoryModel }}'
- key: AI_HELP_MODEL
value: '{{ params.aiHelpModel }}'
- key: SLACK_APP_TOKEN
value: '{{ params.slackAppToken }}'
secret: true
- key: ENABLE_FEEDBACK
value: '{{ params.enableFeedback }}'
- key: DAILY_SUMMARY
value: '{{ params.dailySummary }}'
- key: DAILY_SUMMARY_MAX_TICKETS
value: '{{ params.dailySummaryMaxTickets }}'
- key: CREDIT_NON_HELPERS
value: '{{ params.creditNonHelpers }}'
- key: STALE_TICKET_DAYS
value: '{{ params.staleTicketDays }}'
- key: LOG_LEVEL
value: '{{ params.logLevel }}'
- key: PROMETHEUS_API_KEY
value: '{{ params.prometheusApiKey }}'
secret: true
- key: HELPER_OAUTH_CLIENT_ID
value: '{{ params.helperOauthClientId }}'
- key: HELPER_OAUTH_CLIENT_SECRET
value: '{{ params.helperOauthClientSecret }}'
secret: true
- key: TOKEN_ENCRYPTION_KEY
value: '{{ params.tokenEncryptionKey }}'
secret: true
- key: HCA_CLIENT_ID
value: '{{ params.hcaClientId }}'
- key: HCA_CLIENT_SECRET
value: '{{ params.hcaClientSecret }}'
secret: true
- key: SESSION_SECRET
value: '{{ params.sessionSecret }}'
secret: true
- name: ingress
type: ingress
config:
host: '{{ params.domain }}'
tlsEnabled: '{{ params.enableTls }}'
routes:
- path: /
serviceName: '{{ resources.app.serviceName }}'
servicePort: 3000