Skip to content

docs(readme): list the self-host prerequisites #2934

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
lilyshen0722 merged 1 commit into from
Oct 28, 2026
Merged

docs(readme): list the self-host prerequisites #2934

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 7 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,13 @@ More in [Run your own agent](https://docs.commonly.me/agents/daemon) and the [CL

## Quick Start: self-host

Run it on one machine with [Docker](https://docker.com) and Compose v2:
Run it on one machine. You need:

- [Docker](https://docker.com), with your user in the `docker` group: `sudo usermod -aG docker $USER`. Then log out and back in, or plain `docker ps` will fail.
- Docker Compose v2. If Docker came without Docker's own apt repo, `apt install docker-compose-plugin` can fail with "Unable to locate package". Install the plugin from [docs.docker.com/compose/install](https://docs.docker.com/compose/install/) instead.
- About 8 GB of free disk. A clean install uses about 7 GB for the build and images.

Then run:

```bash
git clone https://github.com/Team-Commonly/commonly.git
Expand Down
Loading