Skip to content
GitHub

Frontend service

Rafiki’s frontend service provides an optional internal admin interface, called the Rafiki Admin application, for you to manage your Rafiki instance through a Remix web app. This service communicates with the Backend Admin API to facilitate administrative tasks within Rafiki.

Requirements

The following are required when using the frontend service:

  • A Rafiki backend service up and running to access the Backend Admin API.
  • An identity provider for authentication and user management. Out of the box, the Rafiki Admin application uses Ory Kratos, a secure and fully open-source identity management solution.

You must also set the environment variables for the frontend service.

Rafiki Admin settings

While the frontend service is not required to run a Rafiki instance, it is highly recommended. A number of administrative tasks could be performed programmatically via the Backend Admin API, but the frontend service makes these functions available through a user-friendly interface.

Environment variables

VariableHelm Value NameDefaultDescription
GRAPHQL_URLfrontend.serviceUrls.GRAPHQL_URLundefinedURL for the GraphQL Admin API and it’s required
OPEN_PAYMENTS_URLfrontend.serviceUrls.OPEN_PAYMENTS_URLundefinedOpen Payments API Endpoint and it’s required
PORTfrontend.port3005Port from which to host the Remix app
ENABLE_INSECURE_MESSAGE_COOKIEtrueValues of true, t, 1 will not use a secure message cookie which is required for flash messages to work over http. When not set, the secure flag is set to true.