From 4979ec6ca56dc9defb12c96c042af537c42bde00 Mon Sep 17 00:00:00 2001 From: Evann Regnault Date: Wed, 12 Jun 2024 10:17:10 +0200 Subject: [PATCH] Updated readme --- README.md | 86 +++++++++++-------------------------------------------- 1 file changed, 17 insertions(+), 69 deletions(-) diff --git a/README.md b/README.md index 3625a1c..60240ee 100755 --- a/README.md +++ b/README.md @@ -1,78 +1,26 @@ -# Docker PHP Development Environment +# Keycloak WebDav -This repository allows you to quickly get a development environment up and running using Docker, including a MySQL database and some debugging tools. +This project is meant to be a WebDav Server using Keycloak roles for it's [Principals](https://sabre.io/dav/principals/). -This environment includes the latest versions of the following software: +## Requirements + +- PHP +- Composer +- A running keycloak instance +- A Client with `Direct access grants` enabled -- `nginx:alpine` -- `php:8.3-fpm` -- `mysql:latest` -- `xdebug` +## Configuration -## Prerequisites +To configure the server, you just need to create a `.env` file following the example. - - Docker - https://www.docker.com/products/docker-desktop - - Tested and confirmed working on: - - macOS 12.3 (Monterey) - - Windows 10 Version 21H1 build 19043.1165 +Do not forget to create the users_path, as well as to not forget to add a final `/` to the path. -## Project Setup +## Installation -Run `composer create-project jlucki/docker-php-dev-env "project_name"` +In order to start the server, simply run the following commands: -Alternatively, download the files from this repo and copy them to your project directory. - -## Running the Container - -1. Run `docker compose up` from the project directory - - Note: the above command will only work on versions newer than 3.6. If you are using Docker 3.6 or older, use `docker-compose up` -2. Visit `localhost` in your browser - -## Setting up Xdebug in Your IDE - -_The following instructions are for PHPStorm._ - -1. Click on Run > Edit Configurations -2. Click the `+` and add a new PHP Remote Debug configuration -3. Give the configuration a name -4. Tick _Filter debug connection by IDE key_ -5. Add `PHPSTORM` in the session id -6. Click the `...` next to Server -7. Click the `+` to add a new server -8. Give the server a name, and set the host to `localhost` -9. Tick _Use path mappings_ -10. Under the `Project files` file/directory, next to your project folder, for the `Absolute path on the server` column add `/var/www/html` -11. Hit Apply and OK until you've returned to the IDE -12. Click the _Start Listening for PHP Debug Connections_ icon -13. Set a breakpoint in your code -14. Refresh the page in your browser -15. Accept _Incoming Connection From Xdebug_ -16. Happy debugging! - -See https://xdebug.org/docs/remote for how to enable xdebug sessions. - -## Additional Notes - -For database connections, use `mysql` as the hostname. If you would like a different hostname, change the service name in the `docker-compose.yml` file. - -## Windows 10 Troubleshooting - -If you are having problems and can't seem to fix the issue, try one or both of these fixes: - -### Solution 1 -Try switching to **Windows containers**: - -Right-click the Docker icon in the system tray and click **Switch to Windows containers** as seen below: - -![Context Menu](https://i.imgur.com/enYmIPH.png) - -### Solution 2 -If the **Use the WSL 2 based engine** setting is checked: - -Uncheck the setting, then enable file sharing located under the **Resources** section, then the **File Sharing** section as seen below: - -![Docker Settings](https://i.imgur.com/maub2Wh.png) - -If the **Use the WSL 2 based engine** setting is unchecked: -Enable/check the setting (file sharing is automatically configured) +```sh +composer update +php -S localhost:8080 index.php +```