Host a Domain from a Local or Cloud Linux Server¶
The Vircadia packages can help you get your own domain up and running quickly.
Alongside installation, these packages can also migrate an “Athena” domain to Vircadia. You can run them on an existing Vircadia domain to upgrade it if the original was installed using the package. Packages are currently available for the following distributions:
Ubuntu Server 18.04 LTS¶
wget https://cdn.vircadia.com/dist/domain-server/ubuntu/vircadia-server_2020.3.0-demeter-20200929-f7f8ea1-0ubuntu1-1_amd64.deb sudo apt-get update && sudo apt-get install ./vircadia-server_2020.3.0-demeter-20200929-f7f8ea1-0ubuntu1-1_amd64.deb
Amazon Linux 2¶
sudo yum install https://cdn.vircadia.com/dist/domain-server/amazon-linux/vircadia-server-2020.3.0_DEMETER_20200929_f7f8ea1-1.amzn2.x86_64.rpm
The installation packages will create a domain at the default port location and configure a service to keep it running on that machine.
Connect a web browser to the server at port 40100. (If you are on the machine that the server is running on, this would be http://localhost:40100) Complete the initial setup wizard and you should have a functioning domain.
A Vircadia domain reserves a range of four ports to operate on, usually starting at 40100. (Note that the encrypted ports may not be implemented yet.) These ports are:
40100 (+0) : (tcp) administrative http connection
40101 (+1): (tcp) administrative https (encrypted) connection
40102 (+2): (udp) main connection from clients
40103 (+3): (udp) main connection from clients (encrypted)
Generally speaking, only port 40102 must be publicly exposed to permit others to connect to a domain.
In addition there are six “assignment clients” that must run in order for the domain to be operational. These clients run alongside the domain server and must be able to connect with any outside user. These clients are:
asset-server: stores object data to download to the user
audio-mixer: controls what each user would hear
avatar-mixer: allows users to see each other
entity-script-server: runs actions inside the domain
entity-server: describes the location of each object in the domain
messages-mixer: passes messages between users in the domain
These assignment clients use UDP connections on a port number assigned by the operating system at launch (within the ephemeral port range).
The program files are installed in /opt/vircadia:
/opt/vircadia contains the executables
/opt/vircadia/lib contains libraries required for operation
/opt/vircadia/plugins is currently used for audio codecs
/opt/vircadia/resources is required for the administrative website
The executables in this folder (with the exception of
new-server) cannot be launched from the command prompt without first setting
/etc/opt/vircadia/default.conf contains any environment variables necessary to running the domain.
All content is stored under
/var/lib/vircadia/default. All files underneath
/var/lib/vircadia are owned by the user
vircadia, which is also the user that runs all domain-related processes.
The installation packages setup the following systemd services to manage the Vircadia domain:
email@example.com: Manages the core domain server
firstname.lastname@example.org: Spawns and manages the assignment clients
email@example.com: Controls startup and shutdown of the above services
firstname.lastname@example.org service is the only one that is set to auto-start. Starting or stopping it will bring the other two services down.
The first two services log a large amount of data to their service journal. Checking their logs (via
systemctl status) is a good way to ensure they are operating properly.
The installation package is configured to permit multiple domains to run on a single server at different port numbers. New servers can be created using the following command:
/opt/vircadia/new-server <name> <base-port>
name is a word used to name and manage the domain and
base-port must be the the first of a range of four contiguous port numbers not overlapping with any other use on the system.
Assuming you created a new server with the name second-bite, this would setup the following:
Environment variables in
Content stored in
Services launched as
There are a number of tweaks that are made to the default configuration to simplify storage and the ability to run multiple domains on one server. In case you would like to remove this logic and run the servers closer to how the original High Fidelity domain servers were running, this is provided as an option.
Systemd services named
vircadia-server.target(without the @name) have simplified configuration
No file is provided to specify environment variables for the server
Content would be stored in