Skip to content

Commit d55943b

Browse files
authored
Merge pull request #13 from tacman/patch-1
tweaks to reflect current Symfony versions
2 parents b73d0a4 + 3b28751 commit d55943b

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[![Code_Checks](https://github.com/OpenConext/Monitor-bundle/actions/workflows/code_checks.yaml/badge.svg)](https://github.com/OpenConext/Monitor-bundle/actions/workflows/code_checks.yaml)
44

5-
A Symfony 3/4/5 bundle that adds a /health and /info endpoint to your application.
5+
A Symfony 5/6/7 bundle that adds a /health and /info endpoint to your application.
66

77
The endpoints return JSON responses. The `/internal/info` endpoint tries to give as much information about the currently installed
88
version of the application as possible. This information is based on the build path of the installation. But also
@@ -36,21 +36,21 @@ When a health check failed the HTTP Response status code will be 503. And the JS
3636
3737
```php
3838
// config/bundles.php
39-
// in older Symfony apps, enable the bundle in app/AppKernel.php
39+
// in older Symfony apps, enable the bundle in config/bundles.php
4040
return [
4141
// ...
4242
OpenConext\MonitorBundle\OpenConextMonitorBundle::class => ['all' => true],
4343
];
4444
```
4545
46-
* Include the routing configuration in `config/routes.yml` by adding:
46+
* Include the routing configuration in `config/routes.yaml` by adding:
4747
```yaml
4848
open_conext_monitor:
4949
resource: "@OpenConextMonitorBundle/Resources/config/routing.yml"
5050
prefix: /
5151
```
5252
53-
* Add security exceptions in `config/packages/security.yml` (if this is required at all)
53+
* Add security exceptions in `config/packages/security.yaml` (if this is required at all)
5454
```yaml
5555
security:
5656
firewalls:
@@ -104,7 +104,7 @@ class ApiHealthCheck implements HealthCheckInterface
104104
registered health checkers. If everything was OK, just return the report that was passed to the method.
105105
106106
### Register the checker
107-
To actually include the home made checker simply tag it as being a
107+
To actually include the home made checker simply tag it with 'surfnet.monitor.health_check'
108108
109109
Example service definition in `services.yml`
110110

0 commit comments

Comments
 (0)