keycloak-webdav/README.md

29 lines
680 B
Markdown
Raw Normal View History

2024-06-07 22:27:58 +02:00
2024-06-12 10:17:10 +02:00
# Keycloak WebDav
2024-06-07 22:27:58 +02:00
2024-06-12 10:17:10 +02:00
This project is meant to be a WebDav Server using Keycloak roles for it's [Principals](https://sabre.io/dav/principals/).
2024-06-07 22:27:58 +02:00
2024-06-12 10:17:10 +02:00
## Requirements
- PHP
2024-06-19 23:41:01 +02:00
- [phpredis](https://github.com/phpredis/phpredis)
2024-06-12 10:17:10 +02:00
- Composer
- A running keycloak instance
- A Client with `Direct access grants` enabled
2024-06-19 23:41:01 +02:00
- A running Redis Instance
2024-06-07 22:27:58 +02:00
2024-06-12 10:17:10 +02:00
## Configuration
2024-06-07 22:27:58 +02:00
2024-06-12 10:17:10 +02:00
To configure the server, you just need to create a `.env` file following the example.
2024-06-07 22:27:58 +02:00
2024-06-12 10:17:10 +02:00
Do not forget to create the users_path, as well as to not forget to add a final `/` to the path.
2024-06-07 22:27:58 +02:00
2024-06-12 10:17:10 +02:00
## Installation
2024-06-07 22:27:58 +02:00
2024-06-12 10:17:10 +02:00
In order to start the server, simply run the following commands:
2024-06-07 22:27:58 +02:00
2024-06-12 10:17:10 +02:00
```sh
composer update
php -S localhost:8080 index.php
```