zed/crates/collab
Joseph T. Lyons a11af20495
Disable auto watch when leaving a call (#57196)
Auto watch's lifespan should be tied to that of the call and it should
not be assumed the user wants to have this on indefinitely (until app
restart), as it's more of a niche feature. This PR disables it when the
user leaves a call.

Self-Review Checklist:

- [X] I've reviewed my own diff for quality, security, and reliability
- [X] Unsafe blocks (if any) have justifying comments
- [X] The content is consistent with the [UI/UX
checklist](https://github.com/zed-industries/zed/blob/main/CONTRIBUTING.md#uiux-checklist)
- [X] Tests cover the new/changed behavior
- [X] Performance impact has been considered and is acceptable

Release Notes:

- N/A
2026-05-19 21:31:34 +00:00
..
k8s collab: Route get_users_by_ids through Cloud (#56105) 2026-05-08 13:34:46 +00:00
migrations Improve bare repo support (#55153) 2026-04-29 13:16:37 +00:00
migrations.sqlite collab: Introduce UserService (#55449) 2026-05-06 18:15:36 +00:00
seed
src collab: Remove unused fields from database user model (#56898) 2026-05-15 17:01:42 +00:00
tests/integration Disable auto watch when leaving a call (#57196) 2026-05-19 21:31:34 +00:00
.env.toml collab: Remove seeding infrastructure (#56562) 2026-05-13 15:44:55 +00:00
Cargo.toml collab: Add request stream support (#56455) 2026-05-12 17:43:06 +00:00
LICENSE-AGPL
README.md collab: Don't run migrations on startup (#44430) 2025-12-08 21:46:52 +00:00
seed.default.json Add more admin to seed script (#34220) 2025-07-10 16:54:00 +00:00

Zed Server

This crate is what we run at https://collab.zed.dev.

It contains our back-end logic for collaboration, to which we connect from the Zed client via a websocket after authenticating via https://zed.dev, which is a separate repo running on Vercel.

Local Development

Database setup

Before you can run the collab server locally, you'll need to set up a zed Postgres database. Follow the steps sequentially:

  1. Ensure you have postgres installed. If not, install with brew install postgresql@15.
  2. Follow the steps on Brew's formula and verify your $PATH contains /opt/homebrew/opt/postgresql@15/bin.
  3. If you hadn't done it before, create the postgres user with createuser -s postgres.
  4. You are now ready to run the bootstrap script:
script/bootstrap

This script will set up the zed Postgres database, and populate it with some users. It requires internet access, because it fetches some users from the GitHub API.

The script will create several admin users, who you'll sign in as by default when developing locally. The GitHub logins for the default users are specified in the seed.default.json file.

To use a different set of admin users, create crates/collab/seed.json.

{
  "admins": ["yourgithubhere"],
  "channels": ["zed"]
}

Testing collaborative features locally

In one terminal, run Zed's collaboration server and the livekit dev server:

foreman start

In a second terminal, run two or more instances of Zed.

script/zed-local -2

This script starts one to four instances of Zed, depending on the -2, -3 or -4 flags. Each instance will be connected to the local collab server, signed in as a different user from seed.json or seed.default.json.

Deployment

We run two instances of collab:

Both of these run on the Kubernetes cluster hosted in Digital Ocean.

Deployment is triggered by pushing to the collab-staging (or collab-production) tag in GitHub. The best way to do this is:

  • ./script/deploy-collab staging
  • ./script/deploy-collab production

You can tell what is currently deployed with ./script/what-is-deployed.