Skip to main content

Run FlowSynx

Running FlowSynx and checking its health.

Step 1: Open terminal​

You will need to use sudo for this quickstart if:

  • You run your Docker commands with sudo, or
  • The install path is /usr/local/bin (default install path).

Step 2: Run the FlowSynx​

flowctl run

After executing this command, FlowSynx starts to be running and the logs like below will be displayed.

[time=2/1/2024 6:50:39 PM | level=INFO | machine=TEST-PC] message="Now listening on: http://[::]:5860"
[time=2/1/2024 6:50:39 PM | level=INFO | machine=TEST-PC] message="Application started. Press Ctrl+C to shut down."
[time=2/1/2024 6:50:39 PM | level=INFO | machine=TEST-PC] message="Hosting environment: Production"
[time=2/1/2024 6:50:39 PM | level=INFO | machine=TEST-PC] message="Content root path: _____________"

Step 3: Verify FlowSynx running​

In order to make sure that FlowSynx is running, just open another terminal window and enter the following command:

flowctl health

Output:​

[
  {
    "Status": "Healthy",
    "Component": "Configuration Registry",
    "Description": "Configuration registry available"
  },
  {
    "Status": "Healthy",
    "Component": "Plugins Registry",
    "Description": "Plugins registry available"
  }
]