Running the server

As detailed in the "How it works", the server is the orchestration service. The server itself does not execute application code, but instead tracks the state of it using queues, timers, and a database.

It is the most important piece of the architecture. Without it, workers can not operate, and therefore clients can not interact with integrations.


In addition to BLACKSMITH_DIR, BLACKSMITH_ENV, and BLACKSMITH_EXT, the server relies on the following environment variables to properly work:


They are automatically added in .env files when generating an application.

If you need to verify the Blacksmith environment variables, you can run:

$ blacksmith env

Blacksmith environment variables:
  - BLACKSMITH_DIR: blacksmith
  - BLACKSMITH_ENV: development
  - BLACKSMITH_SERVER_URL: localhost:7200

Note that the database URLs are not outputted for security reasons. Depending on your environment, the history might be logged / registered.

Starting the server

You can run the server with:

$ blacksmith start server
Is something missing?

If you notice something we've missed or could be improved on, please follow this link and submit a pull request to the repository. Once we merge it, the changes will be reflected on the website the next time it is deployed.

Thank you for your contributions!