diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index c351f059e..61d1b5e76 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -7,11 +7,11 @@ - Clone the repository - Ensure your Docker daemon is running - Copy `docker/php/env.example` to `docker/php/env` and customize -- Launch `docker-compose run --rm php composer install` to bootstrap php dependencies -- Launch `docker-compose run --rm php bin/console wallabag:install` to bootstrap your installation -- Launch `docker-compose run --rm php yarn install` to bootstrap dependencies for the frontend -- Launch `docker-compose run --rm php yarn build:dev` to build assets for the frontend -- Launch `docker-compose up -d` to start the stack +- Launch `docker compose run --rm php composer install` to bootstrap php dependencies +- Launch `docker compose run --rm php bin/console wallabag:install` to bootstrap your installation +- Launch `docker compose run --rm php yarn install` to bootstrap dependencies for the frontend +- Launch `docker compose run --rm php yarn build:dev` to build assets for the frontend +- Launch `docker compose up -d` to start the stack You'll then have: - a PHP daemon with standalone web server @@ -20,7 +20,7 @@ You'll then have: You can now access your wallabag instance using that url: `http://127.0.0.1:8000` -If you want to test using an other database than SQLite, uncomment the `postgres` or `mariadb` code from the `docker-compose.yml` file at the root of the repo. Also uncomment related line in the `php` section so the database will be linked to your PHP instance. +If you want to test using an other database than SQLite, uncomment the `postgres` or `mariadb` code from the `compose.yaml` file at the root of the repo. Also uncomment related line in the `php` section so the database will be linked to your PHP instance. ### Using your own PHP server diff --git a/.gitignore b/.gitignore index a7f91d8fa..9e9a525cc 100644 --- a/.gitignore +++ b/.gitignore @@ -15,7 +15,7 @@ .php-cs-fixer.cache .phpunit.result.cache phpunit.xml -docker-compose.override.yml +compose.override.yaml # Parameters /app/config/parameters.yml diff --git a/GNUmakefile b/GNUmakefile index 2037be837..2e7f1b43b 100755 --- a/GNUmakefile +++ b/GNUmakefile @@ -11,7 +11,7 @@ else override ENV = prod endif -DOCKER_COMPOSE_RUNNING := $(shell docker-compose ps -q | grep -q . && echo 1 || echo 0) +DOCKER_COMPOSE_RUNNING := $(shell docker compose ps -q | grep -q . && echo 1 || echo 0) ifeq ($(DOCKER_COMPOSE_RUNNING), 1) PHP := docker compose run --rm php php diff --git a/app/config/parameters.yml.dist b/app/config/parameters.yml.dist index a84567ba1..fd46dd933 100644 --- a/app/config/parameters.yml.dist +++ b/app/config/parameters.yml.dist @@ -1,7 +1,7 @@ # This file is a "template" of what your parameters.yml file should look like parameters: # Uncomment these settings or manually update your parameters.yml - # to use docker-compose + # to use Docker Compose # # database_driver: %env.database_driver% # database_host: %env.database_host% diff --git a/docker-compose.yml b/compose.yaml similarity index 100% rename from docker-compose.yml rename to compose.yaml