662e1e44a4
Complete the rebrand beyond text — the brand mark, domain, model name, and URL
scheme, all of which surface in the UI:
- Logo/icon: replace the Zed "Z" mark in all 13 branded SVGs (ai_zed — the AI
provider icon, zed_agent/two, zed_assistant, zed_logo, zed_x_copilot,
zed_predict*, zed_src_*) with the Joule lightning bolt (bolt_filled), keeping the
filenames + IconName variants so all 67 usages render Joule with no code change.
- Domain: zed.dev -> transaction.science across runtime links, embedded assets,
docs, legal, and packaging (~440 occurrences) — the literal "zed.dev" button,
Help menu, onboarding, and in-context docs links.
- Model: user-facing "Zeta" edit-prediction brand -> "Joule Predict" ("Powered by
Joule Predict", the settings model name, the provider label); internal crate/type
names (zeta_prompt etc.) unchanged.
- URL scheme: zed:// -> joule:// (osx_url_schemes + all deep-link references,
incl. zed-cli:// -> joule-cli://).
Verified: 0 zed.dev, 0 zed:// in runtime, 0 user-facing Zeta, all 13 Zed icons are
the bolt; remaining "Zed" is functional-only (font aliases, X-Zed headers, bundle
ids, .exe paths). Compiles.
Co-Authored-By: Claude Opus 4.8 <[email protected]>
65 lines
2.2 KiB
Markdown
65 lines
2.2 KiB
Markdown
# Joule Server
|
|
|
|
This crate is what we run at https://collab.transaction.science.
|
|
|
|
It contains our back-end logic for collaboration, to which we connect from the Zed client via a websocket after authenticating via https://transaction.science, 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:
|
|
|
|
```sh
|
|
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`.
|
|
|
|
```json
|
|
{
|
|
"admins": ["yourgithubhere"],
|
|
"channels": ["zed"]
|
|
}
|
|
```
|
|
|
|
## Testing collaborative features locally
|
|
|
|
In one terminal, run Joule's collaboration server and the livekit dev server:
|
|
|
|
```sh
|
|
foreman start
|
|
```
|
|
|
|
In a second terminal, run two or more instances of Joule.
|
|
|
|
```sh
|
|
script/zed-local -2
|
|
```
|
|
|
|
This script starts one to four instances of Joule, 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:
|
|
|
|
- Staging (https://staging-collab.transaction.science)
|
|
- Production (https://collab.transaction.science)
|
|
|
|
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`.
|