Updates Running-a-server.md to cover DNS SRV support by ginjo · Pull Request #874 · jamulussoftware/jamuluswebsite

ginjo · 2022-11-17T23:32:44Z

Short description of changes
Add documentation to Running-a-server.md to cover new DNS SRV support feature.

Context: Fixes an issue? Related issues
jamulussoftware/jamulus#2930

Status of this Pull Request
Review needed

What is missing until this pull request can be merged?
Merged but needs documentation

Does this need translation?
Yes

Checklist

I've verified that this Pull Request follows the general code principles
I waited some time after this Pull Request was opened and all GitHub checks completed without errors.
I'm sure that this Pull Request goes to the correct branch

Adding documentation for DNS SRV record support

Adding DNS SRV support documentation

wiki/en/Running-a-Server.md

pljones · 2022-11-18T07:16:53Z

wiki/en/Running-a-Server.md

+#### Creating SRV records
+
+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.
+


I think this section should also describe how hosting multiple Jamulus Servers on a single system would work, giving each its own "simple name".

wiki/en/Running-a-Server.md

ginjo · 2022-11-18T23:38:59Z

Thanks @mcfnord , I like the improvements.

@pljones , regarding further description of the one-host-to-many-servers that you mentioned... Maybe something like this?

Example use case with SRV records

Assuming DNS CNAME or A record resolves server1.mydomain.com, and server1.mydomain.com has three Jamulus server instances each listening on one of the three specified ports.

Alternatively, server1.mydomain.com can be a router, NAT-gateway, or load-balancer that forwards each of the ports to a backend Jamulus server (or servers).

JAMULUS CLIENT   ->   DNS SRV RECORD                                                          ->   JAMULUS SERVER

rock.mydomain.com     _jamulus._udp.rock.mydomain.com 300 IN SRV 0 5 22124 server1.mydomain.com    server1.mydomain.com:22124
jazz.mydomain.com     _jamulus._udp.jazz.mydomain.com 300 IN SRV 0 5 22125 server1.mydomain.com    server1.mydomain.com:22125
blues.mydomain.com    _jamulus._udp.blues.mydomain.com 300 IN SRV 0 5 22126 server1.mydomain.com   server1.mydomain.com:22126

It's important to remember that DNS is not forwarding connections. It's simply telling Jamulus client what public host:port to connect to.

pljones · 2022-11-18T23:41:30Z

@pljones , regarding further description of the one-host-to-many-servers that you mentioned... Maybe something like this?

Example use case with SRV records

Looks useful to have, great! Formatting may need some improvement... Maybe use a table..? (Or not...)

Jamulus Client	-> DNS SRV Record ->	Jamulus Server
rock.mydomain.com	`_jamulus._udp.rock.mydomain.com 300 IN SRV 0 5 22124 server1.mydomain.com`	server1.mydomain.com:22124

ginjo · 2022-11-19T22:04:24Z

Looks useful to have, great! Formatting may need some improvement... Maybe use a table..? (Or not...)

Yes, I think the table looks better. The squashed SRV entries are less readable, but the absence of horizontal scrolling is a big improvement:

Example use case with SRV records

Assuming DNS CNAME or A record resolves server1.mydomain.com, and server1.mydomain.com has three Jamulus server instances each listening on one of the three specified ports.

Alternatively, server1.mydomain.com can be a router, NAT-gateway, or load-balancer that forwards each of the ports to a backend Jamulus server (or servers).

JAMULUS CLIENT	DNS SRV RECORD	JAMULUS SERVER
rock.mydomain.com	_jamulus._udp.rock.mydomain.com 300 IN SRV 0 5 22124 server1.mydomain.com	server1.mydomain.com:22124
jazz.mydomain.com	_jamulus._udp.jazz.mydomain.com 300 IN SRV 0 5 22125 server1.mydomain.com	server1.mydomain.com:22125
blues.mydomain.com	_jamulus._udp.blues.mydomain.com 300 IN SRV 0 5 22126 server1.mydomain.com	server1.mydomain.com:22126

It's important to remember that DNS is not forwarding connections. It's simply telling Jamulus client what public host:port to connect to.

Co-authored-by: John Dempsey <[email protected]>

wiki/en/Running-a-Server.md

gilgongo · 2022-11-27T16:50:12Z

FYI I broke out "Running an Unregistered Server" into a separate page in #875 so can put the changes in this PR into that once this one is done (there's probably some clever git way of doing it but I'll just copy/paste)

Co-authored-by: John Dempsey <[email protected]>

Co-authored-by: Peter L Jones <[email protected]>

Removed mydomain.com. Grammar improvements.

