flxbl docs
slackGitHub
  • flxbl
  • sfp
  • sfops
  • Overview
  • Getting Started
    • Pre-Requisites
    • Install sfp
    • Configure Your Project
    • Build & Install an Artifact
    • Congratulations!
    • Docker Images
      • sfp-pro
  • CONCEPTS
    • Overview
    • SF CLI vs. SFP
    • Domains
    • Packages
    • Supported package types
      • Unlocked Packages
      • Org-Dependent Unlocked Packages
      • Source Packages
      • Diff Package
      • Data Packages
    • Artifacts
    • Package vs Artifacts
    • Identifying types of a package
    • Dependency management
    • Transitive Dependency Resolution
    • Destructive Changes
  • configuring a project
    • Project structure
    • Setup Salesforce Org
    • Creating a package
    • Defining a domain
    • Release Config
  • BUILDING ARTIFACTS
    • Overview
    • Determining whether an artifact need to be built
    • Building a domain
    • Building an artifact for package individually
    • Limiting artifacts to be built
    • Controlling aspects of the build command
      • Ignoring packages from being built
      • Building a collection of packages together
      • Selective ignoring of components from being built
      • Use of multiple config file in build command
    • Configuring installation behaviour of a package
      • Always deploy a package
      • Skip Install on Certain Orgs
      • Optimized Installation
      • Pre/Post Deployment Script
      • Reconciling Profiles
      • PermissionSet Assignment
      • Updating Picklist
      • Entitlement Deployment Helper
      • Field History & Feed Tracking
      • Aliasfy Packages
        • Aliasfy Packages - Merge Mode
      • State management for Flows
  • Installing an artifact
    • Overview
    • Controlling Aspects of Installation
    • Applying attributes of an artifact
    • BuiltIn Deployment Helpers
      • PermissionSet Group Awaiter
  • publishing and fetching artifacts
    • Publish Artifact
    • Fetching Artifacts
  • Releasing artifacts
    • Overview
    • Release Definitions
    • Generating a release definition
    • Generating a changelog
  • Validating a change
    • Overview
    • Different types of validation
    • Limiting Validation by Domain
    • Controlling validation attributes of a package
      • Skip Testing
      • Skip Coverage Validation
      • Test Synchronously
  • Analysing a Project
    • Overview
    • Duplicate Check
  • Environment Management
    • Pools
      • Scratch Org Pools
        • Defining a pool
        • Setting up your Salesforce Org for Scratch Org Pools
        • Pool Operations
          • Preparing pools
            • Handling dependencies
          • List Scratch Orgs in a pool
          • Fetch a scratch org
          • Delete Pools
      • Sandbox Pools
        • Sandbox Pool Initialization
        • Fetch a Sandbox from Pool
        • Monitor Sandbox Pools
    • Review Environments
      • Commands
        • Fetch a Review Environment
        • Check Review Environment Status
        • Extend a Review Environment
        • Transition Review Environment Status
        • Unassign a Review Environment
      • Considerations
    • Sandbox
      • Create Sandbox
      • Delete Sandbox
      • List Sandbox
      • Login to Sandbox
      • Update Sandbox
  • Development
    • Development Environment
    • Pull Changes from your org
    • Push Changes to your org
    • Dependency Management
      • Expand Dependencies
      • Shrink Dependencies
      • Explain Dependencies
  • Running sfp as a server
    • Introduction
    • sfp-pro-server: Architecture Overview (Alpha)
      • Task Processing System
      • Authentication & Security Architecture
      • Authentication System: Deep Dive
      • Database Architecture
      • Network Architecture and Integration System
      • Integration Architecture: Building Extensions
    • Installing SFP Server
    • Initializing SFP server
  • API Reference
    • Health
    • Authentication
    • Token
    • Salesforce
    • Team
    • Users
    • Tasks
    • Key Value
    • Repository
    • WebHooks
  • Metrics
    • Available Metrics
    • Custom Metrics
    • Configuring Collectors
      • Datadog
      • Splunk
      • New Relic
      • StatsD
  • Helpers
    • Managing Shared Resources
  • Command Guide
    • Core
      • Build
      • Quickbuild
      • Publish
      • Install
      • Release
    • Advanced
      • Validate
      • Artifacts
      • Changelog
      • Impact
      • Pool
      • Metrics
      • Repo
    • Utilities
      • Apex Tests
      • Flow
      • Dependency
      • Profile
  • FAQs
    • Common Errors
      • Org Shapes
      • Troubleshooting Unlocked Packages Build Failure Due to Code Coverage
    • Common Questions
      • Email Templates Deployment: Classic vs Lightning
      • Dealing with Long Build Times in Salesforce
      • Standard ValueSets and unlocked packages
      • Common Issues encountered with aliasfied packages
      • API Version
      • Understanding alwaysDeploy and skipIfAlreadyInstalled in Deployment Pipelines
    • sfp versioning and upgrade Process
  • References
  • Legal
    • Terms of Service for sfp
    • Terms of Service for 'sfp-pro' Software
  • LLMs.txt
