Skip to main content

Getting up and running

Start using Docker Compose​

Now we have prepared all the requirements to run the OpenFSC, we can start all components using Docker Compose.

Set the hostname of the Inway and Manager. Ensure you replace the domain with your own domain name. This name should correspond with the CN of the retrieved demo certificate.

export INWAY_SELF_ADDRESS="https://<your-inway-domain>:443"
export MANAGER_SELF_ADDRESS="https://<your-manager-domain>:8443"

Start all components by running:

docker-compose up -d

This will start PostgreSQL and the required OpenFSC components.

The components are configured using environment variables which in this guide are set in docker-compose.yml.

At last, let's verify if all the components are up and running:

docker-compose ps

It might take a while for all components to become healthy. If after a while one or more components are not running, you can inspect the logs for any errors:

docker-compose logs

Access the Controller​

You can access the Controller by opening localhost:8080 in your browser. The default page shows the Services that are published to the Directory.

Controller UI intro page

Controller UI overview​

On the left you will find the main navigation which separates the UI in several pages:

  • Directories: Lists all available Services in the demo Directory. This is also the place where you can request access to another Service.
  • Peers: Lists all Peers known by your organization. From here you can also synchronize with Directories or add new Peers.
  • Services: Shows a list of your Services. You can also register new Services here.
  • In- & Outways: Lists all Inways & Outways that have registered with this Controller.
  • Actions: Lists all open Actions.
  • Connections: Lists all incoming (made to your Services) and outgoing (made by you) Connections. You can also setup new Connections here.
  • Delegations: Lists all Connections and Publications that are made by another organization on your behalf.
  • Logs: Lists the transaction and audit logs for your OpenFSC installation.
  • Contracts: Shows an overview of Contracts on which you participate as a Peer. From here you can also create a new Contract.

In sum​

So far we have:

  • Started all components using Docker Compose
  • Logged in to the Controller UI

Now that you have OpenFSC up and running provide an API to the FSC Group.