1# Local Collaboration
  2
  3First, make sure you've installed Zed's backend dependencies for your platform:
  4
  5- [macOS](./macos.md#backend-dependencies)
  6- [Linux](./linux.md#backend-dependencies)
  7- [Windows](./windows.md#backend-dependencies)
  8
  9## Database setup
 10
 11Before you can run the `collab` server locally, you'll need to set up a `zed` Postgres database.
 12
 13### On macOS and Linux
 14
 15```sh
 16script/bootstrap
 17```
 18
 19This 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.
 20
 21The script will seed the database with various content defined by:
 22
 23```sh
 24cat crates/collab/seed.default.json
 25```
 26
 27To use a different set of admin users, you can create your own version of that json file and export the `SEED_PATH` environment variable. Note that the usernames listed in the admins list currently must correspond to valid Github users.
 28
 29```json
 30{
 31  "admins": ["admin1", "admin2"],
 32  "channels": ["zed"]
 33}
 34```
 35
 36### On Windows
 37
 38```powershell
 39.\script\bootstrap.ps1
 40```
 41
 42## Testing collaborative features locally
 43
 44### On macOS and Linux
 45
 46Ensure that Postgres is configured and running, then run Zed's collaboration server and the `livekit` dev server:
 47
 48```sh
 49foreman start
 50# OR
 51cargo run -p collab -- serve all
 52```
 53
 54In a new terminal, run two or more instances of Zed.
 55
 56```sh
 57script/zed-local -2
 58```
 59
 60This 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 `.admins.json` or `.admins.default.json`.
 61
 62### On Windows
 63
 64Since `foreman` is not available on Windows, you can run the following commands in separate terminals:
 65
 66```powershell
 67cargo run --package=collab -- serve all
 68```
 69
 70If you have added the `livekit-server` binary to your `PATH`, you can run:
 71
 72```powershell
 73livekit-server --dev
 74```
 75
 76Otherwise,
 77
 78```powershell
 79.\path\to\livekit-serve.exe --dev
 80```
 81
 82In a new terminal, run two or more instances of Zed.
 83
 84```powershell
 85node .\script\zed-local -2
 86```
 87
 88Note that this requires `node.exe` to be in your `PATH`.
 89
 90## Running a local collab server
 91
 92If you want to run your own version of the zed collaboration service, you can, but note that this is still under development, and there is no good support for authentication nor extensions.
 93
 94Configuration is done through environment variables. By default it will read the configuration from [`.env.toml`](https://github.com/zed-industries/zed/blob/main/crates/collab/.env.toml) and you should use that as a guide for setting this up.
 95
 96By default Zed assumes that the DATABASE_URL is a Postgres database, but you can make it use Sqlite by compiling with `--features sqlite` and using a sqlite DATABASE_URL with `?mode=rwc`.
 97
 98To authenticate you must first configure the server by creating a seed.json file that contains at a minimum your github handle. This will be used to create the user on demand.
 99
100```json
101{
102  "admins": ["nathansobo"]
103}
104```
105
106By default the collab server will seed the database when first creating it, but if you want to add more users you can explicitly reseed them with `SEED_PATH=./seed.json cargo run -p collab seed`
107
108Then when running the zed client you must specify two environment variables, `ZED_ADMIN_API_TOKEN` (which should match the value of `API_TOKEN` in .env.toml) and `ZED_IMPERSONATE` (which should match one of the users in your seed.json)