github-personal/firezone
1
0
Fork 0
mirror of https://github.com/outbackdingo/firezone.git synced 2026-01-27 10:18:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add note for compose v2 (#5110)

Browse Source 
fixes #4641

---------

Signed-off-by: Jamil <jamilbk@users.noreply.github.com>
Co-authored-by: Reactor Scram <ReactorScram@users.noreply.github.com>
This commit is contained in:
Jamil
2024-05-23 11:03:01 -07:00
committed by GitHub
parent 8412bf5b02
commit 8feb708730
1 changed files with 16 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
docs/CONTRIBUTING.md
View File

@@ -58,7 +58,16 @@ Firezone component.
We recommend [Docker Desktop](https://docs.docker.com/engine/install/#desktop)
even if you're developing on Linux. This is what the Firezone core devs use and
comes with `compose` included.
comes with the correct version of `compose` included.
If you're using Docker Engine on Linux instead, you'll want to make sure to
[ install the compose plugin ](https://docs.docker.com/compose/install/#scenario-two-install-the-compose-plugin)
instead so that you have v2 installed.
```bash
> docker compose version
Docker Compose version v2.27.0
```
#### Test With Docker
@@ -97,8 +106,8 @@ docker compose exec -it client /bin/sh
##### Rust development with docker
Sometimes it's useful to test your changes in a local docker, however the
`docker-compose.yml` file at the root directory requires rebuilding the
images each time you want to test the change.
`docker-compose.yml` file at the root directory requires rebuilding the images
each time you want to test the change.
To solve this, you can use the `rust/docker-compose-dev.yml` file like
`docker compose -f docker-compose.yml -f rust/docker-compose-dev.yml <command>`
@@ -106,7 +115,7 @@ To solve this, you can use the `rust/docker-compose-dev.yml` file like
This will use locally compiled binaries situated at
`rust/target/x86_64-unknown-musl/debug`
You can also set use the env variable `COMPOSE_FILE` as explained [here](https://docs.docker.com/compose/environment-variables/envvars/#compose_file)
You can also [set the env variable `COMPOSE_FILE`](https://docs.docker.com/compose/environment-variables/envvars/#compose_file)
so you don't have to manually set the compose files each time.
### Bootstrapping
@@ -166,11 +175,9 @@ setup properly.
### asdf-vm Setup
While not strictly required, we use [asdf-vm](https://asdf-vm.com) to manage
language versions for Firezone. You'll need to install the language runtimes
according to the versions laid out in the [.tool-versions](../.tool-versions) file.
If using asdf, simply run `asdf install` from the project root.
We use [asdf-vm](https://asdf-vm.com) to manage
language versions for Firezone. Install the language runtimes
defined in the [.tool-versions](../.tool-versions) file by running `asdf install` from the project root.
- Note: For a fresh install of `asdf` you will need to install some
[asdf-plugins](https://asdf-vm.com/manage/plugins.html). Running