Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding documentation for FrankenPHP #829

Open
wants to merge 3 commits into
base: 3.x
Choose a base branch
from

Conversation

mamazu
Copy link
Contributor

@mamazu mamazu commented Jan 7, 2025

Q A
Fixed tickets -
Related PRs -
License MIT

What's in this PR?

Explaining how adding frankenphp works.

Why?

This is also officially supported by Sulu so we might as well document it.

@mamazu mamazu force-pushed the documenting-frankenphp branch from dbe4f83 to 2074385 Compare January 7, 2025 17:26
@@ -0,0 +1,63 @@
Running Franken PHP
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would call this FrankenPHP via Docker

as you can use also frankenphp standalone binary which is different to use. Same for the file name.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, that's a good idea. Did that.

Comment on lines 54 to 61
After setting up the container you might also want to update the `DATABASE_URL` variable in the php service (by default it assumes postgres). At least note that FrankenPHP and the default Sulu mysql container have different default credentials.

If you have some other modifications in your set up be sure to copy all changes of the `docker-compose*` files to the `compose.yaml` and `compose.override.yaml`.

After all this, the Sulu default configuration is not used anymore and can be removed:
.. code-block:: bash
rm docker-compose.yaml
rm docker-compose.override.yaml
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not understanding this parts sulu use compose.yaml files like Symfony and Dunglas Symfony Docker. The docker-compose.yaml are not in use by any of them.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, that's why I would recommend to delete them. That way we don't confuse the user of which of the compose file is now being used.

Copy link
Member

@alexander-schranz alexander-schranz Jan 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would remove that sentence about docker+compose, we should not consider here that somebody uses may older version of something. This docs is more used for new setup projects which are uptodate. Think else this confuses more.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The point should be that whatever you had in your old Sulu docker-compose.yaml had will no longer be used when running the compose.yaml. That's why you need to merge any changes from the Sulu config into the FrankenPHP config. And if you remove the old file you get conflicts when Sulu changes something in the default config.

cookbook/web-server/franken-php.rst Outdated Show resolved Hide resolved
cookbook/web-server/franken-php.rst Outdated Show resolved Hide resolved
cookbook/web-server/franken-php.rst Outdated Show resolved Hide resolved
cookbook/web-server/franken-php.rst Outdated Show resolved Hide resolved
mamazu and others added 2 commits January 7, 2025 18:38
Co-authored-by: Alexander Schranz <alexander@sulu.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants