Skip to content

Commit 4e0105d

Browse files
committed
Improve organisation of DNS SRV page
1 parent cdcdf99 commit 4e0105d

3 files changed

Lines changed: 29 additions & 46 deletions

File tree

wiki/en/DNS-SRV-Support.md

Lines changed: 27 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -9,37 +9,23 @@ permalink: "/wiki/DNS-SRV-Support"
99

1010
# DNS SRV Record Support
1111

12-
#### Connecting to a Server or Directory
12+
#### Background - connecting to a Server or Directory
1313

1414
The default UDP port on which a Jamulus Server or Directory listens is **22124**. Normally, when a Client or a Server is given a plain hostname or an IP address to connect to, such as `198.51.100.46` or `jamulus.example.com`, it will use `22124` as the destination port number.
1515

1616
Since a single Jamulus Server only provides a single "room", and a single Jamulus Directory only provides a single "list", it is often useful to run multiple Jamulus Server or Directory instances on a single host, sharing one IP address. In order to do this, the instances must each be made to listen on a different UDP port. This is done by specifying the port number on the command line, using `-p NNNNN` or `--port NNNNN`.
1717

1818
If such a Server is registered with a Directory, such as the standard Jamulus Directories, e.g. **Any Genre 1**, the port number in use is automatically detected by the Directory at registration time, and stored in the list which is sent to a Client. The user's Jamulus Client can then connect to the Server in the normal way from the list in the Connect Dialog.
1919

20-
However, a Jamulus instance wanting to connect _directly_ to a Server or Directory by IP or hostname must know the port number to use. This can be specified after the IP address or hostname, such as `198.51.100.46:22123` or `jamulus.example.com:22120`.
20+
However, a Jamulus instance wanting to connect _directly_ to a Server or Directory by IP or hostname must know the port number to use. This can be specified after the IP address or hostname, such as `198.51.100.46:22123` or `jamulus.example.com:22120`. Such port numbers are not very memorable, so it's often necessary to look them up! The solution is for the server operator to publish the port number using an SRV record in DNS.
2121

2222
#### Using DNS SRV to publish port numbers
2323

