diff --git a/README.md b/README.md index 7bb382d5a6f087a1d655cee333862c7e5779eed6..658ec1317ce2ccc1752f83bb1ec6e93a68d28071 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,16 @@ Based on [foreman_concrete](https://github.com/timogoebel/foreman_concrete/). See the [Plugins install instructions, advanced installation from gems](https://theforeman.org/plugins/#2.3AdvancedInstallationfromGems) for information on how to install this plugins. +Configuration is done by placing a yaml file in the foreman plugin settings folder, e.g. +```console +# cat /etc/foreman/plugins/foreman_cement.yaml +--- +sentry_dsn: https://abcdef0123456789@sentry.example.com/1 +# sentry_trace: true # Traces 20% of all requests +# sentry_trace: +# rate: 1.0 # Traces 100% of all requests +``` + ## Contributing Bug reports and pull requests are welcome on the LiU GitLab at https://gitlab.liu.se/ITI/foreman_uuid_boot or on GitHub at https://github.com/ananace/foreman_uuid_boot