Setup Workflow

Jump to bottom

Lars Krämer edited this page Aug 23, 2025 · 3 revisions

HTTP GET /setup/availability

checks whether setup is available (or whether a setup is already running).

HTTP GET /setup/licenses

checks the status of licenses and returns all current project licenses.

HTTP GET /setup/database/configuration

checks whether a database configuration is specified in the environment variables and returns it.

HTTP POST /setup/database/check

checks the database with the given access data and returns the supported database type (e.g., PostgreSQL, MySQL, etc.).

HTTP GET /setup/user

checks whether a Homebook admin user has been specified in the environment variables.

HTTP GET /setup/configuration

checks whether the Homebook instance configuration has been specified in the environment variables (name, etc.) and returns it.

HTTP POST /setup/start

starts the setup process. If necessary, further configurations can be specified here.