Skip to content

Choosing a Server Type

Jonathan edited this page Sep 30, 2020 · 56 revisions

( en | es )

Home > Running a Server > Server Types

You can run your server in one of three "modes" (either at home or on a 3rd party host):

Public

Your server will be listed in the central server 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. See Private, below.

PublicServer

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 \
        --centralserver 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 for other parameters you can set.


Private

You must give musicians your server address to connect their clients to. See also Running a Private Server for what needs to be done to enable others to connect to it.

PrivateServer

This mode is activated by un-checking "Register my server...".

When running without the GUI ("headless"), the following would configure a private server:

Jamulus --nogui --server

See also Command Line Options for other parameters you can set.


Central

Configuring your server as a Central 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 central server, musicians must enter the address in their client’s "Custom Central Server" settings field. They will then see a Connection Setup list which is generated by that central server.

Server operators can also register with your custom central server so their servers can show up in your server list by setting yours as their --centralserver option.

To run a server as a central server, it should be configured with --centralserver localhost (that is, specify itself as the central server to query). --pingservers is also required.

If you want to control which servers can register with your central server, you can enable a whitelist with the command line Option --listfilter. See the command line options page for further information about this feature.

If there are always certain hosts you want to list (whether they're actually online and registered or not), this can be done with the extended --serverinfo value, with the additional entries being the fixed values. See the command line options page for further information about this feature.

See also Command Line Options for other parameters you can set.