From 19102a60a9d2c0d0f0239a5e1287798677f4b319 Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Tue, 29 Nov 2022 09:41:28 +0000
Subject: [PATCH 01/63] New version
---
wiki/en/Running-a-Server.md | 311 ++++++++++++++++++------------------
1 file changed, 156 insertions(+), 155 deletions(-)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index b022821de..33dad266e 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -17,14 +17,15 @@ permalink: "/wiki/Running-a-Server"
-
## Do I need to run a Server?
-**No**. You can use the Servers listed by the built in Directories and use Jamulus without running a Server or choose a third party hosting service. If you just want an undisturbed session, use the [soloing technique described on the Tips and Tricks page](Tips-Tricks-More#have-an-undisturbed-session-on-any-server). If you decide you cannot use any of the Servers listed by the built in Directories, you may be able to use a Server (either Registered in a Custom Directory, or Unregistered - see [Server Types](#server-types)) hosted by a third party. Doing so will save you the trouble of setting one up yourself.
+**No**. You can use the Servers listed by the built in Directories and use Jamulus without running a Server yourself. Or you can use a third party hosting service such as [melomax](https://melomax.live/jamulus-hosting/) or [KOORD](https://koord.live/).
+
+If you just want an undisturbed session, use the soloing technique described on the [Tips and Tricks page](Tips-Tricks-More#have-an-undisturbed-session-on-any-server).
-## Basic requirements
+---
-While setting up a Server isn't difficult, it's a good idea to read the following background information to avoid some problems:
+## Requirements
### Speed and latency
@@ -36,84 +37,101 @@ However, various problems can also arise when setting up Servers - especially wh
Consider using a cloud host, not your home internet connection, to get better ping times if you're having problems.
-
### General notes
* Any Server should have at least 1.6GHz CPU frequency and 1GB RAM
* Running a Server may require you to adjust any firewalls running on or outside of your machine or cloud host.
-* Running an Unregistered Server at home will require you to [port forward](#port-forwarding) on your router. When running a Registered Server, port forwarding should not be necessary in most cases, but it's advisable to do so because some networks may not work properly with Jamulus in its default mode.
+* Running an [Unregistered Server](Unregistered-Servers) at home will require you to port forward on your router. This should not be necessary when running a Registered Server, most cases, but it's advisable to do so because some networks may not work properly with Jamulus in its default mode.
* Jamulus only has limited IPv6 support which needs to be enabled with a command line argument on the Client and Server. (There are plans to expand IPv6 support.)
-## Server Types
+---
-You can run your Server in different ways (either at home or on a 3rd party host):
+## Installation
-### 1. Registered
+Most people run Jamulus on a 3rd party/cloud host as a "pure" Server (also known as "headless") on **hardware without audio** running Linux. You can also run a Server in a [**desktop environment**](#servers-on-the-desktop).
-Your Server will be listed in a Directory. By default, Jamulus has a list of built-in Directories that Clients can connect to. If you register with one of these, anyone can then discover and connect to your Server. You can also have your Server listed on a Custom Directory, if that better meets your needs.
+To run a headless server on Linux, the following steps assume you are familiar with the command line and Debian/Ubuntu or similar distribution using systemd.
-
-
-How Registered Servers work
-
+If you want to run a Server on a **Raspberry Pi** (or a different armhf/arm64 debian-based device), you will need to download the [latest armhf .deb file]({{ site.download_root_link }}{{ site.download_file_names.deb-headless-armhf }}) or [latest arm64 .deb file]({{ site.download_root_link }}{{ site.download_file_names.deb-headless-arm64 }}) depending on your CPU - not the default `amd64` ones for use on Intel/AMD machines.
+
+1. Download the [latest headless (amd64) .deb file]({{ site.download_root_link }}{{ site.download_file_names.deb-headless }}) (or for Raspberry Pi etc. as above)
+1. Make sure you have a current list of standard packages: `sudo apt update`
+1. Install the Jamulus package for your architecture, for example:
+
+ `sudo apt install ./{{ site.download_file_names.deb-headless }}`
+
+1. Enable the headless Server process:
+
+ `sudo systemctl enable jamulus-headless`
+
+1. Add your desired [command line options](Running-a-Server#configuration) to the `ExecStart` line in the systemd service file (by default you will be running an Unregistered Server):
+
+ `sudo systemctl edit --full jamulus-headless`
-### 2. Unregistered
+1. Reload the systemd files and restart the headless Server:
+
+ `sudo systemctl daemon-reload && systemctl restart jamulus-headless`
+
+_To upgrade your Server, just repeat the steps above._
+
+---
+
+## Server Types
+
+Servers can be run in one of three modes (either at home or on a 3rd party host), depending on your needs.
+
+### 1. Unregistered
This is the default when starting a Server for the first time. Unregistered Servers are not listed by Directories, so only musicians who know your Server's address to will be able to connect to it. This is useful because Jamulus does not let you control who can connect to a Server.
+**For information about running an Unregistered Server [see this guide](Unregistered-Servers).**
+
- How Unregistered Servers work
-If you are running an unregistered server behind a home internet connection, you might need to enable [port forwarding](#port-forwarding) as described below.
-
-### 3. Directory
-
-If you want to run a number of Servers, possibly also behind a firewall or on a LAN, you may want to run your Server as a Directory. Examples include online events, music associations, sectional rehearsals or music lessons for schools.
+### 2. Registered
-To run a Directory [read this guide](Directories)
+In this mode your Server will be listed in a Directory. Jamulus has a list of built-in Directories that Clients can connect to, and if you register your Server with one of these, anyone can then discover and connect to it. You can also have your Server listed on a Custom Directory (see below), if that better meets your requirements.
+Note that Directories can only register up to 150 Servers. If you see a message that says you cannot register your Server becuase the Directory is full, you can try registering on another. For a list of all public Directories and the Servers on them, see [explorer.jamulus.io](https://explorer.jamulus.io).
-## Installation and Configuration
+
+
+
-Most people run Jamulus as a "pure" Server on **hardware without audio** (e.g. on a 3rd party/cloud host) running Linux. The following steps assume you are familiar with the command line and Debian/Ubuntu or similar distribution using systemd. To run a server on Windows or on the desktop with a graphical user interface, [see this section](#servers-on-the-desktop).
+### 3. Directory
-If you want to run a Server on a Raspberry Pi (or a different armhf/arm64 debian-based device), you will need to download the `.deb` files for 32 bit `armhf` or 64 bit `arm64`, not the default `amd64` ones you'd use on an Intel/AMD based machine.
+If you want to run a number of Servers, possibly also behind a firewall or on a LAN, you may want to run your Server as a Directory. Examples include online events, music associations, sectional rehearsals or music lessons for schools.
+For information, [see the Directories guide](Directories).
-### Installation
+# Configuration
-1. Download the [latest headless (amd64) .deb file]({{ site.download_root_link }}{{ site.download_file_names.deb-headless }}) or, if you use a Raspberry Pi etc. download the [latest armhf .deb file]({{ site.download_root_link }}{{ site.download_file_names.deb-headless-armhf }}) or the [latest arm64 .deb file]({{ site.download_root_link }}{{ site.download_file_names.deb-headless-arm64 }})
-1. Update apt to make sure you have a current list of standard packages: `sudo apt update`
-1. Install the Jamulus package: `sudo apt install ./{{ site.download_file_names.deb-headless }}` or for RasPi etc. armhf: `sudo apt install ./{{ site.download_file_names.deb-headless-armhf }}`; arm64: `sudo apt install ./{{ site.download_file_names.deb-headless-arm64 }}`
-1. Enable the headless Server process via systemd: `sudo systemctl enable jamulus-headless`
-1. Add your desired [command line options](Running-a-Server#command-line-options) to the `ExecStart` line in the systemd service file by running `sudo systemctl edit --full jamulus-headless` (By default you will be running an Unregistered Server).
-1. Reload the systemd files `sudo systemctl daemon-reload` and restart the headless Server: `sudo systemctl restart jamulus-headless`
-1. Check all is well with `systemctl status jamulus-headless` (hit `q` to get back to the command prompt).
+Depending on your operating system and how you are running the server, you can set Server options and make them persistent between reloads as follows:
-You can control Jamulus with the `systemctl` command. For example, to stop the Server cleanly:
+**Linux headless mode** (Debian/Ubuntu using systemd)
+Add your desired command line options to the `ExecStart` line in the systemd service file by running `sudo systemctl edit --full jamulus-headless`
-`sudo systemctl stop jamulus-headless`
+**GUI mode** (all platforms)
+Any settings made using the graphical interface will be stored in the `Jamulusserver.ini` file (do not attempt to edit this file by hand). However, some options are not available via the GUI and need to be set via the command line. For more information, see [Servers on the desktop](#servers-on-the-desktop)
-_To upgrade your Server, just repeat the steps above._
+---
-### Configuration
+## Server mode options
-#### Running in Registered mode
+#### `-s` or `--server`
+Start Jamulus in Server mode
-The following minimum setup is required to [run a Registered Server](Running-a-Server#server-types):
+#### `-e or --directoryserver`
-~~~
-jamulus --nogui --server \
- --directoryserver genreServer:port \
- --serverinfo "yourServerName;yourCity;[country ID]"
-~~~
+Required for a [Registered Server](Running-a-Server#2-registered). Also required to run Jamulus as a [Directory](Directories).
-**Note**: Semicolon and newline characters are not allowed in `yourServerName` and `yourCity` within the `--serverinfo` argument
+This option takes the format:
-To register with one of the Directories built into the Jamulus Client, replace `genreServer:port` in the example above with one of the following options:
+`--directoryserver genreServer:port`
+To register with one of the Directories built into the Jamulus Client, replace `genreServer:port` with one of the following options:
| Genre | Server Address |
|-----------|------------------|
@@ -125,30 +143,94 @@ To register with one of the Directories built into the Jamulus Client, replace `
|**Genre Classical/Folk** |`classical.jamulus.io:22524`|
|**Genre Choral/Barbershop** |`choral.jamulus.io:22724`|
-You can also specify a [Directory](#3-directory) in the same way from the command line, providing the Server Address in the same format.
-#### Running as a Directory
+#### `-o or --serverinfo`
+When registering a server on a Directory, this lets you display a server name and location details so that users can then search or sort by these values when connecting to Directories with their client.
-If you wish to run a [Directory](Running-a-Server#3-directory) please see [this guide](Directories).
+This option takes the format:
-### Maintenance
+`[name];[city];[country as two-letter ISO country code]`
-#### Viewing The Logs
+See [two-letter ISO country codes](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
-Jamulus will log to the system log file if you left the `StandardOutput=journal` setting in the unit file.
+Note that semicolon and newline characters are not allowed in `name` and `city` values.
-To view the log, use `journalctl` (to exit press Ctrl-C). For example, to read the system log file, filtered for the Jamulus service:
+#### `-L or --licence`
+Show an agreement window before users can connect
-`journalctl -f -u jamulus-headless`
+#### `-w or --welcomemessage`
+Welcome message on connect. Can be given as a string or filename, and can contain HTML.
-#### Controlling Recording
+#### `--serverpublicip`
+The public IP address of the Server if connecting to a Directory behind the same NAT. See [the Directories guide](Directories) for further information.
-When using the recording function with the `-R` command line option, if the Server receives a SIGUSR1 signal during a recording, it will start a new recording in a new Directory. SIGUSR2 will recording enabled on/off.
+#### `--directoryfile`
+_Directories only:_ Remember registered Servers even if the Directory is restarted. See [the Directories guide](Directories) for further information.
-To send these signals using systemd, create the following two `.service` files in `/etc/systemd/system`, calling them something appropriate (e.g. `jamulusTogglerec.service`).
+#### `-f or --listfilter`
+_Directories only:_ Whitelist Servers registering on the Server. See [the Directories guide](Directories) for further information.
+
+---
+
+## General Server options
+These options can be used regardless of which mode your server is running in (although some may not be relevant for Directories).
+
+#### `-d or --discononquit`
+Normally, when a Server is stopped or restarted, any Clients that have not used their “Disconnect” buttons will re-establish connection when the Server comes back up again. Using this option forces Clients to manually re-establish their connections to the Server.
+
+#### `-F or --fastupdate`
+Reduces latency if Clients connect with “Enable Small Network Buffers” option. Requires faster CPU to avoid dropouts, and more bandwidth to enabled Clients.
+
+#### `-l or --log`
+Enable logging, set path and file name
+
+#### `-m or --htmlstatus`
+Enable HTML status file, set path and file name
+
+#### `-P or --delaypan`
+Start with delay panning enabled.This option uses small differences in sound arrival time between the two ears. It produces a stereo effect similar to natural human hearing when compared to normal “volume” panning.
+
+#### `--serverbindip`
+Specify the IP address the Jamulus process will bind to
+
+#### `-T or --multithreading`
+Use multithreading to make better use of multi-core CPUs to support more Clients
+
+#### `-u or --numchannels`
+Maximum number of channels (Clients)
+
+#### `-z or --startminimized`
+Start the graphicial user interface minimized
+
+## Other options
+
+{% include_relative Include-Shared-Commands.md %}
+
+---
+
+## Recording
+
+#### `-R or --recording`
+Set server recording directory; Server will record when a session is active by default.
**Note:** You will need to save recordings to a path _outside_ of the jamulus home Directory, or remove `ProtectHome=true` from your systemd unit file (be aware that doing so is however a potential security risk).
+Recordings are per track in [Audacity](https://www.audacityteam.org/) `.lof` format and [REAPER](https://en.wikipedia.org/wiki/REAPER) `.rpp`. Open the respective files to listen to them in those applications.
+
+Note that when your Server is recording, Clients will display a message that recording is on.
+
+#### `--norecord`
+Set server not to record by default when recording is configured.
+
+
+### Controlling Recording
+
+Recording starts once the first person connects to the Server, and stops when the last person leaves.
+
+If the Server receives a SIGUSR1 signal during a recording, it will start a new recording in a new Directory. SIGUSR2 will toggle recording on/off.
+
+To send these signals using systemd, create the following two `.service` files in `/etc/systemd/system`, calling them something appropriate (e.g. `jamulusTogglerec.service`).
+
For turning recording on or off (depending on the current state):
~~~
@@ -179,131 +261,50 @@ Run `sudo systemctl daemon-reload` to register them for first use.
Now you can run these with the `systemctl` command, for example:
-`sudo systemctl start jamulusTogglerec` (assuming you named your unit file `jamulusTogglerec.service`)
+`sudo systemctl start jamulusTogglerec`
You can see the result of these commands if you run `systemctl status jamulus`, or by viewing the logs.
+---
## Servers on the desktop
-Jamulus can be run in Server mode from the desktop. This gives you a graphical user interface to control most of the settings.
-
-* **Windows users** - Use the "Jamulus Server" icon in the Windows Start menu.
-* **macOS users** - Double-click the "Jamulus Server" icon in Applications (assuming you put the files from the install there as per [these instructions](Installation-for-Macintosh)).
-* **Linux users** - Launch the "Jamulus Server" shortcut. Or you can open a terminal window (`CTRL+ALT+t` on Debian and related distros), type `jamulus -s` and hit return.
-
-
-## Server Setup
-
-
+Jamulus can be run in Server mode from the desktop. This gives you a graphical user interface to control most of the settings. To do this, first [install Jamulus](Getting-Started) for your platform, the do one of the following:
-### The Directory list
+* **Windows users** - Use the "Jamulus Server" icon in the Windows Start menu. If you want the Server to start automatically on system start, enable the corresponding check box.
-**None**: By default, you will not be connected to a Directory and will be running in unregistered mode. [Read these instructions](#running-an-unregistered-server) to have other people connect to your Server in this mode.
+* **macOS users** - Double-click the "Jamulus Server" icon in Applications.
-**Genre**: To allow other people to see your Server on one of the Directories built into the Client, select your desired genre Directory. You should see a confirmation message saying whether your Server has registered successfully. If not, and you leave your Server running, it will keep trying to register until a free slot becomes available.
-
-**Custom**: This allows you to specify a custom directory on which to be listed. See the "Options" tab for the Custom Directory address you want to use.
-
-To run your Server _as_ a Directory, you need to set the Custom Directory address as `localhost` or `127.0.0.1` and set the "Genre" to "Custom". [Read this guide](Directories) for further details.
-
-### My Server Info
-
-When running as a Registered Server this displays the Server's name, city and country so that other users can easily identify it in the Directory listing.
-
-### Chat Welcome Message
-
-The text entered here appears to all users when they join the Server (the chat window will open automatically for them). HTML is also supported.
-
-## Options
-
-
-
-### Recording Directory
-
-This sets the path to where the Server's recordings will be stored. With this path set, the "Enable Jam Recorder" function in the Server Setup tab will make recording start once the first person connects to the Server, and stops when the last person leaves. Use the "New Recording" button to create a new sub-directory in which the recordings will be stored from then on. Note that Recordings are per track in [Audacity](https://www.audacityteam.org/) `.lof` format and [REAPER](https://en.wikipedia.org/wiki/REAPER) `.rpp`. Open the respective files to listen to them in those applications.
-
-**Note**: When your Server is recording, Clients will display a message that recording is on.
-
-### Custom Directory Address
-
-Leave this field empty unless you need to list your Server on a [Custom Directory](#3-directory) or run a Directory.
+* **Linux users** - Launch the "Jamulus Server" shortcut. Or you can open a terminal window (`CTRL+ALT+t` on Debian and related distros), type `jamulus -s` and hit return.
-### Server List Filename
+While most common functions in Jamulus can be set using the GUI, others can only be set using options given in a terminal window when the server is launched. Exactly how you do this will depend on your operating system.
-Leave this field empty unless you need to run your Server as a [Directory](#3-directory). When in use, this holds the list of registered Servers whilst restarting the Directory. This prevents the server list appearing "empty" until the Servers re-register.
+For example on Windows, to use a specific settings file, right-click on the Jamulus shortcut and choose **Properties** > **Target**. Add the necessary arguments to Jamulus.exe:
-### Delay panning
+ `"C:\Program Files\Jamulus\Jamulus.exe" --serverbindip 192.168.0.100`
-This option uses small differences in sound arrival time between the two ears. It produces a stereo effect similar to natural human hearing when compared to normal "volume" panning.
+For macOS, start a Terminal window and run Jamulus with the desired options like this:
-### Start Minimised
+ `/Applications/Jamulus.app/Contents/MacOS/Jamulus --serverbindip 192.168.0.100`
-**Windows users** - If you want the Server to start automatically on system start, enable the corresponding check box.
+**Note** Command line options will set the Server’s defaults at startup. You can override them with their corresponding GUI controls while the Server is running.
-### Server status icon
+### The Server status icon
-When the Server is running, the operating system will show an icon in the system tray or status area to represent whether the Server is active:
+When a Server is running in GUI mode, the operating system will show an icon in the system tray or status area that indicates whether the Server is active:
The Server is empty
The Server is occupied
-## Command line options
-
-Most common functions in Jamulus can be set using the GUI, but these and others can also be set using options given in a terminal window. Exactly how you do this will depend on your operating system.
-
-For example on Windows, to use a specific settings file, right-click on the Jamulus shortcut and choose "Properties" > Target. Add the necessary arguments to Jamulus.exe:
-
-```shell
- "C:\Program Files\Jamulus\Jamulus.exe" --serverbindip 192.168.0.100
-```
-
-For macOS, start a Terminal window and run Jamulus with the desired options like this:
-
-```shell
- /Applications/Jamulus.app/Contents/MacOS/Jamulus --serverbindip 192.168.0.100
-```
-
-**Note**: Command line options will set the Server's defaults at startup. You can override them with their corresponding GUI controls while the Server is running.
-
-{% include_relative Include-Server-Commands.md %}
-
-{% include_relative Include-Shared-Commands.md %}
-
-
-## Running an Unregistered Server
-
-It is highly recommended to test your Server by registering it on one of the built-in Directories **first** so as to narrow down any subsequent problems in unregistered mode.
-
-### Setting up a Server behind a home router
-
-If you set up your server at home, you will probably need to change some settings in your router/firewall:
-
-#### Port forwarding
-
-People from outside your home network will not be able to see things inside it. To let external Jamulus clients connect to your server, you need to set up port forwarding in your Router's settings. The exact setup differs for every router. For help see your Router's documentation or [portforward.com](https://portforward.com).
-
-**Note:** The default port for the current version of Jamulus is **UDP** (not TCP) port **22124**. You will usually forward the port **22124** from outside your network to the port **22124** of the machine running the Server.
-
-**Note:** Your home router may change the IP address of the machine you're running your Server on. Depending on your router, you might need to give this machine a static IP address (often under DHCP settings of your router).
-
-#### Getting the external IP
-
-To allow others to connect to your Server from the internet, get your external (WAN) IP address e.g. by [using Google](https://www.google.com/search?q=what+is+my+ip) and give it to them.
-You yourself should connect using the local network (LAN) address of the machine the Server is running on. If you are running a Client on the same machine as your Server, that would be `localhost` or `127.0.0.1`.
-
-
-#### Dynamic DNS and why you will probably need it
-
-Most domestic internet connections change their external IP address after a short period. To avoid problems with this, you might want to set up "dynamic DNS" to get a static (sub-)domain you can share with others. Please research how to do that for your specic set up. Your router might support some "dynamic DNS" providers out of the box. If this is not the case, set up a dynamic DNS client as described by the dynamic DNS provider you chose.
+---
## Backing up the Server
-_Note that headless Servers do not use `.ini` files. All configuration is given as command line options._
-
{% include_relative Include-Backing-Up.md %}
+- Headless Servers do not use `.ini` files. All configuration is given as command line options. If you are running a server in GUI mode, it will store its configuration (after reading any command line options on start) in the file `Jamululsserver.ini`
+
## Troubleshooting
If you are having other problems, [see this guide](Server-Troubleshooting).
From 68eef3bfc3a79a8700fc796748f0888661a4728b Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Tue, 29 Nov 2022 09:42:57 +0000
Subject: [PATCH 02/63] Separating Unreg servers to file
---
wiki/en/Unregistered-Servers.md | 34 +++++++++++++++++++++++++++++++++
1 file changed, 34 insertions(+)
create mode 100644 wiki/en/Unregistered-Servers.md
diff --git a/wiki/en/Unregistered-Servers.md b/wiki/en/Unregistered-Servers.md
new file mode 100644
index 000000000..8adf573a1
--- /dev/null
+++ b/wiki/en/Unregistered-Servers.md
@@ -0,0 +1,34 @@
+---
+layout: wiki
+title: "Running an Unregistered Server"
+lang: "en"
+permalink: "/wiki/Unregistered-Servers"
+---
+
+{% include breadcrumb.html root="More" branch1="Server Administration" branch1-url="Running-a-Server" %}
+
+# Running an Unregistered Server
+
+It is highly recommended to test your Server by registering it on one of the built-in Directories **first**. This will help you tackle general problems before you try unregistered mode.
+
+## Setting up a Server behind a home router
+
+If you set up your server at home, you will probably need to change some settings in your router/firewall:
+
+### Port forwarding
+
+Normally, people from outside your home network cannot see things inside it. To let external Jamulus clients connect to your server, you need to set up port forwarding in your router's settings. The exact setup differs for every router. For help, see your router's documentation or [portforward.com](https://portforward.com).
+
+**Note:** The default port for Jamulus is **UDP** (not TCP) port **22124**. You will usually forward the port **22124** from outside your network to the port **22124** of the computer running the Server.
+
+**Note:** Your home router might change the IP address of the computer you're running your Server on. Depending on your router, you might need to give this computer a static IP address (often under DHCP settings of your router).
+
+### Getting the external IP
+
+To allow others to connect to your Server from the internet, give them your public internet IP address. You can learn your current address [using Google](https://www.google.com/search?q=what+is+my+ip).
+You should connect yourself using the local network address of the computer the Server is running on. If you are running a Client on the same computer as your Server, the address is `localhost` or `127.0.0.1`.
+
+
+### Dynamic DNS and why you will probably need it
+
+Unless your ISP provides you with a fixed IP address, you may find that your address changes over time. To avoid problems with this, you might want to set up "dynamic DNS" to get a static address you can share with others. Your router might support some "dynamic DNS" providers to do this. If this is not the case, these providers will have instructions to set up a dynamic DNS client.
From 8dc888ee794ab4aca17595b5b0f7884024a9c8ec Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Tue, 29 Nov 2022 09:44:14 +0000
Subject: [PATCH 03/63] Update Command-Line-Options.md
Old server include file removed
---
wiki/en/Command-Line-Options.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/wiki/en/Command-Line-Options.md b/wiki/en/Command-Line-Options.md
index 4a652aa30..89b3d3dd3 100644
--- a/wiki/en/Command-Line-Options.md
+++ b/wiki/en/Command-Line-Options.md
@@ -17,5 +17,5 @@ permalink: "/wiki/Command-Line-Options"
## Server only commands
-{% include_relative Include-Server-Commands.md %}
+See [Running a Server](Running-a-Server#server-mode-options)
From b75c63236014f505854092951e8517b62e278362 Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Tue, 29 Nov 2022 09:45:19 +0000
Subject: [PATCH 04/63] Delete Include-Server-Commands.md
---
wiki/en/Include-Server-Commands.md | 19 -------------------
1 file changed, 19 deletions(-)
delete mode 100644 wiki/en/Include-Server-Commands.md
diff --git a/wiki/en/Include-Server-Commands.md b/wiki/en/Include-Server-Commands.md
deleted file mode 100644
index f76181a18..000000000
--- a/wiki/en/Include-Server-Commands.md
+++ /dev/null
@@ -1,19 +0,0 @@
-- `-d` or `--discononquit` Disconnect all Clients on quit. Normally, when a Server is stopped or restarted, any Clients that have not used their "Disconnect" buttons will re-establish connection when the Server comes back up again. Using this option forces Clients to manually re-establish their connections to the Server.
-- `-e` or `--directoryserver` Register the Server on a Directory (e.g. to set its genre (see also `-o`)). See [Server Types](Running-a-Server#server-types) for further information.
-- `--directoryfile` Remember registered Servers even if the Directory is restarted. Directory Servers only. See [this guide](Directories) for further information.
-- `-f` or `--listfilter` Whitelist Servers registering on the Server list, format `ip address 1[;ip address 2]` Directories only.
-- `-F` or `--fastupdate` Reduces latency if Clients connect with "Enable Small Network Buffers" option. Requires faster CPU to avoid dropouts, and more bandwidth to enabled Clients.
-- `-l` or `--log` Enable logging, set path and file name
-- `-L` or `--licence` Show an agreement window before users can connect
-- `-m` or `--htmlstatus` Enable HTML status file, set path and file name
-- `-o` or `--serverinfo` Location details in the format: `[name];[city];[country as two-letter ISO country code or Qt5 Locale]` (see [two-letter ISO country codes](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) or [Qt5 Locale values](https://doc.qt.io/qt-5/qlocale.html#Country-enum)) Registered Servers only
-- `-P` or `--delaypan` Start with delay panning enabled See [notes](Running-a-Server#delay-panning)
-- `-R` or `--recording` Set server recording directory; Server will record when a session is active by default. See [Options](Running-a-Server#options).
-- `--norecord` Set server not to record by default (when recording is configured e.g via `-R`)
-- `-s` or `--server` Start in Server mode
-- `--serverbindip` Specify the IP address to bind to
-- `-T` or `--multithreading` Use multithreading to make better use of multi-core CPUs to support more Clients
-- `-u` or `--numchannels` Maximum number of channels (Clients)
-- `-w` or `--welcomemessage` Welcome message on connect. Can be given as a string or filename, and can contain HTML.
-- `-z` or `--startminimized` Start minimized
-- `--serverpublicip` The public IP address of the Server if connecting to a Directory behind the same NAT. See [Notes on Directories](Directories#points-to-note-about-directories)
From e1c9ac6f72738c2974f2136781a84623ba45f687 Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Tue, 29 Nov 2022 09:46:59 +0000
Subject: [PATCH 05/63] Delete server-window-options.inc
---
assets/img/en-screenshots/server-window-options.inc | 1 -
1 file changed, 1 deletion(-)
delete mode 100644 assets/img/en-screenshots/server-window-options.inc
diff --git a/assets/img/en-screenshots/server-window-options.inc b/assets/img/en-screenshots/server-window-options.inc
deleted file mode 100644
index 2536b94a6..000000000
--- a/assets/img/en-screenshots/server-window-options.inc
+++ /dev/null
@@ -1 +0,0 @@
-https://user-images.githubusercontent.com/4561747/178142687-da256fa5-d7b8-47ab-9265-63c3c9760841.png
From 6d7df2618a34c7652a1e6b0cfdc854ae01e1f411 Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Tue, 29 Nov 2022 09:47:15 +0000
Subject: [PATCH 06/63] Delete server-window-setup.inc
---
assets/img/en-screenshots/server-window-setup.inc | 1 -
1 file changed, 1 deletion(-)
delete mode 100644 assets/img/en-screenshots/server-window-setup.inc
diff --git a/assets/img/en-screenshots/server-window-setup.inc b/assets/img/en-screenshots/server-window-setup.inc
deleted file mode 100644
index 714fbf90e..000000000
--- a/assets/img/en-screenshots/server-window-setup.inc
+++ /dev/null
@@ -1 +0,0 @@
-https://user-images.githubusercontent.com/4561747/178142684-1b85e654-78be-4909-a76c-945d7a0f7ccc.png
From 8b15142cd148795bab46a2e01f6d80ec5131ce4e Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Tue, 29 Nov 2022 10:23:52 +0000
Subject: [PATCH 07/63] Update headings, layout
---
wiki/en/Running-a-Server.md | 57 +++++++++++++++++++++----------------
1 file changed, 32 insertions(+), 25 deletions(-)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index 33dad266e..114eebfa8 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -106,26 +106,27 @@ If you want to run a number of Servers, possibly also behind a firewall or on a
For information, [see the Directories guide](Directories).
-# Configuration
+---
+
+## Configuration options
Depending on your operating system and how you are running the server, you can set Server options and make them persistent between reloads as follows:
**Linux headless mode** (Debian/Ubuntu using systemd)
+
Add your desired command line options to the `ExecStart` line in the systemd service file by running `sudo systemctl edit --full jamulus-headless`
**GUI mode** (all platforms)
+
Any settings made using the graphical interface will be stored in the `Jamulusserver.ini` file (do not attempt to edit this file by hand). However, some options are not available via the GUI and need to be set via the command line. For more information, see [Servers on the desktop](#servers-on-the-desktop)
---
-## Server mode options
-
-#### `-s` or `--server`
-Start Jamulus in Server mode
+### Server mode-related options
-#### `-e or --directoryserver`
+##### `-e or --directoryserver`
-Required for a [Registered Server](Running-a-Server#2-registered). Also required to run Jamulus as a [Directory](Directories).
+Required for a [Registered Server](Running-a-Server#2-registered). Also required to run Jamulus as a [Directory](Directories).
This option takes the format:
@@ -144,7 +145,8 @@ To register with one of the Directories built into the Jamulus Client, replace `
|**Genre Choral/Barbershop** |`choral.jamulus.io:22724`|
-#### `-o or --serverinfo`
+##### `-o or --serverinfo`
+
When registering a server on a Directory, this lets you display a server name and location details so that users can then search or sort by these values when connecting to Directories with their client.
This option takes the format:
@@ -155,53 +157,58 @@ See [two-letter ISO country codes](https://en.wikipedia.org/wiki/ISO_3166-1_alph
Note that semicolon and newline characters are not allowed in `name` and `city` values.
-#### `-L or --licence`
+##### `-L or --licence`
Show an agreement window before users can connect
-#### `-w or --welcomemessage`
+##### `-w or --welcomemessage`
Welcome message on connect. Can be given as a string or filename, and can contain HTML.
-#### `--serverpublicip`
+##### `--serverpublicip`
The public IP address of the Server if connecting to a Directory behind the same NAT. See [the Directories guide](Directories) for further information.
-#### `--directoryfile`
+##### `--directoryfile`
_Directories only:_ Remember registered Servers even if the Directory is restarted. See [the Directories guide](Directories) for further information.
-#### `-f or --listfilter`
+##### `-f or --listfilter`
_Directories only:_ Whitelist Servers registering on the Server. See [the Directories guide](Directories) for further information.
---
-## General Server options
+### General Server options
These options can be used regardless of which mode your server is running in (although some may not be relevant for Directories).
-#### `-d or --discononquit`
+##### `-d or --discononquit`
Normally, when a Server is stopped or restarted, any Clients that have not used their “Disconnect” buttons will re-establish connection when the Server comes back up again. Using this option forces Clients to manually re-establish their connections to the Server.
-#### `-F or --fastupdate`
+##### `-F or --fastupdate`
Reduces latency if Clients connect with “Enable Small Network Buffers” option. Requires faster CPU to avoid dropouts, and more bandwidth to enabled Clients.
-#### `-l or --log`
+##### `-l or --log`
Enable logging, set path and file name
-#### `-m or --htmlstatus`
+##### `-m or --htmlstatus`
Enable HTML status file, set path and file name
-#### `-P or --delaypan`
+##### `-P or --delaypan`
Start with delay panning enabled.This option uses small differences in sound arrival time between the two ears. It produces a stereo effect similar to natural human hearing when compared to normal “volume” panning.
-#### `--serverbindip`
+##### `-s` or `--server`
+Start Jamulus in Server mode
+
+##### `--serverbindip`
Specify the IP address the Jamulus process will bind to
-#### `-T or --multithreading`
+##### `-T or --multithreading`
Use multithreading to make better use of multi-core CPUs to support more Clients
-#### `-u or --numchannels`
+##### `-u or --numchannels`
Maximum number of channels (Clients)
-#### `-z or --startminimized`
+##### `-z or --startminimized`
Start the graphicial user interface minimized
+---
+
## Other options
{% include_relative Include-Shared-Commands.md %}
@@ -210,7 +217,7 @@ Start the graphicial user interface minimized
## Recording
-#### `-R or --recording`
+##### `-R or --recording`
Set server recording directory; Server will record when a session is active by default.
**Note:** You will need to save recordings to a path _outside_ of the jamulus home Directory, or remove `ProtectHome=true` from your systemd unit file (be aware that doing so is however a potential security risk).
@@ -219,7 +226,7 @@ Recordings are per track in [Audacity](https://www.audacityteam.org/) `.lof` for
Note that when your Server is recording, Clients will display a message that recording is on.
-#### `--norecord`
+##### `--norecord`
Set server not to record by default when recording is configured.
From 1175dc2734a57024a9eaaef3882ce33b2d65052c Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Tue, 29 Nov 2022 21:25:27 +0000
Subject: [PATCH 08/63] Minor updates
Co-authored-by: Peter L Jones
---
wiki/en/Running-a-Server.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index 114eebfa8..f17389405 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -41,7 +41,7 @@ Consider using a cloud host, not your home internet connection, to get better pi
* Any Server should have at least 1.6GHz CPU frequency and 1GB RAM
* Running a Server may require you to adjust any firewalls running on or outside of your machine or cloud host.
-* Running an [Unregistered Server](Unregistered-Servers) at home will require you to port forward on your router. This should not be necessary when running a Registered Server, most cases, but it's advisable to do so because some networks may not work properly with Jamulus in its default mode.
+* Running an [Unregistered Server](Unregistered-Servers) at home will require you to port forward on your router. This should not be necessary when running a Registered Server, in most cases, but it's advisable to do so because some networks may not work properly with Jamulus in its default mode.
* Jamulus only has limited IPv6 support which needs to be enabled with a command line argument on the Client and Server. (There are plans to expand IPv6 support.)
---
From 83538d1cb67d6d01dae0c4c51d4d5fabe7711998 Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Tue, 29 Nov 2022 21:25:45 +0000
Subject: [PATCH 09/63] Formatting
Co-authored-by: Peter L Jones
---
wiki/en/Running-a-Server.md | 2 ++
1 file changed, 2 insertions(+)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index f17389405..a43cb5e3c 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -74,6 +74,8 @@ If you want to run a Server on a **Raspberry Pi** (or a different armhf/arm64 de
_To upgrade your Server, just repeat the steps above._
+_To amend your Server configuration, just repeat the last two steps above._
+
---
## Server Types
From d8d046fdf4acdbbba5cd97850ab4b91a172d13af Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Tue, 29 Nov 2022 21:26:30 +0000
Subject: [PATCH 10/63] Minor amends. Formatting
Co-authored-by: Peter L Jones
---
wiki/en/Running-a-Server.md | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index a43cb5e3c..eed0975a2 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -94,7 +94,9 @@ This is the default when starting a Server for the first time. Unregistered Serv
### 2. Registered
-In this mode your Server will be listed in a Directory. Jamulus has a list of built-in Directories that Clients can connect to, and if you register your Server with one of these, anyone can then discover and connect to it. You can also have your Server listed on a Custom Directory (see below), if that better meets your requirements.
+In this mode your Server will be included in the server list supplied by a Directory. Jamulus has a list of built-in Directories that Clients can know, and if you register your Server with one of these, anyone can then discover and connect to it.
+
+You can also have your Server listed by a Custom Directory (see below), if that better meets your requirements. Clients can then only see your Server if they also know the Custom Directory.
Note that Directories can only register up to 150 Servers. If you see a message that says you cannot register your Server becuase the Directory is full, you can try registering on another. For a list of all public Directories and the Servers on them, see [explorer.jamulus.io](https://explorer.jamulus.io).
From 9154095c8217ec98b437270fb812b770fb7ef779 Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Tue, 29 Nov 2022 21:29:40 +0000
Subject: [PATCH 11/63] Add --directoryserver syntax
Co-authored-by: Peter L Jones
---
wiki/en/Running-a-Server.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index eed0975a2..a0172a627 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -134,7 +134,7 @@ Required for a [Registered Server](Running-a-Server#2-registered). Also required
This option takes the format:
-`--directoryserver genreServer:port`
+`--directoryserver hostname:port` where `hostname` is the Genre Directory host name and `port` is its port number.
To register with one of the Directories built into the Jamulus Client, replace `genreServer:port` with one of the following options:
From 548d884b19c38b3bb6bc58bb4aa6b3ecb4f260e0 Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Tue, 29 Nov 2022 21:31:00 +0000
Subject: [PATCH 12/63] Syntax clarification
Co-authored-by: Peter L Jones
---
wiki/en/Running-a-Server.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index a0172a627..9609d0069 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -138,7 +138,7 @@ This option takes the format:
To register with one of the Directories built into the Jamulus Client, replace `genreServer:port` with one of the following options:
-| Genre | Server Address |
+| Genre | `hostname:port` |
|-----------|------------------|
|**Any Genre 1** |`anygenre1.jamulus.io:22124`|
|**Any Genre 2** |`anygenre2.jamulus.io:22224`|
From 850c9b341021b8030839d666e570fca89d77959b Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Tue, 29 Nov 2022 21:31:31 +0000
Subject: [PATCH 13/63] Remove ref. to genre
Co-authored-by: Peter L Jones
---
wiki/en/Running-a-Server.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index 9609d0069..bbb9752cd 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -136,7 +136,7 @@ This option takes the format:
`--directoryserver hostname:port` where `hostname` is the Genre Directory host name and `port` is its port number.
-To register with one of the Directories built into the Jamulus Client, replace `genreServer:port` with one of the following options:
+To register with one of the Directories built into the Jamulus Client, replace `hostname:port` with one of the following options:
| Genre | `hostname:port` |
|-----------|------------------|
From 7e622572a58cd5b39f450dd26901f4c664a3767e Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Tue, 29 Nov 2022 21:32:46 +0000
Subject: [PATCH 14/63] Remove ref. to sorting
Co-authored-by: Peter L Jones
---
wiki/en/Running-a-Server.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index bbb9752cd..5c17b5fd3 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -151,7 +151,7 @@ To register with one of the Directories built into the Jamulus Client, replace `
##### `-o or --serverinfo`
-When registering a server on a Directory, this lets you display a server name and location details so that users can then search or sort by these values when connecting to Directories with their client.
+When registering your Server with a Directory, this lets you supply a server name and location details so that users can then search for these values from their Client.
This option takes the format:
From 8b99210fc18aada70461fe15a07798d085ebc9da Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Tue, 29 Nov 2022 21:33:28 +0000
Subject: [PATCH 15/63] Clarify -L description
Co-authored-by: Peter L Jones
---
wiki/en/Running-a-Server.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index 5c17b5fd3..ffd65b7b3 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -162,7 +162,7 @@ See [two-letter ISO country codes](https://en.wikipedia.org/wiki/ISO_3166-1_alph
Note that semicolon and newline characters are not allowed in `name` and `city` values.
##### `-L or --licence`
-Show an agreement window before users can connect
+Show an agreement window before users can connect. The text of the agreement to be shown should be supplied as the `--welcomemessage` (see below).
##### `-w or --welcomemessage`
Welcome message on connect. Can be given as a string or filename, and can contain HTML.
From b504fee00f5490db148781bb2761532abb39c61d Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Tue, 29 Nov 2022 21:33:56 +0000
Subject: [PATCH 16/63] Clarify -w description
Co-authored-by: Peter L Jones
---
wiki/en/Running-a-Server.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index ffd65b7b3..976f1d14e 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -165,7 +165,7 @@ Note that semicolon and newline characters are not allowed in `name` and `city`
Show an agreement window before users can connect. The text of the agreement to be shown should be supplied as the `--welcomemessage` (see below).
##### `-w or --welcomemessage`
-Welcome message on connect. Can be given as a string or filename, and can contain HTML.
+A "welcome message" to display in the Client chat window on connect. Can be given as a string or filename, and can contain HTML.
##### `--serverpublicip`
The public IP address of the Server if connecting to a Directory behind the same NAT. See [the Directories guide](Directories) for further information.
From 89207d051ef4b896a9206c9e91148cc0cbbd1ae1 Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Tue, 29 Nov 2022 21:35:19 +0000
Subject: [PATCH 17/63] Clarify Dyndns paragraph
Co-authored-by: Peter L Jones
---
wiki/en/Unregistered-Servers.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/wiki/en/Unregistered-Servers.md b/wiki/en/Unregistered-Servers.md
index 8adf573a1..6c9a7d1b6 100644
--- a/wiki/en/Unregistered-Servers.md
+++ b/wiki/en/Unregistered-Servers.md
@@ -31,4 +31,4 @@ You should connect yourself using the local network address of the computer the
### Dynamic DNS and why you will probably need it
-Unless your ISP provides you with a fixed IP address, you may find that your address changes over time. To avoid problems with this, you might want to set up "dynamic DNS" to get a static address you can share with others. Your router might support some "dynamic DNS" providers to do this. If this is not the case, these providers will have instructions to set up a dynamic DNS client.
+Unless your ISP provides you with a fixed IP address, you may find that your address changes over time. To avoid problems with this, you might want to set up "dynamic DNS" to get a static address you can share with others. A "dynamic DNS" provider can supply you with a static IP address that you can share but you need to keep refreshing your dynamic IP with the provider. Your router might support certain providers to do this. If this is not the case, the provider will have instructions on how to set up a dynamic DNS client.
From f383e682c135e4ba47f75bed383fb45d7b661e94 Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Tue, 29 Nov 2022 21:36:06 +0000
Subject: [PATCH 18/63] Clarify headless description
Co-authored-by: John Dempsey <1750243+mcfnord@users.noreply.github.com>
---
wiki/en/Running-a-Server.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index 976f1d14e..02e699043 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -48,7 +48,7 @@ Consider using a cloud host, not your home internet connection, to get better pi
## Installation
-Most people run Jamulus on a 3rd party/cloud host as a "pure" Server (also known as "headless") on **hardware without audio** running Linux. You can also run a Server in a [**desktop environment**](#servers-on-the-desktop).
+Most people run Jamulus on a 3rd party/cloud host as a "headless" Server (no video display or keyboard) on **hardware without audio** running Linux. You can also run a Server in a [**desktop environment**](#servers-on-the-desktop).
To run a headless server on Linux, the following steps assume you are familiar with the command line and Debian/Ubuntu or similar distribution using systemd.
From ccef379edde6fc4ffc3b3d23fd2569ec0653435b Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Tue, 29 Nov 2022 21:41:36 +0000
Subject: [PATCH 19/63] Update for style
Co-authored-by: John Dempsey <1750243+mcfnord@users.noreply.github.com>
---
wiki/en/Running-a-Server.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index 02e699043..3109147c6 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -50,7 +50,7 @@ Consider using a cloud host, not your home internet connection, to get better pi
Most people run Jamulus on a 3rd party/cloud host as a "headless" Server (no video display or keyboard) on **hardware without audio** running Linux. You can also run a Server in a [**desktop environment**](#servers-on-the-desktop).
-To run a headless server on Linux, the following steps assume you are familiar with the command line and Debian/Ubuntu or similar distribution using systemd.
+To run a headless server on Linux, the following steps assume you are familiar with the command line and Debian/Ubuntu or similar distribution that uses systemd.
If you want to run a Server on a **Raspberry Pi** (or a different armhf/arm64 debian-based device), you will need to download the [latest armhf .deb file]({{ site.download_root_link }}{{ site.download_file_names.deb-headless-armhf }}) or [latest arm64 .deb file]({{ site.download_root_link }}{{ site.download_file_names.deb-headless-arm64 }}) depending on your CPU - not the default `amd64` ones for use on Intel/AMD machines.
From 1391933abb2cabb3ed989311f141a53b5fc031e3 Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Tue, 29 Nov 2022 21:42:26 +0000
Subject: [PATCH 20/63] Add deprecation warning to -m
Co-authored-by: John Dempsey <1750243+mcfnord@users.noreply.github.com>
---
wiki/en/Running-a-Server.md | 2 ++
1 file changed, 2 insertions(+)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index 3109147c6..5f23cab11 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -193,6 +193,8 @@ Enable logging, set path and file name
##### `-m or --htmlstatus`
Enable HTML status file, set path and file name
+**Note:** This feature is deprecated, and may disappear in a future release.
+
##### `-P or --delaypan`
Start with delay panning enabled.This option uses small differences in sound arrival time between the two ears. It produces a stereo effect similar to natural human hearing when compared to normal “volume” panning.
From 008209daef789bd4af25172c117b741e0533e7da Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Tue, 29 Nov 2022 21:43:29 +0000
Subject: [PATCH 21/63] Update for style
Co-authored-by: John Dempsey <1750243+mcfnord@users.noreply.github.com>
---
wiki/en/Running-a-Server.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index 5f23cab11..bc5c2f3fb 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -224,7 +224,7 @@ Start the graphicial user interface minimized
## Recording
##### `-R or --recording`
-Set server recording directory; Server will record when a session is active by default.
+Set server recording directory. By default, the Server will record when a session is active.
**Note:** You will need to save recordings to a path _outside_ of the jamulus home Directory, or remove `ProtectHome=true` from your systemd unit file (be aware that doing so is however a potential security risk).
From b798bd51cfb79ec85192e7e797ad46b09d025e8e Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Tue, 29 Nov 2022 21:44:17 +0000
Subject: [PATCH 22/63] Update for style
Co-authored-by: John Dempsey <1750243+mcfnord@users.noreply.github.com>
---
wiki/en/Running-a-Server.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index bc5c2f3fb..6e153c0a9 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -230,7 +230,7 @@ Set server recording directory. By default, the Server will record when a sessio
Recordings are per track in [Audacity](https://www.audacityteam.org/) `.lof` format and [REAPER](https://en.wikipedia.org/wiki/REAPER) `.rpp`. Open the respective files to listen to them in those applications.
-Note that when your Server is recording, Clients will display a message that recording is on.
+**Note:** When your Server is recording, Clients display a red banner message that the session is being recorded.
##### `--norecord`
Set server not to record by default when recording is configured.
From 422d94888ab4ef0cf339d17a0db85d218be56ab7 Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Tue, 29 Nov 2022 21:44:44 +0000
Subject: [PATCH 23/63] Correct case
Co-authored-by: John Dempsey <1750243+mcfnord@users.noreply.github.com>
---
wiki/en/Running-a-Server.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index 6e153c0a9..1ff8c2e84 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -240,7 +240,7 @@ Set server not to record by default when recording is configured.
Recording starts once the first person connects to the Server, and stops when the last person leaves.
-If the Server receives a SIGUSR1 signal during a recording, it will start a new recording in a new Directory. SIGUSR2 will toggle recording on/off.
+If the Server receives a SIGUSR1 signal during a recording, it will start a new recording in a new directory. SIGUSR2 will toggle recording on/off.
To send these signals using systemd, create the following two `.service` files in `/etc/systemd/system`, calling them something appropriate (e.g. `jamulusTogglerec.service`).
From 0ccb5532c4e48240b63411b419b7ac86f79da247 Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Tue, 29 Nov 2022 21:45:55 +0000
Subject: [PATCH 24/63] Update for style
Co-authored-by: John Dempsey <1750243+mcfnord@users.noreply.github.com>
---
wiki/en/Running-a-Server.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index 1ff8c2e84..a6f220bf0 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -284,7 +284,7 @@ You can see the result of these commands if you run `systemctl status jamulus`,
Jamulus can be run in Server mode from the desktop. This gives you a graphical user interface to control most of the settings. To do this, first [install Jamulus](Getting-Started) for your platform, the do one of the following:
-* **Windows users** - Use the "Jamulus Server" icon in the Windows Start menu. If you want the Server to start automatically on system start, enable the corresponding check box.
+* **Windows users** - Use the "Jamulus Server" icon in the Windows Start menu. If you want the Server to start automatically when you start Windows, check the box for this option.
* **macOS users** - Double-click the "Jamulus Server" icon in Applications.
From b93516d8cd14d42fc9f055bdd800877a72e8698b Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Tue, 29 Nov 2022 21:46:20 +0000
Subject: [PATCH 25/63] Update for style
Co-authored-by: John Dempsey <1750243+mcfnord@users.noreply.github.com>
---
wiki/en/Running-a-Server.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index a6f220bf0..4972ff0cb 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -316,7 +316,7 @@ When a Server is running in GUI mode, the operating system will show an icon in
{% include_relative Include-Backing-Up.md %}
-- Headless Servers do not use `.ini` files. All configuration is given as command line options. If you are running a server in GUI mode, it will store its configuration (after reading any command line options on start) in the file `Jamululsserver.ini`
+- Headless Servers do not use `.ini` files. All configuration is given as command line options. If you are running a server in GUI mode, it will store its configuration (after reading any command line options on start) in the `Jamululsserver.ini` file.
## Troubleshooting
From 6edf222e47b3ce3aff1a16359670109a119e6d2f Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Tue, 29 Nov 2022 21:46:44 +0000
Subject: [PATCH 26/63] Update for style
Co-authored-by: John Dempsey <1750243+mcfnord@users.noreply.github.com>
---
wiki/en/Running-a-Server.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index 4972ff0cb..15d4ba1a0 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -256,7 +256,7 @@ For turning recording on or off (depending on the current state):
ExecStart=/bin/systemctl kill -s SIGUSR2 Jamulus-Server
~~~
-For starting a new recording:
+To start a new recording:
~~~
[Unit]
From 8dcbf7e8c3168f4280a9b3e7a0c76aeeb1610d39 Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Tue, 29 Nov 2022 21:47:19 +0000
Subject: [PATCH 27/63] Update for style
Co-authored-by: John Dempsey <1750243+mcfnord@users.noreply.github.com>
---
wiki/en/Running-a-Server.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index 15d4ba1a0..b458f8cc5 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -244,7 +244,7 @@ If the Server receives a SIGUSR1 signal during a recording, it will start a new
To send these signals using systemd, create the following two `.service` files in `/etc/systemd/system`, calling them something appropriate (e.g. `jamulusTogglerec.service`).
-For turning recording on or off (depending on the current state):
+To turn recording on or off (depending on the current state):
~~~
[Unit]
From cb2c25462273bafa0d072e5289701bc0729a0fa9 Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Tue, 29 Nov 2022 21:47:58 +0000
Subject: [PATCH 28/63] Update for style
Co-authored-by: John Dempsey <1750243+mcfnord@users.noreply.github.com>
---
wiki/en/Running-a-Server.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index b458f8cc5..9f7aba37f 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -226,7 +226,7 @@ Start the graphicial user interface minimized
##### `-R or --recording`
Set server recording directory. By default, the Server will record when a session is active.
-**Note:** You will need to save recordings to a path _outside_ of the jamulus home Directory, or remove `ProtectHome=true` from your systemd unit file (be aware that doing so is however a potential security risk).
+**Note:** You will need to save recordings to a path _outside_ of the jamulus home Directory, or remove `ProtectHome=true` from your systemd unit file (but be aware that doing could be a security risk).
Recordings are per track in [Audacity](https://www.audacityteam.org/) `.lof` format and [REAPER](https://en.wikipedia.org/wiki/REAPER) `.rpp`. Open the respective files to listen to them in those applications.
From 7bccd33533090c384ee8b998ebc258a68bc72dac Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Tue, 29 Nov 2022 21:49:26 +0000
Subject: [PATCH 29/63] Update for style
Co-authored-by: John Dempsey <1750243+mcfnord@users.noreply.github.com>
---
wiki/en/Running-a-Server.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index 9f7aba37f..4ad9b7ddd 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -159,7 +159,7 @@ This option takes the format:
See [two-letter ISO country codes](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
-Note that semicolon and newline characters are not allowed in `name` and `city` values.
+**Note:** Semicolon and newline characters are not allowed in `name` and `city` values.
##### `-L or --licence`
Show an agreement window before users can connect. The text of the agreement to be shown should be supplied as the `--welcomemessage` (see below).
From bdaa0499fe6edd5aa9ce11ec4f326e507c112c6e Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Tue, 29 Nov 2022 21:50:45 +0000
Subject: [PATCH 30/63] Update for style
Co-authored-by: John Dempsey <1750243+mcfnord@users.noreply.github.com>
---
wiki/en/Running-a-Server.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index 4ad9b7ddd..df338f48f 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -174,7 +174,7 @@ The public IP address of the Server if connecting to a Directory behind the same
_Directories only:_ Remember registered Servers even if the Directory is restarted. See [the Directories guide](Directories) for further information.
##### `-f or --listfilter`
-_Directories only:_ Whitelist Servers registering on the Server. See [the Directories guide](Directories) for further information.
+_Directories only:_ Allowlist Servers registering on the Server. See [the Directories guide](Directories) for further information.
---
From c9a511a2a144b18c3031c78ac4e74dee97e80393 Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Tue, 29 Nov 2022 22:05:04 +0000
Subject: [PATCH 31/63] Upates for style
Co-authored-by: John Dempsey <1750243+mcfnord@users.noreply.github.com>
---
wiki/en/Running-a-Server.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index df338f48f..fc77409e8 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -182,7 +182,7 @@ _Directories only:_ Allowlist Servers registering on the Server. See [the Direct
These options can be used regardless of which mode your server is running in (although some may not be relevant for Directories).
##### `-d or --discononquit`
-Normally, when a Server is stopped or restarted, any Clients that have not used their “Disconnect” buttons will re-establish connection when the Server comes back up again. Using this option forces Clients to manually re-establish their connections to the Server.
+Normally, when a Server is stopped or restarted, any Clients that have not pressed their **Disconnect** buttons will automatically re-establish the connection when the Server returns. This option forces Clients to manually re-establish their connections to the Server in this scenario.
##### `-F or --fastupdate`
Reduces latency if Clients connect with “Enable Small Network Buffers” option. Requires faster CPU to avoid dropouts, and more bandwidth to enabled Clients.
From 428ea10467bb794de7c53634a3aa6118cc1701ea Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Tue, 29 Nov 2022 22:05:53 +0000
Subject: [PATCH 32/63] Minor amends
Co-authored-by: John Dempsey <1750243+mcfnord@users.noreply.github.com>
---
wiki/en/Unregistered-Servers.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/wiki/en/Unregistered-Servers.md b/wiki/en/Unregistered-Servers.md
index 6c9a7d1b6..46c112898 100644
--- a/wiki/en/Unregistered-Servers.md
+++ b/wiki/en/Unregistered-Servers.md
@@ -31,4 +31,4 @@ You should connect yourself using the local network address of the computer the
### Dynamic DNS and why you will probably need it
-Unless your ISP provides you with a fixed IP address, you may find that your address changes over time. To avoid problems with this, you might want to set up "dynamic DNS" to get a static address you can share with others. A "dynamic DNS" provider can supply you with a static IP address that you can share but you need to keep refreshing your dynamic IP with the provider. Your router might support certain providers to do this. If this is not the case, the provider will have instructions on how to set up a dynamic DNS client.
+Unless your ISP provides you with a fixed IP address, you may find that your address changes over time. You might want to set up "dynamic DNS" to get a static address you can share with others. A "dynamic DNS" provider can supply you with a static IP address that you can share, but you need to keep refreshing your dynamic IP with the provider. Your router might support certain providers to do this. If this is not the case, the provider will have instructions on how to set up a dynamic DNS client.
From e5e174445e0d22bf55457ccea9afce1d416f1a05 Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Tue, 29 Nov 2022 22:06:22 +0000
Subject: [PATCH 33/63] Minor amends
Co-authored-by: John Dempsey <1750243+mcfnord@users.noreply.github.com>
---
wiki/en/Unregistered-Servers.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/wiki/en/Unregistered-Servers.md b/wiki/en/Unregistered-Servers.md
index 46c112898..1c7816d58 100644
--- a/wiki/en/Unregistered-Servers.md
+++ b/wiki/en/Unregistered-Servers.md
@@ -25,7 +25,7 @@ Normally, people from outside your home network cannot see things inside it. To
### Getting the external IP
-To allow others to connect to your Server from the internet, give them your public internet IP address. You can learn your current address [using Google](https://www.google.com/search?q=what+is+my+ip).
+To allow others to connect to your Server from the internet, give them your public internet IP address. You can [learn your current address using Google](https://www.google.com/search?q=what+is+my+ip).
You should connect yourself using the local network address of the computer the Server is running on. If you are running a Client on the same computer as your Server, the address is `localhost` or `127.0.0.1`.
From 21b66e4d5d3c39ea028582660f57eecd6796393d Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Tue, 29 Nov 2022 22:06:48 +0000
Subject: [PATCH 34/63] "public" not "external"
Co-authored-by: John Dempsey <1750243+mcfnord@users.noreply.github.com>
---
wiki/en/Unregistered-Servers.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/wiki/en/Unregistered-Servers.md b/wiki/en/Unregistered-Servers.md
index 1c7816d58..ee1d1b7f8 100644
--- a/wiki/en/Unregistered-Servers.md
+++ b/wiki/en/Unregistered-Servers.md
@@ -23,7 +23,7 @@ Normally, people from outside your home network cannot see things inside it. To
**Note:** Your home router might change the IP address of the computer you're running your Server on. Depending on your router, you might need to give this computer a static IP address (often under DHCP settings of your router).
-### Getting the external IP
+### Getting the public IP
To allow others to connect to your Server from the internet, give them your public internet IP address. You can [learn your current address using Google](https://www.google.com/search?q=what+is+my+ip).
You should connect yourself using the local network address of the computer the Server is running on. If you are running a Client on the same computer as your Server, the address is `localhost` or `127.0.0.1`.
From a17bd1dd4cdd8cf6209ec1bfce6bcae5d324c97b Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Tue, 29 Nov 2022 22:07:55 +0000
Subject: [PATCH 35/63] Update for style
Co-authored-by: John Dempsey <1750243+mcfnord@users.noreply.github.com>
---
wiki/en/Running-a-Server.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index fc77409e8..2607eb90e 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -185,7 +185,7 @@ These options can be used regardless of which mode your server is running in (al
Normally, when a Server is stopped or restarted, any Clients that have not pressed their **Disconnect** buttons will automatically re-establish the connection when the Server returns. This option forces Clients to manually re-establish their connections to the Server in this scenario.
##### `-F or --fastupdate`
-Reduces latency if Clients connect with “Enable Small Network Buffers” option. Requires faster CPU to avoid dropouts, and more bandwidth to enabled Clients.
+Reduces latency if Clients connect with **Enable Small Network Buffers** option. Requires faster CPU to avoid dropouts, and more bandwidth to enabled Clients.
##### `-l or --log`
Enable logging, set path and file name
From a27df7949eda1b0c0c45975e23faa8413a8e00f0 Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Tue, 29 Nov 2022 22:08:35 +0000
Subject: [PATCH 36/63] Minor amends
Co-authored-by: John Dempsey <1750243+mcfnord@users.noreply.github.com>
---
wiki/en/Running-a-Server.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index 2607eb90e..83ba1f8d1 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -196,7 +196,7 @@ Enable HTML status file, set path and file name
**Note:** This feature is deprecated, and may disappear in a future release.
##### `-P or --delaypan`
-Start with delay panning enabled.This option uses small differences in sound arrival time between the two ears. It produces a stereo effect similar to natural human hearing when compared to normal “volume” panning.
+Start with delay panning enabled. This option uses small differences in sound arrival time between the two ears. It produces a stereo effect similar to natural human hearing when compared to normal “volume” panning.
##### `-s` or `--server`
Start Jamulus in Server mode
From 940063af26f8ac512f1581c30535ec5dbcd56c27 Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Tue, 29 Nov 2022 23:03:51 +0000
Subject: [PATCH 37/63] Remove redundant ref. to access control
Co-authored-by: John Dempsey <1750243+mcfnord@users.noreply.github.com>
---
wiki/en/Running-a-Server.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index 83ba1f8d1..6d59c253a 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -84,7 +84,7 @@ Servers can be run in one of three modes (either at home or on a 3rd party host)
### 1. Unregistered
-This is the default when starting a Server for the first time. Unregistered Servers are not listed by Directories, so only musicians who know your Server's address to will be able to connect to it. This is useful because Jamulus does not let you control who can connect to a Server.
+This is the default when starting a Server for the first time. Unregistered Servers are not listed by Directories, so only musicians who know your Server's address can connect to it.
**For information about running an Unregistered Server [see this guide](Unregistered-Servers).**
From 4632eb076f0e62bc75ebf0c13737833379b0f4c7 Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Fri, 2 Dec 2022 21:42:22 +0000
Subject: [PATCH 38/63] Remove ref. to Explorer
---
wiki/en/Running-a-Server.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index 6d59c253a..1f59d6337 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -98,7 +98,7 @@ In this mode your Server will be included in the server list supplied by a Direc
You can also have your Server listed by a Custom Directory (see below), if that better meets your requirements. Clients can then only see your Server if they also know the Custom Directory.
-Note that Directories can only register up to 150 Servers. If you see a message that says you cannot register your Server becuase the Directory is full, you can try registering on another. For a list of all public Directories and the Servers on them, see [explorer.jamulus.io](https://explorer.jamulus.io).
+Note that Directories can only register up to 150 Servers. If you see a message that says you cannot register your Server becuase the Directory is full, you can try registering on another.
From ff1ee668faba53bcd6b593e9f7e3be93ccfb5b67 Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Fri, 2 Dec 2022 21:45:39 +0000
Subject: [PATCH 39/63] Explain IP binding
---
wiki/en/Running-a-Server.md | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index 1f59d6337..c9149bc7c 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -202,7 +202,9 @@ Start with delay panning enabled. This option uses small differences in sound ar
Start Jamulus in Server mode
##### `--serverbindip`
-Specify the IP address the Jamulus process will bind to
+Specify the IP address the Jamulus process will bind to.
+
+Normally, Jamulus will listen on all IP addresses on the host machine. Where the host has multiple network addresses, this option allows one of the addresses to be chosen.
##### `-T or --multithreading`
Use multithreading to make better use of multi-core CPUs to support more Clients
From 4f8fc0883686bc179380f68ca8eedaf9afea6515 Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Sat, 3 Dec 2022 07:18:06 +0000
Subject: [PATCH 40/63] Port forwarding changes for style
Co-authored-by: John Dempsey <1750243+mcfnord@users.noreply.github.com>
---
wiki/en/Running-a-Server.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index c9149bc7c..4099a3510 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -41,7 +41,7 @@ Consider using a cloud host, not your home internet connection, to get better pi
* Any Server should have at least 1.6GHz CPU frequency and 1GB RAM
* Running a Server may require you to adjust any firewalls running on or outside of your machine or cloud host.
-* Running an [Unregistered Server](Unregistered-Servers) at home will require you to port forward on your router. This should not be necessary when running a Registered Server, in most cases, but it's advisable to do so because some networks may not work properly with Jamulus in its default mode.
+* You must set up port forwarding on your router to run an [Unregistered Server](Unregistered-Servers) at home. This should not be necessary when running a Registered Server in most cases. However, some home networks can require port forwarding for a Registered Server.
* Jamulus only has limited IPv6 support which needs to be enabled with a command line argument on the Client and Server. (There are plans to expand IPv6 support.)
---
From ce52e002f55670ee8fda9ac83dfb525bf0097c93 Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Sat, 3 Dec 2022 07:19:10 +0000
Subject: [PATCH 41/63] ipv6 wording style
Co-authored-by: John Dempsey <1750243+mcfnord@users.noreply.github.com>
---
wiki/en/Running-a-Server.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index 4099a3510..70cec3474 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -42,7 +42,7 @@ Consider using a cloud host, not your home internet connection, to get better pi
* Any Server should have at least 1.6GHz CPU frequency and 1GB RAM
* Running a Server may require you to adjust any firewalls running on or outside of your machine or cloud host.
* You must set up port forwarding on your router to run an [Unregistered Server](Unregistered-Servers) at home. This should not be necessary when running a Registered Server in most cases. However, some home networks can require port forwarding for a Registered Server.
-* Jamulus only has limited IPv6 support which needs to be enabled with a command line argument on the Client and Server. (There are plans to expand IPv6 support.)
+* Jamulus offers limited IPv6 support that you can turn on for a Client or Server from the command line.
---
From 6d5c6357b1fc1070f8ebe97d3a212253ffe7a437 Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Sat, 3 Dec 2022 07:19:58 +0000
Subject: [PATCH 42/63] Remove server type number
Co-authored-by: John Dempsey <1750243+mcfnord@users.noreply.github.com>
---
wiki/en/Running-a-Server.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index 70cec3474..e57c914c3 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -82,7 +82,7 @@ _To amend your Server configuration, just repeat the last two steps above._
Servers can be run in one of three modes (either at home or on a 3rd party host), depending on your needs.
-### 1. Unregistered
+### Unregistered
This is the default when starting a Server for the first time. Unregistered Servers are not listed by Directories, so only musicians who know your Server's address can connect to it.
From ac82b2eb9f4658ac1492c8d14953319fe86fe8b6 Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Sat, 3 Dec 2022 07:20:35 +0000
Subject: [PATCH 43/63] Remove server type number
Co-authored-by: John Dempsey <1750243+mcfnord@users.noreply.github.com>
---
wiki/en/Running-a-Server.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index e57c914c3..95a76c03d 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -92,7 +92,7 @@ This is the default when starting a Server for the first time. Unregistered Serv
-### 2. Registered
+### Registered
In this mode your Server will be included in the server list supplied by a Directory. Jamulus has a list of built-in Directories that Clients can know, and if you register your Server with one of these, anyone can then discover and connect to it.
From 5dfe90d8b06386669cf21b204d3703f9c60d413a Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Sat, 3 Dec 2022 07:21:00 +0000
Subject: [PATCH 44/63] Remove server type number
Co-authored-by: John Dempsey <1750243+mcfnord@users.noreply.github.com>
---
wiki/en/Running-a-Server.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index 95a76c03d..f785c9c02 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -104,7 +104,7 @@ Note that Directories can only register up to 150 Servers. If you see a message
-### 3. Directory
+### Directory
If you want to run a number of Servers, possibly also behind a firewall or on a LAN, you may want to run your Server as a Directory. Examples include online events, music associations, sectional rehearsals or music lessons for schools.
From d92bdec7cea1070c8b3a097efaea59313fc034cd Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Sat, 3 Dec 2022 07:45:58 +0000
Subject: [PATCH 45/63] Remove duplicated info
---
wiki/en/Unregistered-Servers.md | 2 --
1 file changed, 2 deletions(-)
diff --git a/wiki/en/Unregistered-Servers.md b/wiki/en/Unregistered-Servers.md
index ee1d1b7f8..a6b65f586 100644
--- a/wiki/en/Unregistered-Servers.md
+++ b/wiki/en/Unregistered-Servers.md
@@ -21,8 +21,6 @@ Normally, people from outside your home network cannot see things inside it. To
**Note:** The default port for Jamulus is **UDP** (not TCP) port **22124**. You will usually forward the port **22124** from outside your network to the port **22124** of the computer running the Server.
-**Note:** Your home router might change the IP address of the computer you're running your Server on. Depending on your router, you might need to give this computer a static IP address (often under DHCP settings of your router).
-
### Getting the public IP
To allow others to connect to your Server from the internet, give them your public internet IP address. You can [learn your current address using Google](https://www.google.com/search?q=what+is+my+ip).
From c238bf83b54c2cebe5832794218346d28ed818e9 Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Sat, 3 Dec 2022 07:47:54 +0000
Subject: [PATCH 46/63] Ini files update for style
Co-authored-by: John Dempsey <1750243+mcfnord@users.noreply.github.com>
---
wiki/en/Running-a-Server.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index f785c9c02..085cf15b1 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -318,7 +318,7 @@ When a Server is running in GUI mode, the operating system will show an icon in
{% include_relative Include-Backing-Up.md %}
-- Headless Servers do not use `.ini` files. All configuration is given as command line options. If you are running a server in GUI mode, it will store its configuration (after reading any command line options on start) in the `Jamululsserver.ini` file.
+- Headless Servers do not use `.ini` files. All configuration is given as command line options. If you are running a server in GUI mode, after reading any command line options on start, it will store its configuration in the `Jamululsserver.ini` file.
## Troubleshooting
From a496ddb471e2853314331d9eb9446fb91729ad32 Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Sat, 3 Dec 2022 07:52:03 +0000
Subject: [PATCH 47/63] GUI mode update for style
Co-authored-by: John Dempsey <1750243+mcfnord@users.noreply.github.com>
---
wiki/en/Running-a-Server.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index 085cf15b1..e1858a136 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -302,7 +302,7 @@ For macOS, start a Terminal window and run Jamulus with the desired options like
`/Applications/Jamulus.app/Contents/MacOS/Jamulus --serverbindip 192.168.0.100`
-**Note** Command line options will set the Server’s defaults at startup. You can override them with their corresponding GUI controls while the Server is running.
+**Note** Command line options will set the Server’s defaults at startup. You can override them while the Server is running using their corresponding GUI controls.
### The Server status icon
From 3fdf56c48b8d79d9a3756e8bc587e1d1c2b01d7c Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Sat, 3 Dec 2022 07:59:58 +0000
Subject: [PATCH 48/63] Change "type" to "mode"
---
wiki/en/Running-a-Server.md | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index e1858a136..ad3c5bcc0 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -78,11 +78,11 @@ _To amend your Server configuration, just repeat the last two steps above._
---
-## Server Types
+## Server Modes
Servers can be run in one of three modes (either at home or on a 3rd party host), depending on your needs.
-### Unregistered
+### Unregistered mode
This is the default when starting a Server for the first time. Unregistered Servers are not listed by Directories, so only musicians who know your Server's address can connect to it.
@@ -92,7 +92,7 @@ This is the default when starting a Server for the first time. Unregistered Serv
-### Registered
+### Registered mode
In this mode your Server will be included in the server list supplied by a Directory. Jamulus has a list of built-in Directories that Clients can know, and if you register your Server with one of these, anyone can then discover and connect to it.
@@ -104,7 +104,7 @@ Note that Directories can only register up to 150 Servers. If you see a message
-### Directory
+### Directory mode
If you want to run a number of Servers, possibly also behind a firewall or on a LAN, you may want to run your Server as a Directory. Examples include online events, music associations, sectional rehearsals or music lessons for schools.
@@ -116,11 +116,11 @@ For information, [see the Directories guide](Directories).
Depending on your operating system and how you are running the server, you can set Server options and make them persistent between reloads as follows:
-**Linux headless mode** (Debian/Ubuntu using systemd)
+**For Linux headless** (Debian/Ubuntu using systemd)
Add your desired command line options to the `ExecStart` line in the systemd service file by running `sudo systemctl edit --full jamulus-headless`
-**GUI mode** (all platforms)
+**For the GUI** (all platforms)
Any settings made using the graphical interface will be stored in the `Jamulusserver.ini` file (do not attempt to edit this file by hand). However, some options are not available via the GUI and need to be set via the command line. For more information, see [Servers on the desktop](#servers-on-the-desktop)
From c4235bc1abdf4e5174dcbc5795cd70b8e46563c0 Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Sat, 3 Dec 2022 08:01:24 +0000
Subject: [PATCH 49/63] Server icon description
Co-authored-by: John Dempsey <1750243+mcfnord@users.noreply.github.com>
---
wiki/en/Running-a-Server.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index ad3c5bcc0..9752a80f8 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -306,7 +306,7 @@ For macOS, start a Terminal window and run Jamulus with the desired options like
### The Server status icon
-When a Server is running in GUI mode, the operating system will show an icon in the system tray or status area that indicates whether the Server is active:
+When a Server is running in GUI mode, the operating system will show an icon in the system tray or status area that indicates whether the Server has connections:
The Server is empty
From 91d76646e713c4665c4ae865157bc5e09e8d7a7f Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Sat, 3 Dec 2022 08:04:41 +0000
Subject: [PATCH 50/63] Multithreading update for style
Co-authored-by: John Dempsey <1750243+mcfnord@users.noreply.github.com>
---
wiki/en/Running-a-Server.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index 9752a80f8..50a814924 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -207,7 +207,7 @@ Specify the IP address the Jamulus process will bind to.
Normally, Jamulus will listen on all IP addresses on the host machine. Where the host has multiple network addresses, this option allows one of the addresses to be chosen.
##### `-T or --multithreading`
-Use multithreading to make better use of multi-core CPUs to support more Clients
+Use multithreading to make better use of multi-core CPUs. This setting can support more Clients.
##### `-u or --numchannels`
Maximum number of channels (Clients)
From 5531ccbaad67bf81bf7c6f35aea6dd60795d5419 Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Sat, 3 Dec 2022 08:09:05 +0000
Subject: [PATCH 51/63] Start minimized wording
Co-authored-by: John Dempsey <1750243+mcfnord@users.noreply.github.com>
---
wiki/en/Running-a-Server.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index 50a814924..29300788d 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -213,7 +213,7 @@ Use multithreading to make better use of multi-core CPUs. This setting can suppo
Maximum number of channels (Clients)
##### `-z or --startminimized`
-Start the graphicial user interface minimized
+Start the Jamulus Server graphical user interface in the minimized window state.
---
From d1aba2f43d1f709ab62a3ac598e4e9dfca903e60 Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Sat, 3 Dec 2022 08:17:34 +0000
Subject: [PATCH 52/63] Add note on restarting
---
wiki/en/Running-a-Server.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index 29300788d..47907c329 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -118,7 +118,7 @@ Depending on your operating system and how you are running the server, you can s
**For Linux headless** (Debian/Ubuntu using systemd)
-Add your desired command line options to the `ExecStart` line in the systemd service file by running `sudo systemctl edit --full jamulus-headless`
+Add your desired command line options to the `ExecStart` line in the systemd service file by running `sudo systemctl edit --full jamulus-headless` (You will need to reload the restart for the changes to take effect. See [Installation](#installation))
**For the GUI** (all platforms)
From a1a4ff664f7567fc5cf346b58554d96421281341 Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Sat, 3 Dec 2022 19:47:20 +0000
Subject: [PATCH 53/63] Correct heading level for Other options
---
wiki/en/Running-a-Server.md | 4 +---
1 file changed, 1 insertion(+), 3 deletions(-)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index 47907c329..edfaa4f41 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -215,9 +215,7 @@ Maximum number of channels (Clients)
##### `-z or --startminimized`
Start the Jamulus Server graphical user interface in the minimized window state.
----
-
-## Other options
+### Other options
{% include_relative Include-Shared-Commands.md %}
From 1ca7947fa37226abf0a8e1e231e308272e6edcac Mon Sep 17 00:00:00 2001
From: ann0see <20726856+ann0see@users.noreply.github.com>
Date: Wed, 7 Dec 2022 22:07:52 +0100
Subject: [PATCH 54/63] Fix invalid CSS
Fixes: https://github.com/jamulussoftware/jamuluswebsite/issues/839
---
assets/css/fw.css | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/assets/css/fw.css b/assets/css/fw.css
index 6776fc0be..1ad3a9d17 100644
--- a/assets/css/fw.css
+++ b/assets/css/fw.css
@@ -306,7 +306,7 @@ main>div {
details {
font: 16px;
- font-style: bold;
+ font-weight: bold;
width: 620px;
}
From 622f07cc08c67b7c841da2adc6d0f6da9a5f2681 Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Wed, 21 Dec 2022 23:04:35 +0000
Subject: [PATCH 55/63] Add explanation to -T
---
wiki/en/Running-a-Server.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index edfaa4f41..855a3fd02 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -207,7 +207,7 @@ Specify the IP address the Jamulus process will bind to.
Normally, Jamulus will listen on all IP addresses on the host machine. Where the host has multiple network addresses, this option allows one of the addresses to be chosen.
##### `-T or --multithreading`
-Use multithreading to make better use of multi-core CPUs. This setting can support more Clients.
+Use multithreading to make better use of multi-core CPUs. This setting may help the Server support more Clients. See also `--numchannels`
##### `-u or --numchannels`
Maximum number of channels (Clients)
From e10548c938af391120f35c2cc0dec1ac2d0441d9 Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Wed, 21 Dec 2022 23:08:06 +0000
Subject: [PATCH 56/63] Update Registered server desc.
Co-authored-by: John Dempsey <1750243+mcfnord@users.noreply.github.com>
---
wiki/en/Running-a-Server.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index 855a3fd02..667ad1798 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -94,7 +94,7 @@ This is the default when starting a Server for the first time. Unregistered Serv
### Registered mode
-In this mode your Server will be included in the server list supplied by a Directory. Jamulus has a list of built-in Directories that Clients can know, and if you register your Server with one of these, anyone can then discover and connect to it.
+In this mode your Server will appear in the server list supplied by a Directory. Jamulus Clients come with a list of Directories built-in. If you register your Server with one of these, anyone can discover and connect to it.
You can also have your Server listed by a Custom Directory (see below), if that better meets your requirements. Clients can then only see your Server if they also know the Custom Directory.
From 2936a59b37fe4693ac5de63bd4ab70c819055ddf Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Wed, 21 Dec 2022 23:08:50 +0000
Subject: [PATCH 57/63] Update Custom Dir desc.
Co-authored-by: John Dempsey <1750243+mcfnord@users.noreply.github.com>
---
wiki/en/Running-a-Server.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index 667ad1798..85ee619e3 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -96,7 +96,7 @@ This is the default when starting a Server for the first time. Unregistered Serv
In this mode your Server will appear in the server list supplied by a Directory. Jamulus Clients come with a list of Directories built-in. If you register your Server with one of these, anyone can discover and connect to it.
-You can also have your Server listed by a Custom Directory (see below), if that better meets your requirements. Clients can then only see your Server if they also know the Custom Directory.
+Alternatively, you can list your Server on a Custom Directory (see below). Clients will only find your Server if they enter the Custom Directory's internet address.
Note that Directories can only register up to 150 Servers. If you see a message that says you cannot register your Server becuase the Directory is full, you can try registering on another.
From 794feef42a313513fca35ea5be777f18eba73b2f Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Thu, 22 Dec 2022 19:39:16 +0000
Subject: [PATCH 58/63] Update for style
Co-authored-by: John Dempsey <1750243+mcfnord@users.noreply.github.com>
---
wiki/en/Running-a-Server.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index 85ee619e3..9984807e4 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -98,7 +98,7 @@ In this mode your Server will appear in the server list supplied by a Directory.
Alternatively, you can list your Server on a Custom Directory (see below). Clients will only find your Server if they enter the Custom Directory's internet address.
-Note that Directories can only register up to 150 Servers. If you see a message that says you cannot register your Server becuase the Directory is full, you can try registering on another.
+Note that Directories can only register up to 150 Servers. If you see a message that says you cannot register your Server because the Directory is full, you can try registering on a different Directory.
From 95a9f7e54760d5a0464ee01985bf0169ba969409 Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Mon, 2 Jan 2023 10:36:59 +0000
Subject: [PATCH 59/63] Clarify GUI for home computer
Co-authored-by: John Dempsey <1750243+mcfnord@users.noreply.github.com>
---
wiki/en/Running-a-Server.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index 9984807e4..f9838551f 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -282,7 +282,7 @@ You can see the result of these commands if you run `systemctl status jamulus`,
## Servers on the desktop
-Jamulus can be run in Server mode from the desktop. This gives you a graphical user interface to control most of the settings. To do this, first [install Jamulus](Getting-Started) for your platform, the do one of the following:
+Jamulus can run in Server mode in the graphical environment of your home computer. This gives you a graphical user interface to control most of the settings. To do this, first [install Jamulus](Getting-Started) for your platform, the do one of the following:
* **Windows users** - Use the "Jamulus Server" icon in the Windows Start menu. If you want the Server to start automatically when you start Windows, check the box for this option.
From 269caa9f286177dbeb049482db142e8e1ceb5272 Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Mon, 2 Jan 2023 10:38:01 +0000
Subject: [PATCH 60/63] Correct capitalization
Co-authored-by: John Dempsey <1750243+mcfnord@users.noreply.github.com>
---
wiki/en/Running-a-Server.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index f9838551f..3427e7fb6 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -226,7 +226,7 @@ Start the Jamulus Server graphical user interface in the minimized window state.
##### `-R or --recording`
Set server recording directory. By default, the Server will record when a session is active.
-**Note:** You will need to save recordings to a path _outside_ of the jamulus home Directory, or remove `ProtectHome=true` from your systemd unit file (but be aware that doing could be a security risk).
+**Note:** You will need to save recordings to a path _outside_ of the jamulus home directory, or remove `ProtectHome=true` from your systemd unit file, but be aware that doing could be a security risk.
Recordings are per track in [Audacity](https://www.audacityteam.org/) `.lof` format and [REAPER](https://en.wikipedia.org/wiki/REAPER) `.rpp`. Open the respective files to listen to them in those applications.
From f1073fc37ad23fada6a75fc8bcbec78c7fe41004 Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Mon, 2 Jan 2023 10:41:33 +0000
Subject: [PATCH 61/63] Minor updates for style
Co-authored-by: John Dempsey <1750243+mcfnord@users.noreply.github.com>
---
wiki/en/Running-a-Server.md | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index 3427e7fb6..13e4bee1f 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -19,9 +19,9 @@ permalink: "/wiki/Running-a-Server"
## Do I need to run a Server?
-**No**. You can use the Servers listed by the built in Directories and use Jamulus without running a Server yourself. Or you can use a third party hosting service such as [melomax](https://melomax.live/jamulus-hosting/) or [KOORD](https://koord.live/).
+**No**. You don't need to run a Server. You can use the Servers listed by the built-in Directories and use Jamulus without running a Server yourself. You can also use an unlisted server if you know its internet address. Or you can use a third party hosting service such as [melomax](https://melomax.live/jamulus-hosting/) or [KOORD](https://koord.live/). There's probably a Server nearby that you and your friends can use at low enough latency for most needs.
-If you just want an undisturbed session, use the soloing technique described on the [Tips and Tricks page](Tips-Tricks-More#have-an-undisturbed-session-on-any-server).
+Using a public server might introduce you to strangers. If you want an undisturbed session, you can use the soloing technique described on the [Tips and Tricks page](Tips-Tricks-More#have-an-undisturbed-session-on-any-server). You won't hear strangers who connect to the Server, but they can hear you if they wish.
---
@@ -114,15 +114,15 @@ For information, [see the Directories guide](Directories).
## Configuration options
-Depending on your operating system and how you are running the server, you can set Server options and make them persistent between reloads as follows:
+Depending on your operating system and how you are running the server, you can set Server options and make them persistent between reloads by following these steps:
**For Linux headless** (Debian/Ubuntu using systemd)
-Add your desired command line options to the `ExecStart` line in the systemd service file by running `sudo systemctl edit --full jamulus-headless` (You will need to reload the restart for the changes to take effect. See [Installation](#installation))
+Add your desired command line options to the `ExecStart` line in the systemd service file by running `sudo systemctl edit --full jamulus-headless` (You will need to reload or restart for the changes to take effect. See [Installation](#installation))
**For the GUI** (all platforms)
-Any settings made using the graphical interface will be stored in the `Jamulusserver.ini` file (do not attempt to edit this file by hand). However, some options are not available via the GUI and need to be set via the command line. For more information, see [Servers on the desktop](#servers-on-the-desktop)
+Any settings made using the graphical interface will be stored in the `Jamulusserver.ini` file. (Do **not** edit this file by hand!) However, some options are not available in the GUI and need to be set using the command line. For more information, see [Servers on the desktop](#servers-on-the-desktop)
---
From 376ef4e494a672058be67896823ccd4627756d0c Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Mon, 2 Jan 2023 10:47:41 +0000
Subject: [PATCH 62/63] Register with, not on.
Co-authored-by: Peter L Jones
---
wiki/en/Running-a-Server.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index 13e4bee1f..153166551 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -98,7 +98,7 @@ In this mode your Server will appear in the server list supplied by a Directory.
Alternatively, you can list your Server on a Custom Directory (see below). Clients will only find your Server if they enter the Custom Directory's internet address.
-Note that Directories can only register up to 150 Servers. If you see a message that says you cannot register your Server because the Directory is full, you can try registering on a different Directory.
+Note that Directories can only register up to 150 Servers. If you see a message that says you cannot register your Server because the Directory is full, you can try registering with a different Directory.
From 06d79af17b448645d7ef8cfd93998d8acc4c2b52 Mon Sep 17 00:00:00 2001
From: Jonathan <4561747+gilgongo@users.noreply.github.com>
Date: Mon, 2 Jan 2023 19:08:10 +0000
Subject: [PATCH 63/63] Clarify GUI environment
Co-authored-by: Peter L Jones
---
wiki/en/Running-a-Server.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md
index 153166551..20ad5ef10 100644
--- a/wiki/en/Running-a-Server.md
+++ b/wiki/en/Running-a-Server.md
@@ -282,7 +282,7 @@ You can see the result of these commands if you run `systemctl status jamulus`,
## Servers on the desktop
-Jamulus can run in Server mode in the graphical environment of your home computer. This gives you a graphical user interface to control most of the settings. To do this, first [install Jamulus](Getting-Started) for your platform, the do one of the following:
+Jamulus can run in Server mode in the graphical environment of a computer. This gives you a graphical user interface to control most of the settings. To do this, first [install Jamulus](Getting-Started) for your platform, the do one of the following:
* **Windows users** - Use the "Jamulus Server" icon in the Windows Start menu. If you want the Server to start automatically when you start Windows, check the box for this option.