netenglabs / suzieq

Using network observability to operate and design healthier networks
https://www.stardustsystems.net/
Apache License 2.0
780 stars 104 forks source link

Rest HTTPS docs and default behavior #904

Closed claudious96 closed 1 year ago

claudious96 commented 1 year ago

Description

This PR updates the documentation where the rest-certfile and rest-certkey were mentioned to their actual name. Additionally we change the default behavior of loading the certificates included in the suzieq package if the user don't provide any.

Type of change

Please delete options that are not relevant.

New Behavior

If the rest server is set to use https but the rest-certfile and rest-certkey files are not provided we won't load anymore the certificates included in the package (which are expired in any case).

Discussion: Benefits and Drawbacks

Major benefit: we force the user to set the correct files and we avoid any unwanted launch of the server using the default ones.

Drawback: the user now need to have to generate (or already have) the certificate files to run the rest server with https

Comments

Include additional comments about the this pull request

Double Check