Skip to content

P hoffmann/readme #152

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
p-hoffmann merged 2 commits into from
Apr 30, 2026
Merged

P hoffmann/readme #152

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5129ceb
update readme
p-hoffmann Apr 30, 2026
bc3780e
update readme
p-hoffmann Apr 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 10 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,18 @@

[![Docker Build and Up](https://github.com/ohdsi/trex/actions/workflows/docker-build-push.yml/badge.svg)](https://github.com/ohdsi/trex/actions/workflows/docker-build-push.yml)    [![NPM build package](https://github.com/ohdsi/trex/actions/workflows/npm-ci.yml/badge.svg)](https://github.com/ohdsi/trex/actions/workflows/npm-ci.yml)

`trex-runtime` is the edge function runtime used by [Trex](https://github.com/OHDSI/trex). It hosts the JavaScript / TypeScript functions that back HTTP routes, plugin APIs, and server-side workloads inside the `trex` binary, and is the execution environment that Supabase-style edge functions run in within this project.
`trex-runtime` is the edge function runtime used by [Trex](https://github.com/OHDSI/trex). It hosts the JavaScript / TypeScript functions that back HTTP routes, plugin APIs, and server-side workloads inside the `trex` binary, and is the execution environment in which Supabase-compatible edge functions run within this project.

It is a fork of the [Supabase Edge Runtime](https://github.com/supabase/edge-runtime), updated to track Deno **2.7.12**.
It is a fork of the [Supabase Edge Runtime](https://github.com/supabase/edge-runtime).

## Role in Trex
## Why a fork?

Upstream Supabase Edge Runtime is built for the Supabase cloud platform, tuned for large-scale, multi-tenant deployment. Trex is a lightweight, self-hosted backend platform that integrates an analytical-first database engine (DuckDB-based) alongside Postgres, and this fork lets us shape the edge runtime to fit that profile while staying API-compatible with Supabase Edge Functions.

- Embedded as a Rust crate alongside the analytical engine and the Postgres-wire layer, so HTTP requests reaching `:8001` / `:8000` can be dispatched into user-supplied edge functions without leaving the `trex` process.
- Loads encrypted secrets from the core platform at invocation time and exposes them as plain environment variables, so functions can read them without bundling secrets into images.
- Compatible with the Supabase Edge Functions developer experience (deploy, secrets, local dev via the Supabase CLI fork) while running on a newer Deno toolchain.
The fork also lets us track our own Deno release cadence. trex-runtime currently sits on Deno 2.7.12, kept in step with the rest of the Trex stack rather than with the upstream service's release schedule.

## Role in Trex

## Get in contact
- Integrated alongside the analytical engine and the Postgres-wire layer, so HTTP requests can be dispatched into user-supplied edge functions without leaving the `trex` process.
- Compatible with the Supabase Edge Functions developer experience (deploy, secrets, local dev via the Trex CLI, itself a fork of the Supabase CLI).

Please [click here](https://discord.gg/5XtHky2BZe) to join us in Discord.
Loading