diff --git a/CHANGELOG.md b/CHANGELOG.md index 4099ffeb7..508d12184 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## Unreleased + +### Changed + +- Updated the `docker compose` instructions to _Compose V2_ in the documentation + ## 2.36.0 - 2024-01-07 ### Added diff --git a/README.md b/README.md index af5a7a8c9..d128f7948 100644 --- a/README.md +++ b/README.md @@ -118,7 +118,7 @@ We provide official container images hosted on [Docker Hub](https://hub.docker.c Run the following command to start the Docker images from [Docker Hub](https://hub.docker.com/r/ghostfolio/ghostfolio): ```bash -docker-compose --env-file ./.env -f docker/docker-compose.yml up -d +docker compose --env-file ./.env -f docker/docker-compose.yml up -d ``` #### b. Build and run environment @@ -126,8 +126,8 @@ docker-compose --env-file ./.env -f docker/docker-compose.yml up -d Run the following commands to build and start the Docker images: ```bash -docker-compose --env-file ./.env -f docker/docker-compose.build.yml build -docker-compose --env-file ./.env -f docker/docker-compose.build.yml up -d +docker compose --env-file ./.env -f docker/docker-compose.build.yml build +docker compose --env-file ./.env -f docker/docker-compose.build.yml up -d ``` #### Setup @@ -138,7 +138,7 @@ docker-compose --env-file ./.env -f docker/docker-compose.build.yml up -d #### Upgrade Version 1. Increase the version of the `ghostfolio/ghostfolio` Docker image in `docker/docker-compose.yml` -1. Run the following command to start the new Docker image: `docker-compose --env-file ./.env -f docker/docker-compose.yml up -d` +1. Run the following command to start the new Docker image: `docker compose --env-file ./.env -f docker/docker-compose.yml up -d` At each start, the container will automatically apply the database schema migrations if needed. ### Home Server Systems (Community) @@ -158,7 +158,7 @@ Ghostfolio is available for various home server systems, including [Runtipi](htt ### Setup 1. Run `yarn install` -1. Run `docker-compose --env-file ./.env -f docker/docker-compose.dev.yml up -d` to start [PostgreSQL](https://www.postgresql.org) and [Redis](https://redis.io) +1. Run `docker compose --env-file ./.env -f docker/docker-compose.dev.yml up -d` to start [PostgreSQL](https://www.postgresql.org) and [Redis](https://redis.io) 1. Run `yarn database:setup` to initialize the database schema 1. Start the server and the client (see [_Development_](#Development)) 1. Open http://localhost:4200/en in your browser