Show HN: Oolong – Lightweight Transparency Exchange API Implementation

2 hours ago 1

Social:

This project is a lightweight implementation of Transparency Exchange API which uses NestJS framework.

If you are looking for a full-featured TEA server implementation with UI and built-in artifact storage, please refer to ReARM.

Live demo server is currently operating at oolong-demo.rearmhq.com.

I.e., you can access well-known at https://oolong-demo.rearmhq.com/.well-known/tea.

Also you can download ReARM CLI and try out full flow with TEI urn:tei:asin:oolong-demo.rearmhq.com:B09D6HR559

using

rearm tea full_tea_flow --debug true --tei urn:tei:asin:oolong-demo.rearmhq.com:B09D6HR559

We provided oolong/sample_content/ directory for development and testing purposes.

Oolong uses oolong/oolong-server/src/content/ directory to serve TEA content (this is under .gitignore). You can copy the content from oolong/sample_content/ to oolong/oolong-server/src/content/ directory directly when running via npm.

The provided Dockerfile will package content from oolong/content/ directory. This way the content will be baked into the container image.

Alternatively, you can mount the content with docker-compose or using git pod in the helm chart installation. If using git pod option, the content will be synchronized with the git repository at the specified interval (currently, only public git repositories are supported).

For content management, use ReARM CLI. See documentation for oolong content management commands here.

cd oolong docker build -t oolong-local .

The following command shows how to run the container image with a custom content directory and environment variables.

docker run -p 3000:3000 \ -v /path/to/content:/app/src/content \ -e API_VERSION=v0.2.0-beta.2 \ -e SERVER_HOST=https://myserver.com/tea \ oolong-local

It is possible to mount the content directory to the container and use it as a volume. This way, you can update the content directory and the container will use the updated content.

Use the pre-built image from the registry:

This will run the server on http://localhost:3005 using the image from registry.relizahub.com/library/oolong-server.

Build and run from local Dockerfile with development settings:

docker-compose -f docker-compose.dev.yml up -d --build

This will build the image locally and run with NODE_ENV=development.

Both configurations:

Mount the ./oolong/content directory to serve TEA content
Run on port 3005 (mapped to container port 3000)
Set API_VERSION=v0.2.0-beta.2
Set SERVER_HOST=http://localhost:3005

Installation via helm chart

Using local chart (development mode)

helm upgrade --install --create-namespace -n oolong oolong helm-chart/oolong \ --version 0.0.7

Sample installation on k3d:

helm upgrade --install --create-namespace -n oolong --set useTraefikDevelopment=true \ --set env.SERVER_HOST='http://oolong.localhost:8003' oolong helm-chart/oolong \ --version 0.0.7

Using official chart from registry

helm upgrade --install --create-namespace -n oolong oolong registry.relizahub.com/library/oolong \ --version 0.0.7

Enable automatic Git synchronization to populate content from a Git repository. Note, currently, only public repositories are supported.

helm upgrade --install --create-namespace -n oolong \ --set gitPod.enabled=true \ --set gitPod.repoUrl='https://github.com/your-org/your-repo.git' \ --set gitPod.branch='main' \ --set gitPod.syncInterval='60' \ oolong helm-chart/oolong \ --version 0.0.7

Configuration options:

gitPod.enabled - Enable/disable Git pod (default: false)
gitPod.repoUrl - Git repository URL (required when enabled)
gitPod.branch - Git branch to sync (default: main)
gitPod.syncInterval - Sync interval in seconds (default: 60)
gitPod.mountPath - Mount path for content (default: /content)

The Git pod will clone the repository and perform git pull at the specified interval, keeping the content synchronized with the remote repository.

Generation from TEA OpenAPI Specification

npx @openapitools/openapi-generator-cli version-manager set 7.16.0 npx @openapitools/openapi-generator-cli generate -i tea-spec/openapi.yaml -g typescript-nestjs-server -o oolong/oolong-server/src/generated-nest/