-
Notifications
You must be signed in to change notification settings - Fork 92
Create Server Admin Manual + other changes #527
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
Merged
Merged
Changes from all commits
Commits
Show all changes
20 commits
Select commit
Hold shift + click to select a range
fbd4626
Initial content re-arrangement and modifications
gilgongo b37074d
Further consolidation and amends
gilgongo 802dde2
Adding info re. illegal characters #514
gilgongo c173bfe
Update Running-a-Server.md
gilgongo 7c2fa9a
Corrections
gilgongo 3c5ac39
Expand Rpi statement
gilgongo af3cdb6
Delete linksys-port-forward.png
gilgongo b8068f9
Update Running-a-Server.md
gilgongo 405fb09
Remove QoS to KB, update Win path
gilgongo da47259
Move QoS to KB, correct Win path
gilgongo 554028c
Correct "central"
gilgongo a2c6e62
Add redirect
gilgongo 207da62
Typo
gilgongo 978da29
Clarify Feedback Protection
gilgongo e9cf9e3
use systemctl not service
gilgongo 106840d
Typo
gilgongo a76b9dd
Simplify running server under Linux
gilgongo 34e3868
Remove port-forwarding statement
gilgongo 7b8cffb
Add space for po4a
gilgongo ceec582
Add TOC
gilgongo File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,65 +1,8 @@ | ||
| --- | ||
| layout: wiki | ||
| title: "Choosing a Server Type" | ||
| layout: redirect | ||
| redirect: "/wiki/Running-a-Server" | ||
| lang: "en" | ||
| permalink: "/wiki/Choosing-a-Server-Type" | ||
| category: "hidden" | ||
| --- | ||
|
|
||
| {% include breadcrumb.html root="More" branch1="Running a Server" branch1-url="Running-a-Server" %} | ||
|
|
||
| # Server Types | ||
|
|
||
| You can run your server in one of three "modes" (either at home or on a 3rd party host): | ||
|
|
||
| ### 1. Public | ||
|
|
||
| Your server will be listed in the [directory server](Directory-Servers) list that clients use by default. Musicians can then discover and connect to your server. It is not necessary to run as a public server since many other people already run them. Just connect to one with low latency and start jamming. | ||
|
|
||
| <figure><img src="{{site.url}}/assets/img/en-screenshots/diagram-public-server.png" loading="lazy" alt="Diagram of connections between clients within a Jamulus public server"></figure> | ||
|
|
||
| This mode is activated by checking the "Register my server..." checkbox and (optionally) entering your server information. | ||
|
|
||
| When running without the GUI ("headless"), the following would configure a public server: | ||
|
|
||
| ~~~ | ||
| Jamulus --nogui --server \ | ||
| --directoryserver genreServer:port \ | ||
| --serverinfo "yourServerName;yourCity;[country ID]" | ||
| ~~~ | ||
|
|
||
| **Note**: It is **not** necessary to port-forward or otherwise configure your router to run a public server. | ||
|
|
||
| See also [Command Line Options](Command-Line-Options) for other parameters you can set. | ||
|
|
||
|
|
||
| ### 2. Private | ||
|
|
||
| This type of server will not be listed on a directory server list. You must give musicians your server address to connect their clients to. See [Running a Private Server](Running-a-Private-Server) for what needs to be done to enable others to connect to it. | ||
|
|
||
| <figure><img src="{{site.url}}/assets/img/en-screenshots/diagram-private-server.png" loading="lazy" alt="Diagram of connections between clients within a Jamulus private server"></figure> | ||
|
|
||
| This mode is activated by un-checking "Register my server...". | ||
|
|
||
| When running without the GUI ("headless"), the following would configure a private server: | ||
|
|
||
| ```shell | ||
| Jamulus --nogui --server | ||
| ``` | ||
|
|
||
| See also [Command Line Options](Command-Line-Options) for other parameters you can set. | ||
|
|
||
| ### 3. Directory | ||
|
|
||
| Configuring your server as a Directory Server need only be done under special circumstances (e.g. for online events or musical associations). Most people can ignore this type. | ||
|
|
||
| To view servers listed by a custom directory server, musicians must enter the address in their client’s "Custom Directory Server" settings field. They will then see a Connection Setup list which is generated by that directory server. | ||
|
|
||
| Normal server operators can also register with your custom directory server so their servers can show up in your server list by setting yours as their `--directoryserver` option. | ||
|
|
||
| To run a server as a Directory Server, it should be configured with `--directoryserver localhost` (that is, specify itself as the directory server to query). | ||
|
|
||
| #### Configuration points to note | ||
|
|
||
| If you want to control which servers can register with your Directory Server, you can enable a whitelist with the `--listfilter` command line option. See the [command line options page](Command-Line-Options) for further information about this feature and other parameters you can set. | ||
|
|
||
| When running a public Directory Server behind a NAT firewall on a private network, use the `--serverpublicip` option to specify the public IP address of the server(s) being listed by your Directory Server. This is necessary to allow clients on the public Internet to connect to them via NAT. Note that for the servers using this option, you will still need proper port forwarding in your router/firewall. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,68 +1,7 @@ | ||
| --- | ||
|
gilgongo marked this conversation as resolved.
|
||
| layout: wiki | ||
| title: "Command Line Options" | ||
| layout: redirect | ||
| redirect: "/wiki/Running-a-Server" | ||
| lang: "en" | ||
| permalink: "/wiki/Command-Line-Options" | ||
| category: "hidden" | ||
| --- | ||
|
|
||
| # 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 have a client 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 (x86)\Jamulus\Jamulus.exe" --inifile "C:\path\to\myinifile.ini" | ||
| ``` | ||
|
|
||
| For macOS, start a Terminal window and run Jamulus with the desired options like this: | ||
|
|
||
| ```shell | ||
| /Applications/Jamulus.app/Contents/MacOS/Jamulus --inifile "/path/to/myinifile.ini" | ||
| ``` | ||
|
|
||
| *** | ||
|
|
||
| You can see all possible options your version supports by starting Jamulus with the `-h` option. | ||
|
|
||
| _Note that the following options will not alter settings made in the GUI._ | ||
|
|
||
| ### General settings (client and server modes) | ||
|
|
||
| | Short | Long name | `[...]` means optional parameter | Notes | | ||
| |---------|-------------------|--------------------------------------------------------------------------------------------------------------|----------------------------------------------------------| | ||
| | `-h,-?` | `--help` | This help text | | | ||
| | `-i` | `--inifile` | Set location of initialization file (overrides default) | Client (always) and server (with GUI) | | ||
| | `-n` | `--nogui` | Disable GUI | | | ||
| | `-p` | `--port` | Local UDP port number. Default is 22124 | | | ||
| | `-Q` | `--qos` | Sets the quality of service DSCP value. Default is 128. Disable with 0. | QoS is ignored by Windows, but see [Tips & Tricks](Tips-Tricks-More#quality-of-service) for how to apply it. | | ||
| | `-t` | `--notranslation` | Disable translations | | | ||
| | `-v` | `--version` | Output version information and exit | | | ||
|
|
||
| ### Server only | ||
|
|
||
| | Short | Long name | `[...]` means optional parameter | Notes | | ||
| |-------|-------------------|----------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------| | ||
| | `-d` | `--discononquit` | Disconnect all clients on quit | | | ||
| | `-e` | `--directoryserver` | Make the server public and sets its genre. See also `-o` | See [server types](Choosing-a-Server-Type#3-directory) | | ||
| | `-f` | `--listfilter` | Whitelist servers registering on the server list, format `ip address 1[;ip address 2]` | Directory servers only. [See note](Choosing-a-Server-Type#3-directory) | | ||
| | `-F` | `--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` | `--log` | Enable logging, set path and file name | | | ||
| | `-L` | `--licence` | Show an agreement window before users can connect | | | ||
| | `-m` | `--htmlstatus` | Enable HTML status file, set path and file name | | | ||
| | `-o` | `--serverinfo` | Location details in the format: `[name];[city];[locale value]` (see [values](https://doc.qt.io/qt-5/qlocale.html#Country-enum)) | Public servers only | | ||
| | `-P` | `--delaypan` | Start with delay panning enabled | See [Server Setup](Server-Win-Mac#other-options) | | ||
| | `-R` | `--recording` | Include a writeable path where the files should be stored (in quotes if needed). | See [Server Setup](Server-Win-Mac#recording). | | ||
| | | `--norecord` | Disable recording when enabled by default by `-R` | | | ||
| | | `--serverbindip` | Specify the IP address to bind to | | ||
|
|
||
| ### Client only | ||
|
|
||
| | Short | Long name | `[...]` means optional parameter | Notes | | ||
| |-------|-------------------|---------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------| | ||
| | `-M` | `--mutestream` | Starts Jamulus in muted state | | | ||
| | | `--mutemyown` | Mute me in my personal mix | Headless only | | ||
| | `-c` | `--connect` | Connect to given server address on startup, format `address[:port]` | | | ||
| | `-j` | `--nojackconnect` | Disable auto JACK connections | | | ||
| | | `--ctrlmidich` | MIDI controller channel to listen on, control number offset and consecutive CC numbers (channels). Format: `channel[;f*][;p*][;s*][;m*]` | See [Tips & Tricks](Tips-Tricks-More#using-ctrlmidich-for-midi-controllers) | | ||
| | | `--clientname` | Window title and JACK client name | | | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,30 +1,7 @@ | ||
| --- | ||
| layout: wiki | ||
| title: "Directory Servers" | ||
| layout: redirect | ||
| redirect: "/wiki/Running-a-Server" | ||
| lang: "en" | ||
| permalink: "/wiki/Directory-Servers" | ||
| category: "hidden" | ||
| --- | ||
|
|
||
| {% include breadcrumb.html root="More" branch1="Running a Server" branch1-url="Running-a-Server" %} | ||
|
|
||
| # Public Server Registration | ||
|
|
||
| Because there is a limit of 150 servers per directory server, you need to select which directory server you want to advertise your server on. Select a genre if you intend to limit players to that style (players can then see your server in their genre list). | ||
|
|
||
| When you start a public server, you will see a message saying whether your server has been successfully listed or not. If not, and you leave your server running, it will keep trying to register until a free slot becomes available. | ||
|
|
||
|
|
||
| ## Headless servers | ||
|
|
||
| Set directory (genre) server using the `--directoryserver` (`-e`) option as follows: | ||
|
|
||
|
|
||
| | Genre | Server address | | ||
| |-----------|------------------| | ||
| |**Any Genre 1** |`anygenre1.jamulus.io:22124`| | ||
| |**Any Genre 2** |`anygenre2.jamulus.io:22224`| | ||
| |**Any Genre 3** |`anygenre3.jamulus.io:22624`| | ||
| |**Genre Rock** |`rock.jamulus.io:22424`| | ||
| |**Genre Jazz** |`jazz.jamulus.io:22324`| | ||
| |**Genre Classical/Folk** |`classical.jamulus.io:22524`| | ||
| |**Genre Choral/Barbershop** |`choral.jamulus.io:22724`| |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.