Skip to content

Commit 2f092ef

Browse files
committed
update docs with docker-compose changes
1 parent 45d4795 commit 2f092ef

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

Diff for: contributor_docs/installation.md

+1
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ Note that this takes up a significant amount of space on your machine. Make sure
5050
2. Install [Docker Desktop](https://www.docker.com/products/docker-desktop/)
5151
3. Clone this repository and cd into it
5252
4. `$ docker-compose -f docker-compose-development.yml build`
53+
* Note: Depending on which version of Docker Compose you are using, the base command will be either `docker-compose` or `docker compose`. More information about it can be found in Docker Compose's documentation for their [V1 to V2 transition](https://github.com/docker/compose/tree/v1?tab=readme-ov-file#v1-vs-v2-transition-hourglass_flowing_sand).
5354
5. `$ cp .env.example .env`
5455
6. (Optional) Update `.env` with necessary keys to enable certain app behaviors, i.e. add Github ID and Github Secret if you want to be able to log in with Github.
5556
* See the [GitHub API Configuration](#github-api-configuration) section for information on how to authenticate with Github.

0 commit comments

Comments
 (0)