Skip to content

Workflow to build and run Kitodo.Production over ngrok

Jump to bottom
Markus Weigelt edited this page May 16, 2023 · 3 revisions

If you want to build and run Kitodo.Production from a specific branch of a repository fork or the base repository e.g. to perform a review or a visual test, then you are in the right place.

This repository contains a workflow with the help of which you can brew and launch Kitodo.Production. Via ngrok you can then access Kitodo.Production, the log viewer and the file browser via a URL.

To do this you have to fork this repository, register with ngrok and set the Auth token of ngrok as repository secret (Settings -> Secrets and variables -> Action -> New repository secret) with the name NGROK_AUTH_TOKEN.

Under Actions of fork repository you will find the workflow Build and run Kitodo.Production over ngrok. With click on that workflow a page with last workflow runs will be opened. When you click the button Run workflow following popup will be displayed.

image

As default the master branch of base Kitodo.Production repository will be used. Adjust the branch and repository inputs and click on Run workflow. If everything works out, Kitodo.Production will be built and launched against this repository and branch. This takes a few minutes.

When the workflow step Run ngrok is active, navigate to ngrok Dashboard and open the agents and click on the active agent.

image

In the panel you will see all exposed ports (Kitodo.Production runs on port 8080, Log Viewer on port 8088 and the File Browser on port 8090) mapped to a specific ngrok URL. Click any URL to navigate to the appropriate application and click on Visit Site. Don't forget to add the context path /kitodo to the Kitodo.Production URL.

The stop the workflow, navigate to ngrok Dashboard and open the agents again and click the stop icon on the active agent and confirm this with the click on Stop Session button in the displayed popup.

Clone this wiki locally