wiki/en/Running-a-Server.md

Minor improvements to wording. Co-authored-by: John Dempsey <[email protected]>

wiki/en/Running-a-Server.md

ann0see · 2022-12-07T20:58:24Z

wiki/en/Running-a-Server.md

+
+#### Example use case with SRV records
+
+This example assumes a DNS A or CNAME record resolves ```server1.example.com```, and ```server1.example.com``` has three Jamulus server instances, each listening on one of the three specified ports below.


I think this should be rephrased as the grammar seems strange (I'm not a native speaker.)

wiki/en/Running-a-Server.md

Updates SRV record section. Co-authored-by: ann0see <[email protected]>

Updates SRV record section. Co-authored-by: John Dempsey <[email protected]>

Updates SRV record section. Co-authored-by: ann0see <[email protected]>

Updates SRV record section, changing client to Client

wiki/en/Running-a-Server.md

ann0see

I think I'm mostly happy now. See my comment from above.

@gilgongo could you please give a final review about the language again?

gilgongo · 2023-01-02T10:24:57Z

I think I'm mostly happy now. See my comment from above.

I'm fine with it - but I don't know what this comment from @pljones implies (I'm not close enough to the details) https://github.com/jamulussoftware/jamuluswebsite/pull/874/files#r1026094826

Co-authored-by: ann0see <[email protected]>

gilgongo · 2023-01-04T14:05:43Z

Ah, conflicts. But since this PR was raised, we now have a seprate page in which to put these docs (Unregistered-Servers.md - at least I assume its only relevant to that).

If so, how best to proceed? Shall I just take the current content and raise another PR with it in?

wiki/en/Running-a-Server.md

Adjusts wording in SRV record section Co-authored-by: John Dempsey <[email protected]>

Co-authored-by: John Dempsey <[email protected]>

gilgongo · 2023-01-15T15:15:37Z

Replacing with #904 to resolve issues.

ginjo added 5 commits November 11, 2022 01:58

Update Running-a-Server.md

a1f6a08

Adding documentation for DNS SRV record support

Update Running-a-Server.md

b6925d6

Adding DNS SRV support documentation

Update Running-a-Server.md

2803f2b

Adding DNS SRV support documentation

Update Running-a-Server.md

5000e5d

Adding DNS SRV support documentation

Add server documentation for DNS SRV records

e11eb91

pljones reviewed Nov 18, 2022

View reviewed changes

wiki/en/Running-a-Server.md Outdated Show resolved Hide resolved

pljones reviewed Nov 18, 2022

View reviewed changes

mcfnord reviewed Nov 18, 2022

View reviewed changes

wiki/en/Running-a-Server.md Outdated Show resolved Hide resolved

mcfnord reviewed Nov 18, 2022

View reviewed changes

wiki/en/Running-a-Server.md Outdated Show resolved Hide resolved

mcfnord reviewed Nov 18, 2022

View reviewed changes

wiki/en/Running-a-Server.md Outdated Show resolved Hide resolved

mcfnord reviewed Nov 18, 2022

View reviewed changes

wiki/en/Running-a-Server.md Outdated Show resolved Hide resolved

mcfnord reviewed Nov 18, 2022

View reviewed changes

wiki/en/Running-a-Server.md Outdated Show resolved Hide resolved

mcfnord reviewed Nov 18, 2022

View reviewed changes

wiki/en/Running-a-Server.md Outdated Show resolved Hide resolved

ann0see added this to the Release 3.10.0 milestone Nov 19, 2022

ginjo and others added 6 commits November 21, 2022 00:40

Update wiki/en/Running-a-Server.md DNS SRV description

fe772b7

Co-authored-by: John Dempsey <[email protected]>

Update wiki/en/Running-a-Server.md DNS SRV description

d525b8b

Co-authored-by: John Dempsey <[email protected]>

Update wiki/en/Running-a-Server.md DNS SRV usage

af1ccfd

Co-authored-by: John Dempsey <[email protected]>

Update wiki/en/Running-a-Server.md DNS SRV usage

fc375c5

Co-authored-by: John Dempsey <[email protected]>

Update wiki/en/Running-a-Server.md DNS SRV example

dbd622b

Co-authored-by: John Dempsey <[email protected]>

Adds SRV record example use case

b78b24c

pljones reviewed Nov 21, 2022

View reviewed changes

wiki/en/Running-a-Server.md Outdated Show resolved Hide resolved

hoffie reviewed Nov 22, 2022

View reviewed changes

wiki/en/Running-a-Server.md Outdated Show resolved Hide resolved

gilgongo and others added 3 commits November 28, 2022 08:20

Use example.com

f237a16

Co-authored-by: John Dempsey <[email protected]>

Minor amends to grammar

d454d9b

Co-authored-by: Peter L Jones <[email protected]>

Update Running-a-Server.md

e912a0b

Removed mydomain.com. Grammar improvements.

pljones approved these changes Nov 29, 2022

View reviewed changes

mcfnord reviewed Nov 30, 2022

View reviewed changes

wiki/en/Running-a-Server.md Outdated Show resolved Hide resolved

Update wiki/en/Running-a-Server.md

ba2cd6f

Minor improvements to wording. Co-authored-by: John Dempsey <[email protected]>

ann0see reviewed Dec 7, 2022

View reviewed changes

gilgongo reviewed Dec 8, 2022

View reviewed changes

wiki/en/Running-a-Server.md Outdated Show resolved Hide resolved

ginjo and others added 8 commits December 13, 2022 00:08

Update wiki/en/Running-a-Server.md

da56612

Updates SRV record section. Co-authored-by: ann0see <[email protected]>

Update wiki/en/Running-a-Server.md

84e999b

Updates SRV record section. Co-authored-by: ann0see <[email protected]>

Update wiki/en/Running-a-Server.md

48c83fb

Updates SRV record section. Co-authored-by: ann0see <[email protected]>

Update wiki/en/Running-a-Server.md

ef21720

Updates SRV record section. Co-authored-by: ann0see <[email protected]>

Update wiki/en/Running-a-Server.md

8f3a7b2

Updates SRV record section. Co-authored-by: John Dempsey <[email protected]>

Update wiki/en/Running-a-Server.md

e1b5912

Updates SRV record section. Co-authored-by: ann0see <[email protected]>

Update wiki/en/Running-a-Server.md

8b77028

Updates SRV record section. Co-authored-by: ann0see <[email protected]>

Update Running-a-Server.md

be84c56

Updates SRV record section, changing client to Client

ann0see reviewed Dec 25, 2022

View reviewed changes

wiki/en/Running-a-Server.md Outdated Show resolved Hide resolved

ann0see reviewed Dec 25, 2022

View reviewed changes

Correct formatting

f4aec35

Co-authored-by: ann0see <[email protected]>

mcfnord reviewed Jan 7, 2023

View reviewed changes

wiki/en/Running-a-Server.md Outdated Show resolved Hide resolved

mcfnord reviewed Jan 7, 2023

View reviewed changes

wiki/en/Running-a-Server.md Outdated Show resolved Hide resolved

mcfnord reviewed Jan 7, 2023

View reviewed changes

wiki/en/Running-a-Server.md Outdated Show resolved Hide resolved

ginjo and others added 3 commits January 11, 2023 14:23

Update wiki/en/Running-a-Server.md

1e3d587

Adjusts wording in SRV record section Co-authored-by: John Dempsey <[email protected]>

Update wiki/en/Running-a-Server.md

98298ec

Adjusts wording in SRV record section Co-authored-by: John Dempsey <[email protected]>

Better term for 'domstic'

fd9ec3d

Co-authored-by: John Dempsey <[email protected]>

gilgongo mentioned this pull request Jan 15, 2023

Move DNS SRV docs to Unregistered-Servers.md #904

Merged

gilgongo closed this Jan 15, 2023

pljones removed this from the Release 3.10.0 milestone Jun 4, 2023

		#### Creating SRV records

		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.


		#### Example use case with SRV records

		This example assumes a DNS A or CNAME record resolves ```server1.example.com```, and ```server1.example.com``` has three Jamulus server instances, each listening on one of the three specified ports below.

Comments

Conversation

ginjo commented Nov 17, 2022 • edited by ann0see Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Uh oh!

Uh oh!

pljones Nov 18, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ginjo commented Nov 18, 2022

Example use case with SRV records

Uh oh!

pljones commented Nov 18, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Example use case with SRV records

Uh oh!

ginjo commented Nov 19, 2022

Example use case with SRV records

Uh oh!

Uh oh!

Uh oh!

gilgongo commented Nov 27, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ann0see Dec 7, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ann0see left a comment

Choose a reason for hiding this comment

Uh oh!

gilgongo commented Jan 2, 2023

Uh oh!

gilgongo commented Jan 4, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gilgongo commented Jan 15, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

ginjo commented Nov 17, 2022 •

edited by ann0see

Loading

pljones commented Nov 18, 2022 •

edited

Loading

gilgongo commented Nov 27, 2022 •

edited

Loading

gilgongo commented Jan 4, 2023 •

edited

Loading