From 50335dcfcb0cb2478b017c060fd9ead3aed4f340 Mon Sep 17 00:00:00 2001 From: Stanislau Kviatkouski <7zete7@gmail.com> Date: Wed, 9 Apr 2025 18:03:02 +0300 Subject: [PATCH] docs: update artifacts --- docs/mysql.md | 2 +- docs/options.md | 2 +- docs/tls.md | 2 +- docs/xdebug.md | 23 ++++++++++++++--------- 4 files changed, 17 insertions(+), 12 deletions(-) diff --git a/docs/mysql.md b/docs/mysql.md index ee6f599f6..3ac6335ff 100644 --- a/docs/mysql.md +++ b/docs/mysql.md @@ -10,7 +10,7 @@ Change the database image to use MySQL instead of PostgreSQL in `compose.yaml`: ```diff ###> doctrine/doctrine-bundle ### -- image: postgres:${POSTGRES_VERSION:-15}-alpine +- image: postgres:${POSTGRES_VERSION:-16}-alpine + image: mysql:${MYSQL_VERSION:-8} environment: - POSTGRES_DB: ${POSTGRES_DB:-app} diff --git a/docs/options.md b/docs/options.md index a85405a31..7fe721c72 100644 --- a/docs/options.md +++ b/docs/options.md @@ -60,7 +60,7 @@ You can also customize the `Caddyfile` by using the following environment variab | `CADDY_SERVER_LOG_OPTIONS` | the [server log options block](https://caddyserver.com/docs/caddyfile/directives/log), one per line | | | `SERVER_NAME` | the server name or address | `localhost` | | `FRANKENPHP_CONFIG` | a list of extra [FrankenPHP directives](https://frankenphp.dev/docs/config/#caddyfile-config), one per line | `import worker.Caddyfile` | -| `MERCURE_TRANSPORT_URL` | the value passed to the `transport_url` directive | `bolt://mercure.db` | +| `MERCURE_TRANSPORT_URL` | the value passed to the `transport_url` directive | `bolt:///data/mercure.db` | | `MERCURE_PUBLISHER_JWT_KEY` | the JWT key to use for publishers | | | `MERCURE_PUBLISHER_JWT_ALG` | the JWT algorithm to use for publishers | `HS256` | | `MERCURE_SUBSCRIBER_JWT_KEY` | the JWT key to use for subscribers | | diff --git a/docs/tls.md b/docs/tls.md index aa70e11c9..adeb14cb5 100644 --- a/docs/tls.md +++ b/docs/tls.md @@ -34,7 +34,7 @@ For instance, to use self-signed certificates created with [mkcert](https://gith # ... volumes: + - ./frankenphp/certs:/etc/caddy/certs:ro - - ./public:/app/public:ro + # ... ``` 5. Restart your `php` service diff --git a/docs/xdebug.md b/docs/xdebug.md index fcc78ad5c..9ea4b3c18 100644 --- a/docs/xdebug.md +++ b/docs/xdebug.md @@ -49,23 +49,28 @@ You can now use the debugger! ## Debugging with Xdebug and VScode 1. Install necessery [PHP extension for VScode](https://marketplace.visualstudio.com/items?itemName=DEVSENSE.phptools-vscode). -2. Add [debug configuration](https://code.visualstudio.com/docs/editor/debugging#_launch-configurations) into your `.vscode\launch.json` file. +2. Add [debug configuration](https://code.visualstudio.com/docs/debugtest/debugging-configuration#_launch-configurations) into your `.vscode\launch.json` file. Example: ``` { - "name": "Listen for Xdebug", - "type": "php", - "request": "launch", - "port": 9003, - "pathMappings": { - "/app": "${workspaceFolder}" - } + "version": "0.2.0", + "configurations": [ + { + "name": "Listen for Xdebug", + "type": "php", + "request": "launch", + "port": 9003, + "pathMappings": { + "/app": "${workspaceFolder}" + } + } + ] } ``` -3. Use [Run and Debug](https://code.visualstudio.com/docs/editor/debugging) options and run `Listen for Xdebug` command to listen for upcomming connections with [the **Xdebug extension**](https://xdebug.org/docs/step_debug#browser-extensions) installed and active. +3. Use [Run and Debug](https://code.visualstudio.com/docs/debugtest/debugging#_start-a-debugging-session) options and run `Listen for Xdebug` command to listen for upcomming connections with [the **Xdebug extension**](https://xdebug.org/docs/step_debug#browser-extensions) installed and active. ## Troubleshooting