Framework
Sign in Sign up

Self-hosted Framework Cloud

Framework Cloud is open source. Host it for your lab, department, or institution. A single-user installation runs on a personal computer.

A self-hosted server includes the same features as Framework Public Cloud. You manage updates, data, and published artifacts.

Read the installation guide Source code on GitHub

Server components

Each release is a Docker image. Docker Compose runs three containers: a web server, a background worker, and a PostgreSQL database. The worker creates GitHub repositories and sends email.

Download the Compose file and settings template. Start the containers.

The web server obtains a Let’s Encrypt HTTPS certificate for your domain.

Source datasets and analysis code stay on your users' computers and in their repositories. Connected features send project settings, blueprints, and, with the integrity ledger, file fingerprints and related metadata. Publishing uploads the selected artifact and its supporting files. Rendered notebooks can include code, tables, and figures.

Terminal
# Download the Compose file and the settings template curl -fsSLO https://raw.githubusercontent.com/frameworktools/framework-cloud/main/docker/selfhost/compose.yml curl -fsSL https://raw.githubusercontent.com/frameworktools/framework-cloud/main/docker/selfhost/.env.example -o .env # Fill in .env, then start it docker compose up -d

Server features

Blueprints and projects

Built-in and custom blueprints, skills, and project setup. Projects can be local or on GitHub.

Artifact publishing

Every account can publish artifacts. You set the storage, on the server or in a bucket.

Account management

Email links, passkeys, passwords, and optional GitHub sign-in. Registration is configurable.

Single-user mode

Local installation with no sign-in screen. Requests from that computer are signed in as you.

Artifact storage

Artifacts use the server’s disk by default, in a Docker volume. For shared servers, use an S3-compatible bucket, such as Amazon S3, Cloudflare R2, MinIO, or Backblaze B2.

Published HTML can contain scripts. On shared servers, serve HTML from a separate domain, such as files.example.com. Artifact storage configuration

Server administration

Docker host
Docker with the Compose plugin. For a shared server, a domain that points at the machine, with ports 80 and 443 open.
Database and files
PostgreSQL runs in its own container. Back up the database, the storage volume, and the application key.
Email
Sign-in links and password resets need an email service, such as SMTP or Amazon SES. Until it is set up, admins can print sign-in links on the server.
GitHub integration (optional)
Creating projects on GitHub needs a GitHub App for your server. The setup page opens GitHub with the app's settings filled in.
Updates
Pull a newer release and restart. You can pin a version. Database changes run when the server starts.

Credentials saved on the server's setup page are encrypted with its application key. Keep a copy of the key with your backups. Backups and upgrades

Installation

The installation guide covers requirements, configuration, and the first sign-in. Start with Docker unless you already run PHP applications.

Install with Docker

Framework Public Cloud

Framework Public Cloud at framework.pub is free to use. We run and update the server. Each account includes 1 GB of artifact storage.

Create an account on Framework Public Cloud