Introduction

Factrove is a self-hostable library for HTML artifacts, with a web app, HTTP API, and CLI.

Factrove keeps HTML artifacts in one place you run yourself. People and agents upload files, the web app lists them, and a viewer opens the stored HTML.

This site documents the code in this repository. It does not describe a hosted product, a price, or a launch date. The software is licensed under the GNU Affero General Public License v3.0 or later.

​

What you get

• A web app for sign-in, the library, and the viewer
• An HTTP API for artifacts, public shares, and API keys
• A CLI that uploads files, prints content, and manages share links. The published package is factrove (npm i -g factrove). ftrv runs the same program. A checkout of this repository uses pnpm factrove.

The API owns PostgreSQL metadata and object storage. The web app and CLI only know HTTP origins.

​

Links use a base URL you set

Viewer and share URLs are a configured origin plus the artifact path. The API reads PUBLIC_BASE_URL (and falls back to WEB_ORIGIN when that is unset). Setting the variable does not start a server or publish the app.

Local:

http://localhost:3000/artifacts/{id}
http://localhost:3000/share/{id}/{token}

A self-hosted origin you choose:

https://library.example.com/artifacts/{id}
https://library.example.com/share/{id}/{token}

​

Where to go next

• Quickstart gets the source and runs the local loop
• Concepts explains artifacts, HTML delivery, access, and shares
• Self-hosting runs the Docker Compose stack, or the same apps from source
• CLI covers commands, flags, and config precedence
• Sharing links covers public URLs and optional passwords
• Troubleshooting covers ports, origins, cookies, and links