Last updated

Running From Source on Your Machine

Estimated Time

Starting from scratch, running Catena from source on your machine is estimated to take <10 minutes.

Installation Instructions

1. Obtain Catena source code

Catena is distributed via Git. Instructions for installing Git can be found here.

To gain access to the Catena Source, please contact us to obtain a license. Once you have access, clone Catena to your machine.

git clone git@github.com:CatenaTools/catena-tools-core.git

2. Installing Required Dependencies

.NET 8 SDK

Catena is built with .NET 8.

  1. Download the installer for the .NET SDK from this page. If you need to determine your computer's architecture (x64, x86, or Arm64) you can:
    1. Click Start
    2. Type “system” in the search box
    3. Click “System Information”
    4. Look at the “System Type” entry in the right pane
  2. Once you have downloaded the SDK Installer, run it.

3. Run Catena

  1. Open Powershell.
  2. Run Catena using the .NET SDK you installed.
dotnet run ctc --configEnv Development --project catena-tools-core
  1. Check that Catena is running either by sending a request from this page using the provided interactive API or by using cURL

Send Request from This Page

Loading...

Use cURL

curl -i -X GET \
  http://localhost:5000/api/v1/node_inspection/is_healthy
Response
application/json
{ "isHealthy": true }

What Next?

By default, Catena is run with an assortment of plugins enabled. We recommend exploring what is possible with our included plugins before experimenting with swapping them out for other modules.