2424
A [DNS SRV record ("service" record)](https://en.wikipedia.org/wiki/SRV_record) is a special DNS record that can be used to publish the port number and hostname that should be used to connect to a particular service.
2525

26-
Later versions of Jamulus Clients and Servers support [DNS SRV records ("service" records)](https://en.wikipedia.org/wiki/SRV_record). Depending on the version of Jamulus, if it finds a DNS SRV record associated with the domain name given, it will try to connect to the endpoint host and port listed in the SRV record. This process is similar to HTTP redirection in a web browser, only it's between Jamulus and the DNS server. The Jamulus Server is not involved in this interaction. Jamulus Servers just listen for connections on the same port listed in the SRV record.
26+
Recent versions of Jamulus Clients and Servers are able to make use of such records. Depending on the version of Jamulus (see below), if it finds a DNS SRV record associated with the domain name given, it will try to connect to the endpoint host and port listed in the SRV record. The user does not have to specify the port number explicitly.
2727

28-
SRV records are created by the administrator of the domain being used to host the Jamulus Server. The SRV records are added through the administration portal (or API if available) of the domain's DNS hosting service. The format of the SRV record entry can vary by DNS hosting service but will generally look something like this:
29-
30-
~~~
31-
_service._proto.name. ttl IN SRV priority weight port target.
32-
~~~
33-
34-
In the case of Jamulus, the `service` must be `jamulus` and the `proto` must be `udp`, so the record will look like this:
35-
36-
~~~
37-
_jamulus._udp.example.com. 60 IN SRV 0 5 12345 jamulus.example.com.
38-
~~~
39-
40-
This allows to host many Jamulus Servers at different ports on a single host with different hostnames by giving each its own SRV record. This avoids having to give your users the port number, which may be less memorable than a name.
41-
42-
See the documentation of your DNS provider for instructions on creating an SRV record.
28+
If no SRV records are found on the DNS server for the hostname given, Jamulus will attempt to connect to the Directory or Server address on the default port number `22124`.
4329

4430
#### Jamulus versions supporting SRV
4531

@@ -54,41 +40,38 @@ In addition to the above, both Clients and Servers with version **3.12.0** or la
5440
* Server: (GUI) in the "Custom Directory address" setting under "Options".
5541
* Client: (GUI) in the list of custom Directories under "Advanced Setup" in "Settings".
5642

57-
#### Why is this helpful?
43+
#### Creating DNS SRV records
5844

59-
Jamulus can connect to a Server or Directory on a non-default port by specifying the port as part of the Server address. A Server administrator may want to give users a simple address without the port details, while still serving Jamulus on a non-default port. For this case, the port information can be acquired from an SRV record, as described above.
45+
SRV records are created by the administrator of the DNS domain being used to host the Jamulus Server. The SRV records are added through the administration portal (or API if available) of the domain's DNS hosting service. The format of the SRV record entry can vary by DNS hosting service but will generally look something like this:
6046

61-
In this case, an address entered in the Connect window, or for a custom Directory, could look like `jamulus.example.com`. If no explicit port number is specified, and an SRV record is found for this DNS domain, Jamulus will try to connect to the Directory or Server on the host:port listed in the SRV record, such as `jamulus.example.com:12345`.
62-
63-
If no SRV records are found on the DNS server, Jamulus will attempt to connect to the Directory or Server address on the default port number `22124`.
64-
65-
#### Example use case with SRV records
66-
67-
This example assumes the DNS contains an A or CNAME record that resolves to `server1.example.com`, where three Jamulus Server instances are running, each listening on one of the three ports listed below.
47+
~~~
48+
_service._proto.name. ttl IN SRV priority weight port target.
49+
~~~
6850

69-
Alternatively, `server1.example.com` can be a router, NAT-gateway, or load-balancer that forwards each of the ports to a backend Jamulus Server (or Servers).
51+
In the case of Jamulus, the `service` must be `jamulus` and the `proto` must be `udp`, so the record will look like this:
7052

53+
~~~
54+
_jamulus._udp.example.com. 60 IN SRV 0 5 12345 jamulus.example.com.
55+
~~~
7156

72-
| JAMULUS CLIENT | DNS SRV RECORD | JAMULUS SERVER |
73-
| ------------------- | -------------------------------------------------------------------------- | --------------------------- |
74-
| `rock.example.com` | `_jamulus._udp.rock.example.com 300 IN SRV 0 5 22124 server1.example.com` | `server1.example.com:22124` |
75-
| `jazz.example.com` | `_jamulus._udp.jazz.example.com 300 IN SRV 0 5 22125 server1.example.com` | `server1.example.com:22125` |
76-
| `blues.example.com` | `_jamulus._udp.blues.example.com 300 IN SRV 0 5 22126 server1.example.com` | `server1.example.com:22126` |
57+
This allows to host many Jamulus Servers or Directories at different ports on a single host with different hostnames by giving each its own SRV record. This avoids having to give your users the port number, which may be less memorable than a name.
7758

78-
*It's important to remember that DNS is not forwarding connections. It's simply telling Jamulus what public host:port to connect to.*
59+
See the documentation of your DNS provider for instructions on creating an SRV record.
7960

80-
#### SRV for the main Jamulus public Directories
61+
#### Example - SRV records for the main Jamulus public Directories
8162

8263
In the `jamulus.io` domain, SRV records have been created to specify the correct port for each of the standard public Directories:
8364

84-
| DIRECTORY | DNS SRV RECORD | JAMULUS SERVER |
85-
| ---------------------- | --------------------------------------------------------------------------------- | ---------------------------- |
86-
| `anygenre1.jamulus.io` | `_jamulus._udp.anygenre1.jamulus.io. 60 IN SRV 0 0 22124 anygenre1.jamulus.io.` | `anygenre1.jamulus.io:22124` |
87-
| `anygenre2.jamulus.io` | `_jamulus._udp.anygenre2.jamulus.io. 60 IN SRV 0 0 22224 anygenre2.jamulus.io.` | `anygenre2.jamulus.io:22224` |
88-
| `anygenre3.jamulus.io` | `_jamulus._udp.anygenre3.jamulus.io. 60 IN SRV 0 0 22624 anygenre3.jamulus.io.` | `anygenre3.jamulus.io:22624` |
89-
| `rock.jamulus.io` | `_jamulus._udp.rock.jamulus.io. 60 IN SRV 0 0 22424 rock.jamulus.io.` | `rock.jamulus.io:22424` |
90-
| `jazz.jamulus.io` | `_jamulus._udp.jazz.jamulus.io. 60 IN SRV 0 0 22324 jazz.jamulus.io.` | `jazz.jamulus.io:22324` |
91-
| `classical.jamulus.io` | `_jamulus._udp.classical.jamulus.io. 60 IN SRV 0 0 22524 classical.jamulus.io.` | `classical.jamulus.io:22524` |
92-
| `choral.jamulus.io` | `_jamulus._udp.choral.jamulus.io. 60 IN SRV 0 0 22724 choral.jamulus.io.` | `choraljamulus.io.:22724` |
65+
| DIRECTORY | DNS SRV RECORD | JAMULUS SERVER |
66+
| ---------------------- | ------------------------------------------------------------------------------- | ---------------------------- |
67+
| `anygenre1.jamulus.io` | `_jamulus._udp.anygenre1.jamulus.io. 60 IN SRV 0 0 22124 anygenre1.jamulus.io.` | `anygenre1.jamulus.io:22124` |
68+
| `anygenre2.jamulus.io` | `_jamulus._udp.anygenre2.jamulus.io. 60 IN SRV 0 0 22224 anygenre2.jamulus.io.` | `anygenre2.jamulus.io:22224` |
69+
| `anygenre3.jamulus.io` | `_jamulus._udp.anygenre3.jamulus.io. 60 IN SRV 0 0 22624 anygenre3.jamulus.io.` | `anygenre3.jamulus.io:22624` |
70+
| `rock.jamulus.io` | `_jamulus._udp.rock.jamulus.io. 60 IN SRV 0 0 22424 rock.jamulus.io.` | `rock.jamulus.io:22424` |
71+
| `jazz.jamulus.io` | `_jamulus._udp.jazz.jamulus.io. 60 IN SRV 0 0 22324 jazz.jamulus.io.` | `jazz.jamulus.io:22324` |
72+
| `classical.jamulus.io` | `_jamulus._udp.classical.jamulus.io. 60 IN SRV 0 0 22524 classical.jamulus.io.` | `classical.jamulus.io:22524` |
73+
| `choral.jamulus.io` | `_jamulus._udp.choral.jamulus.io. 60 IN SRV 0 0 22724 choral.jamulus.io.` | `choral.jamulus.io:22724` |
9374

9475
This means that a Jamulus Server of version **3.12.0** or later can just give the hostname of the Directory to the `-e` or `--directoryaddress` option, without needing to find and specify the port number.
76+
77+
A server administrator can use the same technique to publish an SRV record for his own Server or Directory.

wiki/en/Running-a-Server.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ To register with one of the Directories built into the Jamulus Client, replace `
183183
|**Genre Classical/Folk** |`classical.jamulus.io:22524`|
184184
|**Genre Choral/Barbershop** |`choral.jamulus.io:22724`|
185185
186-
Recent versions of Jamulus support [DNS SRV records ("service" records)](https://en.wikipedia.org/wiki/SRV_record) for automatically finding the port number to use to connect to a Directory or Server. This allows just the hostname to be specified, without the port number. See [this page](DNS-SRV-Support) for details.
186+
Recent versions of Jamulus support [DNS SRV records ("service" records)](https://en.wikipedia.org/wiki/SRV_record) for automatically finding the port number to use to connect to a Directory or Server. This allows just the hostname to be specified, without the port number. See [this page](DNS-SRV-Support) for details and applicable version numbers.
187187
188188
##### `-o or --serverinfo`
189189

wiki/en/Unregistered-Servers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,4 @@ Unless your ISP provides you with a fixed IP address, you may find that your add
3333

3434
## DNS SRV record support
3535

36-
Recent versions of Jamulus support [DNS SRV records ("service" records)](https://en.wikipedia.org/wiki/SRV_record) for automatically finding the port number to use to connect to a Directory or Server. This allows just the hostname to be specified, without the port number. See [this page](DNS-SRV-Support) for details.
36+
Recent versions of Jamulus support [DNS SRV records ("service" records)](https://en.wikipedia.org/wiki/SRV_record) for automatically finding the port number to use to connect to a Directory or Server. This allows just the hostname to be specified, without the port number. See [this page](DNS-SRV-Support) for details and applicable version numbers.

0 commit comments

Comments
 (0)