Projects tigase _server tigase-stun Issues #3
Add STUN documentation (#3)
Closed
Daniel Wisnewski opened 7 years ago

Add Stun configuration documentation to component and then to overall documentation.

Daniel Wisnewski commented 7 years ago

Uploaded documentation and it now builds with main server.

Andrzej, please look over it to see if i've missed anything critical.

Andrzej Wójcik (Tigase) commented 7 years ago

I've looked over documentation of STUN component generated as a part of Tigase XMPP Server documentation and I've found an error there.

In documentation which you prepared it is stated:

Below is an example configuration for STUN component. Note that the 4 stun-primarysettings are required, where secondaries are not.

While at Tigase STUN component wiki it is stated that following is required

stun/stun-primary-ip=10.0.0.1
stun/stun-primary-port[I]=3478
stun/stun-secondary-ip=10.0.0.2
stun/stun-secondary-port[I]=7001

and following is optional:

stun/stun-primary-external-ip=172.16.0.22
stun/stun-primary-external-port[I]=3479
stun/stun-secondary-external-ip=172.16.0.23
stun/stun-secondary-external-port[I]=7002

As STUN component requires 2 external IP addresses to work properly, it required both (primary and secondary) IP/port configuration.

Only properties with -external- are optional as they are used to specify external IP/port pairs is our STUN server is behind a firewall which forwards traffic but at the same time maps ip address to internal one.

To sum up, looking at an example from documnetation which you added:

stun (class: tigase.stun.StunComponent) {
    'stun-primary-external-ip' = '172.16.0.22'
    'stun-primary-external-port' = 3479
    'stun-primary-ip' = '10.0.0.1'
    'stun-primary-port' = 3478
    'stun-secondary-external-ip' = '172.16.0.23'
    'stun-secondary-external-port' = 7002
    'stun-secondary-ip' = '10.0.0.2'
    'stun-secondary-port' = 7001
}

it should be stated that following properties are required:

    'stun-primary-ip' = '10.0.0.1'
    'stun-primary-port' = 3478
    'stun-secondary-ip' = '10.0.0.2'
    'stun-secondary-port' = 7001

and following are optional:

    'stun-primary-external-ip' = '172.16.0.22'
    'stun-primary-external-port' = 3479
    'stun-secondary-external-ip' = '172.16.0.23'
    'stun-secondary-external-port' = 7002
Daniel Wisnewski commented 7 years ago

Closing Task as this was completed some time back.

issue 1 of 1
Type
Task
Priority
Normal
Assignee
RedmineID
6091
Issue Votes (0)
Watchers (0)
Reference
tigase/_server/tigase-stun#3
Please wait...
Page is in error, reload to recover