inrule/catalog-manager repository overview

⁠InRule Catalog Manager

The InRule Catalog Manager is the web-based management portal for irCatalog. The Catalog Manager container connects to the InRule Catalog Service.

Note: This image can be deployed as a self-hosted Docker container locally or in Azure/AWS cloud platforms. The following instructions detail the steps for installing locally via Docker Desktop.

⁠What You Need

• Docker installed and running
• Catalog Service URI

Note: The Catalog Service⁠ container should be deployed before the Catalog Manager. This will allow you to obtain the Catalog Service URI.

⁠Required Configuration

The container requires this environment variable:

• InRule__Catalog__Uri — URI of the Catalog Service the manager connects to (for example, https://your-catalog-server/Service.svc/core).

⁠Optional Configuration

This web app supports the following additional settings:

• Connecting to an irCatalog Service and Configuration⁠

⁠Logging

The container writes logs to stdout by default, which outputs to the console log stream. No extra Serilog settings are required. When running in AKS or Amazon ECS, stdout can be forwarded using a log collector or a task logging driver.

To add another Serilog sink and keep console output, set Serilog__WriteTo__1__Name (and later indexes). Setting Serilog__WriteTo__0__Name replaces the console sink.

⁠Run the Container

⁠Bash Example

docker run -d \
  --name inrule-catalog-manager \
  -p 8080:8080 \
  -e InRule__Catalog__Uri="https://your-catalog-server/Service.svc/core" \
  inrule/catalog-manager:latest

Note: The above multi-line command can also be run using Windows PowerShell ISE by substituting the \ end-of-line delimiter with a backtick. The use of the latest tag in the above example is temporarily unavailable, for now you must specify the specific version tag.

⁠Verify the Container Started

⁠Startup Check

This endpoint reports whether the application process has started and is serving traffic:

http://localhost:8080/api/status/startup

Example:

curl http://localhost:8080/api/status/startup

Expected result: HTTP 200 OK

⁠Liveness Check

This endpoint additionally verifies the application can reach its database:

http://localhost:8080/api/status/liveness

Expected result: HTTP 200 OK (returns 503 if the database cannot be reached)

⁠Web UI

Open the Catalog Manager sign-in page in a browser to confirm the application is reachable:

http://localhost:8080/

⁠Documentation

• Overview of the irCatalog Manager Website⁠
• Connecting to an irCatalog Service and Configuration⁠
• irCatalog for Rule Management⁠