# pardnchiu/HakoRun

> HakoRun by Pardn Chiu: a self-hosted FaaS in Go that runs Python, JavaScript, and TypeScript functions in an OS-native sandbox.

Maintained by 邱敬幃 Pardn Chiu (pardnchiu), Pardn Co., Ltd, Taiwan · Infrastructure Engineering. Source: https://github.com/pardnchiu/HakoRun

Full text in one file: [English](https://hakorun.pardn.io/llms-full.txt) · [中文](https://hakorun.pardn.io/zh/llms-full.txt)

## Overview

- [Home](https://hakorun.pardn.io/index.md): HakoRun by Pardn Chiu: a self-hosted FaaS in Go that runs Python, JavaScript, and TypeScript functions in an OS-native sandbox.
- [Getting Started](https://hakorun.pardn.io/getting-started.md): Install HakoRun from source, add the Python and Node.js runtimes, start the server, and upload and invoke your first function.

## Concepts

- [Architecture](https://hakorun.pardn.io/architecture.md): How HakoRun's entry point, Gin router, handlers, storage backends, and per-platform sandbox fit together.
- [Core Concepts](https://hakorun.pardn.io/core-concepts.md): Function paths, timestamp versions, and the difference between stored runs and run-now in HakoRun.
- [Script Runtime](https://hakorun.pardn.io/script-runtime.md): How HakoRun wrappers pass input as event, run top-level return, and print results for Python, JavaScript, and TypeScript.
- [Storage](https://hakorun.pardn.io/storage.md): HakoRun's ToriiDB default and Redis build-tag backend, the shared key layout, and how versions are written and read.

## Security

- [Sandbox](https://hakorun.pardn.io/sandbox.md): How HakoRun isolates functions with Bubblewrap on Linux and sandbox-exec seatbelt profiles on macOS.
- [Resource Limits](https://hakorun.pardn.io/resource-limits.md): CPU quota, memory ceiling, request body limit, and execution timeout applied to every HakoRun function run.

## Reference

- [Configuration](https://hakorun.pardn.io/configuration.md): Every HakoRun environment variable with defaults: HTTP port, timeouts, body size, slice limits, and Redis connection.
- [API Reference](https://hakorun.pardn.io/api-reference.md): HakoRun HTTP endpoints POST /upload, POST /run/*path, and POST /run-now with fields and status codes.
- [Responses and SSE](https://hakorun.pardn.io/responses.md): How HakoRun tags results as string, number, json, or text, and the log, result, and error SSE events.

## 中文文件

- [首頁](https://hakorun.pardn.io/zh/index.md): 邱敬幃開發的 HakoRun：以 Go 撰寫的自架 FaaS，在 OS 原生沙箱中執行 Python、JavaScript 與 TypeScript 函式。
- [快速開始](https://hakorun.pardn.io/zh/getting-started.md): 從原始碼安裝 HakoRun、補齊 Python 與 Node.js 執行環境、啟動伺服器並上傳呼叫第一個函式。
- [架構](https://hakorun.pardn.io/zh/architecture.md): HakoRun 的進入點、Gin 路由、Handler、儲存後端與各平台沙箱如何串接。
- [核心概念](https://hakorun.pardn.io/zh/core-concepts.md): HakoRun 的函式路徑、時間戳版本，以及已儲存執行與 run-now 的差異。
- [腳本執行環境](https://hakorun.pardn.io/zh/script-runtime.md): HakoRun wrapper 如何把輸入注入為 event、支援頂層 return，並輸出 Python／JavaScript／TypeScript 結果。
- [儲存後端](https://hakorun.pardn.io/zh/storage.md): HakoRun 預設的 ToriiDB 與建置標籤切換的 Redis 後端、共用 key 配置與版本讀寫方式。
- [沙箱](https://hakorun.pardn.io/zh/sandbox.md): HakoRun 如何以 Linux Bubblewrap 與 macOS sandbox-exec seatbelt profile 隔離函式。
- [資源上限](https://hakorun.pardn.io/zh/resource-limits.md): 每次執行 HakoRun 函式時套用的 CPU 配額、記憶體上限、請求大小上限與執行逾時。
- [設定](https://hakorun.pardn.io/zh/configuration.md): HakoRun 所有環境變數與預設值：HTTP 埠、逾時、請求大小、slice 上限與 Redis 連線。
- [API 參考](https://hakorun.pardn.io/zh/api-reference.md): HakoRun HTTP 端點 POST /upload、POST /run/*path、POST /run-now 的欄位與狀態碼。
- [回應與 SSE](https://hakorun.pardn.io/zh/responses.md): HakoRun 如何將結果標註為 string、number、json 或 text，以及 log、result、error 三種 SSE 事件。

## Optional

- [Release Notes](https://hakorun.pardn.io/released/index.md): pardnchiu/HakoRun changelog by version