Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Repair corrections of various terms #792

Merged
merged 15 commits into from
Aug 14, 2022
2 changes: 1 addition & 1 deletion wiki/en-no-translate/Directory-Servers.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
layout: redirect
redirect: "/wiki/Running-a-Server"
redirect: "/wiki/Directories"
lang: "en"
permalink: "/wiki/Directory-Servers"
category: "hidden"
Expand Down
8 changes: 4 additions & 4 deletions wiki/en/Custom-Directories.md → wiki/en/Directories.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
---
layout: wiki
title: "Custom Directories"
title: "Directories"
gilgongo marked this conversation as resolved.
Show resolved Hide resolved
lang: "en"
permalink: "/wiki/Custom-Directories"
permalink: "/wiki/Directories"
---

{% include breadcrumb.html root="More" branch1="Server Administration" branch1-url="Running-a-Server" %}


# Running a Custom Directory
# Running a Directory

This is a specialised Jamulus Server configuration, as described in [Server Types](Running-a-Server#server-types).

To view Servers listed by a Custom Directory, users must enter the address of that Directory in their Client's Settings > Advanced Setup > Custom Directories field. Multiple addresses can be added in this way if needed. Custom Directories will then appear in the Directory drop-down list on their Connect window. Custom Directories otherwise work for Clients in the same way as Public Directories, displaying a list of Servers registered with them.

To run a Server as a Directory, it should be started with the `--directoryserver` option to make itself (that is, `localhost` or `127.0.0.1`) the Directory to query for Servers.

When running a Server with the GUI, set the Custom Directory server address in the Options tab to "localhost", then select "Custom" from the Directory drop-down list.
When running a Server with the GUI, set the Custom Directory server address in the Options tab to "localhost", then select "Custom" from the Directory drop-down list.


### Points to note about Directories
Expand Down
2 changes: 1 addition & 1 deletion wiki/en/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Bear in mind also that all participants should follow [The Golden Rule](/wiki/Cl

### How do I know if I can join a Server? Are there rules?

In general, if somebody lists a Server on one of the Public Directories provided by Jamulus by default, they accept that anyone can play on it. Jamulus has no password protection or other authentication mechanisms built in. However, some Servers may state their policies in the welcome message you will see in the chat window.
If somebody lists a Server on one of the Directories built into Jamulus, they accept that anyone can play on it. Jamulus has no password protection or other authentication mechanisms. Whilst some Servers may state their policies in the welcome message you will see in the chat window, Jamulus itself does nothing to enforce these.

Note also that Servers do not have to be registered on a Directory in order for Jamulus Clients to connect to them. Server operators can simply give out the address of their Servers to those they want to play with, and they can then connect directly. Have a look at [this overview for more information](/wiki/Running-a-Server#server-types).

Expand Down
4 changes: 2 additions & 2 deletions wiki/en/Include-Server-Commands.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
- `-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](#server-types) for further information.
- `--directoryfile` Remember registered Servers even if the Directory is restarted. Directory Servers only. See [this guide](Custom-Directories) 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
Expand All @@ -16,4 +16,4 @@
- `-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](Custom-Directories#points-to-note-about-directories)
- `--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)
12 changes: 6 additions & 6 deletions wiki/en/Running-a-Server.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ If you are running an unregistered server behind a home internet connection, you

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.

To run a Directory [read this guide](Custom-Directories)
To run a Directory [read this guide](Directories)


## Installation and Configuration
Expand Down Expand Up @@ -129,7 +129,7 @@ You can also specify a [Directory](#3-directory) in the same way from the comman

#### Running as a Directory

If you wish to run a [Directory](Running-a-Server#3-directory) please see [this guide](Custom-Directories).
If you wish to run a [Directory](Running-a-Server#3-directory) please see [this guide](Directories).

### Maintenance

Expand Down Expand Up @@ -201,15 +201,15 @@ Jamulus can be run in Server mode from the desktop. This gives you a graphical u

**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.

**Genre**: To allow other people to see your Server on one of the built-in Public Directories, 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.
**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.
jujudusud marked this conversation as resolved.
Show resolved Hide resolved

**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](Custom-Directories) for further details.
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.
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

Expand Down Expand Up @@ -274,7 +274,7 @@ For macOS, start a Terminal window and run Jamulus with the desired options like

## Running an Unregistered Server

It is highly recommended to test your Server on a **Public Directory** first so as to narrow down any subsequent problems in unregistered mode.
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

Expand Down
6 changes: 3 additions & 3 deletions wiki/en/Software-Manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -240,9 +240,9 @@ rate is not higher than your available internet upload speed (check this with a

<figure><img src="{% include img/en-screenshots/settings-advanced.inc %}" style="border: 5px solid grey;" loading="lazy" alt="Image of advanced settings window"></figure>

### Custom directory server address
### Custom Directories

Leave this blank unless you need to enter the address of a directory server other than the default.
If you need to add Directory addresses other than the built-in ones, you can do so here.

### New Client Level

Expand Down Expand Up @@ -272,7 +272,7 @@ You can save and restore the mix you have for your band rehearsals (fader, mute,

### Edit > Auto-Adjust All Faders

Applies a one-off fader setting to each channel depending on its volume. Useful for large ensembles to get a reasonable overall mix, although individual adjustments might still be necessary. Best applied during a warm-up or a uniform part of the music piece.
Applies a one-off fader setting to each channel depending on its volume. Useful for large ensembles to get a reasonable overall mix, although individual adjustments might still be necessary. Best applied during a warm-up or a uniform part of the music piece.

# Backing up Jamulus

Expand Down
10 changes: 6 additions & 4 deletions wiki/en/Tips-Tricks-More.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,11 @@ Jamulus user [Chris Rimple](https://sourceforge.net/u/chrisrimple/profile/) has

## Using the Jamulus Client

### Have a undisturbed session on any Server
### Have an undisturbed session on any Server

You can have a "private", undisturbed session with other people on any Server, including publically listed Servers, by simply soloing each other. You will then not be able to hear anyone else if they enter your Server (note that this does not stop them from hearing you, using the chat function, or seeing your profile information).
You can have an undisturbed session with other people on any Server by simply soloing each other. You will then not be able to hear anyone else if they enter your Server.

**NOTE:** This does not stop people from hearing you, using the chat function, or seeing your profile information.

### Using Jamulus audio in Zoom (or other) meeting apps

Expand Down Expand Up @@ -98,9 +100,9 @@ Make sure you connect your MIDI device's output port to the Jamulus MIDI in port

## For Server admins

### Converting a public Server to a private one on the fly
### Converting a Registered Server to an Unregistered one on the fly

You can run a public Server long enough for your band to connect, then go private by simply unchecking the 'Make my Server Public' box in the Server GUI. Your band mates will still be connected to the Server until they disconnect. (Thanks to [David Savinkoff](https://github.com/DavidSavinkoff) for this tip!)
You can run as a Registered Server long enough for your band to connect, then go "private" (Unregistered) by setting the Directory to "none" in the Server GUI. Your band mates will still be connected to the Server until they disconnect. (Thanks to [David Savinkoff](https://github.com/DavidSavinkoff) for this tip!)

### Remote management of recordings

Expand Down