Start

Start a tenant's services

Secrets Management: This command supports multiple options for secrets management:

  • infisical: Use Infisical as a dedicated secrets manager

  • aws-secretsmanager: Use AWS Secrets Manager

  • custom: Use environment variables (recommended when using tools like "infisical run" or AWS CLI)

For custom secrets provider, inject secrets as environment variables before running the command. Example: infisical run -- sfp server start --tenant my-app --secrets-provider custom

sfp server start

Start a tenant's services

USAGE
  $ sfp server start -t <value> [-j] [--daemon] [--no-browser] [--base-dir <value>] [-r] [--config-file
    ./server-config.json] [--passphrase <value> [--identity-file <value> --ssh-connection <value>]] [--infisical-token
    <value> --secrets-provider infisical|aws-secretsmanager|custom] [--aws-region <value> ] [--aws-access-key-id <value>
    ] [--aws-secret-access-key <value> ] [-g <value>...] [--loglevel
    trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

FLAGS
  -g, --logsgroupsymbol=<value>...
      Symbol used by CICD platform to group/collapse logs in the console. Provide an opening group, and an optional
      closing group symbol.

  -j, --[no-]json
      Output in JSON format

  -r, --restart
      Restart server if already running

  -t, --tenant=<value>
      (required) Name of the tenant to start

  --aws-access-key-id=<value>
      AWS access key ID. Optional when secrets-provider is "aws-secretsmanager" (can use instance profile).

  --aws-region=<value>
      AWS region for Secrets Manager. Required only when secrets-provider is "aws-secretsmanager".

  --aws-secret-access-key=<value>
      AWS secret access key. Optional when secrets-provider is "aws-secretsmanager" (can use instance profile).

  --base-dir=<value>
      [default: ./sfp-server] Base Directory which contains the sfp-server

  --config-file=./server-config.json
      Path to JSON config file containing server configuration values

  --daemon
      Run server in daemon mode (detached)

  --identity-file=<value>
      Path to SSH private key file

  --infisical-token=<value>
      Infisical API token. Required only when secrets-provider is "infisical".

  --loglevel=<option>
      [default: info] logging level for this command invocation
      <options: trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL>

  --no-browser
      Disable automatic browser opening

  --passphrase=<value>
      Passphrase for the SSH private key if required

  --secrets-provider=<option>
      [default: custom] Secret provider to use for managing secrets. Available options:
      - infisical: Use Infisical as secrets provider
      - aws-secretsmanager: Use AWS Secrets Manager
      - custom: Use environment variables (suitable when using external tools like "infisical run" or AWS CLI)
      <options: infisical|aws-secretsmanager|custom>

  --ssh-connection=<value>
      SSH connection string in the format user@host[:port]

DESCRIPTION
  Start a tenant's services

  Secrets Management:
  This command supports multiple options for secrets management:
  - infisical: Use Infisical as a dedicated secrets manager
  - aws-secretsmanager: Use AWS Secrets Manager
  - custom: Use environment variables (recommended when using tools like "infisical run" or AWS CLI)

  For custom secrets provider, inject secrets as environment variables before running the command.
  Example: infisical run -- sfp server start --tenant my-app --secrets-provider custom

EXAMPLES
  $ sfp server start --tenant my-app

  $ sfp server start --tenant my-app --ssh-connection [email protected] --identity-file ~/.ssh/id_rsa

  $ sfp server start --tenant my-app --secrets-provider custom

  $ sfp server start --tenant my-app --secrets-provider infisical

  $ sfp server start --tenant my-app --secrets-provider aws-secretsmanager --aws-region us-east-1

See code: src/commands/server/start.tsarrow-up-right

Last updated

Was this helpful?