[asterisk-dev] [Code Review] 2811: New pjsip.conf.sample with 100% more pjsip

Matt Jordan reviewboard at asterisk.org
Fri Aug 30 08:54:50 CDT 2013 

-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviewboard.asterisk.org/r/2811/#review9563
-----------------------------------------------------------



/trunk/configs/pjsip.conf.sample
<https://reviewboard.asterisk.org/r/2811/#comment18679>

    Since this security notice seems directed towards an Asterisk beginner, I would mention here the endpoint configuration item that determines where an inbound call is routed to.



/trunk/configs/pjsip.conf.sample
<https://reviewboard.asterisk.org/r/2811/#comment18687>

    I think at this point here it'd be good to note the major configuration objects that need to be defined for most configurations and a one sentence description of what they do. At a minimum:
    
    * Transports
    * Endpoints
    * Authentication
    * Address of Record
    * Endpoint Identification
    



/trunk/configs/pjsip.conf.sample
<https://reviewboard.asterisk.org/r/2811/#comment18681>

    I'd rephrase this a bit differently:
    
    For endpoints using IPv6, remember to set rtp_ipv6=yes so that the RTP engine will also be able to bind to an IPv6 address.



/trunk/configs/pjsip.conf.sample
<https://reviewboard.asterisk.org/r/2811/#comment18684>

    IPv6 not ipv6



/trunk/configs/pjsip.conf.sample
<https://reviewboard.asterisk.org/r/2811/#comment18683>

    Blob, IPv4 not ipv4



/trunk/configs/pjsip.conf.sample
<https://reviewboard.asterisk.org/r/2811/#comment18688>

    Rephrase to something like:
    
    "Note that because this object is used for outbound registration, outbound_auth is used to specify the authentication section as opposed to auth"



/trunk/configs/pjsip.conf.sample
<https://reviewboard.asterisk.org/r/2811/#comment18707>

    Direct Media isn't a NAT option. It is an option that can be affected by NAT.



/trunk/configs/pjsip.conf.sample
<https://reviewboard.asterisk.org/r/2811/#comment18709>

    I think a brief explanation of the AOR section is warranted. The breaking up of an entity (formally a user/peer) to an endpoint and an AOR (along with the rest of the sections) is the biggest conceptual change. Ideally, this would be noted earlier on as well.



/trunk/configs/pjsip.conf.sample
<https://reviewboard.asterisk.org/r/2811/#comment18708>

    registration *and* calls.



/trunk/configs/pjsip.conf.sample
<https://reviewboard.asterisk.org/r/2811/#comment18710>

    Note that if you don't specify a transport, a default transport is chosen. The default transport chosen is the first defined transport in the configuration file.



/trunk/configs/pjsip.conf.sample
<https://reviewboard.asterisk.org/r/2811/#comment18711>

    change to: "enable SRTP, though they are not ..."



/trunk/configs/pjsip.conf.sample
<https://reviewboard.asterisk.org/r/2811/#comment18712>

    What module provides this?


- Matt Jordan


On Aug. 29, 2013, 11:33 p.m., rnewton wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviewboard.asterisk.org/r/2811/
> -----------------------------------------------------------
> 
> (Updated Aug. 29, 2013, 11:33 p.m.)
> 
> 
> Review request for Asterisk Developers.
> 
> 
> Bugs: ASTERISK-22145
>     https://issues.asterisk.org/jira/browse/ASTERISK-22145
> 
> 
> Repository: Asterisk
> 
> 
> Description
> -------
> 
> pjsip.conf!
> 
> The file consists of two main bodies of text.
> 1. Manually written examples - fulfilling a variety of basic configuration scenarios. A few of which are detailed on the ASTERISK-22145 issue.
> 2. A full config option list - Output from a python script I wrote. It takes an xml config dump from Asterisk and parses the pjsip.conf config options out into the format you see in the file. (I may throw that script up here later after I improve it)
> 
> Before the examples there is a blurb talking about where the official documentation is and a brief security notice.
> 
> Notes on the thought process behind what we have so far:
> 
> * We want this to be easy to maintain
> 
> In writing this I found it's easy to turn it into exhaustive documentation and make it very redundant with our other documentation sources. For maintenance sake I trimmed it all back to be about as simple as possible and tried to aim it towards a "quick reference sheet", rather than "demonstrate every config option in action document".
> 
> The full option list is easy to update thanks to it being pulled from a script and not hand edited. 
> 
> * The sample files should start moving towards "sample" files and not be exhaustive documentation.
> * The sample file is not a tutorial.
> 
> The examples provided in the file are geared towards someone who has already read the basics on the wiki[1] or elsewhere. The examples also helpful to serve as context for when you are looking at specific options through the cli config help or referencing the full option list in the bottom of the file. 
> 
> * The examples in the sample file should be simple for a user to understand and modify
> 
> The examples don't have every option listed under them because it makes it a bit confusing to look at. I've tried to arrange them realistically for basic configurations so that it would be easy for you to copy paste options from the big list at the bottom to the examples at the top.
> 
> * Every example is not explained in detail
> 
> I tried to pick out key points or options used in the examples, rather than just explaining them line by line (since that would lead to a lot of redundancy)
> 
> *** Don't provide feedback here for all the individual option names, synopsis, descriptions etc. That is all pulled from the XML config documentation. If you see errors in those areas please file a JIRA issue ***
> 
> Please provide feedback on the example configurations and text that is not in the big list of options at the bottom of the file. That is any obviously wrong configuration (option that couldn't be used in a section), horrible spelling, grammar or logic and flow problems. Suggestions for additional configuration examples that are crucial or essential would be very helpful, especially if you can write the example. Feedback is also very welcome on the formatting of the options list at the bottom. :)
> 
> Moving around all this text, I'm sure I missed quite a few things! Thanks in advance for the help!
> 
> [1]: https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Installation+and+Configuration
> 
> 
> Diffs
> -----
> 
>   /trunk/configs/pjsip.conf.sample 397957 
> 
> Diff: https://reviewboard.asterisk.org/r/2811/diff/
> 
> 
> Testing
> -------
> 
> I tested pretty much all the configurations in this file or pulled them from other peoples working configurations, there are probably a few option combinations and configurations that I missed, but added in.
> 
> 
> Thanks,
> 
> rnewton
> 
>

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.digium.com/pipermail/asterisk-dev/attachments/20130830/44ec16f9/attachment-0001.htm>

More information about the asterisk-dev mailing list