Article What is the Installer container image?

The installer image is the install and upgrade entrypoint for Community 14. It should typically be integrated directly into Compose and expected to run and exit before the job and web services start. For standard use, prefer Compose.

Purpose

Use the installer container to:

  • Create the Community databases when they do not exist
  • Create and permission the Community SQL login and user
  • Initialize a new Community site
  • Apply Community database upgrades on later releases

Dependencies

The installer image requires:

  • A reachable SQL Server instance, the same as web and job.
  • SQL administrative credentials
  • Credentials for to-be-created databases and users

It does not depend on web, job, search, or infra.

Configuration

Options available via environmental variables:

  • MSSQL_HOST: MS SQL database server (required)
  • MSSQL_SA_USER: SQL Server administrator user name (required)
  • MSSQL_SA_PASSWORD: SQL Server administrator user name (required)
  • MSSQL_APP_USER: User to create for Community application access (required)
  • MSSQL_APP_PASSWORD: Password for Community application user (required)
  • DB_FORCE_UPGRADE: If the database already exists, the installer will check if its schema patches are current with patches contained within the installer. If current, the installer will exit. DB_FORCE_UPGRADE forces the installer to run a full update even if current. This can be useful if other components need to be updated like stored procedures. (optional, default: false)
  • APP_DB_NAME: Community database name to create and/or upgrade. (optional, default: community_app)
  • REPORTING_DB_NAME: Reporting database name to create and/or upgrade. (optional, default: community_reporting)
  • ADMIN_USERNAME: Default community admin member username when initializing a new community (default: admin)
  • ADMIN_EMAIL Default community admin member email when initializing a new community (default: admin@example.com)
  • ADMIN_PASSWORD Default community admin member password when initializing a new community (default: p)

Volumes and Ports

  • No host port or volumes are required.

Startup Expectations

  • In a fresh environment on startup, installer creates or prepares the databases, database users, community data, community admin users, and exits.
  • In an existing environment on startup, installer checks current schema state and applies required upgrades and exits.
  • DB_FORCE_UPGRADE=true is useful when you need a full database upgrade path even if schema patches alone do not require it.