Powered by GitBook
On this page
  1. Running sfp as a server

Initializing SFP server

sfp-pro
sfp (community)

Availability

✅

❌

From

December 24

The sfp server init command is used to set up and configure an SFP server instance. This command creates the necessary directory structure, generates configuration files, and initializes the database.

Basic Usage

sfp server init --tenant my-app

This command will:

  1. Create a directory structure for your tenant at ./sfp-server/tenants/my-app

  2. Generate Docker Compose and Caddy configuration files

  3. Collect required secrets (prompting if needed)

  4. Initialize the Supabase database with required schema

  5. Start the server containers

  6. Create a default admin user

Command Options

Required Parameters

  • --tenant: Name of the tenant (required, must be lowercase alphanumeric with hyphens)

Environment Configuration

  • --mode: Server mode, either 'dev' or 'prod' (default: 'prod')

  • --domain: Domain name for the server (required in prod mode)

Infrastructure Configuration

  • --worker-counts: Number of workers for critical,normal,batch queues (comma separated, default: 1,1,1)

  • --base-dir: Base directory for the server (default: './sfp-server')

Secrets Configuration

  • --secrets-provider: Type of secrets provider to use (options: 'custom', 'infisical')

  • --infisical-token: Authentication token for Infisical

  • --infisical-workspace: Workspace ID in Infisical

Other Options

  • --interactive: Run in interactive mode to prompt for secrets (default: false)

  • --force: Overwrite existing tenant configuration if it exists

  • --config-file: Path to JSON config file containing server configuration

Example Usage

Development Mode

sfp server init --tenant my-app --mode dev --interactive

Production Mode with Domain

sfp server init --tenant my-app --mode prod --domain example.com --worker-counts 2,3,1

Using Configuration File

sfp server init --tenant my-app --config-file ./server-config.json

Example configuration file:

{
  "domain": "example.com",
  "workerCounts": "2,3,1",
  "secrets": {
    "DOCKER_REGISTRY": "ghcr.io",
    "DOCKER_REGISTRY_TOKEN": "your-token",
    "SUPABASE_DB_URL": "postgresql://postgres:password@localhost:5432/postgres",
    "SUPABASE_URL": "https://your-project.supabase.co",
    "SUPABASE_SERVICE_KEY": "your-service-key",
    "SUPABASE_ANON_KEY": "your-anon-key",
    "SUPABASE_JWT_SECRET": "your-jwt-secret",
    "SUPABASE_ENCRYPTION_KEY": "your-encryption-key",
    "GITHUB_TOKEN": "your-github-token",
    "AUTH_USE_GLOBAL_AUTH": "false",
    "AUTH_SUPABASE_URL": "https://your-project.supabase.co",
    "AUTH_SUPABASE_ANON_KEY": "your-anon-key",
  }
}

Post-Initialization

After successful initialization, the command outputs:

  • Tenant URL and access details

  • Available management commands

  • Service status information

You can manage the initialized server using other sfp server commands:

sfp server logs <tenant>     # View server logs
sfp server status <tenant>   # Check server status
sfp server stop <tenant>     # Stop server
sfp server update <tenant>   # Update server configuration

Note: For production deployments, ensure you have configured your domain DNS settings and have necessary SSL certificates before initialization.

Warning: The --force flag will overwrite existing configurations. Use with caution in production environments.

Last updated 1 day ago