Skip to content

Commit

Permalink
add usage notes
Browse files Browse the repository at this point in the history
  • Loading branch information
joshuanianji committed Aug 22, 2024
1 parent fad0fc9 commit 4480629
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions src/edgedb-cli/NOTES.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,14 @@
## Usage

**The EdgeDB instance should not be in the same container as the CLI.** My experience doing so makes the `edgedb ui` command start failing once you restart the container. I recommend the following options:

1. Use a docker-compose template with two services: one for the CLI and one for the EdgeDB instance.

You can either use the [javascript-node-edgedb](https://github.com/joshuanianji/devcontainer-templates/blob/main/src/javascript-node-edgedb) or the [rust-edgedb](https://github.com/joshuanianji/devcontainer-templates/blob/main/src/rust-edgedb) templates, or use them as references to make your own.

Once inside the devcontainer, you can run `edgedb instance link` to connect the CLI to the instance. Check the templates above for more details.

2. Connect to a cloud instance [with `edgedb cloud`](https://docs.edgedb.com/cloud/cli).

## Notes on Volume Mounts

Expand Down

0 comments on commit 4480629

Please sign in to comment.