docs: add note about work mode

dunglas · Dec 5, 2023 · d55dc3c · d55dc3c
1 parent 1afdd01
commit d55dc3c
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 8 deletions.
diff --git a/docs/build.md b/docs/build.md
@@ -34,7 +34,8 @@ Use the `SERVER_NAME` environment variable to define your custom server name(s).
 
     SERVER_NAME="app.localhost" docker compose up -d --wait
 
-*Tips: You can define your server name variable in your `.env` file to keep it at each up*
+> [!TIP]
+> You can define your server name variable in your `.env` file to keep it at each up
 
 ## Using custom HTTP ports
 
@@ -44,4 +45,5 @@ Use the environment variables `HTTP_PORT`, `HTTPS_PORT` and/or `HTTP3_PORT` to a
 
 to access your application on [https://localhost:4443](https://localhost:4443).
 
-*Note: Let's Encrypt only supports the standard HTTP and HTTPS ports. Creating a Let's Encrypt certificate for another port will not work, you have to use the standard ports or to configure Caddy to use another provider.*
+> [!NOTE]  
+> Let's Encrypt only supports the standard HTTP and HTTPS ports. Creating a Let's Encrypt certificate for another port will not work, you have to use the standard ports or to configure Caddy to use another provider.
diff --git a/docs/existing-project.md b/docs/existing-project.md
@@ -31,3 +31,9 @@ Start the project!
     docker compose up -d
 
 Browse `https://localhost`, your Docker configuration is ready!
+
+> [!NOTE]
+> If you want to use the worker mode of FrankenPHP, make sure you required the `runtime/frankenphp-symfony` package.
+
+> [!NOTE]
+> The worker mode of FrankenPHP is enabled by default in prod. To disabled it, add the env var FRANKENPHP_CONFIG as empty to the compose.prod.yaml file.
diff --git a/docs/makefile.md b/docs/makefile.md
@@ -27,9 +27,8 @@ git \
 
 And rebuild the PHP image.
 
-**PS**: If using Windows, you have to install [chocolatey.org](https://chocolatey.org/)
-or use [Cygwin](http://cygwin.com) to use the `make` command. Check out this
-[StackOverflow question](https://stackoverflow.com/q/2532234/633864) for more explanations.
+> [!NOTE]  
+> If you are using Windows, you have to install [chocolatey.org](https://chocolatey.org/) or [Cygwin](http://cygwin.com) to use the `make` command. Check out this [StackOverflow question](https://stackoverflow.com/q/2532234/633864) for more explanations.
 
 ## The template
 

diff --git a/docs/production.md b/docs/production.md
@@ -40,8 +40,8 @@ Example:
 your-domain-name.example.com.  IN  A     207.154.233.113
 ````
 
-Note: Let's Encrypt, the service used by default by Symfony Docker to automatically generate a TLS certificate doesn't support using bare IP addresses.
-Using a domain name is mandatory to use Let's Encrypt.
+> [!NOTE]  
+> Note: Let's Encrypt, the service used by default by Symfony Docker to automatically generate a TLS certificate doesn't support using bare IP addresses. Using a domain name is mandatory to use Let's Encrypt.
 
 ## Deploying
 
@@ -66,7 +66,7 @@ docker compose -f compose.yaml -f compose.prod.yaml up -d --wait
 
 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.
 
-Your server is up and running, and a Let's Encrypt HTTPS certificate has been automatically generated for you.
+Your server is up and running, and a HTTPS certificate has been automatically generated for you.
 Go to `https://your-domain-name.example.com` and enjoy!
 
 ## Disabling HTTPS