Skip to content

Commit f854890

Browse files
committed
revert rename in docs
1 parent 18ef271 commit f854890

File tree

9 files changed

+45
-15
lines changed

9 files changed

+45
-15
lines changed

.github/workflows/ci.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,12 @@ jobs:
1212
- name: Checkout
1313
uses: actions/checkout@v2
1414
- name: Pull images
15-
run: docker compose pull
15+
run: docker-compose pull
1616
- name: Start services
17-
run: docker compose up --build -d
17+
run: docker-compose up --build -d
1818
- name: Wait for services
1919
run: |
20-
while status="$(docker inspect --format="{{if .Config.Healthcheck}}{{print .State.Health.Status}}{{end}}" "$(docker compose ps -q php)")"; do
20+
while status="$(docker inspect --format="{{if .Config.Healthcheck}}{{print .State.Health.Status}}{{end}}" "$(docker-compose ps -q php)")"; do
2121
case $status in
2222
starting) sleep 1;;
2323
healthy) exit 0;;

Dockerfile

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,12 @@ RUN composer create-project "symfony/skeleton ${SYMFONY_VERSION}" . --stability=
9898
composer clear-cache
9999

100100
###> recipes ###
101+
###> doctrine/doctrine-bundle ###
102+
RUN apk add --no-cache --virtual .pgsql-deps postgresql-dev; \
103+
docker-php-ext-install -j$(nproc) pdo_pgsql; \
104+
apk add --no-cache --virtual .pgsql-rundeps so:libpq.so.5; \
105+
apk del .pgsql-deps
106+
###< doctrine/doctrine-bundle ###
101107
###< recipes ###
102108

