flxbl-bot
718cb1c4e1
Provides GitHub Actions workflows for customers to initialize, update, and monitor their self-hosted SFP Pro server instances. Includes a composite action for CLI installation from Gitea and SSH setup. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
116 lines
3.7 KiB
Bash
116 lines
3.7 KiB
Bash
# SFP Server Self-Hosted Configuration Reference
|
|
# ================================================
|
|
#
|
|
# This file documents all configuration variables and where they come from.
|
|
# Do NOT edit this file directly -- configure values via GitHub Actions
|
|
# secrets/variables, or on the server's .env file post-init.
|
|
#
|
|
# The sfp CLI manages the actual .env file on the remote server.
|
|
|
|
# ============================================================
|
|
# Set via GitHub Actions Secrets (required for init & update)
|
|
# ============================================================
|
|
|
|
# Token to authenticate with Docker registry for pulling images
|
|
# GitHub Secret: DOCKER_REGISTRY_TOKEN
|
|
# DOCKER_REGISTRY_TOKEN=
|
|
|
|
# Token for source.flxbl.io Gitea API (CLI download)
|
|
# GitHub Secret: GITEA_TOKEN
|
|
# GITEA_TOKEN=
|
|
|
|
# SSH private key to access the remote server
|
|
# GitHub Secret: SSH_PRIVATE_KEY
|
|
# SSH_PRIVATE_KEY=
|
|
|
|
# ============================================================
|
|
# Set via GitHub Actions Secrets (conditional)
|
|
# ============================================================
|
|
|
|
# TLS certificate and private key (base64-encoded PEM)
|
|
# Only needed when using tls-mode=custom
|
|
# GitHub Secret: ORIGIN_CERT
|
|
# ORIGIN_CERT=
|
|
|
|
# GitHub Secret: ORIGIN_KEY
|
|
# ORIGIN_KEY=
|
|
|
|
# ============================================================
|
|
# Set via GitHub Actions Variables
|
|
# ============================================================
|
|
|
|
# Target server hostname or IP (required)
|
|
# GitHub Variable: SSH_HOST
|
|
# SSH_HOST=
|
|
|
|
# Tenant identifier (required)
|
|
# GitHub Variable: TENANT_NAME
|
|
# TENANT_NAME=my-company
|
|
|
|
# FQDN for the server (required)
|
|
# GitHub Variable: DOMAIN
|
|
# DOMAIN=sfp.yourcompany.com
|
|
|
|
# Docker registry hostname (required)
|
|
# Examples: source.flxbl.io, ghcr.io, your-registry.example.com
|
|
# GitHub Variable: DOCKER_REGISTRY
|
|
# DOCKER_REGISTRY=source.flxbl.io
|
|
|
|
# SSH username (optional, default: root)
|
|
# GitHub Variable: SSH_USER
|
|
# SSH_USER=root
|
|
|
|
# Full Docker image path (optional, overrides default)
|
|
# Example: source.flxbl.io/flxbl/sfp-server
|
|
# GitHub Variable: IMAGE_FQDN
|
|
# IMAGE_FQDN=
|
|
|
|
# Docker image tag (optional, default: latest)
|
|
# Examples: latest, v3-latest, 3.28.0-12345
|
|
# GitHub Variable: IMAGE_TAG
|
|
# IMAGE_TAG=latest
|
|
|
|
# Number of background workers (optional, default: 1)
|
|
# GitHub Variable: WORKERS
|
|
# WORKERS=1
|
|
|
|
# Base directory on the remote server (optional, default: ./sfp-server)
|
|
# GitHub Variable: BASE_DIR
|
|
# BASE_DIR=./sfp-server
|
|
|
|
# SFP CLI version to download (optional, default: latest)
|
|
# GitHub Variable: SFP_CLI_VERSION
|
|
# SFP_CLI_VERSION=latest
|
|
|
|
# ============================================================
|
|
# Auto-generated during init (persisted on server's .env)
|
|
# ============================================================
|
|
# These values are automatically generated by `sfp server init`
|
|
# and stored on the remote server. They are read by `sfp server update`
|
|
# via SSH -- you do NOT need to store them in GitHub.
|
|
#
|
|
# SUPABASE_JWT_SECRET
|
|
# SUPABASE_ANON_KEY
|
|
# SUPABASE_SERVICE_KEY
|
|
# POSTGRES_PASSWORD
|
|
# HATCHET_APPLICATION_TOKEN
|
|
# HATCHET_DB_PASSWORD
|
|
# PG_META_CRYPTO_KEY
|
|
# SUPABASE_ENCRYPTION_KEY
|
|
|
|
# ============================================================
|
|
# Configured post-init (integration setup)
|
|
# ============================================================
|
|
# These are NOT needed for server initialization. Configure them
|
|
# after the server is running via the integration API or by
|
|
# SSH-ing to the server and editing .env + restarting services.
|
|
#
|
|
# GITHUB_OAUTH_CLIENT_ID # GitHub OAuth App for user login
|
|
# GITHUB_OAUTH_CLIENT_SECRET
|
|
# GITHUB_APP_ID # GitHub App for repo operations
|
|
# GITHUB_APP_PRIVATE_KEY
|
|
# SLACK_APP_TOKEN # Slack integration
|
|
# SLACK_SIGNING_SECRET
|
|
# SLACK_BOT_TOKEN
|
|
# OPENAI_API_KEY # AI features
|