Framework Cloud documentation
Framework Cloud is the web companion to the Framework packages for R, Python, and Stata. It holds your blueprints, your author details, and your project definitions. It can create projects on GitHub and host published artifacts and collections.
Framework Cloud is open source. You can use it in two ways:
- Framework Public Cloud (framework.pub). Create a free account and start working. Each account includes free publishing with 1 GB of artifact storage.
- Your own server. Run Framework Cloud for yourself, a lab, or an institution. Every feature is included.
Framework Cloud
- Getting started: create an account, connect R, Python, Stata, or fw, and start your first project.
- Signing in: email links, passkeys, GitHub, and passwords.
- Projects and blueprints: set up projects, and build, borrow, and remix blueprints.
- GitHub integration: sign in with GitHub and create projects as repositories.
- Publishing artifacts: share reports, figures, tables, model outputs, and collections with version histories and optional passwords.
- Framework for Stata: install the Stata package, choose a backend, and publish estimation results.
Self-hosting
- Self-hosting overview: setup options and requirements.
- Docker installation: the recommended way to run a server for a group.
- Local installation: a private, single-user server with no sign-in screen.
- Manual installation: PHP, PostgreSQL, and a web server you manage.
- Server setup: email, GitHub, and storage for published artifacts.
- Configuration reference: every environment variable.
- Maintenance: upgrades, backups, and admin commands.