103109
COPY . .

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ A [Docker](https://www.docker.com/)-based installer and runtime for the [Symfony
77
## Getting Started
88

99
1. If not already done, [install Docker Compose](https://docs.docker.com/compose/install/)
10-
2. Run `docker compose up` (the logs will be displayed in the current shell)
10+
2. Run `docker-compose up` (the logs will be displayed in the current shell)
1111
3. Open `https://localhost` in your favorite web browser and [accept the auto-generated TLS certificate](https://stackoverflow.com/a/15076602/1352334)
1212

1313
## Features

docker-compose.override.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,9 @@ services:
1717
volumes:
1818
- ./docker/caddy/Caddyfile:/etc/caddy/Caddyfile:ro
1919
- ./public:/srv/app/public:ro
20+
21+
###> doctrine/doctrine-bundle ###
22+
database:
23+
ports:
24+
- "5432"
25+
###< doctrine/doctrine-bundle ###

docker-compose.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,25 @@ services:
5454
published: 443
5555
protocol: udp
5656

57+
###> doctrine/doctrine-bundle ###
58+
database:
59+
image: postgres:${POSTGRES_VERSION:-13}-alpine
60+
environment:
61+
POSTGRES_DB: ${POSTGRES_DB:-app}
62+
# You should definitely change the password in production
63+
POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:-ChangeMe}
64+
POSTGRES_USER: ${POSTGRES_USER:-symfony}
65+
volumes:
66+
- db-data:/var/lib/postgresql/data:rw
67+
# You may use a bind-mounted host directory instead, so that it is harder to accidentally remove the volume and lose all your data!
68+
# - ./docker/db/data:/var/lib/postgresql/data:rw
69+
###< doctrine/doctrine-bundle ###
70+
5771
volumes:
5872
php_socket:
5973
caddy_data:
6074
caddy_config:
75+
76+
###> doctrine/doctrine-bundle ###
77+
db-data:
78+
###< doctrine/doctrine-bundle ###

docs/build.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
# Build Options
22

3-
## Selection a Symfony Skeleton
3+
## Selecting a Symfony Skeleton
44

55
By default, Symfony Docker will install the minimalist skeleton.
66
To install the ["website skeleton"](https://symfony.com/doc/current/setup.html#creating-symfony-applications), use the following command:
77

8-
SKELETON=symfony/website-skeleton docker compose up --build
8+
SKELETON=symfony/website-skeleton docker-compose up --build
99

1010
## Selecting a Specific Symfony Version
1111

1212
Use the `SYMFONY_VERSION` environment variable to select a specific Symfony version.
1313

1414
For instance, use the following command to install Symfony 4.4:
1515

16-
SYMFONY_VERSION=4.4.* docker compose up --build
16+
SYMFONY_VERSION=4.4.* docker-compose up --build
1717

1818
## Installing Development Versions of Symfony
1919

@@ -22,12 +22,12 @@ The value must be [a valid Composer stability option](https://getcomposer.org/do
2222

2323
For instance, use the following command to use the `master` branch of Symfony:
2424

25-
STABILITY=dev docker compose up --build
25+
STABILITY=dev docker-compose up --build
2626

2727
## Customizing the Server Name
2828

2929
Use the `SERVER_NAME` environment variable to define your custom server name(s).
3030

31-
SERVER_NAME="symfony.wip, caddy:80" docker compose up --build
31+
SERVER_NAME="symfony.wip, caddy:80" docker-compose up --build
3232

3333
If you use Mercure, keep `caddy:80` in the list to allow the PHP container to request the caddy service.

docs/production.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ Go into the directory containing your project (`<project-name>`), and start the
6666
SERVER_NAME=your-domain-name.example.com \
6767
APP_SECRET=ChangeMe \
6868
CADDY_MERCURE_JWT_SECRET=ChangeMe \
69-
docker compose -f docker-compose.yml -f docker-compose.prod.yml up -d
69+
docker-compose -f docker-compose.yml -f docker-compose.prod.yml up -d
7070
```
7171

7272
Be sure to replace `your-domain-name.example.com` by your actual domain name and to set the values of `APP_SECRET`, `CADDY_MERCURE_JWT_SECRET` to cryptographically secure random values.

docs/troubleshooting.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,16 @@
22

33
## Editing Permissions on Linux
44

5-
If you work on linux and cannot edit some of the project files right after the first installation, you can run `docker compose run --rm php chown -R $(id -u):$(id -g) .` to set yourself as owner of the project files that were created by the docker container.
5+
If you work on linux and cannot edit some of the project files right after the first installation, you can run `docker-compose run --rm php chown -R $(id -u):$(id -g) .` to set yourself as owner of the project files that were created by the docker container.
66

77
## Fix Chrome/Brave SSL
88

99
If you have a TLS trust issues, you can copy the self-signed certificate from Caddy and add it to the trusted certificates :
1010

1111
# Mac
12-
$ docker cp $(docker compose ps -q caddy):/data/caddy/pki/authorities/local/root.crt /tmp/root.crt && sudo security add-trusted-cert -d -r trustRoot -k /Library/Keychains/System.keychain /tmp/root.crt
12+
$ docker cp $(docker-compose ps -q caddy):/data/caddy/pki/authorities/local/root.crt /tmp/root.crt && sudo security add-trusted-cert -d -r trustRoot -k /Library/Keychains/System.keychain /tmp/root.crt
1313
# Linux
14-
$ docker cp $(docker compose ps -q caddy):/data/caddy/pki/authorities/local/root.crt /usr/local/share/ca-certificates/root.crt && sudo update-ca-certificates
14+
$ docker cp $(docker-compose ps -q caddy):/data/caddy/pki/authorities/local/root.crt /usr/local/share/ca-certificates/root.crt && sudo update-ca-certificates
1515

1616
## HTTPs and Redirects
1717

docs/xdebug.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,15 +52,15 @@ services:
5252
Then run:
5353
5454
```console
55-
docker compose -f docker-compose.yml -f docker-compose.debug.yml up -d
55+
docker-compose -f docker-compose.yml -f docker-compose.debug.yml up -d
5656
```
5757

5858
## Troubleshooting
5959

6060
Inspect the installation with the following command. The requested Xdebug version should be displayed in the output.
6161

6262
```console
63-
$ docker compose exec php php --version
63+
$ docker-compose exec php php --version
6464

6565
PHP ...
6666
with Xdebug v3.0.4 ...

0 commit comments

Comments
 (0)