search

sipcapture / heplify-server

HEP Capture Server for HOMER
https://sipcapture.org
GNU Affero General Public License v3.0
184 stars 85 forks source link

Meaningful Documentation #448

Closed DGEllis closed 3 years ago

DGEllis commented 3 years ago

Hello,

I found this page: https://github.com/sipcapture/homer/wiki/HEPLIFY-SERVER-Settings

Please, folks, expand on this. Could you:

  1. List all configuration switches
  2. Provide what inputs each switch accepts, including ranges to remain within where appropriate
  3. What the switch does, what it's intent is, how it is used, and how it relates to other switches

In other words, help up help ourselves.

Thank you,

Darren

PS: It would be a good idea to do this for Homer also.

lmangani commented 3 years ago

Hello @DGEllis Most critical items are documented in the configuration files, ie: https://github.com/sipcapture/heplify-server/blob/master/example/homer7_config/heplify-server.toml

There are many options for many use cases, you can discover going through the examples of interest. Any contributions are welcome, particularly on the documentation/wiki front. If everyone using it documented one feature they use, a full manual could be done in a few days ;)