Pavlov VR Wiki - User contributions [en]

Setting up a dedicated server

2023-12-05T06:28:25Z

SaltedCrackerJack: /* System setup and software installation */

== Setting up a dedicated server ==

'''There are no Windows binaries'''

This guide is written exclusively for Linux and covers Ubuntu/Debian/Debian-like and Red Hat RPM-based distros. Possible to run with other distros, but some of the commands won't work and you will need to know enough to figure out the software install of dependencies on your own.

If you are considering hosting from home, please read that section of the wiki first.

This guide assumes you know the basics of using a bash terminal: ssh'ing into a server, running bash commands, editing text files, etc.

If you have no experience using bash, maybe start [https://www.howtogeek.com/140679/beginner-geek-how-to-start-using-the-linux-terminal/ here]. Editing text files via commandline is often a challenge. Suggest using nano and reading guide [https://www.howtogeek.com/howto/42980/the-beginners-guide-to-nano-the-linux-command-line-text-editor/ here]

If you are new to linux and accessing your server from Windows, highly suggest using MobaXterm as your SSH client as that can make required editing of text files easier using built in editor instead of the native linux command line editors.

And finally, ask yourself why you want to setup a server? If you look at the list, there are many, many more servers than players. If you don't have a team, discord community, or group of friends ready to play on your server, chances are it will go unused. Got one of these... great, let's go.

If you don't want to go through the hassle yourself and want to pay for a hosting service Arctic VR (PC and Shack) and Horde (Shack) provide a server hosting services and are trusted in the community. See links below.

----

=== Server Requirements ===

'''Pavlovserver can only be hosted under Linux.'''

This can be running as a VM under windows, but this will increase the complexity of the setup beyond this guide.

Ubuntu 18.04 x86_64, Ubuntu 19/04 amd64, Ubuntu 20.04, and Rocky Linux 8 are confirmed working. Ubuntu 15.04 x86 is known to fail to install using this guide. Recommend not running on "minimal" images as some tools are missing.

* 2GB RAM + 1GB RAM per each additional server with 10 players. More RAM is recommended for larger maps, higher player counts, or complex gamemodes. Not having enough RAM is a common cause of server crashes.

* A ~2.5Ghz CPU will comfortably support a 10 player server.

* A ~4Ghz CPU will comfortably support 24 players. This is a limit built into Pavlov itself, no server will allow players to join over 24. Lower player counts are recommended for complex gamemodes (E.g. CodZ) and/or highly detailed maps, so that maximum number will often be lower.

(Note that these are '''not''' hard limits for player counts, just suggestions for the best performance, based on experiences with many server providers on different grades of hardware.)

* Pavlovserver is functionally single threaded (one thread does vast majority of work). More CPUs only help if you are running more servers. More clockspeed = higher performance = more users per server.
The maximum number of servers you can run is dependent on how many CPUs you have. For example, if you have an 8 core CPU, the maximum number of servers would be 7. You should always have at least one CPU free as overhead, as Pavlov servers can use slightly more than one thread.

----

==== Hosting at home ====
When hosting at home there are additional requirements regarding networking: Your router has to support port-forwarding, hair-pinning/LoopbackNAT, and respond to ping requests. These techniques are necessary to allow your server to be found and to talk back to the client. please see https://en.wikipedia.org/wiki/Port_forwarding, https://en.wikipedia.org/wiki/Hairpinning, and https://www.speedguide.net/faq/how-to-become-pingable-behind-a-routerfirewall-376 for more info and google for these terms in addition to your router model to find guides on how to enable/configure it properly. If you have modern Router, it may have these features already enabled, in this case you just have to configure port-forwarding. If you can see your server but not join it while others can, this is indicative of a failure of LoopbackNAT.

A second challenge to hosting at home is CGNAT (Carrier grade NAT: https://www.a10networks.com/blog/carrier-grade-nat/). Just like NAT on your home network that has to be gotten around w/ port-forwarding, CGNAT breaks the ability of external connections to be made back to your server, but the controls are solely in your ISPs hands. Sometimes if you ask, you can be removed from CGNAT pools and/or assigned a static IP. CGNAT rollouts are becoming very common now, so if your server worked then doesn't allow connections now, your ISP may have made this change.

You can check whether you’re on a CGNAT network by visiting a Web site such as ipaddress.com or whatsmyip.com and comparing the IP address listed to the public/WAN IP address assigned to your Internet gateway. To find your gateway’s public IP address, check the status page in the administrative interface. If the two IP addresses differ, you’re likely on a CGNAT network. If so, this problem must be resolved before you go any further.

'''Not understanding these requirements and configuration is a frequent cause of failed setups and questions in discord. Don't skip this if you are trying to host from home'''

'''There are serious security implications of hosting this software at home.''' None of the devs are security experts and there has been no security review of the code. You are opening up your system to the world and publicity advertising this fact. Expect that any system hosting this software is open to compromise from the Internet and act accordingly. If your router offers a DMZ network, use it. Consider hosting on a cloud based server and think twice before running this software on any system that contains data you care about or has access to networks and computers you care about.

If you're hosting at home using Oracle's VirtualBox, there are steps you can take to prevent double NAT (which can cause issues later on)

1. Select your VM and then click Settings in VirtualBox's main window.

2. Click on Network and change Attached To from NAT to Bridged Adapter.

Once you've done this, your VM should be connected directly to your home router and double NAT should no longer be a issue.

----

==== Starting Server Install ====

====Obtaining an ApiKey ====
(Not required unless hosting large amount of servers )

you can just comment this line out or remove it For your server to show up in the server list, there is now a requirement to have an ApiKey issued by vankrupt. This is to prevent DOS attacks against the master server

Get the key by going here: https://pavlov-ms.vankrupt.com/servers/v1/key and using your mobile number to get a SMS
(Note that there have been reported failures of this SMS system for non-US mobiles. In this case, DM davevillz your phone number and request a key)

Put this key in your Game.ini as follows:
ApiKey="ABC123FALSEKEYDONTUSEME"
or if you would like (personally untested..I would use Game.ini) you can call it at server runtime with flag as follows:
-KEY="ABC123FALSEKEYDONTUSEME"

This key can be re-used for a reasonable number of servers (a limit of 10 has been mentioned). Contact the Devs if you need more servers per key.

====System setup and software installation====

Install dependencies and create the `steam` user. (You only need to do this once):

Confirm Linux version
<pre>
lsb_release -a
</pre>

'''Ubuntu 20.04'''
'''''sudo apt update''''' && '''''sudo apt install''''' -y gdb curl lib32gcc1 libc++-dev unzip

'''Ubuntu 20.10 or higher'''
sudo apt update && sudo apt install -y gdb curl lib32gcc-s1 libc++-dev unzip

'''Rocky Linux, CentOS 8, and RHEL 8'''
sudo sed -i 's/^SELINUX=enforcing$/SELINUX=permissive/g' /etc/selinux/config
sudo setenforce 0
sudo yum install gdb curl glibc.i686 libstdc++.i686 libstdc++-devel.i686 libstdc++-devel.x86_64 unzip wget -y
wget <nowiki>https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/l/libcxx-3.8.0-3.el7.x86_64.rpm</nowiki>
sudo rpm -i libcxx-3.8.0-3.el7.x86_64.rpm

'''Steam user'''
sudo useradd -m steam

[Optional] Set the /bin/bash shell for the steam user this will allow you to use arrow keys in terminal and show what folder you are in at all times<pre>sudo chsh -s /bin/bash steam</pre>

[Optional] Set a password for steam.<pre>sudo passwd steam</pre>

Login as the Steam user. ('''You will need to do this each time you connect to your server'''):<pre>
sudo su -l steam
</pre>

Install Steam:

<pre>
mkdir ~/Steam && cd ~/Steam && curl -sqL "https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz" | tar zxvf -
</pre>

There are different dedicated server versions for Pavlov Server - choose which server version you want to host (PC non-beta, PC Beta, Shack Live, or Shack RC)
(You will need to run this command each time there is a Pavlov Server update).

 
To host '''PC Server (non-beta)''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta default +exit

</pre>

To host '''PC BETA''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta beta_server +exit
</pre>

To host '''Shack Live''' (Quest):

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack +exit
</pre>

To host '''Shack RC''' (Quest): 

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack_beta +exit
</pre>

Now that we've installed the server, all pavlov server versions should continue. 
Install a fresh copy of steamclient.so (May have to do this after each update):
<pre>
~/Steam/steamcmd.sh +login anonymous +app_update 1007 +quit
mkdir -p ~/.steam/sdk64
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/pavlovserver/Pavlov/Binaries/Linux/steamclient.so
</pre>

The update 29 of the PCVR version of Pavlov and after added a requirement to run these commands to change the steamclient.so:
<code>sudo rm /usr/lib/x86_64-linux-gnu/libc++.so</code>
<code>sudo ln -s /usr/lib/x86_64-linux-gnu/libc++.so.1 /usr/lib/x86_64-linux-gnu/libc++.so</code>

Make the PavlovServer script executable. (You only need to do this once):

<pre>
chmod +x ~/pavlovserver/PavlovServer.sh
</pre>

----

=== Server Configuration ===

Before starting the server we need to configure it. Start by creating some directories:

<pre>
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Logs
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps
</pre>

==== Mods/Blacklist/Whitelist (optional) ====

The following three files allow you to specify mods, banned players, and whitelist players. These are optional, but go ahead and create them. Populating the files is described later.

<pre>
touch /home/steam/pavlovserver/Pavlov/Saved/Config/mods.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/blacklist.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/whitelist.txt
</pre>

====Configuring Game.ini====
Create a new Game.ini file using following command to open an editor and copy/paste the following block into it then save it. Note not all of these options are required. For instance remove or comment out the Password=0000 line to make a public server with no pin.
<pre>
nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini
</pre>

<pre>
[/Script/Pavlov.DedicatedServer]
bEnabled=true
ServerName="My_private_idaho"
MaxPlayers=10 #its recommended for the best experience to keep shack servers at or below 10 players pcvr and psvr are both capped at 24 too.
ApiKey="ABC123FALSEKEYDONTUSEME"
bSecured=true
bCustomServer=true
bVerboseLogging=false
bCompetitive=false #This only works for SND
bWhitelist=false
RefreshListTime=120
LimitedAmmoType=0
TickRate=90
TimeLimit=60
#Password=0000
#BalanceTableURL="vankruptgames/BalancingTable/main"
MapRotation=(MapId="UGC1758245796", GameMode="GUN")
MapRotation=(MapId="datacenter", GameMode="SND")
MapRotation=(MapId="sand", GameMode="DM")

</pre>

* '''bEnabled''' - whether the server appears in the server list (unconfirmed)
* '''ServerName''' - name it will be listed as. (approx 35 chars max)
* '''MaxPlayers''' - See suggested specs for limits. 10 standard (10 for shack), 20-24 is max recommended for large maps like Stalingrad or PUSH/RUSH modes, and servers allow a maximum of 24 players.
* '''ApiKey''' - Unique ApiKey required to register server with master server. Replace with your key
* '''bSecured''' - enabled Valve Anti-Cheat (VAC)
* '''bCustomServer''' - activates some new modding tools (save and http functions. Required to write to blacklist.txt for bans)
* '''bCompetitive''' - sets the server to competitive mode for SND. If removed the server will default to false
* '''bVerboseLogging''' - enables verbose logging, mostly detailed statistics. Be prepared for significant increase in logging.
* '''bWhitelist''' - Only allow users in whitelist.txt to join
* '''RefreshListTime''' - sets how often the running server checks for updates in ban/whitelist/mod files
* '''LimitedAmmoType''' - sets limited ammo mode, see Limited Ammo Types table below

* '''TimeLimit''' - sets time limit for each map
* '''TickRate''' - sets the server tickrate. (so far minimum stable seems around 50 and max around 120. Beware setting this changes weapon despawn time and breaks some game modes. Recommend not touching)
* '''Password''' - PIN number for server #FYI - this is now also changeable via rcon.
* '''BalanceTableURL''' - Points to a custom balance table from github. See https://github.com/vankruptgames/BalancingTable for instructions. This line isn't needed if you don't have one.
* '''MapRotation''' - you can add multiple of these. The map system has switched from the steam workshop to modio which means that the server rotation will need to be redone with modio UGCs. <nowiki>https://mod.io/g/pavlov</nowiki>. This is done by taking the resource ID from the modio page, adding “UGC” in front of it and then adding that to the rotation. For example the map gravity <nowiki>https://mod.io/g/pavlov/m/gravity1</nowiki> has a resource ID of 2773760 so the map ID to add to the server would be “UGC2773760”. When a match ends, the server will load the next map in the rotation.
* '''AFKTimeLimit''' There is now a feature to kick players who are idle in the game. Integers are measured in seconds and 0 disables AFK kicking completely.

Available game modes as of 09/06/2022: See Game modes table below

For maps running a Custom gamemode (CodZ, BR, Duel, etc.) it doesn't matter which gamemode you choose, as the map will automatically override it with the custom mode.

{| class="wikitable"
|+Limited Ammo Types
!AmmoType
!Name
!Description
|-
|0
|Unlimited
|Players have unlimited ammo, carry no ammo boxes and do not display an ammo count on the wrist.
|-
|1
|Limited Generic
|Players carry ammo boxes with a limited amount of ammo.
One box for each weapon class (Pistol, Submachine gun, Rifles/MGs, Shotgun, Sniper).

Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.

An ammo count is displayed on the wrist.
|-
|2
|Limited Specific
|Players carry ammo boxes with a limited amount of ammo.
One box for each weapon.

Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.

An ammo count is displayed on the wrist.
|-
|3
|Custom
|Allows for full control over ammo by the map.
|-
|4
| Limited Special
|'''All weapons except "special" weapons are unlimited, more clarification is needed.'''
|-
|5
|Boxless
|'''Like limited generic but without boxes? Clarification is needed.'''
|}
{| class="wikitable"
|+Game modes
!GameMode
!Name
|-
|DM
|Death match
|-
|KOTH
|King of the hill
|-
|GUN
| Gun game
|-
|OITC
| One in the chamber
|-
|SND
|Search and destroy
|-
|TANKTDM
|WW2 Team Death Match
|-
| TDM
|Team Death Match
|-
|TTT
|Trouble in Terrorist Town
|-
|TTTclassic
|TTT with only innocent/traitor/detective
|-
|WW2GUN
|WW2 gun game
|-
|ZWV
| Zombie wave survival
|-
|HIDE
|The Hidden
|-
|INFECTION
|Hidden infection
|-
|PUSH
|Push
|-
|PH
|Prop hunt
|}
= Default Map ID's =
datacenter

sand

bridge

containeryard

siberia (Prison Break)

hospital (Zombies map)

killhouse

range

tutorial

santorini

station

industry

ogcontainers (Shack only)

haguenau (Shack only)

foundation (Shack only)

stalingrad (PC only)

stalingrad_night (PC only)

santorini_night (PC only)

sand_night (PC only)

station_night (PC only)

industry_night (PC only)

bunker (PC only)

==== Firewall/Port forwarding ====
Using the default settings there are two UDP ports (7777, 8177) that need to be allowed to access the server either by firewall setup or port forwarding.

'''Ubuntu''' firewall commands to check firewall and open ports:
<pre>
sudo ufw status
sudo ufw allow 7777
sudo ufw allow 8177
sudo ufw allow 9100
sudo ufw status
</pre>

'''Rocky Linux''' firewall commands to check the firewall and open ports:
<pre>
sudo firewall-cmd --zone=public --add-port=7777/tcp
sudo firewall-cmd --zone=public --add-port=7777/udp
sudo firewall-cmd --zone=public --add-port=8177/tcp
sudo firewall-cmd --zone=public --add-port=8177/udp
sudo firewall-cmd --zone=public --add-port=9100/udp
sudo firewall-cmd --zone=public --add-port=9100/tcp
sudo firewall-cmd --list-ports
firewall-cmd --runtime-to-permanent
</pre>

You may also need to allow Pings (ICMP) for the server's true latency to appear in the master list.

If you are running multiple servers and have set additional ports (see http://pavlovwiki.com/index.php/Setting_up_a_dedicated_server#Running_multiple_servers_on_one_host) then you need to allow access to the defined port plus the port 400 higher. So if you use 7000 as your port, then UDP 7000 and 7400 need to be open

If you have setup rcon via RconSettings.txt (below) then that port also needs to be allowed access via TCP

If you are running Shack/Quest and want to have maps that are downloadable from your server, your server ports (ex. 7777 & 8177) must also be open via TCP

----

==== Shack Maps (Quest) ====

If you try to use the steps above to add maps for Shack, you'll run into issues very quickly. This is because Shack has no affiliation with Steam, and therefore cannot use Steam Workshop maps like the above. In the future, these steps will apply to PC servers as well, allowing a server to hold the map itself, instead of offloading it to Steam.

To get started, first, create the directory to hold the maps

<pre>mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps</pre>

You can use any number of methods to move the map files onto the server, but I'll go over the two simplest, starting with a GUI approach

Download and install Cyberduck onto your "home" PC (Whatever PC you use for access to the server, but not the server itself): https://cyberduck.io/

Next, download and unzip your map of choice from https://www.pavlovquest.com/ , https://pavlovhorde.com/mapsList, or look in #shack-map-showcase channel in the discord server. I'm going to use Cheeto's WW2 Items test (http://www.mediafire.com/file/emyt9bs1z9u9ykw/SVR_Cheeto_Items.zip/file ) for this example, you do what you like

In the top left corner, open a connection, set the connection type to SFTP, and fill in the rest of the information. The username is typically `root`, password is whatever you set the root pw as (toor in Ubuntu by default)

In the directory dropdown (it will say /root) go back to /

Follow the directories until we arrive back at our "maps" folder <pre>/home/steam/pavlovserver/Pavlov/Saved/maps</pre>

Drag and drop the unzipped map folder into the main window, in this case itll be SVR_Cheeto_Items

Hit Allow

You'll now see a folder named SVR_Cheeto_Items, and within it should be nothing but 3 files. If there is another folder in it, move this folder to the maps directory, otherwise the server won't work. The 3 files (2 .PAK one .JSON) should be in home/steam/pavlovserver/Pavlov/Saved/maps/SVR_Cheeto_Items, no more, no less.

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

To play the map, you can either use RCON switch map command, or to add the map to your server's automatic map rotation list, add the map's folder name to your Game.ini. This replaces the MapID section, so for our example, it would be

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

And that's all! Disconnect CyberDuck from your server before playing, otherwise you'll have difficulty joining.

-----------

==== Adding Shack Maps over Command Line Interface ====

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

A bit more complicated, but adding maps over CLI has its benefits

First, CD to the maps directory you made above

<pre>cd ~/pavlovserver/Pavlov/Saved/maps</pre>

Download the map files from whatever you use to upload them. To do this, you can either use curl or wget

<pre>curl -O insertURLhere</pre>

'''If you download your map from Google Drive''', make sure that your .zip folder is shared with anyone.
Then, get the file's URL from the shared link. Example : ''<nowiki>https://drive.google.com/file/d/19bI8gUHaN5tUrDvnadAacUnchQf6_k/view</nowiki>'' will be ''19bI8gUHaN5tUrDvnadAacUnchQf6_k''
Edit "fileId" and "fileName" before you execute the command.
<pre>
fileId=19bI8gUHaN5tUrDvnadAacUnchQf6_k
fileName=SVR_USER_MAPNAME
curl -sc /tmp/cookie "https://drive.google.com/uc?export=download&id=${fileId}" > /dev/null
code="$(awk '/_warning_/ {print $NF}' /tmp/cookie)"
curl -Lb /tmp/cookie "https://drive.google.com/uc?export=download&confirm=${code}&id=${fileId}" -o ${fileName} </pre>

To keep with the Items example:

<pre>curl -O https://cdn.discordapp.com/attachments/744185280759857234/745027406695366788/SVR_Cheeto_Items.zip</pre>

Next, unzip the file. If this next step errors out, saying the command is unknown, switch back to the root user (su root), and install unzip (sudo apt install unzip), then return to the steam user, and continue.

<pre>unzip SVR_Cheeto_Items.zip</pre>

Now finish like before by adding the map to your Game.ini

<pre>nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini</pre>

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

==== Admin/Moderator list (optional) ====

The only working in-game admin menu is through Arctic VR server hosting (see below).

If you add moderators to your server, they will not be subject to vote kicks.

<pre>
nano ~/pavlovserver/Pavlov/Saved/Config/mods.txt
</pre>

Example Mod List:
<pre>
76541198397498572 #Optional Comment: Player name
76541198397498573 #Some Other Player
</pre>

==== ArcticVR Admin Menu ====

[[File:Arcticmenu.jpg|500px|link=https://www.arctic-vr.com/server-admin-menu]]

Arctic-VR Offers an advanced In-Game Admin menu that is exclusive to their hosting service. Features include:
* Switch Maps+Modes
* Teleport Players to Players
* Change Player Skins
* Control Player Buying+Cash
* Spawn Items
* Clean up corpses + guns
* Spawn Bots
* Spawn Items for other players
* Control Teams + Balance/Shuffle Teams
* ResetSND
* And More

You can read more about the ArcticVR admin menu on their website: https://www.arctic-vr.com/server-admin-menu

==== Handy tools for finding steamIDs ====

Steam ID finder: https://steamidfinder.com/lookup/ or https://steamid.xyz/

You want to enter in the steamID64 format.

This tool can convert or lookup IDs: https://steamid.io/

If you are looking for a steamID of a player that has been on your server recently this is technique to find them:
<pre>
grep -i playername ~/pavlovserver/Pavlov/Saved/Logs/* | grep TicketValidation
</pre>

=== Configure Rcon ===
To enable Rcon access create config file:
<pre> nano /home/steam/pavlovserver/Pavlov/Saved/Config/RconSettings.txt </pre>

Copy in the following text - change password, and if desired the port:
<pre>
Password=ChangeThisPassword
Port=9100
</pre>
You must specify a port for the Rcon server to use as well as a Password (use a different port per sever instance if running multiple server instances off the same hardware)

=== Starting the server ===

<pre>
cd ~/pavlovserver && ./PavlovServer.sh
</pre>

That's it, your server will be automatically broadcast to the master server! :)

Two handy tools to determine quickly if your server is broadcasting are [https://pablub.xyz/ Pablub] (PC only) and [https://pavlovhorde.com/ Horde] (Shack) and [https://pavlovhorde.com/pcServers Horde] (PC version)

Note that when you close your terminal, the server will go down. See the "supervisors" section below for how to prevent this.

----

=== Supervising the server using systemd ===

Running '''./PavlovServer.sh''' in your interactive shell is easy, but the server will shut down when you close your terminal. If you want to run the server in the background,
you'll want to run it under a supervisor. There are many options, ranging from the simple (nohup, screen or tmux), to the
more robust (supervisord, systemd).

Systemd is running by default on Ubuntu Linux, so we'll use that here.

To run the server as a systemd service, create the file '''/etc/systemd/system/pavlovserver.service''' (as root) by typing
<pre>
sudo nano /etc/systemd/system/pavlovserver.service
</pre>

Copy the contents below into the file and save.

<pre>
[Unit]
Description=Pavlov VR dedicated server

[Service]
Type=simple
WorkingDirectory=/home/steam/pavlovserver
ExecStart=/home/steam/pavlovserver/PavlovServer.sh

RestartSec=1
Restart=always
User=steam
Group=steam

[Install]
WantedBy = multi-user.target
</pre>

If you'd like your server to start as competitive without editing the game.ini, change the line "ExecStart=/home/steam/pavlovserver/PavlovServer.sh" to look like this below. Though it's much easier to just use the game.ini to enable competitive instead. <pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -COMPETITIVE=1</pre>

Change the user or paths as appropriate. After saving the service file, to start, restart, stop, or monitor the server:

<pre>
sudo systemctl start pavlovserver
sudo systemctl restart pavlovserver
sudo systemctl stop pavlovserver
sudo systemctl status pavlovserver
</pre>

To view the logs:

<pre>
sudo journalctl -u pavlovserver
# to live-tail the logs
sudo journalctl -u pavlovserver -f
</pre>

If you want to run the pavlov server as soon as your server boots (e.g. a VPS you turn on and off), add pavlov as a startup service:

<pre>
sudo systemctl enable pavlovserver
</pre>

----

== Advanced Server Administration ==

=== Running multiple servers on one host ===

* Pavlovserver is functionally single-threaded (there are multiple threads, but the vast majority of work occurs in the primary one). Make sure you have # of pavlovservers + 1 CPU available. More CPUs= more servers. Faster CPU = more players.
* Make multiple server installs by defining a separate install dir for each server.
* Run each server with a unique port. eg: '''./PavlovServer.sh -PORT="Desired Port"'''
* The Server will use the Desired Port and the Port 400 above (Example: You choose 8200 as Port. So Port 8600 will be used as well)
* If you are using RCON, each server will need a unique port defined in RconSettings.txt
* Ensure the ports are forwarded and opened in your firewall

To duplicate directories:

be in the steam home folder
<pre>
cp -r pavlovserver pavlovserver1
/home/steam/pavlovserver1/PavlovServer.sh -PORT=[Desired Port]
</pre>

=== Starting server in competitive mode ===
Competitive mode will prevent dead teammates from being able to see the match, to prevent ghosting.
You can either enable this via Game.ini (described in Game.ini file), or using the -COMPETITIVE=1 parameter.

<pre>
/home/steam/pavlovserver1/PavlovServer.sh -COMPETITIVE=1
</pre>

{| class="wikitable"

|}

=== Useful Linux Commands ===
List files / folders in directory, print current working directory,
<pre>ls -la #list files/directories along with authorities and ownership
pwd #print working directory
sudo chown <owner> <file/directory> #change owner of file/directory. If root created something and you need to change it to steam
sudo chgrp <group> <file/directory> #change group of file/directory.
</pre>

Check if pavlov is running by checking process status. If the only row you see is the grep command, pavlov server is not started.
<pre> ps -ef | grep pav </pre>

Sample output:
<pre>
steam 34044 1 0 16:52 ? 00:00:00 /bin/sh /home/steam/pavlovserver/PavlovServer.sh
steam 34066 34044 80 16:52 ? 00:00:04 /home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer
zombies+ 34101 34013 0 16:52 pts/0 00:00:00 grep --color=auto pav
</pre>

Kill a process. Note this command uses 34044, which is a process id from the command output above.
<pre> kill -9 34044 </pre>

Dump the log to the console so you can scroll through it:
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log </pre>

Search the log for a string - replace my_string with case-sensitive string
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep my_string </pre>

<hr>

== Advanced Scripts For Server Management ==
<hr>

=== '''Auto-updating the server (PCVR only)''' ===
Assuming you have followed this guide and used the default paths, users, and install instructions, you can paste the following into your terminal to auto-update your Pavlov server:

<pre>
cat << 'EOF' > $HOME/pavlov_daily_update_and_restart.sh
#!/bin/bash

USER="steam"
SERVICENAME="pavlovserver.service"
INSTALLDIRNAME="pavlovserver"
USERHOME="/home/$USER"

echo -e "Beginning Pavlov VR update run on $(date)\n\n"

systemctl stop "$SERVICENAME"

sleep 5
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +force_install_dir "$USERHOME/$INSTALLDIRNAME" +app_update 622970 +exit
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +app_update 1007 +quit
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/.steam/sdk64/steamclient.so"
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/pavlovserver/Pavlov/Binaries/Linux/steamclient.so"

systemctl start "$SERVICENAME"

echo -e "Ending Pavlov VR update run on $(date)\n\n"

EOF

chmod +x $HOME/pavlov_daily_update_and_restart.sh
mkdir $HOME/pavlov_update_logs && touch $HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log
CRONLINE="00 2 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
(sudo crontab -u root -l; echo "$CRONLINE" ) | sudo crontab -u root -
unset CRONLINE

</pre>

These commands will:

1. Create a shell script in the "steam" user's home directory that automatically stops the Pavlov server, pulls any updates via steam, pull updates to the Steamworks SDK Redist, and copies the latest version of steamclient.so to the Pavlov server directory

2. Make the shell script executable

3. Create a new directory called "pavlov_update_logs" in the "steam" user's directory, and create a logfile inside that directory called "pavlov_daily_update_and_restart.sh.log". You can check this logfile to see the output of the Pavlov and Steam SDK update commands.

4. Create a crontab entry for the root user that runs this shell script automatically every day at 2:00AM local time

If you want to change the time that this script runs, edit the numbers "00 2" in the line that starts with "CRONLINE=". In the example provided, 00 is the minutes column, and 2 is the hour column. For example, if you wanted the server to automatically update and restart at 4:17AM every day, change the line starting with "CRONLINE=" to:

<pre>
CRONLINE="17 4 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
</pre>

If the time is PM, use 24-hour time format, e.g. "32 18" for 6:32PM.
<hr>
=== '''Save Logs for records and stats''' ===
this is an automated script that will on a timer save all the backups made by the server before they are purged by the game for admin records and starts collection

https://github.com/JTWP-org/backUpLogs2
<hr>

=== '''Make an API request with Mod.io to get map picture and name''' ===
very basic script pass the script a map ID as an argument then it will give u the name and a thumbnail to use

https://github.com/JTWP-org/mod.io-modcheck/tree/main

=== '''Sharing Bans over gameserver on same machine''' ===
when you have a lot of servers keeping the bans synced can be a nightmare so using a symbolic link allows all the servers to use one file

for this lets say I have pavlovserver000 and pavlovserver001 and they are located at /home/steam/pavlovserver000 and /home/steam/pavlovserver001

''step 1 will be to pick a blacklist to use as the new one and move it to a central location''
mkdir ~/shared ; mv /home/steam/pavlovserver000/Pavlov/Saved/Config/blacklist.txt ~/shared/blacklist.txt ; rm /home/steam/pavlovserver001/Pavlov/Saved/Config/blacklist.txt
now we have moved the blacklist from pavlovserver000 to a folder in our home called shared and then we removed the blacklist from pavlovserver001

step 2 making the links
ln -s ~/shared/blacklist.txt /home/steam/pavlovserver000/Pavlov/Saved/Config/blacklist.txt ; ln -s ~/shared/blacklist.txt /home/steam/pavlovserver001/Pavlov/Saved/Config/blacklist.txt
now editing them in pavlovserver001's files will update the list for all of the servers it's not a sync its uses the same list if you want to check where a link is pointed if u
ls -l
It will show where the file is really located <hr>
=== Interactive Update ALL ===
will find all server installs on machine and update them will update Ubuntu check what version and do correct updates for that version also UPDATE 29 PCVR STEP then it will list each server by server name and ask what type it is and then it will update and move to the next

https://github.com/JTWP-org/Pavlov-updateallservers/tree/main<hr>

=== getting map info with just the UGC ===

you will need to get a API key from mod.io for this ... running this bash script and passing a UGC number to it will return the map name mod.io url and a thumbnail

HOW TO USE <pre>nano get-map.sh</pre>

then enter this script <pre>#!/bin/bash

ugc=000000

gameID=3959 #PAVLOV IS 3959

api-path="https://u-*ID NUMBER*.modapi.io/v1" #get on thhe access tab in mod.io settings

api-key="" #get on thhe access tab in mod.io settings

curl -X GET "${api-path}/v1/games/${gameID}/mods/$("${ugc:3})?api_key=${api-key}" -H 'Accept: application/json' | jq '.logo.thumb_1280x720, .name , .profile_url</pre>

then give script perms to run <pre>sudo chmod +x get-map.sh</pre>

and then run it like this
<pre>bash get-map.sh UGC3409480 </pre>

Setting up a dedicated server

2023-11-24T06:29:47Z

SaltedCrackerJack: /* Configuring Game.ini */

== Setting up a dedicated server ==

'''There are no Windows binaries'''

This guide is written exclusively for Linux and covers Ubuntu/Debian/Debian-like and Red Hat RPM-based distros. Possible to run with other distros, but some of the commands won't work and you will need to know enough to figure out the software install of dependencies on your own.

If you are considering hosting from home, please read that section of the wiki first.

This guide assumes you know the basics of using a bash terminal: ssh'ing into a server, running bash commands, editing text files, etc.

If you have no experience using bash, maybe start [https://www.howtogeek.com/140679/beginner-geek-how-to-start-using-the-linux-terminal/ here]. Editing text files via commandline is often a challenge. Suggest using nano and reading guide [https://www.howtogeek.com/howto/42980/the-beginners-guide-to-nano-the-linux-command-line-text-editor/ here]

If you are new to linux and accessing your server from Windows, highly suggest using MobaXterm as your SSH client as that can make required editing of text files easier using built in editor instead of the native linux command line editors.

And finally, ask yourself why you want to setup a server? If you look at the list, there are many, many more servers than players. If you don't have a team, discord community, or group of friends ready to play on your server, chances are it will go unused. Got one of these... great, let's go.

If you don't want to go through the hassle yourself and want to pay for a hosting service Arctic VR (PC and Shack) and Horde (Shack) provide a server hosting services and are trusted in the community. See links below.

----

=== Server Requirements ===

'''Pavlovserver can only be hosted under Linux.'''

This can be running as a VM under windows, but this will increase the complexity of the setup beyond this guide.

Ubuntu 18.04 x86_64, Ubuntu 19/04 amd64, Ubuntu 20.04, and Rocky Linux 8 are confirmed working. Ubuntu 15.04 x86 is known to fail to install using this guide. Recommend not running on "minimal" images as some tools are missing.

* 2GB RAM + 1GB RAM per each additional server with 10 players. More RAM is recommended for larger maps, higher player counts, or complex gamemodes. Not having enough RAM is a common cause of server crashes.

* A ~2.5Ghz CPU will comfortably support a 10 player server.

* A ~4Ghz CPU will comfortably support 24 players. This is a limit built into Pavlov itself, no server will allow players to join over 24. Lower player counts are recommended for complex gamemodes (E.g. CodZ) and/or highly detailed maps, so that maximum number will often be lower.

(Note that these are '''not''' hard limits for player counts, just suggestions for the best performance, based on experiences with many server providers on different grades of hardware.)

* Pavlovserver is functionally single threaded (one thread does vast majority of work). More CPUs only help if you are running more servers. More clockspeed = higher performance = more users per server.
The maximum number of servers you can run is dependent on how many CPUs you have. For example, if you have an 8 core CPU, the maximum number of servers would be 7. You should always have at least one CPU free as overhead, as Pavlov servers can use slightly more than one thread.

----

==== Hosting at home ====
When hosting at home there are additional requirements regarding networking: Your router has to support port-forwarding, hair-pinning/LoopbackNAT, and respond to ping requests. These techniques are necessary to allow your server to be found and to talk back to the client. please see https://en.wikipedia.org/wiki/Port_forwarding, https://en.wikipedia.org/wiki/Hairpinning, and https://www.speedguide.net/faq/how-to-become-pingable-behind-a-routerfirewall-376 for more info and google for these terms in addition to your router model to find guides on how to enable/configure it properly. If you have modern Router, it may have these features already enabled, in this case you just have to configure port-forwarding. If you can see your server but not join it while others can, this is indicative of a failure of LoopbackNAT.

A second challenge to hosting at home is CGNAT (Carrier grade NAT: https://www.a10networks.com/blog/carrier-grade-nat/). Just like NAT on your home network that has to be gotten around w/ port-forwarding, CGNAT breaks the ability of external connections to be made back to your server, but the controls are solely in your ISPs hands. Sometimes if you ask, you can be removed from CGNAT pools and/or assigned a static IP. CGNAT rollouts are becoming very common now, so if your server worked then doesn't allow connections now, your ISP may have made this change.

You can check whether you’re on a CGNAT network by visiting a Web site such as ipaddress.com or whatsmyip.com and comparing the IP address listed to the public/WAN IP address assigned to your Internet gateway. To find your gateway’s public IP address, check the status page in the administrative interface. If the two IP addresses differ, you’re likely on a CGNAT network. If so, this problem must be resolved before you go any further.

'''Not understanding these requirements and configuration is a frequent cause of failed setups and questions in discord. Don't skip this if you are trying to host from home'''

'''There are serious security implications of hosting this software at home.''' None of the devs are security experts and there has been no security review of the code. You are opening up your system to the world and publicity advertising this fact. Expect that any system hosting this software is open to compromise from the Internet and act accordingly. If your router offers a DMZ network, use it. Consider hosting on a cloud based server and think twice before running this software on any system that contains data you care about or has access to networks and computers you care about.

If you're hosting at home using Oracle's VirtualBox, there are steps you can take to prevent double NAT (which can cause issues later on)

1. Select your VM and then click Settings in VirtualBox's main window.

2. Click on Network and change Attached To from NAT to Bridged Adapter.

Once you've done this, your VM should be connected directly to your home router and double NAT should no longer be a issue.

----

==== Starting Server Install ====

====Obtaining an ApiKey ====
(Not required unless hosting large amount of servers )

you can just comment this line out or remove it For your server to show up in the server list, there is now a requirement to have an ApiKey issued by vankrupt. This is to prevent DOS attacks against the master server

Get the key by going here: https://pavlov-ms.vankrupt.com/servers/v1/key and using your mobile number to get a SMS
(Note that there have been reported failures of this SMS system for non-US mobiles. In this case, DM davevillz your phone number and request a key)

Put this key in your Game.ini as follows:
ApiKey="ABC123FALSEKEYDONTUSEME"
or if you would like (personally untested..I would use Game.ini) you can call it at server runtime with flag as follows:
-KEY="ABC123FALSEKEYDONTUSEME"

This key can be re-used for a reasonable number of servers (a limit of 10 has been mentioned). Contact the Devs if you need more servers per key.

====System setup and software installation====

Install dependencies and create the `steam` user. (You only need to do this once):

Confirm Linux version
<pre>
lsb_release -a
</pre>

'''Ubuntu 20.04'''
'''''sudo apt update''''' && '''''sudo apt install''''' -y gdb curl lib32gcc1 libc++-dev unzip
sudo useradd -m steam
'''Ubuntu 20.10 or higher'''
sudo apt update && sudo apt install -y gdb curl lib32gcc-s1 libc++-dev unzip
sudo useradd -m steam
'''Rocky Linux, CentOS 8, and RHEL 8'''
sudo sed -i 's/^SELINUX=enforcing$/SELINUX=permissive/g' /etc/selinux/config
sudo setenforce 0
sudo yum install gdb curl glibc.i686 libstdc++.i686 libstdc++-devel.i686 libstdc++-devel.x86_64 unzip wget -y
wget <nowiki>https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/l/libcxx-3.8.0-3.el7.x86_64.rpm</nowiki>
sudo rpm -i libcxx-3.8.0-3.el7.x86_64.rpm
sudo useradd -m steam
[Optional] Set a password for steam.
<pre>sudo passwd steam</pre>

[Optional] Set the /bin/bash shell for the steam user this will allow you to use arrow keys in terminal and show what folder you are in at all times <pre>sudo chsh -s /bin/bash steam</pre>

Login as the Steam user. ('''You will need to do this each time you connect to your server'''):

<pre>
sudo su -l steam
</pre>

Install Steam:

<pre>
mkdir ~/Steam && cd ~/Steam && curl -sqL "https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz" | tar zxvf -
</pre>

There are different dedicated server versions for Pavlov Server - choose which server version you want to host (PC non-beta, PC Beta, Shack Live, or Shack RC)
(You will need to run this command each time there is a Pavlov Server update).

 
To host '''PC Server (non-beta)''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta default +exit

</pre>

To host '''PC BETA''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta beta_server +exit
</pre>

To host '''Shack Live''' (Quest):

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack +exit
</pre>

To host '''Shack RC''' (Quest): 

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack_beta +exit
</pre>

Now that we've installed the server, all pavlov server versions should continue. 
Install a fresh copy of steamclient.so (May have to do this after each update):
<pre>
~/Steam/steamcmd.sh +login anonymous +app_update 1007 +quit
mkdir -p ~/.steam/sdk64
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/pavlovserver/Pavlov/Binaries/Linux/steamclient.so
</pre>

The update 29 of the PCVR version of Pavlov and after added a requirement to run these commands to change the steamclient.so:
<code>sudo rm /usr/lib/x86_64-linux-gnu/libc++.so</code>
<code>sudo ln -s /usr/lib/x86_64-linux-gnu/libc++.so.1 /usr/lib/x86_64-linux-gnu/libc++.so</code>

Make the PavlovServer script executable. (You only need to do this once):

<pre>
chmod +x ~/pavlovserver/PavlovServer.sh
</pre>

----

=== Server Configuration ===

Before starting the server we need to configure it. Start by creating some directories:

<pre>
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Logs
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps
</pre>

==== Mods/Blacklist/Whitelist (optional) ====

The following three files allow you to specify mods, banned players, and whitelist players. These are optional, but go ahead and create them. Populating the files is described later.

<pre>
touch /home/steam/pavlovserver/Pavlov/Saved/Config/mods.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/blacklist.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/whitelist.txt
</pre>

====Configuring Game.ini====
Create a new Game.ini file using following command to open an editor and copy/paste the following block into it then save it. Note not all of these options are required. For instance remove or comment out the Password=0000 line to make a public server with no pin.
<pre>
nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini
</pre>

<pre>
[/Script/Pavlov.DedicatedServer]
bEnabled=true
ServerName="My_private_idaho"
MaxPlayers=10 #its recommended for the best experience to keep shack servers at or below 10 players pcvr and psvr are both capped at 24 too.
ApiKey="ABC123FALSEKEYDONTUSEME"
bSecured=true
bCustomServer=true
bVerboseLogging=false
bCompetitive=false #This only works for SND
bWhitelist=false
RefreshListTime=120
LimitedAmmoType=0
TickRate=90
TimeLimit=60
#Password=0000
#BalanceTableURL="vankruptgames/BalancingTable/main"
MapRotation=(MapId="UGC1758245796", GameMode="GUN")
MapRotation=(MapId="datacenter", GameMode="SND")
MapRotation=(MapId="sand", GameMode="DM")

</pre>

* '''bEnabled''' - whether the server appears in the server list (unconfirmed)
* '''ServerName''' - name it will be listed as. (approx 35 chars max)
* '''MaxPlayers''' - See suggested specs for limits. 10 standard (10 for shack), 20-24 is max recommended for large maps like Stalingrad or PUSH/RUSH modes, and servers allow a maximum of 24 players.
* '''ApiKey''' - Unique ApiKey required to register server with master server. Replace with your key
* '''bSecured''' - enabled Valve Anti-Cheat (VAC)
* '''bCustomServer''' - activates some new modding tools (save and http functions. Required to write to blacklist.txt for bans)
* '''bCompetitive''' - sets the server to competitive mode for SND. If removed the server will default to false
* '''bVerboseLogging''' - enables verbose logging, mostly detailed statistics. Be prepared for significant increase in logging.
* '''bWhitelist''' - Only allow users in whitelist.txt to join
* '''RefreshListTime''' - sets how often the running server checks for updates in ban/whitelist/mod files
* '''LimitedAmmoType''' - sets limited ammo mode, see Limited Ammo Types table below

* '''TimeLimit''' - sets time limit for each map
* '''TickRate''' - sets the server tickrate. (so far minimum stable seems around 50 and max around 120. Beware setting this changes weapon despawn time and breaks some game modes. Recommend not touching)
* '''Password''' - PIN number for server #FYI - this is now also changeable via rcon.
* '''BalanceTableURL''' - Points to a custom balance table from github. See https://github.com/vankruptgames/BalancingTable for instructions. This line isn't needed if you don't have one.
* '''MapRotation''' - you can add multiple of these. The map system has switched from the steam workshop to modio which means that the server rotation will need to be redone with modio UGCs. <nowiki>https://mod.io/g/pavlov</nowiki>. This is done by taking the resource ID from the modio page, adding “UGC” in front of it and then adding that to the rotation. For example the map gravity <nowiki>https://mod.io/g/pavlov/m/gravity1</nowiki> has a resource ID of 2773760 so the map ID to add to the server would be “UGC2773760”. When a match ends, the server will load the next map in the rotation.
* '''AFKTimeLimit''' There is now a feature to kick players who are idle in the game. Integers are measured in seconds and 0 disables AFK kicking completely.

Available game modes as of 09/06/2022: See Game modes table below

For maps running a Custom gamemode (CodZ, BR, Duel, etc.) it doesn't matter which gamemode you choose, as the map will automatically override it with the custom mode.

{| class="wikitable"
|+Limited Ammo Types
!AmmoType
!Name
!Description
|-
|0
|Unlimited
|Players have unlimited ammo, carry no ammo boxes and do not display an ammo count on the wrist.
|-
|1
|Limited Generic
|Players carry ammo boxes with a limited amount of ammo.
One box for each weapon class (Pistol, Submachine gun, Rifles/MGs, Shotgun, Sniper).

Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.

An ammo count is displayed on the wrist.
|-
|2
|Limited Specific
|Players carry ammo boxes with a limited amount of ammo.
One box for each weapon.

Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.

An ammo count is displayed on the wrist.
|-
|3
|Custom
|Allows for full control over ammo by the map.
|-
|4
| Limited Special
|'''All weapons except "special" weapons are unlimited, more clarification is needed.'''
|-
|5
|Boxless
|'''Like limited generic but without boxes? Clarification is needed.'''
|}
{| class="wikitable"
|+Game modes
!GameMode
!Name
|-
|DM
|Death match
|-
|KOTH
|King of the hill
|-
|GUN
| Gun game
|-
|OITC
| One in the chamber
|-
|SND
|Search and destroy
|-
|TANKTDM
|WW2 Team Death Match
|-
| TDM
|Team Death Match
|-
|TTT
|Trouble in Terrorist Town
|-
|TTTclassic
|TTT with only innocent/traitor/detective
|-
|WW2GUN
|WW2 gun game
|-
|ZWV
| Zombie wave survival
|-
|HIDE
|The Hidden
|-
|INFECTION
|Hidden infection
|-
|PUSH
|Push
|-
|PH
|Prop hunt
|}
= Default Map ID's =
datacenter

sand

bridge

containeryard

siberia (Prison Break)

hospital (Zombies map)

killhouse

range

tutorial

santorini

station

industry

ogcontainers (Shack only)

haguenau (Shack only)

foundation (Shack only)

stalingrad (PC only)

stalingrad_night (PC only)

santorini_night (PC only)

sand_night (PC only)

station_night (PC only)

industry_night (PC only)

bunker (PC only)

==== Firewall/Port forwarding ====
Using the default settings there are two UDP ports (7777, 8177) that need to be allowed to access the server either by firewall setup or port forwarding.

'''Ubuntu''' firewall commands to check firewall and open ports:
<pre>
sudo ufw status
sudo ufw allow 7777
sudo ufw allow 8177
sudo ufw allow 9100
sudo ufw status
</pre>

'''Rocky Linux''' firewall commands to check the firewall and open ports:
<pre>
sudo firewall-cmd --zone=public --add-port=7777/tcp
sudo firewall-cmd --zone=public --add-port=7777/udp
sudo firewall-cmd --zone=public --add-port=8177/tcp
sudo firewall-cmd --zone=public --add-port=8177/udp
sudo firewall-cmd --zone=public --add-port=9100/udp
sudo firewall-cmd --zone=public --add-port=9100/tcp
sudo firewall-cmd --list-ports
firewall-cmd --runtime-to-permanent
</pre>

You may also need to allow Pings (ICMP) for the server's true latency to appear in the master list.

If you are running multiple servers and have set additional ports (see http://pavlovwiki.com/index.php/Setting_up_a_dedicated_server#Running_multiple_servers_on_one_host) then you need to allow access to the defined port plus the port 400 higher. So if you use 7000 as your port, then UDP 7000 and 7400 need to be open

If you have setup rcon via RconSettings.txt (below) then that port also needs to be allowed access via TCP

If you are running Shack/Quest and want to have maps that are downloadable from your server, your server ports (ex. 7777 & 8177) must also be open via TCP

----

==== Shack Maps (Quest) ====

If you try to use the steps above to add maps for Shack, you'll run into issues very quickly. This is because Shack has no affiliation with Steam, and therefore cannot use Steam Workshop maps like the above. In the future, these steps will apply to PC servers as well, allowing a server to hold the map itself, instead of offloading it to Steam.

To get started, first, create the directory to hold the maps

<pre>mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps</pre>

You can use any number of methods to move the map files onto the server, but I'll go over the two simplest, starting with a GUI approach

Download and install Cyberduck onto your "home" PC (Whatever PC you use for access to the server, but not the server itself): https://cyberduck.io/

Next, download and unzip your map of choice from https://www.pavlovquest.com/ , https://pavlovhorde.com/mapsList, or look in #shack-map-showcase channel in the discord server. I'm going to use Cheeto's WW2 Items test (http://www.mediafire.com/file/emyt9bs1z9u9ykw/SVR_Cheeto_Items.zip/file ) for this example, you do what you like

In the top left corner, open a connection, set the connection type to SFTP, and fill in the rest of the information. The username is typically `root`, password is whatever you set the root pw as (toor in Ubuntu by default)

In the directory dropdown (it will say /root) go back to /

Follow the directories until we arrive back at our "maps" folder <pre>/home/steam/pavlovserver/Pavlov/Saved/maps</pre>

Drag and drop the unzipped map folder into the main window, in this case itll be SVR_Cheeto_Items

Hit Allow

You'll now see a folder named SVR_Cheeto_Items, and within it should be nothing but 3 files. If there is another folder in it, move this folder to the maps directory, otherwise the server won't work. The 3 files (2 .PAK one .JSON) should be in home/steam/pavlovserver/Pavlov/Saved/maps/SVR_Cheeto_Items, no more, no less.

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

To play the map, you can either use RCON switch map command, or to add the map to your server's automatic map rotation list, add the map's folder name to your Game.ini. This replaces the MapID section, so for our example, it would be

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

And that's all! Disconnect CyberDuck from your server before playing, otherwise you'll have difficulty joining.

-----------

==== Adding Shack Maps over Command Line Interface ====

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

A bit more complicated, but adding maps over CLI has its benefits

First, CD to the maps directory you made above

<pre>cd ~/pavlovserver/Pavlov/Saved/maps</pre>

Download the map files from whatever you use to upload them. To do this, you can either use curl or wget

<pre>curl -O insertURLhere</pre>

'''If you download your map from Google Drive''', make sure that your .zip folder is shared with anyone.
Then, get the file's URL from the shared link. Example : ''<nowiki>https://drive.google.com/file/d/19bI8gUHaN5tUrDvnadAacUnchQf6_k/view</nowiki>'' will be ''19bI8gUHaN5tUrDvnadAacUnchQf6_k''
Edit "fileId" and "fileName" before you execute the command.
<pre>
fileId=19bI8gUHaN5tUrDvnadAacUnchQf6_k
fileName=SVR_USER_MAPNAME
curl -sc /tmp/cookie "https://drive.google.com/uc?export=download&id=${fileId}" > /dev/null
code="$(awk '/_warning_/ {print $NF}' /tmp/cookie)"
curl -Lb /tmp/cookie "https://drive.google.com/uc?export=download&confirm=${code}&id=${fileId}" -o ${fileName} </pre>

To keep with the Items example:

<pre>curl -O https://cdn.discordapp.com/attachments/744185280759857234/745027406695366788/SVR_Cheeto_Items.zip</pre>

Next, unzip the file. If this next step errors out, saying the command is unknown, switch back to the root user (su root), and install unzip (sudo apt install unzip), then return to the steam user, and continue.

<pre>unzip SVR_Cheeto_Items.zip</pre>

Now finish like before by adding the map to your Game.ini

<pre>nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini</pre>

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

==== Admin/Moderator list (optional) ====

The only working in-game admin menu is through Arctic VR server hosting (see below).

If you add moderators to your server, they will not be subject to vote kicks.

<pre>
nano ~/pavlovserver/Pavlov/Saved/Config/mods.txt
</pre>

Example Mod List:
<pre>
76541198397498572 #Optional Comment: Player name
76541198397498573 #Some Other Player
</pre>

==== ArcticVR Admin Menu ====

[[File:Arcticmenu.jpg|500px|link=https://www.arctic-vr.com/server-admin-menu]]

Arctic-VR Offers an advanced In-Game Admin menu that is exclusive to their hosting service. Features include:
* Switch Maps+Modes
* Teleport Players to Players
* Change Player Skins
* Control Player Buying+Cash
* Spawn Items
* Clean up corpses + guns
* Spawn Bots
* Spawn Items for other players
* Control Teams + Balance/Shuffle Teams
* ResetSND
* And More

You can read more about the ArcticVR admin menu on their website: https://www.arctic-vr.com/server-admin-menu

==== Handy tools for finding steamIDs ====

Steam ID finder: https://steamidfinder.com/lookup/ or https://steamid.xyz/

You want to enter in the steamID64 format.

This tool can convert or lookup IDs: https://steamid.io/

If you are looking for a steamID of a player that has been on your server recently this is technique to find them:
<pre>
grep -i playername ~/pavlovserver/Pavlov/Saved/Logs/* | grep TicketValidation
</pre>

=== Configure Rcon ===
To enable Rcon access create config file:
<pre> nano /home/steam/pavlovserver/Pavlov/Saved/Config/RconSettings.txt </pre>

Copy in the following text - change password, and if desired the port:
<pre>
Password=ChangeThisPassword
Port=9100
</pre>
You must specify a port for the Rcon server to use as well as a Password (use a different port per sever instance if running multiple server instances off the same hardware)

=== Starting the server ===

<pre>
cd ~/pavlovserver && ./PavlovServer.sh
</pre>

That's it, your server will be automatically broadcast to the master server! :)

Two handy tools to determine quickly if your server is broadcasting are [https://pablub.xyz/ Pablub] (PC only) and [https://pavlovhorde.com/ Horde] (Shack) and [https://pavlovhorde.com/pcServers Horde] (PC version)

Note that when you close your terminal, the server will go down. See the "supervisors" section below for how to prevent this.

----

=== Supervising the server using systemd ===

Running '''./PavlovServer.sh''' in your interactive shell is easy, but the server will shut down when you close your terminal. If you want to run the server in the background,
you'll want to run it under a supervisor. There are many options, ranging from the simple (nohup, screen or tmux), to the
more robust (supervisord, systemd).

Systemd is running by default on Ubuntu Linux, so we'll use that here.

To run the server as a systemd service, create the file '''/etc/systemd/system/pavlovserver.service''' (as root) by typing
<pre>
sudo nano /etc/systemd/system/pavlovserver.service
</pre>

Copy the contents below into the file and save.

<pre>
[Unit]
Description=Pavlov VR dedicated server

[Service]
Type=simple
WorkingDirectory=/home/steam/pavlovserver
ExecStart=/home/steam/pavlovserver/PavlovServer.sh

RestartSec=1
Restart=always
User=steam
Group=steam

[Install]
WantedBy = multi-user.target
</pre>

If you'd like your server to start as competitive without editing the game.ini, change the line "ExecStart=/home/steam/pavlovserver/PavlovServer.sh" to look like this below. Though it's much easier to just use the game.ini to enable competitive instead. <pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -COMPETITIVE=1</pre>

Change the user or paths as appropriate. After saving the service file, to start, restart, stop, or monitor the server:

<pre>
sudo systemctl start pavlovserver
sudo systemctl restart pavlovserver
sudo systemctl stop pavlovserver
sudo systemctl status pavlovserver
</pre>

To view the logs:

<pre>
sudo journalctl -u pavlovserver
# to live-tail the logs
sudo journalctl -u pavlovserver -f
</pre>

If you want to run the pavlov server as soon as your server boots (e.g. a VPS you turn on and off), add pavlov as a startup service:

<pre>
sudo systemctl enable pavlovserver
</pre>

----

== Advanced Server Administration ==

=== Running multiple servers on one host ===

* Pavlovserver is functionally single-threaded (there are multiple threads, but the vast majority of work occurs in the primary one). Make sure you have # of pavlovservers + 1 CPU available. More CPUs= more servers. Faster CPU = more players.
* Make multiple server installs by defining a separate install dir for each server.
* Run each server with a unique port. eg: '''./PavlovServer.sh -PORT="Desired Port"'''
* The Server will use the Desired Port and the Port 400 above (Example: You choose 8200 as Port. So Port 8600 will be used as well)
* If you are using RCON, each server will need a unique port defined in RconSettings.txt
* Ensure the ports are forwarded and opened in your firewall

To duplicate directories:

be in the steam home folder
<pre>
cp -r pavlovserver pavlovserver1
/home/steam/pavlovserver1/PavlovServer.sh -PORT=[Desired Port]
</pre>

=== Starting server in competitive mode ===
Competitive mode will prevent dead teammates from being able to see the match, to prevent ghosting.
You can either enable this via Game.ini (described in Game.ini file), or using the -COMPETITIVE=1 parameter.

<pre>
/home/steam/pavlovserver1/PavlovServer.sh -COMPETITIVE=1
</pre>

{| class="wikitable"

|}

=== Useful Linux Commands ===
List files / folders in directory, print current working directory,
<pre>ls -la #list files/directories along with authorities and ownership
pwd #print working directory
sudo chown <owner> <file/directory> #change owner of file/directory. If root created something and you need to change it to steam
sudo chgrp <group> <file/directory> #change group of file/directory.
</pre>

Check if pavlov is running by checking process status. If the only row you see is the grep command, pavlov server is not started.
<pre> ps -ef | grep pav </pre>

Sample output:
<pre>
steam 34044 1 0 16:52 ? 00:00:00 /bin/sh /home/steam/pavlovserver/PavlovServer.sh
steam 34066 34044 80 16:52 ? 00:00:04 /home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer
zombies+ 34101 34013 0 16:52 pts/0 00:00:00 grep --color=auto pav
</pre>

Kill a process. Note this command uses 34044, which is a process id from the command output above.
<pre> kill -9 34044 </pre>

Dump the log to the console so you can scroll through it:
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log </pre>

Search the log for a string - replace my_string with case-sensitive string
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep my_string </pre>

<hr>

== Advanced Scripts For Server Management ==
<hr>

=== '''Auto-updating the server (PCVR only)''' ===
Assuming you have followed this guide and used the default paths, users, and install instructions, you can paste the following into your terminal to auto-update your Pavlov server:

<pre>
cat << 'EOF' > $HOME/pavlov_daily_update_and_restart.sh
#!/bin/bash

USER="steam"
SERVICENAME="pavlovserver.service"
INSTALLDIRNAME="pavlovserver"
USERHOME="/home/$USER"

echo -e "Beginning Pavlov VR update run on $(date)\n\n"

systemctl stop "$SERVICENAME"

sleep 5
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +force_install_dir "$USERHOME/$INSTALLDIRNAME" +app_update 622970 +exit
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +app_update 1007 +quit
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/.steam/sdk64/steamclient.so"
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/pavlovserver/Pavlov/Binaries/Linux/steamclient.so"

systemctl start "$SERVICENAME"

echo -e "Ending Pavlov VR update run on $(date)\n\n"

EOF

chmod +x $HOME/pavlov_daily_update_and_restart.sh
mkdir $HOME/pavlov_update_logs && touch $HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log
CRONLINE="00 2 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
(sudo crontab -u root -l; echo "$CRONLINE" ) | sudo crontab -u root -
unset CRONLINE

</pre>

These commands will:

1. Create a shell script in the "steam" user's home directory that automatically stops the Pavlov server, pulls any updates via steam, pull updates to the Steamworks SDK Redist, and copies the latest version of steamclient.so to the Pavlov server directory

2. Make the shell script executable

3. Create a new directory called "pavlov_update_logs" in the "steam" user's directory, and create a logfile inside that directory called "pavlov_daily_update_and_restart.sh.log". You can check this logfile to see the output of the Pavlov and Steam SDK update commands.

4. Create a crontab entry for the root user that runs this shell script automatically every day at 2:00AM local time

If you want to change the time that this script runs, edit the numbers "00 2" in the line that starts with "CRONLINE=". In the example provided, 00 is the minutes column, and 2 is the hour column. For example, if you wanted the server to automatically update and restart at 4:17AM every day, change the line starting with "CRONLINE=" to:

<pre>
CRONLINE="17 4 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
</pre>

If the time is PM, use 24-hour time format, e.g. "32 18" for 6:32PM.
<hr>
=== '''Save Logs for records and stats''' ===
this is an automated script that will on a timer save all the backups made by the server before they are purged by the game for admin records and starts collection

https://github.com/JTWP-org/backUpLogs2
<hr>

=== '''Make an API request with Mod.io to get map picture and name''' ===
very basic script pass the script a map ID as an argument then it will give u the name and a thumbnail to use

https://github.com/JTWP-org/mod.io-modcheck/tree/main

=== '''Sharing Bans over gameserver on same machine''' ===
when you have a lot of servers keeping the bans synced can be a nightmare so using a symbolic link allows all the servers to use one file

for this lets say I have pavlovserver000 and pavlovserver001 and they are located at /home/steam/pavlovserver000 and /home/steam/pavlovserver001

''step 1 will be to pick a blacklist to use as the new one and move it to a central location''
mkdir ~/shared ; mv /home/steam/pavlovserver000/Pavlov/Saved/Config/blacklist.txt ~/shared/blacklist.txt ; rm /home/steam/pavlovserver001/Pavlov/Saved/Config/blacklist.txt
now we have moved the blacklist from pavlovserver000 to a folder in our home called shared and then we removed the blacklist from pavlovserver001

step 2 making the links
ln -s ~/shared/blacklist.txt /home/steam/pavlovserver000/Pavlov/Saved/Config/blacklist.txt ; ln -s ~/shared/blacklist.txt /home/steam/pavlovserver001/Pavlov/Saved/Config/blacklist.txt
now editing them in pavlovserver001's files will update the list for all of the servers it's not a sync its uses the same list if you want to check where a link is pointed if u
ls -l
It will show where the file is really located <hr>
=== Interactive Update ALL ===
will find all server installs on machine and update them will update Ubuntu check what version and do correct updates for that version also UPDATE 29 PCVR STEP then it will list each server by server name and ask what type it is and then it will update and move to the next

https://github.com/JTWP-org/Pavlov-updateallservers/tree/main<hr>

=== getting map info with just the UGC ===

you will need to get a API key from mod.io for this ... running this bash script and passing a UGC number to it will return the map name mod.io url and a thumbnail

HOW TO USE <pre>nano get-map.sh</pre>

then enter this script <pre>#!/bin/bash

ugc=000000

gameID=3959 #PAVLOV IS 3959

api-path="https://u-*ID NUMBER*.modapi.io/v1" #get on thhe access tab in mod.io settings

api-key="" #get on thhe access tab in mod.io settings

curl -X GET "${api-path}/v1/games/${gameID}/mods/$("${ugc:3})?api_key=${api-key}" -H 'Accept: application/json' | jq '.logo.thumb_1280x720, .name , .profile_url</pre>

then give script perms to run <pre>sudo chmod +x get-map.sh</pre>

and then run it like this
<pre>bash get-map.sh UGC3409480 </pre>

Setting up a dedicated server

2023-11-20T23:58:11Z

SaltedCrackerJack: /* Interactive Update ALL */

== Setting up a dedicated server ==

'''There are no Windows binaries'''

This guide is written exclusively for Linux and covers Ubuntu/Debian/Debian-like and Red Hat RPM-based distros. Possible to run with other distros, but some of the commands won't work and you will need to know enough to figure out the software install of dependencies on your own.

If you are considering hosting from home, please read that section of the wiki first.

This guide assumes you know the basics of using a bash terminal: ssh'ing into a server, running bash commands, editing text files, etc.

If you have no experience using bash, maybe start [https://www.howtogeek.com/140679/beginner-geek-how-to-start-using-the-linux-terminal/ here]. Editing text files via commandline is often a challenge. Suggest using nano and reading guide [https://www.howtogeek.com/howto/42980/the-beginners-guide-to-nano-the-linux-command-line-text-editor/ here]

If you are new to linux and accessing your server from Windows, highly suggest using MobaXterm as your SSH client as that can make required editing of text files easier using built in editor instead of the native linux command line editors.

And finally, ask yourself why you want to setup a server? If you look at the list, there are many, many more servers than players. If you don't have a team, discord community, or group of friends ready to play on your server, chances are it will go unused. Got one of these... great, let's go.

If you don't want to go through the hassle yourself and want to pay for a hosting service Arctic VR (PC and Shack) and Horde (Shack) provide a server hosting services and are trusted in the community. See links below.

----

=== Server Requirements ===

'''Pavlovserver can only be hosted under Linux.'''

This can be running as a VM under windows, but this will increase the complexity of the setup beyond this guide.

Ubuntu 18.04 x86_64, Ubuntu 19/04 amd64, Ubuntu 20.04, and Rocky Linux 8 are confirmed working. Ubuntu 15.04 x86 is known to fail to install using this guide. Recommend not running on "minimal" images as some tools are missing.

* 2GB RAM + 1GB RAM per each additional server with 10 players. More RAM is recommended for larger maps, higher player counts, or complex gamemodes. Not having enough RAM is a common cause of server crashes.

* A ~2.5Ghz CPU will comfortably support a 10 player server.

* A ~4Ghz CPU will comfortably support 24 players. This is a limit built into Pavlov itself, no server will allow players to join over 24. Lower player counts are recommended for complex gamemodes (E.g. CodZ) and/or highly detailed maps, so that maximum number will often be lower.

(Note that these are '''not''' hard limits for player counts, just suggestions for the best performance, based on experiences with many server providers on different grades of hardware.)

* Pavlovserver is functionally single threaded (one thread does vast majority of work). More CPUs only help if you are running more servers. More clockspeed = higher performance = more users per server.
The maximum number of servers you can run is dependent on how many CPUs you have. For example, if you have an 8 core CPU, the maximum number of servers would be 7. You should always have at least one CPU free as overhead, as Pavlov servers can use slightly more than one thread.

----

==== Hosting at home ====
When hosting at home there are additional requirements regarding networking: Your router has to support port-forwarding, hair-pinning/LoopbackNAT, and respond to ping requests. These techniques are necessary to allow your server to be found and to talk back to the client. please see https://en.wikipedia.org/wiki/Port_forwarding, https://en.wikipedia.org/wiki/Hairpinning, and https://www.speedguide.net/faq/how-to-become-pingable-behind-a-routerfirewall-376 for more info and google for these terms in addition to your router model to find guides on how to enable/configure it properly. If you have modern Router, it may have these features already enabled, in this case you just have to configure port-forwarding. If you can see your server but not join it while others can, this is indicative of a failure of LoopbackNAT.

A second challenge to hosting at home is CGNAT (Carrier grade NAT: https://www.a10networks.com/blog/carrier-grade-nat/). Just like NAT on your home network that has to be gotten around w/ port-forwarding, CGNAT breaks the ability of external connections to be made back to your server, but the controls are solely in your ISPs hands. Sometimes if you ask, you can be removed from CGNAT pools and/or assigned a static IP. CGNAT rollouts are becoming very common now, so if your server worked then doesn't allow connections now, your ISP may have made this change.

You can check whether you’re on a CGNAT network by visiting a Web site such as ipaddress.com or whatsmyip.com and comparing the IP address listed to the public/WAN IP address assigned to your Internet gateway. To find your gateway’s public IP address, check the status page in the administrative interface. If the two IP addresses differ, you’re likely on a CGNAT network. If so, this problem must be resolved before you go any further.

'''Not understanding these requirements and configuration is a frequent cause of failed setups and questions in discord. Don't skip this if you are trying to host from home'''

'''There are serious security implications of hosting this software at home.''' None of the devs are security experts and there has been no security review of the code. You are opening up your system to the world and publicity advertising this fact. Expect that any system hosting this software is open to compromise from the Internet and act accordingly. If your router offers a DMZ network, use it. Consider hosting on a cloud based server and think twice before running this software on any system that contains data you care about or has access to networks and computers you care about.

If you're hosting at home using Oracle's VirtualBox, there are steps you can take to prevent double NAT (which can cause issues later on)

1. Select your VM and then click Settings in VirtualBox's main window.

2. Click on Network and change Attached To from NAT to Bridged Adapter.

Once you've done this, your VM should be connected directly to your home router and double NAT should no longer be a issue.

----

==== Starting Server Install ====

====Obtaining an ApiKey ====
(Not required unless hosting large amount of servers )

you can just comment this line out or remove it For your server to show up in the server list, there is now a requirement to have an ApiKey issued by vankrupt. This is to prevent DOS attacks against the master server

Get the key by going here: https://pavlov-ms.vankrupt.com/servers/v1/key and using your mobile number to get a SMS
(Note that there have been reported failures of this SMS system for non-US mobiles. In this case, DM davevillz your phone number and request a key)

Put this key in your Game.ini as follows:
ApiKey="ABC123FALSEKEYDONTUSEME"
or if you would like (personally untested..I would use Game.ini) you can call it at server runtime with flag as follows:
-KEY="ABC123FALSEKEYDONTUSEME"

This key can be re-used for a reasonable number of servers (a limit of 10 has been mentioned). Contact the Devs if you need more servers per key.

====System setup and software installation====

Install dependencies and create the `steam` user. (You only need to do this once):

Confirm Linux version
<pre>
lsb_release -a
</pre>

'''Ubuntu 20.04'''
'''''sudo apt update''''' && '''''sudo apt install''''' -y gdb curl lib32gcc1 libc++-dev unzip
sudo useradd -m steam
'''Ubuntu 20.10 or higher'''
sudo apt update && sudo apt install -y gdb curl lib32gcc-s1 libc++-dev unzip
sudo useradd -m steam
'''Rocky Linux, CentOS 8, and RHEL 8'''
sudo sed -i 's/^SELINUX=enforcing$/SELINUX=permissive/g' /etc/selinux/config
sudo setenforce 0
sudo yum install gdb curl glibc.i686 libstdc++.i686 libstdc++-devel.i686 libstdc++-devel.x86_64 unzip wget -y
wget <nowiki>https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/l/libcxx-3.8.0-3.el7.x86_64.rpm</nowiki>
sudo rpm -i libcxx-3.8.0-3.el7.x86_64.rpm
sudo useradd -m steam
[Optional] Set a password for steam.
<pre>sudo passwd steam</pre>

[Optional] Set the /bin/bash shell for the steam user this will allow you to use arrow keys in terminal and show what folder you are in at all times <pre>sudo chsh -s /bin/bash steam</pre>

Login as the Steam user. ('''You will need to do this each time you connect to your server'''):

<pre>
sudo su -l steam
</pre>

Install Steam:

<pre>
mkdir ~/Steam && cd ~/Steam && curl -sqL "https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz" | tar zxvf -
</pre>

There are different dedicated server versions for Pavlov Server - choose which server version you want to host (PC non-beta, PC Beta, Shack Live, or Shack RC)
(You will need to run this command each time there is a Pavlov Server update).

 
To host '''PC Server (non-beta)''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta default +exit

</pre>

To host '''PC BETA''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta beta_server +exit
</pre>

To host '''Shack Live''' (Quest):

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack +exit
</pre>

To host '''Shack RC''' (Quest): 

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack_beta +exit
</pre>

Now that we've installed the server, all pavlov server versions should continue. 
Install a fresh copy of steamclient.so (May have to do this after each update):
<pre>
~/Steam/steamcmd.sh +login anonymous +app_update 1007 +quit
mkdir -p ~/.steam/sdk64
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/pavlovserver/Pavlov/Binaries/Linux/steamclient.so
</pre>

The update 29 of the PCVR version of Pavlov and after added a requirement to run these commands to change the steamclient.so:
<code>sudo rm /usr/lib/x86_64-linux-gnu/libc++.so</code>
<code>sudo ln -s /usr/lib/x86_64-linux-gnu/libc++.so.1 /usr/lib/x86_64-linux-gnu/libc++.so</code>

Make the PavlovServer script executable. (You only need to do this once):

<pre>
chmod +x ~/pavlovserver/PavlovServer.sh
</pre>

----

=== Server Configuration ===

Before starting the server we need to configure it. Start by creating some directories:

<pre>
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Logs
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps
</pre>

==== Mods/Blacklist/Whitelist (optional) ====

The following three files allow you to specify mods, banned players, and whitelist players. These are optional, but go ahead and create them. Populating the files is described later.

<pre>
touch /home/steam/pavlovserver/Pavlov/Saved/Config/mods.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/blacklist.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/whitelist.txt
</pre>

====Configuring Game.ini====
Create a new Game.ini file using following command to open an editor and copy/paste the following block into it then save it. Note not all of these options are required. For instance remove or comment out the Password=0000 line to make a public server with no pin.
<pre>
nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini
</pre>

<pre>
[/Script/Pavlov.DedicatedServer]
bEnabled=true
ServerName="My_private_idaho"
MaxPlayers=10 #Set this to 10 for Shack. 24 is the max for PC, setting it higher will not allow players to join.
ApiKey="ABC123FALSEKEYDONTUSEME"
bSecured=true
bCustomServer=true
bVerboseLogging=false
bCompetitive=false #This only works for SND
bWhitelist=false
RefreshListTime=120
LimitedAmmoType=0
TickRate=90
TimeLimit=60
#Password=0000
#BalanceTableURL="vankruptgames/BalancingTable/main"
MapRotation=(MapId="UGC1758245796", GameMode="GUN")
MapRotation=(MapId="datacenter", GameMode="SND")
MapRotation=(MapId="sand", GameMode="DM")

</pre>

* '''bEnabled''' - whether the server appears in the server list (unconfirmed)
* '''ServerName''' - name it will be listed as. (approx 35 chars max)
* '''MaxPlayers''' - See suggested specs for limits. 10 standard (10 for shack), 20-24 is max recommended for large maps like Stalingrad or PUSH/RUSH modes, and servers allow a maximum of 24 players.
* '''ApiKey''' - Unique ApiKey required to register server with master server. Replace with your key
* '''bSecured''' - enabled Valve Anti-Cheat (VAC)
* '''bCustomServer''' - activates some new modding tools (save and http functions. Required to write to blacklist.txt for bans)
* '''bCompetitive''' - sets the server to competitive mode for SND. If removed the server will default to false
* '''bVerboseLogging''' - enables verbose logging, mostly detailed statistics. Be prepared for significant increase in logging.
* '''bWhitelist''' - Only allow users in whitelist.txt to join
* '''RefreshListTime''' - sets how often the running server checks for updates in ban/whitelist/mod files
* '''LimitedAmmoType''' - sets limited ammo mode, see Limited Ammo Types table below

* '''TimeLimit''' - sets time limit for each map
* '''TickRate''' - sets the server tickrate. (so far minimum stable seems around 50 and max around 120. Beware setting this changes weapon despawn time and breaks some game modes. Recommend not touching)
* '''Password''' - PIN number for server #FYI - this is now also changeable via rcon.
* '''BalanceTableURL''' - Points to a custom balance table from github. See https://github.com/vankruptgames/BalancingTable for instructions. This line isn't needed if you don't have one.
* '''MapRotation''' - you can add multiple of these. The map system has switched from the steam workshop to modio which means that the server rotation will need to be redone with modio UGCs. <nowiki>https://mod.io/g/pavlov</nowiki>. This is done by taking the resource ID from the modio page, adding “UGC” in front of it and then adding that to the rotation. For example the map gravity <nowiki>https://mod.io/g/pavlov/m/gravity1</nowiki> has a resource ID of 2773760 so the map ID to add to the server would be “UGC2773760”. When a match ends, the server will load the next map in the rotation.
* '''AFKTimeLimit''' There is now a feature to kick players who are idle in the game. Integers are measured in seconds and 0 disables AFK kicking completely.

Available game modes as of 09/06/2022: See Game modes table below

For maps running a Custom gamemode (CodZ, BR, Duel, etc.) it doesn't matter which gamemode you choose, as the map will automatically override it with the custom mode.

{| class="wikitable"
|+Limited Ammo Types
!AmmoType
!Name
!Description
|-
|0
|Unlimited
|Players have unlimited ammo, carry no ammo boxes and do not display an ammo count on the wrist.
|-
|1
|Limited Generic
|Players carry ammo boxes with a limited amount of ammo.
One box for each weapon class (Pistol, Submachine gun, Rifles/MGs, Shotgun, Sniper).

Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.

An ammo count is displayed on the wrist.
|-
|2
|Limited Specific
|Players carry ammo boxes with a limited amount of ammo.
One box for each weapon.

Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.

An ammo count is displayed on the wrist.
|-
|3
|Custom
|Allows for full control over ammo by the map.
|-
|4
| Limited Special
|'''All weapons except "special" weapons are unlimited, more clarification is needed.'''
|-
|5
|Boxless
|'''Like limited generic but without boxes? Clarification is needed.'''
|}
{| class="wikitable"
|+Game modes
!GameMode
!Name
|-
|DM
|Death match
|-
|KOTH
|King of the hill
|-
|GUN
| Gun game
|-
|OITC
| One in the chamber
|-
|SND
|Search and destroy
|-
|TANKTDM
|WW2 Team Death Match
|-
| TDM
|Team Death Match
|-
|TTT
|Trouble in Terrorist Town
|-
|TTTclassic
|TTT with only innocent/traitor/detective
|-
|WW2GUN
|WW2 gun game
|-
|ZWV
| Zombie wave survival
|-
|HIDE
|The Hidden
|-
|INFECTION
|Hidden infection
|-
|PUSH
|Push
|-
|PH
|Prop hunt
|}
= Default Map ID's =
datacenter

sand

bridge

containeryard

siberia (Prison Break)

hospital (Zombies map)

killhouse

range

tutorial

santorini

station

industry

ogcontainers (Shack only)

haguenau (Shack only)

foundation (Shack only)

stalingrad (PC only)

stalingrad_night (PC only)

santorini_night (PC only)

sand_night (PC only)

station_night (PC only)

industry_night (PC only)

bunker (PC only)

==== Firewall/Port forwarding ====
Using the default settings there are two UDP ports (7777, 8177) that need to be allowed to access the server either by firewall setup or port forwarding.

'''Ubuntu''' firewall commands to check firewall and open ports:
<pre>
sudo ufw status
sudo ufw allow 7777
sudo ufw allow 8177
sudo ufw allow 9100
sudo ufw status
</pre>

'''Rocky Linux''' firewall commands to check the firewall and open ports:
<pre>
sudo firewall-cmd --zone=public --add-port=7777/tcp
sudo firewall-cmd --zone=public --add-port=7777/udp
sudo firewall-cmd --zone=public --add-port=8177/tcp
sudo firewall-cmd --zone=public --add-port=8177/udp
sudo firewall-cmd --zone=public --add-port=9100/udp
sudo firewall-cmd --zone=public --add-port=9100/tcp
sudo firewall-cmd --list-ports
firewall-cmd --runtime-to-permanent
</pre>

You may also need to allow Pings (ICMP) for the server's true latency to appear in the master list.

If you are running multiple servers and have set additional ports (see http://pavlovwiki.com/index.php/Setting_up_a_dedicated_server#Running_multiple_servers_on_one_host) then you need to allow access to the defined port plus the port 400 higher. So if you use 7000 as your port, then UDP 7000 and 7400 need to be open

If you have setup rcon via RconSettings.txt (below) then that port also needs to be allowed access via TCP

If you are running Shack/Quest and want to have maps that are downloadable from your server, your server ports (ex. 7777 & 8177) must also be open via TCP

----

==== Shack Maps (Quest) ====

If you try to use the steps above to add maps for Shack, you'll run into issues very quickly. This is because Shack has no affiliation with Steam, and therefore cannot use Steam Workshop maps like the above. In the future, these steps will apply to PC servers as well, allowing a server to hold the map itself, instead of offloading it to Steam.

To get started, first, create the directory to hold the maps

<pre>mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps</pre>

You can use any number of methods to move the map files onto the server, but I'll go over the two simplest, starting with a GUI approach

Download and install Cyberduck onto your "home" PC (Whatever PC you use for access to the server, but not the server itself): https://cyberduck.io/

Next, download and unzip your map of choice from https://www.pavlovquest.com/ , https://pavlovhorde.com/mapsList, or look in #shack-map-showcase channel in the discord server. I'm going to use Cheeto's WW2 Items test (http://www.mediafire.com/file/emyt9bs1z9u9ykw/SVR_Cheeto_Items.zip/file ) for this example, you do what you like

In the top left corner, open a connection, set the connection type to SFTP, and fill in the rest of the information. The username is typically `root`, password is whatever you set the root pw as (toor in Ubuntu by default)

In the directory dropdown (it will say /root) go back to /

Follow the directories until we arrive back at our "maps" folder <pre>/home/steam/pavlovserver/Pavlov/Saved/maps</pre>

Drag and drop the unzipped map folder into the main window, in this case itll be SVR_Cheeto_Items

Hit Allow

You'll now see a folder named SVR_Cheeto_Items, and within it should be nothing but 3 files. If there is another folder in it, move this folder to the maps directory, otherwise the server won't work. The 3 files (2 .PAK one .JSON) should be in home/steam/pavlovserver/Pavlov/Saved/maps/SVR_Cheeto_Items, no more, no less.

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

To play the map, you can either use RCON switch map command, or to add the map to your server's automatic map rotation list, add the map's folder name to your Game.ini. This replaces the MapID section, so for our example, it would be

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

And that's all! Disconnect CyberDuck from your server before playing, otherwise you'll have difficulty joining.

-----------

==== Adding Shack Maps over Command Line Interface ====

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

A bit more complicated, but adding maps over CLI has its benefits

First, CD to the maps directory you made above

<pre>cd ~/pavlovserver/Pavlov/Saved/maps</pre>

Download the map files from whatever you use to upload them. To do this, you can either use curl or wget

<pre>curl -O insertURLhere</pre>

'''If you download your map from Google Drive''', make sure that your .zip folder is shared with anyone.
Then, get the file's URL from the shared link. Example : ''<nowiki>https://drive.google.com/file/d/19bI8gUHaN5tUrDvnadAacUnchQf6_k/view</nowiki>'' will be ''19bI8gUHaN5tUrDvnadAacUnchQf6_k''
Edit "fileId" and "fileName" before you execute the command.
<pre>
fileId=19bI8gUHaN5tUrDvnadAacUnchQf6_k
fileName=SVR_USER_MAPNAME
curl -sc /tmp/cookie "https://drive.google.com/uc?export=download&id=${fileId}" > /dev/null
code="$(awk '/_warning_/ {print $NF}' /tmp/cookie)"
curl -Lb /tmp/cookie "https://drive.google.com/uc?export=download&confirm=${code}&id=${fileId}" -o ${fileName} </pre>

To keep with the Items example:

<pre>curl -O https://cdn.discordapp.com/attachments/744185280759857234/745027406695366788/SVR_Cheeto_Items.zip</pre>

Next, unzip the file. If this next step errors out, saying the command is unknown, switch back to the root user (su root), and install unzip (sudo apt install unzip), then return to the steam user, and continue.

<pre>unzip SVR_Cheeto_Items.zip</pre>

Now finish like before by adding the map to your Game.ini

<pre>nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini</pre>

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

==== Admin/Moderator list (optional) ====

The only working in-game admin menu is through Arctic VR server hosting (see below).

If you add moderators to your server, they will not be subject to vote kicks.

<pre>
nano ~/pavlovserver/Pavlov/Saved/Config/mods.txt
</pre>

Example Mod List:
<pre>
76541198397498572 #Optional Comment: Player name
76541198397498573 #Some Other Player
</pre>

==== ArcticVR Admin Menu ====

[[File:Arcticmenu.jpg|500px|link=https://www.arctic-vr.com/server-admin-menu]]

Arctic-VR Offers an advanced In-Game Admin menu that is exclusive to their hosting service. Features include:
* Switch Maps+Modes
* Teleport Players to Players
* Change Player Skins
* Control Player Buying+Cash
* Spawn Items
* Clean up corpses + guns
* Spawn Bots
* Spawn Items for other players
* Control Teams + Balance/Shuffle Teams
* ResetSND
* And More

You can read more about the ArcticVR admin menu on their website: https://www.arctic-vr.com/server-admin-menu

==== Handy tools for finding steamIDs ====

Steam ID finder: https://steamidfinder.com/lookup/ or https://steamid.xyz/

You want to enter in the steamID64 format.

This tool can convert or lookup IDs: https://steamid.io/

If you are looking for a steamID of a player that has been on your server recently this is technique to find them:
<pre>
grep -i playername ~/pavlovserver/Pavlov/Saved/Logs/* | grep TicketValidation
</pre>

=== Configure Rcon ===
To enable Rcon access create config file:
<pre> nano /home/steam/pavlovserver/Pavlov/Saved/Config/RconSettings.txt </pre>

Copy in the following text - change password, and if desired the port:
<pre>
Password=ChangeThisPassword
Port=9100
</pre>
You must specify a port for the Rcon server to use as well as a Password (use a different port per sever instance if running multiple server instances off the same hardware)

=== Starting the server ===

<pre>
cd ~/pavlovserver && ./PavlovServer.sh
</pre>

That's it, your server will be automatically broadcast to the master server! :)

Two handy tools to determine quickly if your server is broadcasting are [https://pablub.xyz/ Pablub] (PC only) and [https://pavlovhorde.com/ Horde] (Shack) and [https://pavlovhorde.com/pcServers Horde] (PC version)

Note that when you close your terminal, the server will go down. See the "supervisors" section below for how to prevent this.

----

=== Supervising the server using systemd ===

Running '''./PavlovServer.sh''' in your interactive shell is easy, but the server will shut down when you close your terminal. If you want to run the server in the background,
you'll want to run it under a supervisor. There are many options, ranging from the simple (nohup, screen or tmux), to the
more robust (supervisord, systemd).

Systemd is running by default on Ubuntu Linux, so we'll use that here.

To run the server as a systemd service, create the file '''/etc/systemd/system/pavlovserver.service''' (as root) by typing
<pre>
sudo nano /etc/systemd/system/pavlovserver.service
</pre>

Copy the contents below into the file and save.

<pre>
[Unit]
Description=Pavlov VR dedicated server

[Service]
Type=simple
WorkingDirectory=/home/steam/pavlovserver
ExecStart=/home/steam/pavlovserver/PavlovServer.sh

RestartSec=1
Restart=always
User=steam
Group=steam

[Install]
WantedBy = multi-user.target
</pre>

If you'd like your server to start as competitive without editing the game.ini, change the line "ExecStart=/home/steam/pavlovserver/PavlovServer.sh" to look like this below. Though it's much easier to just use the game.ini to enable competitive instead. <pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -COMPETITIVE=1</pre>

Change the user or paths as appropriate. After saving the service file, to start, restart, stop, or monitor the server:

<pre>
sudo systemctl start pavlovserver
sudo systemctl restart pavlovserver
sudo systemctl stop pavlovserver
sudo systemctl status pavlovserver
</pre>

To view the logs:

<pre>
sudo journalctl -u pavlovserver
# to live-tail the logs
sudo journalctl -u pavlovserver -f
</pre>

If you want to run the pavlov server as soon as your server boots (e.g. a VPS you turn on and off), add pavlov as a startup service:

<pre>
sudo systemctl enable pavlovserver
</pre>

----

== Advanced Server Administration ==

=== Running multiple servers on one host ===

* Pavlovserver is functionally single-threaded (there are multiple threads, but the vast majority of work occurs in the primary one). Make sure you have # of pavlovservers + 1 CPU available. More CPUs= more servers. Faster CPU = more players.
* Make multiple server installs by defining a separate install dir for each server.
* Run each server with a unique port. eg: '''./PavlovServer.sh -PORT="Desired Port"'''
* The Server will use the Desired Port and the Port 400 above (Example: You choose 8200 as Port. So Port 8600 will be used as well)
* If you are using RCON, each server will need a unique port defined in RconSettings.txt
* Ensure the ports are forwarded and opened in your firewall

To duplicate directories:

be in the steam home folder
<pre>
cp -r pavlovserver pavlovserver1
/home/steam/pavlovserver1/PavlovServer.sh -PORT=[Desired Port]
</pre>

=== Starting server in competitive mode ===
Competitive mode will prevent dead teammates from being able to see the match, to prevent ghosting.
You can either enable this via Game.ini (described in Game.ini file), or using the -COMPETITIVE=1 parameter.

<pre>
/home/steam/pavlovserver1/PavlovServer.sh -COMPETITIVE=1
</pre>

{| class="wikitable"

|}

=== Useful Linux Commands ===
List files / folders in directory, print current working directory,
<pre>ls -la #list files/directories along with authorities and ownership
pwd #print working directory
sudo chown <owner> <file/directory> #change owner of file/directory. If root created something and you need to change it to steam
sudo chgrp <group> <file/directory> #change group of file/directory.
</pre>

Check if pavlov is running by checking process status. If the only row you see is the grep command, pavlov server is not started.
<pre> ps -ef | grep pav </pre>

Sample output:
<pre>
steam 34044 1 0 16:52 ? 00:00:00 /bin/sh /home/steam/pavlovserver/PavlovServer.sh
steam 34066 34044 80 16:52 ? 00:00:04 /home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer
zombies+ 34101 34013 0 16:52 pts/0 00:00:00 grep --color=auto pav
</pre>

Kill a process. Note this command uses 34044, which is a process id from the command output above.
<pre> kill -9 34044 </pre>

Dump the log to the console so you can scroll through it:
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log </pre>

Search the log for a string - replace my_string with case-sensitive string
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep my_string </pre>

<hr>

== Advanced Scripts For Server Management ==
<hr>

=== '''Auto-updating the server (PCVR only)''' ===
Assuming you have followed this guide and used the default paths, users, and install instructions, you can paste the following into your terminal to auto-update your Pavlov server:

<pre>
cat << 'EOF' > $HOME/pavlov_daily_update_and_restart.sh
#!/bin/bash

USER="steam"
SERVICENAME="pavlovserver.service"
INSTALLDIRNAME="pavlovserver"
USERHOME="/home/$USER"

echo -e "Beginning Pavlov VR update run on $(date)\n\n"

systemctl stop "$SERVICENAME"

sleep 5
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +force_install_dir "$USERHOME/$INSTALLDIRNAME" +app_update 622970 +exit
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +app_update 1007 +quit
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/.steam/sdk64/steamclient.so"
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/pavlovserver/Pavlov/Binaries/Linux/steamclient.so"

systemctl start "$SERVICENAME"

echo -e "Ending Pavlov VR update run on $(date)\n\n"

EOF

chmod +x $HOME/pavlov_daily_update_and_restart.sh
mkdir $HOME/pavlov_update_logs && touch $HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log
CRONLINE="00 2 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
(sudo crontab -u root -l; echo "$CRONLINE" ) | sudo crontab -u root -
unset CRONLINE

</pre>

These commands will:

1. Create a shell script in the "steam" user's home directory that automatically stops the Pavlov server, pulls any updates via steam, pull updates to the Steamworks SDK Redist, and copies the latest version of steamclient.so to the Pavlov server directory

2. Make the shell script executable

3. Create a new directory called "pavlov_update_logs" in the "steam" user's directory, and create a logfile inside that directory called "pavlov_daily_update_and_restart.sh.log". You can check this logfile to see the output of the Pavlov and Steam SDK update commands.

4. Create a crontab entry for the root user that runs this shell script automatically every day at 2:00AM local time

If you want to change the time that this script runs, edit the numbers "00 2" in the line that starts with "CRONLINE=". In the example provided, 00 is the minutes column, and 2 is the hour column. For example, if you wanted the server to automatically update and restart at 4:17AM every day, change the line starting with "CRONLINE=" to:

<pre>
CRONLINE="17 4 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
</pre>

If the time is PM, use 24-hour time format, e.g. "32 18" for 6:32PM.
<hr>
=== '''Save Logs for records and stats''' ===
this is an automated script that will on a timer save all the backups made by the server before they are purged by the game for admin records and starts collection

https://github.com/JTWP-org/backUpLogs2
<hr>

=== '''Make an API request with Mod.io to get map picture and name''' ===
very basic script pass the script a map ID as an argument then it will give u the name and a thumbnail to use

https://github.com/JTWP-org/mod.io-modcheck/tree/main

=== '''Sharing Bans over gameserver on same machine''' ===
when you have a lot of servers keeping the bans synced can be a nightmare so using a symbolic link allows all the servers to use one file

for this lets say I have pavlovserver000 and pavlovserver001 and they are located at /home/steam/pavlovserver000 and /home/steam/pavlovserver001

''step 1 will be to pick a blacklist to use as the new one and move it to a central location''
mkdir ~/shared ; mv /home/steam/pavlovserver000/Pavlov/Saved/Config/blacklist.txt ~/shared/blacklist.txt ; rm /home/steam/pavlovserver001/Pavlov/Saved/Config/blacklist.txt
now we have moved the blacklist from pavlovserver000 to a folder in our home called shared and then we removed the blacklist from pavlovserver001

step 2 making the links
ln -s ~/shared/blacklist.txt /home/steam/pavlovserver000/Pavlov/Saved/Config/blacklist.txt ; ln -s ~/shared/blacklist.txt /home/steam/pavlovserver001/Pavlov/Saved/Config/blacklist.txt
now editing them in pavlovserver001's files will update the list for all of the servers it's not a sync its uses the same list if you want to check where a link is pointed if u
ls -l
It will show where the file is really located <hr>
=== Interactive Update ALL ===
will find all server installs on machine and update them will update Ubuntu check what version and do correct updates for that version also UPDATE 29 PCVR STEP then it will list each server by server name and ask what type it is and then it will update and move to the next

https://github.com/JTWP-org/Pavlov-updateallservers/tree/main<hr>

=== getting map info with just the UGC ===

you will need to get a API key from mod.io for this ... running this bash script and passing a UGC number to it will return the map name mod.io url and a thumbnail

HOW TO USE <pre>nano get-map.sh</pre>

then enter this script <pre>#!/bin/bash

ugc=000000

gameID=3959 #PAVLOV IS 3959

api-path="https://u-*ID NUMBER*.modapi.io/v1" #get on thhe access tab in mod.io settings

api-key="" #get on thhe access tab in mod.io settings

curl -X GET "${api-path}/v1/games/${gameID}/mods/$("${ugc:3})?api_key=${api-key}" -H 'Accept: application/json' | jq '.logo.thumb_1280x720, .name , .profile_url</pre>

then give script perms to run <pre>sudo chmod +x get-map.sh</pre>

and then run it like this
<pre>bash get-map.sh UGC3409480 </pre>

Setting up a dedicated server

2023-11-20T23:55:28Z

SaltedCrackerJack: /* Interactive Update ALL */

== Setting up a dedicated server ==

'''There are no Windows binaries'''

This guide is written exclusively for Linux and covers Ubuntu/Debian/Debian-like and Red Hat RPM-based distros. Possible to run with other distros, but some of the commands won't work and you will need to know enough to figure out the software install of dependencies on your own.

If you are considering hosting from home, please read that section of the wiki first.

This guide assumes you know the basics of using a bash terminal: ssh'ing into a server, running bash commands, editing text files, etc.

If you have no experience using bash, maybe start [https://www.howtogeek.com/140679/beginner-geek-how-to-start-using-the-linux-terminal/ here]. Editing text files via commandline is often a challenge. Suggest using nano and reading guide [https://www.howtogeek.com/howto/42980/the-beginners-guide-to-nano-the-linux-command-line-text-editor/ here]

If you are new to linux and accessing your server from Windows, highly suggest using MobaXterm as your SSH client as that can make required editing of text files easier using built in editor instead of the native linux command line editors.

And finally, ask yourself why you want to setup a server? If you look at the list, there are many, many more servers than players. If you don't have a team, discord community, or group of friends ready to play on your server, chances are it will go unused. Got one of these... great, let's go.

If you don't want to go through the hassle yourself and want to pay for a hosting service Arctic VR (PC and Shack) and Horde (Shack) provide a server hosting services and are trusted in the community. See links below.

----

=== Server Requirements ===

'''Pavlovserver can only be hosted under Linux.'''

This can be running as a VM under windows, but this will increase the complexity of the setup beyond this guide.

Ubuntu 18.04 x86_64, Ubuntu 19/04 amd64, Ubuntu 20.04, and Rocky Linux 8 are confirmed working. Ubuntu 15.04 x86 is known to fail to install using this guide. Recommend not running on "minimal" images as some tools are missing.

* 2GB RAM + 1GB RAM per each additional server with 10 players. More RAM is recommended for larger maps, higher player counts, or complex gamemodes. Not having enough RAM is a common cause of server crashes.

* A ~2.5Ghz CPU will comfortably support a 10 player server.

* A ~4Ghz CPU will comfortably support 24 players. This is a limit built into Pavlov itself, no server will allow players to join over 24. Lower player counts are recommended for complex gamemodes (E.g. CodZ) and/or highly detailed maps, so that maximum number will often be lower.

(Note that these are '''not''' hard limits for player counts, just suggestions for the best performance, based on experiences with many server providers on different grades of hardware.)

* Pavlovserver is functionally single threaded (one thread does vast majority of work). More CPUs only help if you are running more servers. More clockspeed = higher performance = more users per server.
The maximum number of servers you can run is dependent on how many CPUs you have. For example, if you have an 8 core CPU, the maximum number of servers would be 7. You should always have at least one CPU free as overhead, as Pavlov servers can use slightly more than one thread.

----

==== Hosting at home ====
When hosting at home there are additional requirements regarding networking: Your router has to support port-forwarding, hair-pinning/LoopbackNAT, and respond to ping requests. These techniques are necessary to allow your server to be found and to talk back to the client. please see https://en.wikipedia.org/wiki/Port_forwarding, https://en.wikipedia.org/wiki/Hairpinning, and https://www.speedguide.net/faq/how-to-become-pingable-behind-a-routerfirewall-376 for more info and google for these terms in addition to your router model to find guides on how to enable/configure it properly. If you have modern Router, it may have these features already enabled, in this case you just have to configure port-forwarding. If you can see your server but not join it while others can, this is indicative of a failure of LoopbackNAT.

A second challenge to hosting at home is CGNAT (Carrier grade NAT: https://www.a10networks.com/blog/carrier-grade-nat/). Just like NAT on your home network that has to be gotten around w/ port-forwarding, CGNAT breaks the ability of external connections to be made back to your server, but the controls are solely in your ISPs hands. Sometimes if you ask, you can be removed from CGNAT pools and/or assigned a static IP. CGNAT rollouts are becoming very common now, so if your server worked then doesn't allow connections now, your ISP may have made this change.

You can check whether you’re on a CGNAT network by visiting a Web site such as ipaddress.com or whatsmyip.com and comparing the IP address listed to the public/WAN IP address assigned to your Internet gateway. To find your gateway’s public IP address, check the status page in the administrative interface. If the two IP addresses differ, you’re likely on a CGNAT network. If so, this problem must be resolved before you go any further.

'''Not understanding these requirements and configuration is a frequent cause of failed setups and questions in discord. Don't skip this if you are trying to host from home'''

'''There are serious security implications of hosting this software at home.''' None of the devs are security experts and there has been no security review of the code. You are opening up your system to the world and publicity advertising this fact. Expect that any system hosting this software is open to compromise from the Internet and act accordingly. If your router offers a DMZ network, use it. Consider hosting on a cloud based server and think twice before running this software on any system that contains data you care about or has access to networks and computers you care about.

If you're hosting at home using Oracle's VirtualBox, there are steps you can take to prevent double NAT (which can cause issues later on)

1. Select your VM and then click Settings in VirtualBox's main window.

2. Click on Network and change Attached To from NAT to Bridged Adapter.

Once you've done this, your VM should be connected directly to your home router and double NAT should no longer be a issue.

----

==== Starting Server Install ====

====Obtaining an ApiKey ====
(Not required unless hosting large amount of servers )

you can just comment this line out or remove it For your server to show up in the server list, there is now a requirement to have an ApiKey issued by vankrupt. This is to prevent DOS attacks against the master server

Get the key by going here: https://pavlov-ms.vankrupt.com/servers/v1/key and using your mobile number to get a SMS
(Note that there have been reported failures of this SMS system for non-US mobiles. In this case, DM davevillz your phone number and request a key)

Put this key in your Game.ini as follows:
ApiKey="ABC123FALSEKEYDONTUSEME"
or if you would like (personally untested..I would use Game.ini) you can call it at server runtime with flag as follows:
-KEY="ABC123FALSEKEYDONTUSEME"

This key can be re-used for a reasonable number of servers (a limit of 10 has been mentioned). Contact the Devs if you need more servers per key.

====System setup and software installation====

Install dependencies and create the `steam` user. (You only need to do this once):

Confirm Linux version
<pre>
lsb_release -a
</pre>

'''Ubuntu 20.04'''
'''''sudo apt update''''' && '''''sudo apt install''''' -y gdb curl lib32gcc1 libc++-dev unzip
sudo useradd -m steam
'''Ubuntu 20.10 or higher'''
sudo apt update && sudo apt install -y gdb curl lib32gcc-s1 libc++-dev unzip
sudo useradd -m steam
'''Rocky Linux, CentOS 8, and RHEL 8'''
sudo sed -i 's/^SELINUX=enforcing$/SELINUX=permissive/g' /etc/selinux/config
sudo setenforce 0
sudo yum install gdb curl glibc.i686 libstdc++.i686 libstdc++-devel.i686 libstdc++-devel.x86_64 unzip wget -y
wget <nowiki>https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/l/libcxx-3.8.0-3.el7.x86_64.rpm</nowiki>
sudo rpm -i libcxx-3.8.0-3.el7.x86_64.rpm
sudo useradd -m steam
[Optional] Set a password for steam.
<pre>sudo passwd steam</pre>

[Optional] Set the /bin/bash shell for the steam user this will allow you to use arrow keys in terminal and show what folder you are in at all times <pre>sudo chsh -s /bin/bash steam</pre>

Login as the Steam user. ('''You will need to do this each time you connect to your server'''):

<pre>
sudo su -l steam
</pre>

Install Steam:

<pre>
mkdir ~/Steam && cd ~/Steam && curl -sqL "https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz" | tar zxvf -
</pre>

There are different dedicated server versions for Pavlov Server - choose which server version you want to host (PC non-beta, PC Beta, Shack Live, or Shack RC)
(You will need to run this command each time there is a Pavlov Server update).

 
To host '''PC Server (non-beta)''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta default +exit

</pre>

To host '''PC BETA''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta beta_server +exit
</pre>

To host '''Shack Live''' (Quest):

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack +exit
</pre>

To host '''Shack RC''' (Quest): 

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack_beta +exit
</pre>

Now that we've installed the server, all pavlov server versions should continue. 
Install a fresh copy of steamclient.so (May have to do this after each update):
<pre>
~/Steam/steamcmd.sh +login anonymous +app_update 1007 +quit
mkdir -p ~/.steam/sdk64
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/pavlovserver/Pavlov/Binaries/Linux/steamclient.so
</pre>

The update 29 of the PCVR version of Pavlov and after added a requirement to run these commands to change the steamclient.so:
<code>sudo rm /usr/lib/x86_64-linux-gnu/libc++.so</code>
<code>sudo ln -s /usr/lib/x86_64-linux-gnu/libc++.so.1 /usr/lib/x86_64-linux-gnu/libc++.so</code>

Make the PavlovServer script executable. (You only need to do this once):

<pre>
chmod +x ~/pavlovserver/PavlovServer.sh
</pre>

----

=== Server Configuration ===

Before starting the server we need to configure it. Start by creating some directories:

<pre>
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Logs
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps
</pre>

==== Mods/Blacklist/Whitelist (optional) ====

The following three files allow you to specify mods, banned players, and whitelist players. These are optional, but go ahead and create them. Populating the files is described later.

<pre>
touch /home/steam/pavlovserver/Pavlov/Saved/Config/mods.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/blacklist.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/whitelist.txt
</pre>

====Configuring Game.ini====
Create a new Game.ini file using following command to open an editor and copy/paste the following block into it then save it. Note not all of these options are required. For instance remove or comment out the Password=0000 line to make a public server with no pin.
<pre>
nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini
</pre>

<pre>
[/Script/Pavlov.DedicatedServer]
bEnabled=true
ServerName="My_private_idaho"
MaxPlayers=10 #Set this to 10 for Shack. 24 is the max for PC, setting it higher will not allow players to join.
ApiKey="ABC123FALSEKEYDONTUSEME"
bSecured=true
bCustomServer=true
bVerboseLogging=false
bCompetitive=false #This only works for SND
bWhitelist=false
RefreshListTime=120
LimitedAmmoType=0
TickRate=90
TimeLimit=60
#Password=0000
#BalanceTableURL="vankruptgames/BalancingTable/main"
MapRotation=(MapId="UGC1758245796", GameMode="GUN")
MapRotation=(MapId="datacenter", GameMode="SND")
MapRotation=(MapId="sand", GameMode="DM")

</pre>

* '''bEnabled''' - whether the server appears in the server list (unconfirmed)
* '''ServerName''' - name it will be listed as. (approx 35 chars max)
* '''MaxPlayers''' - See suggested specs for limits. 10 standard (10 for shack), 20-24 is max recommended for large maps like Stalingrad or PUSH/RUSH modes, and servers allow a maximum of 24 players.
* '''ApiKey''' - Unique ApiKey required to register server with master server. Replace with your key
* '''bSecured''' - enabled Valve Anti-Cheat (VAC)
* '''bCustomServer''' - activates some new modding tools (save and http functions. Required to write to blacklist.txt for bans)
* '''bCompetitive''' - sets the server to competitive mode for SND. If removed the server will default to false
* '''bVerboseLogging''' - enables verbose logging, mostly detailed statistics. Be prepared for significant increase in logging.
* '''bWhitelist''' - Only allow users in whitelist.txt to join
* '''RefreshListTime''' - sets how often the running server checks for updates in ban/whitelist/mod files
* '''LimitedAmmoType''' - sets limited ammo mode, see Limited Ammo Types table below

* '''TimeLimit''' - sets time limit for each map
* '''TickRate''' - sets the server tickrate. (so far minimum stable seems around 50 and max around 120. Beware setting this changes weapon despawn time and breaks some game modes. Recommend not touching)
* '''Password''' - PIN number for server #FYI - this is now also changeable via rcon.
* '''BalanceTableURL''' - Points to a custom balance table from github. See https://github.com/vankruptgames/BalancingTable for instructions. This line isn't needed if you don't have one.
* '''MapRotation''' - you can add multiple of these. The map system has switched from the steam workshop to modio which means that the server rotation will need to be redone with modio UGCs. <nowiki>https://mod.io/g/pavlov</nowiki>. This is done by taking the resource ID from the modio page, adding “UGC” in front of it and then adding that to the rotation. For example the map gravity <nowiki>https://mod.io/g/pavlov/m/gravity1</nowiki> has a resource ID of 2773760 so the map ID to add to the server would be “UGC2773760”. When a match ends, the server will load the next map in the rotation.
* '''AFKTimeLimit''' There is now a feature to kick players who are idle in the game. Integers are measured in seconds and 0 disables AFK kicking completely.

Available game modes as of 09/06/2022: See Game modes table below

For maps running a Custom gamemode (CodZ, BR, Duel, etc.) it doesn't matter which gamemode you choose, as the map will automatically override it with the custom mode.

{| class="wikitable"
|+Limited Ammo Types
!AmmoType
!Name
!Description
|-
|0
|Unlimited
|Players have unlimited ammo, carry no ammo boxes and do not display an ammo count on the wrist.
|-
|1
|Limited Generic
|Players carry ammo boxes with a limited amount of ammo.
One box for each weapon class (Pistol, Submachine gun, Rifles/MGs, Shotgun, Sniper).

Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.

An ammo count is displayed on the wrist.
|-
|2
|Limited Specific
|Players carry ammo boxes with a limited amount of ammo.
One box for each weapon.

Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.

An ammo count is displayed on the wrist.
|-
|3
|Custom
|Allows for full control over ammo by the map.
|-
|4
| Limited Special
|'''All weapons except "special" weapons are unlimited, more clarification is needed.'''
|-
|5
|Boxless
|'''Like limited generic but without boxes? Clarification is needed.'''
|}
{| class="wikitable"
|+Game modes
!GameMode
!Name
|-
|DM
|Death match
|-
|KOTH
|King of the hill
|-
|GUN
| Gun game
|-
|OITC
| One in the chamber
|-
|SND
|Search and destroy
|-
|TANKTDM
|WW2 Team Death Match
|-
| TDM
|Team Death Match
|-
|TTT
|Trouble in Terrorist Town
|-
|TTTclassic
|TTT with only innocent/traitor/detective
|-
|WW2GUN
|WW2 gun game
|-
|ZWV
| Zombie wave survival
|-
|HIDE
|The Hidden
|-
|INFECTION
|Hidden infection
|-
|PUSH
|Push
|-
|PH
|Prop hunt
|}
= Default Map ID's =
datacenter

sand

bridge

containeryard

siberia (Prison Break)

hospital (Zombies map)

killhouse

range

tutorial

santorini

station

industry

ogcontainers (Shack only)

haguenau (Shack only)

foundation (Shack only)

stalingrad (PC only)

stalingrad_night (PC only)

santorini_night (PC only)

sand_night (PC only)

station_night (PC only)

industry_night (PC only)

bunker (PC only)

==== Firewall/Port forwarding ====
Using the default settings there are two UDP ports (7777, 8177) that need to be allowed to access the server either by firewall setup or port forwarding.

'''Ubuntu''' firewall commands to check firewall and open ports:
<pre>
sudo ufw status
sudo ufw allow 7777
sudo ufw allow 8177
sudo ufw allow 9100
sudo ufw status
</pre>

'''Rocky Linux''' firewall commands to check the firewall and open ports:
<pre>
sudo firewall-cmd --zone=public --add-port=7777/tcp
sudo firewall-cmd --zone=public --add-port=7777/udp
sudo firewall-cmd --zone=public --add-port=8177/tcp
sudo firewall-cmd --zone=public --add-port=8177/udp
sudo firewall-cmd --zone=public --add-port=9100/udp
sudo firewall-cmd --zone=public --add-port=9100/tcp
sudo firewall-cmd --list-ports
firewall-cmd --runtime-to-permanent
</pre>

You may also need to allow Pings (ICMP) for the server's true latency to appear in the master list.

If you are running multiple servers and have set additional ports (see http://pavlovwiki.com/index.php/Setting_up_a_dedicated_server#Running_multiple_servers_on_one_host) then you need to allow access to the defined port plus the port 400 higher. So if you use 7000 as your port, then UDP 7000 and 7400 need to be open

If you have setup rcon via RconSettings.txt (below) then that port also needs to be allowed access via TCP

If you are running Shack/Quest and want to have maps that are downloadable from your server, your server ports (ex. 7777 & 8177) must also be open via TCP

----

==== Shack Maps (Quest) ====

If you try to use the steps above to add maps for Shack, you'll run into issues very quickly. This is because Shack has no affiliation with Steam, and therefore cannot use Steam Workshop maps like the above. In the future, these steps will apply to PC servers as well, allowing a server to hold the map itself, instead of offloading it to Steam.

To get started, first, create the directory to hold the maps

<pre>mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps</pre>

You can use any number of methods to move the map files onto the server, but I'll go over the two simplest, starting with a GUI approach

Download and install Cyberduck onto your "home" PC (Whatever PC you use for access to the server, but not the server itself): https://cyberduck.io/

Next, download and unzip your map of choice from https://www.pavlovquest.com/ , https://pavlovhorde.com/mapsList, or look in #shack-map-showcase channel in the discord server. I'm going to use Cheeto's WW2 Items test (http://www.mediafire.com/file/emyt9bs1z9u9ykw/SVR_Cheeto_Items.zip/file ) for this example, you do what you like

In the top left corner, open a connection, set the connection type to SFTP, and fill in the rest of the information. The username is typically `root`, password is whatever you set the root pw as (toor in Ubuntu by default)

In the directory dropdown (it will say /root) go back to /

Follow the directories until we arrive back at our "maps" folder <pre>/home/steam/pavlovserver/Pavlov/Saved/maps</pre>

Drag and drop the unzipped map folder into the main window, in this case itll be SVR_Cheeto_Items

Hit Allow

You'll now see a folder named SVR_Cheeto_Items, and within it should be nothing but 3 files. If there is another folder in it, move this folder to the maps directory, otherwise the server won't work. The 3 files (2 .PAK one .JSON) should be in home/steam/pavlovserver/Pavlov/Saved/maps/SVR_Cheeto_Items, no more, no less.

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

To play the map, you can either use RCON switch map command, or to add the map to your server's automatic map rotation list, add the map's folder name to your Game.ini. This replaces the MapID section, so for our example, it would be

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

And that's all! Disconnect CyberDuck from your server before playing, otherwise you'll have difficulty joining.

-----------

==== Adding Shack Maps over Command Line Interface ====

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

A bit more complicated, but adding maps over CLI has its benefits

First, CD to the maps directory you made above

<pre>cd ~/pavlovserver/Pavlov/Saved/maps</pre>

Download the map files from whatever you use to upload them. To do this, you can either use curl or wget

<pre>curl -O insertURLhere</pre>

'''If you download your map from Google Drive''', make sure that your .zip folder is shared with anyone.
Then, get the file's URL from the shared link. Example : ''<nowiki>https://drive.google.com/file/d/19bI8gUHaN5tUrDvnadAacUnchQf6_k/view</nowiki>'' will be ''19bI8gUHaN5tUrDvnadAacUnchQf6_k''
Edit "fileId" and "fileName" before you execute the command.
<pre>
fileId=19bI8gUHaN5tUrDvnadAacUnchQf6_k
fileName=SVR_USER_MAPNAME
curl -sc /tmp/cookie "https://drive.google.com/uc?export=download&id=${fileId}" > /dev/null
code="$(awk '/_warning_/ {print $NF}' /tmp/cookie)"
curl -Lb /tmp/cookie "https://drive.google.com/uc?export=download&confirm=${code}&id=${fileId}" -o ${fileName} </pre>

To keep with the Items example:

<pre>curl -O https://cdn.discordapp.com/attachments/744185280759857234/745027406695366788/SVR_Cheeto_Items.zip</pre>

Next, unzip the file. If this next step errors out, saying the command is unknown, switch back to the root user (su root), and install unzip (sudo apt install unzip), then return to the steam user, and continue.

<pre>unzip SVR_Cheeto_Items.zip</pre>

Now finish like before by adding the map to your Game.ini

<pre>nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini</pre>

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

==== Admin/Moderator list (optional) ====

The only working in-game admin menu is through Arctic VR server hosting (see below).

If you add moderators to your server, they will not be subject to vote kicks.

<pre>
nano ~/pavlovserver/Pavlov/Saved/Config/mods.txt
</pre>

Example Mod List:
<pre>
76541198397498572 #Optional Comment: Player name
76541198397498573 #Some Other Player
</pre>

==== ArcticVR Admin Menu ====

[[File:Arcticmenu.jpg|500px|link=https://www.arctic-vr.com/server-admin-menu]]

Arctic-VR Offers an advanced In-Game Admin menu that is exclusive to their hosting service. Features include:
* Switch Maps+Modes
* Teleport Players to Players
* Change Player Skins
* Control Player Buying+Cash
* Spawn Items
* Clean up corpses + guns
* Spawn Bots
* Spawn Items for other players
* Control Teams + Balance/Shuffle Teams
* ResetSND
* And More

You can read more about the ArcticVR admin menu on their website: https://www.arctic-vr.com/server-admin-menu

==== Handy tools for finding steamIDs ====

Steam ID finder: https://steamidfinder.com/lookup/ or https://steamid.xyz/

You want to enter in the steamID64 format.

This tool can convert or lookup IDs: https://steamid.io/

If you are looking for a steamID of a player that has been on your server recently this is technique to find them:
<pre>
grep -i playername ~/pavlovserver/Pavlov/Saved/Logs/* | grep TicketValidation
</pre>

=== Configure Rcon ===
To enable Rcon access create config file:
<pre> nano /home/steam/pavlovserver/Pavlov/Saved/Config/RconSettings.txt </pre>

Copy in the following text - change password, and if desired the port:
<pre>
Password=ChangeThisPassword
Port=9100
</pre>
You must specify a port for the Rcon server to use as well as a Password (use a different port per sever instance if running multiple server instances off the same hardware)

=== Starting the server ===

<pre>
cd ~/pavlovserver && ./PavlovServer.sh
</pre>

That's it, your server will be automatically broadcast to the master server! :)

Two handy tools to determine quickly if your server is broadcasting are [https://pablub.xyz/ Pablub] (PC only) and [https://pavlovhorde.com/ Horde] (Shack) and [https://pavlovhorde.com/pcServers Horde] (PC version)

Note that when you close your terminal, the server will go down. See the "supervisors" section below for how to prevent this.

----

=== Supervising the server using systemd ===

Running '''./PavlovServer.sh''' in your interactive shell is easy, but the server will shut down when you close your terminal. If you want to run the server in the background,
you'll want to run it under a supervisor. There are many options, ranging from the simple (nohup, screen or tmux), to the
more robust (supervisord, systemd).

Systemd is running by default on Ubuntu Linux, so we'll use that here.

To run the server as a systemd service, create the file '''/etc/systemd/system/pavlovserver.service''' (as root) by typing
<pre>
sudo nano /etc/systemd/system/pavlovserver.service
</pre>

Copy the contents below into the file and save.

<pre>
[Unit]
Description=Pavlov VR dedicated server

[Service]
Type=simple
WorkingDirectory=/home/steam/pavlovserver
ExecStart=/home/steam/pavlovserver/PavlovServer.sh

RestartSec=1
Restart=always
User=steam
Group=steam

[Install]
WantedBy = multi-user.target
</pre>

If you'd like your server to start as competitive without editing the game.ini, change the line "ExecStart=/home/steam/pavlovserver/PavlovServer.sh" to look like this below. Though it's much easier to just use the game.ini to enable competitive instead. <pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -COMPETITIVE=1</pre>

Change the user or paths as appropriate. After saving the service file, to start, restart, stop, or monitor the server:

<pre>
sudo systemctl start pavlovserver
sudo systemctl restart pavlovserver
sudo systemctl stop pavlovserver
sudo systemctl status pavlovserver
</pre>

To view the logs:

<pre>
sudo journalctl -u pavlovserver
# to live-tail the logs
sudo journalctl -u pavlovserver -f
</pre>

If you want to run the pavlov server as soon as your server boots (e.g. a VPS you turn on and off), add pavlov as a startup service:

<pre>
sudo systemctl enable pavlovserver
</pre>

----

== Advanced Server Administration ==

=== Running multiple servers on one host ===

* Pavlovserver is functionally single-threaded (there are multiple threads, but the vast majority of work occurs in the primary one). Make sure you have # of pavlovservers + 1 CPU available. More CPUs= more servers. Faster CPU = more players.
* Make multiple server installs by defining a separate install dir for each server.
* Run each server with a unique port. eg: '''./PavlovServer.sh -PORT="Desired Port"'''
* The Server will use the Desired Port and the Port 400 above (Example: You choose 8200 as Port. So Port 8600 will be used as well)
* If you are using RCON, each server will need a unique port defined in RconSettings.txt
* Ensure the ports are forwarded and opened in your firewall

To duplicate directories:

be in the steam home folder
<pre>
cp -r pavlovserver pavlovserver1
/home/steam/pavlovserver1/PavlovServer.sh -PORT=[Desired Port]
</pre>

=== Starting server in competitive mode ===
Competitive mode will prevent dead teammates from being able to see the match, to prevent ghosting.
You can either enable this via Game.ini (described in Game.ini file), or using the -COMPETITIVE=1 parameter.

<pre>
/home/steam/pavlovserver1/PavlovServer.sh -COMPETITIVE=1
</pre>

{| class="wikitable"

|}

=== Useful Linux Commands ===
List files / folders in directory, print current working directory,
<pre>ls -la #list files/directories along with authorities and ownership
pwd #print working directory
sudo chown <owner> <file/directory> #change owner of file/directory. If root created something and you need to change it to steam
sudo chgrp <group> <file/directory> #change group of file/directory.
</pre>

Check if pavlov is running by checking process status. If the only row you see is the grep command, pavlov server is not started.
<pre> ps -ef | grep pav </pre>

Sample output:
<pre>
steam 34044 1 0 16:52 ? 00:00:00 /bin/sh /home/steam/pavlovserver/PavlovServer.sh
steam 34066 34044 80 16:52 ? 00:00:04 /home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer
zombies+ 34101 34013 0 16:52 pts/0 00:00:00 grep --color=auto pav
</pre>

Kill a process. Note this command uses 34044, which is a process id from the command output above.
<pre> kill -9 34044 </pre>

Dump the log to the console so you can scroll through it:
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log </pre>

Search the log for a string - replace my_string with case-sensitive string
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep my_string </pre>

<hr>

== Advanced Scripts For Server Management ==
<hr>

=== '''Auto-updating the server (PCVR only)''' ===
Assuming you have followed this guide and used the default paths, users, and install instructions, you can paste the following into your terminal to auto-update your Pavlov server:

<pre>
cat << 'EOF' > $HOME/pavlov_daily_update_and_restart.sh
#!/bin/bash

USER="steam"
SERVICENAME="pavlovserver.service"
INSTALLDIRNAME="pavlovserver"
USERHOME="/home/$USER"

echo -e "Beginning Pavlov VR update run on $(date)\n\n"

systemctl stop "$SERVICENAME"

sleep 5
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +force_install_dir "$USERHOME/$INSTALLDIRNAME" +app_update 622970 +exit
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +app_update 1007 +quit
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/.steam/sdk64/steamclient.so"
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/pavlovserver/Pavlov/Binaries/Linux/steamclient.so"

systemctl start "$SERVICENAME"

echo -e "Ending Pavlov VR update run on $(date)\n\n"

EOF

chmod +x $HOME/pavlov_daily_update_and_restart.sh
mkdir $HOME/pavlov_update_logs && touch $HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log
CRONLINE="00 2 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
(sudo crontab -u root -l; echo "$CRONLINE" ) | sudo crontab -u root -
unset CRONLINE

</pre>

These commands will:

1. Create a shell script in the "steam" user's home directory that automatically stops the Pavlov server, pulls any updates via steam, pull updates to the Steamworks SDK Redist, and copies the latest version of steamclient.so to the Pavlov server directory

2. Make the shell script executable

3. Create a new directory called "pavlov_update_logs" in the "steam" user's directory, and create a logfile inside that directory called "pavlov_daily_update_and_restart.sh.log". You can check this logfile to see the output of the Pavlov and Steam SDK update commands.

4. Create a crontab entry for the root user that runs this shell script automatically every day at 2:00AM local time

If you want to change the time that this script runs, edit the numbers "00 2" in the line that starts with "CRONLINE=". In the example provided, 00 is the minutes column, and 2 is the hour column. For example, if you wanted the server to automatically update and restart at 4:17AM every day, change the line starting with "CRONLINE=" to:

<pre>
CRONLINE="17 4 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
</pre>

If the time is PM, use 24-hour time format, e.g. "32 18" for 6:32PM.
<hr>
=== '''Save Logs for records and stats''' ===
this is an automated script that will on a timer save all the backups made by the server before they are purged by the game for admin records and starts collection

https://github.com/JTWP-org/backUpLogs2
<hr>

=== '''Make an API request with Mod.io to get map picture and name''' ===
very basic script pass the script a map ID as an argument then it will give u the name and a thumbnail to use

https://github.com/JTWP-org/mod.io-modcheck/tree/main

=== '''Sharing Bans over gameserver on same machine''' ===
when you have a lot of servers keeping the bans synced can be a nightmare so using a symbolic link allows all the servers to use one file

for this lets say I have pavlovserver000 and pavlovserver001 and they are located at /home/steam/pavlovserver000 and /home/steam/pavlovserver001

''step 1 will be to pick a blacklist to use as the new one and move it to a central location''
mkdir ~/shared ; mv /home/steam/pavlovserver000/Pavlov/Saved/Config/blacklist.txt ~/shared/blacklist.txt ; rm /home/steam/pavlovserver001/Pavlov/Saved/Config/blacklist.txt
now we have moved the blacklist from pavlovserver000 to a folder in our home called shared and then we removed the blacklist from pavlovserver001

step 2 making the links
ln -s ~/shared/blacklist.txt /home/steam/pavlovserver000/Pavlov/Saved/Config/blacklist.txt ; ln -s ~/shared/blacklist.txt /home/steam/pavlovserver001/Pavlov/Saved/Config/blacklist.txt
now editing them in pavlovserver001's files will update the list for all of the servers it's not a sync its uses the same list if you want to check where a link is pointed if u
ls -l
It will show where the file is really located <hr>
=== Interactive Update ALL ===
will find all server installs on machine and update them will update Ubuntu check what version and do correct updates for that version also UPDATE 29 PCVR STEP then it will list each server by server name and ask what type it is and then it will update and move to the next

https://github.com/JTWP-org/Pavlov-updateallservers/tree/main<hr>

=== getting map info with just the UGC ===

you will need to get a API key from mod.io for this ... running this bash script and passing a UGC number to it will return the map name mod.io url and a thumbnail

`

nano get-map.sh

`

then enter this script

`

<nowiki>#</nowiki>!/bin/bash

ugc=000000

gameID=3959 #PAVLOV IS 3959

api-path="<nowiki>https://u-*ID</nowiki> NUMBER*.modapi.io/v1" #get on thhe access tab in mod.io settings

api-key="" #get on thhe access tab in mod.io settings

curl -X GET "${api-path}/v1/games/${gameID}/mods/$("${ugc:3})?api_key=${api-key}" -H 'Accept: application/json' | jq '.logo.thumb_1280x720, .name , .profile_url'

`

then give script perms to run

`

sudo chmod +x get-map.sh

`

and then run it like this

`

bash get-map.sh UGC3409480

`

Setting up a dedicated server

2023-11-19T20:34:56Z

SaltedCrackerJack: /* (Not required unless hosting large amount of servers ) */

== Setting up a dedicated server ==

'''There are no Windows binaries'''

This guide is written exclusively for Linux and covers Ubuntu/Debian/Debian-like and Red Hat RPM-based distros. Possible to run with other distros, but some of the commands won't work and you will need to know enough to figure out the software install of dependencies on your own.

If you are considering hosting from home, please read that section of the wiki first.

This guide assumes you know the basics of using a bash terminal: ssh'ing into a server, running bash commands, editing text files, etc.

If you have no experience using bash, maybe start [https://www.howtogeek.com/140679/beginner-geek-how-to-start-using-the-linux-terminal/ here]. Editing text files via commandline is often a challenge. Suggest using nano and reading guide [https://www.howtogeek.com/howto/42980/the-beginners-guide-to-nano-the-linux-command-line-text-editor/ here]

If you are new to linux and accessing your server from Windows, highly suggest using MobaXterm as your SSH client as that can make required editing of text files easier using built in editor instead of the native linux command line editors.

And finally, ask yourself why you want to setup a server? If you look at the list, there are many, many more servers than players. If you don't have a team, discord community, or group of friends ready to play on your server, chances are it will go unused. Got one of these... great, let's go.

If you don't want to go through the hassle yourself and want to pay for a hosting service Arctic VR (PC and Shack) and Horde (Shack) provide a server hosting services and are trusted in the community. See links below.

----

=== Server Requirements ===

'''Pavlovserver can only be hosted under Linux.'''

This can be running as a VM under windows, but this will increase the complexity of the setup beyond this guide.

Ubuntu 18.04 x86_64, Ubuntu 19/04 amd64, Ubuntu 20.04, and Rocky Linux 8 are confirmed working. Ubuntu 15.04 x86 is known to fail to install using this guide. Recommend not running on "minimal" images as some tools are missing.

* 2GB RAM + 1GB RAM per each additional server with 10 players. More RAM is recommended for larger maps, higher player counts, or complex gamemodes. Not having enough RAM is a common cause of server crashes.

* A ~2.5Ghz CPU will comfortably support a 10 player server.

* A ~4Ghz CPU will comfortably support 24 players. This is a limit built into Pavlov itself, no server will allow players to join over 24. Lower player counts are recommended for complex gamemodes (E.g. CodZ) and/or highly detailed maps, so that maximum number will often be lower.

(Note that these are '''not''' hard limits for player counts, just suggestions for the best performance, based on experiences with many server providers on different grades of hardware.)

* Pavlovserver is functionally single threaded (one thread does vast majority of work). More CPUs only help if you are running more servers. More clockspeed = higher performance = more users per server.
The maximum number of servers you can run is dependent on how many CPUs you have. For example, if you have an 8 core CPU, the maximum number of servers would be 7. You should always have at least one CPU free as overhead, as Pavlov servers can use slightly more than one thread.

----

==== Hosting at home ====
When hosting at home there are additional requirements regarding networking: Your router has to support port-forwarding, hair-pinning/LoopbackNAT, and respond to ping requests. These techniques are necessary to allow your server to be found and to talk back to the client. please see https://en.wikipedia.org/wiki/Port_forwarding, https://en.wikipedia.org/wiki/Hairpinning, and https://www.speedguide.net/faq/how-to-become-pingable-behind-a-routerfirewall-376 for more info and google for these terms in addition to your router model to find guides on how to enable/configure it properly. If you have modern Router, it may have these features already enabled, in this case you just have to configure port-forwarding. If you can see your server but not join it while others can, this is indicative of a failure of LoopbackNAT.

A second challenge to hosting at home is CGNAT (Carrier grade NAT: https://www.a10networks.com/blog/carrier-grade-nat/). Just like NAT on your home network that has to be gotten around w/ port-forwarding, CGNAT breaks the ability of external connections to be made back to your server, but the controls are solely in your ISPs hands. Sometimes if you ask, you can be removed from CGNAT pools and/or assigned a static IP. CGNAT rollouts are becoming very common now, so if your server worked then doesn't allow connections now, your ISP may have made this change.

You can check whether you’re on a CGNAT network by visiting a Web site such as ipaddress.com or whatsmyip.com and comparing the IP address listed to the public/WAN IP address assigned to your Internet gateway. To find your gateway’s public IP address, check the status page in the administrative interface. If the two IP addresses differ, you’re likely on a CGNAT network. If so, this problem must be resolved before you go any further.

'''Not understanding these requirements and configuration is a frequent cause of failed setups and questions in discord. Don't skip this if you are trying to host from home'''

'''There are serious security implications of hosting this software at home.''' None of the devs are security experts and there has been no security review of the code. You are opening up your system to the world and publicity advertising this fact. Expect that any system hosting this software is open to compromise from the Internet and act accordingly. If your router offers a DMZ network, use it. Consider hosting on a cloud based server and think twice before running this software on any system that contains data you care about or has access to networks and computers you care about.

If you're hosting at home using Oracle's VirtualBox, there are steps you can take to prevent double NAT (which can cause issues later on)

1. Select your VM and then click Settings in VirtualBox's main window.

2. Click on Network and change Attached To from NAT to Bridged Adapter.

Once you've done this, your VM should be connected directly to your home router and double NAT should no longer be a issue.

----

==== Starting Server Install ====

====Obtaining an ApiKey ====
(Not required unless hosting large amount of servers )

you can just comment this line out or remove it For your server to show up in the server list, there is now a requirement to have an ApiKey issued by vankrupt. This is to prevent DOS attacks against the master server

Get the key by going here: https://pavlov-ms.vankrupt.com/servers/v1/key and using your mobile number to get a SMS
(Note that there have been reported failures of this SMS system for non-US mobiles. In this case, DM davevillz your phone number and request a key)

Put this key in your Game.ini as follows:
ApiKey="ABC123FALSEKEYDONTUSEME"
or if you would like (personally untested..I would use Game.ini) you can call it at server runtime with flag as follows:
-KEY="ABC123FALSEKEYDONTUSEME"

This key can be re-used for a reasonable number of servers (a limit of 10 has been mentioned). Contact the Devs if you need more servers per key.

====System setup and software installation====

Install dependencies and create the `steam` user. (You only need to do this once):

Confirm Linux version
<pre>
lsb_release -a
</pre>

'''Ubuntu 20.04'''
'''''sudo apt update''''' && '''''sudo apt install''''' -y gdb curl lib32gcc1 libc++-dev unzip
sudo useradd -m steam
'''Ubuntu 20.10 or higher'''
sudo apt update && sudo apt install -y gdb curl lib32gcc-s1 libc++-dev unzip
sudo useradd -m steam
'''Rocky Linux, CentOS 8, and RHEL 8'''
sudo sed -i 's/^SELINUX=enforcing$/SELINUX=permissive/g' /etc/selinux/config
sudo setenforce 0
sudo yum install gdb curl glibc.i686 libstdc++.i686 libstdc++-devel.i686 libstdc++-devel.x86_64 unzip wget -y
wget <nowiki>https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/l/libcxx-3.8.0-3.el7.x86_64.rpm</nowiki>
sudo rpm -i libcxx-3.8.0-3.el7.x86_64.rpm
sudo useradd -m steam
[Optional] Set a password for steam.
<pre>sudo passwd steam</pre>

[Optional] Set the /bin/bash shell for the steam user this will allow you to use arrow keys in terminal and show what folder you are in at all times <pre>sudo chsh -s /bin/bash steam</pre>

Login as the Steam user. ('''You will need to do this each time you connect to your server'''):

<pre>
sudo su -l steam
</pre>

Install Steam:

<pre>
mkdir ~/Steam && cd ~/Steam && curl -sqL "https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz" | tar zxvf -
</pre>

There are different dedicated server versions for Pavlov Server - choose which server version you want to host (PC non-beta, PC Beta, Shack Live, or Shack RC)
(You will need to run this command each time there is a Pavlov Server update).

 
To host '''PC Server (non-beta)''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta default +exit

</pre>

To host '''PC BETA''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta beta_server +exit
</pre>

To host '''Shack Live''' (Quest):

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack +exit
</pre>

To host '''Shack RC''' (Quest): 

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack_beta +exit
</pre>

Now that we've installed the server, all pavlov server versions should continue. 
Install a fresh copy of steamclient.so (May have to do this after each update):
<pre>
~/Steam/steamcmd.sh +login anonymous +app_update 1007 +quit
mkdir -p ~/.steam/sdk64
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/pavlovserver/Pavlov/Binaries/Linux/steamclient.so
</pre>

The update 29 of the PCVR version of Pavlov and after added a requirement to run these commands to change the steamclient.so:
<code>sudo rm /usr/lib/x86_64-linux-gnu/libc++.so</code>
<code>sudo ln -s /usr/lib/x86_64-linux-gnu/libc++.so.1 /usr/lib/x86_64-linux-gnu/libc++.so</code>

Make the PavlovServer script executable. (You only need to do this once):

<pre>
chmod +x ~/pavlovserver/PavlovServer.sh
</pre>

----

=== Server Configuration ===

Before starting the server we need to configure it. Start by creating some directories:

<pre>
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Logs
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps
</pre>

==== Mods/Blacklist/Whitelist (optional) ====

The following three files allow you to specify mods, banned players, and whitelist players. These are optional, but go ahead and create them. Populating the files is described later.

<pre>
touch /home/steam/pavlovserver/Pavlov/Saved/Config/mods.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/blacklist.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/whitelist.txt
</pre>

====Configuring Game.ini====
Create a new Game.ini file using following command to open an editor and copy/paste the following block into it then save it. Note not all of these options are required. For instance remove or comment out the Password=0000 line to make a public server with no pin.
<pre>
nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini
</pre>

<pre>
[/Script/Pavlov.DedicatedServer]
bEnabled=true
ServerName="My_private_idaho"
MaxPlayers=10 #Set this to 10 for Shack. 24 is the max for PC, setting it higher will not allow players to join.
ApiKey="ABC123FALSEKEYDONTUSEME"
bSecured=true
bCustomServer=true
bVerboseLogging=false
bCompetitive=false #This only works for SND
bWhitelist=false
RefreshListTime=120
LimitedAmmoType=0
TickRate=90
TimeLimit=60
#Password=0000
#BalanceTableURL="vankruptgames/BalancingTable/main"
MapRotation=(MapId="UGC1758245796", GameMode="GUN")
MapRotation=(MapId="datacenter", GameMode="SND")
MapRotation=(MapId="sand", GameMode="DM")

</pre>

* '''bEnabled''' - whether the server appears in the server list (unconfirmed)
* '''ServerName''' - name it will be listed as. (approx 35 chars max)
* '''MaxPlayers''' - See suggested specs for limits. 10 standard (10 for shack), 20-24 is max recommended for large maps like Stalingrad or PUSH/RUSH modes, and servers allow a maximum of 24 players.
* '''ApiKey''' - Unique ApiKey required to register server with master server. Replace with your key
* '''bSecured''' - enabled Valve Anti-Cheat (VAC)
* '''bCustomServer''' - activates some new modding tools (save and http functions. Required to write to blacklist.txt for bans)
* '''bCompetitive''' - sets the server to competitive mode for SND. If removed the server will default to false
* '''bVerboseLogging''' - enables verbose logging, mostly detailed statistics. Be prepared for significant increase in logging.
* '''bWhitelist''' - Only allow users in whitelist.txt to join
* '''RefreshListTime''' - sets how often the running server checks for updates in ban/whitelist/mod files
* '''LimitedAmmoType''' - sets limited ammo mode, see Limited Ammo Types table below

* '''TimeLimit''' - sets time limit for each map
* '''TickRate''' - sets the server tickrate. (so far minimum stable seems around 50 and max around 120. Beware setting this changes weapon despawn time and breaks some game modes. Recommend not touching)
* '''Password''' - PIN number for server #FYI - this is now also changeable via rcon.
* '''BalanceTableURL''' - Points to a custom balance table from github. See https://github.com/vankruptgames/BalancingTable for instructions. This line isn't needed if you don't have one.
* '''MapRotation''' - you can add multiple of these. The map system has switched from the steam workshop to modio which means that the server rotation will need to be redone with modio UGCs. <nowiki>https://mod.io/g/pavlov</nowiki>. This is done by taking the resource ID from the modio page, adding “UGC” in front of it and then adding that to the rotation. For example the map gravity <nowiki>https://mod.io/g/pavlov/m/gravity1</nowiki> has a resource ID of 2773760 so the map ID to add to the server would be “UGC2773760”. When a match ends, the server will load the next map in the rotation.
* '''AFKTimeLimit''' There is now a feature to kick players who are idle in the game. Integers are measured in seconds and 0 disables AFK kicking completely.

Available game modes as of 09/06/2022: See Game modes table below

For maps running a Custom gamemode (CodZ, BR, Duel, etc.) it doesn't matter which gamemode you choose, as the map will automatically override it with the custom mode.

{| class="wikitable"
|+Limited Ammo Types
!AmmoType
!Name
!Description
|-
|0
|Unlimited
|Players have unlimited ammo, carry no ammo boxes and do not display an ammo count on the wrist.
|-
|1
|Limited Generic
|Players carry ammo boxes with a limited amount of ammo.
One box for each weapon class (Pistol, Submachine gun, Rifles/MGs, Shotgun, Sniper).

Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.

An ammo count is displayed on the wrist.
|-
|2
|Limited Specific
|Players carry ammo boxes with a limited amount of ammo.
One box for each weapon.

Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.

An ammo count is displayed on the wrist.
|-
|3
|Custom
|Allows for full control over ammo by the map.
|-
|4
| Limited Special
|'''All weapons except "special" weapons are unlimited, more clarification is needed.'''
|-
|5
|Boxless
|'''Like limited generic but without boxes? Clarification is needed.'''
|}
{| class="wikitable"
|+Game modes
!GameMode
!Name
|-
|DM
|Death match
|-
|KOTH
|King of the hill
|-
|GUN
| Gun game
|-
|OITC
| One in the chamber
|-
|SND
|Search and destroy
|-
|TANKTDM
|WW2 Team Death Match
|-
| TDM
|Team Death Match
|-
|TTT
|Trouble in Terrorist Town
|-
|TTTclassic
|TTT with only innocent/traitor/detective
|-
|WW2GUN
|WW2 gun game
|-
|ZWV
| Zombie wave survival
|-
|HIDE
|The Hidden
|-
|INFECTION
|Hidden infection
|-
|PUSH
|Push
|-
|PH
|Prop hunt
|}
= Default Map ID's =
datacenter

sand

bridge

containeryard

siberia (Prison Break)

hospital (Zombies map)

killhouse

range

tutorial

santorini

station

industry

ogcontainers (Shack only)

haguenau (Shack only)

foundation (Shack only)

stalingrad (PC only)

stalingrad_night (PC only)

santorini_night (PC only)

sand_night (PC only)

station_night (PC only)

industry_night (PC only)

bunker (PC only)

==== Firewall/Port forwarding ====
Using the default settings there are two UDP ports (7777, 8177) that need to be allowed to access the server either by firewall setup or port forwarding.

'''Ubuntu''' firewall commands to check firewall and open ports:
<pre>
sudo ufw status
sudo ufw allow 7777
sudo ufw allow 8177
sudo ufw allow 9100
sudo ufw status
</pre>

'''Rocky Linux''' firewall commands to check the firewall and open ports:
<pre>
sudo firewall-cmd --zone=public --add-port=7777/tcp
sudo firewall-cmd --zone=public --add-port=7777/udp
sudo firewall-cmd --zone=public --add-port=8177/tcp
sudo firewall-cmd --zone=public --add-port=8177/udp
sudo firewall-cmd --zone=public --add-port=9100/udp
sudo firewall-cmd --zone=public --add-port=9100/tcp
sudo firewall-cmd --list-ports
firewall-cmd --runtime-to-permanent
</pre>

You may also need to allow Pings (ICMP) for the server's true latency to appear in the master list.

If you are running multiple servers and have set additional ports (see http://pavlovwiki.com/index.php/Setting_up_a_dedicated_server#Running_multiple_servers_on_one_host) then you need to allow access to the defined port plus the port 400 higher. So if you use 7000 as your port, then UDP 7000 and 7400 need to be open

If you have setup rcon via RconSettings.txt (below) then that port also needs to be allowed access via TCP

If you are running Shack/Quest and want to have maps that are downloadable from your server, your server ports (ex. 7777 & 8177) must also be open via TCP

----

==== Shack Maps (Quest) ====

If you try to use the steps above to add maps for Shack, you'll run into issues very quickly. This is because Shack has no affiliation with Steam, and therefore cannot use Steam Workshop maps like the above. In the future, these steps will apply to PC servers as well, allowing a server to hold the map itself, instead of offloading it to Steam.

To get started, first, create the directory to hold the maps

<pre>mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps</pre>

You can use any number of methods to move the map files onto the server, but I'll go over the two simplest, starting with a GUI approach

Download and install Cyberduck onto your "home" PC (Whatever PC you use for access to the server, but not the server itself): https://cyberduck.io/

Next, download and unzip your map of choice from https://www.pavlovquest.com/ , https://pavlovhorde.com/mapsList, or look in #shack-map-showcase channel in the discord server. I'm going to use Cheeto's WW2 Items test (http://www.mediafire.com/file/emyt9bs1z9u9ykw/SVR_Cheeto_Items.zip/file ) for this example, you do what you like

In the top left corner, open a connection, set the connection type to SFTP, and fill in the rest of the information. The username is typically `root`, password is whatever you set the root pw as (toor in Ubuntu by default)

In the directory dropdown (it will say /root) go back to /

Follow the directories until we arrive back at our "maps" folder <pre>/home/steam/pavlovserver/Pavlov/Saved/maps</pre>

Drag and drop the unzipped map folder into the main window, in this case itll be SVR_Cheeto_Items

Hit Allow

You'll now see a folder named SVR_Cheeto_Items, and within it should be nothing but 3 files. If there is another folder in it, move this folder to the maps directory, otherwise the server won't work. The 3 files (2 .PAK one .JSON) should be in home/steam/pavlovserver/Pavlov/Saved/maps/SVR_Cheeto_Items, no more, no less.

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

To play the map, you can either use RCON switch map command, or to add the map to your server's automatic map rotation list, add the map's folder name to your Game.ini. This replaces the MapID section, so for our example, it would be

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

And that's all! Disconnect CyberDuck from your server before playing, otherwise you'll have difficulty joining.

-----------

==== Adding Shack Maps over Command Line Interface ====

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

A bit more complicated, but adding maps over CLI has its benefits

First, CD to the maps directory you made above

<pre>cd ~/pavlovserver/Pavlov/Saved/maps</pre>

Download the map files from whatever you use to upload them. To do this, you can either use curl or wget

<pre>curl -O insertURLhere</pre>

'''If you download your map from Google Drive''', make sure that your .zip folder is shared with anyone.
Then, get the file's URL from the shared link. Example : ''<nowiki>https://drive.google.com/file/d/19bI8gUHaN5tUrDvnadAacUnchQf6_k/view</nowiki>'' will be ''19bI8gUHaN5tUrDvnadAacUnchQf6_k''
Edit "fileId" and "fileName" before you execute the command.
<pre>
fileId=19bI8gUHaN5tUrDvnadAacUnchQf6_k
fileName=SVR_USER_MAPNAME
curl -sc /tmp/cookie "https://drive.google.com/uc?export=download&id=${fileId}" > /dev/null
code="$(awk '/_warning_/ {print $NF}' /tmp/cookie)"
curl -Lb /tmp/cookie "https://drive.google.com/uc?export=download&confirm=${code}&id=${fileId}" -o ${fileName} </pre>

To keep with the Items example:

<pre>curl -O https://cdn.discordapp.com/attachments/744185280759857234/745027406695366788/SVR_Cheeto_Items.zip</pre>

Next, unzip the file. If this next step errors out, saying the command is unknown, switch back to the root user (su root), and install unzip (sudo apt install unzip), then return to the steam user, and continue.

<pre>unzip SVR_Cheeto_Items.zip</pre>

Now finish like before by adding the map to your Game.ini

<pre>nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini</pre>

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

==== Admin/Moderator list (optional) ====

The only working in-game admin menu is through Arctic VR server hosting (see below).

If you add moderators to your server, they will not be subject to vote kicks.

<pre>
nano ~/pavlovserver/Pavlov/Saved/Config/mods.txt
</pre>

Example Mod List:
<pre>
76541198397498572 #Optional Comment: Player name
76541198397498573 #Some Other Player
</pre>

==== ArcticVR Admin Menu ====

[[File:Arcticmenu.jpg|500px|link=https://www.arctic-vr.com/server-admin-menu]]

Arctic-VR Offers an advanced In-Game Admin menu that is exclusive to their hosting service. Features include:
* Switch Maps+Modes
* Teleport Players to Players
* Change Player Skins
* Control Player Buying+Cash
* Spawn Items
* Clean up corpses + guns
* Spawn Bots
* Spawn Items for other players
* Control Teams + Balance/Shuffle Teams
* ResetSND
* And More

You can read more about the ArcticVR admin menu on their website: https://www.arctic-vr.com/server-admin-menu

==== Handy tools for finding steamIDs ====

Steam ID finder: https://steamidfinder.com/lookup/ or https://steamid.xyz/

You want to enter in the steamID64 format.

This tool can convert or lookup IDs: https://steamid.io/

If you are looking for a steamID of a player that has been on your server recently this is technique to find them:
<pre>
grep -i playername ~/pavlovserver/Pavlov/Saved/Logs/* | grep TicketValidation
</pre>

=== Configure Rcon ===
To enable Rcon access create config file:
<pre> nano /home/steam/pavlovserver/Pavlov/Saved/Config/RconSettings.txt </pre>

Copy in the following text - change password, and if desired the port:
<pre>
Password=ChangeThisPassword
Port=9100
</pre>
You must specify a port for the Rcon server to use as well as a Password (use a different port per sever instance if running multiple server instances off the same hardware)

=== Starting the server ===

<pre>
cd ~/pavlovserver && ./PavlovServer.sh
</pre>

That's it, your server will be automatically broadcast to the master server! :)

Two handy tools to determine quickly if your server is broadcasting are [https://pablub.xyz/ Pablub] (PC only) and [https://pavlovhorde.com/ Horde] (Shack) and [https://pavlovhorde.com/pcServers Horde] (PC version)

Note that when you close your terminal, the server will go down. See the "supervisors" section below for how to prevent this.

----

=== Supervising the server using systemd ===

Running '''./PavlovServer.sh''' in your interactive shell is easy, but the server will shut down when you close your terminal. If you want to run the server in the background,
you'll want to run it under a supervisor. There are many options, ranging from the simple (nohup, screen or tmux), to the
more robust (supervisord, systemd).

Systemd is running by default on Ubuntu Linux, so we'll use that here.

To run the server as a systemd service, create the file '''/etc/systemd/system/pavlovserver.service''' (as root) by typing
<pre>
sudo nano /etc/systemd/system/pavlovserver.service
</pre>

Copy the contents below into the file and save.

<pre>
[Unit]
Description=Pavlov VR dedicated server

[Service]
Type=simple
WorkingDirectory=/home/steam/pavlovserver
ExecStart=/home/steam/pavlovserver/PavlovServer.sh

RestartSec=1
Restart=always
User=steam
Group=steam

[Install]
WantedBy = multi-user.target
</pre>

If you'd like your server to start as competitive without editing the game.ini, change the line "ExecStart=/home/steam/pavlovserver/PavlovServer.sh" to look like this below. Though it's much easier to just use the game.ini to enable competitive instead. <pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -COMPETITIVE=1</pre>

Change the user or paths as appropriate. After saving the service file, to start, restart, stop, or monitor the server:

<pre>
sudo systemctl start pavlovserver
sudo systemctl restart pavlovserver
sudo systemctl stop pavlovserver
sudo systemctl status pavlovserver
</pre>

To view the logs:

<pre>
sudo journalctl -u pavlovserver
# to live-tail the logs
sudo journalctl -u pavlovserver -f
</pre>

If you want to run the pavlov server as soon as your server boots (e.g. a VPS you turn on and off), add pavlov as a startup service:

<pre>
sudo systemctl enable pavlovserver
</pre>

----

== Advanced Server Administration ==

=== Running multiple servers on one host ===

* Pavlovserver is functionally single-threaded (there are multiple threads, but the vast majority of work occurs in the primary one). Make sure you have # of pavlovservers + 1 CPU available. More CPUs= more servers. Faster CPU = more players.
* Make multiple server installs by defining a separate install dir for each server.
* Run each server with a unique port. eg: '''./PavlovServer.sh -PORT="Desired Port"'''
* The Server will use the Desired Port and the Port 400 above (Example: You choose 8200 as Port. So Port 8600 will be used as well)
* If you are using RCON, each server will need a unique port defined in RconSettings.txt
* Ensure the ports are forwarded and opened in your firewall

To duplicate directories:

be in the steam home folder
<pre>
cp -r pavlovserver pavlovserver1
/home/steam/pavlovserver1/PavlovServer.sh -PORT=[Desired Port]
</pre>

=== Starting server in competitive mode ===
Competitive mode will prevent dead teammates from being able to see the match, to prevent ghosting.
You can either enable this via Game.ini (described in Game.ini file), or using the -COMPETITIVE=1 parameter.

<pre>
/home/steam/pavlovserver1/PavlovServer.sh -COMPETITIVE=1
</pre>

{| class="wikitable"

|}

=== Useful Linux Commands ===
List files / folders in directory, print current working directory,
<pre>ls -la #list files/directories along with authorities and ownership
pwd #print working directory
sudo chown <owner> <file/directory> #change owner of file/directory. If root created something and you need to change it to steam
sudo chgrp <group> <file/directory> #change group of file/directory.
</pre>

Check if pavlov is running by checking process status. If the only row you see is the grep command, pavlov server is not started.
<pre> ps -ef | grep pav </pre>

Sample output:
<pre>
steam 34044 1 0 16:52 ? 00:00:00 /bin/sh /home/steam/pavlovserver/PavlovServer.sh
steam 34066 34044 80 16:52 ? 00:00:04 /home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer
zombies+ 34101 34013 0 16:52 pts/0 00:00:00 grep --color=auto pav
</pre>

Kill a process. Note this command uses 34044, which is a process id from the command output above.
<pre> kill -9 34044 </pre>

Dump the log to the console so you can scroll through it:
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log </pre>

Search the log for a string - replace my_string with case-sensitive string
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep my_string </pre>

<hr>

== Advanced Scripts For Server Management ==
<hr>

=== '''Auto-updating the server (PCVR only)''' ===
Assuming you have followed this guide and used the default paths, users, and install instructions, you can paste the following into your terminal to auto-update your Pavlov server:

<pre>
cat << 'EOF' > $HOME/pavlov_daily_update_and_restart.sh
#!/bin/bash

USER="steam"
SERVICENAME="pavlovserver.service"
INSTALLDIRNAME="pavlovserver"
USERHOME="/home/$USER"

echo -e "Beginning Pavlov VR update run on $(date)\n\n"

systemctl stop "$SERVICENAME"

sleep 5
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +force_install_dir "$USERHOME/$INSTALLDIRNAME" +app_update 622970 +exit
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +app_update 1007 +quit
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/.steam/sdk64/steamclient.so"
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/pavlovserver/Pavlov/Binaries/Linux/steamclient.so"

systemctl start "$SERVICENAME"

echo -e "Ending Pavlov VR update run on $(date)\n\n"

EOF

chmod +x $HOME/pavlov_daily_update_and_restart.sh
mkdir $HOME/pavlov_update_logs && touch $HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log
CRONLINE="00 2 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
(sudo crontab -u root -l; echo "$CRONLINE" ) | sudo crontab -u root -
unset CRONLINE

</pre>

These commands will:

1. Create a shell script in the "steam" user's home directory that automatically stops the Pavlov server, pulls any updates via steam, pull updates to the Steamworks SDK Redist, and copies the latest version of steamclient.so to the Pavlov server directory

2. Make the shell script executable

3. Create a new directory called "pavlov_update_logs" in the "steam" user's directory, and create a logfile inside that directory called "pavlov_daily_update_and_restart.sh.log". You can check this logfile to see the output of the Pavlov and Steam SDK update commands.

4. Create a crontab entry for the root user that runs this shell script automatically every day at 2:00AM local time

If you want to change the time that this script runs, edit the numbers "00 2" in the line that starts with "CRONLINE=". In the example provided, 00 is the minutes column, and 2 is the hour column. For example, if you wanted the server to automatically update and restart at 4:17AM every day, change the line starting with "CRONLINE=" to:

<pre>
CRONLINE="17 4 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
</pre>

If the time is PM, use 24-hour time format, e.g. "32 18" for 6:32PM.
<hr>
=== '''Save Logs for records and stats''' ===
this is an automated script that will on a timer save all the backups made by the server before they are purged by the game for admin records and starts collection

https://github.com/JTWP-org/backUpLogs2
<hr>

=== '''Make an API request with Mod.io to get map picture and name''' ===
very basic script pass the script a map ID as an argument then it will give u the name and a thumbnail to use

https://github.com/JTWP-org/mod.io-modcheck/tree/main

=== '''Sharing Bans over gameserver on same machine''' ===
when you have a lot of servers keeping the bans synced can be a nightmare so using a symbolic link allows all the servers to use one file

for this lets say I have pavlovserver000 and pavlovserver001 and they are located at /home/steam/pavlovserver000 and /home/steam/pavlovserver001

''step 1 will be to pick a blacklist to use as the new one and move it to a central location''
mkdir ~/shared ; mv /home/steam/pavlovserver000/Pavlov/Saved/Config/blacklist.txt ~/shared/blacklist.txt ; rm /home/steam/pavlovserver001/Pavlov/Saved/Config/blacklist.txt
now we have moved the blacklist from pavlovserver000 to a folder in our home called shared and then we removed the blacklist from pavlovserver001

step 2 making the links
ln -s ~/shared/blacklist.txt /home/steam/pavlovserver000/Pavlov/Saved/Config/blacklist.txt ; ln -s ~/shared/blacklist.txt /home/steam/pavlovserver001/Pavlov/Saved/Config/blacklist.txt
now editing them in pavlovserver001's files will update the list for all of the servers it's not a sync its uses the same list if you want to check where a link is pointed if u
ls -l
It will show where the file is really located <hr>
=== Interactive Update ALL ===
will find all server installs on machine and update them will update Ubuntu check what version and do correct updates for that version also UPDATE 29 PCVR STEP then it will list each server by server name and ask what type it is and then it will update and move to the next

https://github.com/JTWP-org/Pavlov-updateallservers/tree/main<hr>

Setting up a dedicated server

2023-11-02T05:05:18Z

SaltedCrackerJack: /* System setup and software installation */

== Setting up a dedicated server ==

'''There are no Windows binaries'''

This guide is written exclusively for Linux and covers Ubuntu/Debian/Debian-like and Red Hat RPM-based distros. Possible to run with other distros, but some of the commands won't work and you will need to know enough to figure out the software install of dependencies on your own.

If you are considering hosting from home, please read that section of the wiki first.

This guide assumes you know the basics of using a bash terminal: ssh'ing into a server, running bash commands, editing text files, etc.

If you have no experience using bash, maybe start [https://www.howtogeek.com/140679/beginner-geek-how-to-start-using-the-linux-terminal/ here]. Editing text files via commandline is often a challenge. Suggest using nano and reading guide [https://www.howtogeek.com/howto/42980/the-beginners-guide-to-nano-the-linux-command-line-text-editor/ here]

If you are new to linux and accessing your server from Windows, highly suggest using MobaXterm as your SSH client as that can make required editing of text files easier using built in editor instead of the native linux command line editors.

And finally, ask yourself why you want to setup a server? If you look at the list, there are many, many more servers than players. If you don't have a team, discord community, or group of friends ready to play on your server, chances are it will go unused. Got one of these... great, let's go.

If you don't want to go through the hassle yourself and want to pay for a hosting service Arctic VR (PC and Shack) and Horde (Shack) provide a server hosting services and are trusted in the community. See links below.

----

=== Server Requirements ===

'''Pavlovserver can only be hosted under Linux.'''

This can be running as a VM under windows, but this will increase the complexity of the setup beyond this guide.

Ubuntu 18.04 x86_64, Ubuntu 19/04 amd64, Ubuntu 20.04, and Rocky Linux 8 are confirmed working. Ubuntu 15.04 x86 is known to fail to install using this guide. Recommend not running on "minimal" images as some tools are missing.

* 2GB RAM + 1GB RAM per each additional server with 10 players. More RAM is recommended for larger maps, higher player counts, or complex gamemodes. Not having enough RAM is a common cause of server crashes.

* A ~2.5Ghz CPU will comfortably support a 10 player server.

* A ~4Ghz CPU will comfortably support 24 players. This is a limit built into Pavlov itself, no server will allow players to join over 24. Lower player counts are recommended for complex gamemodes (E.g. CodZ) and/or highly detailed maps, so that maximum number will often be lower.

(Note that these are '''not''' hard limits for player counts, just suggestions for the best performance, based on experiences with many server providers on different grades of hardware.)

* Pavlovserver is functionally single threaded (one thread does vast majority of work). More CPUs only help if you are running more servers. More clockspeed = higher performance = more users per server.
The maximum number of servers you can run is dependent on how many CPUs you have. For example, if you have an 8 core CPU, the maximum number of servers would be 7. You should always have at least one CPU free as overhead, as Pavlov servers can use slightly more than one thread.

----

==== Hosting at home ====
When hosting at home there are additional requirements regarding networking: Your router has to support port-forwarding, hair-pinning/LoopbackNAT, and respond to ping requests. These techniques are necessary to allow your server to be found and to talk back to the client. please see https://en.wikipedia.org/wiki/Port_forwarding, https://en.wikipedia.org/wiki/Hairpinning, and https://www.speedguide.net/faq/how-to-become-pingable-behind-a-routerfirewall-376 for more info and google for these terms in addition to your router model to find guides on how to enable/configure it properly. If you have modern Router, it may have these features already enabled, in this case you just have to configure port-forwarding. If you can see your server but not join it while others can, this is indicative of a failure of LoopbackNAT.

A second challenge to hosting at home is CGNAT (Carrier grade NAT: https://www.a10networks.com/blog/carrier-grade-nat/). Just like NAT on your home network that has to be gotten around w/ port-forwarding, CGNAT breaks the ability of external connections to be made back to your server, but the controls are solely in your ISPs hands. Sometimes if you ask, you can be removed from CGNAT pools and/or assigned a static IP. CGNAT rollouts are becoming very common now, so if your server worked then doesn't allow connections now, your ISP may have made this change.

You can check whether you’re on a CGNAT network by visiting a Web site such as ipaddress.com or whatsmyip.com and comparing the IP address listed to the public/WAN IP address assigned to your Internet gateway. To find your gateway’s public IP address, check the status page in the administrative interface. If the two IP addresses differ, you’re likely on a CGNAT network. If so, this problem must be resolved before you go any further.

'''Not understanding these requirements and configuration is a frequent cause of failed setups and questions in discord. Don't skip this if you are trying to host from home'''

'''There are serious security implications of hosting this software at home.''' None of the devs are security experts and there has been no security review of the code. You are opening up your system to the world and publicity advertising this fact. Expect that any system hosting this software is open to compromise from the Internet and act accordingly. If your router offers a DMZ network, use it. Consider hosting on a cloud based server and think twice before running this software on any system that contains data you care about or has access to networks and computers you care about.

If you're hosting at home using Oracle's VirtualBox, there are steps you can take to prevent double NAT (which can cause issues later on)

1. Select your VM and then click Settings in VirtualBox's main window.

2. Click on Network and change Attached To from NAT to Bridged Adapter.

Once you've done this, your VM should be connected directly to your home router and double NAT should no longer be a issue.

----

==== Starting Server Install ====

====Obtaining an ApiKey ====
====(Not required unless hosting large amount of servers )====
you can just comment this line out or remove it For your server to show up in the server list, there is now a requirement to have an ApiKey issued by vankrupt. This is to prevent DOS attacks against the master server

Get the key by going here: https://pavlov-ms.vankrupt.com/servers/v1/key and using your mobile number to get a SMS
(Note that there have been reported failures of this SMS system for non-US mobiles. In this case, DM davevillz your phone number and request a key)

Put this key in your Game.ini as follows:
ApiKey="ABC123FALSEKEYDONTUSEME"
or if you would like (personally untested..I would use Game.ini) you can call it at server runtime with flag as follows:
-KEY="ABC123FALSEKEYDONTUSEME"

This key can be re-used for a reasonable number of servers (a limit of 10 has been mentioned). Contact the Devs if you need more servers per key.

====System setup and software installation====

Install dependencies and create the `steam` user. (You only need to do this once):

Confirm Linux version
<pre>
lsb_release -a
</pre>

'''Ubuntu 20.04'''
'''''sudo apt update''''' && '''''sudo apt install''''' -y gdb curl lib32gcc1 libc++-dev unzip
sudo useradd -m steam
'''Ubuntu 20.10 or higher'''
sudo apt update && sudo apt install -y gdb curl lib32gcc-s1 libc++-dev unzip
sudo useradd -m steam
'''Rocky Linux, CentOS 8, and RHEL 8'''
sudo sed -i 's/^SELINUX=enforcing$/SELINUX=permissive/g' /etc/selinux/config
sudo setenforce 0
sudo yum install gdb curl glibc.i686 libstdc++.i686 libstdc++-devel.i686 libstdc++-devel.x86_64 unzip wget -y
wget <nowiki>https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/l/libcxx-3.8.0-3.el7.x86_64.rpm</nowiki>
sudo rpm -i libcxx-3.8.0-3.el7.x86_64.rpm
sudo useradd -m steam
[Optional] Set a password for steam.
<pre>sudo passwd steam</pre>

[Optional] Set the /bin/bash shell for the steam user this will allow you to use arrow keys in terminal and show what folder you are in at all times <pre>sudo chsh -s /bin/bash steam</pre>

Login as the Steam user. ('''You will need to do this each time you connect to your server'''):

<pre>
sudo su -l steam
</pre>

Install Steam:

<pre>
mkdir ~/Steam && cd ~/Steam && curl -sqL "https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz" | tar zxvf -
</pre>

There are different dedicated server versions for Pavlov Server - choose which server version you want to host (PC non-beta, PC Beta, Shack Live, or Shack RC)
(You will need to run this command each time there is a Pavlov Server update).

 
To host '''PC Server (non-beta)''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta default +exit

</pre>

To host '''PC BETA''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta beta_server +exit
</pre>

To host '''Shack Live''' (Quest):

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack +exit
</pre>

To host '''Shack RC''' (Quest): 

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack_beta +exit
</pre>

Now that we've installed the server, all pavlov server versions should continue. 
Install a fresh copy of steamclient.so (May have to do this after each update):
<pre>
~/Steam/steamcmd.sh +login anonymous +app_update 1007 +quit
mkdir -p ~/.steam/sdk64
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/pavlovserver/Pavlov/Binaries/Linux/steamclient.so
</pre>

The update 29 of the PCVR version of Pavlov and after added a requirement to run these commands to change the steamclient.so:
<code>sudo rm /usr/lib/x86_64-linux-gnu/libc++.so</code>
<code>sudo ln -s /usr/lib/x86_64-linux-gnu/libc++.so.1 /usr/lib/x86_64-linux-gnu/libc++.so</code>

Make the PavlovServer script executable. (You only need to do this once):

<pre>
chmod +x ~/pavlovserver/PavlovServer.sh
</pre>

----

=== Server Configuration ===

Before starting the server we need to configure it. Start by creating some directories:

<pre>
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Logs
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps
</pre>

==== Mods/Blacklist/Whitelist (optional) ====

The following three files allow you to specify mods, banned players, and whitelist players. These are optional, but go ahead and create them. Populating the files is described later.

<pre>
touch /home/steam/pavlovserver/Pavlov/Saved/Config/mods.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/blacklist.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/whitelist.txt
</pre>

====Configuring Game.ini====
Create a new Game.ini file using following command to open an editor and copy/paste the following block into it then save it. Note not all of these options are required. For instance remove or comment out the Password=0000 line to make a public server with no pin.
<pre>
nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini
</pre>

<pre>
[/Script/Pavlov.DedicatedServer]
bEnabled=true
ServerName="My_private_idaho"
MaxPlayers=10 #Set this to 10 for Shack. 24 is the max for PC, setting it higher will not allow players to join.
ApiKey="ABC123FALSEKEYDONTUSEME"
bSecured=true
bCustomServer=true
bVerboseLogging=false
bCompetitive=false #This only works for SND
bWhitelist=false
RefreshListTime=120
LimitedAmmoType=0
TickRate=90
TimeLimit=60
#Password=0000
#BalanceTableURL="vankruptgames/BalancingTable/main"
MapRotation=(MapId="UGC1758245796", GameMode="GUN")
MapRotation=(MapId="datacenter", GameMode="SND")
MapRotation=(MapId="sand", GameMode="DM")

</pre>

* '''bEnabled''' - whether the server appears in the server list (unconfirmed)
* '''ServerName''' - name it will be listed as. (approx 35 chars max)
* '''MaxPlayers''' - See suggested specs for limits. 10 standard (10 for shack), 20-24 is max recommended for large maps like Stalingrad or PUSH/RUSH modes, and servers allow a maximum of 24 players.
* '''ApiKey''' - Unique ApiKey required to register server with master server. Replace with your key
* '''bSecured''' - enabled Valve Anti-Cheat (VAC)
* '''bCustomServer''' - activates some new modding tools (save and http functions. Required to write to blacklist.txt for bans)
* '''bCompetitive''' - sets the server to competitive mode for SND. If removed the server will default to false
* '''bVerboseLogging''' - enables verbose logging, mostly detailed statistics. Be prepared for significant increase in logging.
* '''bWhitelist''' - Only allow users in whitelist.txt to join
* '''RefreshListTime''' - sets how often the running server checks for updates in ban/whitelist/mod files
* '''LimitedAmmoType''' - sets limited ammo mode, see Limited Ammo Types table below

* '''TimeLimit''' - sets time limit for each map
* '''TickRate''' - sets the server tickrate. (so far minimum stable seems around 50 and max around 120. Beware setting this changes weapon despawn time and breaks some game modes. Recommend not touching)
* '''Password''' - PIN number for server #FYI - this is now also changeable via rcon.
* '''BalanceTableURL''' - Points to a custom balance table from github. See https://github.com/vankruptgames/BalancingTable for instructions. This line isn't needed if you don't have one.
* '''MapRotation''' - you can add multiple of these. The map system has switched from the steam workshop to modio which means that the server rotation will need to be redone with modio UGCs. <nowiki>https://mod.io/g/pavlov</nowiki>. This is done by taking the resource ID from the modio page, adding “UGC” in front of it and then adding that to the rotation. For example the map gravity <nowiki>https://mod.io/g/pavlov/m/gravity1</nowiki> has a resource ID of 2773760 so the map ID to add to the server would be “UGC2773760”. When a match ends, the server will load the next map in the rotation.
* '''AFKTimeLimit''' There is now a feature to kick players who are idle in the game. Integers are measured in seconds and 0 disables AFK kicking completely.

Available game modes as of 09/06/2022: See Game modes table below

For maps running a Custom gamemode (CodZ, BR, Duel, etc.) it doesn't matter which gamemode you choose, as the map will automatically override it with the custom mode.

{| class="wikitable"
|+Limited Ammo Types
!AmmoType
!Name
!Description
|-
|0
|Unlimited
|Players have unlimited ammo, carry no ammo boxes and do not display an ammo count on the wrist.
|-
|1
|Limited Generic
|Players carry ammo boxes with a limited amount of ammo.
One box for each weapon class (Pistol, Submachine gun, Rifles/MGs, Shotgun, Sniper).

Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.

An ammo count is displayed on the wrist.
|-
|2
|Limited Specific
|Players carry ammo boxes with a limited amount of ammo.
One box for each weapon.

Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.

An ammo count is displayed on the wrist.
|-
|3
|Custom
|Allows for full control over ammo by the map.
|-
|4
| Limited Special
|'''All weapons except "special" weapons are unlimited, more clarification is needed.'''
|-
|5
|Boxless
|'''Like limited generic but without boxes? Clarification is needed.'''
|}
{| class="wikitable"
|+Game modes
!GameMode
!Name
|-
|DM
|Death match
|-
|KOTH
|King of the hill
|-
|GUN
| Gun game
|-
|OITC
| One in the chamber
|-
|SND
|Search and destroy
|-
|TANKTDM
|WW2 Team Death Match
|-
| TDM
|Team Death Match
|-
|TTT
|Trouble in Terrorist Town
|-
|TTTclassic
|TTT with only innocent/traitor/detective
|-
|WW2GUN
|WW2 gun game
|-
|ZWV
| Zombie wave survival
|-
|HIDE
|The Hidden
|-
|INFECTION
|Hidden infection
|-
|PUSH
|Push
|-
|PH
|Prop hunt
|}
= Default Map ID's =
datacenter

sand

bridge

containeryard

siberia (Prison Break)

hospital (Zombies map)

killhouse

range

tutorial

santorini

station

industry

ogcontainers (Shack only)

haguenau (Shack only)

foundation (Shack only)

stalingrad (PC only)

stalingrad_night (PC only)

santorini_night (PC only)

sand_night (PC only)

station_night (PC only)

industry_night (PC only)

bunker (PC only)

==== Firewall/Port forwarding ====
Using the default settings there are two UDP ports (7777, 8177) that need to be allowed to access the server either by firewall setup or port forwarding.

'''Ubuntu''' firewall commands to check firewall and open ports:
<pre>
sudo ufw status
sudo ufw allow 7777
sudo ufw allow 8177
sudo ufw allow 9100
sudo ufw status
</pre>

'''Rocky Linux''' firewall commands to check the firewall and open ports:
<pre>
sudo firewall-cmd --zone=public --add-port=7777/tcp
sudo firewall-cmd --zone=public --add-port=7777/udp
sudo firewall-cmd --zone=public --add-port=8177/tcp
sudo firewall-cmd --zone=public --add-port=8177/udp
sudo firewall-cmd --zone=public --add-port=9100/udp
sudo firewall-cmd --zone=public --add-port=9100/tcp
sudo firewall-cmd --list-ports
firewall-cmd --runtime-to-permanent
</pre>

You may also need to allow Pings (ICMP) for the server's true latency to appear in the master list.

If you are running multiple servers and have set additional ports (see http://pavlovwiki.com/index.php/Setting_up_a_dedicated_server#Running_multiple_servers_on_one_host) then you need to allow access to the defined port plus the port 400 higher. So if you use 7000 as your port, then UDP 7000 and 7400 need to be open

If you have setup rcon via RconSettings.txt (below) then that port also needs to be allowed access via TCP

If you are running Shack/Quest and want to have maps that are downloadable from your server, your server ports (ex. 7777 & 8177) must also be open via TCP

----

==== Shack Maps (Quest) ====

If you try to use the steps above to add maps for Shack, you'll run into issues very quickly. This is because Shack has no affiliation with Steam, and therefore cannot use Steam Workshop maps like the above. In the future, these steps will apply to PC servers as well, allowing a server to hold the map itself, instead of offloading it to Steam.

To get started, first, create the directory to hold the maps

<pre>mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps</pre>

You can use any number of methods to move the map files onto the server, but I'll go over the two simplest, starting with a GUI approach

Download and install Cyberduck onto your "home" PC (Whatever PC you use for access to the server, but not the server itself): https://cyberduck.io/

Next, download and unzip your map of choice from https://www.pavlovquest.com/ , https://pavlovhorde.com/mapsList, or look in #shack-map-showcase channel in the discord server. I'm going to use Cheeto's WW2 Items test (http://www.mediafire.com/file/emyt9bs1z9u9ykw/SVR_Cheeto_Items.zip/file ) for this example, you do what you like

In the top left corner, open a connection, set the connection type to SFTP, and fill in the rest of the information. The username is typically `root`, password is whatever you set the root pw as (toor in Ubuntu by default)

In the directory dropdown (it will say /root) go back to /

Follow the directories until we arrive back at our "maps" folder <pre>/home/steam/pavlovserver/Pavlov/Saved/maps</pre>

Drag and drop the unzipped map folder into the main window, in this case itll be SVR_Cheeto_Items

Hit Allow

You'll now see a folder named SVR_Cheeto_Items, and within it should be nothing but 3 files. If there is another folder in it, move this folder to the maps directory, otherwise the server won't work. The 3 files (2 .PAK one .JSON) should be in home/steam/pavlovserver/Pavlov/Saved/maps/SVR_Cheeto_Items, no more, no less.

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

To play the map, you can either use RCON switch map command, or to add the map to your server's automatic map rotation list, add the map's folder name to your Game.ini. This replaces the MapID section, so for our example, it would be

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

And that's all! Disconnect CyberDuck from your server before playing, otherwise you'll have difficulty joining.

-----------

==== Adding Shack Maps over Command Line Interface ====

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

A bit more complicated, but adding maps over CLI has its benefits

First, CD to the maps directory you made above

<pre>cd ~/pavlovserver/Pavlov/Saved/maps</pre>

Download the map files from whatever you use to upload them. To do this, you can either use curl or wget

<pre>curl -O insertURLhere</pre>

'''If you download your map from Google Drive''', make sure that your .zip folder is shared with anyone.
Then, get the file's URL from the shared link. Example : ''<nowiki>https://drive.google.com/file/d/19bI8gUHaN5tUrDvnadAacUnchQf6_k/view</nowiki>'' will be ''19bI8gUHaN5tUrDvnadAacUnchQf6_k''
Edit "fileId" and "fileName" before you execute the command.
<pre>
fileId=19bI8gUHaN5tUrDvnadAacUnchQf6_k
fileName=SVR_USER_MAPNAME
curl -sc /tmp/cookie "https://drive.google.com/uc?export=download&id=${fileId}" > /dev/null
code="$(awk '/_warning_/ {print $NF}' /tmp/cookie)"
curl -Lb /tmp/cookie "https://drive.google.com/uc?export=download&confirm=${code}&id=${fileId}" -o ${fileName} </pre>

To keep with the Items example:

<pre>curl -O https://cdn.discordapp.com/attachments/744185280759857234/745027406695366788/SVR_Cheeto_Items.zip</pre>

Next, unzip the file. If this next step errors out, saying the command is unknown, switch back to the root user (su root), and install unzip (sudo apt install unzip), then return to the steam user, and continue.

<pre>unzip SVR_Cheeto_Items.zip</pre>

Now finish like before by adding the map to your Game.ini

<pre>nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini</pre>

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

==== Admin/Moderator list (optional) ====

The only working in-game admin menu is through Arctic VR server hosting (see below).

If you add moderators to your server, they will not be subject to vote kicks.

<pre>
nano ~/pavlovserver/Pavlov/Saved/Config/mods.txt
</pre>

Example Mod List:
<pre>
76541198397498572 #Optional Comment: Player name
76541198397498573 #Some Other Player
</pre>

==== ArcticVR Admin Menu ====

[[File:Arcticmenu.jpg|500px|link=https://www.arctic-vr.com/server-admin-menu]]

Arctic-VR Offers an advanced In-Game Admin menu that is exclusive to their hosting service. Features include:
* Switch Maps+Modes
* Teleport Players to Players
* Change Player Skins
* Control Player Buying+Cash
* Spawn Items
* Clean up corpses + guns
* Spawn Bots
* Spawn Items for other players
* Control Teams + Balance/Shuffle Teams
* ResetSND
* And More

You can read more about the ArcticVR admin menu on their website: https://www.arctic-vr.com/server-admin-menu

==== Handy tools for finding steamIDs ====

Steam ID finder: https://steamidfinder.com/lookup/ or https://steamid.xyz/

You want to enter in the steamID64 format.

This tool can convert or lookup IDs: https://steamid.io/

If you are looking for a steamID of a player that has been on your server recently this is technique to find them:
<pre>
grep -i playername ~/pavlovserver/Pavlov/Saved/Logs/* | grep TicketValidation
</pre>

=== Configure Rcon ===
To enable Rcon access create config file:
<pre> nano /home/steam/pavlovserver/Pavlov/Saved/Config/RconSettings.txt </pre>

Copy in the following text - change password, and if desired the port:
<pre>
Password=ChangeThisPassword
Port=9100
</pre>
You must specify a port for the Rcon server to use as well as a Password (use a different port per sever instance if running multiple server instances off the same hardware)

=== Starting the server ===

<pre>
cd ~/pavlovserver && ./PavlovServer.sh
</pre>

That's it, your server will be automatically broadcast to the master server! :)

Two handy tools to determine quickly if your server is broadcasting are [https://pablub.xyz/ Pablub] (PC only) and [https://pavlovhorde.com/ Horde] (Shack) and [https://pavlovhorde.com/pcServers Horde] (PC version)

Note that when you close your terminal, the server will go down. See the "supervisors" section below for how to prevent this.

----

=== Supervising the server using systemd ===

Running '''./PavlovServer.sh''' in your interactive shell is easy, but the server will shut down when you close your terminal. If you want to run the server in the background,
you'll want to run it under a supervisor. There are many options, ranging from the simple (nohup, screen or tmux), to the
more robust (supervisord, systemd).

Systemd is running by default on Ubuntu Linux, so we'll use that here.

To run the server as a systemd service, create the file '''/etc/systemd/system/pavlovserver.service''' (as root) by typing
<pre>
sudo nano /etc/systemd/system/pavlovserver.service
</pre>

Copy the contents below into the file and save.

<pre>
[Unit]
Description=Pavlov VR dedicated server

[Service]
Type=simple
WorkingDirectory=/home/steam/pavlovserver
ExecStart=/home/steam/pavlovserver/PavlovServer.sh

RestartSec=1
Restart=always
User=steam
Group=steam

[Install]
WantedBy = multi-user.target
</pre>

If you'd like your server to start as competitive without editing the game.ini, change the line "ExecStart=/home/steam/pavlovserver/PavlovServer.sh" to look like this below. Though it's much easier to just use the game.ini to enable competitive instead. <pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -COMPETITIVE=1</pre>

Change the user or paths as appropriate. After saving the service file, to start, restart, stop, or monitor the server:

<pre>
sudo systemctl start pavlovserver
sudo systemctl restart pavlovserver
sudo systemctl stop pavlovserver
sudo systemctl status pavlovserver
</pre>

To view the logs:

<pre>
sudo journalctl -u pavlovserver
# to live-tail the logs
sudo journalctl -u pavlovserver -f
</pre>

If you want to run the pavlov server as soon as your server boots (e.g. a VPS you turn on and off), add pavlov as a startup service:

<pre>
sudo systemctl enable pavlovserver
</pre>

----

== Advanced Server Administration ==

=== Running multiple servers on one host ===

* Pavlovserver is functionally single-threaded (there are multiple threads, but the vast majority of work occurs in the primary one). Make sure you have # of pavlovservers + 1 CPU available. More CPUs= more servers. Faster CPU = more players.
* Make multiple server installs by defining a separate install dir for each server.
* Run each server with a unique port. eg: '''./PavlovServer.sh -PORT="Desired Port"'''
* The Server will use the Desired Port and the Port 400 above (Example: You choose 8200 as Port. So Port 8600 will be used as well)
* If you are using RCON, each server will need a unique port defined in RconSettings.txt
* Ensure the ports are forwarded and opened in your firewall

To duplicate directories:

be in the steam home folder
<pre>
cp -r pavlovserver pavlovserver1
/home/steam/pavlovserver1/PavlovServer.sh -PORT=[Desired Port]
</pre>

=== Starting server in competitive mode ===
Competitive mode will prevent dead teammates from being able to see the match, to prevent ghosting.
You can either enable this via Game.ini (described in Game.ini file), or using the -COMPETITIVE=1 parameter.

<pre>
/home/steam/pavlovserver1/PavlovServer.sh -COMPETITIVE=1
</pre>

{| class="wikitable"

|}

=== Useful Linux Commands ===
List files / folders in directory, print current working directory,
<pre>ls -la #list files/directories along with authorities and ownership
pwd #print working directory
sudo chown <owner> <file/directory> #change owner of file/directory. If root created something and you need to change it to steam
sudo chgrp <group> <file/directory> #change group of file/directory.
</pre>

Check if pavlov is running by checking process status. If the only row you see is the grep command, pavlov server is not started.
<pre> ps -ef | grep pav </pre>

Sample output:
<pre>
steam 34044 1 0 16:52 ? 00:00:00 /bin/sh /home/steam/pavlovserver/PavlovServer.sh
steam 34066 34044 80 16:52 ? 00:00:04 /home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer
zombies+ 34101 34013 0 16:52 pts/0 00:00:00 grep --color=auto pav
</pre>

Kill a process. Note this command uses 34044, which is a process id from the command output above.
<pre> kill -9 34044 </pre>

Dump the log to the console so you can scroll through it:
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log </pre>

Search the log for a string - replace my_string with case-sensitive string
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep my_string </pre>

<hr>

== Advanced Scripts For Server Management ==
<hr>

=== '''Auto-updating the server (PCVR only)''' ===
Assuming you have followed this guide and used the default paths, users, and install instructions, you can paste the following into your terminal to auto-update your Pavlov server:

<pre>
cat << 'EOF' > $HOME/pavlov_daily_update_and_restart.sh
#!/bin/bash

USER="steam"
SERVICENAME="pavlovserver.service"
INSTALLDIRNAME="pavlovserver"
USERHOME="/home/$USER"

echo -e "Beginning Pavlov VR update run on $(date)\n\n"

systemctl stop "$SERVICENAME"

sleep 5
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +force_install_dir "$USERHOME/$INSTALLDIRNAME" +app_update 622970 +exit
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +app_update 1007 +quit
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/.steam/sdk64/steamclient.so"
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/pavlovserver/Pavlov/Binaries/Linux/steamclient.so"

systemctl start "$SERVICENAME"

echo -e "Ending Pavlov VR update run on $(date)\n\n"

EOF

chmod +x $HOME/pavlov_daily_update_and_restart.sh
mkdir $HOME/pavlov_update_logs && touch $HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log
CRONLINE="00 2 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
(sudo crontab -u root -l; echo "$CRONLINE" ) | sudo crontab -u root -
unset CRONLINE

</pre>

These commands will:

1. Create a shell script in the "steam" user's home directory that automatically stops the Pavlov server, pulls any updates via steam, pull updates to the Steamworks SDK Redist, and copies the latest version of steamclient.so to the Pavlov server directory

2. Make the shell script executable

3. Create a new directory called "pavlov_update_logs" in the "steam" user's directory, and create a logfile inside that directory called "pavlov_daily_update_and_restart.sh.log". You can check this logfile to see the output of the Pavlov and Steam SDK update commands.

4. Create a crontab entry for the root user that runs this shell script automatically every day at 2:00AM local time

If you want to change the time that this script runs, edit the numbers "00 2" in the line that starts with "CRONLINE=". In the example provided, 00 is the minutes column, and 2 is the hour column. For example, if you wanted the server to automatically update and restart at 4:17AM every day, change the line starting with "CRONLINE=" to:

<pre>
CRONLINE="17 4 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
</pre>

If the time is PM, use 24-hour time format, e.g. "32 18" for 6:32PM.
<hr>
=== '''Save Logs for records and stats''' ===
this is an automated script that will on a timer save all the backups made by the server before they are purged by the game for admin records and starts collection

https://github.com/JTWP-org/backUpLogs2
<hr>

=== '''Make an API request with Mod.io to get map picture and name''' ===
very basic script pass the script a map ID as an argument then it will give u the name and a thumbnail to use

https://github.com/JTWP-org/mod.io-modcheck/tree/main

=== '''Sharing Bans over gameserver on same machine''' ===
when you have a lot of servers keeping the bans synced can be a nightmare so using a symbolic link allows all the servers to use one file

for this lets say I have pavlovserver000 and pavlovserver001 and they are located at /home/steam/pavlovserver000 and /home/steam/pavlovserver001

''step 1 will be to pick a blacklist to use as the new one and move it to a central location''
mkdir ~/shared ; mv /home/steam/pavlovserver000/Pavlov/Saved/Config/blacklist.txt ~/shared/blacklist.txt ; rm /home/steam/pavlovserver001/Pavlov/Saved/Config/blacklist.txt
now we have moved the blacklist from pavlovserver000 to a folder in our home called shared and then we removed the blacklist from pavlovserver001

step 2 making the links
ln -s ~/shared/blacklist.txt /home/steam/pavlovserver000/Pavlov/Saved/Config/blacklist.txt ; ln -s ~/shared/blacklist.txt /home/steam/pavlovserver001/Pavlov/Saved/Config/blacklist.txt
now editing them in pavlovserver001's files will update the list for all of the servers it's not a sync its uses the same list if you want to check where a link is pointed if u
ls -l
It will show where the file is really located <hr>
=== Interactive Update ALL ===
will find all server installs on machine and update them will update Ubuntu check what version and do correct updates for that version also UPDATE 29 PCVR STEP then it will list each server by server name and ask what type it is and then it will update and move to the next

https://github.com/JTWP-org/Pavlov-updateallservers/tree/main<hr>

Setting up a dedicated server

2023-11-01T22:45:21Z

SaltedCrackerJack: /* (Not required unless hosting large amount of servers ) */

== Setting up a dedicated server ==

'''There are no Windows binaries'''

This guide is written exclusively for Linux and covers Ubuntu/Debian/Debian-like and Red Hat RPM-based distros. Possible to run with other distros, but some of the commands won't work and you will need to know enough to figure out the software install of dependencies on your own.

If you are considering hosting from home, please read that section of the wiki first.

This guide assumes you know the basics of using a bash terminal: ssh'ing into a server, running bash commands, editing text files, etc.

If you have no experience using bash, maybe start [https://www.howtogeek.com/140679/beginner-geek-how-to-start-using-the-linux-terminal/ here]. Editing text files via commandline is often a challenge. Suggest using nano and reading guide [https://www.howtogeek.com/howto/42980/the-beginners-guide-to-nano-the-linux-command-line-text-editor/ here]

If you are new to linux and accessing your server from Windows, highly suggest using MobaXterm as your SSH client as that can make required editing of text files easier using built in editor instead of the native linux command line editors.

And finally, ask yourself why you want to setup a server? If you look at the list, there are many, many more servers than players. If you don't have a team, discord community, or group of friends ready to play on your server, chances are it will go unused. Got one of these... great, let's go.

If you don't want to go through the hassle yourself and want to pay for a hosting service Arctic VR (PC and Shack) and Horde (Shack) provide a server hosting services and are trusted in the community. See links below.

----

=== Server Requirements ===

'''Pavlovserver can only be hosted under Linux.'''

This can be running as a VM under windows, but this will increase the complexity of the setup beyond this guide.

Ubuntu 18.04 x86_64, Ubuntu 19/04 amd64, Ubuntu 20.04, and Rocky Linux 8 are confirmed working. Ubuntu 15.04 x86 is known to fail to install using this guide. Recommend not running on "minimal" images as some tools are missing.

* 2GB RAM + 1GB RAM per each additional server with 10 players. More RAM is recommended for larger maps, higher player counts, or complex gamemodes. Not having enough RAM is a common cause of server crashes.

* A ~2.5Ghz CPU will comfortably support a 10 player server.

* A ~4Ghz CPU will comfortably support 24 players. This is a limit built into Pavlov itself, no server will allow players to join over 24. Lower player counts are recommended for complex gamemodes (E.g. CodZ) and/or highly detailed maps, so that maximum number will often be lower.

(Note that these are '''not''' hard limits for player counts, just suggestions for the best performance, based on experiences with many server providers on different grades of hardware.)

* Pavlovserver is functionally single threaded (one thread does vast majority of work). More CPUs only help if you are running more servers. More clockspeed = higher performance = more users per server.
The maximum number of servers you can run is dependent on how many CPUs you have. For example, if you have an 8 core CPU, the maximum number of servers would be 7. You should always have at least one CPU free as overhead, as Pavlov servers can use slightly more than one thread.

----

==== Hosting at home ====
When hosting at home there are additional requirements regarding networking: Your router has to support port-forwarding, hair-pinning/LoopbackNAT, and respond to ping requests. These techniques are necessary to allow your server to be found and to talk back to the client. please see https://en.wikipedia.org/wiki/Port_forwarding, https://en.wikipedia.org/wiki/Hairpinning, and https://www.speedguide.net/faq/how-to-become-pingable-behind-a-routerfirewall-376 for more info and google for these terms in addition to your router model to find guides on how to enable/configure it properly. If you have modern Router, it may have these features already enabled, in this case you just have to configure port-forwarding. If you can see your server but not join it while others can, this is indicative of a failure of LoopbackNAT.

A second challenge to hosting at home is CGNAT (Carrier grade NAT: https://www.a10networks.com/blog/carrier-grade-nat/). Just like NAT on your home network that has to be gotten around w/ port-forwarding, CGNAT breaks the ability of external connections to be made back to your server, but the controls are solely in your ISPs hands. Sometimes if you ask, you can be removed from CGNAT pools and/or assigned a static IP. CGNAT rollouts are becoming very common now, so if your server worked then doesn't allow connections now, your ISP may have made this change.

You can check whether you’re on a CGNAT network by visiting a Web site such as ipaddress.com or whatsmyip.com and comparing the IP address listed to the public/WAN IP address assigned to your Internet gateway. To find your gateway’s public IP address, check the status page in the administrative interface. If the two IP addresses differ, you’re likely on a CGNAT network. If so, this problem must be resolved before you go any further.

'''Not understanding these requirements and configuration is a frequent cause of failed setups and questions in discord. Don't skip this if you are trying to host from home'''

'''There are serious security implications of hosting this software at home.''' None of the devs are security experts and there has been no security review of the code. You are opening up your system to the world and publicity advertising this fact. Expect that any system hosting this software is open to compromise from the Internet and act accordingly. If your router offers a DMZ network, use it. Consider hosting on a cloud based server and think twice before running this software on any system that contains data you care about or has access to networks and computers you care about.

If you're hosting at home using Oracle's VirtualBox, there are steps you can take to prevent double NAT (which can cause issues later on)

1. Select your VM and then click Settings in VirtualBox's main window.

2. Click on Network and change Attached To from NAT to Bridged Adapter.

Once you've done this, your VM should be connected directly to your home router and double NAT should no longer be a issue.

----

==== Starting Server Install ====

====Obtaining an ApiKey ====
====(Not required unless hosting large amount of servers )====
you can just comment this line out or remove it For your server to show up in the server list, there is now a requirement to have an ApiKey issued by vankrupt. This is to prevent DOS attacks against the master server

Get the key by going here: https://pavlov-ms.vankrupt.com/servers/v1/key and using your mobile number to get a SMS
(Note that there have been reported failures of this SMS system for non-US mobiles. In this case, DM davevillz your phone number and request a key)

Put this key in your Game.ini as follows:
ApiKey="ABC123FALSEKEYDONTUSEME"
or if you would like (personally untested..I would use Game.ini) you can call it at server runtime with flag as follows:
-KEY="ABC123FALSEKEYDONTUSEME"

This key can be re-used for a reasonable number of servers (a limit of 10 has been mentioned). Contact the Devs if you need more servers per key.

====System setup and software installation====

Install dependencies and create the `steam` user. (You only need to do this once):

Confirm Linux version
<pre>
lsb_release -a
</pre>

'''Ubuntu 20.04'''
'''''sudo apt update''''' && '''''sudo apt install''''' -y gdb curl lib32gcc1 libc++-dev unzip
sudo useradd -m steam
'''Ubuntu 20.10 or higher'''
sudo apt update && sudo apt install -y gdb curl lib32gcc-s1 libc++-dev unzip
sudo useradd -m steam
'''Rocky Linux, CentOS 8, and RHEL 8'''
sudo sed -i 's/^SELINUX=enforcing$/SELINUX=permissive/g' /etc/selinux/config
sudo setenforce 0
sudo yum install gdb curl glibc.i686 libstdc++.i686 libstdc++-devel.i686 libstdc++-devel.x86_64 unzip wget -y
wget <nowiki>https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/l/libcxx-3.8.0-3.el7.x86_64.rpm</nowiki>
sudo rpm -i libcxx-3.8.0-3.el7.x86_64.rpm
sudo useradd -m steam
[Optional] Set a password for steam.
<pre>sudo passwd steam</pre>

Login as the Steam user. ('''You will need to do this each time you connect to your server'''):

<pre>
sudo su -l steam
</pre>

Install Steam:

<pre>
mkdir ~/Steam && cd ~/Steam && curl -sqL "https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz" | tar zxvf -
</pre>

There are different dedicated server versions for Pavlov Server - choose which server version you want to host (PC non-beta, PC Beta, Shack Live, or Shack RC)
(You will need to run this command each time there is a Pavlov Server update).

 
To host '''PC Server (non-beta)''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta default +exit

</pre>

To host '''PC BETA''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta beta_server +exit
</pre>

To host '''Shack Live''' (Quest):

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack +exit
</pre>

To host '''Shack RC''' (Quest): 

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack_beta +exit
</pre>

Now that we've installed the server, all pavlov server versions should continue. 
Install a fresh copy of steamclient.so (May have to do this after each update):
<pre>
~/Steam/steamcmd.sh +login anonymous +app_update 1007 +quit
mkdir -p ~/.steam/sdk64
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/pavlovserver/Pavlov/Binaries/Linux/steamclient.so
</pre>

The update 29 of the PCVR version of Pavlov and after added a requirement to run these commands to change the steamclient.so:
<code>sudo rm /usr/lib/x86_64-linux-gnu/libc++.so</code>
<code>sudo ln -s /usr/lib/x86_64-linux-gnu/libc++.so.1 /usr/lib/x86_64-linux-gnu/libc++.so</code>

Make the PavlovServer script executable. (You only need to do this once):

<pre>
chmod +x ~/pavlovserver/PavlovServer.sh
</pre>

----

=== Server Configuration ===

Before starting the server we need to configure it. Start by creating some directories:

<pre>
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Logs
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps
</pre>

==== Mods/Blacklist/Whitelist (optional) ====

The following three files allow you to specify mods, banned players, and whitelist players. These are optional, but go ahead and create them. Populating the files is described later.

<pre>
touch /home/steam/pavlovserver/Pavlov/Saved/Config/mods.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/blacklist.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/whitelist.txt
</pre>

====Configuring Game.ini====
Create a new Game.ini file using following command to open an editor and copy/paste the following block into it then save it. Note not all of these options are required. For instance remove or comment out the Password=0000 line to make a public server with no pin.
<pre>
nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini
</pre>

<pre>
[/Script/Pavlov.DedicatedServer]
bEnabled=true
ServerName="My_private_idaho"
MaxPlayers=10 #Set this to 10 for Shack. 24 is the max for PC, setting it higher will not allow players to join.
ApiKey="ABC123FALSEKEYDONTUSEME"
bSecured=true
bCustomServer=true
bVerboseLogging=false
bCompetitive=false #This only works for SND
bWhitelist=false
RefreshListTime=120
LimitedAmmoType=0
TickRate=90
TimeLimit=60
#Password=0000
#BalanceTableURL="vankruptgames/BalancingTable/main"
MapRotation=(MapId="UGC1758245796", GameMode="GUN")
MapRotation=(MapId="datacenter", GameMode="SND")
MapRotation=(MapId="sand", GameMode="DM")

</pre>

* '''bEnabled''' - whether the server appears in the server list (unconfirmed)
* '''ServerName''' - name it will be listed as. (approx 35 chars max)
* '''MaxPlayers''' - See suggested specs for limits. 10 standard (10 for shack), 20-24 is max recommended for large maps like Stalingrad or PUSH/RUSH modes, and servers allow a maximum of 24 players.
* '''ApiKey''' - Unique ApiKey required to register server with master server. Replace with your key
* '''bSecured''' - enabled Valve Anti-Cheat (VAC)
* '''bCustomServer''' - activates some new modding tools (save and http functions. Required to write to blacklist.txt for bans)
* '''bCompetitive''' - sets the server to competitive mode for SND. If removed the server will default to false
* '''bVerboseLogging''' - enables verbose logging, mostly detailed statistics. Be prepared for significant increase in logging.
* '''bWhitelist''' - Only allow users in whitelist.txt to join
* '''RefreshListTime''' - sets how often the running server checks for updates in ban/whitelist/mod files
* '''LimitedAmmoType''' - sets limited ammo mode, see Limited Ammo Types table below

* '''TimeLimit''' - sets time limit for each map
* '''TickRate''' - sets the server tickrate. (so far minimum stable seems around 50 and max around 120. Beware setting this changes weapon despawn time and breaks some game modes. Recommend not touching)
* '''Password''' - PIN number for server #FYI - this is now also changeable via rcon.
* '''BalanceTableURL''' - Points to a custom balance table from github. See https://github.com/vankruptgames/BalancingTable for instructions. This line isn't needed if you don't have one.
* '''MapRotation''' - you can add multiple of these. The map system has switched from the steam workshop to modio which means that the server rotation will need to be redone with modio UGCs. <nowiki>https://mod.io/g/pavlov</nowiki>. This is done by taking the resource ID from the modio page, adding “UGC” in front of it and then adding that to the rotation. For example the map gravity <nowiki>https://mod.io/g/pavlov/m/gravity1</nowiki> has a resource ID of 2773760 so the map ID to add to the server would be “UGC2773760”. When a match ends, the server will load the next map in the rotation.
* '''AFKTimeLimit''' There is now a feature to kick players who are idle in the game. Integers are measured in seconds and 0 disables AFK kicking completely.

Available game modes as of 09/06/2022: See Game modes table below

For maps running a Custom gamemode (CodZ, BR, Duel, etc.) it doesn't matter which gamemode you choose, as the map will automatically override it with the custom mode.

{| class="wikitable"
|+Limited Ammo Types
!AmmoType
!Name
!Description
|-
|0
|Unlimited
|Players have unlimited ammo, carry no ammo boxes and do not display an ammo count on the wrist.
|-
|1
|Limited Generic
|Players carry ammo boxes with a limited amount of ammo.
One box for each weapon class (Pistol, Submachine gun, Rifles/MGs, Shotgun, Sniper).

Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.

An ammo count is displayed on the wrist.
|-
|2
|Limited Specific
|Players carry ammo boxes with a limited amount of ammo.
One box for each weapon.

Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.

An ammo count is displayed on the wrist.
|-
|3
|Custom
|Allows for full control over ammo by the map.
|-
|4
| Limited Special
|'''All weapons except "special" weapons are unlimited, more clarification is needed.'''
|-
|5
|Boxless
|'''Like limited generic but without boxes? Clarification is needed.'''
|}
{| class="wikitable"
|+Game modes
!GameMode
!Name
|-
|DM
|Death match
|-
|KOTH
|King of the hill
|-
|GUN
| Gun game
|-
|OITC
| One in the chamber
|-
|SND
|Search and destroy
|-
|TANKTDM
|WW2 Team Death Match
|-
| TDM
|Team Death Match
|-
|TTT
|Trouble in Terrorist Town
|-
|TTTclassic
|TTT with only innocent/traitor/detective
|-
|WW2GUN
|WW2 gun game
|-
|ZWV
| Zombie wave survival
|-
|HIDE
|The Hidden
|-
|INFECTION
|Hidden infection
|-
|PUSH
|Push
|-
|PH
|Prop hunt
|}
= Default Map ID's =
datacenter

sand

bridge

containeryard

siberia (Prison Break)

hospital (Zombies map)

killhouse

range

tutorial

santorini

station

industry

ogcontainers (Shack only)

haguenau (Shack only)

foundation (Shack only)

stalingrad (PC only)

stalingrad_night (PC only)

santorini_night (PC only)

sand_night (PC only)

station_night (PC only)

industry_night (PC only)

bunker (PC only)

==== Firewall/Port forwarding ====
Using the default settings there are two UDP ports (7777, 8177) that need to be allowed to access the server either by firewall setup or port forwarding.

'''Ubuntu''' firewall commands to check firewall and open ports:
<pre>
sudo ufw status
sudo ufw allow 7777
sudo ufw allow 8177
sudo ufw allow 9100
sudo ufw status
</pre>

'''Rocky Linux''' firewall commands to check the firewall and open ports:
<pre>
sudo firewall-cmd --zone=public --add-port=7777/tcp
sudo firewall-cmd --zone=public --add-port=7777/udp
sudo firewall-cmd --zone=public --add-port=8177/tcp
sudo firewall-cmd --zone=public --add-port=8177/udp
sudo firewall-cmd --zone=public --add-port=9100/udp
sudo firewall-cmd --zone=public --add-port=9100/tcp
sudo firewall-cmd --list-ports
firewall-cmd --runtime-to-permanent
</pre>

You may also need to allow Pings (ICMP) for the server's true latency to appear in the master list.

If you are running multiple servers and have set additional ports (see http://pavlovwiki.com/index.php/Setting_up_a_dedicated_server#Running_multiple_servers_on_one_host) then you need to allow access to the defined port plus the port 400 higher. So if you use 7000 as your port, then UDP 7000 and 7400 need to be open

If you have setup rcon via RconSettings.txt (below) then that port also needs to be allowed access via TCP

If you are running Shack/Quest and want to have maps that are downloadable from your server, your server ports (ex. 7777 & 8177) must also be open via TCP

----

==== Shack Maps (Quest) ====

If you try to use the steps above to add maps for Shack, you'll run into issues very quickly. This is because Shack has no affiliation with Steam, and therefore cannot use Steam Workshop maps like the above. In the future, these steps will apply to PC servers as well, allowing a server to hold the map itself, instead of offloading it to Steam.

To get started, first, create the directory to hold the maps

<pre>mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps</pre>

You can use any number of methods to move the map files onto the server, but I'll go over the two simplest, starting with a GUI approach

Download and install Cyberduck onto your "home" PC (Whatever PC you use for access to the server, but not the server itself): https://cyberduck.io/

Next, download and unzip your map of choice from https://www.pavlovquest.com/ , https://pavlovhorde.com/mapsList, or look in #shack-map-showcase channel in the discord server. I'm going to use Cheeto's WW2 Items test (http://www.mediafire.com/file/emyt9bs1z9u9ykw/SVR_Cheeto_Items.zip/file ) for this example, you do what you like

In the top left corner, open a connection, set the connection type to SFTP, and fill in the rest of the information. The username is typically `root`, password is whatever you set the root pw as (toor in Ubuntu by default)

In the directory dropdown (it will say /root) go back to /

Follow the directories until we arrive back at our "maps" folder <pre>/home/steam/pavlovserver/Pavlov/Saved/maps</pre>

Drag and drop the unzipped map folder into the main window, in this case itll be SVR_Cheeto_Items

Hit Allow

You'll now see a folder named SVR_Cheeto_Items, and within it should be nothing but 3 files. If there is another folder in it, move this folder to the maps directory, otherwise the server won't work. The 3 files (2 .PAK one .JSON) should be in home/steam/pavlovserver/Pavlov/Saved/maps/SVR_Cheeto_Items, no more, no less.

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

To play the map, you can either use RCON switch map command, or to add the map to your server's automatic map rotation list, add the map's folder name to your Game.ini. This replaces the MapID section, so for our example, it would be

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

And that's all! Disconnect CyberDuck from your server before playing, otherwise you'll have difficulty joining.

-----------

==== Adding Shack Maps over Command Line Interface ====

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

A bit more complicated, but adding maps over CLI has its benefits

First, CD to the maps directory you made above

<pre>cd ~/pavlovserver/Pavlov/Saved/maps</pre>

Download the map files from whatever you use to upload them. To do this, you can either use curl or wget

<pre>curl -O insertURLhere</pre>

'''If you download your map from Google Drive''', make sure that your .zip folder is shared with anyone.
Then, get the file's URL from the shared link. Example : ''<nowiki>https://drive.google.com/file/d/19bI8gUHaN5tUrDvnadAacUnchQf6_k/view</nowiki>'' will be ''19bI8gUHaN5tUrDvnadAacUnchQf6_k''
Edit "fileId" and "fileName" before you execute the command.
<pre>
fileId=19bI8gUHaN5tUrDvnadAacUnchQf6_k
fileName=SVR_USER_MAPNAME
curl -sc /tmp/cookie "https://drive.google.com/uc?export=download&id=${fileId}" > /dev/null
code="$(awk '/_warning_/ {print $NF}' /tmp/cookie)"
curl -Lb /tmp/cookie "https://drive.google.com/uc?export=download&confirm=${code}&id=${fileId}" -o ${fileName} </pre>

To keep with the Items example:

<pre>curl -O https://cdn.discordapp.com/attachments/744185280759857234/745027406695366788/SVR_Cheeto_Items.zip</pre>

Next, unzip the file. If this next step errors out, saying the command is unknown, switch back to the root user (su root), and install unzip (sudo apt install unzip), then return to the steam user, and continue.

<pre>unzip SVR_Cheeto_Items.zip</pre>

Now finish like before by adding the map to your Game.ini

<pre>nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini</pre>

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

==== Admin/Moderator list (optional) ====

The only working in-game admin menu is through Arctic VR server hosting (see below).

If you add moderators to your server, they will not be subject to vote kicks.

<pre>
nano ~/pavlovserver/Pavlov/Saved/Config/mods.txt
</pre>

Example Mod List:
<pre>
76541198397498572 #Optional Comment: Player name
76541198397498573 #Some Other Player
</pre>

==== ArcticVR Admin Menu ====

[[File:Arcticmenu.jpg|500px|link=https://www.arctic-vr.com/server-admin-menu]]

Arctic-VR Offers an advanced In-Game Admin menu that is exclusive to their hosting service. Features include:
* Switch Maps+Modes
* Teleport Players to Players
* Change Player Skins
* Control Player Buying+Cash
* Spawn Items
* Clean up corpses + guns
* Spawn Bots
* Spawn Items for other players
* Control Teams + Balance/Shuffle Teams
* ResetSND
* And More

You can read more about the ArcticVR admin menu on their website: https://www.arctic-vr.com/server-admin-menu

==== Handy tools for finding steamIDs ====

Steam ID finder: https://steamidfinder.com/lookup/ or https://steamid.xyz/

You want to enter in the steamID64 format.

This tool can convert or lookup IDs: https://steamid.io/

If you are looking for a steamID of a player that has been on your server recently this is technique to find them:
<pre>
grep -i playername ~/pavlovserver/Pavlov/Saved/Logs/* | grep TicketValidation
</pre>

=== Configure Rcon ===
To enable Rcon access create config file:
<pre> nano /home/steam/pavlovserver/Pavlov/Saved/Config/RconSettings.txt </pre>

Copy in the following text - change password, and if desired the port:
<pre>
Password=ChangeThisPassword
Port=9100
</pre>
You must specify a port for the Rcon server to use as well as a Password (use a different port per sever instance if running multiple server instances off the same hardware)

=== Starting the server ===

<pre>
cd ~/pavlovserver && ./PavlovServer.sh
</pre>

That's it, your server will be automatically broadcast to the master server! :)

Two handy tools to determine quickly if your server is broadcasting are [https://pablub.xyz/ Pablub] (PC only) and [https://pavlovhorde.com/ Horde] (Shack) and [https://pavlovhorde.com/pcServers Horde] (PC version)

Note that when you close your terminal, the server will go down. See the "supervisors" section below for how to prevent this.

----

=== Supervising the server using systemd ===

Running '''./PavlovServer.sh''' in your interactive shell is easy, but the server will shut down when you close your terminal. If you want to run the server in the background,
you'll want to run it under a supervisor. There are many options, ranging from the simple (nohup, screen or tmux), to the
more robust (supervisord, systemd).

Systemd is running by default on Ubuntu Linux, so we'll use that here.

To run the server as a systemd service, create the file '''/etc/systemd/system/pavlovserver.service''' (as root) by typing
<pre>
sudo nano /etc/systemd/system/pavlovserver.service
</pre>

Copy the contents below into the file and save.

<pre>
[Unit]
Description=Pavlov VR dedicated server

[Service]
Type=simple
WorkingDirectory=/home/steam/pavlovserver
ExecStart=/home/steam/pavlovserver/PavlovServer.sh

RestartSec=1
Restart=always
User=steam
Group=steam

[Install]
WantedBy = multi-user.target
</pre>

If you'd like your server to start as competitive without editing the game.ini, change the line "ExecStart=/home/steam/pavlovserver/PavlovServer.sh" to look like this below. Though it's much easier to just use the game.ini to enable competitive instead. <pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -COMPETITIVE=1</pre>

Change the user or paths as appropriate. After saving the service file, to start, restart, stop, or monitor the server:

<pre>
sudo systemctl start pavlovserver
sudo systemctl restart pavlovserver
sudo systemctl stop pavlovserver
sudo systemctl status pavlovserver
</pre>

To view the logs:

<pre>
sudo journalctl -u pavlovserver
# to live-tail the logs
sudo journalctl -u pavlovserver -f
</pre>

If you want to run the pavlov server as soon as your server boots (e.g. a VPS you turn on and off), add pavlov as a startup service:

<pre>
sudo systemctl enable pavlovserver
</pre>

----

== Advanced Server Administration ==

=== Running multiple servers on one host ===

* Pavlovserver is functionally single-threaded (there are multiple threads, but the vast majority of work occurs in the primary one). Make sure you have # of pavlovservers + 1 CPU available. More CPUs= more servers. Faster CPU = more players.
* Make multiple server installs by defining a separate install dir for each server.
* Run each server with a unique port. eg: '''./PavlovServer.sh -PORT="Desired Port"'''
* The Server will use the Desired Port and the Port 400 above (Example: You choose 8200 as Port. So Port 8600 will be used as well)
* If you are using RCON, each server will need a unique port defined in RconSettings.txt
* Ensure the ports are forwarded and opened in your firewall

To duplicate directories:

be in the steam home folder
<pre>
cp -r pavlovserver pavlovserver1
/home/steam/pavlovserver1/PavlovServer.sh -PORT=[Desired Port]
</pre>

=== Starting server in competitive mode ===
Competitive mode will prevent dead teammates from being able to see the match, to prevent ghosting.
You can either enable this via Game.ini (described in Game.ini file), or using the -COMPETITIVE=1 parameter.

<pre>
/home/steam/pavlovserver1/PavlovServer.sh -COMPETITIVE=1
</pre>

{| class="wikitable"

|}

=== Useful Linux Commands ===
List files / folders in directory, print current working directory,
<pre>ls -la #list files/directories along with authorities and ownership
pwd #print working directory
sudo chown <owner> <file/directory> #change owner of file/directory. If root created something and you need to change it to steam
sudo chgrp <group> <file/directory> #change group of file/directory.
</pre>

Check if pavlov is running by checking process status. If the only row you see is the grep command, pavlov server is not started.
<pre> ps -ef | grep pav </pre>

Sample output:
<pre>
steam 34044 1 0 16:52 ? 00:00:00 /bin/sh /home/steam/pavlovserver/PavlovServer.sh
steam 34066 34044 80 16:52 ? 00:00:04 /home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer
zombies+ 34101 34013 0 16:52 pts/0 00:00:00 grep --color=auto pav
</pre>

Kill a process. Note this command uses 34044, which is a process id from the command output above.
<pre> kill -9 34044 </pre>

Dump the log to the console so you can scroll through it:
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log </pre>

Search the log for a string - replace my_string with case-sensitive string
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep my_string </pre>

<hr>

== Advanced Scripts For Server Management ==
<hr>

=== '''Auto-updating the server''' ===
Assuming you have followed this guide and used the default paths, users, and install instructions, you can paste the following into your terminal to auto-update your Pavlov server:

<pre>
cat << 'EOF' > $HOME/pavlov_daily_update_and_restart.sh
#!/bin/bash

USER="steam"
SERVICENAME="pavlovserver.service"
INSTALLDIRNAME="pavlovserver"
USERHOME="/home/$USER"

echo -e "Beginning Pavlov VR update run on $(date)\n\n"

systemctl stop "$SERVICENAME"

sleep 5
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +force_install_dir "$USERHOME/$INSTALLDIRNAME" +app_update 622970 +exit
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +app_update 1007 +quit
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/.steam/sdk64/steamclient.so"
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/pavlovserver/Pavlov/Binaries/Linux/steamclient.so"

systemctl start "$SERVICENAME"

echo -e "Ending Pavlov VR update run on $(date)\n\n"

EOF

chmod +x $HOME/pavlov_daily_update_and_restart.sh
mkdir $HOME/pavlov_update_logs && touch $HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log
CRONLINE="00 2 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
(sudo crontab -u root -l; echo "$CRONLINE" ) | sudo crontab -u root -
unset CRONLINE

</pre>

These commands will:

1. Create a shell script in the "steam" user's home directory that automatically stops the Pavlov server, pulls any updates via steam, pull updates to the Steamworks SDK Redist, and copies the latest version of steamclient.so to the Pavlov server directory

2. Make the shell script executable

3. Create a new directory called "pavlov_update_logs" in the "steam" user's directory, and create a logfile inside that directory called "pavlov_daily_update_and_restart.sh.log". You can check this logfile to see the output of the Pavlov and Steam SDK update commands.

4. Create a crontab entry for the root user that runs this shell script automatically every day at 2:00AM local time

If you want to change the time that this script runs, edit the numbers "00 2" in the line that starts with "CRONLINE=". In the example provided, 00 is the minutes column, and 2 is the hour column. For example, if you wanted the server to automatically update and restart at 4:17AM every day, change the line starting with "CRONLINE=" to:

<pre>
CRONLINE="17 4 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
</pre>

If the time is PM, use 24-hour time format, e.g. "32 18" for 6:32PM.
<hr>
=== '''Save Logs for records and stats''' ===
this is an automated script that will on a timer save all the backups made by the server before they are purged by the game for admin records and starts collection

https://github.com/JTWP-org/backUpLogs2
<hr>

=== '''Make an API request with Mod.io to get map picture and name''' ===
very basic script pass the script a map ID as an argument then it will give u the name and a thumbnail to use

https://github.com/JTWP-org/mod.io-modcheck/tree/main

=== '''Sharing Bans over gameserver on same machine''' ===
when you have a lot of servers keeping the bans synced can be a nightmare so using a symbolic link allows all the servers to use one file

for this lets say I have pavlovserver000 and pavlovserver001 and they are located at /home/steam/pavlovserver000 and /home/steam/pavlovserver001

''step 1 will be to pick a blacklist to use as the new one and move it to a central location''
mkdir ~/shared ; mv /home/steam/pavlovserver000/Pavlov/Saved/Config/blacklist.txt ~/shared/blacklist.txt ; rm /home/steam/pavlovserver001/Pavlov/Saved/Config/blacklist.txt
now we have moved the blacklist from pavlovserver000 to a folder in our home called shared and then we removed the blacklist from pavlovserver001

step 2 making the links
ln -s ~/shared/blacklist.txt /home/steam/pavlovserver000/Pavlov/Saved/Config/blacklist.txt ; ln -s ~/shared/blacklist.txt /home/steam/pavlovserver001/Pavlov/Saved/Config/blacklist.txt
now editing them in pavlovserver001's files will update the list for all of the servers it's not a sync its uses the same list if you want to check where a link is pointed if u
ls -l
It will show where the file is really located

<hr>

Setting up a dedicated server

2023-11-01T22:45:08Z

SaltedCrackerJack: /* Obtaining an ApiKey */

== Setting up a dedicated server ==

'''There are no Windows binaries'''

This guide is written exclusively for Linux and covers Ubuntu/Debian/Debian-like and Red Hat RPM-based distros. Possible to run with other distros, but some of the commands won't work and you will need to know enough to figure out the software install of dependencies on your own.

If you are considering hosting from home, please read that section of the wiki first.

This guide assumes you know the basics of using a bash terminal: ssh'ing into a server, running bash commands, editing text files, etc.

If you have no experience using bash, maybe start [https://www.howtogeek.com/140679/beginner-geek-how-to-start-using-the-linux-terminal/ here]. Editing text files via commandline is often a challenge. Suggest using nano and reading guide [https://www.howtogeek.com/howto/42980/the-beginners-guide-to-nano-the-linux-command-line-text-editor/ here]

If you are new to linux and accessing your server from Windows, highly suggest using MobaXterm as your SSH client as that can make required editing of text files easier using built in editor instead of the native linux command line editors.

And finally, ask yourself why you want to setup a server? If you look at the list, there are many, many more servers than players. If you don't have a team, discord community, or group of friends ready to play on your server, chances are it will go unused. Got one of these... great, let's go.

If you don't want to go through the hassle yourself and want to pay for a hosting service Arctic VR (PC and Shack) and Horde (Shack) provide a server hosting services and are trusted in the community. See links below.

----

=== Server Requirements ===

'''Pavlovserver can only be hosted under Linux.'''

This can be running as a VM under windows, but this will increase the complexity of the setup beyond this guide.

Ubuntu 18.04 x86_64, Ubuntu 19/04 amd64, Ubuntu 20.04, and Rocky Linux 8 are confirmed working. Ubuntu 15.04 x86 is known to fail to install using this guide. Recommend not running on "minimal" images as some tools are missing.

* 2GB RAM + 1GB RAM per each additional server with 10 players. More RAM is recommended for larger maps, higher player counts, or complex gamemodes. Not having enough RAM is a common cause of server crashes.

* A ~2.5Ghz CPU will comfortably support a 10 player server.

* A ~4Ghz CPU will comfortably support 24 players. This is a limit built into Pavlov itself, no server will allow players to join over 24. Lower player counts are recommended for complex gamemodes (E.g. CodZ) and/or highly detailed maps, so that maximum number will often be lower.

(Note that these are '''not''' hard limits for player counts, just suggestions for the best performance, based on experiences with many server providers on different grades of hardware.)

* Pavlovserver is functionally single threaded (one thread does vast majority of work). More CPUs only help if you are running more servers. More clockspeed = higher performance = more users per server.
The maximum number of servers you can run is dependent on how many CPUs you have. For example, if you have an 8 core CPU, the maximum number of servers would be 7. You should always have at least one CPU free as overhead, as Pavlov servers can use slightly more than one thread.

----

==== Hosting at home ====
When hosting at home there are additional requirements regarding networking: Your router has to support port-forwarding, hair-pinning/LoopbackNAT, and respond to ping requests. These techniques are necessary to allow your server to be found and to talk back to the client. please see https://en.wikipedia.org/wiki/Port_forwarding, https://en.wikipedia.org/wiki/Hairpinning, and https://www.speedguide.net/faq/how-to-become-pingable-behind-a-routerfirewall-376 for more info and google for these terms in addition to your router model to find guides on how to enable/configure it properly. If you have modern Router, it may have these features already enabled, in this case you just have to configure port-forwarding. If you can see your server but not join it while others can, this is indicative of a failure of LoopbackNAT.

A second challenge to hosting at home is CGNAT (Carrier grade NAT: https://www.a10networks.com/blog/carrier-grade-nat/). Just like NAT on your home network that has to be gotten around w/ port-forwarding, CGNAT breaks the ability of external connections to be made back to your server, but the controls are solely in your ISPs hands. Sometimes if you ask, you can be removed from CGNAT pools and/or assigned a static IP. CGNAT rollouts are becoming very common now, so if your server worked then doesn't allow connections now, your ISP may have made this change.

You can check whether you’re on a CGNAT network by visiting a Web site such as ipaddress.com or whatsmyip.com and comparing the IP address listed to the public/WAN IP address assigned to your Internet gateway. To find your gateway’s public IP address, check the status page in the administrative interface. If the two IP addresses differ, you’re likely on a CGNAT network. If so, this problem must be resolved before you go any further.

'''Not understanding these requirements and configuration is a frequent cause of failed setups and questions in discord. Don't skip this if you are trying to host from home'''

'''There are serious security implications of hosting this software at home.''' None of the devs are security experts and there has been no security review of the code. You are opening up your system to the world and publicity advertising this fact. Expect that any system hosting this software is open to compromise from the Internet and act accordingly. If your router offers a DMZ network, use it. Consider hosting on a cloud based server and think twice before running this software on any system that contains data you care about or has access to networks and computers you care about.

If you're hosting at home using Oracle's VirtualBox, there are steps you can take to prevent double NAT (which can cause issues later on)

1. Select your VM and then click Settings in VirtualBox's main window.

2. Click on Network and change Attached To from NAT to Bridged Adapter.

Once you've done this, your VM should be connected directly to your home router and double NAT should no longer be a issue.

----

==== Starting Server Install ====

====Obtaining an ApiKey ====
====(Not required unless hosting large amount of servers )====
youu can just comment this line out or remove it For your server to show up in the server list, there is now a requirement to have an ApiKey issued by vankrupt. This is to prevent DOS attacks against the master server

Get the key by going here: https://pavlov-ms.vankrupt.com/servers/v1/key and using your mobile number to get a SMS
(Note that there have been reported failures of this SMS system for non-US mobiles. In this case, DM davevillz your phone number and request a key)

Put this key in your Game.ini as follows:
ApiKey="ABC123FALSEKEYDONTUSEME"
or if you would like (personally untested..I would use Game.ini) you can call it at server runtime with flag as follows:
-KEY="ABC123FALSEKEYDONTUSEME"

This key can be re-used for a reasonable number of servers (a limit of 10 has been mentioned). Contact the Devs if you need more servers per key.

====System setup and software installation====

Install dependencies and create the `steam` user. (You only need to do this once):

Confirm Linux version
<pre>
lsb_release -a
</pre>

'''Ubuntu 20.04'''
'''''sudo apt update''''' && '''''sudo apt install''''' -y gdb curl lib32gcc1 libc++-dev unzip
sudo useradd -m steam
'''Ubuntu 20.10 or higher'''
sudo apt update && sudo apt install -y gdb curl lib32gcc-s1 libc++-dev unzip
sudo useradd -m steam
'''Rocky Linux, CentOS 8, and RHEL 8'''
sudo sed -i 's/^SELINUX=enforcing$/SELINUX=permissive/g' /etc/selinux/config
sudo setenforce 0
sudo yum install gdb curl glibc.i686 libstdc++.i686 libstdc++-devel.i686 libstdc++-devel.x86_64 unzip wget -y
wget <nowiki>https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/l/libcxx-3.8.0-3.el7.x86_64.rpm</nowiki>
sudo rpm -i libcxx-3.8.0-3.el7.x86_64.rpm
sudo useradd -m steam
[Optional] Set a password for steam.
<pre>sudo passwd steam</pre>

Login as the Steam user. ('''You will need to do this each time you connect to your server'''):

<pre>
sudo su -l steam
</pre>

Install Steam:

<pre>
mkdir ~/Steam && cd ~/Steam && curl -sqL "https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz" | tar zxvf -
</pre>

There are different dedicated server versions for Pavlov Server - choose which server version you want to host (PC non-beta, PC Beta, Shack Live, or Shack RC)
(You will need to run this command each time there is a Pavlov Server update).

 
To host '''PC Server (non-beta)''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta default +exit

</pre>

To host '''PC BETA''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta beta_server +exit
</pre>

To host '''Shack Live''' (Quest):

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack +exit
</pre>

To host '''Shack RC''' (Quest): 

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack_beta +exit
</pre>

Now that we've installed the server, all pavlov server versions should continue. 
Install a fresh copy of steamclient.so (May have to do this after each update):
<pre>
~/Steam/steamcmd.sh +login anonymous +app_update 1007 +quit
mkdir -p ~/.steam/sdk64
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/pavlovserver/Pavlov/Binaries/Linux/steamclient.so
</pre>

The update 29 of the PCVR version of Pavlov and after added a requirement to run these commands to change the steamclient.so:
<code>sudo rm /usr/lib/x86_64-linux-gnu/libc++.so</code>
<code>sudo ln -s /usr/lib/x86_64-linux-gnu/libc++.so.1 /usr/lib/x86_64-linux-gnu/libc++.so</code>

Make the PavlovServer script executable. (You only need to do this once):

<pre>
chmod +x ~/pavlovserver/PavlovServer.sh
</pre>

----

=== Server Configuration ===

Before starting the server we need to configure it. Start by creating some directories:

<pre>
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Logs
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps
</pre>

==== Mods/Blacklist/Whitelist (optional) ====

The following three files allow you to specify mods, banned players, and whitelist players. These are optional, but go ahead and create them. Populating the files is described later.

<pre>
touch /home/steam/pavlovserver/Pavlov/Saved/Config/mods.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/blacklist.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/whitelist.txt
</pre>

====Configuring Game.ini====
Create a new Game.ini file using following command to open an editor and copy/paste the following block into it then save it. Note not all of these options are required. For instance remove or comment out the Password=0000 line to make a public server with no pin.
<pre>
nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini
</pre>

<pre>
[/Script/Pavlov.DedicatedServer]
bEnabled=true
ServerName="My_private_idaho"
MaxPlayers=10 #Set this to 10 for Shack. 24 is the max for PC, setting it higher will not allow players to join.
ApiKey="ABC123FALSEKEYDONTUSEME"
bSecured=true
bCustomServer=true
bVerboseLogging=false
bCompetitive=false #This only works for SND
bWhitelist=false
RefreshListTime=120
LimitedAmmoType=0
TickRate=90
TimeLimit=60
#Password=0000
#BalanceTableURL="vankruptgames/BalancingTable/main"
MapRotation=(MapId="UGC1758245796", GameMode="GUN")
MapRotation=(MapId="datacenter", GameMode="SND")
MapRotation=(MapId="sand", GameMode="DM")

</pre>

* '''bEnabled''' - whether the server appears in the server list (unconfirmed)
* '''ServerName''' - name it will be listed as. (approx 35 chars max)
* '''MaxPlayers''' - See suggested specs for limits. 10 standard (10 for shack), 20-24 is max recommended for large maps like Stalingrad or PUSH/RUSH modes, and servers allow a maximum of 24 players.
* '''ApiKey''' - Unique ApiKey required to register server with master server. Replace with your key
* '''bSecured''' - enabled Valve Anti-Cheat (VAC)
* '''bCustomServer''' - activates some new modding tools (save and http functions. Required to write to blacklist.txt for bans)
* '''bCompetitive''' - sets the server to competitive mode for SND. If removed the server will default to false
* '''bVerboseLogging''' - enables verbose logging, mostly detailed statistics. Be prepared for significant increase in logging.
* '''bWhitelist''' - Only allow users in whitelist.txt to join
* '''RefreshListTime''' - sets how often the running server checks for updates in ban/whitelist/mod files
* '''LimitedAmmoType''' - sets limited ammo mode, see Limited Ammo Types table below

* '''TimeLimit''' - sets time limit for each map
* '''TickRate''' - sets the server tickrate. (so far minimum stable seems around 50 and max around 120. Beware setting this changes weapon despawn time and breaks some game modes. Recommend not touching)
* '''Password''' - PIN number for server #FYI - this is now also changeable via rcon.
* '''BalanceTableURL''' - Points to a custom balance table from github. See https://github.com/vankruptgames/BalancingTable for instructions. This line isn't needed if you don't have one.
* '''MapRotation''' - you can add multiple of these. The map system has switched from the steam workshop to modio which means that the server rotation will need to be redone with modio UGCs. <nowiki>https://mod.io/g/pavlov</nowiki>. This is done by taking the resource ID from the modio page, adding “UGC” in front of it and then adding that to the rotation. For example the map gravity <nowiki>https://mod.io/g/pavlov/m/gravity1</nowiki> has a resource ID of 2773760 so the map ID to add to the server would be “UGC2773760”. When a match ends, the server will load the next map in the rotation.
* '''AFKTimeLimit''' There is now a feature to kick players who are idle in the game. Integers are measured in seconds and 0 disables AFK kicking completely.

Available game modes as of 09/06/2022: See Game modes table below

For maps running a Custom gamemode (CodZ, BR, Duel, etc.) it doesn't matter which gamemode you choose, as the map will automatically override it with the custom mode.

{| class="wikitable"
|+Limited Ammo Types
!AmmoType
!Name
!Description
|-
|0
|Unlimited
|Players have unlimited ammo, carry no ammo boxes and do not display an ammo count on the wrist.
|-
|1
|Limited Generic
|Players carry ammo boxes with a limited amount of ammo.
One box for each weapon class (Pistol, Submachine gun, Rifles/MGs, Shotgun, Sniper).

Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.

An ammo count is displayed on the wrist.
|-
|2
|Limited Specific
|Players carry ammo boxes with a limited amount of ammo.
One box for each weapon.

Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.

An ammo count is displayed on the wrist.
|-
|3
|Custom
|Allows for full control over ammo by the map.
|-
|4
| Limited Special
|'''All weapons except "special" weapons are unlimited, more clarification is needed.'''
|-
|5
|Boxless
|'''Like limited generic but without boxes? Clarification is needed.'''
|}
{| class="wikitable"
|+Game modes
!GameMode
!Name
|-
|DM
|Death match
|-
|KOTH
|King of the hill
|-
|GUN
| Gun game
|-
|OITC
| One in the chamber
|-
|SND
|Search and destroy
|-
|TANKTDM
|WW2 Team Death Match
|-
| TDM
|Team Death Match
|-
|TTT
|Trouble in Terrorist Town
|-
|TTTclassic
|TTT with only innocent/traitor/detective
|-
|WW2GUN
|WW2 gun game
|-
|ZWV
| Zombie wave survival
|-
|HIDE
|The Hidden
|-
|INFECTION
|Hidden infection
|-
|PUSH
|Push
|-
|PH
|Prop hunt
|}
= Default Map ID's =
datacenter

sand

bridge

containeryard

siberia (Prison Break)

hospital (Zombies map)

killhouse

range

tutorial

santorini

station

industry

ogcontainers (Shack only)

haguenau (Shack only)

foundation (Shack only)

stalingrad (PC only)

stalingrad_night (PC only)

santorini_night (PC only)

sand_night (PC only)

station_night (PC only)

industry_night (PC only)

bunker (PC only)

==== Firewall/Port forwarding ====
Using the default settings there are two UDP ports (7777, 8177) that need to be allowed to access the server either by firewall setup or port forwarding.

'''Ubuntu''' firewall commands to check firewall and open ports:
<pre>
sudo ufw status
sudo ufw allow 7777
sudo ufw allow 8177
sudo ufw allow 9100
sudo ufw status
</pre>

'''Rocky Linux''' firewall commands to check the firewall and open ports:
<pre>
sudo firewall-cmd --zone=public --add-port=7777/tcp
sudo firewall-cmd --zone=public --add-port=7777/udp
sudo firewall-cmd --zone=public --add-port=8177/tcp
sudo firewall-cmd --zone=public --add-port=8177/udp
sudo firewall-cmd --zone=public --add-port=9100/udp
sudo firewall-cmd --zone=public --add-port=9100/tcp
sudo firewall-cmd --list-ports
firewall-cmd --runtime-to-permanent
</pre>

You may also need to allow Pings (ICMP) for the server's true latency to appear in the master list.

If you are running multiple servers and have set additional ports (see http://pavlovwiki.com/index.php/Setting_up_a_dedicated_server#Running_multiple_servers_on_one_host) then you need to allow access to the defined port plus the port 400 higher. So if you use 7000 as your port, then UDP 7000 and 7400 need to be open

If you have setup rcon via RconSettings.txt (below) then that port also needs to be allowed access via TCP

If you are running Shack/Quest and want to have maps that are downloadable from your server, your server ports (ex. 7777 & 8177) must also be open via TCP

----

==== Shack Maps (Quest) ====

If you try to use the steps above to add maps for Shack, you'll run into issues very quickly. This is because Shack has no affiliation with Steam, and therefore cannot use Steam Workshop maps like the above. In the future, these steps will apply to PC servers as well, allowing a server to hold the map itself, instead of offloading it to Steam.

To get started, first, create the directory to hold the maps

<pre>mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps</pre>

You can use any number of methods to move the map files onto the server, but I'll go over the two simplest, starting with a GUI approach

Download and install Cyberduck onto your "home" PC (Whatever PC you use for access to the server, but not the server itself): https://cyberduck.io/

Next, download and unzip your map of choice from https://www.pavlovquest.com/ , https://pavlovhorde.com/mapsList, or look in #shack-map-showcase channel in the discord server. I'm going to use Cheeto's WW2 Items test (http://www.mediafire.com/file/emyt9bs1z9u9ykw/SVR_Cheeto_Items.zip/file ) for this example, you do what you like

In the top left corner, open a connection, set the connection type to SFTP, and fill in the rest of the information. The username is typically `root`, password is whatever you set the root pw as (toor in Ubuntu by default)

In the directory dropdown (it will say /root) go back to /

Follow the directories until we arrive back at our "maps" folder <pre>/home/steam/pavlovserver/Pavlov/Saved/maps</pre>

Drag and drop the unzipped map folder into the main window, in this case itll be SVR_Cheeto_Items

Hit Allow

You'll now see a folder named SVR_Cheeto_Items, and within it should be nothing but 3 files. If there is another folder in it, move this folder to the maps directory, otherwise the server won't work. The 3 files (2 .PAK one .JSON) should be in home/steam/pavlovserver/Pavlov/Saved/maps/SVR_Cheeto_Items, no more, no less.

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

To play the map, you can either use RCON switch map command, or to add the map to your server's automatic map rotation list, add the map's folder name to your Game.ini. This replaces the MapID section, so for our example, it would be

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

And that's all! Disconnect CyberDuck from your server before playing, otherwise you'll have difficulty joining.

-----------

==== Adding Shack Maps over Command Line Interface ====

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

A bit more complicated, but adding maps over CLI has its benefits

First, CD to the maps directory you made above

<pre>cd ~/pavlovserver/Pavlov/Saved/maps</pre>

Download the map files from whatever you use to upload them. To do this, you can either use curl or wget

<pre>curl -O insertURLhere</pre>

'''If you download your map from Google Drive''', make sure that your .zip folder is shared with anyone.
Then, get the file's URL from the shared link. Example : ''<nowiki>https://drive.google.com/file/d/19bI8gUHaN5tUrDvnadAacUnchQf6_k/view</nowiki>'' will be ''19bI8gUHaN5tUrDvnadAacUnchQf6_k''
Edit "fileId" and "fileName" before you execute the command.
<pre>
fileId=19bI8gUHaN5tUrDvnadAacUnchQf6_k
fileName=SVR_USER_MAPNAME
curl -sc /tmp/cookie "https://drive.google.com/uc?export=download&id=${fileId}" > /dev/null
code="$(awk '/_warning_/ {print $NF}' /tmp/cookie)"
curl -Lb /tmp/cookie "https://drive.google.com/uc?export=download&confirm=${code}&id=${fileId}" -o ${fileName} </pre>

To keep with the Items example:

<pre>curl -O https://cdn.discordapp.com/attachments/744185280759857234/745027406695366788/SVR_Cheeto_Items.zip</pre>

Next, unzip the file. If this next step errors out, saying the command is unknown, switch back to the root user (su root), and install unzip (sudo apt install unzip), then return to the steam user, and continue.

<pre>unzip SVR_Cheeto_Items.zip</pre>

Now finish like before by adding the map to your Game.ini

<pre>nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini</pre>

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

==== Admin/Moderator list (optional) ====

The only working in-game admin menu is through Arctic VR server hosting (see below).

If you add moderators to your server, they will not be subject to vote kicks.

<pre>
nano ~/pavlovserver/Pavlov/Saved/Config/mods.txt
</pre>

Example Mod List:
<pre>
76541198397498572 #Optional Comment: Player name
76541198397498573 #Some Other Player
</pre>

==== ArcticVR Admin Menu ====

[[File:Arcticmenu.jpg|500px|link=https://www.arctic-vr.com/server-admin-menu]]

Arctic-VR Offers an advanced In-Game Admin menu that is exclusive to their hosting service. Features include:
* Switch Maps+Modes
* Teleport Players to Players
* Change Player Skins
* Control Player Buying+Cash
* Spawn Items
* Clean up corpses + guns
* Spawn Bots
* Spawn Items for other players
* Control Teams + Balance/Shuffle Teams
* ResetSND
* And More

You can read more about the ArcticVR admin menu on their website: https://www.arctic-vr.com/server-admin-menu

==== Handy tools for finding steamIDs ====

Steam ID finder: https://steamidfinder.com/lookup/ or https://steamid.xyz/

You want to enter in the steamID64 format.

This tool can convert or lookup IDs: https://steamid.io/

If you are looking for a steamID of a player that has been on your server recently this is technique to find them:
<pre>
grep -i playername ~/pavlovserver/Pavlov/Saved/Logs/* | grep TicketValidation
</pre>

=== Configure Rcon ===
To enable Rcon access create config file:
<pre> nano /home/steam/pavlovserver/Pavlov/Saved/Config/RconSettings.txt </pre>

Copy in the following text - change password, and if desired the port:
<pre>
Password=ChangeThisPassword
Port=9100
</pre>
You must specify a port for the Rcon server to use as well as a Password (use a different port per sever instance if running multiple server instances off the same hardware)

=== Starting the server ===

<pre>
cd ~/pavlovserver && ./PavlovServer.sh
</pre>

That's it, your server will be automatically broadcast to the master server! :)

Two handy tools to determine quickly if your server is broadcasting are [https://pablub.xyz/ Pablub] (PC only) and [https://pavlovhorde.com/ Horde] (Shack) and [https://pavlovhorde.com/pcServers Horde] (PC version)

Note that when you close your terminal, the server will go down. See the "supervisors" section below for how to prevent this.

----

=== Supervising the server using systemd ===

Running '''./PavlovServer.sh''' in your interactive shell is easy, but the server will shut down when you close your terminal. If you want to run the server in the background,
you'll want to run it under a supervisor. There are many options, ranging from the simple (nohup, screen or tmux), to the
more robust (supervisord, systemd).

Systemd is running by default on Ubuntu Linux, so we'll use that here.

To run the server as a systemd service, create the file '''/etc/systemd/system/pavlovserver.service''' (as root) by typing
<pre>
sudo nano /etc/systemd/system/pavlovserver.service
</pre>

Copy the contents below into the file and save.

<pre>
[Unit]
Description=Pavlov VR dedicated server

[Service]
Type=simple
WorkingDirectory=/home/steam/pavlovserver
ExecStart=/home/steam/pavlovserver/PavlovServer.sh

RestartSec=1
Restart=always
User=steam
Group=steam

[Install]
WantedBy = multi-user.target
</pre>

If you'd like your server to start as competitive without editing the game.ini, change the line "ExecStart=/home/steam/pavlovserver/PavlovServer.sh" to look like this below. Though it's much easier to just use the game.ini to enable competitive instead. <pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -COMPETITIVE=1</pre>

Change the user or paths as appropriate. After saving the service file, to start, restart, stop, or monitor the server:

<pre>
sudo systemctl start pavlovserver
sudo systemctl restart pavlovserver
sudo systemctl stop pavlovserver
sudo systemctl status pavlovserver
</pre>

To view the logs:

<pre>
sudo journalctl -u pavlovserver
# to live-tail the logs
sudo journalctl -u pavlovserver -f
</pre>

If you want to run the pavlov server as soon as your server boots (e.g. a VPS you turn on and off), add pavlov as a startup service:

<pre>
sudo systemctl enable pavlovserver
</pre>

----

== Advanced Server Administration ==

=== Running multiple servers on one host ===

* Pavlovserver is functionally single-threaded (there are multiple threads, but the vast majority of work occurs in the primary one). Make sure you have # of pavlovservers + 1 CPU available. More CPUs= more servers. Faster CPU = more players.
* Make multiple server installs by defining a separate install dir for each server.
* Run each server with a unique port. eg: '''./PavlovServer.sh -PORT="Desired Port"'''
* The Server will use the Desired Port and the Port 400 above (Example: You choose 8200 as Port. So Port 8600 will be used as well)
* If you are using RCON, each server will need a unique port defined in RconSettings.txt
* Ensure the ports are forwarded and opened in your firewall

To duplicate directories:

be in the steam home folder
<pre>
cp -r pavlovserver pavlovserver1
/home/steam/pavlovserver1/PavlovServer.sh -PORT=[Desired Port]
</pre>

=== Starting server in competitive mode ===
Competitive mode will prevent dead teammates from being able to see the match, to prevent ghosting.
You can either enable this via Game.ini (described in Game.ini file), or using the -COMPETITIVE=1 parameter.

<pre>
/home/steam/pavlovserver1/PavlovServer.sh -COMPETITIVE=1
</pre>

{| class="wikitable"

|}

=== Useful Linux Commands ===
List files / folders in directory, print current working directory,
<pre>ls -la #list files/directories along with authorities and ownership
pwd #print working directory
sudo chown <owner> <file/directory> #change owner of file/directory. If root created something and you need to change it to steam
sudo chgrp <group> <file/directory> #change group of file/directory.
</pre>

Check if pavlov is running by checking process status. If the only row you see is the grep command, pavlov server is not started.
<pre> ps -ef | grep pav </pre>

Sample output:
<pre>
steam 34044 1 0 16:52 ? 00:00:00 /bin/sh /home/steam/pavlovserver/PavlovServer.sh
steam 34066 34044 80 16:52 ? 00:00:04 /home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer
zombies+ 34101 34013 0 16:52 pts/0 00:00:00 grep --color=auto pav
</pre>

Kill a process. Note this command uses 34044, which is a process id from the command output above.
<pre> kill -9 34044 </pre>

Dump the log to the console so you can scroll through it:
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log </pre>

Search the log for a string - replace my_string with case-sensitive string
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep my_string </pre>

<hr>

== Advanced Scripts For Server Management ==
<hr>

=== '''Auto-updating the server''' ===
Assuming you have followed this guide and used the default paths, users, and install instructions, you can paste the following into your terminal to auto-update your Pavlov server:

<pre>
cat << 'EOF' > $HOME/pavlov_daily_update_and_restart.sh
#!/bin/bash

USER="steam"
SERVICENAME="pavlovserver.service"
INSTALLDIRNAME="pavlovserver"
USERHOME="/home/$USER"

echo -e "Beginning Pavlov VR update run on $(date)\n\n"

systemctl stop "$SERVICENAME"

sleep 5
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +force_install_dir "$USERHOME/$INSTALLDIRNAME" +app_update 622970 +exit
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +app_update 1007 +quit
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/.steam/sdk64/steamclient.so"
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/pavlovserver/Pavlov/Binaries/Linux/steamclient.so"

systemctl start "$SERVICENAME"

echo -e "Ending Pavlov VR update run on $(date)\n\n"

EOF

chmod +x $HOME/pavlov_daily_update_and_restart.sh
mkdir $HOME/pavlov_update_logs && touch $HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log
CRONLINE="00 2 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
(sudo crontab -u root -l; echo "$CRONLINE" ) | sudo crontab -u root -
unset CRONLINE

</pre>

These commands will:

1. Create a shell script in the "steam" user's home directory that automatically stops the Pavlov server, pulls any updates via steam, pull updates to the Steamworks SDK Redist, and copies the latest version of steamclient.so to the Pavlov server directory

2. Make the shell script executable

3. Create a new directory called "pavlov_update_logs" in the "steam" user's directory, and create a logfile inside that directory called "pavlov_daily_update_and_restart.sh.log". You can check this logfile to see the output of the Pavlov and Steam SDK update commands.

4. Create a crontab entry for the root user that runs this shell script automatically every day at 2:00AM local time

If you want to change the time that this script runs, edit the numbers "00 2" in the line that starts with "CRONLINE=". In the example provided, 00 is the minutes column, and 2 is the hour column. For example, if you wanted the server to automatically update and restart at 4:17AM every day, change the line starting with "CRONLINE=" to:

<pre>
CRONLINE="17 4 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
</pre>

If the time is PM, use 24-hour time format, e.g. "32 18" for 6:32PM.
<hr>
=== '''Save Logs for records and stats''' ===
this is an automated script that will on a timer save all the backups made by the server before they are purged by the game for admin records and starts collection

https://github.com/JTWP-org/backUpLogs2
<hr>

=== '''Make an API request with Mod.io to get map picture and name''' ===
very basic script pass the script a map ID as an argument then it will give u the name and a thumbnail to use

https://github.com/JTWP-org/mod.io-modcheck/tree/main

=== '''Sharing Bans over gameserver on same machine''' ===
when you have a lot of servers keeping the bans synced can be a nightmare so using a symbolic link allows all the servers to use one file

for this lets say I have pavlovserver000 and pavlovserver001 and they are located at /home/steam/pavlovserver000 and /home/steam/pavlovserver001

''step 1 will be to pick a blacklist to use as the new one and move it to a central location''
mkdir ~/shared ; mv /home/steam/pavlovserver000/Pavlov/Saved/Config/blacklist.txt ~/shared/blacklist.txt ; rm /home/steam/pavlovserver001/Pavlov/Saved/Config/blacklist.txt
now we have moved the blacklist from pavlovserver000 to a folder in our home called shared and then we removed the blacklist from pavlovserver001

step 2 making the links
ln -s ~/shared/blacklist.txt /home/steam/pavlovserver000/Pavlov/Saved/Config/blacklist.txt ; ln -s ~/shared/blacklist.txt /home/steam/pavlovserver001/Pavlov/Saved/Config/blacklist.txt
now editing them in pavlovserver001's files will update the list for all of the servers it's not a sync its uses the same list if you want to check where a link is pointed if u
ls -l
It will show where the file is really located

<hr>

Setting up a dedicated server

2023-07-31T22:51:49Z

SaltedCrackerJack: /* Make an API request with Mod.io to get map picture and name */

== Setting up a dedicated server ==

'''There are no Windows binaries'''

This guide is written exclusively for Linux and covers Ubuntu/Debian/Debian-like and Red Hat RPM-based distros. Possible to run with other distros, but some of the commands won't work and you will need to know enough to figure out the software install of dependencies on your own.

If you are considering hosting from home, please read that section of the wiki first.

This guide assumes you know the basics of using a bash terminal: ssh'ing into a server, running bash commands, editing text files, etc.

If you have no experience using bash, maybe start [https://www.howtogeek.com/140679/beginner-geek-how-to-start-using-the-linux-terminal/ here]. Editing text files via commandline is often a challenge. Suggest using nano and reading guide [https://www.howtogeek.com/howto/42980/the-beginners-guide-to-nano-the-linux-command-line-text-editor/ here]

If you are new to linux and accessing your server from Windows, highly suggest using MobaXterm as your SSH client as that can make required editing of text files easier using built in editor instead of the native linux command line editors.

And finally, ask yourself why you want to setup a server? If you look at the list, there are many, many more servers than players. If you don't have a team, discord community, or group of friends ready to play on your server, chances are it will go unused. Got one of these... great, let's go.

If you don't want to go through the hassle yourself and want to pay for a hosting service Arctic VR (PC and Shack) and Horde (Shack) provide a server hosting services and are trusted in the community. See links below.

----

=== Server Requirements ===

'''Pavlovserver can only be hosted under Linux.'''

This can be running as a VM under windows, but this will increase the complexity of the setup beyond this guide.

Ubuntu 18.04 x86_64, Ubuntu 19/04 amd64, Ubuntu 20.04, and Rocky Linux 8 are confirmed working. Ubuntu 15.04 x86 is known to fail to install using this guide. Recommend not running on "minimal" images as some tools are missing.

* 2GB RAM + 1GB RAM per each additional server with 10 players. More RAM is recommended for larger maps, higher player counts, or complex gamemodes. Not having enough RAM is a common cause of server crashes.

* A ~2.5Ghz CPU will comfortably support a 10 player server.

* A ~4Ghz CPU will comfortably support 24 players. This is a limit built into Pavlov itself, no server will allow players to join over 24. Lower player counts are recommended for complex gamemodes (E.g. CodZ) and/or highly detailed maps, so that maximum number will often be lower.

(Note that these are '''not''' hard limits for player counts, just suggestions for the best performance, based on experiences with many server providers on different grades of hardware.)

* Pavlovserver is functionally single threaded (one thread does vast majority of work). More CPUs only help if you are running more servers. More clockspeed = higher performance = more users per server.
The maximum number of servers you can run is dependent on how many CPUs you have. For example, if you have an 8 core CPU, the maximum number of servers would be 7. You should always have at least one CPU free as overhead, as Pavlov servers can use slightly more than one thread.

----

==== Hosting at home ====
When hosting at home there are additional requirements regarding networking: Your router has to support port-forwarding, hair-pinning/LoopbackNAT, and respond to ping requests. These techniques are necessary to allow your server to be found and to talk back to the client. please see https://en.wikipedia.org/wiki/Port_forwarding, https://en.wikipedia.org/wiki/Hairpinning, and https://www.speedguide.net/faq/how-to-become-pingable-behind-a-routerfirewall-376 for more info and google for these terms in addition to your router model to find guides on how to enable/configure it properly. If you have modern Router, it may have these features already enabled, in this case you just have to configure port-forwarding. If you can see your server but not join it while others can, this is indicative of a failure of LoopbackNAT.

A second challenge to hosting at home is CGNAT (Carrier grade NAT: https://www.a10networks.com/blog/carrier-grade-nat/). Just like NAT on your home network that has to be gotten around w/ port-forwarding, CGNAT breaks the ability of external connections to be made back to your server, but the controls are solely in your ISPs hands. Sometimes if you ask, you can be removed from CGNAT pools and/or assigned a static IP. CGNAT rollouts are becoming very common now, so if your server worked then doesn't allow connections now, your ISP may have made this change.

You can check whether you’re on a CGNAT network by visiting a Web site such as ipaddress.com or whatsmyip.com and comparing the IP address listed to the public/WAN IP address assigned to your Internet gateway. To find your gateway’s public IP address, check the status page in the administrative interface. If the two IP addresses differ, you’re likely on a CGNAT network. If so, this problem must be resolved before you go any further.

'''Not understanding these requirements and configuration is a frequent cause of failed setups and questions in discord. Don't skip this if you are trying to host from home'''

'''There are serious security implications of hosting this software at home.''' None of the devs are security experts and there has been no security review of the code. You are opening up your system to the world and publicity advertising this fact. Expect that any system hosting this software is open to compromise from the Internet and act accordingly. If your router offers a DMZ network, use it. Consider hosting on a cloud based server and think twice before running this software on any system that contains data you care about or has access to networks and computers you care about.

If you're hosting at home using Oracle's VirtualBox, there are steps you can take to prevent double NAT (which can cause issues later on)

1. Select your VM and then click Settings in VirtualBox's main window.

2. Click on Network and change Attached To from NAT to Bridged Adapter.

Once you've done this, your VM should be connected directly to your home router and double NAT should no longer be a issue.

----

==== Starting Server Install ====

====Obtaining an ApiKey====
For your server to show up in the server list, there is now a requirement to have an ApiKey issued by vankrupt. This is to prevent DOS attacks against the master server

Get the key by going here: https://pavlov-ms.vankrupt.com/servers/v1/key and using your mobile number to get a SMS
(note that there have been reported failures of this SMS system for non-US mobiles. In this case DM davevillz your mobile and ask for a key)

Put this key in your Game.ini as follows:
ApiKey="ABC123FALSEKEYDONTUSEME"
or if you would like (personally untested..I would use game.ini) you can call it at server runtime with flag as follows:
-KEY="ABC123FALSEKEYDONTUSEME"

This key can be re-used for a reasonable number of servers (a limit of 10 has been mentioned). Contact the Devs if you need more servers per key.

====System setup and software installation====

Install dependencies and create the `steam` user. (You only need to do this once):

Confirm Linux version
<pre>
lsb_release -a
</pre>

'''Ubuntu 20.04'''
'''''sudo apt update''''' && '''''sudo apt install''''' -y gdb curl lib32gcc1 libc++-dev unzip
sudo useradd -m steam
'''Ubuntu 20.10 or higher'''
sudo apt update && sudo apt install -y gdb curl lib32gcc-s1 libc++-dev unzip
sudo useradd -m steam
'''Rocky Linux, CentOS 8, and RHEL 8'''
sudo sed -i 's/^SELINUX=enforcing$/SELINUX=permissive/g' /etc/selinux/config
sudo setenforce 0
sudo yum install gdb curl glibc.i686 libstdc++.i686 libstdc++-devel.i686 libstdc++-devel.x86_64 unzip wget -y
wget <nowiki>https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/l/libcxx-3.8.0-3.el7.x86_64.rpm</nowiki>
sudo rpm -i libcxx-3.8.0-3.el7.x86_64.rpm
sudo useradd -m steam
[Optional] Set a password for steam.
<pre>sudo passwd steam</pre>

Login as the steam user. ('''You will need to do this each time you connect to your server'''):

<pre>
sudo su -l steam
</pre>

Install Steam:

<pre>
mkdir ~/Steam && cd ~/Steam && curl -sqL "https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz" | tar zxvf -
</pre>

There are different dedicated server versions for Pavlov Server - choose which server version you want to host (PC non-beta, PC Beta, Shack Live, or Shack RC)
(You will need to run this command each time there is a Pavlov Server update).

 
To host '''PC Server (non-beta)''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta default +exit
</pre>

To host '''PC BETA''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta beta_server +exit
</pre>

To host '''Shack Live''' (Quest):

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack +exit
</pre>

To host '''Shack RC''' (Quest): 

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack_beta +exit
</pre>

Now that we've installed the server, all pavlov server versions should continue. 
Install a fresh copy of steamclient.so (May have to do this after each update):
<pre>
~/Steam/steamcmd.sh +login anonymous +app_update 1007 +quit
mkdir -p ~/.steam/sdk64
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/pavlovserver/Pavlov/Binaries/Linux/steamclient.so
</pre>

The update 29 of the PCVR version of pavlov and after added a requirement to run these commands to change the steamclient.so:
<code>sudo rm /usr/lib/x86_64-linux-gnu/libc++.so</code>
<code>sudo ln -s /usr/lib/x86_64-linux-gnu/libc++.so.1 /usr/lib/x86_64-linux-gnu/libc++.so</code>

Make the PavlovServer script executable. (You only need to do this once):

<pre>
chmod +x ~/pavlovserver/PavlovServer.sh
</pre>

----

=== Server Configuration ===

Before starting the server we need to configure it. Start by creating some directories:

<pre>
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Logs
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps
</pre>

==== Mods/Blacklist/Whitelist (optional) ====

The following three files allow you to specify mods, banned players, and whitelist players. These are optional, but go ahead and create them. Populating the files is described later.

<pre>
touch /home/steam/pavlovserver/Pavlov/Saved/Config/mods.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/blacklist.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/whitelist.txt
</pre>

====Configuring Game.ini====
Create a new Game.ini file using following command to open an editor and copy/paste the following block into it then save it. Note not all of these options are required. For instance remove or comment out the Password=0000 line to make a public server with no pin.
<pre>
nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini
</pre>

<pre>
[/Script/Pavlov.DedicatedServer]
bEnabled=true
ServerName="My_private_idaho"
MaxPlayers=10 #Set this to 10 for Shack. 24 is the max for PC, setting it higher will not allow players to join.
ApiKey="ABC123FALSEKEYDONTUSEME"
bSecured=true
bCustomServer=true
bVerboseLogging=false
bCompetitive=false #This only works for SND
bWhitelist=false
RefreshListTime=120
LimitedAmmoType=0
TickRate=90
TimeLimit=60
#Password=0000
#BalanceTableURL="vankruptgames/BalancingTable/main"
MapRotation=(MapId="UGC1758245796", GameMode="GUN")
MapRotation=(MapId="datacenter", GameMode="SND")
MapRotation=(MapId="sand", GameMode="DM")

</pre>

* '''bEnabled''' - whether the server appears in the server list (unconfirmed)
* '''ServerName''' - name it will be listed as. (approx 35 chars max)
* '''MaxPlayers''' - See suggested specs for limits. 10 standard (10 for shack), 20-24 is max recommended for large maps like Stalingrad or PUSH/RUSH modes, and servers allow a maximum of 24 players.
* '''ApiKey''' - Unique ApiKey required to register server with master server. Replace with your key
* '''bSecured''' - enabled Valve Anti-Cheat (VAC)
* '''bCustomServer''' - activates some new modding tools (save and http functions. Required to write to blacklist.txt for bans)
* '''bCompetitive''' - sets the server to competitive mode for SND. If removed the server will default to false
* '''bVerboseLogging''' - enables verbose logging, mostly detailed statistics. Be prepared for significant increase in logging.
* '''bWhitelist''' - Only allow users in whitelist.txt to join
* '''RefreshListTime''' - sets how often the running server checks for updates in ban/whitelist/mod files
* '''LimitedAmmoType''' - sets limited ammo mode, see Limited Ammo Types table below

* '''TimeLimit''' - sets time limit for each map
* '''TickRate''' - sets the server tickrate. (so far minimum stable seems around 50 and max around 120. Beware setting this changes weapon despawn time and breaks some game modes. Recommend not touching)
* '''Password''' - PIN number for server #FYI - this is now also changeable via rcon.
* '''BalanceTableURL''' - Points to a custom balance table from github. See https://github.com/vankruptgames/BalancingTable for instructions. This line isn't needed if you don't have one.
* '''MapRotation''' - you can add multiple of these. The map system has switched from the steam workshop to modio which means that the server rotation will need to be redone with modio UGCs. <nowiki>https://mod.io/g/pavlov</nowiki>. This is done by taking the resource ID from the modio page, adding “UGC” in front of it and then adding that to the rotation. For example the map gravity <nowiki>https://mod.io/g/pavlov/m/gravity1</nowiki> has a resource ID of 2773760 so the map ID to add to the server would be “UGC2773760”. When a match ends, the server will load the next map in the rotation.
* '''AFKTimeLimit''' There is now a feature to kick players who are idle in the game. Integers are measured in seconds and 0 disables AFK kicking completely.

Available game modes as of 09/06/2022: See Game modes table below

For maps running a Custom gamemode (CodZ, BR, Duel, etc.) it doesn't matter which gamemode you choose, as the map will automatically override it with the custom mode.

{| class="wikitable"
|+Limited Ammo Types
!AmmoType
!Name
!Description
|-
|0
|Unlimited
|Players have unlimited ammo, carry no ammo boxes and do not display an ammo count on the wrist.
|-
|1
|Limited Generic
|Players carry ammo boxes with a limited amount of ammo.
One box for each weapon class (Pistol, Submachine gun, Rifles/MGs, Shotgun, Sniper).

Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.

An ammo count is displayed on the wrist.
|-
|2
|Limited Specific
|Players carry ammo boxes with a limited amount of ammo.
One box for each weapon.

Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.

An ammo count is displayed on the wrist.
|-
|3
|Custom
|Allows for full control over ammo by the map.
|-
|4
| Limited Special
|'''All weapons except "special" weapons are unlimited, more clarification is needed.'''
|-
|5
|Boxless
|'''Like limited generic but without boxes? Clarification is needed.'''
|}
{| class="wikitable"
|+Game modes
!GameMode
!Name
|-
|DM
|Death match
|-
|KOTH
|King of the hill
|-
|GUN
| Gun game
|-
|OITC
| One in the chamber
|-
|SND
|Search and destroy
|-
|TANKTDM
|WW2 Team Death Match
|-
| TDM
|Team Death Match
|-
|TTT
|Trouble in Terrorist Town
|-
|WW2GUN
|WW2 gun game
|-
|ZWV
| Zombie wave survival
|-
|HIDE
|The Hidden
|-
|INFECTION
|Hidden infection
|-
|PUSH
|Push
|-
|PH
|Prop hunt
|}
= Default Map ID's =
datacenter

sand

bridge

containeryard

siberia (Prison Break)

hospital (Zombies map)

killhouse

range

tutorial

santorini

station

industry

ogcontainers (Shack only)

haguenau (Shack only)

foundation (Shack only)

stalingrad (PC only)

stalingrad_night (PC only)

santorini_night (PC only)

sand_night (PC only)

station_night (PC only)

industry_night (PC only)

bunker (PC only)

==== Firewall/Port forwarding ====
Using the default settings there are two UDP ports (7777, 8177) that need to be allowed to access the server either by firewall setup or port forwarding.

'''Ubuntu''' firewall commands to check firewall and open ports:
<pre>
sudo ufw status
sudo ufw allow 7777
sudo ufw allow 8177
sudo ufw allow 9100
sudo ufw status
</pre>

'''Rocky Linux''' firewall commands to check firewall and open ports:
<pre>
sudo firewall-cmd --zone=public --add-port=7777/tcp
sudo firewall-cmd --zone=public --add-port=7777/udp
sudo firewall-cmd --zone=public --add-port=8177/tcp
sudo firewall-cmd --zone=public --add-port=8177/udp
sudo firewall-cmd --zone=public --add-port=9100/udp
sudo firewall-cmd --zone=public --add-port=9100/tcp
sudo firewall-cmd --list-ports
firewall-cmd --runtime-to-permanent
</pre>

You may also need to allow Pings (ICMP) for the server's true latency to appear in the master list.

If you are running multiple servers and have set additional ports (see http://wiki.pavlov-vr.com/index.php?title=Dedicated_server#Running_multiple_servers_on_one_host) then you need to allow access to the defined port plus the port 400 higher. So if you use 7000 as your port, then UDP 7000 and 7400 need to be open

If you have setup rcon via RconSettings.txt (below) then that port also need to be allowed access via TCP

If you are running Shack/Quest and want to have maps that are downloadable from your server, your server ports (ex. 7777 & 8177) must also be open via TCP

----

==== Shack Maps (Quest) ====

If you try to use the steps above to add maps for Shack, youll run into issues very quickly. This is because Shack has no affiliation to Steam, and therefore cannot use Steam Workshop maps like above. In the future, these steps will apply to PC servers as well, allowing a server to hold the map itself, instead of offloading to Steam.

To get started, first create the directory to hold the maps

<pre>mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps</pre>

You can use any number of methods to move the map files onto the server, but ill go over the two simplest, starting with a GUI approach

Download and install CyberDuck onto your "home" PC (Whatever PC you use for access to the server, but not the server itsself): https://cyberduck.io/

Next, download and unzip your map of choice from https://www.pavlovquest.com/ , https://pavlovhorde.com/mapsList, or look in #shack-map-showcase channel in the discord server. I'm going to use Cheeto's WW2 Items test (http://www.mediafire.com/file/emyt9bs1z9u9ykw/SVR_Cheeto_Items.zip/file ) for this example, you do what you like

In the top left corner, open a connection, set the connection type to SFTP, and fill in the rest of the information. User will be root, password is whatever you set the root pw as (toor in Ubuntu by default)

In the directory dropdown (itll say /root) go back to /

Follow the directories until we arrive back at our "maps" folder <pre>/home/steam/pavlovserver/Pavlov/Saved/maps</pre>

Drag and drop the unzipped map folder into the main window, in this case itll be SVR_Cheeto_Items

Hit Allow

Youll now see a folder named SVR_Cheeto_Items, and within it should be nothing but 3 files. If there is another folder in it, move this folder to the maps directory, otherwise the server wont work. The 3 files (2 .PAK one .JSON) should be in home/steam/pavlovserver/Pavlov/Saved/maps/SVR_Cheeto_Items, no more, no less.

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

To play the map, you can either use RCON switch map command, or to add the map to your servers automatic map rotation list, add the map's folder name to your Game.ini. This replaces the MapID section, so for our example it would be

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

And thats all! Disconnect CyberDuck from your server before playing, otherwise youll have difficulty joining.

-----------

==== Adding Shack Maps over Command Line Interface ====

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

A bit more complicated, but adding maps over CLI has its benefits

First, CD to the maps directory you made above

<pre>cd ~/pavlovserver/Pavlov/Saved/maps</pre>

Download the map files from whatever you use to upload them. To do this, you can either use curl or wget

<pre>curl -O insertURLhere</pre>

'''If you download your map from Google Drive''', make sure that your .zip folder is shared to anyone.
Then, get the file's url from the shared link. Example : ''<nowiki>https://drive.google.com/file/d/19bI8gUHaN5tUrDvnadAacUnchQf6_k/view</nowiki>'' will be ''19bI8gUHaN5tUrDvnadAacUnchQf6_k''
Edit "fileId" and "fileName" before you execute the command.
<pre>
fileId=19bI8gUHaN5tUrDvnadAacUnchQf6_k
fileName=SVR_USER_MAPNAME
curl -sc /tmp/cookie "https://drive.google.com/uc?export=download&id=${fileId}" > /dev/null
code="$(awk '/_warning_/ {print $NF}' /tmp/cookie)"
curl -Lb /tmp/cookie "https://drive.google.com/uc?export=download&confirm=${code}&id=${fileId}" -o ${fileName} </pre>

To keep with the Items example:

<pre>curl -O https://cdn.discordapp.com/attachments/744185280759857234/745027406695366788/SVR_Cheeto_Items.zip</pre>

Next, unzip the file. If this next step errors out, saying the command is unknown, switch back to the root user (su root), and install unzip (sudo apt install unzip), then return to the steam user, and continue.

<pre>unzip SVR_Cheeto_Items.zip</pre>

Now finish like before by adding the map to your Game.ini

<pre>nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini</pre>

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

==== Admin/Moderator list (optional) ====

The only working in-game admin menu is through Arctic VR server hosting (see below).

If you add moderators to your server, they will not be subject to vote kicks.

<pre>
nano ~/pavlovserver/Pavlov/Saved/Config/mods.txt
</pre>

Example Mod List:
<pre>
76541198397498572 #Optional Comment: Player name
76541198397498573 #Some Other Player
</pre>

==== ArcticVR Admin Menu ====

[[File:Arcticmenu.jpg|500px|link=https://www.arctic-vr.com/server-admin-menu]]

Arctic-VR Offers an advanced In-Game Admin menu that is exclusive to their hosting service. Features include:
* Switch Maps+Modes
* Teleport Players to Players
* Change Player Skins
* Control Player Buying+Cash
* Spawn Items
* Clean up corpses + guns
* Spawn Bots
* Spawn Items for other players
* Control Teams + Balance/Shuffle Teams
* ResetSND
* And More

You can read more about the ArcticVR admin menu on their website: https://www.arctic-vr.com/server-admin-menu

==== Handy tools for finding steamIDs ====

Steam ID finder: https://steamidfinder.com/lookup/ or https://steamid.xyz/

You want to enter in the steamID64 format.

This tool can convert or lookup IDs: https://steamid.io/

If you are looking for a steamID of a player that has been on your server recently this is technique to find them:
<pre>
grep -i playername ~/pavlovserver/Pavlov/Saved/Logs/* | grep TicketValidation
</pre>

=== Configure Rcon ===
To enable Rcon access create config file:
<pre> nano /home/steam/pavlovserver/Pavlov/Saved/Config/RconSettings.txt </pre>

Copy in the following text - change password, and if desired the port:
<pre>
Password=ChangeThisPassword
Port=9100
</pre>
You must specify a port for the Rcon server to use as well as a Password (use a different port per sever instance if running multiple server instances off the same hardware)

=== Starting the server ===

<pre>
cd ~/pavlovserver && ./PavlovServer.sh
</pre>

That's it, your server will be automatically broadcast to the master server! :)

Two handy tools to determine quickly if your server is broadcasting are [https://pablub.xyz/ Pablub] (PC only) and [https://pavlovhorde.com/ Horde] (Shack) and [https://pavlovhorde.com/pcServers Horde] (PC version)

Note that when you close your terminal, the server will go down. See the "supervisors" section below for how to prevent this.

----

=== Supervising the server using systemd ===

Running '''./PavlovServer.sh''' in your interactive shell is easy, but the server will shut down when you close your terminal. If you want to run the server in the background,
you'll want to run it under a supervisor. There are many options, ranging from the simple (nohup, screen or tmux), to the
more robust (supervisord, systemd).

Systemd is running by default on Ubuntu Linux, so we'll use that here.

To run the server as a systemd service, create the file '''/etc/systemd/system/pavlovserver.service''' (as root) by typing
<pre>
sudo nano /etc/systemd/system/pavlovserver.service
</pre>

Copy contents below into the file and save.

<pre>
[Unit]
Description=Pavlov VR dedicated server

[Service]
Type=simple
WorkingDirectory=/home/steam/pavlovserver
ExecStart=/home/steam/pavlovserver/PavlovServer.sh

RestartSec=1
Restart=always
User=steam
Group=steam

[Install]
WantedBy = multi-user.target
</pre>

If you'd like your server to start as competitive without editing the game.ini, change the line "ExecStart=/home/steam/pavlovserver/PavlovServer.sh" to look like this below. Though it's much easier to just use the game.ini to enable competitive instead. <pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -COMPETITIVE=1</pre>

Change the user or paths as appropriate. After saving the service file, to start, restart, stop, or monitor the server:

<pre>
sudo systemctl start pavlovserver
sudo systemctl restart pavlovserver
sudo systemctl stop pavlovserver
sudo systemctl status pavlovserver
</pre>

To view the logs:

<pre>
sudo journalctl -u pavlovserver
# to live-tail the logs
sudo journalctl -u pavlovserver -f
</pre>

If you want to run the pavlov server as soon as your server boots (e.g. a VPS you turn on and off), add pavlov as a startup service:

<pre>
sudo systemctl enable pavlovserver
</pre>

----

== Advanced Server Administration ==

=== Running multiple servers on one host ===

* Pavlovserver is functionally single threaded (there are multiple threads, but vast majority of work occurs in the primary one). Make sure you have # of pavlovservers + 1 CPU available. More CPUs= more servers. Faster CPU = more players.
* Make multiple server installs by defining a separate install dir for each server.
* Run each server with a unique port. eg: '''./PavlovServer.sh -PORT="Desired Port"'''
* The Server will use the Desired Port and the Port 400 above (Example: You choose 8200 as Port. So Port 8600 will be used as well)
* If you are using RCON, each server will need a unique port defined in RconSettings.txt
* Ensure the ports are forwarded and opened in your firewall

To duplicate directories:

be in the steam home folder
<pre>
cp -r pavlovserver pavlovserver1
/home/steam/pavlovserver1/PavlovServer.sh -PORT=[Desired Port]
</pre>

=== Starting server in competitive mode ===
Competitive mode will prevent dead teammates from being able to see the match, to prevent ghosting.
You can either enable this via Game.ini (described in Game.ini file), or using the -COMPETITIVE=1 parameter.

<pre>
/home/steam/pavlovserver1/PavlovServer.sh -COMPETITIVE=1
</pre>

{| class="wikitable"

|}

=== Useful Linux Commands ===
List files / folders in directory, print current working directory,
<pre>ls -la #list files/directories along with authorities and ownership
pwd #print working directory
sudo chown <owner> <file/directory> #change owner of file/directory. If root created something and you need to change it to steam
sudo chgrp <group> <file/directory> #change group of file/directory.
</pre>

Check if pavlov is running by checking process status. If the only row you see is the grep command, pavlov server is not started.
<pre> ps -ef | grep pav </pre>

Sample output:
<pre>
steam 34044 1 0 16:52 ? 00:00:00 /bin/sh /home/steam/pavlovserver/PavlovServer.sh
steam 34066 34044 80 16:52 ? 00:00:04 /home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer
zombies+ 34101 34013 0 16:52 pts/0 00:00:00 grep --color=auto pav
</pre>

Kill a process. Note this command uses 34044, which is a process id from the command output above.
<pre> kill -9 34044 </pre>

Dump the log to the console so you can scroll through it:
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log </pre>

Search the log for a string - replace my_string with case-sensitive string
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep my_string </pre>

<hr>

== Advanced Scripts For Server Management ==
<hr>

=== '''Auto-updating the server''' ===
Assuming you have followed this guide and used the default paths, users, and install instructions, you can paste the following into your terminal to auto-update your Pavlov server:

<pre>
cat << 'EOF' > $HOME/pavlov_daily_update_and_restart.sh
#!/bin/bash

USER="steam"
SERVICENAME="pavlovserver.service"
INSTALLDIRNAME="pavlovserver"
USERHOME="/home/$USER"

echo -e "Beginning Pavlov VR update run on $(date)\n\n"

systemctl stop "$SERVICENAME"

sleep 5
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +force_install_dir "$USERHOME/$INSTALLDIRNAME" +app_update 622970 +exit
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +app_update 1007 +quit
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/.steam/sdk64/steamclient.so"
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/pavlovserver/Pavlov/Binaries/Linux/steamclient.so"

systemctl start "$SERVICENAME"

echo -e "Ending Pavlov VR update run on $(date)\n\n"

EOF

chmod +x $HOME/pavlov_daily_update_and_restart.sh
mkdir $HOME/pavlov_update_logs && touch $HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log
CRONLINE="00 2 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
(sudo crontab -u root -l; echo "$CRONLINE" ) | sudo crontab -u root -
unset CRONLINE

</pre>

These commands will:

1. Create a shell script in the "steam" user's home directory that automatically stops the Pavlov server, pulls any updates via steam, pull updates to the Steamworks SDK Redist, and copies the latest version of steamclient.so to the Pavlov server directory

2. Make the shell script executable

3. Create a new directory called "pavlov_update_logs" in the "steam" user's directory, and create a logfile inside that directory called "pavlov_daily_update_and_restart.sh.log". You can check this logfile to see the output of the Pavlov and Steam SDK update commands.

4. Create a crontab entry for the root user that runs this shell script automatically every day at 2:00AM local time

If you want to change the time that this script runs, edit the numbers "00 2" in the line that starts with "CRONLINE=". In the example provided, 00 is the minutes column, and 2 is the hour column. For example, if you wanted the server to automatically update and restart at 4:17AM every day, change the line starting with "CRONLINE=" to:

<pre>
CRONLINE="17 4 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
</pre>

If the time is PM, use 24-hour time format, e.g. "32 18" for 6:32PM.
<hr>
=== '''Save Logs for records and stats''' ===
this is a automated script that will on a timer save all the backups made by the server before they are purged by the game for admin records and starts collection

https://github.com/JTWP-org/backUpLogs2
<hr>

=== '''Make an API request with Mod.io to get map picture and name''' ===
very basic script pass the script a map id as an argument then it will give u the name and a thumbnail to use

https://github.com/JTWP-org/mod.io-modcheck/tree/main

=== '''Sharing Bans over gameserver on same machine''' ===
when u have a lot of servers keeping the bans synced can be a nightmare so using a symbolic link allows all the servers to use one file

for this lets say i have pavlovserver000 and pavlovserver001 and they are located at /home/steam/pavlovserver000 and /home/steam/pavlovserver001

''step 1 will be to pick a blacklist to use as the new one and move it to a central location''
mkdir ~/shared ; mv /home/steam/pavlovserver000/Pavlov/Saved/Config/blacklist.txt ~/shared/blacklist.txt ; rm /home/steam/pavlovserver001/Pavlov/Saved/Config/blacklist.txt
now we have moved the blacklist from pavlovserver000 to a folder in our home called shared and then we removed the blacklist from pavlovserver001

step 2 making the links
ln -s ~/shared/blacklist.txt /home/steam/pavlovserver000/Pavlov/Saved/Config/blacklist.txt ; ln -s ~/shared/blacklist.txt /home/steam/pavlovserver001/Pavlov/Saved/Config/blacklist.txt
now editing them in pavlovserver001's files will update the list for all of the servers its not a sync its using the same list if u want to check where a link is pointed if u
ls -l
it will show where the file is really located

<hr>

Setting up a dedicated server

2023-07-31T22:51:36Z

SaltedCrackerJack: /* Save Logs for records and stats */

== Setting up a dedicated server ==

'''There are no Windows binaries'''

This guide is written exclusively for Linux and covers Ubuntu/Debian/Debian-like and Red Hat RPM-based distros. Possible to run with other distros, but some of the commands won't work and you will need to know enough to figure out the software install of dependencies on your own.

If you are considering hosting from home, please read that section of the wiki first.

This guide assumes you know the basics of using a bash terminal: ssh'ing into a server, running bash commands, editing text files, etc.

If you have no experience using bash, maybe start [https://www.howtogeek.com/140679/beginner-geek-how-to-start-using-the-linux-terminal/ here]. Editing text files via commandline is often a challenge. Suggest using nano and reading guide [https://www.howtogeek.com/howto/42980/the-beginners-guide-to-nano-the-linux-command-line-text-editor/ here]

If you are new to linux and accessing your server from Windows, highly suggest using MobaXterm as your SSH client as that can make required editing of text files easier using built in editor instead of the native linux command line editors.

And finally, ask yourself why you want to setup a server? If you look at the list, there are many, many more servers than players. If you don't have a team, discord community, or group of friends ready to play on your server, chances are it will go unused. Got one of these... great, let's go.

If you don't want to go through the hassle yourself and want to pay for a hosting service Arctic VR (PC and Shack) and Horde (Shack) provide a server hosting services and are trusted in the community. See links below.

----

=== Server Requirements ===

'''Pavlovserver can only be hosted under Linux.'''

This can be running as a VM under windows, but this will increase the complexity of the setup beyond this guide.

Ubuntu 18.04 x86_64, Ubuntu 19/04 amd64, Ubuntu 20.04, and Rocky Linux 8 are confirmed working. Ubuntu 15.04 x86 is known to fail to install using this guide. Recommend not running on "minimal" images as some tools are missing.

* 2GB RAM + 1GB RAM per each additional server with 10 players. More RAM is recommended for larger maps, higher player counts, or complex gamemodes. Not having enough RAM is a common cause of server crashes.

* A ~2.5Ghz CPU will comfortably support a 10 player server.

* A ~4Ghz CPU will comfortably support 24 players. This is a limit built into Pavlov itself, no server will allow players to join over 24. Lower player counts are recommended for complex gamemodes (E.g. CodZ) and/or highly detailed maps, so that maximum number will often be lower.

(Note that these are '''not''' hard limits for player counts, just suggestions for the best performance, based on experiences with many server providers on different grades of hardware.)

* Pavlovserver is functionally single threaded (one thread does vast majority of work). More CPUs only help if you are running more servers. More clockspeed = higher performance = more users per server.
The maximum number of servers you can run is dependent on how many CPUs you have. For example, if you have an 8 core CPU, the maximum number of servers would be 7. You should always have at least one CPU free as overhead, as Pavlov servers can use slightly more than one thread.

----

==== Hosting at home ====
When hosting at home there are additional requirements regarding networking: Your router has to support port-forwarding, hair-pinning/LoopbackNAT, and respond to ping requests. These techniques are necessary to allow your server to be found and to talk back to the client. please see https://en.wikipedia.org/wiki/Port_forwarding, https://en.wikipedia.org/wiki/Hairpinning, and https://www.speedguide.net/faq/how-to-become-pingable-behind-a-routerfirewall-376 for more info and google for these terms in addition to your router model to find guides on how to enable/configure it properly. If you have modern Router, it may have these features already enabled, in this case you just have to configure port-forwarding. If you can see your server but not join it while others can, this is indicative of a failure of LoopbackNAT.

A second challenge to hosting at home is CGNAT (Carrier grade NAT: https://www.a10networks.com/blog/carrier-grade-nat/). Just like NAT on your home network that has to be gotten around w/ port-forwarding, CGNAT breaks the ability of external connections to be made back to your server, but the controls are solely in your ISPs hands. Sometimes if you ask, you can be removed from CGNAT pools and/or assigned a static IP. CGNAT rollouts are becoming very common now, so if your server worked then doesn't allow connections now, your ISP may have made this change.

You can check whether you’re on a CGNAT network by visiting a Web site such as ipaddress.com or whatsmyip.com and comparing the IP address listed to the public/WAN IP address assigned to your Internet gateway. To find your gateway’s public IP address, check the status page in the administrative interface. If the two IP addresses differ, you’re likely on a CGNAT network. If so, this problem must be resolved before you go any further.

'''Not understanding these requirements and configuration is a frequent cause of failed setups and questions in discord. Don't skip this if you are trying to host from home'''

'''There are serious security implications of hosting this software at home.''' None of the devs are security experts and there has been no security review of the code. You are opening up your system to the world and publicity advertising this fact. Expect that any system hosting this software is open to compromise from the Internet and act accordingly. If your router offers a DMZ network, use it. Consider hosting on a cloud based server and think twice before running this software on any system that contains data you care about or has access to networks and computers you care about.

If you're hosting at home using Oracle's VirtualBox, there are steps you can take to prevent double NAT (which can cause issues later on)

1. Select your VM and then click Settings in VirtualBox's main window.

2. Click on Network and change Attached To from NAT to Bridged Adapter.

Once you've done this, your VM should be connected directly to your home router and double NAT should no longer be a issue.

----

==== Starting Server Install ====

====Obtaining an ApiKey====
For your server to show up in the server list, there is now a requirement to have an ApiKey issued by vankrupt. This is to prevent DOS attacks against the master server

Get the key by going here: https://pavlov-ms.vankrupt.com/servers/v1/key and using your mobile number to get a SMS
(note that there have been reported failures of this SMS system for non-US mobiles. In this case DM davevillz your mobile and ask for a key)

Put this key in your Game.ini as follows:
ApiKey="ABC123FALSEKEYDONTUSEME"
or if you would like (personally untested..I would use game.ini) you can call it at server runtime with flag as follows:
-KEY="ABC123FALSEKEYDONTUSEME"

This key can be re-used for a reasonable number of servers (a limit of 10 has been mentioned). Contact the Devs if you need more servers per key.

====System setup and software installation====

Install dependencies and create the `steam` user. (You only need to do this once):

Confirm Linux version
<pre>
lsb_release -a
</pre>

'''Ubuntu 20.04'''
'''''sudo apt update''''' && '''''sudo apt install''''' -y gdb curl lib32gcc1 libc++-dev unzip
sudo useradd -m steam
'''Ubuntu 20.10 or higher'''
sudo apt update && sudo apt install -y gdb curl lib32gcc-s1 libc++-dev unzip
sudo useradd -m steam
'''Rocky Linux, CentOS 8, and RHEL 8'''
sudo sed -i 's/^SELINUX=enforcing$/SELINUX=permissive/g' /etc/selinux/config
sudo setenforce 0
sudo yum install gdb curl glibc.i686 libstdc++.i686 libstdc++-devel.i686 libstdc++-devel.x86_64 unzip wget -y
wget <nowiki>https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/l/libcxx-3.8.0-3.el7.x86_64.rpm</nowiki>
sudo rpm -i libcxx-3.8.0-3.el7.x86_64.rpm
sudo useradd -m steam
[Optional] Set a password for steam.
<pre>sudo passwd steam</pre>

Login as the steam user. ('''You will need to do this each time you connect to your server'''):

<pre>
sudo su -l steam
</pre>

Install Steam:

<pre>
mkdir ~/Steam && cd ~/Steam && curl -sqL "https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz" | tar zxvf -
</pre>

There are different dedicated server versions for Pavlov Server - choose which server version you want to host (PC non-beta, PC Beta, Shack Live, or Shack RC)
(You will need to run this command each time there is a Pavlov Server update).

 
To host '''PC Server (non-beta)''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta default +exit
</pre>

To host '''PC BETA''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta beta_server +exit
</pre>

To host '''Shack Live''' (Quest):

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack +exit
</pre>

To host '''Shack RC''' (Quest): 

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack_beta +exit
</pre>

Now that we've installed the server, all pavlov server versions should continue. 
Install a fresh copy of steamclient.so (May have to do this after each update):
<pre>
~/Steam/steamcmd.sh +login anonymous +app_update 1007 +quit
mkdir -p ~/.steam/sdk64
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/pavlovserver/Pavlov/Binaries/Linux/steamclient.so
</pre>

The update 29 of the PCVR version of pavlov and after added a requirement to run these commands to change the steamclient.so:
<code>sudo rm /usr/lib/x86_64-linux-gnu/libc++.so</code>
<code>sudo ln -s /usr/lib/x86_64-linux-gnu/libc++.so.1 /usr/lib/x86_64-linux-gnu/libc++.so</code>

Make the PavlovServer script executable. (You only need to do this once):

<pre>
chmod +x ~/pavlovserver/PavlovServer.sh
</pre>

----

=== Server Configuration ===

Before starting the server we need to configure it. Start by creating some directories:

<pre>
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Logs
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps
</pre>

==== Mods/Blacklist/Whitelist (optional) ====

The following three files allow you to specify mods, banned players, and whitelist players. These are optional, but go ahead and create them. Populating the files is described later.

<pre>
touch /home/steam/pavlovserver/Pavlov/Saved/Config/mods.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/blacklist.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/whitelist.txt
</pre>

====Configuring Game.ini====
Create a new Game.ini file using following command to open an editor and copy/paste the following block into it then save it. Note not all of these options are required. For instance remove or comment out the Password=0000 line to make a public server with no pin.
<pre>
nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini
</pre>

<pre>
[/Script/Pavlov.DedicatedServer]
bEnabled=true
ServerName="My_private_idaho"
MaxPlayers=10 #Set this to 10 for Shack. 24 is the max for PC, setting it higher will not allow players to join.
ApiKey="ABC123FALSEKEYDONTUSEME"
bSecured=true
bCustomServer=true
bVerboseLogging=false
bCompetitive=false #This only works for SND
bWhitelist=false
RefreshListTime=120
LimitedAmmoType=0
TickRate=90
TimeLimit=60
#Password=0000
#BalanceTableURL="vankruptgames/BalancingTable/main"
MapRotation=(MapId="UGC1758245796", GameMode="GUN")
MapRotation=(MapId="datacenter", GameMode="SND")
MapRotation=(MapId="sand", GameMode="DM")

</pre>

* '''bEnabled''' - whether the server appears in the server list (unconfirmed)
* '''ServerName''' - name it will be listed as. (approx 35 chars max)
* '''MaxPlayers''' - See suggested specs for limits. 10 standard (10 for shack), 20-24 is max recommended for large maps like Stalingrad or PUSH/RUSH modes, and servers allow a maximum of 24 players.
* '''ApiKey''' - Unique ApiKey required to register server with master server. Replace with your key
* '''bSecured''' - enabled Valve Anti-Cheat (VAC)
* '''bCustomServer''' - activates some new modding tools (save and http functions. Required to write to blacklist.txt for bans)
* '''bCompetitive''' - sets the server to competitive mode for SND. If removed the server will default to false
* '''bVerboseLogging''' - enables verbose logging, mostly detailed statistics. Be prepared for significant increase in logging.
* '''bWhitelist''' - Only allow users in whitelist.txt to join
* '''RefreshListTime''' - sets how often the running server checks for updates in ban/whitelist/mod files
* '''LimitedAmmoType''' - sets limited ammo mode, see Limited Ammo Types table below

* '''TimeLimit''' - sets time limit for each map
* '''TickRate''' - sets the server tickrate. (so far minimum stable seems around 50 and max around 120. Beware setting this changes weapon despawn time and breaks some game modes. Recommend not touching)
* '''Password''' - PIN number for server #FYI - this is now also changeable via rcon.
* '''BalanceTableURL''' - Points to a custom balance table from github. See https://github.com/vankruptgames/BalancingTable for instructions. This line isn't needed if you don't have one.
* '''MapRotation''' - you can add multiple of these. The map system has switched from the steam workshop to modio which means that the server rotation will need to be redone with modio UGCs. <nowiki>https://mod.io/g/pavlov</nowiki>. This is done by taking the resource ID from the modio page, adding “UGC” in front of it and then adding that to the rotation. For example the map gravity <nowiki>https://mod.io/g/pavlov/m/gravity1</nowiki> has a resource ID of 2773760 so the map ID to add to the server would be “UGC2773760”. When a match ends, the server will load the next map in the rotation.
* '''AFKTimeLimit''' There is now a feature to kick players who are idle in the game. Integers are measured in seconds and 0 disables AFK kicking completely.

Available game modes as of 09/06/2022: See Game modes table below

For maps running a Custom gamemode (CodZ, BR, Duel, etc.) it doesn't matter which gamemode you choose, as the map will automatically override it with the custom mode.

{| class="wikitable"
|+Limited Ammo Types
!AmmoType
!Name
!Description
|-
|0
|Unlimited
|Players have unlimited ammo, carry no ammo boxes and do not display an ammo count on the wrist.
|-
|1
|Limited Generic
|Players carry ammo boxes with a limited amount of ammo.
One box for each weapon class (Pistol, Submachine gun, Rifles/MGs, Shotgun, Sniper).

Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.

An ammo count is displayed on the wrist.
|-
|2
|Limited Specific
|Players carry ammo boxes with a limited amount of ammo.
One box for each weapon.

Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.

An ammo count is displayed on the wrist.
|-
|3
|Custom
|Allows for full control over ammo by the map.
|-
|4
| Limited Special
|'''All weapons except "special" weapons are unlimited, more clarification is needed.'''
|-
|5
|Boxless
|'''Like limited generic but without boxes? Clarification is needed.'''
|}
{| class="wikitable"
|+Game modes
!GameMode
!Name
|-
|DM
|Death match
|-
|KOTH
|King of the hill
|-
|GUN
| Gun game
|-
|OITC
| One in the chamber
|-
|SND
|Search and destroy
|-
|TANKTDM
|WW2 Team Death Match
|-
| TDM
|Team Death Match
|-
|TTT
|Trouble in Terrorist Town
|-
|WW2GUN
|WW2 gun game
|-
|ZWV
| Zombie wave survival
|-
|HIDE
|The Hidden
|-
|INFECTION
|Hidden infection
|-
|PUSH
|Push
|-
|PH
|Prop hunt
|}
= Default Map ID's =
datacenter

sand

bridge

containeryard

siberia (Prison Break)

hospital (Zombies map)

killhouse

range

tutorial

santorini

station

industry

ogcontainers (Shack only)

haguenau (Shack only)

foundation (Shack only)

stalingrad (PC only)

stalingrad_night (PC only)

santorini_night (PC only)

sand_night (PC only)

station_night (PC only)

industry_night (PC only)

bunker (PC only)

==== Firewall/Port forwarding ====
Using the default settings there are two UDP ports (7777, 8177) that need to be allowed to access the server either by firewall setup or port forwarding.

'''Ubuntu''' firewall commands to check firewall and open ports:
<pre>
sudo ufw status
sudo ufw allow 7777
sudo ufw allow 8177
sudo ufw allow 9100
sudo ufw status
</pre>

'''Rocky Linux''' firewall commands to check firewall and open ports:
<pre>
sudo firewall-cmd --zone=public --add-port=7777/tcp
sudo firewall-cmd --zone=public --add-port=7777/udp
sudo firewall-cmd --zone=public --add-port=8177/tcp
sudo firewall-cmd --zone=public --add-port=8177/udp
sudo firewall-cmd --zone=public --add-port=9100/udp
sudo firewall-cmd --zone=public --add-port=9100/tcp
sudo firewall-cmd --list-ports
firewall-cmd --runtime-to-permanent
</pre>

You may also need to allow Pings (ICMP) for the server's true latency to appear in the master list.

If you are running multiple servers and have set additional ports (see http://wiki.pavlov-vr.com/index.php?title=Dedicated_server#Running_multiple_servers_on_one_host) then you need to allow access to the defined port plus the port 400 higher. So if you use 7000 as your port, then UDP 7000 and 7400 need to be open

If you have setup rcon via RconSettings.txt (below) then that port also need to be allowed access via TCP

If you are running Shack/Quest and want to have maps that are downloadable from your server, your server ports (ex. 7777 & 8177) must also be open via TCP

----

==== Shack Maps (Quest) ====

If you try to use the steps above to add maps for Shack, youll run into issues very quickly. This is because Shack has no affiliation to Steam, and therefore cannot use Steam Workshop maps like above. In the future, these steps will apply to PC servers as well, allowing a server to hold the map itself, instead of offloading to Steam.

To get started, first create the directory to hold the maps

<pre>mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps</pre>

You can use any number of methods to move the map files onto the server, but ill go over the two simplest, starting with a GUI approach

Download and install CyberDuck onto your "home" PC (Whatever PC you use for access to the server, but not the server itsself): https://cyberduck.io/

Next, download and unzip your map of choice from https://www.pavlovquest.com/ , https://pavlovhorde.com/mapsList, or look in #shack-map-showcase channel in the discord server. I'm going to use Cheeto's WW2 Items test (http://www.mediafire.com/file/emyt9bs1z9u9ykw/SVR_Cheeto_Items.zip/file ) for this example, you do what you like

In the top left corner, open a connection, set the connection type to SFTP, and fill in the rest of the information. User will be root, password is whatever you set the root pw as (toor in Ubuntu by default)

In the directory dropdown (itll say /root) go back to /

Follow the directories until we arrive back at our "maps" folder <pre>/home/steam/pavlovserver/Pavlov/Saved/maps</pre>

Drag and drop the unzipped map folder into the main window, in this case itll be SVR_Cheeto_Items

Hit Allow

Youll now see a folder named SVR_Cheeto_Items, and within it should be nothing but 3 files. If there is another folder in it, move this folder to the maps directory, otherwise the server wont work. The 3 files (2 .PAK one .JSON) should be in home/steam/pavlovserver/Pavlov/Saved/maps/SVR_Cheeto_Items, no more, no less.

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

To play the map, you can either use RCON switch map command, or to add the map to your servers automatic map rotation list, add the map's folder name to your Game.ini. This replaces the MapID section, so for our example it would be

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

And thats all! Disconnect CyberDuck from your server before playing, otherwise youll have difficulty joining.

-----------

==== Adding Shack Maps over Command Line Interface ====

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

A bit more complicated, but adding maps over CLI has its benefits

First, CD to the maps directory you made above

<pre>cd ~/pavlovserver/Pavlov/Saved/maps</pre>

Download the map files from whatever you use to upload them. To do this, you can either use curl or wget

<pre>curl -O insertURLhere</pre>

'''If you download your map from Google Drive''', make sure that your .zip folder is shared to anyone.
Then, get the file's url from the shared link. Example : ''<nowiki>https://drive.google.com/file/d/19bI8gUHaN5tUrDvnadAacUnchQf6_k/view</nowiki>'' will be ''19bI8gUHaN5tUrDvnadAacUnchQf6_k''
Edit "fileId" and "fileName" before you execute the command.
<pre>
fileId=19bI8gUHaN5tUrDvnadAacUnchQf6_k
fileName=SVR_USER_MAPNAME
curl -sc /tmp/cookie "https://drive.google.com/uc?export=download&id=${fileId}" > /dev/null
code="$(awk '/_warning_/ {print $NF}' /tmp/cookie)"
curl -Lb /tmp/cookie "https://drive.google.com/uc?export=download&confirm=${code}&id=${fileId}" -o ${fileName} </pre>

To keep with the Items example:

<pre>curl -O https://cdn.discordapp.com/attachments/744185280759857234/745027406695366788/SVR_Cheeto_Items.zip</pre>

Next, unzip the file. If this next step errors out, saying the command is unknown, switch back to the root user (su root), and install unzip (sudo apt install unzip), then return to the steam user, and continue.

<pre>unzip SVR_Cheeto_Items.zip</pre>

Now finish like before by adding the map to your Game.ini

<pre>nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini</pre>

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

==== Admin/Moderator list (optional) ====

The only working in-game admin menu is through Arctic VR server hosting (see below).

If you add moderators to your server, they will not be subject to vote kicks.

<pre>
nano ~/pavlovserver/Pavlov/Saved/Config/mods.txt
</pre>

Example Mod List:
<pre>
76541198397498572 #Optional Comment: Player name
76541198397498573 #Some Other Player
</pre>

==== ArcticVR Admin Menu ====

[[File:Arcticmenu.jpg|500px|link=https://www.arctic-vr.com/server-admin-menu]]

Arctic-VR Offers an advanced In-Game Admin menu that is exclusive to their hosting service. Features include:
* Switch Maps+Modes
* Teleport Players to Players
* Change Player Skins
* Control Player Buying+Cash
* Spawn Items
* Clean up corpses + guns
* Spawn Bots
* Spawn Items for other players
* Control Teams + Balance/Shuffle Teams
* ResetSND
* And More

You can read more about the ArcticVR admin menu on their website: https://www.arctic-vr.com/server-admin-menu

==== Handy tools for finding steamIDs ====

Steam ID finder: https://steamidfinder.com/lookup/ or https://steamid.xyz/

You want to enter in the steamID64 format.

This tool can convert or lookup IDs: https://steamid.io/

If you are looking for a steamID of a player that has been on your server recently this is technique to find them:
<pre>
grep -i playername ~/pavlovserver/Pavlov/Saved/Logs/* | grep TicketValidation
</pre>

=== Configure Rcon ===
To enable Rcon access create config file:
<pre> nano /home/steam/pavlovserver/Pavlov/Saved/Config/RconSettings.txt </pre>

Copy in the following text - change password, and if desired the port:
<pre>
Password=ChangeThisPassword
Port=9100
</pre>
You must specify a port for the Rcon server to use as well as a Password (use a different port per sever instance if running multiple server instances off the same hardware)

=== Starting the server ===

<pre>
cd ~/pavlovserver && ./PavlovServer.sh
</pre>

That's it, your server will be automatically broadcast to the master server! :)

Two handy tools to determine quickly if your server is broadcasting are [https://pablub.xyz/ Pablub] (PC only) and [https://pavlovhorde.com/ Horde] (Shack) and [https://pavlovhorde.com/pcServers Horde] (PC version)

Note that when you close your terminal, the server will go down. See the "supervisors" section below for how to prevent this.

----

=== Supervising the server using systemd ===

Running '''./PavlovServer.sh''' in your interactive shell is easy, but the server will shut down when you close your terminal. If you want to run the server in the background,
you'll want to run it under a supervisor. There are many options, ranging from the simple (nohup, screen or tmux), to the
more robust (supervisord, systemd).

Systemd is running by default on Ubuntu Linux, so we'll use that here.

To run the server as a systemd service, create the file '''/etc/systemd/system/pavlovserver.service''' (as root) by typing
<pre>
sudo nano /etc/systemd/system/pavlovserver.service
</pre>

Copy contents below into the file and save.

<pre>
[Unit]
Description=Pavlov VR dedicated server

[Service]
Type=simple
WorkingDirectory=/home/steam/pavlovserver
ExecStart=/home/steam/pavlovserver/PavlovServer.sh

RestartSec=1
Restart=always
User=steam
Group=steam

[Install]
WantedBy = multi-user.target
</pre>

If you'd like your server to start as competitive without editing the game.ini, change the line "ExecStart=/home/steam/pavlovserver/PavlovServer.sh" to look like this below. Though it's much easier to just use the game.ini to enable competitive instead. <pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -COMPETITIVE=1</pre>

Change the user or paths as appropriate. After saving the service file, to start, restart, stop, or monitor the server:

<pre>
sudo systemctl start pavlovserver
sudo systemctl restart pavlovserver
sudo systemctl stop pavlovserver
sudo systemctl status pavlovserver
</pre>

To view the logs:

<pre>
sudo journalctl -u pavlovserver
# to live-tail the logs
sudo journalctl -u pavlovserver -f
</pre>

If you want to run the pavlov server as soon as your server boots (e.g. a VPS you turn on and off), add pavlov as a startup service:

<pre>
sudo systemctl enable pavlovserver
</pre>

----

== Advanced Server Administration ==

=== Running multiple servers on one host ===

* Pavlovserver is functionally single threaded (there are multiple threads, but vast majority of work occurs in the primary one). Make sure you have # of pavlovservers + 1 CPU available. More CPUs= more servers. Faster CPU = more players.
* Make multiple server installs by defining a separate install dir for each server.
* Run each server with a unique port. eg: '''./PavlovServer.sh -PORT="Desired Port"'''
* The Server will use the Desired Port and the Port 400 above (Example: You choose 8200 as Port. So Port 8600 will be used as well)
* If you are using RCON, each server will need a unique port defined in RconSettings.txt
* Ensure the ports are forwarded and opened in your firewall

To duplicate directories:

be in the steam home folder
<pre>
cp -r pavlovserver pavlovserver1
/home/steam/pavlovserver1/PavlovServer.sh -PORT=[Desired Port]
</pre>

=== Starting server in competitive mode ===
Competitive mode will prevent dead teammates from being able to see the match, to prevent ghosting.
You can either enable this via Game.ini (described in Game.ini file), or using the -COMPETITIVE=1 parameter.

<pre>
/home/steam/pavlovserver1/PavlovServer.sh -COMPETITIVE=1
</pre>

{| class="wikitable"

|}

=== Useful Linux Commands ===
List files / folders in directory, print current working directory,
<pre>ls -la #list files/directories along with authorities and ownership
pwd #print working directory
sudo chown <owner> <file/directory> #change owner of file/directory. If root created something and you need to change it to steam
sudo chgrp <group> <file/directory> #change group of file/directory.
</pre>

Check if pavlov is running by checking process status. If the only row you see is the grep command, pavlov server is not started.
<pre> ps -ef | grep pav </pre>

Sample output:
<pre>
steam 34044 1 0 16:52 ? 00:00:00 /bin/sh /home/steam/pavlovserver/PavlovServer.sh
steam 34066 34044 80 16:52 ? 00:00:04 /home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer
zombies+ 34101 34013 0 16:52 pts/0 00:00:00 grep --color=auto pav
</pre>

Kill a process. Note this command uses 34044, which is a process id from the command output above.
<pre> kill -9 34044 </pre>

Dump the log to the console so you can scroll through it:
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log </pre>

Search the log for a string - replace my_string with case-sensitive string
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep my_string </pre>

<hr>

== Advanced Scripts For Server Management ==
<hr>

=== '''Auto-updating the server''' ===
Assuming you have followed this guide and used the default paths, users, and install instructions, you can paste the following into your terminal to auto-update your Pavlov server:

<pre>
cat << 'EOF' > $HOME/pavlov_daily_update_and_restart.sh
#!/bin/bash

USER="steam"
SERVICENAME="pavlovserver.service"
INSTALLDIRNAME="pavlovserver"
USERHOME="/home/$USER"

echo -e "Beginning Pavlov VR update run on $(date)\n\n"

systemctl stop "$SERVICENAME"

sleep 5
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +force_install_dir "$USERHOME/$INSTALLDIRNAME" +app_update 622970 +exit
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +app_update 1007 +quit
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/.steam/sdk64/steamclient.so"
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/pavlovserver/Pavlov/Binaries/Linux/steamclient.so"

systemctl start "$SERVICENAME"

echo -e "Ending Pavlov VR update run on $(date)\n\n"

EOF

chmod +x $HOME/pavlov_daily_update_and_restart.sh
mkdir $HOME/pavlov_update_logs && touch $HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log
CRONLINE="00 2 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
(sudo crontab -u root -l; echo "$CRONLINE" ) | sudo crontab -u root -
unset CRONLINE

</pre>

These commands will:

1. Create a shell script in the "steam" user's home directory that automatically stops the Pavlov server, pulls any updates via steam, pull updates to the Steamworks SDK Redist, and copies the latest version of steamclient.so to the Pavlov server directory

2. Make the shell script executable

3. Create a new directory called "pavlov_update_logs" in the "steam" user's directory, and create a logfile inside that directory called "pavlov_daily_update_and_restart.sh.log". You can check this logfile to see the output of the Pavlov and Steam SDK update commands.

4. Create a crontab entry for the root user that runs this shell script automatically every day at 2:00AM local time

If you want to change the time that this script runs, edit the numbers "00 2" in the line that starts with "CRONLINE=". In the example provided, 00 is the minutes column, and 2 is the hour column. For example, if you wanted the server to automatically update and restart at 4:17AM every day, change the line starting with "CRONLINE=" to:

<pre>
CRONLINE="17 4 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
</pre>

If the time is PM, use 24-hour time format, e.g. "32 18" for 6:32PM.
<hr>
=== '''Save Logs for records and stats''' ===
this is a automated script that will on a timer save all the backups made by the server before they are purged by the game for admin records and starts collection

https://github.com/JTWP-org/backUpLogs2
<hr>

=== Make an API request with Mod.io to get map picture and name ===
very basic script pass the script a map id as an argument then it will give u the name and a thumbnail to use

https://github.com/JTWP-org/mod.io-modcheck/tree/main

=== '''Sharing Bans over gameserver on same machine''' ===
when u have a lot of servers keeping the bans synced can be a nightmare so using a symbolic link allows all the servers to use one file

for this lets say i have pavlovserver000 and pavlovserver001 and they are located at /home/steam/pavlovserver000 and /home/steam/pavlovserver001

''step 1 will be to pick a blacklist to use as the new one and move it to a central location''
mkdir ~/shared ; mv /home/steam/pavlovserver000/Pavlov/Saved/Config/blacklist.txt ~/shared/blacklist.txt ; rm /home/steam/pavlovserver001/Pavlov/Saved/Config/blacklist.txt
now we have moved the blacklist from pavlovserver000 to a folder in our home called shared and then we removed the blacklist from pavlovserver001

step 2 making the links
ln -s ~/shared/blacklist.txt /home/steam/pavlovserver000/Pavlov/Saved/Config/blacklist.txt ; ln -s ~/shared/blacklist.txt /home/steam/pavlovserver001/Pavlov/Saved/Config/blacklist.txt
now editing them in pavlovserver001's files will update the list for all of the servers its not a sync its using the same list if u want to check where a link is pointed if u
ls -l
it will show where the file is really located

<hr>

Setting up a dedicated server

2023-07-18T01:55:00Z

SaltedCrackerJack: /* Advanced Scripts For Server Management */

== Setting up a dedicated server ==

'''There are no Windows binaries'''

This guide is written exclusively for Linux and covers Ubuntu/Debian/Debian-like and Red Hat RPM-based distros. Possible to run with other distros, but some of the commands won't work and you will need to know enough to figure out the software install of dependencies on your own.

If you are considering hosting from home, please read that section of the wiki first.

This guide assumes you know the basics of using a bash terminal: ssh'ing into a server, running bash commands, editing text files, etc.

If you have no experience using bash, maybe start [https://www.howtogeek.com/140679/beginner-geek-how-to-start-using-the-linux-terminal/ here]. Editing text files via commandline is often a challenge. Suggest using nano and reading guide [https://www.howtogeek.com/howto/42980/the-beginners-guide-to-nano-the-linux-command-line-text-editor/ here]

If you are new to linux and accessing your server from Windows, highly suggest using MobaXterm as your SSH client as that can make required editing of text files easier using built in editor instead of the native linux command line editors.

And finally, ask yourself why you want to setup a server? If you look at the list, there are many, many more servers than players. If you don't have a team, discord community, or group of friends ready to play on your server, chances are it will go unused. Got one of these... great, let's go.

If you don't want to go through the hassle yourself and want to pay for a hosting service Arctic VR (PC and Shack) and Horde (Shack) provide a server hosting services and are trusted in the community. See links below.

----

=== Server Requirements ===

'''Pavlovserver can only be hosted under Linux.'''

This can be running as a VM under windows, but this will increase the complexity of the setup beyond this guide.

Ubuntu 18.04 x86_64, Ubuntu 19/04 amd64, Ubuntu 20.04, and Rocky Linux 8 are confirmed working. Ubuntu 15.04 x86 is known to fail to install using this guide. Recommend not running on "minimal" images as some tools are missing.

* 2GB RAM + 1GB RAM per each additional server with 10 players. More RAM is recommended for larger maps, higher player counts, or complex gamemodes. Not having enough RAM is a common cause of server crashes.

* A ~2.5Ghz CPU will comfortably support a 10 player server.

* A ~4Ghz CPU will comfortably support 24 players. This is a limit built into Pavlov itself, no server will allow players to join over 24. Lower player counts are recommended for complex gamemodes (E.g. CodZ) and/or highly detailed maps, so that maximum number will often be lower.

(Note that these are '''not''' hard limits for player counts, just suggestions for the best performance, based on experiences with many server providers on different grades of hardware.)

* Pavlovserver is functionally single threaded (one thread does vast majority of work). More CPUs only help if you are running more servers. More clockspeed = higher performance = more users per server.
The maximum number of servers you can run is dependent on how many CPUs you have. For example, if you have an 8 core CPU, the maximum number of servers would be 7. You should always have at least one CPU free as overhead, as Pavlov servers can use slightly more than one thread.

----

==== Hosting at home ====
When hosting at home there are additional requirements regarding networking: Your router has to support port-forwarding, hair-pinning/LoopbackNAT, and respond to ping requests. These techniques are necessary to allow your server to be found and to talk back to the client. please see https://en.wikipedia.org/wiki/Port_forwarding, https://en.wikipedia.org/wiki/Hairpinning, and https://www.speedguide.net/faq/how-to-become-pingable-behind-a-routerfirewall-376 for more info and google for these terms in addition to your router model to find guides on how to enable/configure it properly. If you have modern Router, it may have these features already enabled, in this case you just have to configure port-forwarding. If you can see your server but not join it while others can, this is indicative of a failure of LoopbackNAT.

A second challenge to hosting at home is CGNAT (Carrier grade NAT: https://www.a10networks.com/blog/carrier-grade-nat/). Just like NAT on your home network that has to be gotten around w/ port-forwarding, CGNAT breaks the ability of external connections to be made back to your server, but the controls are solely in your ISPs hands. Sometimes if you ask, you can be removed from CGNAT pools and/or assigned a static IP. CGNAT rollouts are becoming very common now, so if your server worked then doesn't allow connections now, your ISP may have made this change.

You can check whether you’re on a CGNAT network by visiting a Web site such as ipaddress.com or whatsmyip.com and comparing the IP address listed to the public/WAN IP address assigned to your Internet gateway. To find your gateway’s public IP address, check the status page in the administrative interface. If the two IP addresses differ, you’re likely on a CGNAT network. If so, this problem must be resolved before you go any further.

'''Not understanding these requirements and configuration is a frequent cause of failed setups and questions in discord. Don't skip this if you are trying to host from home'''

'''There are serious security implications of hosting this software at home.''' None of the devs are security experts and there has been no security review of the code. You are opening up your system to the world and publicity advertising this fact. Expect that any system hosting this software is open to compromise from the Internet and act accordingly. If your router offers a DMZ network, use it. Consider hosting on a cloud based server and think twice before running this software on any system that contains data you care about or has access to networks and computers you care about.

If you're hosting at home using Oracle's VirtualBox, there are steps you can take to prevent double NAT (which can cause issues later on)

1. Select your VM and then click Settings in VirtualBox's main window.

2. Click on Network and change Attached To from NAT to Bridged Adapter.

Once you've done this, your VM should be connected directly to your home router and double NAT should no longer be a issue.

----

==== Starting Server Install ====

====Obtaining an ApiKey====
For your server to show up in the server list, there is now a requirement to have an ApiKey issued by vankrupt. This is to prevent DOS attacks against the master server

Get the key by going here: https://pavlov-ms.vankrupt.com/servers/v1/key and using your mobile number to get a SMS
(note that there have been reported failures of this SMS system for non-US mobiles. In this case DM davevillz your mobile and ask for a key)

Put this key in your Game.ini as follows:
ApiKey="ABC123FALSEKEYDONTUSEME"
or if you would like (personally untested..I would use game.ini) you can call it at server runtime with flag as follows:
-KEY="ABC123FALSEKEYDONTUSEME"

This key can be re-used for a reasonable number of servers (a limit of 10 has been mentioned). Contact the Devs if you need more servers per key.

====System setup and software installation====

Install dependencies and create the `steam` user. (You only need to do this once):

Confirm Linux version
<pre>
lsb_release -a
</pre>

'''Ubuntu 20.04'''
'''''sudo apt update''''' && '''''sudo apt install''''' -y gdb curl lib32gcc1 libc++-dev unzip
sudo useradd -m steam
'''Ubuntu 20.10 or higher'''
sudo apt update && sudo apt install -y gdb curl lib32gcc-s1 libc++-dev unzip
sudo useradd -m steam
'''Rocky Linux, CentOS 8, and RHEL 8'''
sudo sed -i 's/^SELINUX=enforcing$/SELINUX=permissive/g' /etc/selinux/config
sudo setenforce 0
sudo yum install gdb curl glibc.i686 libstdc++.i686 libstdc++-devel.i686 libstdc++-devel.x86_64 unzip wget -y
wget <nowiki>https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/l/libcxx-3.8.0-3.el7.x86_64.rpm</nowiki>
sudo rpm -i libcxx-3.8.0-3.el7.x86_64.rpm
sudo useradd -m steam
[Optional] Set a password for steam.
<pre>sudo passwd steam</pre>

Login as the steam user. ('''You will need to do this each time you connect to your server'''):

<pre>
sudo su -l steam
</pre>

Install Steam:

<pre>
mkdir ~/Steam && cd ~/Steam && curl -sqL "https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz" | tar zxvf -
</pre>

There are different dedicated server versions for Pavlov Server - choose which server version you want to host (PC non-beta, PC Beta, Shack Live, or Shack RC)
(You will need to run this command each time there is a Pavlov Server update).

 
To host '''PC Server (non-beta)''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta default +exit
</pre>

To host '''PC BETA''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta beta_server +exit
</pre>

To host '''Shack Live''' (Quest):

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack +exit
</pre>

To host '''Shack RC''' (Quest): 

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack_beta +exit
</pre>

Now that we've installed the server, all pavlov server versions should continue. 
Install a fresh copy of steamclient.so (May have to do this after each update):
<pre>
~/Steam/steamcmd.sh +login anonymous +app_update 1007 +quit
mkdir -p ~/.steam/sdk64
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/pavlovserver/Pavlov/Binaries/Linux/steamclient.so
</pre>

The update 29 of the PCVR version of pavlov and after added a requirement to run these commands to change the steamclient.so:
<code>sudo rm /usr/lib/x86_64-linux-gnu/libc++.so</code>
<code>sudo ln -s /usr/lib/x86_64-linux-gnu/libc++.so.1 /usr/lib/x86_64-linux-gnu/libc++.so</code>

Make the PavlovServer script executable. (You only need to do this once):

<pre>
chmod +x ~/pavlovserver/PavlovServer.sh
</pre>

----

=== Server Configuration ===

Before starting the server we need to configure it. Start by creating some directories:

<pre>
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Logs
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps
</pre>

==== Mods/Blacklist/Whitelist (optional) ====

The following three files allow you to specify mods, banned players, and whitelist players. These are optional, but go ahead and create them. Populating the files is described later.

<pre>
touch /home/steam/pavlovserver/Pavlov/Saved/Config/mods.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/blacklist.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/whitelist.txt
</pre>

====Configuring Game.ini====
Create a new Game.ini file using following command to open an editor and copy/paste the following block into it then save it. Note not all of these options are required. For instance remove or comment out the Password=0000 line to make a public server with no pin.
<pre>
nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini
</pre>

<pre>
[/Script/Pavlov.DedicatedServer]
bEnabled=true
ServerName="My_private_idaho"
MaxPlayers=10 #Set this to 10 for Shack. 24 is the max for PC, setting it higher will not allow players to join.
ApiKey="ABC123FALSEKEYDONTUSEME"
bSecured=true
bCustomServer=true
bVerboseLogging=false
bCompetitive=false #This only works for SND
bWhitelist=false
RefreshListTime=120
LimitedAmmoType=0
TickRate=90
TimeLimit=60
#Password=0000
#BalanceTableURL="vankruptgames/BalancingTable/main"
MapRotation=(MapId="UGC1758245796", GameMode="GUN")
MapRotation=(MapId="datacenter", GameMode="SND")
MapRotation=(MapId="sand", GameMode="DM")

</pre>

* '''bEnabled''' - whether the server appears in the server list (unconfirmed)
* '''ServerName''' - name it will be listed as. (approx 35 chars max)
* '''MaxPlayers''' - See suggested specs for limits. 10 standard (10 for shack), 20-24 is max recommended for large maps like Stalingrad or PUSH/RUSH modes, and servers allow a maximum of 24 players.
* '''ApiKey''' - Unique ApiKey required to register server with master server. Replace with your key
* '''bSecured''' - enabled Valve Anti-Cheat (VAC)
* '''bCustomServer''' - activates some new modding tools (save and http functions. Required to write to blacklist.txt for bans)
* '''bCompetitive''' - sets the server to competitive mode for SND. If removed the server will default to false
* '''bVerboseLogging''' - enables verbose logging, mostly detailed statistics. Be prepared for significant increase in logging.
* '''bWhitelist''' - Only allow users in whitelist.txt to join
* '''RefreshListTime''' - sets how often the running server checks for updates in ban/whitelist/mod files
* '''LimitedAmmoType''' - sets limited ammo mode, see Limited Ammo Types table below

* '''TimeLimit''' - sets time limit for each map
* '''TickRate''' - sets the server tickrate. (so far minimum stable seems around 50 and max around 120. Beware setting this changes weapon despawn time and breaks some game modes. Recommend not touching)
* '''Password''' - PIN number for server #FYI - this is now also changeable via rcon.
* '''BalanceTableURL''' - Points to a custom balance table from github. See https://github.com/vankruptgames/BalancingTable for instructions. This line isn't needed if you don't have one.
* '''MapRotation''' - you can add multiple of these. The map system has switched from the steam workshop to modio which means that the server rotation will need to be redone with modio UGCs. <nowiki>https://mod.io/g/pavlov</nowiki>. This is done by taking the resource ID from the modio page, adding “UGC” in front of it and then adding that to the rotation. For example the map gravity <nowiki>https://mod.io/g/pavlov/m/gravity1</nowiki> has a resource ID of 2773760 so the map ID to add to the server would be “UGC2773760”. When a match ends, the server will load the next map in the rotation.
* '''AFKTimeLimit''' There is now a feature to kick players who are idle in the game. Integers are measured in seconds and 0 disables AFK kicking completely.

Available game modes as of 09/06/2022: See Game modes table below

For maps running a Custom gamemode (CodZ, BR, Duel, etc.) it doesn't matter which gamemode you choose, as the map will automatically override it with the custom mode.

{| class="wikitable"
|+Limited Ammo Types
!AmmoType
!Name
!Description
|-
|0
|Unlimited
|Players have unlimited ammo, carry no ammo boxes and do not display an ammo count on the wrist.
|-
|1
|Limited Generic
|Players carry ammo boxes with a limited amount of ammo.
One box for each weapon class (Pistol, Submachine gun, Rifles/MGs, Shotgun, Sniper).

Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.

An ammo count is displayed on the wrist.
|-
|2
|Limited Specific
|Players carry ammo boxes with a limited amount of ammo.
One box for each weapon.

Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.

An ammo count is displayed on the wrist.
|-
|3
|Custom
|Allows for full control over ammo by the map.
|-
|4
| Limited Special
|'''All weapons except "special" weapons are unlimited, more clarification is needed.'''
|-
|5
|Boxless
|'''Like limited generic but without boxes? Clarification is needed.'''
|}
{| class="wikitable"
|+Game modes
!GameMode
!Name
|-
|DM
|Death match
|-
|KOTH
|King of the hill
|-
|GUN
| Gun game
|-
|OITC
| One in the chamber
|-
|SND
|Search and destroy
|-
|TANKTDM
|WW2 Team Death Match
|-
| TDM
|Team Death Match
|-
|TTT
|Trouble in Terrorist Town
|-
|WW2GUN
|WW2 gun game
|-
|ZWV
| Zombie wave survival
|-
|HIDE
|The Hidden
|-
|INFECTION
|Hidden infection
|-
|PUSH
|Push
|-
|PH
|Prop hunt
|}
= Default Map ID's =
datacenter

sand

bridge

containeryard

siberia (Prison Break)

hospital (Zombies map)

killhouse

range

tutorial

santorini

station

industry

ogcontainers (Shack only)

haguenau (Shack only)

foundation (Shack only)

stalingrad (PC only)

stalingrad_night (PC only)

santorini_night (PC only)

sand_night (PC only)

station_night (PC only)

industry_night (PC only)

bunker (PC only)

==== Firewall/Port forwarding ====
Using the default settings there are two UDP ports (7777, 8177) that need to be allowed to access the server either by firewall setup or port forwarding.

'''Ubuntu''' firewall commands to check firewall and open ports:
<pre>
sudo ufw status
sudo ufw allow 7777
sudo ufw allow 8177
sudo ufw allow 9100
sudo ufw status
</pre>

'''Rocky Linux''' firewall commands to check firewall and open ports:
<pre>
sudo firewall-cmd --zone=public --add-port=7777/tcp
sudo firewall-cmd --zone=public --add-port=7777/udp
sudo firewall-cmd --zone=public --add-port=8177/tcp
sudo firewall-cmd --zone=public --add-port=8177/udp
sudo firewall-cmd --zone=public --add-port=9100/udp
sudo firewall-cmd --zone=public --add-port=9100/tcp
sudo firewall-cmd --list-ports
firewall-cmd --runtime-to-permanent
</pre>

You may also need to allow Pings (ICMP) for the server's true latency to appear in the master list.

If you are running multiple servers and have set additional ports (see http://wiki.pavlov-vr.com/index.php?title=Dedicated_server#Running_multiple_servers_on_one_host) then you need to allow access to the defined port plus the port 400 higher. So if you use 7000 as your port, then UDP 7000 and 7400 need to be open

If you have setup rcon via RconSettings.txt (below) then that port also need to be allowed access via TCP

If you are running Shack/Quest and want to have maps that are downloadable from your server, your server ports (ex. 7777 & 8177) must also be open via TCP

----

==== Shack Maps (Quest) ====

If you try to use the steps above to add maps for Shack, youll run into issues very quickly. This is because Shack has no affiliation to Steam, and therefore cannot use Steam Workshop maps like above. In the future, these steps will apply to PC servers as well, allowing a server to hold the map itself, instead of offloading to Steam.

To get started, first create the directory to hold the maps

<pre>mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps</pre>

You can use any number of methods to move the map files onto the server, but ill go over the two simplest, starting with a GUI approach

Download and install CyberDuck onto your "home" PC (Whatever PC you use for access to the server, but not the server itsself): https://cyberduck.io/

Next, download and unzip your map of choice from https://www.pavlovquest.com/ , https://pavlovhorde.com/mapsList, or look in #shack-map-showcase channel in the discord server. I'm going to use Cheeto's WW2 Items test (http://www.mediafire.com/file/emyt9bs1z9u9ykw/SVR_Cheeto_Items.zip/file ) for this example, you do what you like

In the top left corner, open a connection, set the connection type to SFTP, and fill in the rest of the information. User will be root, password is whatever you set the root pw as (toor in Ubuntu by default)

In the directory dropdown (itll say /root) go back to /

Follow the directories until we arrive back at our "maps" folder <pre>/home/steam/pavlovserver/Pavlov/Saved/maps</pre>

Drag and drop the unzipped map folder into the main window, in this case itll be SVR_Cheeto_Items

Hit Allow

Youll now see a folder named SVR_Cheeto_Items, and within it should be nothing but 3 files. If there is another folder in it, move this folder to the maps directory, otherwise the server wont work. The 3 files (2 .PAK one .JSON) should be in home/steam/pavlovserver/Pavlov/Saved/maps/SVR_Cheeto_Items, no more, no less.

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

To play the map, you can either use RCON switch map command, or to add the map to your servers automatic map rotation list, add the map's folder name to your Game.ini. This replaces the MapID section, so for our example it would be

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

And thats all! Disconnect CyberDuck from your server before playing, otherwise youll have difficulty joining.

-----------

==== Adding Shack Maps over Command Line Interface ====

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

A bit more complicated, but adding maps over CLI has its benefits

First, CD to the maps directory you made above

<pre>cd ~/pavlovserver/Pavlov/Saved/maps</pre>

Download the map files from whatever you use to upload them. To do this, you can either use curl or wget

<pre>curl -O insertURLhere</pre>

'''If you download your map from Google Drive''', make sure that your .zip folder is shared to anyone.
Then, get the file's url from the shared link. Example : ''<nowiki>https://drive.google.com/file/d/19bI8gUHaN5tUrDvnadAacUnchQf6_k/view</nowiki>'' will be ''19bI8gUHaN5tUrDvnadAacUnchQf6_k''
Edit "fileId" and "fileName" before you execute the command.
<pre>
fileId=19bI8gUHaN5tUrDvnadAacUnchQf6_k
fileName=SVR_USER_MAPNAME
curl -sc /tmp/cookie "https://drive.google.com/uc?export=download&id=${fileId}" > /dev/null
code="$(awk '/_warning_/ {print $NF}' /tmp/cookie)"
curl -Lb /tmp/cookie "https://drive.google.com/uc?export=download&confirm=${code}&id=${fileId}" -o ${fileName} </pre>

To keep with the Items example:

<pre>curl -O https://cdn.discordapp.com/attachments/744185280759857234/745027406695366788/SVR_Cheeto_Items.zip</pre>

Next, unzip the file. If this next step errors out, saying the command is unknown, switch back to the root user (su root), and install unzip (sudo apt install unzip), then return to the steam user, and continue.

<pre>unzip SVR_Cheeto_Items.zip</pre>

Now finish like before by adding the map to your Game.ini

<pre>nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini</pre>

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

==== Admin/Moderator list (optional) ====

The only working in-game admin menu is through Arctic VR server hosting (see below).

If you add moderators to your server, they will not be subject to vote kicks.

<pre>
nano ~/pavlovserver/Pavlov/Saved/Config/mods.txt
</pre>

Example Mod List:
<pre>
76541198397498572 #Optional Comment: Player name
76541198397498573 #Some Other Player
</pre>

==== ArcticVR Admin Menu ====

[[File:Arcticmenu.jpg|500px|link=https://www.arctic-vr.com/server-admin-menu]]

Arctic-VR Offers an advanced In-Game Admin menu that is exclusive to their hosting service. Features include:
* Switch Maps+Modes
* Teleport Players to Players
* Change Player Skins
* Control Player Buying+Cash
* Spawn Items
* Clean up corpses + guns
* Spawn Bots
* Spawn Items for other players
* Control Teams + Balance/Shuffle Teams
* ResetSND
* And More

You can read more about the ArcticVR admin menu on their website: https://www.arctic-vr.com/server-admin-menu

==== Handy tools for finding steamIDs ====

Steam ID finder: https://steamidfinder.com/lookup/ or https://steamid.xyz/

You want to enter in the steamID64 format.

This tool can convert or lookup IDs: https://steamid.io/

If you are looking for a steamID of a player that has been on your server recently this is technique to find them:
<pre>
grep -i playername ~/pavlovserver/Pavlov/Saved/Logs/* | grep TicketValidation
</pre>

=== Configure Rcon ===
To enable Rcon access create config file:
<pre> nano /home/steam/pavlovserver/Pavlov/Saved/Config/RconSettings.txt </pre>

Copy in the following text - change password, and if desired the port:
<pre>
Password=ChangeThisPassword
Port=9100
</pre>
You must specify a port for the Rcon server to use as well as a Password (use a different port per sever instance if running multiple server instances off the same hardware)

=== Starting the server ===

<pre>
cd ~/pavlovserver && ./PavlovServer.sh
</pre>

That's it, your server will be automatically broadcast to the master server! :)

Two handy tools to determine quickly if your server is broadcasting are [https://pablub.xyz/ Pablub] (PC only) and [https://pavlovhorde.com/ Horde] (Shack) and [https://pavlovhorde.com/pcServers Horde] (PC version)

Note that when you close your terminal, the server will go down. See the "supervisors" section below for how to prevent this.

----

=== Supervising the server using systemd ===

Running '''./PavlovServer.sh''' in your interactive shell is easy, but the server will shut down when you close your terminal. If you want to run the server in the background,
you'll want to run it under a supervisor. There are many options, ranging from the simple (nohup, screen or tmux), to the
more robust (supervisord, systemd).

Systemd is running by default on Ubuntu Linux, so we'll use that here.

To run the server as a systemd service, create the file '''/etc/systemd/system/pavlovserver.service''' (as root) by typing
<pre>
sudo nano /etc/systemd/system/pavlovserver.service
</pre>

Copy contents below into the file and save.

<pre>
[Unit]
Description=Pavlov VR dedicated server

[Service]
Type=simple
WorkingDirectory=/home/steam/pavlovserver
ExecStart=/home/steam/pavlovserver/PavlovServer.sh

RestartSec=1
Restart=always
User=steam
Group=steam

[Install]
WantedBy = multi-user.target
</pre>

If you'd like your server to start as competitive without editing the game.ini, change the line "ExecStart=/home/steam/pavlovserver/PavlovServer.sh" to look like this below. Though it's much easier to just use the game.ini to enable competitive instead. <pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -COMPETITIVE=1</pre>

Change the user or paths as appropriate. After saving the service file, to start, restart, stop, or monitor the server:

<pre>
sudo systemctl start pavlovserver
sudo systemctl restart pavlovserver
sudo systemctl stop pavlovserver
sudo systemctl status pavlovserver
</pre>

To view the logs:

<pre>
sudo journalctl -u pavlovserver
# to live-tail the logs
sudo journalctl -u pavlovserver -f
</pre>

If you want to run the pavlov server as soon as your server boots (e.g. a VPS you turn on and off), add pavlov as a startup service:

<pre>
sudo systemctl enable pavlovserver
</pre>

----

== Advanced Server Administration ==

=== Running multiple servers on one host ===

* Pavlovserver is functionally single threaded (there are multiple threads, but vast majority of work occurs in the primary one). Make sure you have # of pavlovservers + 1 CPU available. More CPUs= more servers. Faster CPU = more players.
* Make multiple server installs by defining a separate install dir for each server.
* Run each server with a unique port. eg: '''./PavlovServer.sh -PORT="Desired Port"'''
* The Server will use the Desired Port and the Port 400 above (Example: You choose 8200 as Port. So Port 8600 will be used as well)
* If you are using RCON, each server will need a unique port defined in RconSettings.txt
* Ensure the ports are forwarded and opened in your firewall

To duplicate directories:

be in the steam home folder
<pre>
cp -r pavlovserver pavlovserver1
/home/steam/pavlovserver1/PavlovServer.sh -PORT=[Desired Port]
</pre>

=== Starting server in competitive mode ===
Competitive mode will prevent dead teammates from being able to see the match, to prevent ghosting.
You can either enable this via Game.ini (described in Game.ini file), or using the -COMPETITIVE=1 parameter.

<pre>
/home/steam/pavlovserver1/PavlovServer.sh -COMPETITIVE=1
</pre>

{| class="wikitable"

|}

=== Useful Linux Commands ===
List files / folders in directory, print current working directory,
<pre>ls -la #list files/directories along with authorities and ownership
pwd #print working directory
sudo chown <owner> <file/directory> #change owner of file/directory. If root created something and you need to change it to steam
sudo chgrp <group> <file/directory> #change group of file/directory.
</pre>

Check if pavlov is running by checking process status. If the only row you see is the grep command, pavlov server is not started.
<pre> ps -ef | grep pav </pre>

Sample output:
<pre>
steam 34044 1 0 16:52 ? 00:00:00 /bin/sh /home/steam/pavlovserver/PavlovServer.sh
steam 34066 34044 80 16:52 ? 00:00:04 /home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer
zombies+ 34101 34013 0 16:52 pts/0 00:00:00 grep --color=auto pav
</pre>

Kill a process. Note this command uses 34044, which is a process id from the command output above.
<pre> kill -9 34044 </pre>

Dump the log to the console so you can scroll through it:
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log </pre>

Search the log for a string - replace my_string with case-sensitive string
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep my_string </pre>

<hr>

== Advanced Scripts For Server Management ==
<hr>

=== '''Auto-updating the server''' ===
Assuming you have followed this guide and used the default paths, users, and install instructions, you can paste the following into your terminal to auto-update your Pavlov server:

<pre>
cat << 'EOF' > $HOME/pavlov_daily_update_and_restart.sh
#!/bin/bash

USER="steam"
SERVICENAME="pavlovserver.service"
INSTALLDIRNAME="pavlovserver"
USERHOME="/home/$USER"

echo -e "Beginning Pavlov VR update run on $(date)\n\n"

systemctl stop "$SERVICENAME"

sleep 5
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +force_install_dir "$USERHOME/$INSTALLDIRNAME" +app_update 622970 +exit
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +app_update 1007 +quit
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/.steam/sdk64/steamclient.so"
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/pavlovserver/Pavlov/Binaries/Linux/steamclient.so"

systemctl start "$SERVICENAME"

echo -e "Ending Pavlov VR update run on $(date)\n\n"

EOF

chmod +x $HOME/pavlov_daily_update_and_restart.sh
mkdir $HOME/pavlov_update_logs && touch $HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log
CRONLINE="00 2 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
(sudo crontab -u root -l; echo "$CRONLINE" ) | sudo crontab -u root -
unset CRONLINE

</pre>

These commands will:

1. Create a shell script in the "steam" user's home directory that automatically stops the Pavlov server, pulls any updates via steam, pull updates to the Steamworks SDK Redist, and copies the latest version of steamclient.so to the Pavlov server directory

2. Make the shell script executable

3. Create a new directory called "pavlov_update_logs" in the "steam" user's directory, and create a logfile inside that directory called "pavlov_daily_update_and_restart.sh.log". You can check this logfile to see the output of the Pavlov and Steam SDK update commands.

4. Create a crontab entry for the root user that runs this shell script automatically every day at 2:00AM local time

If you want to change the time that this script runs, edit the numbers "00 2" in the line that starts with "CRONLINE=". In the example provided, 00 is the minutes column, and 2 is the hour column. For example, if you wanted the server to automatically update and restart at 4:17AM every day, change the line starting with "CRONLINE=" to:

<pre>
CRONLINE="17 4 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
</pre>

If the time is PM, use 24-hour time format, e.g. "32 18" for 6:32PM.
<hr>
=== '''Save Logs for records and stats''' ===
this is a automated script that will on a timer save all the backups made by the server before they are purged by the game for admin records and starts collection

https://github.com/JTWP-org/backUpLogs2
<hr>

=== '''Sharing Bans over gameserver on same machine''' ===
when u have a lot of servers keeping the bans synced can be a nightmare so using a symbolic link allows all the servers to use one file

for this lets say i have pavlovserver000 and pavlovserver001 and they are located at /home/steam/pavlovserver000 and /home/steam/pavlovserver001

''step 1 will be to pick a blacklist to use as the new one and move it to a central location''
mkdir ~/shared ; mv /home/steam/pavlovserver000/Pavlov/Saved/Config/blacklist.txt ~/shared/blacklist.txt ; rm /home/steam/pavlovserver001/Pavlov/Saved/Config/blacklist.txt
now we have moved the blacklist from pavlovserver000 to a folder in our home called shared and then we removed the blacklist from pavlovserver001

step 2 making the links
ln -s ~/shared/blacklist.txt /home/steam/pavlovserver000/Pavlov/Saved/Config/blacklist.txt ; ln -s ~/shared/blacklist.txt /home/steam/pavlovserver001/Pavlov/Saved/Config/blacklist.txt
now editing them in pavlovserver001's files will update the list for all of the servers its not a sync its using the same list if u want to check where a link is pointed if u
ls -l
it will show where the file is really located

<hr>

Setting up a dedicated server

2023-07-17T17:08:51Z

SaltedCrackerJack: /* Save Logs for records and stats */

== Setting up a dedicated server ==

'''There are no Windows binaries'''

This guide is written exclusively for Linux and covers Ubuntu/Debian/Debian-like and Red Hat RPM-based distros. Possible to run with other distros, but some of the commands won't work and you will need to know enough to figure out the software install of dependencies on your own.

If you are considering hosting from home, please read that section of the wiki first.

This guide assumes you know the basics of using a bash terminal: ssh'ing into a server, running bash commands, editing text files, etc.

If you have no experience using bash, maybe start [https://www.howtogeek.com/140679/beginner-geek-how-to-start-using-the-linux-terminal/ here]. Editing text files via commandline is often a challenge. Suggest using nano and reading guide [https://www.howtogeek.com/howto/42980/the-beginners-guide-to-nano-the-linux-command-line-text-editor/ here]

If you are new to linux and accessing your server from Windows, highly suggest using MobaXterm as your SSH client as that can make required editing of text files easier using built in editor instead of the native linux command line editors.

And finally, ask yourself why you want to setup a server? If you look at the list, there are many, many more servers than players. If you don't have a team, discord community, or group of friends ready to play on your server, chances are it will go unused. Got one of these... great, let's go.

If you don't want to go through the hassle yourself and want to pay for a hosting service Arctic VR (PC and Shack) and Horde (Shack) provide a server hosting services and are trusted in the community. See links below.

----

=== Server Requirements ===

'''Pavlovserver can only be hosted under Linux.'''

This can be running as a VM under windows, but this will increase the complexity of the setup beyond this guide.

Ubuntu 18.04 x86_64, Ubuntu 19/04 amd64, Ubuntu 20.04, and Rocky Linux 8 are confirmed working. Ubuntu 15.04 x86 is known to fail to install using this guide. Recommend not running on "minimal" images as some tools are missing.

* 2GB RAM + 1GB RAM per each additional server with 10 players. More RAM is recommended for larger maps, higher player counts, or complex gamemodes. Not having enough RAM is a common cause of server crashes.

* A ~2.5Ghz CPU will comfortably support a 10 player server.

* A ~4Ghz CPU will comfortably support 24 players. This is a limit built into Pavlov itself, no server will allow players to join over 24. Lower player counts are recommended for complex gamemodes (E.g. CodZ) and/or highly detailed maps, so that maximum number will often be lower.

(Note that these are '''not''' hard limits for player counts, just suggestions for the best performance, based on experiences with many server providers on different grades of hardware.)

* Pavlovserver is functionally single threaded (one thread does vast majority of work). More CPUs only help if you are running more servers. More clockspeed = higher performance = more users per server.
The maximum number of servers you can run is dependent on how many CPUs you have. For example, if you have an 8 core CPU, the maximum number of servers would be 7. You should always have at least one CPU free as overhead, as Pavlov servers can use slightly more than one thread.

----

==== Hosting at home ====
When hosting at home there are additional requirements regarding networking: Your router has to support port-forwarding, hair-pinning/LoopbackNAT, and respond to ping requests. These techniques are necessary to allow your server to be found and to talk back to the client. please see https://en.wikipedia.org/wiki/Port_forwarding, https://en.wikipedia.org/wiki/Hairpinning, and https://www.speedguide.net/faq/how-to-become-pingable-behind-a-routerfirewall-376 for more info and google for these terms in addition to your router model to find guides on how to enable/configure it properly. If you have modern Router, it may have these features already enabled, in this case you just have to configure port-forwarding. If you can see your server but not join it while others can, this is indicative of a failure of LoopbackNAT.

A second challenge to hosting at home is CGNAT (Carrier grade NAT: https://www.a10networks.com/blog/carrier-grade-nat/). Just like NAT on your home network that has to be gotten around w/ port-forwarding, CGNAT breaks the ability of external connections to be made back to your server, but the controls are solely in your ISPs hands. Sometimes if you ask, you can be removed from CGNAT pools and/or assigned a static IP. CGNAT rollouts are becoming very common now, so if your server worked then doesn't allow connections now, your ISP may have made this change.

You can check whether you’re on a CGNAT network by visiting a Web site such as ipaddress.com or whatsmyip.com and comparing the IP address listed to the public/WAN IP address assigned to your Internet gateway. To find your gateway’s public IP address, check the status page in the administrative interface. If the two IP addresses differ, you’re likely on a CGNAT network. If so, this problem must be resolved before you go any further.

'''Not understanding these requirements and configuration is a frequent cause of failed setups and questions in discord. Don't skip this if you are trying to host from home'''

'''There are serious security implications of hosting this software at home.''' None of the devs are security experts and there has been no security review of the code. You are opening up your system to the world and publicity advertising this fact. Expect that any system hosting this software is open to compromise from the Internet and act accordingly. If your router offers a DMZ network, use it. Consider hosting on a cloud based server and think twice before running this software on any system that contains data you care about or has access to networks and computers you care about.

If you're hosting at home using Oracle's VirtualBox, there are steps you can take to prevent double NAT (which can cause issues later on)

1. Select your VM and then click Settings in VirtualBox's main window.

2. Click on Network and change Attached To from NAT to Bridged Adapter.

Once you've done this, your VM should be connected directly to your home router and double NAT should no longer be a issue.

----

==== Starting Server Install ====

====Obtaining an ApiKey====
For your server to show up in the server list, there is now a requirement to have an ApiKey issued by vankrupt. This is to prevent DOS attacks against the master server

Get the key by going here: https://pavlov-ms.vankrupt.com/servers/v1/key and using your mobile number to get a SMS
(note that there have been reported failures of this SMS system for non-US mobiles. In this case DM davevillz your mobile and ask for a key)

Put this key in your Game.ini as follows:
ApiKey="ABC123FALSEKEYDONTUSEME"
or if you would like (personally untested..I would use game.ini) you can call it at server runtime with flag as follows:
-KEY="ABC123FALSEKEYDONTUSEME"

This key can be re-used for a reasonable number of servers (a limit of 10 has been mentioned). Contact the Devs if you need more servers per key.

====System setup and software installation====

Install dependencies and create the `steam` user. (You only need to do this once):

Confirm Linux version
<pre>
lsb_release -a
</pre>

'''Ubuntu 20.04'''
'''''sudo apt update''''' && '''''sudo apt install''''' -y gdb curl lib32gcc1 libc++-dev unzip
sudo useradd -m steam
'''Ubuntu 20.10 or higher'''
sudo apt update && sudo apt install -y gdb curl lib32gcc-s1 libc++-dev unzip
sudo useradd -m steam
'''Rocky Linux, CentOS 8, and RHEL 8'''
sudo sed -i 's/^SELINUX=enforcing$/SELINUX=permissive/g' /etc/selinux/config
sudo setenforce 0
sudo yum install gdb curl glibc.i686 libstdc++.i686 libstdc++-devel.i686 libstdc++-devel.x86_64 unzip wget -y
wget <nowiki>https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/l/libcxx-3.8.0-3.el7.x86_64.rpm</nowiki>
sudo rpm -i libcxx-3.8.0-3.el7.x86_64.rpm
sudo useradd -m steam
[Optional] Set a password for steam.
<pre>sudo passwd steam</pre>

Login as the steam user. ('''You will need to do this each time you connect to your server'''):

<pre>
sudo su -l steam
</pre>

Install Steam:

<pre>
mkdir ~/Steam && cd ~/Steam && curl -sqL "https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz" | tar zxvf -
</pre>

There are different dedicated server versions for Pavlov Server - choose which server version you want to host (PC non-beta, PC Beta, Shack Live, or Shack RC)
(You will need to run this command each time there is a Pavlov Server update).

 
To host '''PC Server (non-beta)''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta default +exit
</pre>

To host '''PC BETA''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta beta_server +exit
</pre>

To host '''Shack Live''' (Quest):

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack +exit
</pre>

To host '''Shack RC''' (Quest): 

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack_beta +exit
</pre>

Now that we've installed the server, all pavlov server versions should continue. 
Install a fresh copy of steamclient.so (May have to do this after each update):
<pre>
~/Steam/steamcmd.sh +login anonymous +app_update 1007 +quit
mkdir -p ~/.steam/sdk64
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/pavlovserver/Pavlov/Binaries/Linux/steamclient.so
</pre>

The update 29 of the PCVR version of pavlov and after added a requirement to run these commands to change the steamclient.so:
<code>sudo rm /usr/lib/x86_64-linux-gnu/libc++.so</code>
<code>sudo ln -s /usr/lib/x86_64-linux-gnu/libc++.so.1 /usr/lib/x86_64-linux-gnu/libc++.so</code>

Make the PavlovServer script executable. (You only need to do this once):

<pre>
chmod +x ~/pavlovserver/PavlovServer.sh
</pre>

----

=== Server Configuration ===

Before starting the server we need to configure it. Start by creating some directories:

<pre>
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Logs
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps
</pre>

==== Mods/Blacklist/Whitelist (optional) ====

The following three files allow you to specify mods, banned players, and whitelist players. These are optional, but go ahead and create them. Populating the files is described later.

<pre>
touch /home/steam/pavlovserver/Pavlov/Saved/Config/mods.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/blacklist.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/whitelist.txt
</pre>

====Configuring Game.ini====
Create a new Game.ini file using following command to open an editor and copy/paste the following block into it then save it. Note not all of these options are required. For instance remove or comment out the Password=0000 line to make a public server with no pin.
<pre>
nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini
</pre>

<pre>
[/Script/Pavlov.DedicatedServer]
bEnabled=true
ServerName="My_private_idaho"
MaxPlayers=10 #Set this to 10 for Shack. 24 is the max for PC, setting it higher will not allow players to join.
ApiKey="ABC123FALSEKEYDONTUSEME"
bSecured=true
bCustomServer=true
bVerboseLogging=false
bCompetitive=false #This only works for SND
bWhitelist=false
RefreshListTime=120
LimitedAmmoType=0
TickRate=90
TimeLimit=60
#Password=0000
#BalanceTableURL="vankruptgames/BalancingTable/main"
MapRotation=(MapId="UGC1758245796", GameMode="GUN")
MapRotation=(MapId="datacenter", GameMode="SND")
MapRotation=(MapId="sand", GameMode="DM")

</pre>

* '''bEnabled''' - whether the server appears in the server list (unconfirmed)
* '''ServerName''' - name it will be listed as. (approx 35 chars max)
* '''MaxPlayers''' - See suggested specs for limits. 10 standard (10 for shack), 20-24 is max recommended for large maps like Stalingrad or PUSH/RUSH modes, and servers allow a maximum of 24 players.
* '''ApiKey''' - Unique ApiKey required to register server with master server. Replace with your key
* '''bSecured''' - enabled Valve Anti-Cheat (VAC)
* '''bCustomServer''' - activates some new modding tools (save and http functions. Required to write to blacklist.txt for bans)
* '''bCompetitive''' - sets the server to competitive mode for SND. If removed the server will default to false
* '''bVerboseLogging''' - enables verbose logging, mostly detailed statistics. Be prepared for significant increase in logging.
* '''bWhitelist''' - Only allow users in whitelist.txt to join
* '''RefreshListTime''' - sets how often the running server checks for updates in ban/whitelist/mod files
* '''LimitedAmmoType''' - sets limited ammo mode, see Limited Ammo Types table below

* '''TimeLimit''' - sets time limit for each map
* '''TickRate''' - sets the server tickrate. (so far minimum stable seems around 50 and max around 120. Beware setting this changes weapon despawn time and breaks some game modes. Recommend not touching)
* '''Password''' - PIN number for server #FYI - this is now also changeable via rcon.
* '''BalanceTableURL''' - Points to a custom balance table from github. See https://github.com/vankruptgames/BalancingTable for instructions. This line isn't needed if you don't have one.
* '''MapRotation''' - you can add multiple of these. The map system has switched from the steam workshop to modio which means that the server rotation will need to be redone with modio UGCs. <nowiki>https://mod.io/g/pavlov</nowiki>. This is done by taking the resource ID from the modio page, adding “UGC” in front of it and then adding that to the rotation. For example the map gravity <nowiki>https://mod.io/g/pavlov/m/gravity1</nowiki> has a resource ID of 2773760 so the map ID to add to the server would be “UGC2773760”. When a match ends, the server will load the next map in the rotation.
* '''AFKTimeLimit''' There is now a feature to kick players who are idle in the game. Integers are measured in seconds and 0 disables AFK kicking completely.

Available game modes as of 09/06/2022: See Game modes table below

For maps running a Custom gamemode (CodZ, BR, Duel, etc.) it doesn't matter which gamemode you choose, as the map will automatically override it with the custom mode.

{| class="wikitable"
|+Limited Ammo Types
!AmmoType
!Name
!Description
|-
|0
|Unlimited
|Players have unlimited ammo, carry no ammo boxes and do not display an ammo count on the wrist.
|-
|1
|Limited Generic
|Players carry ammo boxes with a limited amount of ammo.
One box for each weapon class (Pistol, Submachine gun, Rifles/MGs, Shotgun, Sniper).

Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.

An ammo count is displayed on the wrist.
|-
|2
|Limited Specific
|Players carry ammo boxes with a limited amount of ammo.
One box for each weapon.

Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.

An ammo count is displayed on the wrist.
|-
|3
|Custom
|Allows for full control over ammo by the map.
|-
|4
| Limited Special
|'''All weapons except "special" weapons are unlimited, more clarification is needed.'''
|-
|5
|Boxless
|'''Like limited generic but without boxes? Clarification is needed.'''
|}
{| class="wikitable"
|+Game modes
!GameMode
!Name
|-
|DM
|Death match
|-
|KOTH
|King of the hill
|-
|GUN
| Gun game
|-
|OITC
| One in the chamber
|-
|SND
|Search and destroy
|-
|TANKTDM
|WW2 Team Death Match
|-
| TDM
|Team Death Match
|-
|TTT
|Trouble in Terrorist Town
|-
|WW2GUN
|WW2 gun game
|-
|ZWV
| Zombie wave survival
|-
|HIDE
|The Hidden
|-
|INFECTION
|Hidden infection
|-
|PUSH
|Push
|-
|PH
|Prop hunt
|}
= Default Map ID's =
datacenter

sand

bridge

containeryard

siberia (Prison Break)

hospital (Zombies map)

killhouse

range

tutorial

santorini

station

industry

ogcontainers (Shack only)

haguenau (Shack only)

foundation (Shack only)

stalingrad (PC only)

stalingrad_night (PC only)

santorini_night (PC only)

sand_night (PC only)

station_night (PC only)

industry_night (PC only)

bunker (PC only)

==== Firewall/Port forwarding ====
Using the default settings there are two UDP ports (7777, 8177) that need to be allowed to access the server either by firewall setup or port forwarding.

'''Ubuntu''' firewall commands to check firewall and open ports:
<pre>
sudo ufw status
sudo ufw allow 7777
sudo ufw allow 8177
sudo ufw allow 9100
sudo ufw status
</pre>

'''Rocky Linux''' firewall commands to check firewall and open ports:
<pre>
sudo firewall-cmd --zone=public --add-port=7777/tcp
sudo firewall-cmd --zone=public --add-port=7777/udp
sudo firewall-cmd --zone=public --add-port=8177/tcp
sudo firewall-cmd --zone=public --add-port=8177/udp
sudo firewall-cmd --zone=public --add-port=9100/udp
sudo firewall-cmd --zone=public --add-port=9100/tcp
sudo firewall-cmd --list-ports
firewall-cmd --runtime-to-permanent
</pre>

You may also need to allow Pings (ICMP) for the server's true latency to appear in the master list.

If you are running multiple servers and have set additional ports (see http://wiki.pavlov-vr.com/index.php?title=Dedicated_server#Running_multiple_servers_on_one_host) then you need to allow access to the defined port plus the port 400 higher. So if you use 7000 as your port, then UDP 7000 and 7400 need to be open

If you have setup rcon via RconSettings.txt (below) then that port also need to be allowed access via TCP

If you are running Shack/Quest and want to have maps that are downloadable from your server, your server ports (ex. 7777 & 8177) must also be open via TCP

----

==== Shack Maps (Quest) ====

If you try to use the steps above to add maps for Shack, youll run into issues very quickly. This is because Shack has no affiliation to Steam, and therefore cannot use Steam Workshop maps like above. In the future, these steps will apply to PC servers as well, allowing a server to hold the map itself, instead of offloading to Steam.

To get started, first create the directory to hold the maps

<pre>mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps</pre>

You can use any number of methods to move the map files onto the server, but ill go over the two simplest, starting with a GUI approach

Download and install CyberDuck onto your "home" PC (Whatever PC you use for access to the server, but not the server itsself): https://cyberduck.io/

Next, download and unzip your map of choice from https://www.pavlovquest.com/ , https://pavlovhorde.com/mapsList, or look in #shack-map-showcase channel in the discord server. I'm going to use Cheeto's WW2 Items test (http://www.mediafire.com/file/emyt9bs1z9u9ykw/SVR_Cheeto_Items.zip/file ) for this example, you do what you like

In the top left corner, open a connection, set the connection type to SFTP, and fill in the rest of the information. User will be root, password is whatever you set the root pw as (toor in Ubuntu by default)

In the directory dropdown (itll say /root) go back to /

Follow the directories until we arrive back at our "maps" folder <pre>/home/steam/pavlovserver/Pavlov/Saved/maps</pre>

Drag and drop the unzipped map folder into the main window, in this case itll be SVR_Cheeto_Items

Hit Allow

Youll now see a folder named SVR_Cheeto_Items, and within it should be nothing but 3 files. If there is another folder in it, move this folder to the maps directory, otherwise the server wont work. The 3 files (2 .PAK one .JSON) should be in home/steam/pavlovserver/Pavlov/Saved/maps/SVR_Cheeto_Items, no more, no less.

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

To play the map, you can either use RCON switch map command, or to add the map to your servers automatic map rotation list, add the map's folder name to your Game.ini. This replaces the MapID section, so for our example it would be

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

And thats all! Disconnect CyberDuck from your server before playing, otherwise youll have difficulty joining.

-----------

==== Adding Shack Maps over Command Line Interface ====

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

A bit more complicated, but adding maps over CLI has its benefits

First, CD to the maps directory you made above

<pre>cd ~/pavlovserver/Pavlov/Saved/maps</pre>

Download the map files from whatever you use to upload them. To do this, you can either use curl or wget

<pre>curl -O insertURLhere</pre>

'''If you download your map from Google Drive''', make sure that your .zip folder is shared to anyone.
Then, get the file's url from the shared link. Example : ''<nowiki>https://drive.google.com/file/d/19bI8gUHaN5tUrDvnadAacUnchQf6_k/view</nowiki>'' will be ''19bI8gUHaN5tUrDvnadAacUnchQf6_k''
Edit "fileId" and "fileName" before you execute the command.
<pre>
fileId=19bI8gUHaN5tUrDvnadAacUnchQf6_k
fileName=SVR_USER_MAPNAME
curl -sc /tmp/cookie "https://drive.google.com/uc?export=download&id=${fileId}" > /dev/null
code="$(awk '/_warning_/ {print $NF}' /tmp/cookie)"
curl -Lb /tmp/cookie "https://drive.google.com/uc?export=download&confirm=${code}&id=${fileId}" -o ${fileName} </pre>

To keep with the Items example:

<pre>curl -O https://cdn.discordapp.com/attachments/744185280759857234/745027406695366788/SVR_Cheeto_Items.zip</pre>

Next, unzip the file. If this next step errors out, saying the command is unknown, switch back to the root user (su root), and install unzip (sudo apt install unzip), then return to the steam user, and continue.

<pre>unzip SVR_Cheeto_Items.zip</pre>

Now finish like before by adding the map to your Game.ini

<pre>nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini</pre>

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

==== Admin/Moderator list (optional) ====

The only working in-game admin menu is through Arctic VR server hosting (see below).

If you add moderators to your server, they will not be subject to vote kicks.

<pre>
nano ~/pavlovserver/Pavlov/Saved/Config/mods.txt
</pre>

Example Mod List:
<pre>
76541198397498572 #Optional Comment: Player name
76541198397498573 #Some Other Player
</pre>

==== ArcticVR Admin Menu ====

[[File:Arcticmenu.jpg|500px|link=https://www.arctic-vr.com/server-admin-menu]]

Arctic-VR Offers an advanced In-Game Admin menu that is exclusive to their hosting service. Features include:
* Switch Maps+Modes
* Teleport Players to Players
* Change Player Skins
* Control Player Buying+Cash
* Spawn Items
* Clean up corpses + guns
* Spawn Bots
* Spawn Items for other players
* Control Teams + Balance/Shuffle Teams
* ResetSND
* And More

You can read more about the ArcticVR admin menu on their website: https://www.arctic-vr.com/server-admin-menu

==== Handy tools for finding steamIDs ====

Steam ID finder: https://steamidfinder.com/lookup/ or https://steamid.xyz/

You want to enter in the steamID64 format.

This tool can convert or lookup IDs: https://steamid.io/

If you are looking for a steamID of a player that has been on your server recently this is technique to find them:
<pre>
grep -i playername ~/pavlovserver/Pavlov/Saved/Logs/* | grep TicketValidation
</pre>

=== Configure Rcon ===
To enable Rcon access create config file:
<pre> nano /home/steam/pavlovserver/Pavlov/Saved/Config/RconSettings.txt </pre>

Copy in the following text - change password, and if desired the port:
<pre>
Password=ChangeThisPassword
Port=9100
</pre>
You must specify a port for the Rcon server to use as well as a Password (use a different port per sever instance if running multiple server instances off the same hardware)

=== Starting the server ===

<pre>
cd ~/pavlovserver && ./PavlovServer.sh
</pre>

That's it, your server will be automatically broadcast to the master server! :)

Two handy tools to determine quickly if your server is broadcasting are [https://pablub.xyz/ Pablub] (PC only) and [https://pavlovhorde.com/ Horde] (Shack) and [https://pavlovhorde.com/pcServers Horde] (PC version)

Note that when you close your terminal, the server will go down. See the "supervisors" section below for how to prevent this.

----

=== Supervising the server using systemd ===

Running '''./PavlovServer.sh''' in your interactive shell is easy, but the server will shut down when you close your terminal. If you want to run the server in the background,
you'll want to run it under a supervisor. There are many options, ranging from the simple (nohup, screen or tmux), to the
more robust (supervisord, systemd).

Systemd is running by default on Ubuntu Linux, so we'll use that here.

To run the server as a systemd service, create the file '''/etc/systemd/system/pavlovserver.service''' (as root) by typing
<pre>
sudo nano /etc/systemd/system/pavlovserver.service
</pre>

Copy contents below into the file and save.

<pre>
[Unit]
Description=Pavlov VR dedicated server

[Service]
Type=simple
WorkingDirectory=/home/steam/pavlovserver
ExecStart=/home/steam/pavlovserver/PavlovServer.sh

RestartSec=1
Restart=always
User=steam
Group=steam

[Install]
WantedBy = multi-user.target
</pre>

If you'd like your server to start as competitive without editing the game.ini, change the line "ExecStart=/home/steam/pavlovserver/PavlovServer.sh" to look like this below. Though it's much easier to just use the game.ini to enable competitive instead. <pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -COMPETITIVE=1</pre>

Change the user or paths as appropriate. After saving the service file, to start, restart, stop, or monitor the server:

<pre>
sudo systemctl start pavlovserver
sudo systemctl restart pavlovserver
sudo systemctl stop pavlovserver
sudo systemctl status pavlovserver
</pre>

To view the logs:

<pre>
sudo journalctl -u pavlovserver
# to live-tail the logs
sudo journalctl -u pavlovserver -f
</pre>

If you want to run the pavlov server as soon as your server boots (e.g. a VPS you turn on and off), add pavlov as a startup service:

<pre>
sudo systemctl enable pavlovserver
</pre>

----

== Advanced Server Administration ==

=== Running multiple servers on one host ===

* Pavlovserver is functionally single threaded (there are multiple threads, but vast majority of work occurs in the primary one). Make sure you have # of pavlovservers + 1 CPU available. More CPUs= more servers. Faster CPU = more players.
* Make multiple server installs by defining a separate install dir for each server.
* Run each server with a unique port. eg: '''./PavlovServer.sh -PORT="Desired Port"'''
* The Server will use the Desired Port and the Port 400 above (Example: You choose 8200 as Port. So Port 8600 will be used as well)
* If you are using RCON, each server will need a unique port defined in RconSettings.txt
* Ensure the ports are forwarded and opened in your firewall

To duplicate directories:

be in the steam home folder
<pre>
cp -r pavlovserver pavlovserver1
/home/steam/pavlovserver1/PavlovServer.sh -PORT=[Desired Port]
</pre>

=== Starting server in competitive mode ===
Competitive mode will prevent dead teammates from being able to see the match, to prevent ghosting.
You can either enable this via Game.ini (described in Game.ini file), or using the -COMPETITIVE=1 parameter.

<pre>
/home/steam/pavlovserver1/PavlovServer.sh -COMPETITIVE=1
</pre>

{| class="wikitable"

|}

=== Useful Linux Commands ===
List files / folders in directory, print current working directory,
<pre>ls -la #list files/directories along with authorities and ownership
pwd #print working directory
sudo chown <owner> <file/directory> #change owner of file/directory. If root created something and you need to change it to steam
sudo chgrp <group> <file/directory> #change group of file/directory.
</pre>

Check if pavlov is running by checking process status. If the only row you see is the grep command, pavlov server is not started.
<pre> ps -ef | grep pav </pre>

Sample output:
<pre>
steam 34044 1 0 16:52 ? 00:00:00 /bin/sh /home/steam/pavlovserver/PavlovServer.sh
steam 34066 34044 80 16:52 ? 00:00:04 /home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer
zombies+ 34101 34013 0 16:52 pts/0 00:00:00 grep --color=auto pav
</pre>

Kill a process. Note this command uses 34044, which is a process id from the command output above.
<pre> kill -9 34044 </pre>

Dump the log to the console so you can scroll through it:
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log </pre>

Search the log for a string - replace my_string with case-sensitive string
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep my_string </pre>

<hr>

== Advanced Scripts For Server Management ==
<hr>

=== '''Auto-updating the server''' ===
Assuming you have followed this guide and used the default paths, users, and install instructions, you can paste the following into your terminal to auto-update your Pavlov server:

<pre>
cat << 'EOF' > $HOME/pavlov_daily_update_and_restart.sh
#!/bin/bash

USER="steam"
SERVICENAME="pavlovserver.service"
INSTALLDIRNAME="pavlovserver"
USERHOME="/home/$USER"

echo -e "Beginning Pavlov VR update run on $(date)\n\n"

systemctl stop "$SERVICENAME"

sleep 5
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +force_install_dir "$USERHOME/$INSTALLDIRNAME" +app_update 622970 +exit
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +app_update 1007 +quit
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/.steam/sdk64/steamclient.so"
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/pavlovserver/Pavlov/Binaries/Linux/steamclient.so"

systemctl start "$SERVICENAME"

echo -e "Ending Pavlov VR update run on $(date)\n\n"

EOF

chmod +x $HOME/pavlov_daily_update_and_restart.sh
mkdir $HOME/pavlov_update_logs && touch $HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log
CRONLINE="00 2 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
(sudo crontab -u root -l; echo "$CRONLINE" ) | sudo crontab -u root -
unset CRONLINE

</pre>

These commands will:

1. Create a shell script in the "steam" user's home directory that automatically stops the Pavlov server, pulls any updates via steam, pull updates to the Steamworks SDK Redist, and copies the latest version of steamclient.so to the Pavlov server directory

2. Make the shell script executable

3. Create a new directory called "pavlov_update_logs" in the "steam" user's directory, and create a logfile inside that directory called "pavlov_daily_update_and_restart.sh.log". You can check this logfile to see the output of the Pavlov and Steam SDK update commands.

4. Create a crontab entry for the root user that runs this shell script automatically every day at 2:00AM local time

If you want to change the time that this script runs, edit the numbers "00 2" in the line that starts with "CRONLINE=". In the example provided, 00 is the minutes column, and 2 is the hour column. For example, if you wanted the server to automatically update and restart at 4:17AM every day, change the line starting with "CRONLINE=" to:

<pre>
CRONLINE="17 4 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
</pre>

If the time is PM, use 24-hour time format, e.g. "32 18" for 6:32PM.
<hr>
=== '''Save Logs for records and stats''' ===
this is a automated script that will on a timer save all the backups made by the server before they are purged by the game for admin records and starts collection

https://github.com/JTWP-org/backUpLogs2
<hr>

=== '''Sharing Bans over gameserver on same machine''' ===
when u have a lot of servers keeping the bans synced can be a nightmare so using a symbolic link allows all the servers to use one file

for this lets say i have pavlovserver000 and pavlovserver001 and they are located at /home/steam/pavlovserver000 and /home/steam/pavlovserver001

''step 1 will be to pick a blacklist to use as the new one and move it to a central location''
mkdir ~/shared ; mv /home/steam/pavlovserver000/Pavlov/Saved/Config/blacklist.txt ~/shared/blacklist.txt ; rm /home/steam/pavlovserver001/Pavlov/Saved/Config/blacklist.txt
now we have moved the blacklist from pavlovserver000 to a folder in our home called shared and then we removed the blacklist from pavlovserver001

step 2 making the links
ln -s ~/shared/blacklist.txt /home/steam/pavlovserver000/Pavlov/Saved/Config/blacklist.txt ; ln -s ~/shared/blacklist.txt /home/steam/pavlovserver001/Pavlov/Saved/Config/blacklist.txt
now editing them in pavlovserver001's files will update the list for all of the servers its not a sync its using the same list if u want to check where a link is pointed if u
ls -l
it will show where the file is really located

<hr>

Setting up a dedicated server

2023-07-17T16:57:22Z

SaltedCrackerJack: /* Advanced Scripts For Server Management */

== Setting up a dedicated server ==

'''There are no Windows binaries'''

This guide is written exclusively for Linux and covers Ubuntu/Debian/Debian-like and Red Hat RPM-based distros. Possible to run with other distros, but some of the commands won't work and you will need to know enough to figure out the software install of dependencies on your own.

If you are considering hosting from home, please read that section of the wiki first.

This guide assumes you know the basics of using a bash terminal: ssh'ing into a server, running bash commands, editing text files, etc.

If you have no experience using bash, maybe start [https://www.howtogeek.com/140679/beginner-geek-how-to-start-using-the-linux-terminal/ here]. Editing text files via commandline is often a challenge. Suggest using nano and reading guide [https://www.howtogeek.com/howto/42980/the-beginners-guide-to-nano-the-linux-command-line-text-editor/ here]

If you are new to linux and accessing your server from Windows, highly suggest using MobaXterm as your SSH client as that can make required editing of text files easier using built in editor instead of the native linux command line editors.

And finally, ask yourself why you want to setup a server? If you look at the list, there are many, many more servers than players. If you don't have a team, discord community, or group of friends ready to play on your server, chances are it will go unused. Got one of these... great, let's go.

If you don't want to go through the hassle yourself and want to pay for a hosting service Arctic VR (PC and Shack) and Horde (Shack) provide a server hosting services and are trusted in the community. See links below.

----

=== Server Requirements ===

'''Pavlovserver can only be hosted under Linux.'''

This can be running as a VM under windows, but this will increase the complexity of the setup beyond this guide.

Ubuntu 18.04 x86_64, Ubuntu 19/04 amd64, Ubuntu 20.04, and Rocky Linux 8 are confirmed working. Ubuntu 15.04 x86 is known to fail to install using this guide. Recommend not running on "minimal" images as some tools are missing.

* 2GB RAM + 1GB RAM per each additional server with 10 players. More RAM is recommended for larger maps, higher player counts, or complex gamemodes. Not having enough RAM is a common cause of server crashes.

* A ~2.5Ghz CPU will comfortably support a 10 player server.

* A ~4Ghz CPU will comfortably support 24 players. This is a limit built into Pavlov itself, no server will allow players to join over 24. Lower player counts are recommended for complex gamemodes (E.g. CodZ) and/or highly detailed maps, so that maximum number will often be lower.

(Note that these are '''not''' hard limits for player counts, just suggestions for the best performance, based on experiences with many server providers on different grades of hardware.)

* Pavlovserver is functionally single threaded (one thread does vast majority of work). More CPUs only help if you are running more servers. More clockspeed = higher performance = more users per server.
The maximum number of servers you can run is dependent on how many CPUs you have. For example, if you have an 8 core CPU, the maximum number of servers would be 7. You should always have at least one CPU free as overhead, as Pavlov servers can use slightly more than one thread.

----

==== Hosting at home ====
When hosting at home there are additional requirements regarding networking: Your router has to support port-forwarding, hair-pinning/LoopbackNAT, and respond to ping requests. These techniques are necessary to allow your server to be found and to talk back to the client. please see https://en.wikipedia.org/wiki/Port_forwarding, https://en.wikipedia.org/wiki/Hairpinning, and https://www.speedguide.net/faq/how-to-become-pingable-behind-a-routerfirewall-376 for more info and google for these terms in addition to your router model to find guides on how to enable/configure it properly. If you have modern Router, it may have these features already enabled, in this case you just have to configure port-forwarding. If you can see your server but not join it while others can, this is indicative of a failure of LoopbackNAT.

A second challenge to hosting at home is CGNAT (Carrier grade NAT: https://www.a10networks.com/blog/carrier-grade-nat/). Just like NAT on your home network that has to be gotten around w/ port-forwarding, CGNAT breaks the ability of external connections to be made back to your server, but the controls are solely in your ISPs hands. Sometimes if you ask, you can be removed from CGNAT pools and/or assigned a static IP. CGNAT rollouts are becoming very common now, so if your server worked then doesn't allow connections now, your ISP may have made this change.

You can check whether you’re on a CGNAT network by visiting a Web site such as ipaddress.com or whatsmyip.com and comparing the IP address listed to the public/WAN IP address assigned to your Internet gateway. To find your gateway’s public IP address, check the status page in the administrative interface. If the two IP addresses differ, you’re likely on a CGNAT network. If so, this problem must be resolved before you go any further.

'''Not understanding these requirements and configuration is a frequent cause of failed setups and questions in discord. Don't skip this if you are trying to host from home'''

'''There are serious security implications of hosting this software at home.''' None of the devs are security experts and there has been no security review of the code. You are opening up your system to the world and publicity advertising this fact. Expect that any system hosting this software is open to compromise from the Internet and act accordingly. If your router offers a DMZ network, use it. Consider hosting on a cloud based server and think twice before running this software on any system that contains data you care about or has access to networks and computers you care about.

If you're hosting at home using Oracle's VirtualBox, there are steps you can take to prevent double NAT (which can cause issues later on)

1. Select your VM and then click Settings in VirtualBox's main window.

2. Click on Network and change Attached To from NAT to Bridged Adapter.

Once you've done this, your VM should be connected directly to your home router and double NAT should no longer be a issue.

----

==== Starting Server Install ====

====Obtaining an ApiKey====
For your server to show up in the server list, there is now a requirement to have an ApiKey issued by vankrupt. This is to prevent DOS attacks against the master server

Get the key by going here: https://pavlov-ms.vankrupt.com/servers/v1/key and using your mobile number to get a SMS
(note that there have been reported failures of this SMS system for non-US mobiles. In this case DM davevillz your mobile and ask for a key)

Put this key in your Game.ini as follows:
ApiKey="ABC123FALSEKEYDONTUSEME"
or if you would like (personally untested..I would use game.ini) you can call it at server runtime with flag as follows:
-KEY="ABC123FALSEKEYDONTUSEME"

This key can be re-used for a reasonable number of servers (a limit of 10 has been mentioned). Contact the Devs if you need more servers per key.

====System setup and software installation====

Install dependencies and create the `steam` user. (You only need to do this once):

Confirm Linux version
<pre>
lsb_release -a
</pre>

'''Ubuntu 20.04'''
'''''sudo apt update''''' && '''''sudo apt install''''' -y gdb curl lib32gcc1 libc++-dev unzip
sudo useradd -m steam
'''Ubuntu 20.10 or higher'''
sudo apt update && sudo apt install -y gdb curl lib32gcc-s1 libc++-dev unzip
sudo useradd -m steam
'''Rocky Linux, CentOS 8, and RHEL 8'''
sudo sed -i 's/^SELINUX=enforcing$/SELINUX=permissive/g' /etc/selinux/config
sudo setenforce 0
sudo yum install gdb curl glibc.i686 libstdc++.i686 libstdc++-devel.i686 libstdc++-devel.x86_64 unzip wget -y
wget <nowiki>https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/l/libcxx-3.8.0-3.el7.x86_64.rpm</nowiki>
sudo rpm -i libcxx-3.8.0-3.el7.x86_64.rpm
sudo useradd -m steam
[Optional] Set a password for steam.
<pre>sudo passwd steam</pre>

Login as the steam user. ('''You will need to do this each time you connect to your server'''):

<pre>
sudo su -l steam
</pre>

Install Steam:

<pre>
mkdir ~/Steam && cd ~/Steam && curl -sqL "https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz" | tar zxvf -
</pre>

There are different dedicated server versions for Pavlov Server - choose which server version you want to host (PC non-beta, PC Beta, Shack Live, or Shack RC)
(You will need to run this command each time there is a Pavlov Server update).

 
To host '''PC Server (non-beta)''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta default +exit
</pre>

To host '''PC BETA''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta beta_server +exit
</pre>

To host '''Shack Live''' (Quest):

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack +exit
</pre>

To host '''Shack RC''' (Quest): 

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack_beta +exit
</pre>

Now that we've installed the server, all pavlov server versions should continue. 
Install a fresh copy of steamclient.so (May have to do this after each update):
<pre>
~/Steam/steamcmd.sh +login anonymous +app_update 1007 +quit
mkdir -p ~/.steam/sdk64
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/pavlovserver/Pavlov/Binaries/Linux/steamclient.so
</pre>

The update 29 of the PCVR version of pavlov and after added a requirement to run these commands to change the steamclient.so:
<code>sudo rm /usr/lib/x86_64-linux-gnu/libc++.so</code>
<code>sudo ln -s /usr/lib/x86_64-linux-gnu/libc++.so.1 /usr/lib/x86_64-linux-gnu/libc++.so</code>

Make the PavlovServer script executable. (You only need to do this once):

<pre>
chmod +x ~/pavlovserver/PavlovServer.sh
</pre>

----

=== Server Configuration ===

Before starting the server we need to configure it. Start by creating some directories:

<pre>
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Logs
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps
</pre>

==== Mods/Blacklist/Whitelist (optional) ====

The following three files allow you to specify mods, banned players, and whitelist players. These are optional, but go ahead and create them. Populating the files is described later.

<pre>
touch /home/steam/pavlovserver/Pavlov/Saved/Config/mods.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/blacklist.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/whitelist.txt
</pre>

====Configuring Game.ini====
Create a new Game.ini file using following command to open an editor and copy/paste the following block into it then save it. Note not all of these options are required. For instance remove or comment out the Password=0000 line to make a public server with no pin.
<pre>
nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini
</pre>

<pre>
[/Script/Pavlov.DedicatedServer]
bEnabled=true
ServerName="My_private_idaho"
MaxPlayers=10 #Set this to 10 for Shack. 24 is the max for PC, setting it higher will not allow players to join.
ApiKey="ABC123FALSEKEYDONTUSEME"
bSecured=true
bCustomServer=true
bVerboseLogging=false
bCompetitive=false #This only works for SND
bWhitelist=false
RefreshListTime=120
LimitedAmmoType=0
TickRate=90
TimeLimit=60
#Password=0000
#BalanceTableURL="vankruptgames/BalancingTable/main"
MapRotation=(MapId="UGC1758245796", GameMode="GUN")
MapRotation=(MapId="datacenter", GameMode="SND")
MapRotation=(MapId="sand", GameMode="DM")

</pre>

* '''bEnabled''' - whether the server appears in the server list (unconfirmed)
* '''ServerName''' - name it will be listed as. (approx 35 chars max)
* '''MaxPlayers''' - See suggested specs for limits. 10 standard (10 for shack), 20-24 is max recommended for large maps like Stalingrad or PUSH/RUSH modes, and servers allow a maximum of 24 players.
* '''ApiKey''' - Unique ApiKey required to register server with master server. Replace with your key
* '''bSecured''' - enabled Valve Anti-Cheat (VAC)
* '''bCustomServer''' - activates some new modding tools (save and http functions. Required to write to blacklist.txt for bans)
* '''bCompetitive''' - sets the server to competitive mode for SND. If removed the server will default to false
* '''bVerboseLogging''' - enables verbose logging, mostly detailed statistics. Be prepared for significant increase in logging.
* '''bWhitelist''' - Only allow users in whitelist.txt to join
* '''RefreshListTime''' - sets how often the running server checks for updates in ban/whitelist/mod files
* '''LimitedAmmoType''' - sets limited ammo mode, see Limited Ammo Types table below

* '''TimeLimit''' - sets time limit for each map
* '''TickRate''' - sets the server tickrate. (so far minimum stable seems around 50 and max around 120. Beware setting this changes weapon despawn time and breaks some game modes. Recommend not touching)
* '''Password''' - PIN number for server #FYI - this is now also changeable via rcon.
* '''BalanceTableURL''' - Points to a custom balance table from github. See https://github.com/vankruptgames/BalancingTable for instructions. This line isn't needed if you don't have one.
* '''MapRotation''' - you can add multiple of these. The map system has switched from the steam workshop to modio which means that the server rotation will need to be redone with modio UGCs. <nowiki>https://mod.io/g/pavlov</nowiki>. This is done by taking the resource ID from the modio page, adding “UGC” in front of it and then adding that to the rotation. For example the map gravity <nowiki>https://mod.io/g/pavlov/m/gravity1</nowiki> has a resource ID of 2773760 so the map ID to add to the server would be “UGC2773760”. When a match ends, the server will load the next map in the rotation.
* '''AFKTimeLimit''' There is now a feature to kick players who are idle in the game. Integers are measured in seconds and 0 disables AFK kicking completely.

Available game modes as of 09/06/2022: See Game modes table below

For maps running a Custom gamemode (CodZ, BR, Duel, etc.) it doesn't matter which gamemode you choose, as the map will automatically override it with the custom mode.

{| class="wikitable"
|+Limited Ammo Types
!AmmoType
!Name
!Description
|-
|0
|Unlimited
|Players have unlimited ammo, carry no ammo boxes and do not display an ammo count on the wrist.
|-
|1
|Limited Generic
|Players carry ammo boxes with a limited amount of ammo.
One box for each weapon class (Pistol, Submachine gun, Rifles/MGs, Shotgun, Sniper).

Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.

An ammo count is displayed on the wrist.
|-
|2
|Limited Specific
|Players carry ammo boxes with a limited amount of ammo.
One box for each weapon.

Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.

An ammo count is displayed on the wrist.
|-
|3
|Custom
|Allows for full control over ammo by the map.
|-
|4
| Limited Special
|'''All weapons except "special" weapons are unlimited, more clarification is needed.'''
|-
|5
|Boxless
|'''Like limited generic but without boxes? Clarification is needed.'''
|}
{| class="wikitable"
|+Game modes
!GameMode
!Name
|-
|DM
|Death match
|-
|KOTH
|King of the hill
|-
|GUN
| Gun game
|-
|OITC
| One in the chamber
|-
|SND
|Search and destroy
|-
|TANKTDM
|WW2 Team Death Match
|-
| TDM
|Team Death Match
|-
|TTT
|Trouble in Terrorist Town
|-
|WW2GUN
|WW2 gun game
|-
|ZWV
| Zombie wave survival
|-
|HIDE
|The Hidden
|-
|INFECTION
|Hidden infection
|-
|PUSH
|Push
|-
|PH
|Prop hunt
|}
= Default Map ID's =
datacenter

sand

bridge

containeryard

siberia (Prison Break)

hospital (Zombies map)

killhouse

range

tutorial

santorini

station

industry

ogcontainers (Shack only)

haguenau (Shack only)

foundation (Shack only)

stalingrad (PC only)

stalingrad_night (PC only)

santorini_night (PC only)

sand_night (PC only)

station_night (PC only)

industry_night (PC only)

bunker (PC only)

==== Firewall/Port forwarding ====
Using the default settings there are two UDP ports (7777, 8177) that need to be allowed to access the server either by firewall setup or port forwarding.

'''Ubuntu''' firewall commands to check firewall and open ports:
<pre>
sudo ufw status
sudo ufw allow 7777
sudo ufw allow 8177
sudo ufw allow 9100
sudo ufw status
</pre>

'''Rocky Linux''' firewall commands to check firewall and open ports:
<pre>
sudo firewall-cmd --zone=public --add-port=7777/tcp
sudo firewall-cmd --zone=public --add-port=7777/udp
sudo firewall-cmd --zone=public --add-port=8177/tcp
sudo firewall-cmd --zone=public --add-port=8177/udp
sudo firewall-cmd --zone=public --add-port=9100/udp
sudo firewall-cmd --zone=public --add-port=9100/tcp
sudo firewall-cmd --list-ports
firewall-cmd --runtime-to-permanent
</pre>

You may also need to allow Pings (ICMP) for the server's true latency to appear in the master list.

If you are running multiple servers and have set additional ports (see http://wiki.pavlov-vr.com/index.php?title=Dedicated_server#Running_multiple_servers_on_one_host) then you need to allow access to the defined port plus the port 400 higher. So if you use 7000 as your port, then UDP 7000 and 7400 need to be open

If you have setup rcon via RconSettings.txt (below) then that port also need to be allowed access via TCP

If you are running Shack/Quest and want to have maps that are downloadable from your server, your server ports (ex. 7777 & 8177) must also be open via TCP

----

==== Shack Maps (Quest) ====

If you try to use the steps above to add maps for Shack, youll run into issues very quickly. This is because Shack has no affiliation to Steam, and therefore cannot use Steam Workshop maps like above. In the future, these steps will apply to PC servers as well, allowing a server to hold the map itself, instead of offloading to Steam.

To get started, first create the directory to hold the maps

<pre>mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps</pre>

You can use any number of methods to move the map files onto the server, but ill go over the two simplest, starting with a GUI approach

Download and install CyberDuck onto your "home" PC (Whatever PC you use for access to the server, but not the server itsself): https://cyberduck.io/

Next, download and unzip your map of choice from https://www.pavlovquest.com/ , https://pavlovhorde.com/mapsList, or look in #shack-map-showcase channel in the discord server. I'm going to use Cheeto's WW2 Items test (http://www.mediafire.com/file/emyt9bs1z9u9ykw/SVR_Cheeto_Items.zip/file ) for this example, you do what you like

In the top left corner, open a connection, set the connection type to SFTP, and fill in the rest of the information. User will be root, password is whatever you set the root pw as (toor in Ubuntu by default)

In the directory dropdown (itll say /root) go back to /

Follow the directories until we arrive back at our "maps" folder <pre>/home/steam/pavlovserver/Pavlov/Saved/maps</pre>

Drag and drop the unzipped map folder into the main window, in this case itll be SVR_Cheeto_Items

Hit Allow

Youll now see a folder named SVR_Cheeto_Items, and within it should be nothing but 3 files. If there is another folder in it, move this folder to the maps directory, otherwise the server wont work. The 3 files (2 .PAK one .JSON) should be in home/steam/pavlovserver/Pavlov/Saved/maps/SVR_Cheeto_Items, no more, no less.

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

To play the map, you can either use RCON switch map command, or to add the map to your servers automatic map rotation list, add the map's folder name to your Game.ini. This replaces the MapID section, so for our example it would be

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

And thats all! Disconnect CyberDuck from your server before playing, otherwise youll have difficulty joining.

-----------

==== Adding Shack Maps over Command Line Interface ====

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

A bit more complicated, but adding maps over CLI has its benefits

First, CD to the maps directory you made above

<pre>cd ~/pavlovserver/Pavlov/Saved/maps</pre>

Download the map files from whatever you use to upload them. To do this, you can either use curl or wget

<pre>curl -O insertURLhere</pre>

'''If you download your map from Google Drive''', make sure that your .zip folder is shared to anyone.
Then, get the file's url from the shared link. Example : ''<nowiki>https://drive.google.com/file/d/19bI8gUHaN5tUrDvnadAacUnchQf6_k/view</nowiki>'' will be ''19bI8gUHaN5tUrDvnadAacUnchQf6_k''
Edit "fileId" and "fileName" before you execute the command.
<pre>
fileId=19bI8gUHaN5tUrDvnadAacUnchQf6_k
fileName=SVR_USER_MAPNAME
curl -sc /tmp/cookie "https://drive.google.com/uc?export=download&id=${fileId}" > /dev/null
code="$(awk '/_warning_/ {print $NF}' /tmp/cookie)"
curl -Lb /tmp/cookie "https://drive.google.com/uc?export=download&confirm=${code}&id=${fileId}" -o ${fileName} </pre>

To keep with the Items example:

<pre>curl -O https://cdn.discordapp.com/attachments/744185280759857234/745027406695366788/SVR_Cheeto_Items.zip</pre>

Next, unzip the file. If this next step errors out, saying the command is unknown, switch back to the root user (su root), and install unzip (sudo apt install unzip), then return to the steam user, and continue.

<pre>unzip SVR_Cheeto_Items.zip</pre>

Now finish like before by adding the map to your Game.ini

<pre>nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini</pre>

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

==== Admin/Moderator list (optional) ====

The only working in-game admin menu is through Arctic VR server hosting (see below).

If you add moderators to your server, they will not be subject to vote kicks.

<pre>
nano ~/pavlovserver/Pavlov/Saved/Config/mods.txt
</pre>

Example Mod List:
<pre>
76541198397498572 #Optional Comment: Player name
76541198397498573 #Some Other Player
</pre>

==== ArcticVR Admin Menu ====

[[File:Arcticmenu.jpg|500px|link=https://www.arctic-vr.com/server-admin-menu]]

Arctic-VR Offers an advanced In-Game Admin menu that is exclusive to their hosting service. Features include:
* Switch Maps+Modes
* Teleport Players to Players
* Change Player Skins
* Control Player Buying+Cash
* Spawn Items
* Clean up corpses + guns
* Spawn Bots
* Spawn Items for other players
* Control Teams + Balance/Shuffle Teams
* ResetSND
* And More

You can read more about the ArcticVR admin menu on their website: https://www.arctic-vr.com/server-admin-menu

==== Handy tools for finding steamIDs ====

Steam ID finder: https://steamidfinder.com/lookup/ or https://steamid.xyz/

You want to enter in the steamID64 format.

This tool can convert or lookup IDs: https://steamid.io/

If you are looking for a steamID of a player that has been on your server recently this is technique to find them:
<pre>
grep -i playername ~/pavlovserver/Pavlov/Saved/Logs/* | grep TicketValidation
</pre>

=== Configure Rcon ===
To enable Rcon access create config file:
<pre> nano /home/steam/pavlovserver/Pavlov/Saved/Config/RconSettings.txt </pre>

Copy in the following text - change password, and if desired the port:
<pre>
Password=ChangeThisPassword
Port=9100
</pre>
You must specify a port for the Rcon server to use as well as a Password (use a different port per sever instance if running multiple server instances off the same hardware)

=== Starting the server ===

<pre>
cd ~/pavlovserver && ./PavlovServer.sh
</pre>

That's it, your server will be automatically broadcast to the master server! :)

Two handy tools to determine quickly if your server is broadcasting are [https://pablub.xyz/ Pablub] (PC only) and [https://pavlovhorde.com/ Horde] (Shack) and [https://pavlovhorde.com/pcServers Horde] (PC version)

Note that when you close your terminal, the server will go down. See the "supervisors" section below for how to prevent this.

----

=== Supervising the server using systemd ===

Running '''./PavlovServer.sh''' in your interactive shell is easy, but the server will shut down when you close your terminal. If you want to run the server in the background,
you'll want to run it under a supervisor. There are many options, ranging from the simple (nohup, screen or tmux), to the
more robust (supervisord, systemd).

Systemd is running by default on Ubuntu Linux, so we'll use that here.

To run the server as a systemd service, create the file '''/etc/systemd/system/pavlovserver.service''' (as root) by typing
<pre>
sudo nano /etc/systemd/system/pavlovserver.service
</pre>

Copy contents below into the file and save.

<pre>
[Unit]
Description=Pavlov VR dedicated server

[Service]
Type=simple
WorkingDirectory=/home/steam/pavlovserver
ExecStart=/home/steam/pavlovserver/PavlovServer.sh

RestartSec=1
Restart=always
User=steam
Group=steam

[Install]
WantedBy = multi-user.target
</pre>

If you'd like your server to start as competitive without editing the game.ini, change the line "ExecStart=/home/steam/pavlovserver/PavlovServer.sh" to look like this below. Though it's much easier to just use the game.ini to enable competitive instead. <pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -COMPETITIVE=1</pre>

Change the user or paths as appropriate. After saving the service file, to start, restart, stop, or monitor the server:

<pre>
sudo systemctl start pavlovserver
sudo systemctl restart pavlovserver
sudo systemctl stop pavlovserver
sudo systemctl status pavlovserver
</pre>

To view the logs:

<pre>
sudo journalctl -u pavlovserver
# to live-tail the logs
sudo journalctl -u pavlovserver -f
</pre>

If you want to run the pavlov server as soon as your server boots (e.g. a VPS you turn on and off), add pavlov as a startup service:

<pre>
sudo systemctl enable pavlovserver
</pre>

----

== Advanced Server Administration ==

=== Running multiple servers on one host ===

* Pavlovserver is functionally single threaded (there are multiple threads, but vast majority of work occurs in the primary one). Make sure you have # of pavlovservers + 1 CPU available. More CPUs= more servers. Faster CPU = more players.
* Make multiple server installs by defining a separate install dir for each server.
* Run each server with a unique port. eg: '''./PavlovServer.sh -PORT="Desired Port"'''
* The Server will use the Desired Port and the Port 400 above (Example: You choose 8200 as Port. So Port 8600 will be used as well)
* If you are using RCON, each server will need a unique port defined in RconSettings.txt
* Ensure the ports are forwarded and opened in your firewall

To duplicate directories:

be in the steam home folder
<pre>
cp -r pavlovserver pavlovserver1
/home/steam/pavlovserver1/PavlovServer.sh -PORT=[Desired Port]
</pre>

=== Starting server in competitive mode ===
Competitive mode will prevent dead teammates from being able to see the match, to prevent ghosting.
You can either enable this via Game.ini (described in Game.ini file), or using the -COMPETITIVE=1 parameter.

<pre>
/home/steam/pavlovserver1/PavlovServer.sh -COMPETITIVE=1
</pre>

{| class="wikitable"

|}

=== Useful Linux Commands ===
List files / folders in directory, print current working directory,
<pre>ls -la #list files/directories along with authorities and ownership
pwd #print working directory
sudo chown <owner> <file/directory> #change owner of file/directory. If root created something and you need to change it to steam
sudo chgrp <group> <file/directory> #change group of file/directory.
</pre>

Check if pavlov is running by checking process status. If the only row you see is the grep command, pavlov server is not started.
<pre> ps -ef | grep pav </pre>

Sample output:
<pre>
steam 34044 1 0 16:52 ? 00:00:00 /bin/sh /home/steam/pavlovserver/PavlovServer.sh
steam 34066 34044 80 16:52 ? 00:00:04 /home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer
zombies+ 34101 34013 0 16:52 pts/0 00:00:00 grep --color=auto pav
</pre>

Kill a process. Note this command uses 34044, which is a process id from the command output above.
<pre> kill -9 34044 </pre>

Dump the log to the console so you can scroll through it:
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log </pre>

Search the log for a string - replace my_string with case-sensitive string
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep my_string </pre>

<hr>

== Advanced Scripts For Server Management ==
<hr>

=== '''Auto-updating the server''' ===
Assuming you have followed this guide and used the default paths, users, and install instructions, you can paste the following into your terminal to auto-update your Pavlov server:

<pre>
cat << 'EOF' > $HOME/pavlov_daily_update_and_restart.sh
#!/bin/bash

USER="steam"
SERVICENAME="pavlovserver.service"
INSTALLDIRNAME="pavlovserver"
USERHOME="/home/$USER"

echo -e "Beginning Pavlov VR update run on $(date)\n\n"

systemctl stop "$SERVICENAME"

sleep 5
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +force_install_dir "$USERHOME/$INSTALLDIRNAME" +app_update 622970 +exit
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +app_update 1007 +quit
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/.steam/sdk64/steamclient.so"
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/pavlovserver/Pavlov/Binaries/Linux/steamclient.so"

systemctl start "$SERVICENAME"

echo -e "Ending Pavlov VR update run on $(date)\n\n"

EOF

chmod +x $HOME/pavlov_daily_update_and_restart.sh
mkdir $HOME/pavlov_update_logs && touch $HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log
CRONLINE="00 2 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
(sudo crontab -u root -l; echo "$CRONLINE" ) | sudo crontab -u root -
unset CRONLINE

</pre>

These commands will:

1. Create a shell script in the "steam" user's home directory that automatically stops the Pavlov server, pulls any updates via steam, pull updates to the Steamworks SDK Redist, and copies the latest version of steamclient.so to the Pavlov server directory

2. Make the shell script executable

3. Create a new directory called "pavlov_update_logs" in the "steam" user's directory, and create a logfile inside that directory called "pavlov_daily_update_and_restart.sh.log". You can check this logfile to see the output of the Pavlov and Steam SDK update commands.

4. Create a crontab entry for the root user that runs this shell script automatically every day at 2:00AM local time

If you want to change the time that this script runs, edit the numbers "00 2" in the line that starts with "CRONLINE=". In the example provided, 00 is the minutes column, and 2 is the hour column. For example, if you wanted the server to automatically update and restart at 4:17AM every day, change the line starting with "CRONLINE=" to:

<pre>
CRONLINE="17 4 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
</pre>

If the time is PM, use 24-hour time format, e.g. "32 18" for 6:32PM.
<hr>
=== '''Save Logs for records and stats''' ===
this is a automated script that will on a timer save all the backups made by the server before they are purged by the game for admin records and starts collection

https://github.com/JTWP-org/backUpLogs2

<hr>

Setting up a dedicated server

2023-07-17T16:56:34Z

SaltedCrackerJack: /* System setup and software installation */

== Setting up a dedicated server ==

'''There are no Windows binaries'''

This guide is written exclusively for Linux and covers Ubuntu/Debian/Debian-like and Red Hat RPM-based distros. Possible to run with other distros, but some of the commands won't work and you will need to know enough to figure out the software install of dependencies on your own.

If you are considering hosting from home, please read that section of the wiki first.

This guide assumes you know the basics of using a bash terminal: ssh'ing into a server, running bash commands, editing text files, etc.

If you have no experience using bash, maybe start [https://www.howtogeek.com/140679/beginner-geek-how-to-start-using-the-linux-terminal/ here]. Editing text files via commandline is often a challenge. Suggest using nano and reading guide [https://www.howtogeek.com/howto/42980/the-beginners-guide-to-nano-the-linux-command-line-text-editor/ here]

If you are new to linux and accessing your server from Windows, highly suggest using MobaXterm as your SSH client as that can make required editing of text files easier using built in editor instead of the native linux command line editors.

And finally, ask yourself why you want to setup a server? If you look at the list, there are many, many more servers than players. If you don't have a team, discord community, or group of friends ready to play on your server, chances are it will go unused. Got one of these... great, let's go.

If you don't want to go through the hassle yourself and want to pay for a hosting service Arctic VR (PC and Shack) and Horde (Shack) provide a server hosting services and are trusted in the community. See links below.

----

=== Server Requirements ===

'''Pavlovserver can only be hosted under Linux.'''

This can be running as a VM under windows, but this will increase the complexity of the setup beyond this guide.

Ubuntu 18.04 x86_64, Ubuntu 19/04 amd64, Ubuntu 20.04, and Rocky Linux 8 are confirmed working. Ubuntu 15.04 x86 is known to fail to install using this guide. Recommend not running on "minimal" images as some tools are missing.

* 2GB RAM + 1GB RAM per each additional server with 10 players. More RAM is recommended for larger maps, higher player counts, or complex gamemodes. Not having enough RAM is a common cause of server crashes.

* A ~2.5Ghz CPU will comfortably support a 10 player server.

* A ~4Ghz CPU will comfortably support 24 players. This is a limit built into Pavlov itself, no server will allow players to join over 24. Lower player counts are recommended for complex gamemodes (E.g. CodZ) and/or highly detailed maps, so that maximum number will often be lower.

(Note that these are '''not''' hard limits for player counts, just suggestions for the best performance, based on experiences with many server providers on different grades of hardware.)

* Pavlovserver is functionally single threaded (one thread does vast majority of work). More CPUs only help if you are running more servers. More clockspeed = higher performance = more users per server.
The maximum number of servers you can run is dependent on how many CPUs you have. For example, if you have an 8 core CPU, the maximum number of servers would be 7. You should always have at least one CPU free as overhead, as Pavlov servers can use slightly more than one thread.

----

==== Hosting at home ====
When hosting at home there are additional requirements regarding networking: Your router has to support port-forwarding, hair-pinning/LoopbackNAT, and respond to ping requests. These techniques are necessary to allow your server to be found and to talk back to the client. please see https://en.wikipedia.org/wiki/Port_forwarding, https://en.wikipedia.org/wiki/Hairpinning, and https://www.speedguide.net/faq/how-to-become-pingable-behind-a-routerfirewall-376 for more info and google for these terms in addition to your router model to find guides on how to enable/configure it properly. If you have modern Router, it may have these features already enabled, in this case you just have to configure port-forwarding. If you can see your server but not join it while others can, this is indicative of a failure of LoopbackNAT.

A second challenge to hosting at home is CGNAT (Carrier grade NAT: https://www.a10networks.com/blog/carrier-grade-nat/). Just like NAT on your home network that has to be gotten around w/ port-forwarding, CGNAT breaks the ability of external connections to be made back to your server, but the controls are solely in your ISPs hands. Sometimes if you ask, you can be removed from CGNAT pools and/or assigned a static IP. CGNAT rollouts are becoming very common now, so if your server worked then doesn't allow connections now, your ISP may have made this change.

You can check whether you’re on a CGNAT network by visiting a Web site such as ipaddress.com or whatsmyip.com and comparing the IP address listed to the public/WAN IP address assigned to your Internet gateway. To find your gateway’s public IP address, check the status page in the administrative interface. If the two IP addresses differ, you’re likely on a CGNAT network. If so, this problem must be resolved before you go any further.

'''Not understanding these requirements and configuration is a frequent cause of failed setups and questions in discord. Don't skip this if you are trying to host from home'''

'''There are serious security implications of hosting this software at home.''' None of the devs are security experts and there has been no security review of the code. You are opening up your system to the world and publicity advertising this fact. Expect that any system hosting this software is open to compromise from the Internet and act accordingly. If your router offers a DMZ network, use it. Consider hosting on a cloud based server and think twice before running this software on any system that contains data you care about or has access to networks and computers you care about.

If you're hosting at home using Oracle's VirtualBox, there are steps you can take to prevent double NAT (which can cause issues later on)

1. Select your VM and then click Settings in VirtualBox's main window.

2. Click on Network and change Attached To from NAT to Bridged Adapter.

Once you've done this, your VM should be connected directly to your home router and double NAT should no longer be a issue.

----

==== Starting Server Install ====

====Obtaining an ApiKey====
For your server to show up in the server list, there is now a requirement to have an ApiKey issued by vankrupt. This is to prevent DOS attacks against the master server

Get the key by going here: https://pavlov-ms.vankrupt.com/servers/v1/key and using your mobile number to get a SMS
(note that there have been reported failures of this SMS system for non-US mobiles. In this case DM davevillz your mobile and ask for a key)

Put this key in your Game.ini as follows:
ApiKey="ABC123FALSEKEYDONTUSEME"
or if you would like (personally untested..I would use game.ini) you can call it at server runtime with flag as follows:
-KEY="ABC123FALSEKEYDONTUSEME"

This key can be re-used for a reasonable number of servers (a limit of 10 has been mentioned). Contact the Devs if you need more servers per key.

====System setup and software installation====

Install dependencies and create the `steam` user. (You only need to do this once):

Confirm Linux version
<pre>
lsb_release -a
</pre>

'''Ubuntu 20.04'''
'''''sudo apt update''''' && '''''sudo apt install''''' -y gdb curl lib32gcc1 libc++-dev unzip
sudo useradd -m steam
'''Ubuntu 20.10 or higher'''
sudo apt update && sudo apt install -y gdb curl lib32gcc-s1 libc++-dev unzip
sudo useradd -m steam
'''Rocky Linux, CentOS 8, and RHEL 8'''
sudo sed -i 's/^SELINUX=enforcing$/SELINUX=permissive/g' /etc/selinux/config
sudo setenforce 0
sudo yum install gdb curl glibc.i686 libstdc++.i686 libstdc++-devel.i686 libstdc++-devel.x86_64 unzip wget -y
wget <nowiki>https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/l/libcxx-3.8.0-3.el7.x86_64.rpm</nowiki>
sudo rpm -i libcxx-3.8.0-3.el7.x86_64.rpm
sudo useradd -m steam
[Optional] Set a password for steam.
<pre>sudo passwd steam</pre>

Login as the steam user. ('''You will need to do this each time you connect to your server'''):

<pre>
sudo su -l steam
</pre>

Install Steam:

<pre>
mkdir ~/Steam && cd ~/Steam && curl -sqL "https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz" | tar zxvf -
</pre>

There are different dedicated server versions for Pavlov Server - choose which server version you want to host (PC non-beta, PC Beta, Shack Live, or Shack RC)
(You will need to run this command each time there is a Pavlov Server update).

 
To host '''PC Server (non-beta)''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta default +exit
</pre>

To host '''PC BETA''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta beta_server +exit
</pre>

To host '''Shack Live''' (Quest):

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack +exit
</pre>

To host '''Shack RC''' (Quest): 

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack_beta +exit
</pre>

Now that we've installed the server, all pavlov server versions should continue. 
Install a fresh copy of steamclient.so (May have to do this after each update):
<pre>
~/Steam/steamcmd.sh +login anonymous +app_update 1007 +quit
mkdir -p ~/.steam/sdk64
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/pavlovserver/Pavlov/Binaries/Linux/steamclient.so
</pre>

The update 29 of the PCVR version of pavlov and after added a requirement to run these commands to change the steamclient.so:
<code>sudo rm /usr/lib/x86_64-linux-gnu/libc++.so</code>
<code>sudo ln -s /usr/lib/x86_64-linux-gnu/libc++.so.1 /usr/lib/x86_64-linux-gnu/libc++.so</code>

Make the PavlovServer script executable. (You only need to do this once):

<pre>
chmod +x ~/pavlovserver/PavlovServer.sh
</pre>

----

=== Server Configuration ===

Before starting the server we need to configure it. Start by creating some directories:

<pre>
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Logs
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps
</pre>

==== Mods/Blacklist/Whitelist (optional) ====

The following three files allow you to specify mods, banned players, and whitelist players. These are optional, but go ahead and create them. Populating the files is described later.

<pre>
touch /home/steam/pavlovserver/Pavlov/Saved/Config/mods.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/blacklist.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/whitelist.txt
</pre>

====Configuring Game.ini====
Create a new Game.ini file using following command to open an editor and copy/paste the following block into it then save it. Note not all of these options are required. For instance remove or comment out the Password=0000 line to make a public server with no pin.
<pre>
nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini
</pre>

<pre>
[/Script/Pavlov.DedicatedServer]
bEnabled=true
ServerName="My_private_idaho"
MaxPlayers=10 #Set this to 10 for Shack. 24 is the max for PC, setting it higher will not allow players to join.
ApiKey="ABC123FALSEKEYDONTUSEME"
bSecured=true
bCustomServer=true
bVerboseLogging=false
bCompetitive=false #This only works for SND
bWhitelist=false
RefreshListTime=120
LimitedAmmoType=0
TickRate=90
TimeLimit=60
#Password=0000
#BalanceTableURL="vankruptgames/BalancingTable/main"
MapRotation=(MapId="UGC1758245796", GameMode="GUN")
MapRotation=(MapId="datacenter", GameMode="SND")
MapRotation=(MapId="sand", GameMode="DM")

</pre>

* '''bEnabled''' - whether the server appears in the server list (unconfirmed)
* '''ServerName''' - name it will be listed as. (approx 35 chars max)
* '''MaxPlayers''' - See suggested specs for limits. 10 standard (10 for shack), 20-24 is max recommended for large maps like Stalingrad or PUSH/RUSH modes, and servers allow a maximum of 24 players.
* '''ApiKey''' - Unique ApiKey required to register server with master server. Replace with your key
* '''bSecured''' - enabled Valve Anti-Cheat (VAC)
* '''bCustomServer''' - activates some new modding tools (save and http functions. Required to write to blacklist.txt for bans)
* '''bCompetitive''' - sets the server to competitive mode for SND. If removed the server will default to false
* '''bVerboseLogging''' - enables verbose logging, mostly detailed statistics. Be prepared for significant increase in logging.
* '''bWhitelist''' - Only allow users in whitelist.txt to join
* '''RefreshListTime''' - sets how often the running server checks for updates in ban/whitelist/mod files
* '''LimitedAmmoType''' - sets limited ammo mode, see Limited Ammo Types table below

* '''TimeLimit''' - sets time limit for each map
* '''TickRate''' - sets the server tickrate. (so far minimum stable seems around 50 and max around 120. Beware setting this changes weapon despawn time and breaks some game modes. Recommend not touching)
* '''Password''' - PIN number for server #FYI - this is now also changeable via rcon.
* '''BalanceTableURL''' - Points to a custom balance table from github. See https://github.com/vankruptgames/BalancingTable for instructions. This line isn't needed if you don't have one.
* '''MapRotation''' - you can add multiple of these. The map system has switched from the steam workshop to modio which means that the server rotation will need to be redone with modio UGCs. <nowiki>https://mod.io/g/pavlov</nowiki>. This is done by taking the resource ID from the modio page, adding “UGC” in front of it and then adding that to the rotation. For example the map gravity <nowiki>https://mod.io/g/pavlov/m/gravity1</nowiki> has a resource ID of 2773760 so the map ID to add to the server would be “UGC2773760”. When a match ends, the server will load the next map in the rotation.
* '''AFKTimeLimit''' There is now a feature to kick players who are idle in the game. Integers are measured in seconds and 0 disables AFK kicking completely.

Available game modes as of 09/06/2022: See Game modes table below

For maps running a Custom gamemode (CodZ, BR, Duel, etc.) it doesn't matter which gamemode you choose, as the map will automatically override it with the custom mode.

{| class="wikitable"
|+Limited Ammo Types
!AmmoType
!Name
!Description
|-
|0
|Unlimited
|Players have unlimited ammo, carry no ammo boxes and do not display an ammo count on the wrist.
|-
|1
|Limited Generic
|Players carry ammo boxes with a limited amount of ammo.
One box for each weapon class (Pistol, Submachine gun, Rifles/MGs, Shotgun, Sniper).

Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.

An ammo count is displayed on the wrist.
|-
|2
|Limited Specific
|Players carry ammo boxes with a limited amount of ammo.
One box for each weapon.

Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.

An ammo count is displayed on the wrist.
|-
|3
|Custom
|Allows for full control over ammo by the map.
|-
|4
| Limited Special
|'''All weapons except "special" weapons are unlimited, more clarification is needed.'''
|-
|5
|Boxless
|'''Like limited generic but without boxes? Clarification is needed.'''
|}
{| class="wikitable"
|+Game modes
!GameMode
!Name
|-
|DM
|Death match
|-
|KOTH
|King of the hill
|-
|GUN
| Gun game
|-
|OITC
| One in the chamber
|-
|SND
|Search and destroy
|-
|TANKTDM
|WW2 Team Death Match
|-
| TDM
|Team Death Match
|-
|TTT
|Trouble in Terrorist Town
|-
|WW2GUN
|WW2 gun game
|-
|ZWV
| Zombie wave survival
|-
|HIDE
|The Hidden
|-
|INFECTION
|Hidden infection
|-
|PUSH
|Push
|-
|PH
|Prop hunt
|}
= Default Map ID's =
datacenter

sand

bridge

containeryard

siberia (Prison Break)

hospital (Zombies map)

killhouse

range

tutorial

santorini

station

industry

ogcontainers (Shack only)

haguenau (Shack only)

foundation (Shack only)

stalingrad (PC only)

stalingrad_night (PC only)

santorini_night (PC only)

sand_night (PC only)

station_night (PC only)

industry_night (PC only)

bunker (PC only)

==== Firewall/Port forwarding ====
Using the default settings there are two UDP ports (7777, 8177) that need to be allowed to access the server either by firewall setup or port forwarding.

'''Ubuntu''' firewall commands to check firewall and open ports:
<pre>
sudo ufw status
sudo ufw allow 7777
sudo ufw allow 8177
sudo ufw allow 9100
sudo ufw status
</pre>

'''Rocky Linux''' firewall commands to check firewall and open ports:
<pre>
sudo firewall-cmd --zone=public --add-port=7777/tcp
sudo firewall-cmd --zone=public --add-port=7777/udp
sudo firewall-cmd --zone=public --add-port=8177/tcp
sudo firewall-cmd --zone=public --add-port=8177/udp
sudo firewall-cmd --zone=public --add-port=9100/udp
sudo firewall-cmd --zone=public --add-port=9100/tcp
sudo firewall-cmd --list-ports
firewall-cmd --runtime-to-permanent
</pre>

You may also need to allow Pings (ICMP) for the server's true latency to appear in the master list.

If you are running multiple servers and have set additional ports (see http://wiki.pavlov-vr.com/index.php?title=Dedicated_server#Running_multiple_servers_on_one_host) then you need to allow access to the defined port plus the port 400 higher. So if you use 7000 as your port, then UDP 7000 and 7400 need to be open

If you have setup rcon via RconSettings.txt (below) then that port also need to be allowed access via TCP

If you are running Shack/Quest and want to have maps that are downloadable from your server, your server ports (ex. 7777 & 8177) must also be open via TCP

----

==== Shack Maps (Quest) ====

If you try to use the steps above to add maps for Shack, youll run into issues very quickly. This is because Shack has no affiliation to Steam, and therefore cannot use Steam Workshop maps like above. In the future, these steps will apply to PC servers as well, allowing a server to hold the map itself, instead of offloading to Steam.

To get started, first create the directory to hold the maps

<pre>mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps</pre>

You can use any number of methods to move the map files onto the server, but ill go over the two simplest, starting with a GUI approach

Download and install CyberDuck onto your "home" PC (Whatever PC you use for access to the server, but not the server itsself): https://cyberduck.io/

Next, download and unzip your map of choice from https://www.pavlovquest.com/ , https://pavlovhorde.com/mapsList, or look in #shack-map-showcase channel in the discord server. I'm going to use Cheeto's WW2 Items test (http://www.mediafire.com/file/emyt9bs1z9u9ykw/SVR_Cheeto_Items.zip/file ) for this example, you do what you like

In the top left corner, open a connection, set the connection type to SFTP, and fill in the rest of the information. User will be root, password is whatever you set the root pw as (toor in Ubuntu by default)

In the directory dropdown (itll say /root) go back to /

Follow the directories until we arrive back at our "maps" folder <pre>/home/steam/pavlovserver/Pavlov/Saved/maps</pre>

Drag and drop the unzipped map folder into the main window, in this case itll be SVR_Cheeto_Items

Hit Allow

Youll now see a folder named SVR_Cheeto_Items, and within it should be nothing but 3 files. If there is another folder in it, move this folder to the maps directory, otherwise the server wont work. The 3 files (2 .PAK one .JSON) should be in home/steam/pavlovserver/Pavlov/Saved/maps/SVR_Cheeto_Items, no more, no less.

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

To play the map, you can either use RCON switch map command, or to add the map to your servers automatic map rotation list, add the map's folder name to your Game.ini. This replaces the MapID section, so for our example it would be

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

And thats all! Disconnect CyberDuck from your server before playing, otherwise youll have difficulty joining.

-----------

==== Adding Shack Maps over Command Line Interface ====

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

A bit more complicated, but adding maps over CLI has its benefits

First, CD to the maps directory you made above

<pre>cd ~/pavlovserver/Pavlov/Saved/maps</pre>

Download the map files from whatever you use to upload them. To do this, you can either use curl or wget

<pre>curl -O insertURLhere</pre>

'''If you download your map from Google Drive''', make sure that your .zip folder is shared to anyone.
Then, get the file's url from the shared link. Example : ''<nowiki>https://drive.google.com/file/d/19bI8gUHaN5tUrDvnadAacUnchQf6_k/view</nowiki>'' will be ''19bI8gUHaN5tUrDvnadAacUnchQf6_k''
Edit "fileId" and "fileName" before you execute the command.
<pre>
fileId=19bI8gUHaN5tUrDvnadAacUnchQf6_k
fileName=SVR_USER_MAPNAME
curl -sc /tmp/cookie "https://drive.google.com/uc?export=download&id=${fileId}" > /dev/null
code="$(awk '/_warning_/ {print $NF}' /tmp/cookie)"
curl -Lb /tmp/cookie "https://drive.google.com/uc?export=download&confirm=${code}&id=${fileId}" -o ${fileName} </pre>

To keep with the Items example:

<pre>curl -O https://cdn.discordapp.com/attachments/744185280759857234/745027406695366788/SVR_Cheeto_Items.zip</pre>

Next, unzip the file. If this next step errors out, saying the command is unknown, switch back to the root user (su root), and install unzip (sudo apt install unzip), then return to the steam user, and continue.

<pre>unzip SVR_Cheeto_Items.zip</pre>

Now finish like before by adding the map to your Game.ini

<pre>nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini</pre>

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

==== Admin/Moderator list (optional) ====

The only working in-game admin menu is through Arctic VR server hosting (see below).

If you add moderators to your server, they will not be subject to vote kicks.

<pre>
nano ~/pavlovserver/Pavlov/Saved/Config/mods.txt
</pre>

Example Mod List:
<pre>
76541198397498572 #Optional Comment: Player name
76541198397498573 #Some Other Player
</pre>

==== ArcticVR Admin Menu ====

[[File:Arcticmenu.jpg|500px|link=https://www.arctic-vr.com/server-admin-menu]]

Arctic-VR Offers an advanced In-Game Admin menu that is exclusive to their hosting service. Features include:
* Switch Maps+Modes
* Teleport Players to Players
* Change Player Skins
* Control Player Buying+Cash
* Spawn Items
* Clean up corpses + guns
* Spawn Bots
* Spawn Items for other players
* Control Teams + Balance/Shuffle Teams
* ResetSND
* And More

You can read more about the ArcticVR admin menu on their website: https://www.arctic-vr.com/server-admin-menu

==== Handy tools for finding steamIDs ====

Steam ID finder: https://steamidfinder.com/lookup/ or https://steamid.xyz/

You want to enter in the steamID64 format.

This tool can convert or lookup IDs: https://steamid.io/

If you are looking for a steamID of a player that has been on your server recently this is technique to find them:
<pre>
grep -i playername ~/pavlovserver/Pavlov/Saved/Logs/* | grep TicketValidation
</pre>

=== Configure Rcon ===
To enable Rcon access create config file:
<pre> nano /home/steam/pavlovserver/Pavlov/Saved/Config/RconSettings.txt </pre>

Copy in the following text - change password, and if desired the port:
<pre>
Password=ChangeThisPassword
Port=9100
</pre>
You must specify a port for the Rcon server to use as well as a Password (use a different port per sever instance if running multiple server instances off the same hardware)

=== Starting the server ===

<pre>
cd ~/pavlovserver && ./PavlovServer.sh
</pre>

That's it, your server will be automatically broadcast to the master server! :)

Two handy tools to determine quickly if your server is broadcasting are [https://pablub.xyz/ Pablub] (PC only) and [https://pavlovhorde.com/ Horde] (Shack) and [https://pavlovhorde.com/pcServers Horde] (PC version)

Note that when you close your terminal, the server will go down. See the "supervisors" section below for how to prevent this.

----

=== Supervising the server using systemd ===

Running '''./PavlovServer.sh''' in your interactive shell is easy, but the server will shut down when you close your terminal. If you want to run the server in the background,
you'll want to run it under a supervisor. There are many options, ranging from the simple (nohup, screen or tmux), to the
more robust (supervisord, systemd).

Systemd is running by default on Ubuntu Linux, so we'll use that here.

To run the server as a systemd service, create the file '''/etc/systemd/system/pavlovserver.service''' (as root) by typing
<pre>
sudo nano /etc/systemd/system/pavlovserver.service
</pre>

Copy contents below into the file and save.

<pre>
[Unit]
Description=Pavlov VR dedicated server

[Service]
Type=simple
WorkingDirectory=/home/steam/pavlovserver
ExecStart=/home/steam/pavlovserver/PavlovServer.sh

RestartSec=1
Restart=always
User=steam
Group=steam

[Install]
WantedBy = multi-user.target
</pre>

If you'd like your server to start as competitive without editing the game.ini, change the line "ExecStart=/home/steam/pavlovserver/PavlovServer.sh" to look like this below. Though it's much easier to just use the game.ini to enable competitive instead. <pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -COMPETITIVE=1</pre>

Change the user or paths as appropriate. After saving the service file, to start, restart, stop, or monitor the server:

<pre>
sudo systemctl start pavlovserver
sudo systemctl restart pavlovserver
sudo systemctl stop pavlovserver
sudo systemctl status pavlovserver
</pre>

To view the logs:

<pre>
sudo journalctl -u pavlovserver
# to live-tail the logs
sudo journalctl -u pavlovserver -f
</pre>

If you want to run the pavlov server as soon as your server boots (e.g. a VPS you turn on and off), add pavlov as a startup service:

<pre>
sudo systemctl enable pavlovserver
</pre>

----

== Advanced Server Administration ==

=== Running multiple servers on one host ===

* Pavlovserver is functionally single threaded (there are multiple threads, but vast majority of work occurs in the primary one). Make sure you have # of pavlovservers + 1 CPU available. More CPUs= more servers. Faster CPU = more players.
* Make multiple server installs by defining a separate install dir for each server.
* Run each server with a unique port. eg: '''./PavlovServer.sh -PORT="Desired Port"'''
* The Server will use the Desired Port and the Port 400 above (Example: You choose 8200 as Port. So Port 8600 will be used as well)
* If you are using RCON, each server will need a unique port defined in RconSettings.txt
* Ensure the ports are forwarded and opened in your firewall

To duplicate directories:

be in the steam home folder
<pre>
cp -r pavlovserver pavlovserver1
/home/steam/pavlovserver1/PavlovServer.sh -PORT=[Desired Port]
</pre>

=== Starting server in competitive mode ===
Competitive mode will prevent dead teammates from being able to see the match, to prevent ghosting.
You can either enable this via Game.ini (described in Game.ini file), or using the -COMPETITIVE=1 parameter.

<pre>
/home/steam/pavlovserver1/PavlovServer.sh -COMPETITIVE=1
</pre>

{| class="wikitable"

|}

=== Useful Linux Commands ===
List files / folders in directory, print current working directory,
<pre>ls -la #list files/directories along with authorities and ownership
pwd #print working directory
sudo chown <owner> <file/directory> #change owner of file/directory. If root created something and you need to change it to steam
sudo chgrp <group> <file/directory> #change group of file/directory.
</pre>

Check if pavlov is running by checking process status. If the only row you see is the grep command, pavlov server is not started.
<pre> ps -ef | grep pav </pre>

Sample output:
<pre>
steam 34044 1 0 16:52 ? 00:00:00 /bin/sh /home/steam/pavlovserver/PavlovServer.sh
steam 34066 34044 80 16:52 ? 00:00:04 /home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer
zombies+ 34101 34013 0 16:52 pts/0 00:00:00 grep --color=auto pav
</pre>

Kill a process. Note this command uses 34044, which is a process id from the command output above.
<pre> kill -9 34044 </pre>

Dump the log to the console so you can scroll through it:
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log </pre>

Search the log for a string - replace my_string with case-sensitive string
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep my_string </pre>

<hr>

== Advanced Scripts For Server Management ==
<hr>

=== '''Auto-updating the server''' ===
Assuming you have followed this guide and used the default paths, users, and install instructions, you can paste the following into your terminal to auto-update your Pavlov server:

<pre>
cat << 'EOF' > $HOME/pavlov_daily_update_and_restart.sh
#!/bin/bash

USER="steam"
SERVICENAME="pavlovserver.service"
INSTALLDIRNAME="pavlovserver"
USERHOME="/home/$USER"

echo -e "Beginning Pavlov VR update run on $(date)\n\n"

systemctl stop "$SERVICENAME"

sleep 5
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +force_install_dir "$USERHOME/$INSTALLDIRNAME" +app_update 622970 +exit
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +app_update 1007 +quit
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/.steam/sdk64/steamclient.so"
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/pavlovserver/Pavlov/Binaries/Linux/steamclient.so"

systemctl start "$SERVICENAME"

echo -e "Ending Pavlov VR update run on $(date)\n\n"

EOF

chmod +x $HOME/pavlov_daily_update_and_restart.sh
mkdir $HOME/pavlov_update_logs && touch $HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log
CRONLINE="00 2 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
(sudo crontab -u root -l; echo "$CRONLINE" ) | sudo crontab -u root -
unset CRONLINE

</pre>

These commands will:

1. Create a shell script in the "steam" user's home directory that automatically stops the Pavlov server, pulls any updates via steam, pull updates to the Steamworks SDK Redist, and copies the latest version of steamclient.so to the Pavlov server directory

2. Make the shell script executable

3. Create a new directory called "pavlov_update_logs" in the "steam" user's directory, and create a logfile inside that directory called "pavlov_daily_update_and_restart.sh.log". You can check this logfile to see the output of the Pavlov and Steam SDK update commands.

4. Create a crontab entry for the root user that runs this shell script automatically every day at 2:00AM local time

If you want to change the time that this script runs, edit the numbers "00 2" in the line that starts with "CRONLINE=". In the example provided, 00 is the minutes column, and 2 is the hour column. For example, if you wanted the server to automatically update and restart at 4:17AM every day, change the line starting with "CRONLINE=" to:

<pre>
CRONLINE="17 4 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
</pre>

If the time is PM, use 24-hour time format, e.g. "32 18" for 6:32PM.
<hr>
=== '''Save Logs for records and stats''' ===
this is a automated script that will on a timer save all the backups made by the server before they are purged by the game for admin records and starts collection

https://github.com/JTWP-org/backUpLogs2

Setting up a dedicated server

2023-07-17T16:56:07Z

SaltedCrackerJack: /* System setup and software installation */

== Setting up a dedicated server ==

'''There are no Windows binaries'''

This guide is written exclusively for Linux and covers Ubuntu/Debian/Debian-like and Red Hat RPM-based distros. Possible to run with other distros, but some of the commands won't work and you will need to know enough to figure out the software install of dependencies on your own.

If you are considering hosting from home, please read that section of the wiki first.

This guide assumes you know the basics of using a bash terminal: ssh'ing into a server, running bash commands, editing text files, etc.

If you have no experience using bash, maybe start [https://www.howtogeek.com/140679/beginner-geek-how-to-start-using-the-linux-terminal/ here]. Editing text files via commandline is often a challenge. Suggest using nano and reading guide [https://www.howtogeek.com/howto/42980/the-beginners-guide-to-nano-the-linux-command-line-text-editor/ here]

If you are new to linux and accessing your server from Windows, highly suggest using MobaXterm as your SSH client as that can make required editing of text files easier using built in editor instead of the native linux command line editors.

And finally, ask yourself why you want to setup a server? If you look at the list, there are many, many more servers than players. If you don't have a team, discord community, or group of friends ready to play on your server, chances are it will go unused. Got one of these... great, let's go.

If you don't want to go through the hassle yourself and want to pay for a hosting service Arctic VR (PC and Shack) and Horde (Shack) provide a server hosting services and are trusted in the community. See links below.

----

=== Server Requirements ===

'''Pavlovserver can only be hosted under Linux.'''

This can be running as a VM under windows, but this will increase the complexity of the setup beyond this guide.

Ubuntu 18.04 x86_64, Ubuntu 19/04 amd64, Ubuntu 20.04, and Rocky Linux 8 are confirmed working. Ubuntu 15.04 x86 is known to fail to install using this guide. Recommend not running on "minimal" images as some tools are missing.

* 2GB RAM + 1GB RAM per each additional server with 10 players. More RAM is recommended for larger maps, higher player counts, or complex gamemodes. Not having enough RAM is a common cause of server crashes.

* A ~2.5Ghz CPU will comfortably support a 10 player server.

* A ~4Ghz CPU will comfortably support 24 players. This is a limit built into Pavlov itself, no server will allow players to join over 24. Lower player counts are recommended for complex gamemodes (E.g. CodZ) and/or highly detailed maps, so that maximum number will often be lower.

(Note that these are '''not''' hard limits for player counts, just suggestions for the best performance, based on experiences with many server providers on different grades of hardware.)

* Pavlovserver is functionally single threaded (one thread does vast majority of work). More CPUs only help if you are running more servers. More clockspeed = higher performance = more users per server.
The maximum number of servers you can run is dependent on how many CPUs you have. For example, if you have an 8 core CPU, the maximum number of servers would be 7. You should always have at least one CPU free as overhead, as Pavlov servers can use slightly more than one thread.

----

==== Hosting at home ====
When hosting at home there are additional requirements regarding networking: Your router has to support port-forwarding, hair-pinning/LoopbackNAT, and respond to ping requests. These techniques are necessary to allow your server to be found and to talk back to the client. please see https://en.wikipedia.org/wiki/Port_forwarding, https://en.wikipedia.org/wiki/Hairpinning, and https://www.speedguide.net/faq/how-to-become-pingable-behind-a-routerfirewall-376 for more info and google for these terms in addition to your router model to find guides on how to enable/configure it properly. If you have modern Router, it may have these features already enabled, in this case you just have to configure port-forwarding. If you can see your server but not join it while others can, this is indicative of a failure of LoopbackNAT.

A second challenge to hosting at home is CGNAT (Carrier grade NAT: https://www.a10networks.com/blog/carrier-grade-nat/). Just like NAT on your home network that has to be gotten around w/ port-forwarding, CGNAT breaks the ability of external connections to be made back to your server, but the controls are solely in your ISPs hands. Sometimes if you ask, you can be removed from CGNAT pools and/or assigned a static IP. CGNAT rollouts are becoming very common now, so if your server worked then doesn't allow connections now, your ISP may have made this change.

You can check whether you’re on a CGNAT network by visiting a Web site such as ipaddress.com or whatsmyip.com and comparing the IP address listed to the public/WAN IP address assigned to your Internet gateway. To find your gateway’s public IP address, check the status page in the administrative interface. If the two IP addresses differ, you’re likely on a CGNAT network. If so, this problem must be resolved before you go any further.

'''Not understanding these requirements and configuration is a frequent cause of failed setups and questions in discord. Don't skip this if you are trying to host from home'''

'''There are serious security implications of hosting this software at home.''' None of the devs are security experts and there has been no security review of the code. You are opening up your system to the world and publicity advertising this fact. Expect that any system hosting this software is open to compromise from the Internet and act accordingly. If your router offers a DMZ network, use it. Consider hosting on a cloud based server and think twice before running this software on any system that contains data you care about or has access to networks and computers you care about.

If you're hosting at home using Oracle's VirtualBox, there are steps you can take to prevent double NAT (which can cause issues later on)

1. Select your VM and then click Settings in VirtualBox's main window.

2. Click on Network and change Attached To from NAT to Bridged Adapter.

Once you've done this, your VM should be connected directly to your home router and double NAT should no longer be a issue.

----

==== Starting Server Install ====

====Obtaining an ApiKey====
For your server to show up in the server list, there is now a requirement to have an ApiKey issued by vankrupt. This is to prevent DOS attacks against the master server

Get the key by going here: https://pavlov-ms.vankrupt.com/servers/v1/key and using your mobile number to get a SMS
(note that there have been reported failures of this SMS system for non-US mobiles. In this case DM davevillz your mobile and ask for a key)

Put this key in your Game.ini as follows:
ApiKey="ABC123FALSEKEYDONTUSEME"
or if you would like (personally untested..I would use game.ini) you can call it at server runtime with flag as follows:
-KEY="ABC123FALSEKEYDONTUSEME"

This key can be re-used for a reasonable number of servers (a limit of 10 has been mentioned). Contact the Devs if you need more servers per key.

====System setup and software installation====

Install dependencies and create the `steam` user. (You only need to do this once):

Confirm Linux version
<pre>
lsb_release -a
</pre>

'''Ubuntu 20.04'''<blockquote>
'''''sudo apt update''''' && '''''sudo apt install''''' -y gdb curl lib32gcc1 libc++-dev unzip
sudo useradd -m steam
</blockquote>'''Ubuntu 20.10 or higher'''<blockquote>
sudo apt update && sudo apt install -y gdb curl lib32gcc-s1 libc++-dev unzip
sudo useradd -m steam
</blockquote>'''Rocky Linux, CentOS 8, and RHEL 8'''<blockquote>
sudo sed -i 's/^SELINUX=enforcing$/SELINUX=permissive/g' /etc/selinux/config
sudo setenforce 0
sudo yum install gdb curl glibc.i686 libstdc++.i686 libstdc++-devel.i686 libstdc++-devel.x86_64 unzip wget -y
wget <nowiki>https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/l/libcxx-3.8.0-3.el7.x86_64.rpm</nowiki>
sudo rpm -i libcxx-3.8.0-3.el7.x86_64.rpm
sudo useradd -m steam
</blockquote>[Optional] Set a password for steam.
<pre>sudo passwd steam</pre>

Login as the steam user. ('''You will need to do this each time you connect to your server'''):

<pre>
sudo su -l steam
</pre>

Install Steam:

<pre>
mkdir ~/Steam && cd ~/Steam && curl -sqL "https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz" | tar zxvf -
</pre>

There are different dedicated server versions for Pavlov Server - choose which server version you want to host (PC non-beta, PC Beta, Shack Live, or Shack RC)
(You will need to run this command each time there is a Pavlov Server update).

 
To host '''PC Server (non-beta)''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta default +exit
</pre>

To host '''PC BETA''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta beta_server +exit
</pre>

To host '''Shack Live''' (Quest):

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack +exit
</pre>

To host '''Shack RC''' (Quest): 

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack_beta +exit
</pre>

Now that we've installed the server, all pavlov server versions should continue. 
Install a fresh copy of steamclient.so (May have to do this after each update):
<pre>
~/Steam/steamcmd.sh +login anonymous +app_update 1007 +quit
mkdir -p ~/.steam/sdk64
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/pavlovserver/Pavlov/Binaries/Linux/steamclient.so
</pre>

The update 29 of the PCVR version of pavlov and after added a requirement to run these commands to change the steamclient.so:
<code>sudo rm /usr/lib/x86_64-linux-gnu/libc++.so</code>
<code>sudo ln -s /usr/lib/x86_64-linux-gnu/libc++.so.1 /usr/lib/x86_64-linux-gnu/libc++.so</code>

Make the PavlovServer script executable. (You only need to do this once):

<pre>
chmod +x ~/pavlovserver/PavlovServer.sh
</pre>

----

=== Server Configuration ===

Before starting the server we need to configure it. Start by creating some directories:

<pre>
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Logs
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps
</pre>

==== Mods/Blacklist/Whitelist (optional) ====

The following three files allow you to specify mods, banned players, and whitelist players. These are optional, but go ahead and create them. Populating the files is described later.

<pre>
touch /home/steam/pavlovserver/Pavlov/Saved/Config/mods.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/blacklist.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/whitelist.txt
</pre>

====Configuring Game.ini====
Create a new Game.ini file using following command to open an editor and copy/paste the following block into it then save it. Note not all of these options are required. For instance remove or comment out the Password=0000 line to make a public server with no pin.
<pre>
nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini
</pre>

<pre>
[/Script/Pavlov.DedicatedServer]
bEnabled=true
ServerName="My_private_idaho"
MaxPlayers=10 #Set this to 10 for Shack. 24 is the max for PC, setting it higher will not allow players to join.
ApiKey="ABC123FALSEKEYDONTUSEME"
bSecured=true
bCustomServer=true
bVerboseLogging=false
bCompetitive=false #This only works for SND
bWhitelist=false
RefreshListTime=120
LimitedAmmoType=0
TickRate=90
TimeLimit=60
#Password=0000
#BalanceTableURL="vankruptgames/BalancingTable/main"
MapRotation=(MapId="UGC1758245796", GameMode="GUN")
MapRotation=(MapId="datacenter", GameMode="SND")
MapRotation=(MapId="sand", GameMode="DM")

</pre>

* '''bEnabled''' - whether the server appears in the server list (unconfirmed)
* '''ServerName''' - name it will be listed as. (approx 35 chars max)
* '''MaxPlayers''' - See suggested specs for limits. 10 standard (10 for shack), 20-24 is max recommended for large maps like Stalingrad or PUSH/RUSH modes, and servers allow a maximum of 24 players.
* '''ApiKey''' - Unique ApiKey required to register server with master server. Replace with your key
* '''bSecured''' - enabled Valve Anti-Cheat (VAC)
* '''bCustomServer''' - activates some new modding tools (save and http functions. Required to write to blacklist.txt for bans)
* '''bCompetitive''' - sets the server to competitive mode for SND. If removed the server will default to false
* '''bVerboseLogging''' - enables verbose logging, mostly detailed statistics. Be prepared for significant increase in logging.
* '''bWhitelist''' - Only allow users in whitelist.txt to join
* '''RefreshListTime''' - sets how often the running server checks for updates in ban/whitelist/mod files
* '''LimitedAmmoType''' - sets limited ammo mode, see Limited Ammo Types table below

* '''TimeLimit''' - sets time limit for each map
* '''TickRate''' - sets the server tickrate. (so far minimum stable seems around 50 and max around 120. Beware setting this changes weapon despawn time and breaks some game modes. Recommend not touching)
* '''Password''' - PIN number for server #FYI - this is now also changeable via rcon.
* '''BalanceTableURL''' - Points to a custom balance table from github. See https://github.com/vankruptgames/BalancingTable for instructions. This line isn't needed if you don't have one.
* '''MapRotation''' - you can add multiple of these. The map system has switched from the steam workshop to modio which means that the server rotation will need to be redone with modio UGCs. <nowiki>https://mod.io/g/pavlov</nowiki>. This is done by taking the resource ID from the modio page, adding “UGC” in front of it and then adding that to the rotation. For example the map gravity <nowiki>https://mod.io/g/pavlov/m/gravity1</nowiki> has a resource ID of 2773760 so the map ID to add to the server would be “UGC2773760”. When a match ends, the server will load the next map in the rotation.
* '''AFKTimeLimit''' There is now a feature to kick players who are idle in the game. Integers are measured in seconds and 0 disables AFK kicking completely.

Available game modes as of 09/06/2022: See Game modes table below

For maps running a Custom gamemode (CodZ, BR, Duel, etc.) it doesn't matter which gamemode you choose, as the map will automatically override it with the custom mode.

{| class="wikitable"
|+Limited Ammo Types
!AmmoType
!Name
!Description
|-
|0
|Unlimited
|Players have unlimited ammo, carry no ammo boxes and do not display an ammo count on the wrist.
|-
|1
|Limited Generic
|Players carry ammo boxes with a limited amount of ammo.
One box for each weapon class (Pistol, Submachine gun, Rifles/MGs, Shotgun, Sniper).

Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.

An ammo count is displayed on the wrist.
|-
|2
|Limited Specific
|Players carry ammo boxes with a limited amount of ammo.
One box for each weapon.

Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.

An ammo count is displayed on the wrist.
|-
|3
|Custom
|Allows for full control over ammo by the map.
|-
|4
| Limited Special
|'''All weapons except "special" weapons are unlimited, more clarification is needed.'''
|-
|5
|Boxless
|'''Like limited generic but without boxes? Clarification is needed.'''
|}
{| class="wikitable"
|+Game modes
!GameMode
!Name
|-
|DM
|Death match
|-
|KOTH
|King of the hill
|-
|GUN
| Gun game
|-
|OITC
| One in the chamber
|-
|SND
|Search and destroy
|-
|TANKTDM
|WW2 Team Death Match
|-
| TDM
|Team Death Match
|-
|TTT
|Trouble in Terrorist Town
|-
|WW2GUN
|WW2 gun game
|-
|ZWV
| Zombie wave survival
|-
|HIDE
|The Hidden
|-
|INFECTION
|Hidden infection
|-
|PUSH
|Push
|-
|PH
|Prop hunt
|}
= Default Map ID's =
datacenter

sand

bridge

containeryard

siberia (Prison Break)

hospital (Zombies map)

killhouse

range

tutorial

santorini

station

industry

ogcontainers (Shack only)

haguenau (Shack only)

foundation (Shack only)

stalingrad (PC only)

stalingrad_night (PC only)

santorini_night (PC only)

sand_night (PC only)

station_night (PC only)

industry_night (PC only)

bunker (PC only)

==== Firewall/Port forwarding ====
Using the default settings there are two UDP ports (7777, 8177) that need to be allowed to access the server either by firewall setup or port forwarding.

'''Ubuntu''' firewall commands to check firewall and open ports:
<pre>
sudo ufw status
sudo ufw allow 7777
sudo ufw allow 8177
sudo ufw allow 9100
sudo ufw status
</pre>

'''Rocky Linux''' firewall commands to check firewall and open ports:
<pre>
sudo firewall-cmd --zone=public --add-port=7777/tcp
sudo firewall-cmd --zone=public --add-port=7777/udp
sudo firewall-cmd --zone=public --add-port=8177/tcp
sudo firewall-cmd --zone=public --add-port=8177/udp
sudo firewall-cmd --zone=public --add-port=9100/udp
sudo firewall-cmd --zone=public --add-port=9100/tcp
sudo firewall-cmd --list-ports
firewall-cmd --runtime-to-permanent
</pre>

You may also need to allow Pings (ICMP) for the server's true latency to appear in the master list.

If you are running multiple servers and have set additional ports (see http://wiki.pavlov-vr.com/index.php?title=Dedicated_server#Running_multiple_servers_on_one_host) then you need to allow access to the defined port plus the port 400 higher. So if you use 7000 as your port, then UDP 7000 and 7400 need to be open

If you have setup rcon via RconSettings.txt (below) then that port also need to be allowed access via TCP

If you are running Shack/Quest and want to have maps that are downloadable from your server, your server ports (ex. 7777 & 8177) must also be open via TCP

----

==== Shack Maps (Quest) ====

If you try to use the steps above to add maps for Shack, youll run into issues very quickly. This is because Shack has no affiliation to Steam, and therefore cannot use Steam Workshop maps like above. In the future, these steps will apply to PC servers as well, allowing a server to hold the map itself, instead of offloading to Steam.

To get started, first create the directory to hold the maps

<pre>mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps</pre>

You can use any number of methods to move the map files onto the server, but ill go over the two simplest, starting with a GUI approach

Download and install CyberDuck onto your "home" PC (Whatever PC you use for access to the server, but not the server itsself): https://cyberduck.io/

Next, download and unzip your map of choice from https://www.pavlovquest.com/ , https://pavlovhorde.com/mapsList, or look in #shack-map-showcase channel in the discord server. I'm going to use Cheeto's WW2 Items test (http://www.mediafire.com/file/emyt9bs1z9u9ykw/SVR_Cheeto_Items.zip/file ) for this example, you do what you like

In the top left corner, open a connection, set the connection type to SFTP, and fill in the rest of the information. User will be root, password is whatever you set the root pw as (toor in Ubuntu by default)

In the directory dropdown (itll say /root) go back to /

Follow the directories until we arrive back at our "maps" folder <pre>/home/steam/pavlovserver/Pavlov/Saved/maps</pre>

Drag and drop the unzipped map folder into the main window, in this case itll be SVR_Cheeto_Items

Hit Allow

Youll now see a folder named SVR_Cheeto_Items, and within it should be nothing but 3 files. If there is another folder in it, move this folder to the maps directory, otherwise the server wont work. The 3 files (2 .PAK one .JSON) should be in home/steam/pavlovserver/Pavlov/Saved/maps/SVR_Cheeto_Items, no more, no less.

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

To play the map, you can either use RCON switch map command, or to add the map to your servers automatic map rotation list, add the map's folder name to your Game.ini. This replaces the MapID section, so for our example it would be

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

And thats all! Disconnect CyberDuck from your server before playing, otherwise youll have difficulty joining.

-----------

==== Adding Shack Maps over Command Line Interface ====

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

A bit more complicated, but adding maps over CLI has its benefits

First, CD to the maps directory you made above

<pre>cd ~/pavlovserver/Pavlov/Saved/maps</pre>

Download the map files from whatever you use to upload them. To do this, you can either use curl or wget

<pre>curl -O insertURLhere</pre>

'''If you download your map from Google Drive''', make sure that your .zip folder is shared to anyone.
Then, get the file's url from the shared link. Example : ''<nowiki>https://drive.google.com/file/d/19bI8gUHaN5tUrDvnadAacUnchQf6_k/view</nowiki>'' will be ''19bI8gUHaN5tUrDvnadAacUnchQf6_k''
Edit "fileId" and "fileName" before you execute the command.
<pre>
fileId=19bI8gUHaN5tUrDvnadAacUnchQf6_k
fileName=SVR_USER_MAPNAME
curl -sc /tmp/cookie "https://drive.google.com/uc?export=download&id=${fileId}" > /dev/null
code="$(awk '/_warning_/ {print $NF}' /tmp/cookie)"
curl -Lb /tmp/cookie "https://drive.google.com/uc?export=download&confirm=${code}&id=${fileId}" -o ${fileName} </pre>

To keep with the Items example:

<pre>curl -O https://cdn.discordapp.com/attachments/744185280759857234/745027406695366788/SVR_Cheeto_Items.zip</pre>

Next, unzip the file. If this next step errors out, saying the command is unknown, switch back to the root user (su root), and install unzip (sudo apt install unzip), then return to the steam user, and continue.

<pre>unzip SVR_Cheeto_Items.zip</pre>

Now finish like before by adding the map to your Game.ini

<pre>nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini</pre>

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

==== Admin/Moderator list (optional) ====

The only working in-game admin menu is through Arctic VR server hosting (see below).

If you add moderators to your server, they will not be subject to vote kicks.

<pre>
nano ~/pavlovserver/Pavlov/Saved/Config/mods.txt
</pre>

Example Mod List:
<pre>
76541198397498572 #Optional Comment: Player name
76541198397498573 #Some Other Player
</pre>

==== ArcticVR Admin Menu ====

[[File:Arcticmenu.jpg|500px|link=https://www.arctic-vr.com/server-admin-menu]]

Arctic-VR Offers an advanced In-Game Admin menu that is exclusive to their hosting service. Features include:
* Switch Maps+Modes
* Teleport Players to Players
* Change Player Skins
* Control Player Buying+Cash
* Spawn Items
* Clean up corpses + guns
* Spawn Bots
* Spawn Items for other players
* Control Teams + Balance/Shuffle Teams
* ResetSND
* And More

You can read more about the ArcticVR admin menu on their website: https://www.arctic-vr.com/server-admin-menu

==== Handy tools for finding steamIDs ====

Steam ID finder: https://steamidfinder.com/lookup/ or https://steamid.xyz/

You want to enter in the steamID64 format.

This tool can convert or lookup IDs: https://steamid.io/

If you are looking for a steamID of a player that has been on your server recently this is technique to find them:
<pre>
grep -i playername ~/pavlovserver/Pavlov/Saved/Logs/* | grep TicketValidation
</pre>

=== Configure Rcon ===
To enable Rcon access create config file:
<pre> nano /home/steam/pavlovserver/Pavlov/Saved/Config/RconSettings.txt </pre>

Copy in the following text - change password, and if desired the port:
<pre>
Password=ChangeThisPassword
Port=9100
</pre>
You must specify a port for the Rcon server to use as well as a Password (use a different port per sever instance if running multiple server instances off the same hardware)

=== Starting the server ===

<pre>
cd ~/pavlovserver && ./PavlovServer.sh
</pre>

That's it, your server will be automatically broadcast to the master server! :)

Two handy tools to determine quickly if your server is broadcasting are [https://pablub.xyz/ Pablub] (PC only) and [https://pavlovhorde.com/ Horde] (Shack) and [https://pavlovhorde.com/pcServers Horde] (PC version)

Note that when you close your terminal, the server will go down. See the "supervisors" section below for how to prevent this.

----

=== Supervising the server using systemd ===

Running '''./PavlovServer.sh''' in your interactive shell is easy, but the server will shut down when you close your terminal. If you want to run the server in the background,
you'll want to run it under a supervisor. There are many options, ranging from the simple (nohup, screen or tmux), to the
more robust (supervisord, systemd).

Systemd is running by default on Ubuntu Linux, so we'll use that here.

To run the server as a systemd service, create the file '''/etc/systemd/system/pavlovserver.service''' (as root) by typing
<pre>
sudo nano /etc/systemd/system/pavlovserver.service
</pre>

Copy contents below into the file and save.

<pre>
[Unit]
Description=Pavlov VR dedicated server

[Service]
Type=simple
WorkingDirectory=/home/steam/pavlovserver
ExecStart=/home/steam/pavlovserver/PavlovServer.sh

RestartSec=1
Restart=always
User=steam
Group=steam

[Install]
WantedBy = multi-user.target
</pre>

If you'd like your server to start as competitive without editing the game.ini, change the line "ExecStart=/home/steam/pavlovserver/PavlovServer.sh" to look like this below. Though it's much easier to just use the game.ini to enable competitive instead. <pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -COMPETITIVE=1</pre>

Change the user or paths as appropriate. After saving the service file, to start, restart, stop, or monitor the server:

<pre>
sudo systemctl start pavlovserver
sudo systemctl restart pavlovserver
sudo systemctl stop pavlovserver
sudo systemctl status pavlovserver
</pre>

To view the logs:

<pre>
sudo journalctl -u pavlovserver
# to live-tail the logs
sudo journalctl -u pavlovserver -f
</pre>

If you want to run the pavlov server as soon as your server boots (e.g. a VPS you turn on and off), add pavlov as a startup service:

<pre>
sudo systemctl enable pavlovserver
</pre>

----

== Advanced Server Administration ==

=== Running multiple servers on one host ===

* Pavlovserver is functionally single threaded (there are multiple threads, but vast majority of work occurs in the primary one). Make sure you have # of pavlovservers + 1 CPU available. More CPUs= more servers. Faster CPU = more players.
* Make multiple server installs by defining a separate install dir for each server.
* Run each server with a unique port. eg: '''./PavlovServer.sh -PORT="Desired Port"'''
* The Server will use the Desired Port and the Port 400 above (Example: You choose 8200 as Port. So Port 8600 will be used as well)
* If you are using RCON, each server will need a unique port defined in RconSettings.txt
* Ensure the ports are forwarded and opened in your firewall

To duplicate directories:

be in the steam home folder
<pre>
cp -r pavlovserver pavlovserver1
/home/steam/pavlovserver1/PavlovServer.sh -PORT=[Desired Port]
</pre>

=== Starting server in competitive mode ===
Competitive mode will prevent dead teammates from being able to see the match, to prevent ghosting.
You can either enable this via Game.ini (described in Game.ini file), or using the -COMPETITIVE=1 parameter.

<pre>
/home/steam/pavlovserver1/PavlovServer.sh -COMPETITIVE=1
</pre>

{| class="wikitable"

|}

=== Useful Linux Commands ===
List files / folders in directory, print current working directory,
<pre>ls -la #list files/directories along with authorities and ownership
pwd #print working directory
sudo chown <owner> <file/directory> #change owner of file/directory. If root created something and you need to change it to steam
sudo chgrp <group> <file/directory> #change group of file/directory.
</pre>

Check if pavlov is running by checking process status. If the only row you see is the grep command, pavlov server is not started.
<pre> ps -ef | grep pav </pre>

Sample output:
<pre>
steam 34044 1 0 16:52 ? 00:00:00 /bin/sh /home/steam/pavlovserver/PavlovServer.sh
steam 34066 34044 80 16:52 ? 00:00:04 /home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer
zombies+ 34101 34013 0 16:52 pts/0 00:00:00 grep --color=auto pav
</pre>

Kill a process. Note this command uses 34044, which is a process id from the command output above.
<pre> kill -9 34044 </pre>

Dump the log to the console so you can scroll through it:
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log </pre>

Search the log for a string - replace my_string with case-sensitive string
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep my_string </pre>

<hr>

== Advanced Scripts For Server Management ==
<hr>

=== '''Auto-updating the server''' ===
Assuming you have followed this guide and used the default paths, users, and install instructions, you can paste the following into your terminal to auto-update your Pavlov server:

<pre>
cat << 'EOF' > $HOME/pavlov_daily_update_and_restart.sh
#!/bin/bash

USER="steam"
SERVICENAME="pavlovserver.service"
INSTALLDIRNAME="pavlovserver"
USERHOME="/home/$USER"

echo -e "Beginning Pavlov VR update run on $(date)\n\n"

systemctl stop "$SERVICENAME"

sleep 5
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +force_install_dir "$USERHOME/$INSTALLDIRNAME" +app_update 622970 +exit
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +app_update 1007 +quit
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/.steam/sdk64/steamclient.so"
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/pavlovserver/Pavlov/Binaries/Linux/steamclient.so"

systemctl start "$SERVICENAME"

echo -e "Ending Pavlov VR update run on $(date)\n\n"

EOF

chmod +x $HOME/pavlov_daily_update_and_restart.sh
mkdir $HOME/pavlov_update_logs && touch $HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log
CRONLINE="00 2 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
(sudo crontab -u root -l; echo "$CRONLINE" ) | sudo crontab -u root -
unset CRONLINE

</pre>

These commands will:

1. Create a shell script in the "steam" user's home directory that automatically stops the Pavlov server, pulls any updates via steam, pull updates to the Steamworks SDK Redist, and copies the latest version of steamclient.so to the Pavlov server directory

2. Make the shell script executable

3. Create a new directory called "pavlov_update_logs" in the "steam" user's directory, and create a logfile inside that directory called "pavlov_daily_update_and_restart.sh.log". You can check this logfile to see the output of the Pavlov and Steam SDK update commands.

4. Create a crontab entry for the root user that runs this shell script automatically every day at 2:00AM local time

If you want to change the time that this script runs, edit the numbers "00 2" in the line that starts with "CRONLINE=". In the example provided, 00 is the minutes column, and 2 is the hour column. For example, if you wanted the server to automatically update and restart at 4:17AM every day, change the line starting with "CRONLINE=" to:

<pre>
CRONLINE="17 4 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
</pre>

If the time is PM, use 24-hour time format, e.g. "32 18" for 6:32PM.
<hr>
=== '''Save Logs for records and stats''' ===
this is a automated script that will on a timer save all the backups made by the server before they are purged by the game for admin records and starts collection

https://github.com/JTWP-org/backUpLogs2

Setting up a dedicated server

2023-07-17T16:47:10Z

SaltedCrackerJack: /* Advanced Scripts For Server Management */

== Setting up a dedicated server ==

'''There are no Windows binaries'''

This guide is written exclusively for Linux and covers Ubuntu/Debian/Debian-like and Red Hat RPM-based distros. Possible to run with other distros, but some of the commands won't work and you will need to know enough to figure out the software install of dependencies on your own.

If you are considering hosting from home, please read that section of the wiki first.

This guide assumes you know the basics of using a bash terminal: ssh'ing into a server, running bash commands, editing text files, etc.

If you have no experience using bash, maybe start [https://www.howtogeek.com/140679/beginner-geek-how-to-start-using-the-linux-terminal/ here]. Editing text files via commandline is often a challenge. Suggest using nano and reading guide [https://www.howtogeek.com/howto/42980/the-beginners-guide-to-nano-the-linux-command-line-text-editor/ here]

If you are new to linux and accessing your server from Windows, highly suggest using MobaXterm as your SSH client as that can make required editing of text files easier using built in editor instead of the native linux command line editors.

And finally, ask yourself why you want to setup a server? If you look at the list, there are many, many more servers than players. If you don't have a team, discord community, or group of friends ready to play on your server, chances are it will go unused. Got one of these... great, let's go.

If you don't want to go through the hassle yourself and want to pay for a hosting service Arctic VR (PC and Shack) and Horde (Shack) provide a server hosting services and are trusted in the community. See links below.

----

=== Server Requirements ===

'''Pavlovserver can only be hosted under Linux.'''

This can be running as a VM under windows, but this will increase the complexity of the setup beyond this guide.

Ubuntu 18.04 x86_64, Ubuntu 19/04 amd64, Ubuntu 20.04, and Rocky Linux 8 are confirmed working. Ubuntu 15.04 x86 is known to fail to install using this guide. Recommend not running on "minimal" images as some tools are missing.

* 2GB RAM + 1GB RAM per each additional server with 10 players. More RAM is recommended for larger maps, higher player counts, or complex gamemodes. Not having enough RAM is a common cause of server crashes.

* A ~2.5Ghz CPU will comfortably support a 10 player server.

* A ~4Ghz CPU will comfortably support 24 players. This is a limit built into Pavlov itself, no server will allow players to join over 24. Lower player counts are recommended for complex gamemodes (E.g. CodZ) and/or highly detailed maps, so that maximum number will often be lower.

(Note that these are '''not''' hard limits for player counts, just suggestions for the best performance, based on experiences with many server providers on different grades of hardware.)

* Pavlovserver is functionally single threaded (one thread does vast majority of work). More CPUs only help if you are running more servers. More clockspeed = higher performance = more users per server.
The maximum number of servers you can run is dependent on how many CPUs you have. For example, if you have an 8 core CPU, the maximum number of servers would be 7. You should always have at least one CPU free as overhead, as Pavlov servers can use slightly more than one thread.

----

==== Hosting at home ====
When hosting at home there are additional requirements regarding networking: Your router has to support port-forwarding, hair-pinning/LoopbackNAT, and respond to ping requests. These techniques are necessary to allow your server to be found and to talk back to the client. please see https://en.wikipedia.org/wiki/Port_forwarding, https://en.wikipedia.org/wiki/Hairpinning, and https://www.speedguide.net/faq/how-to-become-pingable-behind-a-routerfirewall-376 for more info and google for these terms in addition to your router model to find guides on how to enable/configure it properly. If you have modern Router, it may have these features already enabled, in this case you just have to configure port-forwarding. If you can see your server but not join it while others can, this is indicative of a failure of LoopbackNAT.

A second challenge to hosting at home is CGNAT (Carrier grade NAT: https://www.a10networks.com/blog/carrier-grade-nat/). Just like NAT on your home network that has to be gotten around w/ port-forwarding, CGNAT breaks the ability of external connections to be made back to your server, but the controls are solely in your ISPs hands. Sometimes if you ask, you can be removed from CGNAT pools and/or assigned a static IP. CGNAT rollouts are becoming very common now, so if your server worked then doesn't allow connections now, your ISP may have made this change.

You can check whether you’re on a CGNAT network by visiting a Web site such as ipaddress.com or whatsmyip.com and comparing the IP address listed to the public/WAN IP address assigned to your Internet gateway. To find your gateway’s public IP address, check the status page in the administrative interface. If the two IP addresses differ, you’re likely on a CGNAT network. If so, this problem must be resolved before you go any further.

'''Not understanding these requirements and configuration is a frequent cause of failed setups and questions in discord. Don't skip this if you are trying to host from home'''

'''There are serious security implications of hosting this software at home.''' None of the devs are security experts and there has been no security review of the code. You are opening up your system to the world and publicity advertising this fact. Expect that any system hosting this software is open to compromise from the Internet and act accordingly. If your router offers a DMZ network, use it. Consider hosting on a cloud based server and think twice before running this software on any system that contains data you care about or has access to networks and computers you care about.

If you're hosting at home using Oracle's VirtualBox, there are steps you can take to prevent double NAT (which can cause issues later on)

1. Select your VM and then click Settings in VirtualBox's main window.

2. Click on Network and change Attached To from NAT to Bridged Adapter.

Once you've done this, your VM should be connected directly to your home router and double NAT should no longer be a issue.

----

==== Starting Server Install ====

====Obtaining an ApiKey====
For your server to show up in the server list, there is now a requirement to have an ApiKey issued by vankrupt. This is to prevent DOS attacks against the master server

Get the key by going here: https://pavlov-ms.vankrupt.com/servers/v1/key and using your mobile number to get a SMS
(note that there have been reported failures of this SMS system for non-US mobiles. In this case DM davevillz your mobile and ask for a key)

Put this key in your Game.ini as follows:
ApiKey="ABC123FALSEKEYDONTUSEME"
or if you would like (personally untested..I would use game.ini) you can call it at server runtime with flag as follows:
-KEY="ABC123FALSEKEYDONTUSEME"

This key can be re-used for a reasonable number of servers (a limit of 10 has been mentioned). Contact the Devs if you need more servers per key.

====System setup and software installation====

Install dependencies and create the `steam` user. (You only need to do this once):

Confirm Linux version
<pre>
lsb_release -a
</pre>

'''Ubuntu 20.04'''
<pre>
sudo apt update && sudo apt install -y gdb curl lib32gcc1 libc++-dev unzip
sudo useradd -m steam
</pre>

'''Ubuntu 20.10 or higher'''
<pre>
sudo apt update && sudo apt install -y gdb curl lib32gcc-s1 libc++-dev unzip
sudo useradd -m steam
</pre>

'''Rocky Linux, CentOS 8, and RHEL 8'''

<pre>
sudo sed -i 's/^SELINUX=enforcing$/SELINUX=permissive/g' /etc/selinux/config
sudo setenforce 0
sudo yum install gdb curl glibc.i686 libstdc++.i686 libstdc++-devel.i686 libstdc++-devel.x86_64 unzip wget -y
wget https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/l/libcxx-3.8.0-3.el7.x86_64.rpm
sudo rpm -i libcxx-3.8.0-3.el7.x86_64.rpm
sudo useradd -m steam
</pre>

[Optional] Set a password for steam.
<pre>sudo passwd steam</pre>

Login as the steam user. ('''You will need to do this each time you connect to your server'''):

<pre>
sudo su -l steam
</pre>

Install Steam:

<pre>
mkdir ~/Steam && cd ~/Steam && curl -sqL "https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz" | tar zxvf -
</pre>

There are different dedicated server versions for Pavlov Server - choose which server version you want to host (PC non-beta, PC Beta, Shack Live, or Shack RC)
(You will need to run this command each time there is a Pavlov Server update).

 
To host '''PC Server (non-beta)''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta default +exit
</pre>

To host '''PC BETA''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta beta_server +exit
</pre>

To host '''Shack Live''' (Quest):

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack +exit
</pre>

To host '''Shack RC''' (Quest): 

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack_beta +exit
</pre>

Now that we've installed the server, all pavlov server versions should continue. 
Install a fresh copy of steamclient.so (May have to do this after each update):
<pre>
~/Steam/steamcmd.sh +login anonymous +app_update 1007 +quit
mkdir -p ~/.steam/sdk64
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/pavlovserver/Pavlov/Binaries/Linux/steamclient.so
</pre>

The update 29 of the PCVR version of pavlov and after added a requirement to run these commands to change the steamclient.so:
<code>sudo rm /usr/lib/x86_64-linux-gnu/libc++.so</code>
<code>sudo ln -s /usr/lib/x86_64-linux-gnu/libc++.so.1 /usr/lib/x86_64-linux-gnu/libc++.so</code>

Make the PavlovServer script executable. (You only need to do this once):

<pre>
chmod +x ~/pavlovserver/PavlovServer.sh
</pre>

----

=== Server Configuration ===

Before starting the server we need to configure it. Start by creating some directories:

<pre>
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Logs
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps
</pre>

==== Mods/Blacklist/Whitelist (optional) ====

The following three files allow you to specify mods, banned players, and whitelist players. These are optional, but go ahead and create them. Populating the files is described later.

<pre>
touch /home/steam/pavlovserver/Pavlov/Saved/Config/mods.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/blacklist.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/whitelist.txt
</pre>

====Configuring Game.ini====
Create a new Game.ini file using following command to open an editor and copy/paste the following block into it then save it. Note not all of these options are required. For instance remove or comment out the Password=0000 line to make a public server with no pin.
<pre>
nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini
</pre>

<pre>
[/Script/Pavlov.DedicatedServer]
bEnabled=true
ServerName="My_private_idaho"
MaxPlayers=10 #Set this to 10 for Shack. 24 is the max for PC, setting it higher will not allow players to join.
ApiKey="ABC123FALSEKEYDONTUSEME"
bSecured=true
bCustomServer=true
bVerboseLogging=false
bCompetitive=false #This only works for SND
bWhitelist=false
RefreshListTime=120
LimitedAmmoType=0
TickRate=90
TimeLimit=60
#Password=0000
#BalanceTableURL="vankruptgames/BalancingTable/main"
MapRotation=(MapId="UGC1758245796", GameMode="GUN")
MapRotation=(MapId="datacenter", GameMode="SND")
MapRotation=(MapId="sand", GameMode="DM")

</pre>

* '''bEnabled''' - whether the server appears in the server list (unconfirmed)
* '''ServerName''' - name it will be listed as. (approx 35 chars max)
* '''MaxPlayers''' - See suggested specs for limits. 10 standard (10 for shack), 20-24 is max recommended for large maps like Stalingrad or PUSH/RUSH modes, and servers allow a maximum of 24 players.
* '''ApiKey''' - Unique ApiKey required to register server with master server. Replace with your key
* '''bSecured''' - enabled Valve Anti-Cheat (VAC)
* '''bCustomServer''' - activates some new modding tools (save and http functions. Required to write to blacklist.txt for bans)
* '''bCompetitive''' - sets the server to competitive mode for SND. If removed the server will default to false
* '''bVerboseLogging''' - enables verbose logging, mostly detailed statistics. Be prepared for significant increase in logging.
* '''bWhitelist''' - Only allow users in whitelist.txt to join
* '''RefreshListTime''' - sets how often the running server checks for updates in ban/whitelist/mod files
* '''LimitedAmmoType''' - sets limited ammo mode, see Limited Ammo Types table below

* '''TimeLimit''' - sets time limit for each map
* '''TickRate''' - sets the server tickrate. (so far minimum stable seems around 50 and max around 120. Beware setting this changes weapon despawn time and breaks some game modes. Recommend not touching)
* '''Password''' - PIN number for server #FYI - this is now also changeable via rcon.
* '''BalanceTableURL''' - Points to a custom balance table from github. See https://github.com/vankruptgames/BalancingTable for instructions. This line isn't needed if you don't have one.
* '''MapRotation''' - you can add multiple of these. The map system has switched from the steam workshop to modio which means that the server rotation will need to be redone with modio UGCs. <nowiki>https://mod.io/g/pavlov</nowiki>. This is done by taking the resource ID from the modio page, adding “UGC” in front of it and then adding that to the rotation. For example the map gravity <nowiki>https://mod.io/g/pavlov/m/gravity1</nowiki> has a resource ID of 2773760 so the map ID to add to the server would be “UGC2773760”. When a match ends, the server will load the next map in the rotation.
* '''AFKTimeLimit''' There is now a feature to kick players who are idle in the game. Integers are measured in seconds and 0 disables AFK kicking completely.

Available game modes as of 09/06/2022: See Game modes table below

For maps running a Custom gamemode (CodZ, BR, Duel, etc.) it doesn't matter which gamemode you choose, as the map will automatically override it with the custom mode.

{| class="wikitable"
|+Limited Ammo Types
!AmmoType
!Name
!Description
|-
|0
|Unlimited
|Players have unlimited ammo, carry no ammo boxes and do not display an ammo count on the wrist.
|-
|1
|Limited Generic
|Players carry ammo boxes with a limited amount of ammo.
One box for each weapon class (Pistol, Submachine gun, Rifles/MGs, Shotgun, Sniper).

Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.

An ammo count is displayed on the wrist.
|-
|2
|Limited Specific
|Players carry ammo boxes with a limited amount of ammo.
One box for each weapon.

Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.

An ammo count is displayed on the wrist.
|-
|3
|Custom
|Allows for full control over ammo by the map.
|-
|4
| Limited Special
|'''All weapons except "special" weapons are unlimited, more clarification is needed.'''
|-
|5
|Boxless
|'''Like limited generic but without boxes? Clarification is needed.'''
|}
{| class="wikitable"
|+Game modes
!GameMode
!Name
|-
|DM
|Death match
|-
|KOTH
|King of the hill
|-
|GUN
| Gun game
|-
|OITC
| One in the chamber
|-
|SND
|Search and destroy
|-
|TANKTDM
|WW2 Team Death Match
|-
| TDM
|Team Death Match
|-
|TTT
|Trouble in Terrorist Town
|-
|WW2GUN
|WW2 gun game
|-
|ZWV
| Zombie wave survival
|-
|HIDE
|The Hidden
|-
|INFECTION
|Hidden infection
|-
|PUSH
|Push
|-
|PH
|Prop hunt
|}
= Default Map ID's =
datacenter

sand

bridge

containeryard

siberia (Prison Break)

hospital (Zombies map)

killhouse

range

tutorial

santorini

station

industry

ogcontainers (Shack only)

haguenau (Shack only)

foundation (Shack only)

stalingrad (PC only)

stalingrad_night (PC only)

santorini_night (PC only)

sand_night (PC only)

station_night (PC only)

industry_night (PC only)

bunker (PC only)

==== Firewall/Port forwarding ====
Using the default settings there are two UDP ports (7777, 8177) that need to be allowed to access the server either by firewall setup or port forwarding.

'''Ubuntu''' firewall commands to check firewall and open ports:
<pre>
sudo ufw status
sudo ufw allow 7777
sudo ufw allow 8177
sudo ufw allow 9100
sudo ufw status
</pre>

'''Rocky Linux''' firewall commands to check firewall and open ports:
<pre>
sudo firewall-cmd --zone=public --add-port=7777/tcp
sudo firewall-cmd --zone=public --add-port=7777/udp
sudo firewall-cmd --zone=public --add-port=8177/tcp
sudo firewall-cmd --zone=public --add-port=8177/udp
sudo firewall-cmd --zone=public --add-port=9100/udp
sudo firewall-cmd --zone=public --add-port=9100/tcp
sudo firewall-cmd --list-ports
firewall-cmd --runtime-to-permanent
</pre>

You may also need to allow Pings (ICMP) for the server's true latency to appear in the master list.

If you are running multiple servers and have set additional ports (see http://wiki.pavlov-vr.com/index.php?title=Dedicated_server#Running_multiple_servers_on_one_host) then you need to allow access to the defined port plus the port 400 higher. So if you use 7000 as your port, then UDP 7000 and 7400 need to be open

If you have setup rcon via RconSettings.txt (below) then that port also need to be allowed access via TCP

If you are running Shack/Quest and want to have maps that are downloadable from your server, your server ports (ex. 7777 & 8177) must also be open via TCP

----

==== Shack Maps (Quest) ====

If you try to use the steps above to add maps for Shack, youll run into issues very quickly. This is because Shack has no affiliation to Steam, and therefore cannot use Steam Workshop maps like above. In the future, these steps will apply to PC servers as well, allowing a server to hold the map itself, instead of offloading to Steam.

To get started, first create the directory to hold the maps

<pre>mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps</pre>

You can use any number of methods to move the map files onto the server, but ill go over the two simplest, starting with a GUI approach

Download and install CyberDuck onto your "home" PC (Whatever PC you use for access to the server, but not the server itsself): https://cyberduck.io/

Next, download and unzip your map of choice from https://www.pavlovquest.com/ , https://pavlovhorde.com/mapsList, or look in #shack-map-showcase channel in the discord server. I'm going to use Cheeto's WW2 Items test (http://www.mediafire.com/file/emyt9bs1z9u9ykw/SVR_Cheeto_Items.zip/file ) for this example, you do what you like

In the top left corner, open a connection, set the connection type to SFTP, and fill in the rest of the information. User will be root, password is whatever you set the root pw as (toor in Ubuntu by default)

In the directory dropdown (itll say /root) go back to /

Follow the directories until we arrive back at our "maps" folder <pre>/home/steam/pavlovserver/Pavlov/Saved/maps</pre>

Drag and drop the unzipped map folder into the main window, in this case itll be SVR_Cheeto_Items

Hit Allow

Youll now see a folder named SVR_Cheeto_Items, and within it should be nothing but 3 files. If there is another folder in it, move this folder to the maps directory, otherwise the server wont work. The 3 files (2 .PAK one .JSON) should be in home/steam/pavlovserver/Pavlov/Saved/maps/SVR_Cheeto_Items, no more, no less.

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

To play the map, you can either use RCON switch map command, or to add the map to your servers automatic map rotation list, add the map's folder name to your Game.ini. This replaces the MapID section, so for our example it would be

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

And thats all! Disconnect CyberDuck from your server before playing, otherwise youll have difficulty joining.

-----------

==== Adding Shack Maps over Command Line Interface ====

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

A bit more complicated, but adding maps over CLI has its benefits

First, CD to the maps directory you made above

<pre>cd ~/pavlovserver/Pavlov/Saved/maps</pre>

Download the map files from whatever you use to upload them. To do this, you can either use curl or wget

<pre>curl -O insertURLhere</pre>

'''If you download your map from Google Drive''', make sure that your .zip folder is shared to anyone.
Then, get the file's url from the shared link. Example : ''<nowiki>https://drive.google.com/file/d/19bI8gUHaN5tUrDvnadAacUnchQf6_k/view</nowiki>'' will be ''19bI8gUHaN5tUrDvnadAacUnchQf6_k''
Edit "fileId" and "fileName" before you execute the command.
<pre>
fileId=19bI8gUHaN5tUrDvnadAacUnchQf6_k
fileName=SVR_USER_MAPNAME
curl -sc /tmp/cookie "https://drive.google.com/uc?export=download&id=${fileId}" > /dev/null
code="$(awk '/_warning_/ {print $NF}' /tmp/cookie)"
curl -Lb /tmp/cookie "https://drive.google.com/uc?export=download&confirm=${code}&id=${fileId}" -o ${fileName} </pre>

To keep with the Items example:

<pre>curl -O https://cdn.discordapp.com/attachments/744185280759857234/745027406695366788/SVR_Cheeto_Items.zip</pre>

Next, unzip the file. If this next step errors out, saying the command is unknown, switch back to the root user (su root), and install unzip (sudo apt install unzip), then return to the steam user, and continue.

<pre>unzip SVR_Cheeto_Items.zip</pre>

Now finish like before by adding the map to your Game.ini

<pre>nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini</pre>

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

==== Admin/Moderator list (optional) ====

The only working in-game admin menu is through Arctic VR server hosting (see below).

If you add moderators to your server, they will not be subject to vote kicks.

<pre>
nano ~/pavlovserver/Pavlov/Saved/Config/mods.txt
</pre>

Example Mod List:
<pre>
76541198397498572 #Optional Comment: Player name
76541198397498573 #Some Other Player
</pre>

==== ArcticVR Admin Menu ====

[[File:Arcticmenu.jpg|500px|link=https://www.arctic-vr.com/server-admin-menu]]

Arctic-VR Offers an advanced In-Game Admin menu that is exclusive to their hosting service. Features include:
* Switch Maps+Modes
* Teleport Players to Players
* Change Player Skins
* Control Player Buying+Cash
* Spawn Items
* Clean up corpses + guns
* Spawn Bots
* Spawn Items for other players
* Control Teams + Balance/Shuffle Teams
* ResetSND
* And More

You can read more about the ArcticVR admin menu on their website: https://www.arctic-vr.com/server-admin-menu

==== Handy tools for finding steamIDs ====

Steam ID finder: https://steamidfinder.com/lookup/ or https://steamid.xyz/

You want to enter in the steamID64 format.

This tool can convert or lookup IDs: https://steamid.io/

If you are looking for a steamID of a player that has been on your server recently this is technique to find them:
<pre>
grep -i playername ~/pavlovserver/Pavlov/Saved/Logs/* | grep TicketValidation
</pre>

=== Configure Rcon ===
To enable Rcon access create config file:
<pre> nano /home/steam/pavlovserver/Pavlov/Saved/Config/RconSettings.txt </pre>

Copy in the following text - change password, and if desired the port:
<pre>
Password=ChangeThisPassword
Port=9100
</pre>
You must specify a port for the Rcon server to use as well as a Password (use a different port per sever instance if running multiple server instances off the same hardware)

=== Starting the server ===

<pre>
cd ~/pavlovserver && ./PavlovServer.sh
</pre>

That's it, your server will be automatically broadcast to the master server! :)

Two handy tools to determine quickly if your server is broadcasting are [https://pablub.xyz/ Pablub] (PC only) and [https://pavlovhorde.com/ Horde] (Shack) and [https://pavlovhorde.com/pcServers Horde] (PC version)

Note that when you close your terminal, the server will go down. See the "supervisors" section below for how to prevent this.

----

=== Supervising the server using systemd ===

Running '''./PavlovServer.sh''' in your interactive shell is easy, but the server will shut down when you close your terminal. If you want to run the server in the background,
you'll want to run it under a supervisor. There are many options, ranging from the simple (nohup, screen or tmux), to the
more robust (supervisord, systemd).

Systemd is running by default on Ubuntu Linux, so we'll use that here.

To run the server as a systemd service, create the file '''/etc/systemd/system/pavlovserver.service''' (as root) by typing
<pre>
sudo nano /etc/systemd/system/pavlovserver.service
</pre>

Copy contents below into the file and save.

<pre>
[Unit]
Description=Pavlov VR dedicated server

[Service]
Type=simple
WorkingDirectory=/home/steam/pavlovserver
ExecStart=/home/steam/pavlovserver/PavlovServer.sh

RestartSec=1
Restart=always
User=steam
Group=steam

[Install]
WantedBy = multi-user.target
</pre>

If you'd like your server to start as competitive without editing the game.ini, change the line "ExecStart=/home/steam/pavlovserver/PavlovServer.sh" to look like this below. Though it's much easier to just use the game.ini to enable competitive instead. <pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -COMPETITIVE=1</pre>

Change the user or paths as appropriate. After saving the service file, to start, restart, stop, or monitor the server:

<pre>
sudo systemctl start pavlovserver
sudo systemctl restart pavlovserver
sudo systemctl stop pavlovserver
sudo systemctl status pavlovserver
</pre>

To view the logs:

<pre>
sudo journalctl -u pavlovserver
# to live-tail the logs
sudo journalctl -u pavlovserver -f
</pre>

If you want to run the pavlov server as soon as your server boots (e.g. a VPS you turn on and off), add pavlov as a startup service:

<pre>
sudo systemctl enable pavlovserver
</pre>

----

== Advanced Server Administration ==

=== Running multiple servers on one host ===

* Pavlovserver is functionally single threaded (there are multiple threads, but vast majority of work occurs in the primary one). Make sure you have # of pavlovservers + 1 CPU available. More CPUs= more servers. Faster CPU = more players.
* Make multiple server installs by defining a separate install dir for each server.
* Run each server with a unique port. eg: '''./PavlovServer.sh -PORT="Desired Port"'''
* The Server will use the Desired Port and the Port 400 above (Example: You choose 8200 as Port. So Port 8600 will be used as well)
* If you are using RCON, each server will need a unique port defined in RconSettings.txt
* Ensure the ports are forwarded and opened in your firewall

To duplicate directories:

be in the steam home folder
<pre>
cp -r pavlovserver pavlovserver1
/home/steam/pavlovserver1/PavlovServer.sh -PORT=[Desired Port]
</pre>

=== Starting server in competitive mode ===
Competitive mode will prevent dead teammates from being able to see the match, to prevent ghosting.
You can either enable this via Game.ini (described in Game.ini file), or using the -COMPETITIVE=1 parameter.

<pre>
/home/steam/pavlovserver1/PavlovServer.sh -COMPETITIVE=1
</pre>

{| class="wikitable"

|}

=== Useful Linux Commands ===
List files / folders in directory, print current working directory,
<pre>ls -la #list files/directories along with authorities and ownership
pwd #print working directory
sudo chown <owner> <file/directory> #change owner of file/directory. If root created something and you need to change it to steam
sudo chgrp <group> <file/directory> #change group of file/directory.
</pre>

Check if pavlov is running by checking process status. If the only row you see is the grep command, pavlov server is not started.
<pre> ps -ef | grep pav </pre>

Sample output:
<pre>
steam 34044 1 0 16:52 ? 00:00:00 /bin/sh /home/steam/pavlovserver/PavlovServer.sh
steam 34066 34044 80 16:52 ? 00:00:04 /home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer
zombies+ 34101 34013 0 16:52 pts/0 00:00:00 grep --color=auto pav
</pre>

Kill a process. Note this command uses 34044, which is a process id from the command output above.
<pre> kill -9 34044 </pre>

Dump the log to the console so you can scroll through it:
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log </pre>

Search the log for a string - replace my_string with case-sensitive string
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep my_string </pre>

<hr>

== Advanced Scripts For Server Management ==
<hr>

=== '''Auto-updating the server''' ===
Assuming you have followed this guide and used the default paths, users, and install instructions, you can paste the following into your terminal to auto-update your Pavlov server:

<pre>
cat << 'EOF' > $HOME/pavlov_daily_update_and_restart.sh
#!/bin/bash

USER="steam"
SERVICENAME="pavlovserver.service"
INSTALLDIRNAME="pavlovserver"
USERHOME="/home/$USER"

echo -e "Beginning Pavlov VR update run on $(date)\n\n"

systemctl stop "$SERVICENAME"

sleep 5
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +force_install_dir "$USERHOME/$INSTALLDIRNAME" +app_update 622970 +exit
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +app_update 1007 +quit
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/.steam/sdk64/steamclient.so"
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/pavlovserver/Pavlov/Binaries/Linux/steamclient.so"

systemctl start "$SERVICENAME"

echo -e "Ending Pavlov VR update run on $(date)\n\n"

EOF

chmod +x $HOME/pavlov_daily_update_and_restart.sh
mkdir $HOME/pavlov_update_logs && touch $HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log
CRONLINE="00 2 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
(sudo crontab -u root -l; echo "$CRONLINE" ) | sudo crontab -u root -
unset CRONLINE

</pre>

These commands will:

1. Create a shell script in the "steam" user's home directory that automatically stops the Pavlov server, pulls any updates via steam, pull updates to the Steamworks SDK Redist, and copies the latest version of steamclient.so to the Pavlov server directory

2. Make the shell script executable

3. Create a new directory called "pavlov_update_logs" in the "steam" user's directory, and create a logfile inside that directory called "pavlov_daily_update_and_restart.sh.log". You can check this logfile to see the output of the Pavlov and Steam SDK update commands.

4. Create a crontab entry for the root user that runs this shell script automatically every day at 2:00AM local time

If you want to change the time that this script runs, edit the numbers "00 2" in the line that starts with "CRONLINE=". In the example provided, 00 is the minutes column, and 2 is the hour column. For example, if you wanted the server to automatically update and restart at 4:17AM every day, change the line starting with "CRONLINE=" to:

<pre>
CRONLINE="17 4 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
</pre>

If the time is PM, use 24-hour time format, e.g. "32 18" for 6:32PM.
<hr>
=== '''Save Logs for records and stats''' ===
this is a automated script that will on a timer save all the backups made by the server before they are purged by the game for admin records and starts collection

https://github.com/JTWP-org/backUpLogs2

Setting up a dedicated server

2023-07-17T16:46:33Z

SaltedCrackerJack: /* Save Logs for records and stats */

== Setting up a dedicated server ==

'''There are no Windows binaries'''

This guide is written exclusively for Linux and covers Ubuntu/Debian/Debian-like and Red Hat RPM-based distros. Possible to run with other distros, but some of the commands won't work and you will need to know enough to figure out the software install of dependencies on your own.

If you are considering hosting from home, please read that section of the wiki first.

This guide assumes you know the basics of using a bash terminal: ssh'ing into a server, running bash commands, editing text files, etc.

If you have no experience using bash, maybe start [https://www.howtogeek.com/140679/beginner-geek-how-to-start-using-the-linux-terminal/ here]. Editing text files via commandline is often a challenge. Suggest using nano and reading guide [https://www.howtogeek.com/howto/42980/the-beginners-guide-to-nano-the-linux-command-line-text-editor/ here]

If you are new to linux and accessing your server from Windows, highly suggest using MobaXterm as your SSH client as that can make required editing of text files easier using built in editor instead of the native linux command line editors.

And finally, ask yourself why you want to setup a server? If you look at the list, there are many, many more servers than players. If you don't have a team, discord community, or group of friends ready to play on your server, chances are it will go unused. Got one of these... great, let's go.

If you don't want to go through the hassle yourself and want to pay for a hosting service Arctic VR (PC and Shack) and Horde (Shack) provide a server hosting services and are trusted in the community. See links below.

----

=== Server Requirements ===

'''Pavlovserver can only be hosted under Linux.'''

This can be running as a VM under windows, but this will increase the complexity of the setup beyond this guide.

Ubuntu 18.04 x86_64, Ubuntu 19/04 amd64, Ubuntu 20.04, and Rocky Linux 8 are confirmed working. Ubuntu 15.04 x86 is known to fail to install using this guide. Recommend not running on "minimal" images as some tools are missing.

* 2GB RAM + 1GB RAM per each additional server with 10 players. More RAM is recommended for larger maps, higher player counts, or complex gamemodes. Not having enough RAM is a common cause of server crashes.

* A ~2.5Ghz CPU will comfortably support a 10 player server.

* A ~4Ghz CPU will comfortably support 24 players. This is a limit built into Pavlov itself, no server will allow players to join over 24. Lower player counts are recommended for complex gamemodes (E.g. CodZ) and/or highly detailed maps, so that maximum number will often be lower.

(Note that these are '''not''' hard limits for player counts, just suggestions for the best performance, based on experiences with many server providers on different grades of hardware.)

* Pavlovserver is functionally single threaded (one thread does vast majority of work). More CPUs only help if you are running more servers. More clockspeed = higher performance = more users per server.
The maximum number of servers you can run is dependent on how many CPUs you have. For example, if you have an 8 core CPU, the maximum number of servers would be 7. You should always have at least one CPU free as overhead, as Pavlov servers can use slightly more than one thread.

----

==== Hosting at home ====
When hosting at home there are additional requirements regarding networking: Your router has to support port-forwarding, hair-pinning/LoopbackNAT, and respond to ping requests. These techniques are necessary to allow your server to be found and to talk back to the client. please see https://en.wikipedia.org/wiki/Port_forwarding, https://en.wikipedia.org/wiki/Hairpinning, and https://www.speedguide.net/faq/how-to-become-pingable-behind-a-routerfirewall-376 for more info and google for these terms in addition to your router model to find guides on how to enable/configure it properly. If you have modern Router, it may have these features already enabled, in this case you just have to configure port-forwarding. If you can see your server but not join it while others can, this is indicative of a failure of LoopbackNAT.

A second challenge to hosting at home is CGNAT (Carrier grade NAT: https://www.a10networks.com/blog/carrier-grade-nat/). Just like NAT on your home network that has to be gotten around w/ port-forwarding, CGNAT breaks the ability of external connections to be made back to your server, but the controls are solely in your ISPs hands. Sometimes if you ask, you can be removed from CGNAT pools and/or assigned a static IP. CGNAT rollouts are becoming very common now, so if your server worked then doesn't allow connections now, your ISP may have made this change.

You can check whether you’re on a CGNAT network by visiting a Web site such as ipaddress.com or whatsmyip.com and comparing the IP address listed to the public/WAN IP address assigned to your Internet gateway. To find your gateway’s public IP address, check the status page in the administrative interface. If the two IP addresses differ, you’re likely on a CGNAT network. If so, this problem must be resolved before you go any further.

'''Not understanding these requirements and configuration is a frequent cause of failed setups and questions in discord. Don't skip this if you are trying to host from home'''

'''There are serious security implications of hosting this software at home.''' None of the devs are security experts and there has been no security review of the code. You are opening up your system to the world and publicity advertising this fact. Expect that any system hosting this software is open to compromise from the Internet and act accordingly. If your router offers a DMZ network, use it. Consider hosting on a cloud based server and think twice before running this software on any system that contains data you care about or has access to networks and computers you care about.

If you're hosting at home using Oracle's VirtualBox, there are steps you can take to prevent double NAT (which can cause issues later on)

1. Select your VM and then click Settings in VirtualBox's main window.

2. Click on Network and change Attached To from NAT to Bridged Adapter.

Once you've done this, your VM should be connected directly to your home router and double NAT should no longer be a issue.

----

==== Starting Server Install ====

====Obtaining an ApiKey====
For your server to show up in the server list, there is now a requirement to have an ApiKey issued by vankrupt. This is to prevent DOS attacks against the master server

Get the key by going here: https://pavlov-ms.vankrupt.com/servers/v1/key and using your mobile number to get a SMS
(note that there have been reported failures of this SMS system for non-US mobiles. In this case DM davevillz your mobile and ask for a key)

Put this key in your Game.ini as follows:
ApiKey="ABC123FALSEKEYDONTUSEME"
or if you would like (personally untested..I would use game.ini) you can call it at server runtime with flag as follows:
-KEY="ABC123FALSEKEYDONTUSEME"

This key can be re-used for a reasonable number of servers (a limit of 10 has been mentioned). Contact the Devs if you need more servers per key.

====System setup and software installation====

Install dependencies and create the `steam` user. (You only need to do this once):

Confirm Linux version
<pre>
lsb_release -a
</pre>

'''Ubuntu 20.04'''
<pre>
sudo apt update && sudo apt install -y gdb curl lib32gcc1 libc++-dev unzip
sudo useradd -m steam
</pre>

'''Ubuntu 20.10 or higher'''
<pre>
sudo apt update && sudo apt install -y gdb curl lib32gcc-s1 libc++-dev unzip
sudo useradd -m steam
</pre>

'''Rocky Linux, CentOS 8, and RHEL 8'''

<pre>
sudo sed -i 's/^SELINUX=enforcing$/SELINUX=permissive/g' /etc/selinux/config
sudo setenforce 0
sudo yum install gdb curl glibc.i686 libstdc++.i686 libstdc++-devel.i686 libstdc++-devel.x86_64 unzip wget -y
wget https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/l/libcxx-3.8.0-3.el7.x86_64.rpm
sudo rpm -i libcxx-3.8.0-3.el7.x86_64.rpm
sudo useradd -m steam
</pre>

[Optional] Set a password for steam.
<pre>sudo passwd steam</pre>

Login as the steam user. ('''You will need to do this each time you connect to your server'''):

<pre>
sudo su -l steam
</pre>

Install Steam:

<pre>
mkdir ~/Steam && cd ~/Steam && curl -sqL "https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz" | tar zxvf -
</pre>

There are different dedicated server versions for Pavlov Server - choose which server version you want to host (PC non-beta, PC Beta, Shack Live, or Shack RC)
(You will need to run this command each time there is a Pavlov Server update).

 
To host '''PC Server (non-beta)''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta default +exit
</pre>

To host '''PC BETA''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta beta_server +exit
</pre>

To host '''Shack Live''' (Quest):

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack +exit
</pre>

To host '''Shack RC''' (Quest): 

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack_beta +exit
</pre>

Now that we've installed the server, all pavlov server versions should continue. 
Install a fresh copy of steamclient.so (May have to do this after each update):
<pre>
~/Steam/steamcmd.sh +login anonymous +app_update 1007 +quit
mkdir -p ~/.steam/sdk64
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/pavlovserver/Pavlov/Binaries/Linux/steamclient.so
</pre>

The update 29 of the PCVR version of pavlov and after added a requirement to run these commands to change the steamclient.so:
<code>sudo rm /usr/lib/x86_64-linux-gnu/libc++.so</code>
<code>sudo ln -s /usr/lib/x86_64-linux-gnu/libc++.so.1 /usr/lib/x86_64-linux-gnu/libc++.so</code>

Make the PavlovServer script executable. (You only need to do this once):

<pre>
chmod +x ~/pavlovserver/PavlovServer.sh
</pre>

----

=== Server Configuration ===

Before starting the server we need to configure it. Start by creating some directories:

<pre>
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Logs
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps
</pre>

==== Mods/Blacklist/Whitelist (optional) ====

The following three files allow you to specify mods, banned players, and whitelist players. These are optional, but go ahead and create them. Populating the files is described later.

<pre>
touch /home/steam/pavlovserver/Pavlov/Saved/Config/mods.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/blacklist.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/whitelist.txt
</pre>

====Configuring Game.ini====
Create a new Game.ini file using following command to open an editor and copy/paste the following block into it then save it. Note not all of these options are required. For instance remove or comment out the Password=0000 line to make a public server with no pin.
<pre>
nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini
</pre>

<pre>
[/Script/Pavlov.DedicatedServer]
bEnabled=true
ServerName="My_private_idaho"
MaxPlayers=10 #Set this to 10 for Shack. 24 is the max for PC, setting it higher will not allow players to join.
ApiKey="ABC123FALSEKEYDONTUSEME"
bSecured=true
bCustomServer=true
bVerboseLogging=false
bCompetitive=false #This only works for SND
bWhitelist=false
RefreshListTime=120
LimitedAmmoType=0
TickRate=90
TimeLimit=60
#Password=0000
#BalanceTableURL="vankruptgames/BalancingTable/main"
MapRotation=(MapId="UGC1758245796", GameMode="GUN")
MapRotation=(MapId="datacenter", GameMode="SND")
MapRotation=(MapId="sand", GameMode="DM")

</pre>

* '''bEnabled''' - whether the server appears in the server list (unconfirmed)
* '''ServerName''' - name it will be listed as. (approx 35 chars max)
* '''MaxPlayers''' - See suggested specs for limits. 10 standard (10 for shack), 20-24 is max recommended for large maps like Stalingrad or PUSH/RUSH modes, and servers allow a maximum of 24 players.
* '''ApiKey''' - Unique ApiKey required to register server with master server. Replace with your key
* '''bSecured''' - enabled Valve Anti-Cheat (VAC)
* '''bCustomServer''' - activates some new modding tools (save and http functions. Required to write to blacklist.txt for bans)
* '''bCompetitive''' - sets the server to competitive mode for SND. If removed the server will default to false
* '''bVerboseLogging''' - enables verbose logging, mostly detailed statistics. Be prepared for significant increase in logging.
* '''bWhitelist''' - Only allow users in whitelist.txt to join
* '''RefreshListTime''' - sets how often the running server checks for updates in ban/whitelist/mod files
* '''LimitedAmmoType''' - sets limited ammo mode, see Limited Ammo Types table below

* '''TimeLimit''' - sets time limit for each map
* '''TickRate''' - sets the server tickrate. (so far minimum stable seems around 50 and max around 120. Beware setting this changes weapon despawn time and breaks some game modes. Recommend not touching)
* '''Password''' - PIN number for server #FYI - this is now also changeable via rcon.
* '''BalanceTableURL''' - Points to a custom balance table from github. See https://github.com/vankruptgames/BalancingTable for instructions. This line isn't needed if you don't have one.
* '''MapRotation''' - you can add multiple of these. The map system has switched from the steam workshop to modio which means that the server rotation will need to be redone with modio UGCs. <nowiki>https://mod.io/g/pavlov</nowiki>. This is done by taking the resource ID from the modio page, adding “UGC” in front of it and then adding that to the rotation. For example the map gravity <nowiki>https://mod.io/g/pavlov/m/gravity1</nowiki> has a resource ID of 2773760 so the map ID to add to the server would be “UGC2773760”. When a match ends, the server will load the next map in the rotation.
* '''AFKTimeLimit''' There is now a feature to kick players who are idle in the game. Integers are measured in seconds and 0 disables AFK kicking completely.

Available game modes as of 09/06/2022: See Game modes table below

For maps running a Custom gamemode (CodZ, BR, Duel, etc.) it doesn't matter which gamemode you choose, as the map will automatically override it with the custom mode.

{| class="wikitable"
|+Limited Ammo Types
!AmmoType
!Name
!Description
|-
|0
|Unlimited
|Players have unlimited ammo, carry no ammo boxes and do not display an ammo count on the wrist.
|-
|1
|Limited Generic
|Players carry ammo boxes with a limited amount of ammo.
One box for each weapon class (Pistol, Submachine gun, Rifles/MGs, Shotgun, Sniper).

Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.

An ammo count is displayed on the wrist.
|-
|2
|Limited Specific
|Players carry ammo boxes with a limited amount of ammo.
One box for each weapon.

Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.

An ammo count is displayed on the wrist.
|-
|3
|Custom
|Allows for full control over ammo by the map.
|-
|4
| Limited Special
|'''All weapons except "special" weapons are unlimited, more clarification is needed.'''
|-
|5
|Boxless
|'''Like limited generic but without boxes? Clarification is needed.'''
|}
{| class="wikitable"
|+Game modes
!GameMode
!Name
|-
|DM
|Death match
|-
|KOTH
|King of the hill
|-
|GUN
| Gun game
|-
|OITC
| One in the chamber
|-
|SND
|Search and destroy
|-
|TANKTDM
|WW2 Team Death Match
|-
| TDM
|Team Death Match
|-
|TTT
|Trouble in Terrorist Town
|-
|WW2GUN
|WW2 gun game
|-
|ZWV
| Zombie wave survival
|-
|HIDE
|The Hidden
|-
|INFECTION
|Hidden infection
|-
|PUSH
|Push
|-
|PH
|Prop hunt
|}
= Default Map ID's =
datacenter

sand

bridge

containeryard

siberia (Prison Break)

hospital (Zombies map)

killhouse

range

tutorial

santorini

station

industry

ogcontainers (Shack only)

haguenau (Shack only)

foundation (Shack only)

stalingrad (PC only)

stalingrad_night (PC only)

santorini_night (PC only)

sand_night (PC only)

station_night (PC only)

industry_night (PC only)

bunker (PC only)

==== Firewall/Port forwarding ====
Using the default settings there are two UDP ports (7777, 8177) that need to be allowed to access the server either by firewall setup or port forwarding.

'''Ubuntu''' firewall commands to check firewall and open ports:
<pre>
sudo ufw status
sudo ufw allow 7777
sudo ufw allow 8177
sudo ufw allow 9100
sudo ufw status
</pre>

'''Rocky Linux''' firewall commands to check firewall and open ports:
<pre>
sudo firewall-cmd --zone=public --add-port=7777/tcp
sudo firewall-cmd --zone=public --add-port=7777/udp
sudo firewall-cmd --zone=public --add-port=8177/tcp
sudo firewall-cmd --zone=public --add-port=8177/udp
sudo firewall-cmd --zone=public --add-port=9100/udp
sudo firewall-cmd --zone=public --add-port=9100/tcp
sudo firewall-cmd --list-ports
firewall-cmd --runtime-to-permanent
</pre>

You may also need to allow Pings (ICMP) for the server's true latency to appear in the master list.

If you are running multiple servers and have set additional ports (see http://wiki.pavlov-vr.com/index.php?title=Dedicated_server#Running_multiple_servers_on_one_host) then you need to allow access to the defined port plus the port 400 higher. So if you use 7000 as your port, then UDP 7000 and 7400 need to be open

If you have setup rcon via RconSettings.txt (below) then that port also need to be allowed access via TCP

If you are running Shack/Quest and want to have maps that are downloadable from your server, your server ports (ex. 7777 & 8177) must also be open via TCP

----

==== Shack Maps (Quest) ====

If you try to use the steps above to add maps for Shack, youll run into issues very quickly. This is because Shack has no affiliation to Steam, and therefore cannot use Steam Workshop maps like above. In the future, these steps will apply to PC servers as well, allowing a server to hold the map itself, instead of offloading to Steam.

To get started, first create the directory to hold the maps

<pre>mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps</pre>

You can use any number of methods to move the map files onto the server, but ill go over the two simplest, starting with a GUI approach

Download and install CyberDuck onto your "home" PC (Whatever PC you use for access to the server, but not the server itsself): https://cyberduck.io/

Next, download and unzip your map of choice from https://www.pavlovquest.com/ , https://pavlovhorde.com/mapsList, or look in #shack-map-showcase channel in the discord server. I'm going to use Cheeto's WW2 Items test (http://www.mediafire.com/file/emyt9bs1z9u9ykw/SVR_Cheeto_Items.zip/file ) for this example, you do what you like

In the top left corner, open a connection, set the connection type to SFTP, and fill in the rest of the information. User will be root, password is whatever you set the root pw as (toor in Ubuntu by default)

In the directory dropdown (itll say /root) go back to /

Follow the directories until we arrive back at our "maps" folder <pre>/home/steam/pavlovserver/Pavlov/Saved/maps</pre>

Drag and drop the unzipped map folder into the main window, in this case itll be SVR_Cheeto_Items

Hit Allow

Youll now see a folder named SVR_Cheeto_Items, and within it should be nothing but 3 files. If there is another folder in it, move this folder to the maps directory, otherwise the server wont work. The 3 files (2 .PAK one .JSON) should be in home/steam/pavlovserver/Pavlov/Saved/maps/SVR_Cheeto_Items, no more, no less.

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

To play the map, you can either use RCON switch map command, or to add the map to your servers automatic map rotation list, add the map's folder name to your Game.ini. This replaces the MapID section, so for our example it would be

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

And thats all! Disconnect CyberDuck from your server before playing, otherwise youll have difficulty joining.

-----------

==== Adding Shack Maps over Command Line Interface ====

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

A bit more complicated, but adding maps over CLI has its benefits

First, CD to the maps directory you made above

<pre>cd ~/pavlovserver/Pavlov/Saved/maps</pre>

Download the map files from whatever you use to upload them. To do this, you can either use curl or wget

<pre>curl -O insertURLhere</pre>

'''If you download your map from Google Drive''', make sure that your .zip folder is shared to anyone.
Then, get the file's url from the shared link. Example : ''<nowiki>https://drive.google.com/file/d/19bI8gUHaN5tUrDvnadAacUnchQf6_k/view</nowiki>'' will be ''19bI8gUHaN5tUrDvnadAacUnchQf6_k''
Edit "fileId" and "fileName" before you execute the command.
<pre>
fileId=19bI8gUHaN5tUrDvnadAacUnchQf6_k
fileName=SVR_USER_MAPNAME
curl -sc /tmp/cookie "https://drive.google.com/uc?export=download&id=${fileId}" > /dev/null
code="$(awk '/_warning_/ {print $NF}' /tmp/cookie)"
curl -Lb /tmp/cookie "https://drive.google.com/uc?export=download&confirm=${code}&id=${fileId}" -o ${fileName} </pre>

To keep with the Items example:

<pre>curl -O https://cdn.discordapp.com/attachments/744185280759857234/745027406695366788/SVR_Cheeto_Items.zip</pre>

Next, unzip the file. If this next step errors out, saying the command is unknown, switch back to the root user (su root), and install unzip (sudo apt install unzip), then return to the steam user, and continue.

<pre>unzip SVR_Cheeto_Items.zip</pre>

Now finish like before by adding the map to your Game.ini

<pre>nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini</pre>

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

==== Admin/Moderator list (optional) ====

The only working in-game admin menu is through Arctic VR server hosting (see below).

If you add moderators to your server, they will not be subject to vote kicks.

<pre>
nano ~/pavlovserver/Pavlov/Saved/Config/mods.txt
</pre>

Example Mod List:
<pre>
76541198397498572 #Optional Comment: Player name
76541198397498573 #Some Other Player
</pre>

==== ArcticVR Admin Menu ====

[[File:Arcticmenu.jpg|500px|link=https://www.arctic-vr.com/server-admin-menu]]

Arctic-VR Offers an advanced In-Game Admin menu that is exclusive to their hosting service. Features include:
* Switch Maps+Modes
* Teleport Players to Players
* Change Player Skins
* Control Player Buying+Cash
* Spawn Items
* Clean up corpses + guns
* Spawn Bots
* Spawn Items for other players
* Control Teams + Balance/Shuffle Teams
* ResetSND
* And More

You can read more about the ArcticVR admin menu on their website: https://www.arctic-vr.com/server-admin-menu

==== Handy tools for finding steamIDs ====

Steam ID finder: https://steamidfinder.com/lookup/ or https://steamid.xyz/

You want to enter in the steamID64 format.

This tool can convert or lookup IDs: https://steamid.io/

If you are looking for a steamID of a player that has been on your server recently this is technique to find them:
<pre>
grep -i playername ~/pavlovserver/Pavlov/Saved/Logs/* | grep TicketValidation
</pre>

=== Configure Rcon ===
To enable Rcon access create config file:
<pre> nano /home/steam/pavlovserver/Pavlov/Saved/Config/RconSettings.txt </pre>

Copy in the following text - change password, and if desired the port:
<pre>
Password=ChangeThisPassword
Port=9100
</pre>
You must specify a port for the Rcon server to use as well as a Password (use a different port per sever instance if running multiple server instances off the same hardware)

=== Starting the server ===

<pre>
cd ~/pavlovserver && ./PavlovServer.sh
</pre>

That's it, your server will be automatically broadcast to the master server! :)

Two handy tools to determine quickly if your server is broadcasting are [https://pablub.xyz/ Pablub] (PC only) and [https://pavlovhorde.com/ Horde] (Shack) and [https://pavlovhorde.com/pcServers Horde] (PC version)

Note that when you close your terminal, the server will go down. See the "supervisors" section below for how to prevent this.

----

=== Supervising the server using systemd ===

Running '''./PavlovServer.sh''' in your interactive shell is easy, but the server will shut down when you close your terminal. If you want to run the server in the background,
you'll want to run it under a supervisor. There are many options, ranging from the simple (nohup, screen or tmux), to the
more robust (supervisord, systemd).

Systemd is running by default on Ubuntu Linux, so we'll use that here.

To run the server as a systemd service, create the file '''/etc/systemd/system/pavlovserver.service''' (as root) by typing
<pre>
sudo nano /etc/systemd/system/pavlovserver.service
</pre>

Copy contents below into the file and save.

<pre>
[Unit]
Description=Pavlov VR dedicated server

[Service]
Type=simple
WorkingDirectory=/home/steam/pavlovserver
ExecStart=/home/steam/pavlovserver/PavlovServer.sh

RestartSec=1
Restart=always
User=steam
Group=steam

[Install]
WantedBy = multi-user.target
</pre>

If you'd like your server to start as competitive without editing the game.ini, change the line "ExecStart=/home/steam/pavlovserver/PavlovServer.sh" to look like this below. Though it's much easier to just use the game.ini to enable competitive instead. <pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -COMPETITIVE=1</pre>

Change the user or paths as appropriate. After saving the service file, to start, restart, stop, or monitor the server:

<pre>
sudo systemctl start pavlovserver
sudo systemctl restart pavlovserver
sudo systemctl stop pavlovserver
sudo systemctl status pavlovserver
</pre>

To view the logs:

<pre>
sudo journalctl -u pavlovserver
# to live-tail the logs
sudo journalctl -u pavlovserver -f
</pre>

If you want to run the pavlov server as soon as your server boots (e.g. a VPS you turn on and off), add pavlov as a startup service:

<pre>
sudo systemctl enable pavlovserver
</pre>

----

== Advanced Server Administration ==

=== Running multiple servers on one host ===

* Pavlovserver is functionally single threaded (there are multiple threads, but vast majority of work occurs in the primary one). Make sure you have # of pavlovservers + 1 CPU available. More CPUs= more servers. Faster CPU = more players.
* Make multiple server installs by defining a separate install dir for each server.
* Run each server with a unique port. eg: '''./PavlovServer.sh -PORT="Desired Port"'''
* The Server will use the Desired Port and the Port 400 above (Example: You choose 8200 as Port. So Port 8600 will be used as well)
* If you are using RCON, each server will need a unique port defined in RconSettings.txt
* Ensure the ports are forwarded and opened in your firewall

To duplicate directories:

be in the steam home folder
<pre>
cp -r pavlovserver pavlovserver1
/home/steam/pavlovserver1/PavlovServer.sh -PORT=[Desired Port]
</pre>

=== Starting server in competitive mode ===
Competitive mode will prevent dead teammates from being able to see the match, to prevent ghosting.
You can either enable this via Game.ini (described in Game.ini file), or using the -COMPETITIVE=1 parameter.

<pre>
/home/steam/pavlovserver1/PavlovServer.sh -COMPETITIVE=1
</pre>

{| class="wikitable"

|}

=== Useful Linux Commands ===
List files / folders in directory, print current working directory,
<pre>ls -la #list files/directories along with authorities and ownership
pwd #print working directory
sudo chown <owner> <file/directory> #change owner of file/directory. If root created something and you need to change it to steam
sudo chgrp <group> <file/directory> #change group of file/directory.
</pre>

Check if pavlov is running by checking process status. If the only row you see is the grep command, pavlov server is not started.
<pre> ps -ef | grep pav </pre>

Sample output:
<pre>
steam 34044 1 0 16:52 ? 00:00:00 /bin/sh /home/steam/pavlovserver/PavlovServer.sh
steam 34066 34044 80 16:52 ? 00:00:04 /home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer
zombies+ 34101 34013 0 16:52 pts/0 00:00:00 grep --color=auto pav
</pre>

Kill a process. Note this command uses 34044, which is a process id from the command output above.
<pre> kill -9 34044 </pre>

Dump the log to the console so you can scroll through it:
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log </pre>

Search the log for a string - replace my_string with case-sensitive string
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep my_string </pre>

<hr>
=== Advanced Scripts For Server Management ===
<hr>

==== Auto-updating the server ====
Assuming you have followed this guide and used the default paths, users, and install instructions, you can paste the following into your terminal to auto-update your Pavlov server:

<pre>
cat << 'EOF' > $HOME/pavlov_daily_update_and_restart.sh
#!/bin/bash

USER="steam"
SERVICENAME="pavlovserver.service"
INSTALLDIRNAME="pavlovserver"
USERHOME="/home/$USER"

echo -e "Beginning Pavlov VR update run on $(date)\n\n"

systemctl stop "$SERVICENAME"

sleep 5
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +force_install_dir "$USERHOME/$INSTALLDIRNAME" +app_update 622970 +exit
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +app_update 1007 +quit
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/.steam/sdk64/steamclient.so"
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/pavlovserver/Pavlov/Binaries/Linux/steamclient.so"

systemctl start "$SERVICENAME"

echo -e "Ending Pavlov VR update run on $(date)\n\n"

EOF

chmod +x $HOME/pavlov_daily_update_and_restart.sh
mkdir $HOME/pavlov_update_logs && touch $HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log
CRONLINE="00 2 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
(sudo crontab -u root -l; echo "$CRONLINE" ) | sudo crontab -u root -
unset CRONLINE

</pre>

These commands will:

1. Create a shell script in the "steam" user's home directory that automatically stops the Pavlov server, pulls any updates via steam, pull updates to the Steamworks SDK Redist, and copies the latest version of steamclient.so to the Pavlov server directory

2. Make the shell script executable

3. Create a new directory called "pavlov_update_logs" in the "steam" user's directory, and create a logfile inside that directory called "pavlov_daily_update_and_restart.sh.log". You can check this logfile to see the output of the Pavlov and Steam SDK update commands.

4. Create a crontab entry for the root user that runs this shell script automatically every day at 2:00AM local time

If you want to change the time that this script runs, edit the numbers "00 2" in the line that starts with "CRONLINE=". In the example provided, 00 is the minutes column, and 2 is the hour column. For example, if you wanted the server to automatically update and restart at 4:17AM every day, change the line starting with "CRONLINE=" to:

<pre>
CRONLINE="17 4 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
</pre>

If the time is PM, use 24-hour time format, e.g. "32 18" for 6:32PM.
<hr>
=== Save Logs for records and stats ===
this is a automated script that will on a timer save all the backups made by the server before they are purged by the game for admin records and starts collection

https://github.com/JTWP-org/backUpLogs2

Setting up a dedicated server

2023-07-17T16:45:18Z

SaltedCrackerJack: /* Advanced Scripts For Server Management */

== Setting up a dedicated server ==

'''There are no Windows binaries'''

This guide is written exclusively for Linux and covers Ubuntu/Debian/Debian-like and Red Hat RPM-based distros. Possible to run with other distros, but some of the commands won't work and you will need to know enough to figure out the software install of dependencies on your own.

If you are considering hosting from home, please read that section of the wiki first.

This guide assumes you know the basics of using a bash terminal: ssh'ing into a server, running bash commands, editing text files, etc.

If you have no experience using bash, maybe start [https://www.howtogeek.com/140679/beginner-geek-how-to-start-using-the-linux-terminal/ here]. Editing text files via commandline is often a challenge. Suggest using nano and reading guide [https://www.howtogeek.com/howto/42980/the-beginners-guide-to-nano-the-linux-command-line-text-editor/ here]

If you are new to linux and accessing your server from Windows, highly suggest using MobaXterm as your SSH client as that can make required editing of text files easier using built in editor instead of the native linux command line editors.

And finally, ask yourself why you want to setup a server? If you look at the list, there are many, many more servers than players. If you don't have a team, discord community, or group of friends ready to play on your server, chances are it will go unused. Got one of these... great, let's go.

If you don't want to go through the hassle yourself and want to pay for a hosting service Arctic VR (PC and Shack) and Horde (Shack) provide a server hosting services and are trusted in the community. See links below.

----

=== Server Requirements ===

'''Pavlovserver can only be hosted under Linux.'''

This can be running as a VM under windows, but this will increase the complexity of the setup beyond this guide.

Ubuntu 18.04 x86_64, Ubuntu 19/04 amd64, Ubuntu 20.04, and Rocky Linux 8 are confirmed working. Ubuntu 15.04 x86 is known to fail to install using this guide. Recommend not running on "minimal" images as some tools are missing.

* 2GB RAM + 1GB RAM per each additional server with 10 players. More RAM is recommended for larger maps, higher player counts, or complex gamemodes. Not having enough RAM is a common cause of server crashes.

* A ~2.5Ghz CPU will comfortably support a 10 player server.

* A ~4Ghz CPU will comfortably support 24 players. This is a limit built into Pavlov itself, no server will allow players to join over 24. Lower player counts are recommended for complex gamemodes (E.g. CodZ) and/or highly detailed maps, so that maximum number will often be lower.

(Note that these are '''not''' hard limits for player counts, just suggestions for the best performance, based on experiences with many server providers on different grades of hardware.)

* Pavlovserver is functionally single threaded (one thread does vast majority of work). More CPUs only help if you are running more servers. More clockspeed = higher performance = more users per server.
The maximum number of servers you can run is dependent on how many CPUs you have. For example, if you have an 8 core CPU, the maximum number of servers would be 7. You should always have at least one CPU free as overhead, as Pavlov servers can use slightly more than one thread.

----

==== Hosting at home ====
When hosting at home there are additional requirements regarding networking: Your router has to support port-forwarding, hair-pinning/LoopbackNAT, and respond to ping requests. These techniques are necessary to allow your server to be found and to talk back to the client. please see https://en.wikipedia.org/wiki/Port_forwarding, https://en.wikipedia.org/wiki/Hairpinning, and https://www.speedguide.net/faq/how-to-become-pingable-behind-a-routerfirewall-376 for more info and google for these terms in addition to your router model to find guides on how to enable/configure it properly. If you have modern Router, it may have these features already enabled, in this case you just have to configure port-forwarding. If you can see your server but not join it while others can, this is indicative of a failure of LoopbackNAT.

A second challenge to hosting at home is CGNAT (Carrier grade NAT: https://www.a10networks.com/blog/carrier-grade-nat/). Just like NAT on your home network that has to be gotten around w/ port-forwarding, CGNAT breaks the ability of external connections to be made back to your server, but the controls are solely in your ISPs hands. Sometimes if you ask, you can be removed from CGNAT pools and/or assigned a static IP. CGNAT rollouts are becoming very common now, so if your server worked then doesn't allow connections now, your ISP may have made this change.

You can check whether you’re on a CGNAT network by visiting a Web site such as ipaddress.com or whatsmyip.com and comparing the IP address listed to the public/WAN IP address assigned to your Internet gateway. To find your gateway’s public IP address, check the status page in the administrative interface. If the two IP addresses differ, you’re likely on a CGNAT network. If so, this problem must be resolved before you go any further.

'''Not understanding these requirements and configuration is a frequent cause of failed setups and questions in discord. Don't skip this if you are trying to host from home'''

'''There are serious security implications of hosting this software at home.''' None of the devs are security experts and there has been no security review of the code. You are opening up your system to the world and publicity advertising this fact. Expect that any system hosting this software is open to compromise from the Internet and act accordingly. If your router offers a DMZ network, use it. Consider hosting on a cloud based server and think twice before running this software on any system that contains data you care about or has access to networks and computers you care about.

If you're hosting at home using Oracle's VirtualBox, there are steps you can take to prevent double NAT (which can cause issues later on)

1. Select your VM and then click Settings in VirtualBox's main window.

2. Click on Network and change Attached To from NAT to Bridged Adapter.

Once you've done this, your VM should be connected directly to your home router and double NAT should no longer be a issue.

----

==== Starting Server Install ====

====Obtaining an ApiKey====
For your server to show up in the server list, there is now a requirement to have an ApiKey issued by vankrupt. This is to prevent DOS attacks against the master server

Get the key by going here: https://pavlov-ms.vankrupt.com/servers/v1/key and using your mobile number to get a SMS
(note that there have been reported failures of this SMS system for non-US mobiles. In this case DM davevillz your mobile and ask for a key)

Put this key in your Game.ini as follows:
ApiKey="ABC123FALSEKEYDONTUSEME"
or if you would like (personally untested..I would use game.ini) you can call it at server runtime with flag as follows:
-KEY="ABC123FALSEKEYDONTUSEME"

This key can be re-used for a reasonable number of servers (a limit of 10 has been mentioned). Contact the Devs if you need more servers per key.

====System setup and software installation====

Install dependencies and create the `steam` user. (You only need to do this once):

Confirm Linux version
<pre>
lsb_release -a
</pre>

'''Ubuntu 20.04'''
<pre>
sudo apt update && sudo apt install -y gdb curl lib32gcc1 libc++-dev unzip
sudo useradd -m steam
</pre>

'''Ubuntu 20.10 or higher'''
<pre>
sudo apt update && sudo apt install -y gdb curl lib32gcc-s1 libc++-dev unzip
sudo useradd -m steam
</pre>

'''Rocky Linux, CentOS 8, and RHEL 8'''

<pre>
sudo sed -i 's/^SELINUX=enforcing$/SELINUX=permissive/g' /etc/selinux/config
sudo setenforce 0
sudo yum install gdb curl glibc.i686 libstdc++.i686 libstdc++-devel.i686 libstdc++-devel.x86_64 unzip wget -y
wget https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/l/libcxx-3.8.0-3.el7.x86_64.rpm
sudo rpm -i libcxx-3.8.0-3.el7.x86_64.rpm
sudo useradd -m steam
</pre>

[Optional] Set a password for steam.
<pre>sudo passwd steam</pre>

Login as the steam user. ('''You will need to do this each time you connect to your server'''):

<pre>
sudo su -l steam
</pre>

Install Steam:

<pre>
mkdir ~/Steam && cd ~/Steam && curl -sqL "https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz" | tar zxvf -
</pre>

There are different dedicated server versions for Pavlov Server - choose which server version you want to host (PC non-beta, PC Beta, Shack Live, or Shack RC)
(You will need to run this command each time there is a Pavlov Server update).

 
To host '''PC Server (non-beta)''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta default +exit
</pre>

To host '''PC BETA''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta beta_server +exit
</pre>

To host '''Shack Live''' (Quest):

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack +exit
</pre>

To host '''Shack RC''' (Quest): 

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack_beta +exit
</pre>

Now that we've installed the server, all pavlov server versions should continue. 
Install a fresh copy of steamclient.so (May have to do this after each update):
<pre>
~/Steam/steamcmd.sh +login anonymous +app_update 1007 +quit
mkdir -p ~/.steam/sdk64
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/pavlovserver/Pavlov/Binaries/Linux/steamclient.so
</pre>

The update 29 of the PCVR version of pavlov and after added a requirement to run these commands to change the steamclient.so:
<code>sudo rm /usr/lib/x86_64-linux-gnu/libc++.so</code>
<code>sudo ln -s /usr/lib/x86_64-linux-gnu/libc++.so.1 /usr/lib/x86_64-linux-gnu/libc++.so</code>

Make the PavlovServer script executable. (You only need to do this once):

<pre>
chmod +x ~/pavlovserver/PavlovServer.sh
</pre>

----

=== Server Configuration ===

Before starting the server we need to configure it. Start by creating some directories:

<pre>
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Logs
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps
</pre>

==== Mods/Blacklist/Whitelist (optional) ====

The following three files allow you to specify mods, banned players, and whitelist players. These are optional, but go ahead and create them. Populating the files is described later.

<pre>
touch /home/steam/pavlovserver/Pavlov/Saved/Config/mods.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/blacklist.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/whitelist.txt
</pre>

====Configuring Game.ini====
Create a new Game.ini file using following command to open an editor and copy/paste the following block into it then save it. Note not all of these options are required. For instance remove or comment out the Password=0000 line to make a public server with no pin.
<pre>
nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini
</pre>

<pre>
[/Script/Pavlov.DedicatedServer]
bEnabled=true
ServerName="My_private_idaho"
MaxPlayers=10 #Set this to 10 for Shack. 24 is the max for PC, setting it higher will not allow players to join.
ApiKey="ABC123FALSEKEYDONTUSEME"
bSecured=true
bCustomServer=true
bVerboseLogging=false
bCompetitive=false #This only works for SND
bWhitelist=false
RefreshListTime=120
LimitedAmmoType=0
TickRate=90
TimeLimit=60
#Password=0000
#BalanceTableURL="vankruptgames/BalancingTable/main"
MapRotation=(MapId="UGC1758245796", GameMode="GUN")
MapRotation=(MapId="datacenter", GameMode="SND")
MapRotation=(MapId="sand", GameMode="DM")

</pre>

* '''bEnabled''' - whether the server appears in the server list (unconfirmed)
* '''ServerName''' - name it will be listed as. (approx 35 chars max)
* '''MaxPlayers''' - See suggested specs for limits. 10 standard (10 for shack), 20-24 is max recommended for large maps like Stalingrad or PUSH/RUSH modes, and servers allow a maximum of 24 players.
* '''ApiKey''' - Unique ApiKey required to register server with master server. Replace with your key
* '''bSecured''' - enabled Valve Anti-Cheat (VAC)
* '''bCustomServer''' - activates some new modding tools (save and http functions. Required to write to blacklist.txt for bans)
* '''bCompetitive''' - sets the server to competitive mode for SND. If removed the server will default to false
* '''bVerboseLogging''' - enables verbose logging, mostly detailed statistics. Be prepared for significant increase in logging.
* '''bWhitelist''' - Only allow users in whitelist.txt to join
* '''RefreshListTime''' - sets how often the running server checks for updates in ban/whitelist/mod files
* '''LimitedAmmoType''' - sets limited ammo mode, see Limited Ammo Types table below

* '''TimeLimit''' - sets time limit for each map
* '''TickRate''' - sets the server tickrate. (so far minimum stable seems around 50 and max around 120. Beware setting this changes weapon despawn time and breaks some game modes. Recommend not touching)
* '''Password''' - PIN number for server #FYI - this is now also changeable via rcon.
* '''BalanceTableURL''' - Points to a custom balance table from github. See https://github.com/vankruptgames/BalancingTable for instructions. This line isn't needed if you don't have one.
* '''MapRotation''' - you can add multiple of these. The map system has switched from the steam workshop to modio which means that the server rotation will need to be redone with modio UGCs. <nowiki>https://mod.io/g/pavlov</nowiki>. This is done by taking the resource ID from the modio page, adding “UGC” in front of it and then adding that to the rotation. For example the map gravity <nowiki>https://mod.io/g/pavlov/m/gravity1</nowiki> has a resource ID of 2773760 so the map ID to add to the server would be “UGC2773760”. When a match ends, the server will load the next map in the rotation.
* '''AFKTimeLimit''' There is now a feature to kick players who are idle in the game. Integers are measured in seconds and 0 disables AFK kicking completely.

Available game modes as of 09/06/2022: See Game modes table below

For maps running a Custom gamemode (CodZ, BR, Duel, etc.) it doesn't matter which gamemode you choose, as the map will automatically override it with the custom mode.

{| class="wikitable"
|+Limited Ammo Types
!AmmoType
!Name
!Description
|-
|0
|Unlimited
|Players have unlimited ammo, carry no ammo boxes and do not display an ammo count on the wrist.
|-
|1
|Limited Generic
|Players carry ammo boxes with a limited amount of ammo.
One box for each weapon class (Pistol, Submachine gun, Rifles/MGs, Shotgun, Sniper).

Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.

An ammo count is displayed on the wrist.
|-
|2
|Limited Specific
|Players carry ammo boxes with a limited amount of ammo.
One box for each weapon.

Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.

An ammo count is displayed on the wrist.
|-
|3
|Custom
|Allows for full control over ammo by the map.
|-
|4
| Limited Special
|'''All weapons except "special" weapons are unlimited, more clarification is needed.'''
|-
|5
|Boxless
|'''Like limited generic but without boxes? Clarification is needed.'''
|}
{| class="wikitable"
|+Game modes
!GameMode
!Name
|-
|DM
|Death match
|-
|KOTH
|King of the hill
|-
|GUN
| Gun game
|-
|OITC
| One in the chamber
|-
|SND
|Search and destroy
|-
|TANKTDM
|WW2 Team Death Match
|-
| TDM
|Team Death Match
|-
|TTT
|Trouble in Terrorist Town
|-
|WW2GUN
|WW2 gun game
|-
|ZWV
| Zombie wave survival
|-
|HIDE
|The Hidden
|-
|INFECTION
|Hidden infection
|-
|PUSH
|Push
|-
|PH
|Prop hunt
|}
= Default Map ID's =
datacenter

sand

bridge

containeryard

siberia (Prison Break)

hospital (Zombies map)

killhouse

range

tutorial

santorini

station

industry

ogcontainers (Shack only)

haguenau (Shack only)

foundation (Shack only)

stalingrad (PC only)

stalingrad_night (PC only)

santorini_night (PC only)

sand_night (PC only)

station_night (PC only)

industry_night (PC only)

bunker (PC only)

==== Firewall/Port forwarding ====
Using the default settings there are two UDP ports (7777, 8177) that need to be allowed to access the server either by firewall setup or port forwarding.

'''Ubuntu''' firewall commands to check firewall and open ports:
<pre>
sudo ufw status
sudo ufw allow 7777
sudo ufw allow 8177
sudo ufw allow 9100
sudo ufw status
</pre>

'''Rocky Linux''' firewall commands to check firewall and open ports:
<pre>
sudo firewall-cmd --zone=public --add-port=7777/tcp
sudo firewall-cmd --zone=public --add-port=7777/udp
sudo firewall-cmd --zone=public --add-port=8177/tcp
sudo firewall-cmd --zone=public --add-port=8177/udp
sudo firewall-cmd --zone=public --add-port=9100/udp
sudo firewall-cmd --zone=public --add-port=9100/tcp
sudo firewall-cmd --list-ports
firewall-cmd --runtime-to-permanent
</pre>

You may also need to allow Pings (ICMP) for the server's true latency to appear in the master list.

If you are running multiple servers and have set additional ports (see http://wiki.pavlov-vr.com/index.php?title=Dedicated_server#Running_multiple_servers_on_one_host) then you need to allow access to the defined port plus the port 400 higher. So if you use 7000 as your port, then UDP 7000 and 7400 need to be open

If you have setup rcon via RconSettings.txt (below) then that port also need to be allowed access via TCP

If you are running Shack/Quest and want to have maps that are downloadable from your server, your server ports (ex. 7777 & 8177) must also be open via TCP

----

==== Shack Maps (Quest) ====

If you try to use the steps above to add maps for Shack, youll run into issues very quickly. This is because Shack has no affiliation to Steam, and therefore cannot use Steam Workshop maps like above. In the future, these steps will apply to PC servers as well, allowing a server to hold the map itself, instead of offloading to Steam.

To get started, first create the directory to hold the maps

<pre>mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps</pre>

You can use any number of methods to move the map files onto the server, but ill go over the two simplest, starting with a GUI approach

Download and install CyberDuck onto your "home" PC (Whatever PC you use for access to the server, but not the server itsself): https://cyberduck.io/

Next, download and unzip your map of choice from https://www.pavlovquest.com/ , https://pavlovhorde.com/mapsList, or look in #shack-map-showcase channel in the discord server. I'm going to use Cheeto's WW2 Items test (http://www.mediafire.com/file/emyt9bs1z9u9ykw/SVR_Cheeto_Items.zip/file ) for this example, you do what you like

In the top left corner, open a connection, set the connection type to SFTP, and fill in the rest of the information. User will be root, password is whatever you set the root pw as (toor in Ubuntu by default)

In the directory dropdown (itll say /root) go back to /

Follow the directories until we arrive back at our "maps" folder <pre>/home/steam/pavlovserver/Pavlov/Saved/maps</pre>

Drag and drop the unzipped map folder into the main window, in this case itll be SVR_Cheeto_Items

Hit Allow

Youll now see a folder named SVR_Cheeto_Items, and within it should be nothing but 3 files. If there is another folder in it, move this folder to the maps directory, otherwise the server wont work. The 3 files (2 .PAK one .JSON) should be in home/steam/pavlovserver/Pavlov/Saved/maps/SVR_Cheeto_Items, no more, no less.

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

To play the map, you can either use RCON switch map command, or to add the map to your servers automatic map rotation list, add the map's folder name to your Game.ini. This replaces the MapID section, so for our example it would be

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

And thats all! Disconnect CyberDuck from your server before playing, otherwise youll have difficulty joining.

-----------

==== Adding Shack Maps over Command Line Interface ====

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

A bit more complicated, but adding maps over CLI has its benefits

First, CD to the maps directory you made above

<pre>cd ~/pavlovserver/Pavlov/Saved/maps</pre>

Download the map files from whatever you use to upload them. To do this, you can either use curl or wget

<pre>curl -O insertURLhere</pre>

'''If you download your map from Google Drive''', make sure that your .zip folder is shared to anyone.
Then, get the file's url from the shared link. Example : ''<nowiki>https://drive.google.com/file/d/19bI8gUHaN5tUrDvnadAacUnchQf6_k/view</nowiki>'' will be ''19bI8gUHaN5tUrDvnadAacUnchQf6_k''
Edit "fileId" and "fileName" before you execute the command.
<pre>
fileId=19bI8gUHaN5tUrDvnadAacUnchQf6_k
fileName=SVR_USER_MAPNAME
curl -sc /tmp/cookie "https://drive.google.com/uc?export=download&id=${fileId}" > /dev/null
code="$(awk '/_warning_/ {print $NF}' /tmp/cookie)"
curl -Lb /tmp/cookie "https://drive.google.com/uc?export=download&confirm=${code}&id=${fileId}" -o ${fileName} </pre>

To keep with the Items example:

<pre>curl -O https://cdn.discordapp.com/attachments/744185280759857234/745027406695366788/SVR_Cheeto_Items.zip</pre>

Next, unzip the file. If this next step errors out, saying the command is unknown, switch back to the root user (su root), and install unzip (sudo apt install unzip), then return to the steam user, and continue.

<pre>unzip SVR_Cheeto_Items.zip</pre>

Now finish like before by adding the map to your Game.ini

<pre>nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini</pre>

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

==== Admin/Moderator list (optional) ====

The only working in-game admin menu is through Arctic VR server hosting (see below).

If you add moderators to your server, they will not be subject to vote kicks.

<pre>
nano ~/pavlovserver/Pavlov/Saved/Config/mods.txt
</pre>

Example Mod List:
<pre>
76541198397498572 #Optional Comment: Player name
76541198397498573 #Some Other Player
</pre>

==== ArcticVR Admin Menu ====

[[File:Arcticmenu.jpg|500px|link=https://www.arctic-vr.com/server-admin-menu]]

Arctic-VR Offers an advanced In-Game Admin menu that is exclusive to their hosting service. Features include:
* Switch Maps+Modes
* Teleport Players to Players
* Change Player Skins
* Control Player Buying+Cash
* Spawn Items
* Clean up corpses + guns
* Spawn Bots
* Spawn Items for other players
* Control Teams + Balance/Shuffle Teams
* ResetSND
* And More

You can read more about the ArcticVR admin menu on their website: https://www.arctic-vr.com/server-admin-menu

==== Handy tools for finding steamIDs ====

Steam ID finder: https://steamidfinder.com/lookup/ or https://steamid.xyz/

You want to enter in the steamID64 format.

This tool can convert or lookup IDs: https://steamid.io/

If you are looking for a steamID of a player that has been on your server recently this is technique to find them:
<pre>
grep -i playername ~/pavlovserver/Pavlov/Saved/Logs/* | grep TicketValidation
</pre>

=== Configure Rcon ===
To enable Rcon access create config file:
<pre> nano /home/steam/pavlovserver/Pavlov/Saved/Config/RconSettings.txt </pre>

Copy in the following text - change password, and if desired the port:
<pre>
Password=ChangeThisPassword
Port=9100
</pre>
You must specify a port for the Rcon server to use as well as a Password (use a different port per sever instance if running multiple server instances off the same hardware)

=== Starting the server ===

<pre>
cd ~/pavlovserver && ./PavlovServer.sh
</pre>

That's it, your server will be automatically broadcast to the master server! :)

Two handy tools to determine quickly if your server is broadcasting are [https://pablub.xyz/ Pablub] (PC only) and [https://pavlovhorde.com/ Horde] (Shack) and [https://pavlovhorde.com/pcServers Horde] (PC version)

Note that when you close your terminal, the server will go down. See the "supervisors" section below for how to prevent this.

----

=== Supervising the server using systemd ===

Running '''./PavlovServer.sh''' in your interactive shell is easy, but the server will shut down when you close your terminal. If you want to run the server in the background,
you'll want to run it under a supervisor. There are many options, ranging from the simple (nohup, screen or tmux), to the
more robust (supervisord, systemd).

Systemd is running by default on Ubuntu Linux, so we'll use that here.

To run the server as a systemd service, create the file '''/etc/systemd/system/pavlovserver.service''' (as root) by typing
<pre>
sudo nano /etc/systemd/system/pavlovserver.service
</pre>

Copy contents below into the file and save.

<pre>
[Unit]
Description=Pavlov VR dedicated server

[Service]
Type=simple
WorkingDirectory=/home/steam/pavlovserver
ExecStart=/home/steam/pavlovserver/PavlovServer.sh

RestartSec=1
Restart=always
User=steam
Group=steam

[Install]
WantedBy = multi-user.target
</pre>

If you'd like your server to start as competitive without editing the game.ini, change the line "ExecStart=/home/steam/pavlovserver/PavlovServer.sh" to look like this below. Though it's much easier to just use the game.ini to enable competitive instead. <pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -COMPETITIVE=1</pre>

Change the user or paths as appropriate. After saving the service file, to start, restart, stop, or monitor the server:

<pre>
sudo systemctl start pavlovserver
sudo systemctl restart pavlovserver
sudo systemctl stop pavlovserver
sudo systemctl status pavlovserver
</pre>

To view the logs:

<pre>
sudo journalctl -u pavlovserver
# to live-tail the logs
sudo journalctl -u pavlovserver -f
</pre>

If you want to run the pavlov server as soon as your server boots (e.g. a VPS you turn on and off), add pavlov as a startup service:

<pre>
sudo systemctl enable pavlovserver
</pre>

----

== Advanced Server Administration ==

=== Running multiple servers on one host ===

* Pavlovserver is functionally single threaded (there are multiple threads, but vast majority of work occurs in the primary one). Make sure you have # of pavlovservers + 1 CPU available. More CPUs= more servers. Faster CPU = more players.
* Make multiple server installs by defining a separate install dir for each server.
* Run each server with a unique port. eg: '''./PavlovServer.sh -PORT="Desired Port"'''
* The Server will use the Desired Port and the Port 400 above (Example: You choose 8200 as Port. So Port 8600 will be used as well)
* If you are using RCON, each server will need a unique port defined in RconSettings.txt
* Ensure the ports are forwarded and opened in your firewall

To duplicate directories:

be in the steam home folder
<pre>
cp -r pavlovserver pavlovserver1
/home/steam/pavlovserver1/PavlovServer.sh -PORT=[Desired Port]
</pre>

=== Starting server in competitive mode ===
Competitive mode will prevent dead teammates from being able to see the match, to prevent ghosting.
You can either enable this via Game.ini (described in Game.ini file), or using the -COMPETITIVE=1 parameter.

<pre>
/home/steam/pavlovserver1/PavlovServer.sh -COMPETITIVE=1
</pre>

{| class="wikitable"

|}

=== Useful Linux Commands ===
List files / folders in directory, print current working directory,
<pre>ls -la #list files/directories along with authorities and ownership
pwd #print working directory
sudo chown <owner> <file/directory> #change owner of file/directory. If root created something and you need to change it to steam
sudo chgrp <group> <file/directory> #change group of file/directory.
</pre>

Check if pavlov is running by checking process status. If the only row you see is the grep command, pavlov server is not started.
<pre> ps -ef | grep pav </pre>

Sample output:
<pre>
steam 34044 1 0 16:52 ? 00:00:00 /bin/sh /home/steam/pavlovserver/PavlovServer.sh
steam 34066 34044 80 16:52 ? 00:00:04 /home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer
zombies+ 34101 34013 0 16:52 pts/0 00:00:00 grep --color=auto pav
</pre>

Kill a process. Note this command uses 34044, which is a process id from the command output above.
<pre> kill -9 34044 </pre>

Dump the log to the console so you can scroll through it:
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log </pre>

Search the log for a string - replace my_string with case-sensitive string
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep my_string </pre>

<hr>
=== Advanced Scripts For Server Management ===
<hr>

==== Auto-updating the server ====
Assuming you have followed this guide and used the default paths, users, and install instructions, you can paste the following into your terminal to auto-update your Pavlov server:

<pre>
cat << 'EOF' > $HOME/pavlov_daily_update_and_restart.sh
#!/bin/bash

USER="steam"
SERVICENAME="pavlovserver.service"
INSTALLDIRNAME="pavlovserver"
USERHOME="/home/$USER"

echo -e "Beginning Pavlov VR update run on $(date)\n\n"

systemctl stop "$SERVICENAME"

sleep 5
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +force_install_dir "$USERHOME/$INSTALLDIRNAME" +app_update 622970 +exit
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +app_update 1007 +quit
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/.steam/sdk64/steamclient.so"
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/pavlovserver/Pavlov/Binaries/Linux/steamclient.so"

systemctl start "$SERVICENAME"

echo -e "Ending Pavlov VR update run on $(date)\n\n"

EOF

chmod +x $HOME/pavlov_daily_update_and_restart.sh
mkdir $HOME/pavlov_update_logs && touch $HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log
CRONLINE="00 2 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
(sudo crontab -u root -l; echo "$CRONLINE" ) | sudo crontab -u root -
unset CRONLINE

</pre>

These commands will:

1. Create a shell script in the "steam" user's home directory that automatically stops the Pavlov server, pulls any updates via steam, pull updates to the Steamworks SDK Redist, and copies the latest version of steamclient.so to the Pavlov server directory

2. Make the shell script executable

3. Create a new directory called "pavlov_update_logs" in the "steam" user's directory, and create a logfile inside that directory called "pavlov_daily_update_and_restart.sh.log". You can check this logfile to see the output of the Pavlov and Steam SDK update commands.

4. Create a crontab entry for the root user that runs this shell script automatically every day at 2:00AM local time

If you want to change the time that this script runs, edit the numbers "00 2" in the line that starts with "CRONLINE=". In the example provided, 00 is the minutes column, and 2 is the hour column. For example, if you wanted the server to automatically update and restart at 4:17AM every day, change the line starting with "CRONLINE=" to:

<pre>
CRONLINE="17 4 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
</pre>

If the time is PM, use 24-hour time format, e.g. "32 18" for 6:32PM.

==== Save Logs for records and stats ====
this is a automated script that will on a timer save all the backups made by the server before they are purged by the game for admin records and starts collection

https://github.com/JTWP-org/backUpLogs2

Setting up a dedicated server

2023-07-17T16:27:21Z

SaltedCrackerJack: /* Advanced Scripts For Server Management */

== Setting up a dedicated server ==

'''There are no Windows binaries'''

This guide is written exclusively for Linux and covers Ubuntu/Debian/Debian-like and Red Hat RPM-based distros. Possible to run with other distros, but some of the commands won't work and you will need to know enough to figure out the software install of dependencies on your own.

If you are considering hosting from home, please read that section of the wiki first.

This guide assumes you know the basics of using a bash terminal: ssh'ing into a server, running bash commands, editing text files, etc.

If you have no experience using bash, maybe start [https://www.howtogeek.com/140679/beginner-geek-how-to-start-using-the-linux-terminal/ here]. Editing text files via commandline is often a challenge. Suggest using nano and reading guide [https://www.howtogeek.com/howto/42980/the-beginners-guide-to-nano-the-linux-command-line-text-editor/ here]

If you are new to linux and accessing your server from Windows, highly suggest using MobaXterm as your SSH client as that can make required editing of text files easier using built in editor instead of the native linux command line editors.

And finally, ask yourself why you want to setup a server? If you look at the list, there are many, many more servers than players. If you don't have a team, discord community, or group of friends ready to play on your server, chances are it will go unused. Got one of these... great, let's go.

If you don't want to go through the hassle yourself and want to pay for a hosting service Arctic VR (PC and Shack) and Horde (Shack) provide a server hosting services and are trusted in the community. See links below.

----

=== Server Requirements ===

'''Pavlovserver can only be hosted under Linux.'''

This can be running as a VM under windows, but this will increase the complexity of the setup beyond this guide.

Ubuntu 18.04 x86_64, Ubuntu 19/04 amd64, Ubuntu 20.04, and Rocky Linux 8 are confirmed working. Ubuntu 15.04 x86 is known to fail to install using this guide. Recommend not running on "minimal" images as some tools are missing.

* 2GB RAM + 1GB RAM per each additional server with 10 players. More RAM is recommended for larger maps, higher player counts, or complex gamemodes. Not having enough RAM is a common cause of server crashes.

* A ~2.5Ghz CPU will comfortably support a 10 player server.

* A ~4Ghz CPU will comfortably support 24 players. This is a limit built into Pavlov itself, no server will allow players to join over 24. Lower player counts are recommended for complex gamemodes (E.g. CodZ) and/or highly detailed maps, so that maximum number will often be lower.

(Note that these are '''not''' hard limits for player counts, just suggestions for the best performance, based on experiences with many server providers on different grades of hardware.)

* Pavlovserver is functionally single threaded (one thread does vast majority of work). More CPUs only help if you are running more servers. More clockspeed = higher performance = more users per server.
The maximum number of servers you can run is dependent on how many CPUs you have. For example, if you have an 8 core CPU, the maximum number of servers would be 7. You should always have at least one CPU free as overhead, as Pavlov servers can use slightly more than one thread.

----

==== Hosting at home ====
When hosting at home there are additional requirements regarding networking: Your router has to support port-forwarding, hair-pinning/LoopbackNAT, and respond to ping requests. These techniques are necessary to allow your server to be found and to talk back to the client. please see https://en.wikipedia.org/wiki/Port_forwarding, https://en.wikipedia.org/wiki/Hairpinning, and https://www.speedguide.net/faq/how-to-become-pingable-behind-a-routerfirewall-376 for more info and google for these terms in addition to your router model to find guides on how to enable/configure it properly. If you have modern Router, it may have these features already enabled, in this case you just have to configure port-forwarding. If you can see your server but not join it while others can, this is indicative of a failure of LoopbackNAT.

A second challenge to hosting at home is CGNAT (Carrier grade NAT: https://www.a10networks.com/blog/carrier-grade-nat/). Just like NAT on your home network that has to be gotten around w/ port-forwarding, CGNAT breaks the ability of external connections to be made back to your server, but the controls are solely in your ISPs hands. Sometimes if you ask, you can be removed from CGNAT pools and/or assigned a static IP. CGNAT rollouts are becoming very common now, so if your server worked then doesn't allow connections now, your ISP may have made this change.

You can check whether you’re on a CGNAT network by visiting a Web site such as ipaddress.com or whatsmyip.com and comparing the IP address listed to the public/WAN IP address assigned to your Internet gateway. To find your gateway’s public IP address, check the status page in the administrative interface. If the two IP addresses differ, you’re likely on a CGNAT network. If so, this problem must be resolved before you go any further.

'''Not understanding these requirements and configuration is a frequent cause of failed setups and questions in discord. Don't skip this if you are trying to host from home'''

'''There are serious security implications of hosting this software at home.''' None of the devs are security experts and there has been no security review of the code. You are opening up your system to the world and publicity advertising this fact. Expect that any system hosting this software is open to compromise from the Internet and act accordingly. If your router offers a DMZ network, use it. Consider hosting on a cloud based server and think twice before running this software on any system that contains data you care about or has access to networks and computers you care about.

If you're hosting at home using Oracle's VirtualBox, there are steps you can take to prevent double NAT (which can cause issues later on)

1. Select your VM and then click Settings in VirtualBox's main window.

2. Click on Network and change Attached To from NAT to Bridged Adapter.

Once you've done this, your VM should be connected directly to your home router and double NAT should no longer be a issue.

----

==== Starting Server Install ====

====Obtaining an ApiKey====
For your server to show up in the server list, there is now a requirement to have an ApiKey issued by vankrupt. This is to prevent DOS attacks against the master server

Get the key by going here: https://pavlov-ms.vankrupt.com/servers/v1/key and using your mobile number to get a SMS
(note that there have been reported failures of this SMS system for non-US mobiles. In this case DM davevillz your mobile and ask for a key)

Put this key in your Game.ini as follows:
ApiKey="ABC123FALSEKEYDONTUSEME"
or if you would like (personally untested..I would use game.ini) you can call it at server runtime with flag as follows:
-KEY="ABC123FALSEKEYDONTUSEME"

This key can be re-used for a reasonable number of servers (a limit of 10 has been mentioned). Contact the Devs if you need more servers per key.

====System setup and software installation====

Install dependencies and create the `steam` user. (You only need to do this once):

Confirm Linux version
<pre>
lsb_release -a
</pre>

'''Ubuntu 20.04'''
<pre>
sudo apt update && sudo apt install -y gdb curl lib32gcc1 libc++-dev unzip
sudo useradd -m steam
</pre>

'''Ubuntu 20.10 or higher'''
<pre>
sudo apt update && sudo apt install -y gdb curl lib32gcc-s1 libc++-dev unzip
sudo useradd -m steam
</pre>

'''Rocky Linux, CentOS 8, and RHEL 8'''

<pre>
sudo sed -i 's/^SELINUX=enforcing$/SELINUX=permissive/g' /etc/selinux/config
sudo setenforce 0
sudo yum install gdb curl glibc.i686 libstdc++.i686 libstdc++-devel.i686 libstdc++-devel.x86_64 unzip wget -y
wget https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/l/libcxx-3.8.0-3.el7.x86_64.rpm
sudo rpm -i libcxx-3.8.0-3.el7.x86_64.rpm
sudo useradd -m steam
</pre>

[Optional] Set a password for steam.
<pre>sudo passwd steam</pre>

Login as the steam user. ('''You will need to do this each time you connect to your server'''):

<pre>
sudo su -l steam
</pre>

Install Steam:

<pre>
mkdir ~/Steam && cd ~/Steam && curl -sqL "https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz" | tar zxvf -
</pre>

There are different dedicated server versions for Pavlov Server - choose which server version you want to host (PC non-beta, PC Beta, Shack Live, or Shack RC)
(You will need to run this command each time there is a Pavlov Server update).

 
To host '''PC Server (non-beta)''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta default +exit
</pre>

To host '''PC BETA''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta beta_server +exit
</pre>

To host '''Shack Live''' (Quest):

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack +exit
</pre>

To host '''Shack RC''' (Quest): 

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack_beta +exit
</pre>

Now that we've installed the server, all pavlov server versions should continue. 
Install a fresh copy of steamclient.so (May have to do this after each update):
<pre>
~/Steam/steamcmd.sh +login anonymous +app_update 1007 +quit
mkdir -p ~/.steam/sdk64
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/pavlovserver/Pavlov/Binaries/Linux/steamclient.so
</pre>

The update 29 of the PCVR version of pavlov and after added a requirement to run these commands to change the steamclient.so:
<code>sudo rm /usr/lib/x86_64-linux-gnu/libc++.so</code>
<code>sudo ln -s /usr/lib/x86_64-linux-gnu/libc++.so.1 /usr/lib/x86_64-linux-gnu/libc++.so</code>

Make the PavlovServer script executable. (You only need to do this once):

<pre>
chmod +x ~/pavlovserver/PavlovServer.sh
</pre>

----

=== Server Configuration ===

Before starting the server we need to configure it. Start by creating some directories:

<pre>
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Logs
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps
</pre>

==== Mods/Blacklist/Whitelist (optional) ====

The following three files allow you to specify mods, banned players, and whitelist players. These are optional, but go ahead and create them. Populating the files is described later.

<pre>
touch /home/steam/pavlovserver/Pavlov/Saved/Config/mods.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/blacklist.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/whitelist.txt
</pre>

====Configuring Game.ini====
Create a new Game.ini file using following command to open an editor and copy/paste the following block into it then save it. Note not all of these options are required. For instance remove or comment out the Password=0000 line to make a public server with no pin.
<pre>
nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini
</pre>

<pre>
[/Script/Pavlov.DedicatedServer]
bEnabled=true
ServerName="My_private_idaho"
MaxPlayers=10 #Set this to 10 for Shack. 24 is the max for PC, setting it higher will not allow players to join.
ApiKey="ABC123FALSEKEYDONTUSEME"
bSecured=true
bCustomServer=true
bVerboseLogging=false
bCompetitive=false #This only works for SND
bWhitelist=false
RefreshListTime=120
LimitedAmmoType=0
TickRate=90
TimeLimit=60
#Password=0000
#BalanceTableURL="vankruptgames/BalancingTable/main"
MapRotation=(MapId="UGC1758245796", GameMode="GUN")
MapRotation=(MapId="datacenter", GameMode="SND")
MapRotation=(MapId="sand", GameMode="DM")

</pre>

* '''bEnabled''' - whether the server appears in the server list (unconfirmed)
* '''ServerName''' - name it will be listed as. (approx 35 chars max)
* '''MaxPlayers''' - See suggested specs for limits. 10 standard (10 for shack), 20-24 is max recommended for large maps like Stalingrad or PUSH/RUSH modes, and servers allow a maximum of 24 players.
* '''ApiKey''' - Unique ApiKey required to register server with master server. Replace with your key
* '''bSecured''' - enabled Valve Anti-Cheat (VAC)
* '''bCustomServer''' - activates some new modding tools (save and http functions. Required to write to blacklist.txt for bans)
* '''bCompetitive''' - sets the server to competitive mode for SND. If removed the server will default to false
* '''bVerboseLogging''' - enables verbose logging, mostly detailed statistics. Be prepared for significant increase in logging.
* '''bWhitelist''' - Only allow users in whitelist.txt to join
* '''RefreshListTime''' - sets how often the running server checks for updates in ban/whitelist/mod files
* '''LimitedAmmoType''' - sets limited ammo mode, see Limited Ammo Types table below

* '''TimeLimit''' - sets time limit for each map
* '''TickRate''' - sets the server tickrate. (so far minimum stable seems around 50 and max around 120. Beware setting this changes weapon despawn time and breaks some game modes. Recommend not touching)
* '''Password''' - PIN number for server #FYI - this is now also changeable via rcon.
* '''BalanceTableURL''' - Points to a custom balance table from github. See https://github.com/vankruptgames/BalancingTable for instructions. This line isn't needed if you don't have one.
* '''MapRotation''' - you can add multiple of these. The map system has switched from the steam workshop to modio which means that the server rotation will need to be redone with modio UGCs. <nowiki>https://mod.io/g/pavlov</nowiki>. This is done by taking the resource ID from the modio page, adding “UGC” in front of it and then adding that to the rotation. For example the map gravity <nowiki>https://mod.io/g/pavlov/m/gravity1</nowiki> has a resource ID of 2773760 so the map ID to add to the server would be “UGC2773760”. When a match ends, the server will load the next map in the rotation.
* '''AFKTimeLimit''' There is now a feature to kick players who are idle in the game. Integers are measured in seconds and 0 disables AFK kicking completely.

Available game modes as of 09/06/2022: See Game modes table below

For maps running a Custom gamemode (CodZ, BR, Duel, etc.) it doesn't matter which gamemode you choose, as the map will automatically override it with the custom mode.

{| class="wikitable"
|+Limited Ammo Types
!AmmoType
!Name
!Description
|-
|0
|Unlimited
|Players have unlimited ammo, carry no ammo boxes and do not display an ammo count on the wrist.
|-
|1
|Limited Generic
|Players carry ammo boxes with a limited amount of ammo.
One box for each weapon class (Pistol, Submachine gun, Rifles/MGs, Shotgun, Sniper).

Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.

An ammo count is displayed on the wrist.
|-
|2
|Limited Specific
|Players carry ammo boxes with a limited amount of ammo.
One box for each weapon.

Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.

An ammo count is displayed on the wrist.
|-
|3
|Custom
|Allows for full control over ammo by the map.
|-
|4
| Limited Special
|'''All weapons except "special" weapons are unlimited, more clarification is needed.'''
|-
|5
|Boxless
|'''Like limited generic but without boxes? Clarification is needed.'''
|}
{| class="wikitable"
|+Game modes
!GameMode
!Name
|-
|DM
|Death match
|-
|KOTH
|King of the hill
|-
|GUN
| Gun game
|-
|OITC
| One in the chamber
|-
|SND
|Search and destroy
|-
|TANKTDM
|WW2 Team Death Match
|-
| TDM
|Team Death Match
|-
|TTT
|Trouble in Terrorist Town
|-
|WW2GUN
|WW2 gun game
|-
|ZWV
| Zombie wave survival
|-
|HIDE
|The Hidden
|-
|INFECTION
|Hidden infection
|-
|PUSH
|Push
|-
|PH
|Prop hunt
|}
= Default Map ID's =
datacenter

sand

bridge

containeryard

siberia (Prison Break)

hospital (Zombies map)

killhouse

range

tutorial

santorini

station

industry

ogcontainers (Shack only)

haguenau (Shack only)

foundation (Shack only)

stalingrad (PC only)

stalingrad_night (PC only)

santorini_night (PC only)

sand_night (PC only)

station_night (PC only)

industry_night (PC only)

bunker (PC only)

==== Firewall/Port forwarding ====
Using the default settings there are two UDP ports (7777, 8177) that need to be allowed to access the server either by firewall setup or port forwarding.

'''Ubuntu''' firewall commands to check firewall and open ports:
<pre>
sudo ufw status
sudo ufw allow 7777
sudo ufw allow 8177
sudo ufw allow 9100
sudo ufw status
</pre>

'''Rocky Linux''' firewall commands to check firewall and open ports:
<pre>
sudo firewall-cmd --zone=public --add-port=7777/tcp
sudo firewall-cmd --zone=public --add-port=7777/udp
sudo firewall-cmd --zone=public --add-port=8177/tcp
sudo firewall-cmd --zone=public --add-port=8177/udp
sudo firewall-cmd --zone=public --add-port=9100/udp
sudo firewall-cmd --zone=public --add-port=9100/tcp
sudo firewall-cmd --list-ports
firewall-cmd --runtime-to-permanent
</pre>

You may also need to allow Pings (ICMP) for the server's true latency to appear in the master list.

If you are running multiple servers and have set additional ports (see http://wiki.pavlov-vr.com/index.php?title=Dedicated_server#Running_multiple_servers_on_one_host) then you need to allow access to the defined port plus the port 400 higher. So if you use 7000 as your port, then UDP 7000 and 7400 need to be open

If you have setup rcon via RconSettings.txt (below) then that port also need to be allowed access via TCP

If you are running Shack/Quest and want to have maps that are downloadable from your server, your server ports (ex. 7777 & 8177) must also be open via TCP

----

==== Shack Maps (Quest) ====

If you try to use the steps above to add maps for Shack, youll run into issues very quickly. This is because Shack has no affiliation to Steam, and therefore cannot use Steam Workshop maps like above. In the future, these steps will apply to PC servers as well, allowing a server to hold the map itself, instead of offloading to Steam.

To get started, first create the directory to hold the maps

<pre>mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps</pre>

You can use any number of methods to move the map files onto the server, but ill go over the two simplest, starting with a GUI approach

Download and install CyberDuck onto your "home" PC (Whatever PC you use for access to the server, but not the server itsself): https://cyberduck.io/

Next, download and unzip your map of choice from https://www.pavlovquest.com/ , https://pavlovhorde.com/mapsList, or look in #shack-map-showcase channel in the discord server. I'm going to use Cheeto's WW2 Items test (http://www.mediafire.com/file/emyt9bs1z9u9ykw/SVR_Cheeto_Items.zip/file ) for this example, you do what you like

In the top left corner, open a connection, set the connection type to SFTP, and fill in the rest of the information. User will be root, password is whatever you set the root pw as (toor in Ubuntu by default)

In the directory dropdown (itll say /root) go back to /

Follow the directories until we arrive back at our "maps" folder <pre>/home/steam/pavlovserver/Pavlov/Saved/maps</pre>

Drag and drop the unzipped map folder into the main window, in this case itll be SVR_Cheeto_Items

Hit Allow

Youll now see a folder named SVR_Cheeto_Items, and within it should be nothing but 3 files. If there is another folder in it, move this folder to the maps directory, otherwise the server wont work. The 3 files (2 .PAK one .JSON) should be in home/steam/pavlovserver/Pavlov/Saved/maps/SVR_Cheeto_Items, no more, no less.

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

To play the map, you can either use RCON switch map command, or to add the map to your servers automatic map rotation list, add the map's folder name to your Game.ini. This replaces the MapID section, so for our example it would be

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

And thats all! Disconnect CyberDuck from your server before playing, otherwise youll have difficulty joining.

-----------

==== Adding Shack Maps over Command Line Interface ====

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

A bit more complicated, but adding maps over CLI has its benefits

First, CD to the maps directory you made above

<pre>cd ~/pavlovserver/Pavlov/Saved/maps</pre>

Download the map files from whatever you use to upload them. To do this, you can either use curl or wget

<pre>curl -O insertURLhere</pre>

'''If you download your map from Google Drive''', make sure that your .zip folder is shared to anyone.
Then, get the file's url from the shared link. Example : ''<nowiki>https://drive.google.com/file/d/19bI8gUHaN5tUrDvnadAacUnchQf6_k/view</nowiki>'' will be ''19bI8gUHaN5tUrDvnadAacUnchQf6_k''
Edit "fileId" and "fileName" before you execute the command.
<pre>
fileId=19bI8gUHaN5tUrDvnadAacUnchQf6_k
fileName=SVR_USER_MAPNAME
curl -sc /tmp/cookie "https://drive.google.com/uc?export=download&id=${fileId}" > /dev/null
code="$(awk '/_warning_/ {print $NF}' /tmp/cookie)"
curl -Lb /tmp/cookie "https://drive.google.com/uc?export=download&confirm=${code}&id=${fileId}" -o ${fileName} </pre>

To keep with the Items example:

<pre>curl -O https://cdn.discordapp.com/attachments/744185280759857234/745027406695366788/SVR_Cheeto_Items.zip</pre>

Next, unzip the file. If this next step errors out, saying the command is unknown, switch back to the root user (su root), and install unzip (sudo apt install unzip), then return to the steam user, and continue.

<pre>unzip SVR_Cheeto_Items.zip</pre>

Now finish like before by adding the map to your Game.ini

<pre>nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini</pre>

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

==== Admin/Moderator list (optional) ====

The only working in-game admin menu is through Arctic VR server hosting (see below).

If you add moderators to your server, they will not be subject to vote kicks.

<pre>
nano ~/pavlovserver/Pavlov/Saved/Config/mods.txt
</pre>

Example Mod List:
<pre>
76541198397498572 #Optional Comment: Player name
76541198397498573 #Some Other Player
</pre>

==== ArcticVR Admin Menu ====

[[File:Arcticmenu.jpg|500px|link=https://www.arctic-vr.com/server-admin-menu]]

Arctic-VR Offers an advanced In-Game Admin menu that is exclusive to their hosting service. Features include:
* Switch Maps+Modes
* Teleport Players to Players
* Change Player Skins
* Control Player Buying+Cash
* Spawn Items
* Clean up corpses + guns
* Spawn Bots
* Spawn Items for other players
* Control Teams + Balance/Shuffle Teams
* ResetSND
* And More

You can read more about the ArcticVR admin menu on their website: https://www.arctic-vr.com/server-admin-menu

==== Handy tools for finding steamIDs ====

Steam ID finder: https://steamidfinder.com/lookup/ or https://steamid.xyz/

You want to enter in the steamID64 format.

This tool can convert or lookup IDs: https://steamid.io/

If you are looking for a steamID of a player that has been on your server recently this is technique to find them:
<pre>
grep -i playername ~/pavlovserver/Pavlov/Saved/Logs/* | grep TicketValidation
</pre>

=== Configure Rcon ===
To enable Rcon access create config file:
<pre> nano /home/steam/pavlovserver/Pavlov/Saved/Config/RconSettings.txt </pre>

Copy in the following text - change password, and if desired the port:
<pre>
Password=ChangeThisPassword
Port=9100
</pre>
You must specify a port for the Rcon server to use as well as a Password (use a different port per sever instance if running multiple server instances off the same hardware)

=== Starting the server ===

<pre>
cd ~/pavlovserver && ./PavlovServer.sh
</pre>

That's it, your server will be automatically broadcast to the master server! :)

Two handy tools to determine quickly if your server is broadcasting are [https://pablub.xyz/ Pablub] (PC only) and [https://pavlovhorde.com/ Horde] (Shack) and [https://pavlovhorde.com/pcServers Horde] (PC version)

Note that when you close your terminal, the server will go down. See the "supervisors" section below for how to prevent this.

----

=== Supervising the server using systemd ===

Running '''./PavlovServer.sh''' in your interactive shell is easy, but the server will shut down when you close your terminal. If you want to run the server in the background,
you'll want to run it under a supervisor. There are many options, ranging from the simple (nohup, screen or tmux), to the
more robust (supervisord, systemd).

Systemd is running by default on Ubuntu Linux, so we'll use that here.

To run the server as a systemd service, create the file '''/etc/systemd/system/pavlovserver.service''' (as root) by typing
<pre>
sudo nano /etc/systemd/system/pavlovserver.service
</pre>

Copy contents below into the file and save.

<pre>
[Unit]
Description=Pavlov VR dedicated server

[Service]
Type=simple
WorkingDirectory=/home/steam/pavlovserver
ExecStart=/home/steam/pavlovserver/PavlovServer.sh

RestartSec=1
Restart=always
User=steam
Group=steam

[Install]
WantedBy = multi-user.target
</pre>

If you'd like your server to start as competitive without editing the game.ini, change the line "ExecStart=/home/steam/pavlovserver/PavlovServer.sh" to look like this below. Though it's much easier to just use the game.ini to enable competitive instead. <pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -COMPETITIVE=1</pre>

Change the user or paths as appropriate. After saving the service file, to start, restart, stop, or monitor the server:

<pre>
sudo systemctl start pavlovserver
sudo systemctl restart pavlovserver
sudo systemctl stop pavlovserver
sudo systemctl status pavlovserver
</pre>

To view the logs:

<pre>
sudo journalctl -u pavlovserver
# to live-tail the logs
sudo journalctl -u pavlovserver -f
</pre>

If you want to run the pavlov server as soon as your server boots (e.g. a VPS you turn on and off), add pavlov as a startup service:

<pre>
sudo systemctl enable pavlovserver
</pre>

----

== Advanced Server Administration ==

=== Running multiple servers on one host ===

* Pavlovserver is functionally single threaded (there are multiple threads, but vast majority of work occurs in the primary one). Make sure you have # of pavlovservers + 1 CPU available. More CPUs= more servers. Faster CPU = more players.
* Make multiple server installs by defining a separate install dir for each server.
* Run each server with a unique port. eg: '''./PavlovServer.sh -PORT="Desired Port"'''
* The Server will use the Desired Port and the Port 400 above (Example: You choose 8200 as Port. So Port 8600 will be used as well)
* If you are using RCON, each server will need a unique port defined in RconSettings.txt
* Ensure the ports are forwarded and opened in your firewall

To duplicate directories:

be in the steam home folder
<pre>
cp -r pavlovserver pavlovserver1
/home/steam/pavlovserver1/PavlovServer.sh -PORT=[Desired Port]
</pre>

=== Starting server in competitive mode ===
Competitive mode will prevent dead teammates from being able to see the match, to prevent ghosting.
You can either enable this via Game.ini (described in Game.ini file), or using the -COMPETITIVE=1 parameter.

<pre>
/home/steam/pavlovserver1/PavlovServer.sh -COMPETITIVE=1
</pre>

{| class="wikitable"

|}

=== Useful Linux Commands ===
List files / folders in directory, print current working directory,
<pre>ls -la #list files/directories along with authorities and ownership
pwd #print working directory
sudo chown <owner> <file/directory> #change owner of file/directory. If root created something and you need to change it to steam
sudo chgrp <group> <file/directory> #change group of file/directory.
</pre>

Check if pavlov is running by checking process status. If the only row you see is the grep command, pavlov server is not started.
<pre> ps -ef | grep pav </pre>

Sample output:
<pre>
steam 34044 1 0 16:52 ? 00:00:00 /bin/sh /home/steam/pavlovserver/PavlovServer.sh
steam 34066 34044 80 16:52 ? 00:00:04 /home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer
zombies+ 34101 34013 0 16:52 pts/0 00:00:00 grep --color=auto pav
</pre>

Kill a process. Note this command uses 34044, which is a process id from the command output above.
<pre> kill -9 34044 </pre>

Dump the log to the console so you can scroll through it:
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log </pre>

Search the log for a string - replace my_string with case-sensitive string
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep my_string </pre>

<hr>
=== Advanced Scripts For Server Management ===
<hr>
==== Auto-updating the server ====
Assuming you have followed this guide and used the default paths, users, and install instructions, you can paste the following into your terminal to auto-update your Pavlov server:

<pre>
cat << 'EOF' > $HOME/pavlov_daily_update_and_restart.sh
#!/bin/bash

USER="steam"
SERVICENAME="pavlovserver.service"
INSTALLDIRNAME="pavlovserver"
USERHOME="/home/$USER"

echo -e "Beginning Pavlov VR update run on $(date)\n\n"

systemctl stop "$SERVICENAME"

sleep 5
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +force_install_dir "$USERHOME/$INSTALLDIRNAME" +app_update 622970 +exit
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +app_update 1007 +quit
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/.steam/sdk64/steamclient.so"
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/pavlovserver/Pavlov/Binaries/Linux/steamclient.so"

systemctl start "$SERVICENAME"

echo -e "Ending Pavlov VR update run on $(date)\n\n"

EOF

chmod +x $HOME/pavlov_daily_update_and_restart.sh
mkdir $HOME/pavlov_update_logs && touch $HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log
CRONLINE="00 2 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
(sudo crontab -u root -l; echo "$CRONLINE" ) | sudo crontab -u root -
unset CRONLINE

</pre>

These commands will:

1. Create a shell script in the "steam" user's home directory that automatically stops the Pavlov server, pulls any updates via steam, pull updates to the Steamworks SDK Redist, and copies the latest version of steamclient.so to the Pavlov server directory

2. Make the shell script executable

3. Create a new directory called "pavlov_update_logs" in the "steam" user's directory, and create a logfile inside that directory called "pavlov_daily_update_and_restart.sh.log". You can check this logfile to see the output of the Pavlov and Steam SDK update commands.

4. Create a crontab entry for the root user that runs this shell script automatically every day at 2:00AM local time

If you want to change the time that this script runs, edit the numbers "00 2" in the line that starts with "CRONLINE=". In the example provided, 00 is the minutes column, and 2 is the hour column. For example, if you wanted the server to automatically update and restart at 4:17AM every day, change the line starting with "CRONLINE=" to:

<pre>
CRONLINE="17 4 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
</pre>

If the time is PM, use 24-hour time format, e.g. "32 18" for 6:32PM.

Setting up a dedicated server

2023-07-17T16:26:09Z

SaltedCrackerJack: /* Advanced Scripts For Server Management */

== Setting up a dedicated server ==

'''There are no Windows binaries'''

This guide is written exclusively for Linux and covers Ubuntu/Debian/Debian-like and Red Hat RPM-based distros. Possible to run with other distros, but some of the commands won't work and you will need to know enough to figure out the software install of dependencies on your own.

If you are considering hosting from home, please read that section of the wiki first.

This guide assumes you know the basics of using a bash terminal: ssh'ing into a server, running bash commands, editing text files, etc.

If you have no experience using bash, maybe start [https://www.howtogeek.com/140679/beginner-geek-how-to-start-using-the-linux-terminal/ here]. Editing text files via commandline is often a challenge. Suggest using nano and reading guide [https://www.howtogeek.com/howto/42980/the-beginners-guide-to-nano-the-linux-command-line-text-editor/ here]

If you are new to linux and accessing your server from Windows, highly suggest using MobaXterm as your SSH client as that can make required editing of text files easier using built in editor instead of the native linux command line editors.

And finally, ask yourself why you want to setup a server? If you look at the list, there are many, many more servers than players. If you don't have a team, discord community, or group of friends ready to play on your server, chances are it will go unused. Got one of these... great, let's go.

If you don't want to go through the hassle yourself and want to pay for a hosting service Arctic VR (PC and Shack) and Horde (Shack) provide a server hosting services and are trusted in the community. See links below.

----

=== Server Requirements ===

'''Pavlovserver can only be hosted under Linux.'''

This can be running as a VM under windows, but this will increase the complexity of the setup beyond this guide.

Ubuntu 18.04 x86_64, Ubuntu 19/04 amd64, Ubuntu 20.04, and Rocky Linux 8 are confirmed working. Ubuntu 15.04 x86 is known to fail to install using this guide. Recommend not running on "minimal" images as some tools are missing.

* 2GB RAM + 1GB RAM per each additional server with 10 players. More RAM is recommended for larger maps, higher player counts, or complex gamemodes. Not having enough RAM is a common cause of server crashes.

* A ~2.5Ghz CPU will comfortably support a 10 player server.

* A ~4Ghz CPU will comfortably support 24 players. This is a limit built into Pavlov itself, no server will allow players to join over 24. Lower player counts are recommended for complex gamemodes (E.g. CodZ) and/or highly detailed maps, so that maximum number will often be lower.

(Note that these are '''not''' hard limits for player counts, just suggestions for the best performance, based on experiences with many server providers on different grades of hardware.)

* Pavlovserver is functionally single threaded (one thread does vast majority of work). More CPUs only help if you are running more servers. More clockspeed = higher performance = more users per server.
The maximum number of servers you can run is dependent on how many CPUs you have. For example, if you have an 8 core CPU, the maximum number of servers would be 7. You should always have at least one CPU free as overhead, as Pavlov servers can use slightly more than one thread.

----

==== Hosting at home ====
When hosting at home there are additional requirements regarding networking: Your router has to support port-forwarding, hair-pinning/LoopbackNAT, and respond to ping requests. These techniques are necessary to allow your server to be found and to talk back to the client. please see https://en.wikipedia.org/wiki/Port_forwarding, https://en.wikipedia.org/wiki/Hairpinning, and https://www.speedguide.net/faq/how-to-become-pingable-behind-a-routerfirewall-376 for more info and google for these terms in addition to your router model to find guides on how to enable/configure it properly. If you have modern Router, it may have these features already enabled, in this case you just have to configure port-forwarding. If you can see your server but not join it while others can, this is indicative of a failure of LoopbackNAT.

A second challenge to hosting at home is CGNAT (Carrier grade NAT: https://www.a10networks.com/blog/carrier-grade-nat/). Just like NAT on your home network that has to be gotten around w/ port-forwarding, CGNAT breaks the ability of external connections to be made back to your server, but the controls are solely in your ISPs hands. Sometimes if you ask, you can be removed from CGNAT pools and/or assigned a static IP. CGNAT rollouts are becoming very common now, so if your server worked then doesn't allow connections now, your ISP may have made this change.

You can check whether you’re on a CGNAT network by visiting a Web site such as ipaddress.com or whatsmyip.com and comparing the IP address listed to the public/WAN IP address assigned to your Internet gateway. To find your gateway’s public IP address, check the status page in the administrative interface. If the two IP addresses differ, you’re likely on a CGNAT network. If so, this problem must be resolved before you go any further.

'''Not understanding these requirements and configuration is a frequent cause of failed setups and questions in discord. Don't skip this if you are trying to host from home'''

'''There are serious security implications of hosting this software at home.''' None of the devs are security experts and there has been no security review of the code. You are opening up your system to the world and publicity advertising this fact. Expect that any system hosting this software is open to compromise from the Internet and act accordingly. If your router offers a DMZ network, use it. Consider hosting on a cloud based server and think twice before running this software on any system that contains data you care about or has access to networks and computers you care about.

If you're hosting at home using Oracle's VirtualBox, there are steps you can take to prevent double NAT (which can cause issues later on)

1. Select your VM and then click Settings in VirtualBox's main window.

2. Click on Network and change Attached To from NAT to Bridged Adapter.

Once you've done this, your VM should be connected directly to your home router and double NAT should no longer be a issue.

----

==== Starting Server Install ====

====Obtaining an ApiKey====
For your server to show up in the server list, there is now a requirement to have an ApiKey issued by vankrupt. This is to prevent DOS attacks against the master server

Get the key by going here: https://pavlov-ms.vankrupt.com/servers/v1/key and using your mobile number to get a SMS
(note that there have been reported failures of this SMS system for non-US mobiles. In this case DM davevillz your mobile and ask for a key)

Put this key in your Game.ini as follows:
ApiKey="ABC123FALSEKEYDONTUSEME"
or if you would like (personally untested..I would use game.ini) you can call it at server runtime with flag as follows:
-KEY="ABC123FALSEKEYDONTUSEME"

This key can be re-used for a reasonable number of servers (a limit of 10 has been mentioned). Contact the Devs if you need more servers per key.

====System setup and software installation====

Install dependencies and create the `steam` user. (You only need to do this once):

Confirm Linux version
<pre>
lsb_release -a
</pre>

'''Ubuntu 20.04'''
<pre>
sudo apt update && sudo apt install -y gdb curl lib32gcc1 libc++-dev unzip
sudo useradd -m steam
</pre>

'''Ubuntu 20.10 or higher'''
<pre>
sudo apt update && sudo apt install -y gdb curl lib32gcc-s1 libc++-dev unzip
sudo useradd -m steam
</pre>

'''Rocky Linux, CentOS 8, and RHEL 8'''

<pre>
sudo sed -i 's/^SELINUX=enforcing$/SELINUX=permissive/g' /etc/selinux/config
sudo setenforce 0
sudo yum install gdb curl glibc.i686 libstdc++.i686 libstdc++-devel.i686 libstdc++-devel.x86_64 unzip wget -y
wget https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/l/libcxx-3.8.0-3.el7.x86_64.rpm
sudo rpm -i libcxx-3.8.0-3.el7.x86_64.rpm
sudo useradd -m steam
</pre>

[Optional] Set a password for steam.
<pre>sudo passwd steam</pre>

Login as the steam user. ('''You will need to do this each time you connect to your server'''):

<pre>
sudo su -l steam
</pre>

Install Steam:

<pre>
mkdir ~/Steam && cd ~/Steam && curl -sqL "https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz" | tar zxvf -
</pre>

There are different dedicated server versions for Pavlov Server - choose which server version you want to host (PC non-beta, PC Beta, Shack Live, or Shack RC)
(You will need to run this command each time there is a Pavlov Server update).

 
To host '''PC Server (non-beta)''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta default +exit
</pre>

To host '''PC BETA''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta beta_server +exit
</pre>

To host '''Shack Live''' (Quest):

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack +exit
</pre>

To host '''Shack RC''' (Quest): 

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack_beta +exit
</pre>

Now that we've installed the server, all pavlov server versions should continue. 
Install a fresh copy of steamclient.so (May have to do this after each update):
<pre>
~/Steam/steamcmd.sh +login anonymous +app_update 1007 +quit
mkdir -p ~/.steam/sdk64
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/pavlovserver/Pavlov/Binaries/Linux/steamclient.so
</pre>

The update 29 of the PCVR version of pavlov and after added a requirement to run these commands to change the steamclient.so:
<code>sudo rm /usr/lib/x86_64-linux-gnu/libc++.so</code>
<code>sudo ln -s /usr/lib/x86_64-linux-gnu/libc++.so.1 /usr/lib/x86_64-linux-gnu/libc++.so</code>

Make the PavlovServer script executable. (You only need to do this once):

<pre>
chmod +x ~/pavlovserver/PavlovServer.sh
</pre>

----

=== Server Configuration ===

Before starting the server we need to configure it. Start by creating some directories:

<pre>
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Logs
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps
</pre>

==== Mods/Blacklist/Whitelist (optional) ====

The following three files allow you to specify mods, banned players, and whitelist players. These are optional, but go ahead and create them. Populating the files is described later.

<pre>
touch /home/steam/pavlovserver/Pavlov/Saved/Config/mods.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/blacklist.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/whitelist.txt
</pre>

====Configuring Game.ini====
Create a new Game.ini file using following command to open an editor and copy/paste the following block into it then save it. Note not all of these options are required. For instance remove or comment out the Password=0000 line to make a public server with no pin.
<pre>
nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini
</pre>

<pre>
[/Script/Pavlov.DedicatedServer]
bEnabled=true
ServerName="My_private_idaho"
MaxPlayers=10 #Set this to 10 for Shack. 24 is the max for PC, setting it higher will not allow players to join.
ApiKey="ABC123FALSEKEYDONTUSEME"
bSecured=true
bCustomServer=true
bVerboseLogging=false
bCompetitive=false #This only works for SND
bWhitelist=false
RefreshListTime=120
LimitedAmmoType=0
TickRate=90
TimeLimit=60
#Password=0000
#BalanceTableURL="vankruptgames/BalancingTable/main"
MapRotation=(MapId="UGC1758245796", GameMode="GUN")
MapRotation=(MapId="datacenter", GameMode="SND")
MapRotation=(MapId="sand", GameMode="DM")

</pre>

* '''bEnabled''' - whether the server appears in the server list (unconfirmed)
* '''ServerName''' - name it will be listed as. (approx 35 chars max)
* '''MaxPlayers''' - See suggested specs for limits. 10 standard (10 for shack), 20-24 is max recommended for large maps like Stalingrad or PUSH/RUSH modes, and servers allow a maximum of 24 players.
* '''ApiKey''' - Unique ApiKey required to register server with master server. Replace with your key
* '''bSecured''' - enabled Valve Anti-Cheat (VAC)
* '''bCustomServer''' - activates some new modding tools (save and http functions. Required to write to blacklist.txt for bans)
* '''bCompetitive''' - sets the server to competitive mode for SND. If removed the server will default to false
* '''bVerboseLogging''' - enables verbose logging, mostly detailed statistics. Be prepared for significant increase in logging.
* '''bWhitelist''' - Only allow users in whitelist.txt to join
* '''RefreshListTime''' - sets how often the running server checks for updates in ban/whitelist/mod files
* '''LimitedAmmoType''' - sets limited ammo mode, see Limited Ammo Types table below

* '''TimeLimit''' - sets time limit for each map
* '''TickRate''' - sets the server tickrate. (so far minimum stable seems around 50 and max around 120. Beware setting this changes weapon despawn time and breaks some game modes. Recommend not touching)
* '''Password''' - PIN number for server #FYI - this is now also changeable via rcon.
* '''BalanceTableURL''' - Points to a custom balance table from github. See https://github.com/vankruptgames/BalancingTable for instructions. This line isn't needed if you don't have one.
* '''MapRotation''' - you can add multiple of these. The map system has switched from the steam workshop to modio which means that the server rotation will need to be redone with modio UGCs. <nowiki>https://mod.io/g/pavlov</nowiki>. This is done by taking the resource ID from the modio page, adding “UGC” in front of it and then adding that to the rotation. For example the map gravity <nowiki>https://mod.io/g/pavlov/m/gravity1</nowiki> has a resource ID of 2773760 so the map ID to add to the server would be “UGC2773760”. When a match ends, the server will load the next map in the rotation.
* '''AFKTimeLimit''' There is now a feature to kick players who are idle in the game. Integers are measured in seconds and 0 disables AFK kicking completely.

Available game modes as of 09/06/2022: See Game modes table below

For maps running a Custom gamemode (CodZ, BR, Duel, etc.) it doesn't matter which gamemode you choose, as the map will automatically override it with the custom mode.

{| class="wikitable"
|+Limited Ammo Types
!AmmoType
!Name
!Description
|-
|0
|Unlimited
|Players have unlimited ammo, carry no ammo boxes and do not display an ammo count on the wrist.
|-
|1
|Limited Generic
|Players carry ammo boxes with a limited amount of ammo.
One box for each weapon class (Pistol, Submachine gun, Rifles/MGs, Shotgun, Sniper).

Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.

An ammo count is displayed on the wrist.
|-
|2
|Limited Specific
|Players carry ammo boxes with a limited amount of ammo.
One box for each weapon.

Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.

An ammo count is displayed on the wrist.
|-
|3
|Custom
|Allows for full control over ammo by the map.
|-
|4
| Limited Special
|'''All weapons except "special" weapons are unlimited, more clarification is needed.'''
|-
|5
|Boxless
|'''Like limited generic but without boxes? Clarification is needed.'''
|}
{| class="wikitable"
|+Game modes
!GameMode
!Name
|-
|DM
|Death match
|-
|KOTH
|King of the hill
|-
|GUN
| Gun game
|-
|OITC
| One in the chamber
|-
|SND
|Search and destroy
|-
|TANKTDM
|WW2 Team Death Match
|-
| TDM
|Team Death Match
|-
|TTT
|Trouble in Terrorist Town
|-
|WW2GUN
|WW2 gun game
|-
|ZWV
| Zombie wave survival
|-
|HIDE
|The Hidden
|-
|INFECTION
|Hidden infection
|-
|PUSH
|Push
|-
|PH
|Prop hunt
|}
= Default Map ID's =
datacenter

sand

bridge

containeryard

siberia (Prison Break)

hospital (Zombies map)

killhouse

range

tutorial

santorini

station

industry

ogcontainers (Shack only)

haguenau (Shack only)

foundation (Shack only)

stalingrad (PC only)

stalingrad_night (PC only)

santorini_night (PC only)

sand_night (PC only)

station_night (PC only)

industry_night (PC only)

bunker (PC only)

==== Firewall/Port forwarding ====
Using the default settings there are two UDP ports (7777, 8177) that need to be allowed to access the server either by firewall setup or port forwarding.

'''Ubuntu''' firewall commands to check firewall and open ports:
<pre>
sudo ufw status
sudo ufw allow 7777
sudo ufw allow 8177
sudo ufw allow 9100
sudo ufw status
</pre>

'''Rocky Linux''' firewall commands to check firewall and open ports:
<pre>
sudo firewall-cmd --zone=public --add-port=7777/tcp
sudo firewall-cmd --zone=public --add-port=7777/udp
sudo firewall-cmd --zone=public --add-port=8177/tcp
sudo firewall-cmd --zone=public --add-port=8177/udp
sudo firewall-cmd --zone=public --add-port=9100/udp
sudo firewall-cmd --zone=public --add-port=9100/tcp
sudo firewall-cmd --list-ports
firewall-cmd --runtime-to-permanent
</pre>

You may also need to allow Pings (ICMP) for the server's true latency to appear in the master list.

If you are running multiple servers and have set additional ports (see http://wiki.pavlov-vr.com/index.php?title=Dedicated_server#Running_multiple_servers_on_one_host) then you need to allow access to the defined port plus the port 400 higher. So if you use 7000 as your port, then UDP 7000 and 7400 need to be open

If you have setup rcon via RconSettings.txt (below) then that port also need to be allowed access via TCP

If you are running Shack/Quest and want to have maps that are downloadable from your server, your server ports (ex. 7777 & 8177) must also be open via TCP

----

==== Shack Maps (Quest) ====

If you try to use the steps above to add maps for Shack, youll run into issues very quickly. This is because Shack has no affiliation to Steam, and therefore cannot use Steam Workshop maps like above. In the future, these steps will apply to PC servers as well, allowing a server to hold the map itself, instead of offloading to Steam.

To get started, first create the directory to hold the maps

<pre>mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps</pre>

You can use any number of methods to move the map files onto the server, but ill go over the two simplest, starting with a GUI approach

Download and install CyberDuck onto your "home" PC (Whatever PC you use for access to the server, but not the server itsself): https://cyberduck.io/

Next, download and unzip your map of choice from https://www.pavlovquest.com/ , https://pavlovhorde.com/mapsList, or look in #shack-map-showcase channel in the discord server. I'm going to use Cheeto's WW2 Items test (http://www.mediafire.com/file/emyt9bs1z9u9ykw/SVR_Cheeto_Items.zip/file ) for this example, you do what you like

In the top left corner, open a connection, set the connection type to SFTP, and fill in the rest of the information. User will be root, password is whatever you set the root pw as (toor in Ubuntu by default)

In the directory dropdown (itll say /root) go back to /

Follow the directories until we arrive back at our "maps" folder <pre>/home/steam/pavlovserver/Pavlov/Saved/maps</pre>

Drag and drop the unzipped map folder into the main window, in this case itll be SVR_Cheeto_Items

Hit Allow

Youll now see a folder named SVR_Cheeto_Items, and within it should be nothing but 3 files. If there is another folder in it, move this folder to the maps directory, otherwise the server wont work. The 3 files (2 .PAK one .JSON) should be in home/steam/pavlovserver/Pavlov/Saved/maps/SVR_Cheeto_Items, no more, no less.

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

To play the map, you can either use RCON switch map command, or to add the map to your servers automatic map rotation list, add the map's folder name to your Game.ini. This replaces the MapID section, so for our example it would be

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

And thats all! Disconnect CyberDuck from your server before playing, otherwise youll have difficulty joining.

-----------

==== Adding Shack Maps over Command Line Interface ====

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

A bit more complicated, but adding maps over CLI has its benefits

First, CD to the maps directory you made above

<pre>cd ~/pavlovserver/Pavlov/Saved/maps</pre>

Download the map files from whatever you use to upload them. To do this, you can either use curl or wget

<pre>curl -O insertURLhere</pre>

'''If you download your map from Google Drive''', make sure that your .zip folder is shared to anyone.
Then, get the file's url from the shared link. Example : ''<nowiki>https://drive.google.com/file/d/19bI8gUHaN5tUrDvnadAacUnchQf6_k/view</nowiki>'' will be ''19bI8gUHaN5tUrDvnadAacUnchQf6_k''
Edit "fileId" and "fileName" before you execute the command.
<pre>
fileId=19bI8gUHaN5tUrDvnadAacUnchQf6_k
fileName=SVR_USER_MAPNAME
curl -sc /tmp/cookie "https://drive.google.com/uc?export=download&id=${fileId}" > /dev/null
code="$(awk '/_warning_/ {print $NF}' /tmp/cookie)"
curl -Lb /tmp/cookie "https://drive.google.com/uc?export=download&confirm=${code}&id=${fileId}" -o ${fileName} </pre>

To keep with the Items example:

<pre>curl -O https://cdn.discordapp.com/attachments/744185280759857234/745027406695366788/SVR_Cheeto_Items.zip</pre>

Next, unzip the file. If this next step errors out, saying the command is unknown, switch back to the root user (su root), and install unzip (sudo apt install unzip), then return to the steam user, and continue.

<pre>unzip SVR_Cheeto_Items.zip</pre>

Now finish like before by adding the map to your Game.ini

<pre>nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini</pre>

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

==== Admin/Moderator list (optional) ====

The only working in-game admin menu is through Arctic VR server hosting (see below).

If you add moderators to your server, they will not be subject to vote kicks.

<pre>
nano ~/pavlovserver/Pavlov/Saved/Config/mods.txt
</pre>

Example Mod List:
<pre>
76541198397498572 #Optional Comment: Player name
76541198397498573 #Some Other Player
</pre>

==== ArcticVR Admin Menu ====

[[File:Arcticmenu.jpg|500px|link=https://www.arctic-vr.com/server-admin-menu]]

Arctic-VR Offers an advanced In-Game Admin menu that is exclusive to their hosting service. Features include:
* Switch Maps+Modes
* Teleport Players to Players
* Change Player Skins
* Control Player Buying+Cash
* Spawn Items
* Clean up corpses + guns
* Spawn Bots
* Spawn Items for other players
* Control Teams + Balance/Shuffle Teams
* ResetSND
* And More

You can read more about the ArcticVR admin menu on their website: https://www.arctic-vr.com/server-admin-menu

==== Handy tools for finding steamIDs ====

Steam ID finder: https://steamidfinder.com/lookup/ or https://steamid.xyz/

You want to enter in the steamID64 format.

This tool can convert or lookup IDs: https://steamid.io/

If you are looking for a steamID of a player that has been on your server recently this is technique to find them:
<pre>
grep -i playername ~/pavlovserver/Pavlov/Saved/Logs/* | grep TicketValidation
</pre>

=== Configure Rcon ===
To enable Rcon access create config file:
<pre> nano /home/steam/pavlovserver/Pavlov/Saved/Config/RconSettings.txt </pre>

Copy in the following text - change password, and if desired the port:
<pre>
Password=ChangeThisPassword
Port=9100
</pre>
You must specify a port for the Rcon server to use as well as a Password (use a different port per sever instance if running multiple server instances off the same hardware)

=== Starting the server ===

<pre>
cd ~/pavlovserver && ./PavlovServer.sh
</pre>

That's it, your server will be automatically broadcast to the master server! :)

Two handy tools to determine quickly if your server is broadcasting are [https://pablub.xyz/ Pablub] (PC only) and [https://pavlovhorde.com/ Horde] (Shack) and [https://pavlovhorde.com/pcServers Horde] (PC version)

Note that when you close your terminal, the server will go down. See the "supervisors" section below for how to prevent this.

----

=== Supervising the server using systemd ===

Running '''./PavlovServer.sh''' in your interactive shell is easy, but the server will shut down when you close your terminal. If you want to run the server in the background,
you'll want to run it under a supervisor. There are many options, ranging from the simple (nohup, screen or tmux), to the
more robust (supervisord, systemd).

Systemd is running by default on Ubuntu Linux, so we'll use that here.

To run the server as a systemd service, create the file '''/etc/systemd/system/pavlovserver.service''' (as root) by typing
<pre>
sudo nano /etc/systemd/system/pavlovserver.service
</pre>

Copy contents below into the file and save.

<pre>
[Unit]
Description=Pavlov VR dedicated server

[Service]
Type=simple
WorkingDirectory=/home/steam/pavlovserver
ExecStart=/home/steam/pavlovserver/PavlovServer.sh

RestartSec=1
Restart=always
User=steam
Group=steam

[Install]
WantedBy = multi-user.target
</pre>

If you'd like your server to start as competitive without editing the game.ini, change the line "ExecStart=/home/steam/pavlovserver/PavlovServer.sh" to look like this below. Though it's much easier to just use the game.ini to enable competitive instead. <pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -COMPETITIVE=1</pre>

Change the user or paths as appropriate. After saving the service file, to start, restart, stop, or monitor the server:

<pre>
sudo systemctl start pavlovserver
sudo systemctl restart pavlovserver
sudo systemctl stop pavlovserver
sudo systemctl status pavlovserver
</pre>

To view the logs:

<pre>
sudo journalctl -u pavlovserver
# to live-tail the logs
sudo journalctl -u pavlovserver -f
</pre>

If you want to run the pavlov server as soon as your server boots (e.g. a VPS you turn on and off), add pavlov as a startup service:

<pre>
sudo systemctl enable pavlovserver
</pre>

----

== Advanced Server Administration ==

=== Running multiple servers on one host ===

* Pavlovserver is functionally single threaded (there are multiple threads, but vast majority of work occurs in the primary one). Make sure you have # of pavlovservers + 1 CPU available. More CPUs= more servers. Faster CPU = more players.
* Make multiple server installs by defining a separate install dir for each server.
* Run each server with a unique port. eg: '''./PavlovServer.sh -PORT="Desired Port"'''
* The Server will use the Desired Port and the Port 400 above (Example: You choose 8200 as Port. So Port 8600 will be used as well)
* If you are using RCON, each server will need a unique port defined in RconSettings.txt
* Ensure the ports are forwarded and opened in your firewall

To duplicate directories:

be in the steam home folder
<pre>
cp -r pavlovserver pavlovserver1
/home/steam/pavlovserver1/PavlovServer.sh -PORT=[Desired Port]
</pre>

=== Starting server in competitive mode ===
Competitive mode will prevent dead teammates from being able to see the match, to prevent ghosting.
You can either enable this via Game.ini (described in Game.ini file), or using the -COMPETITIVE=1 parameter.

<pre>
/home/steam/pavlovserver1/PavlovServer.sh -COMPETITIVE=1
</pre>

{| class="wikitable"

|}

=== Useful Linux Commands ===
List files / folders in directory, print current working directory,
<pre>ls -la #list files/directories along with authorities and ownership
pwd #print working directory
sudo chown <owner> <file/directory> #change owner of file/directory. If root created something and you need to change it to steam
sudo chgrp <group> <file/directory> #change group of file/directory.
</pre>

Check if pavlov is running by checking process status. If the only row you see is the grep command, pavlov server is not started.
<pre> ps -ef | grep pav </pre>

Sample output:
<pre>
steam 34044 1 0 16:52 ? 00:00:00 /bin/sh /home/steam/pavlovserver/PavlovServer.sh
steam 34066 34044 80 16:52 ? 00:00:04 /home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer
zombies+ 34101 34013 0 16:52 pts/0 00:00:00 grep --color=auto pav
</pre>

Kill a process. Note this command uses 34044, which is a process id from the command output above.
<pre> kill -9 34044 </pre>

Dump the log to the console so you can scroll through it:
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log </pre>

Search the log for a string - replace my_string with case-sensitive string
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep my_string </pre>

<hr>
=== Advanced Scripts For Server Management ===
<nowiki></nowiki>
<hr>

=== Auto-updating the server ===

Assuming you have followed this guide and used the default paths, users, and install instructions, you can paste the following into your terminal to auto-update your Pavlov server:

<pre>
cat << 'EOF' > $HOME/pavlov_daily_update_and_restart.sh
#!/bin/bash

USER="steam"
SERVICENAME="pavlovserver.service"
INSTALLDIRNAME="pavlovserver"
USERHOME="/home/$USER"

echo -e "Beginning Pavlov VR update run on $(date)\n\n"

systemctl stop "$SERVICENAME"

sleep 5
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +force_install_dir "$USERHOME/$INSTALLDIRNAME" +app_update 622970 +exit
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +app_update 1007 +quit
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/.steam/sdk64/steamclient.so"
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/pavlovserver/Pavlov/Binaries/Linux/steamclient.so"

systemctl start "$SERVICENAME"

echo -e "Ending Pavlov VR update run on $(date)\n\n"

EOF

chmod +x $HOME/pavlov_daily_update_and_restart.sh
mkdir $HOME/pavlov_update_logs && touch $HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log
CRONLINE="00 2 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
(sudo crontab -u root -l; echo "$CRONLINE" ) | sudo crontab -u root -
unset CRONLINE

</pre>

These commands will:

1. Create a shell script in the "steam" user's home directory that automatically stops the Pavlov server, pulls any updates via steam, pull updates to the Steamworks SDK Redist, and copies the latest version of steamclient.so to the Pavlov server directory

2. Make the shell script executable

3. Create a new directory called "pavlov_update_logs" in the "steam" user's directory, and create a logfile inside that directory called "pavlov_daily_update_and_restart.sh.log". You can check this logfile to see the output of the Pavlov and Steam SDK update commands.

4. Create a crontab entry for the root user that runs this shell script automatically every day at 2:00AM local time

If you want to change the time that this script runs, edit the numbers "00 2" in the line that starts with "CRONLINE=". In the example provided, 00 is the minutes column, and 2 is the hour column. For example, if you wanted the server to automatically update and restart at 4:17AM every day, change the line starting with "CRONLINE=" to:

<pre>
CRONLINE="17 4 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
</pre>

If the time is PM, use 24-hour time format, e.g. "32 18" for 6:32PM.

Setting up a dedicated server

2023-07-17T16:25:17Z

SaltedCrackerJack: /* Useful Linux Commands */

== Setting up a dedicated server ==

'''There are no Windows binaries'''

This guide is written exclusively for Linux and covers Ubuntu/Debian/Debian-like and Red Hat RPM-based distros. Possible to run with other distros, but some of the commands won't work and you will need to know enough to figure out the software install of dependencies on your own.

If you are considering hosting from home, please read that section of the wiki first.

This guide assumes you know the basics of using a bash terminal: ssh'ing into a server, running bash commands, editing text files, etc.

If you have no experience using bash, maybe start [https://www.howtogeek.com/140679/beginner-geek-how-to-start-using-the-linux-terminal/ here]. Editing text files via commandline is often a challenge. Suggest using nano and reading guide [https://www.howtogeek.com/howto/42980/the-beginners-guide-to-nano-the-linux-command-line-text-editor/ here]

If you are new to linux and accessing your server from Windows, highly suggest using MobaXterm as your SSH client as that can make required editing of text files easier using built in editor instead of the native linux command line editors.

And finally, ask yourself why you want to setup a server? If you look at the list, there are many, many more servers than players. If you don't have a team, discord community, or group of friends ready to play on your server, chances are it will go unused. Got one of these... great, let's go.

If you don't want to go through the hassle yourself and want to pay for a hosting service Arctic VR (PC and Shack) and Horde (Shack) provide a server hosting services and are trusted in the community. See links below.

----

=== Server Requirements ===

'''Pavlovserver can only be hosted under Linux.'''

This can be running as a VM under windows, but this will increase the complexity of the setup beyond this guide.

Ubuntu 18.04 x86_64, Ubuntu 19/04 amd64, Ubuntu 20.04, and Rocky Linux 8 are confirmed working. Ubuntu 15.04 x86 is known to fail to install using this guide. Recommend not running on "minimal" images as some tools are missing.

* 2GB RAM + 1GB RAM per each additional server with 10 players. More RAM is recommended for larger maps, higher player counts, or complex gamemodes. Not having enough RAM is a common cause of server crashes.

* A ~2.5Ghz CPU will comfortably support a 10 player server.

* A ~4Ghz CPU will comfortably support 24 players. This is a limit built into Pavlov itself, no server will allow players to join over 24. Lower player counts are recommended for complex gamemodes (E.g. CodZ) and/or highly detailed maps, so that maximum number will often be lower.

(Note that these are '''not''' hard limits for player counts, just suggestions for the best performance, based on experiences with many server providers on different grades of hardware.)

* Pavlovserver is functionally single threaded (one thread does vast majority of work). More CPUs only help if you are running more servers. More clockspeed = higher performance = more users per server.
The maximum number of servers you can run is dependent on how many CPUs you have. For example, if you have an 8 core CPU, the maximum number of servers would be 7. You should always have at least one CPU free as overhead, as Pavlov servers can use slightly more than one thread.

----

==== Hosting at home ====
When hosting at home there are additional requirements regarding networking: Your router has to support port-forwarding, hair-pinning/LoopbackNAT, and respond to ping requests. These techniques are necessary to allow your server to be found and to talk back to the client. please see https://en.wikipedia.org/wiki/Port_forwarding, https://en.wikipedia.org/wiki/Hairpinning, and https://www.speedguide.net/faq/how-to-become-pingable-behind-a-routerfirewall-376 for more info and google for these terms in addition to your router model to find guides on how to enable/configure it properly. If you have modern Router, it may have these features already enabled, in this case you just have to configure port-forwarding. If you can see your server but not join it while others can, this is indicative of a failure of LoopbackNAT.

A second challenge to hosting at home is CGNAT (Carrier grade NAT: https://www.a10networks.com/blog/carrier-grade-nat/). Just like NAT on your home network that has to be gotten around w/ port-forwarding, CGNAT breaks the ability of external connections to be made back to your server, but the controls are solely in your ISPs hands. Sometimes if you ask, you can be removed from CGNAT pools and/or assigned a static IP. CGNAT rollouts are becoming very common now, so if your server worked then doesn't allow connections now, your ISP may have made this change.

You can check whether you’re on a CGNAT network by visiting a Web site such as ipaddress.com or whatsmyip.com and comparing the IP address listed to the public/WAN IP address assigned to your Internet gateway. To find your gateway’s public IP address, check the status page in the administrative interface. If the two IP addresses differ, you’re likely on a CGNAT network. If so, this problem must be resolved before you go any further.

'''Not understanding these requirements and configuration is a frequent cause of failed setups and questions in discord. Don't skip this if you are trying to host from home'''

'''There are serious security implications of hosting this software at home.''' None of the devs are security experts and there has been no security review of the code. You are opening up your system to the world and publicity advertising this fact. Expect that any system hosting this software is open to compromise from the Internet and act accordingly. If your router offers a DMZ network, use it. Consider hosting on a cloud based server and think twice before running this software on any system that contains data you care about or has access to networks and computers you care about.

If you're hosting at home using Oracle's VirtualBox, there are steps you can take to prevent double NAT (which can cause issues later on)

1. Select your VM and then click Settings in VirtualBox's main window.

2. Click on Network and change Attached To from NAT to Bridged Adapter.

Once you've done this, your VM should be connected directly to your home router and double NAT should no longer be a issue.

----

==== Starting Server Install ====

====Obtaining an ApiKey====
For your server to show up in the server list, there is now a requirement to have an ApiKey issued by vankrupt. This is to prevent DOS attacks against the master server

Get the key by going here: https://pavlov-ms.vankrupt.com/servers/v1/key and using your mobile number to get a SMS
(note that there have been reported failures of this SMS system for non-US mobiles. In this case DM davevillz your mobile and ask for a key)

Put this key in your Game.ini as follows:
ApiKey="ABC123FALSEKEYDONTUSEME"
or if you would like (personally untested..I would use game.ini) you can call it at server runtime with flag as follows:
-KEY="ABC123FALSEKEYDONTUSEME"

This key can be re-used for a reasonable number of servers (a limit of 10 has been mentioned). Contact the Devs if you need more servers per key.

====System setup and software installation====

Install dependencies and create the `steam` user. (You only need to do this once):

Confirm Linux version
<pre>
lsb_release -a
</pre>

'''Ubuntu 20.04'''
<pre>
sudo apt update && sudo apt install -y gdb curl lib32gcc1 libc++-dev unzip
sudo useradd -m steam
</pre>

'''Ubuntu 20.10 or higher'''
<pre>
sudo apt update && sudo apt install -y gdb curl lib32gcc-s1 libc++-dev unzip
sudo useradd -m steam
</pre>

'''Rocky Linux, CentOS 8, and RHEL 8'''

<pre>
sudo sed -i 's/^SELINUX=enforcing$/SELINUX=permissive/g' /etc/selinux/config
sudo setenforce 0
sudo yum install gdb curl glibc.i686 libstdc++.i686 libstdc++-devel.i686 libstdc++-devel.x86_64 unzip wget -y
wget https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/l/libcxx-3.8.0-3.el7.x86_64.rpm
sudo rpm -i libcxx-3.8.0-3.el7.x86_64.rpm
sudo useradd -m steam
</pre>

[Optional] Set a password for steam.
<pre>sudo passwd steam</pre>

Login as the steam user. ('''You will need to do this each time you connect to your server'''):

<pre>
sudo su -l steam
</pre>

Install Steam:

<pre>
mkdir ~/Steam && cd ~/Steam && curl -sqL "https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz" | tar zxvf -
</pre>

There are different dedicated server versions for Pavlov Server - choose which server version you want to host (PC non-beta, PC Beta, Shack Live, or Shack RC)
(You will need to run this command each time there is a Pavlov Server update).

 
To host '''PC Server (non-beta)''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta default +exit
</pre>

To host '''PC BETA''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta beta_server +exit
</pre>

To host '''Shack Live''' (Quest):

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack +exit
</pre>

To host '''Shack RC''' (Quest): 

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack_beta +exit
</pre>

Now that we've installed the server, all pavlov server versions should continue. 
Install a fresh copy of steamclient.so (May have to do this after each update):
<pre>
~/Steam/steamcmd.sh +login anonymous +app_update 1007 +quit
mkdir -p ~/.steam/sdk64
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/pavlovserver/Pavlov/Binaries/Linux/steamclient.so
</pre>

The update 29 of the PCVR version of pavlov and after added a requirement to run these commands to change the steamclient.so:
<code>sudo rm /usr/lib/x86_64-linux-gnu/libc++.so</code>
<code>sudo ln -s /usr/lib/x86_64-linux-gnu/libc++.so.1 /usr/lib/x86_64-linux-gnu/libc++.so</code>

Make the PavlovServer script executable. (You only need to do this once):

<pre>
chmod +x ~/pavlovserver/PavlovServer.sh
</pre>

----

=== Server Configuration ===

Before starting the server we need to configure it. Start by creating some directories:

<pre>
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Logs
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps
</pre>

==== Mods/Blacklist/Whitelist (optional) ====

The following three files allow you to specify mods, banned players, and whitelist players. These are optional, but go ahead and create them. Populating the files is described later.

<pre>
touch /home/steam/pavlovserver/Pavlov/Saved/Config/mods.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/blacklist.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/whitelist.txt
</pre>

====Configuring Game.ini====
Create a new Game.ini file using following command to open an editor and copy/paste the following block into it then save it. Note not all of these options are required. For instance remove or comment out the Password=0000 line to make a public server with no pin.
<pre>
nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini
</pre>

<pre>
[/Script/Pavlov.DedicatedServer]
bEnabled=true
ServerName="My_private_idaho"
MaxPlayers=10 #Set this to 10 for Shack. 24 is the max for PC, setting it higher will not allow players to join.
ApiKey="ABC123FALSEKEYDONTUSEME"
bSecured=true
bCustomServer=true
bVerboseLogging=false
bCompetitive=false #This only works for SND
bWhitelist=false
RefreshListTime=120
LimitedAmmoType=0
TickRate=90
TimeLimit=60
#Password=0000
#BalanceTableURL="vankruptgames/BalancingTable/main"
MapRotation=(MapId="UGC1758245796", GameMode="GUN")
MapRotation=(MapId="datacenter", GameMode="SND")
MapRotation=(MapId="sand", GameMode="DM")

</pre>

* '''bEnabled''' - whether the server appears in the server list (unconfirmed)
* '''ServerName''' - name it will be listed as. (approx 35 chars max)
* '''MaxPlayers''' - See suggested specs for limits. 10 standard (10 for shack), 20-24 is max recommended for large maps like Stalingrad or PUSH/RUSH modes, and servers allow a maximum of 24 players.
* '''ApiKey''' - Unique ApiKey required to register server with master server. Replace with your key
* '''bSecured''' - enabled Valve Anti-Cheat (VAC)
* '''bCustomServer''' - activates some new modding tools (save and http functions. Required to write to blacklist.txt for bans)
* '''bCompetitive''' - sets the server to competitive mode for SND. If removed the server will default to false
* '''bVerboseLogging''' - enables verbose logging, mostly detailed statistics. Be prepared for significant increase in logging.
* '''bWhitelist''' - Only allow users in whitelist.txt to join
* '''RefreshListTime''' - sets how often the running server checks for updates in ban/whitelist/mod files
* '''LimitedAmmoType''' - sets limited ammo mode, see Limited Ammo Types table below

* '''TimeLimit''' - sets time limit for each map
* '''TickRate''' - sets the server tickrate. (so far minimum stable seems around 50 and max around 120. Beware setting this changes weapon despawn time and breaks some game modes. Recommend not touching)
* '''Password''' - PIN number for server #FYI - this is now also changeable via rcon.
* '''BalanceTableURL''' - Points to a custom balance table from github. See https://github.com/vankruptgames/BalancingTable for instructions. This line isn't needed if you don't have one.
* '''MapRotation''' - you can add multiple of these. The map system has switched from the steam workshop to modio which means that the server rotation will need to be redone with modio UGCs. <nowiki>https://mod.io/g/pavlov</nowiki>. This is done by taking the resource ID from the modio page, adding “UGC” in front of it and then adding that to the rotation. For example the map gravity <nowiki>https://mod.io/g/pavlov/m/gravity1</nowiki> has a resource ID of 2773760 so the map ID to add to the server would be “UGC2773760”. When a match ends, the server will load the next map in the rotation.
* '''AFKTimeLimit''' There is now a feature to kick players who are idle in the game. Integers are measured in seconds and 0 disables AFK kicking completely.

Available game modes as of 09/06/2022: See Game modes table below

For maps running a Custom gamemode (CodZ, BR, Duel, etc.) it doesn't matter which gamemode you choose, as the map will automatically override it with the custom mode.

{| class="wikitable"
|+Limited Ammo Types
!AmmoType
!Name
!Description
|-
|0
|Unlimited
|Players have unlimited ammo, carry no ammo boxes and do not display an ammo count on the wrist.
|-
|1
|Limited Generic
|Players carry ammo boxes with a limited amount of ammo.
One box for each weapon class (Pistol, Submachine gun, Rifles/MGs, Shotgun, Sniper).

Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.

An ammo count is displayed on the wrist.
|-
|2
|Limited Specific
|Players carry ammo boxes with a limited amount of ammo.
One box for each weapon.

Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.

An ammo count is displayed on the wrist.
|-
|3
|Custom
|Allows for full control over ammo by the map.
|-
|4
| Limited Special
|'''All weapons except "special" weapons are unlimited, more clarification is needed.'''
|-
|5
|Boxless
|'''Like limited generic but without boxes? Clarification is needed.'''
|}
{| class="wikitable"
|+Game modes
!GameMode
!Name
|-
|DM
|Death match
|-
|KOTH
|King of the hill
|-
|GUN
| Gun game
|-
|OITC
| One in the chamber
|-
|SND
|Search and destroy
|-
|TANKTDM
|WW2 Team Death Match
|-
| TDM
|Team Death Match
|-
|TTT
|Trouble in Terrorist Town
|-
|WW2GUN
|WW2 gun game
|-
|ZWV
| Zombie wave survival
|-
|HIDE
|The Hidden
|-
|INFECTION
|Hidden infection
|-
|PUSH
|Push
|-
|PH
|Prop hunt
|}
= Default Map ID's =
datacenter

sand

bridge

containeryard

siberia (Prison Break)

hospital (Zombies map)

killhouse

range

tutorial

santorini

station

industry

ogcontainers (Shack only)

haguenau (Shack only)

foundation (Shack only)

stalingrad (PC only)

stalingrad_night (PC only)

santorini_night (PC only)

sand_night (PC only)

station_night (PC only)

industry_night (PC only)

bunker (PC only)

==== Firewall/Port forwarding ====
Using the default settings there are two UDP ports (7777, 8177) that need to be allowed to access the server either by firewall setup or port forwarding.

'''Ubuntu''' firewall commands to check firewall and open ports:
<pre>
sudo ufw status
sudo ufw allow 7777
sudo ufw allow 8177
sudo ufw allow 9100
sudo ufw status
</pre>

'''Rocky Linux''' firewall commands to check firewall and open ports:
<pre>
sudo firewall-cmd --zone=public --add-port=7777/tcp
sudo firewall-cmd --zone=public --add-port=7777/udp
sudo firewall-cmd --zone=public --add-port=8177/tcp
sudo firewall-cmd --zone=public --add-port=8177/udp
sudo firewall-cmd --zone=public --add-port=9100/udp
sudo firewall-cmd --zone=public --add-port=9100/tcp
sudo firewall-cmd --list-ports
firewall-cmd --runtime-to-permanent
</pre>

You may also need to allow Pings (ICMP) for the server's true latency to appear in the master list.

If you are running multiple servers and have set additional ports (see http://wiki.pavlov-vr.com/index.php?title=Dedicated_server#Running_multiple_servers_on_one_host) then you need to allow access to the defined port plus the port 400 higher. So if you use 7000 as your port, then UDP 7000 and 7400 need to be open

If you have setup rcon via RconSettings.txt (below) then that port also need to be allowed access via TCP

If you are running Shack/Quest and want to have maps that are downloadable from your server, your server ports (ex. 7777 & 8177) must also be open via TCP

----

==== Shack Maps (Quest) ====

If you try to use the steps above to add maps for Shack, youll run into issues very quickly. This is because Shack has no affiliation to Steam, and therefore cannot use Steam Workshop maps like above. In the future, these steps will apply to PC servers as well, allowing a server to hold the map itself, instead of offloading to Steam.

To get started, first create the directory to hold the maps

<pre>mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps</pre>

You can use any number of methods to move the map files onto the server, but ill go over the two simplest, starting with a GUI approach

Download and install CyberDuck onto your "home" PC (Whatever PC you use for access to the server, but not the server itsself): https://cyberduck.io/

Next, download and unzip your map of choice from https://www.pavlovquest.com/ , https://pavlovhorde.com/mapsList, or look in #shack-map-showcase channel in the discord server. I'm going to use Cheeto's WW2 Items test (http://www.mediafire.com/file/emyt9bs1z9u9ykw/SVR_Cheeto_Items.zip/file ) for this example, you do what you like

In the top left corner, open a connection, set the connection type to SFTP, and fill in the rest of the information. User will be root, password is whatever you set the root pw as (toor in Ubuntu by default)

In the directory dropdown (itll say /root) go back to /

Follow the directories until we arrive back at our "maps" folder <pre>/home/steam/pavlovserver/Pavlov/Saved/maps</pre>

Drag and drop the unzipped map folder into the main window, in this case itll be SVR_Cheeto_Items

Hit Allow

Youll now see a folder named SVR_Cheeto_Items, and within it should be nothing but 3 files. If there is another folder in it, move this folder to the maps directory, otherwise the server wont work. The 3 files (2 .PAK one .JSON) should be in home/steam/pavlovserver/Pavlov/Saved/maps/SVR_Cheeto_Items, no more, no less.

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

To play the map, you can either use RCON switch map command, or to add the map to your servers automatic map rotation list, add the map's folder name to your Game.ini. This replaces the MapID section, so for our example it would be

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

And thats all! Disconnect CyberDuck from your server before playing, otherwise youll have difficulty joining.

-----------

==== Adding Shack Maps over Command Line Interface ====

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

A bit more complicated, but adding maps over CLI has its benefits

First, CD to the maps directory you made above

<pre>cd ~/pavlovserver/Pavlov/Saved/maps</pre>

Download the map files from whatever you use to upload them. To do this, you can either use curl or wget

<pre>curl -O insertURLhere</pre>

'''If you download your map from Google Drive''', make sure that your .zip folder is shared to anyone.
Then, get the file's url from the shared link. Example : ''<nowiki>https://drive.google.com/file/d/19bI8gUHaN5tUrDvnadAacUnchQf6_k/view</nowiki>'' will be ''19bI8gUHaN5tUrDvnadAacUnchQf6_k''
Edit "fileId" and "fileName" before you execute the command.
<pre>
fileId=19bI8gUHaN5tUrDvnadAacUnchQf6_k
fileName=SVR_USER_MAPNAME
curl -sc /tmp/cookie "https://drive.google.com/uc?export=download&id=${fileId}" > /dev/null
code="$(awk '/_warning_/ {print $NF}' /tmp/cookie)"
curl -Lb /tmp/cookie "https://drive.google.com/uc?export=download&confirm=${code}&id=${fileId}" -o ${fileName} </pre>

To keep with the Items example:

<pre>curl -O https://cdn.discordapp.com/attachments/744185280759857234/745027406695366788/SVR_Cheeto_Items.zip</pre>

Next, unzip the file. If this next step errors out, saying the command is unknown, switch back to the root user (su root), and install unzip (sudo apt install unzip), then return to the steam user, and continue.

<pre>unzip SVR_Cheeto_Items.zip</pre>

Now finish like before by adding the map to your Game.ini

<pre>nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini</pre>

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

==== Admin/Moderator list (optional) ====

The only working in-game admin menu is through Arctic VR server hosting (see below).

If you add moderators to your server, they will not be subject to vote kicks.

<pre>
nano ~/pavlovserver/Pavlov/Saved/Config/mods.txt
</pre>

Example Mod List:
<pre>
76541198397498572 #Optional Comment: Player name
76541198397498573 #Some Other Player
</pre>

==== ArcticVR Admin Menu ====

[[File:Arcticmenu.jpg|500px|link=https://www.arctic-vr.com/server-admin-menu]]

Arctic-VR Offers an advanced In-Game Admin menu that is exclusive to their hosting service. Features include:
* Switch Maps+Modes
* Teleport Players to Players
* Change Player Skins
* Control Player Buying+Cash
* Spawn Items
* Clean up corpses + guns
* Spawn Bots
* Spawn Items for other players
* Control Teams + Balance/Shuffle Teams
* ResetSND
* And More

You can read more about the ArcticVR admin menu on their website: https://www.arctic-vr.com/server-admin-menu

==== Handy tools for finding steamIDs ====

Steam ID finder: https://steamidfinder.com/lookup/ or https://steamid.xyz/

You want to enter in the steamID64 format.

This tool can convert or lookup IDs: https://steamid.io/

If you are looking for a steamID of a player that has been on your server recently this is technique to find them:
<pre>
grep -i playername ~/pavlovserver/Pavlov/Saved/Logs/* | grep TicketValidation
</pre>

=== Configure Rcon ===
To enable Rcon access create config file:
<pre> nano /home/steam/pavlovserver/Pavlov/Saved/Config/RconSettings.txt </pre>

Copy in the following text - change password, and if desired the port:
<pre>
Password=ChangeThisPassword
Port=9100
</pre>
You must specify a port for the Rcon server to use as well as a Password (use a different port per sever instance if running multiple server instances off the same hardware)

=== Starting the server ===

<pre>
cd ~/pavlovserver && ./PavlovServer.sh
</pre>

That's it, your server will be automatically broadcast to the master server! :)

Two handy tools to determine quickly if your server is broadcasting are [https://pablub.xyz/ Pablub] (PC only) and [https://pavlovhorde.com/ Horde] (Shack) and [https://pavlovhorde.com/pcServers Horde] (PC version)

Note that when you close your terminal, the server will go down. See the "supervisors" section below for how to prevent this.

----

=== Supervising the server using systemd ===

Running '''./PavlovServer.sh''' in your interactive shell is easy, but the server will shut down when you close your terminal. If you want to run the server in the background,
you'll want to run it under a supervisor. There are many options, ranging from the simple (nohup, screen or tmux), to the
more robust (supervisord, systemd).

Systemd is running by default on Ubuntu Linux, so we'll use that here.

To run the server as a systemd service, create the file '''/etc/systemd/system/pavlovserver.service''' (as root) by typing
<pre>
sudo nano /etc/systemd/system/pavlovserver.service
</pre>

Copy contents below into the file and save.

<pre>
[Unit]
Description=Pavlov VR dedicated server

[Service]
Type=simple
WorkingDirectory=/home/steam/pavlovserver
ExecStart=/home/steam/pavlovserver/PavlovServer.sh

RestartSec=1
Restart=always
User=steam
Group=steam

[Install]
WantedBy = multi-user.target
</pre>

If you'd like your server to start as competitive without editing the game.ini, change the line "ExecStart=/home/steam/pavlovserver/PavlovServer.sh" to look like this below. Though it's much easier to just use the game.ini to enable competitive instead. <pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -COMPETITIVE=1</pre>

Change the user or paths as appropriate. After saving the service file, to start, restart, stop, or monitor the server:

<pre>
sudo systemctl start pavlovserver
sudo systemctl restart pavlovserver
sudo systemctl stop pavlovserver
sudo systemctl status pavlovserver
</pre>

To view the logs:

<pre>
sudo journalctl -u pavlovserver
# to live-tail the logs
sudo journalctl -u pavlovserver -f
</pre>

If you want to run the pavlov server as soon as your server boots (e.g. a VPS you turn on and off), add pavlov as a startup service:

<pre>
sudo systemctl enable pavlovserver
</pre>

----

== Advanced Server Administration ==

=== Running multiple servers on one host ===

* Pavlovserver is functionally single threaded (there are multiple threads, but vast majority of work occurs in the primary one). Make sure you have # of pavlovservers + 1 CPU available. More CPUs= more servers. Faster CPU = more players.
* Make multiple server installs by defining a separate install dir for each server.
* Run each server with a unique port. eg: '''./PavlovServer.sh -PORT="Desired Port"'''
* The Server will use the Desired Port and the Port 400 above (Example: You choose 8200 as Port. So Port 8600 will be used as well)
* If you are using RCON, each server will need a unique port defined in RconSettings.txt
* Ensure the ports are forwarded and opened in your firewall

To duplicate directories:

be in the steam home folder
<pre>
cp -r pavlovserver pavlovserver1
/home/steam/pavlovserver1/PavlovServer.sh -PORT=[Desired Port]
</pre>

=== Starting server in competitive mode ===
Competitive mode will prevent dead teammates from being able to see the match, to prevent ghosting.
You can either enable this via Game.ini (described in Game.ini file), or using the -COMPETITIVE=1 parameter.

<pre>
/home/steam/pavlovserver1/PavlovServer.sh -COMPETITIVE=1
</pre>

{| class="wikitable"

|}

=== Useful Linux Commands ===
List files / folders in directory, print current working directory,
<pre>ls -la #list files/directories along with authorities and ownership
pwd #print working directory
sudo chown <owner> <file/directory> #change owner of file/directory. If root created something and you need to change it to steam
sudo chgrp <group> <file/directory> #change group of file/directory.
</pre>

Check if pavlov is running by checking process status. If the only row you see is the grep command, pavlov server is not started.
<pre> ps -ef | grep pav </pre>

Sample output:
<pre>
steam 34044 1 0 16:52 ? 00:00:00 /bin/sh /home/steam/pavlovserver/PavlovServer.sh
steam 34066 34044 80 16:52 ? 00:00:04 /home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer
zombies+ 34101 34013 0 16:52 pts/0 00:00:00 grep --color=auto pav
</pre>

Kill a process. Note this command uses 34044, which is a process id from the command output above.
<pre> kill -9 34044 </pre>

Dump the log to the console so you can scroll through it:
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log </pre>

Search the log for a string - replace my_string with case-sensitive string
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep my_string </pre>

=== Advanced Scripts For Server Management ===
<nowiki><hr></nowiki>

=== Auto-updating the server ===

Assuming you have followed this guide and used the default paths, users, and install instructions, you can paste the following into your terminal to auto-update your Pavlov server:

<pre>
cat << 'EOF' > $HOME/pavlov_daily_update_and_restart.sh
#!/bin/bash

USER="steam"
SERVICENAME="pavlovserver.service"
INSTALLDIRNAME="pavlovserver"
USERHOME="/home/$USER"

echo -e "Beginning Pavlov VR update run on $(date)\n\n"

systemctl stop "$SERVICENAME"

sleep 5
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +force_install_dir "$USERHOME/$INSTALLDIRNAME" +app_update 622970 +exit
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +app_update 1007 +quit
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/.steam/sdk64/steamclient.so"
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/pavlovserver/Pavlov/Binaries/Linux/steamclient.so"

systemctl start "$SERVICENAME"

echo -e "Ending Pavlov VR update run on $(date)\n\n"

EOF

chmod +x $HOME/pavlov_daily_update_and_restart.sh
mkdir $HOME/pavlov_update_logs && touch $HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log
CRONLINE="00 2 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
(sudo crontab -u root -l; echo "$CRONLINE" ) | sudo crontab -u root -
unset CRONLINE

</pre>

These commands will:

1. Create a shell script in the "steam" user's home directory that automatically stops the Pavlov server, pulls any updates via steam, pull updates to the Steamworks SDK Redist, and copies the latest version of steamclient.so to the Pavlov server directory

2. Make the shell script executable

3. Create a new directory called "pavlov_update_logs" in the "steam" user's directory, and create a logfile inside that directory called "pavlov_daily_update_and_restart.sh.log". You can check this logfile to see the output of the Pavlov and Steam SDK update commands.

4. Create a crontab entry for the root user that runs this shell script automatically every day at 2:00AM local time

If you want to change the time that this script runs, edit the numbers "00 2" in the line that starts with "CRONLINE=". In the example provided, 00 is the minutes column, and 2 is the hour column. For example, if you wanted the server to automatically update and restart at 4:17AM every day, change the line starting with "CRONLINE=" to:

<pre>
CRONLINE="17 4 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
</pre>

If the time is PM, use 24-hour time format, e.g. "32 18" for 6:32PM.

Troubleshooting Servers

2023-07-17T16:08:45Z

SaltedCrackerJack: /* Check your ports from an outside tool */

== Troubleshooting ==

To run the server without outputting the heartbeat:

<pre>./PavlovServer.sh | sed '/heartbeat/d'</pre>

To monitor the logs (without heartbeat) from another terminal:

<pre>tail -f -n10000 /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep -v 'Sending heartbeat to masterserver'</pre>

Check your CPU Clock Speed with:

<pre>lscpu | grep MHz</pre>

=== Server won't start ===

Error message:
<pre>
ln: failed to create hard link '/home/steam/.steam/sdk64/steamclient.so': File exists
ln: failed to create hard link '/home/steam/pavlovserver/Pavlov/Binaries/Linux/steamclient.so': File exists
/home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer: error while loading shared libraries: libc++.so.1: cannot open shared object file: No such file or directory
</pre>

First two errors are harmless. The third one is because libc++ step was skipped or failed. Using sudo capable id (probably not steam id), [re]run this line:
<pre>sudo apt update && sudo apt install -y gdb curl lib32gcc1 libc++-dev unzip </pre>

=== Map wont load (kicks to datacenter) ===

try deleting all the downloaded workshop maps with:

<pre>sudo rm -rf /tmp/workshop/7777/content/555160/*</pre> for all maps or

<pre>sudo rm -rf /tmp/workshop/7777/content/555160/whatever-UGC</pre> for specific map

=== Map wont load when running in a container ===
The three typical container problems I have seen:

1) Steam can't write to /tmp for some reason

2) /tmp is actually tmpfs instead of real filesystem and a few gigs of maps runs you out of RAM

3) Made worse by fact that pavlovserver unpacks downloads to ram, then writes to /tmp/workshop. Not enough RAM to do this, no map for you.

=== Server stuck rotating forever ===

Run these 2 commands, then restart your server:

<pre>cd ~/Steam && ./steamcmd.sh +login anonymous +app_update 1007 +quit
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so</pre>

If this doesn't fix it, double check that your server isn't running on the same port as another, by running this command:

<pre>ps -ef | grep pav</pre>

Then if 2 servers are on the same port, you can fix it by editing the pavlovserver.service file, and making sure the following line:

<pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -PORT=Number</pre>

has a unique number after the port for each server you're running.

=== Server - ping 999 ===
Google Cloud Platform - Make sure your compute engine has a network tag and your network rules are applied to the tag.
Make sure you opened the specified ports.

Network testing tools:
Test if your server will respond to ping from outside your network:
https://www.wormly.com/test-remote-ping

even if you think u did it all right it is more often than not port related .. using a free tool like this one https://portchecker.co/ check the appropriate ports for what your experiencing if the server is showing in game but has a ping of 999 that is more than likely a port problem so you would check the default ports for the server (unless u changed them) 7777, 8177 are the default ports both need to show as open . if u cannot connect to RCON check the port you set in the RconSettings.txt the default is 9100

=== Can't connect to RCON ===
Check the file and group owner of RconSettings file. It should be steam, or the ID used to run the pavlov server.
<pre>
cd /home/steam/pavlovserver/Pavlov/Saved/Config
ls -la
</pre>

If the owner/group are not steam, using root or an id with sudo authority, change them to steam, confirm they are now set properly, then restart the pavlov server. (Note - if Rcon has wrong permissions, after fixing you should also to check the other config files like Game.ini, mods/blacklist/whitelist for the same issue. If steam can't access these files, it could cause problems.).
<pre>
cd /home/steam/pavlovserver/Pavlov/Saved/Config
sudo chown steam RconSettings.txt
sudo chgrp steam RconSettings.txt
ls -la </pre>

=== PC ONLY - Map Download stops ===

When downloading a large map from the steam workshop make sure your VPS/Dedi or Shared hosting provider (Otherwise known as a GSP's) has enough RAM assigned to store the map files in its tempfs (stored in ram)!

This is less likely to happen on Dedicated servers and VPS with a decent amount of ram unless you are using docker with RAM limits!

Most GSP's will be using docker or some other type of jailing method to limit system resource allocations and direct access to the host machine, if they are and you know what map you want to use make sure you order a service with enough ram to store your map. If in doubt contact your GSP's support team.

=== Getting Help ===

There's a #pc-custom-servers channel on the official Pavlov Discord - https://discord.gg/Pavlov-VR. Lots of helpful people there!

Troubleshooting Servers

2023-07-17T16:07:09Z

SaltedCrackerJack: /* Getting Help */

== Troubleshooting ==

To run the server without outputting the heartbeat:

<pre>./PavlovServer.sh | sed '/heartbeat/d'</pre>

To monitor the logs (without heartbeat) from another terminal:

<pre>tail -f -n10000 /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep -v 'Sending heartbeat to masterserver'</pre>

Check your CPU Clock Speed with:

<pre>lscpu | grep MHz</pre>

=== Server won't start ===

Error message:
<pre>
ln: failed to create hard link '/home/steam/.steam/sdk64/steamclient.so': File exists
ln: failed to create hard link '/home/steam/pavlovserver/Pavlov/Binaries/Linux/steamclient.so': File exists
/home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer: error while loading shared libraries: libc++.so.1: cannot open shared object file: No such file or directory
</pre>

First two errors are harmless. The third one is because libc++ step was skipped or failed. Using sudo capable id (probably not steam id), [re]run this line:
<pre>sudo apt update && sudo apt install -y gdb curl lib32gcc1 libc++-dev unzip </pre>

=== Map wont load (kicks to datacenter) ===

try deleting all the downloaded workshop maps with:

<pre>sudo rm -rf /tmp/workshop/7777/content/555160/*</pre> for all maps or

<pre>sudo rm -rf /tmp/workshop/7777/content/555160/whatever-UGC</pre> for specific map

=== Map wont load when running in a container ===
The three typical container problems I have seen:

1) Steam can't write to /tmp for some reason

2) /tmp is actually tmpfs instead of real filesystem and a few gigs of maps runs you out of RAM

3) Made worse by fact that pavlovserver unpacks downloads to ram, then writes to /tmp/workshop. Not enough RAM to do this, no map for you.

=== Server stuck rotating forever ===

Run these 2 commands, then restart your server:

<pre>cd ~/Steam && ./steamcmd.sh +login anonymous +app_update 1007 +quit
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so</pre>

If this doesn't fix it, double check that your server isn't running on the same port as another, by running this command:

<pre>ps -ef | grep pav</pre>

Then if 2 servers are on the same port, you can fix it by editing the pavlovserver.service file, and making sure the following line:

<pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -PORT=Number</pre>

has a unique number after the port for each server you're running.

=== Server - ping 999 ===
Google Cloud Platform - Make sure your compute engine has a network tag and your network rules are applied to the tag.
Make sure you opened the specified ports.

Network testing tools:
Test if your server will respond to ping from outside your network:
https://www.wormly.com/test-remote-ping

Test if your ports are accessible via UDP (7777,8177,9100):
https://www.ipvoid.com/udp-port-scan/

=== Can't connect to RCON ===
Check the file and group owner of RconSettings file. It should be steam, or the ID used to run the pavlov server.
<pre>
cd /home/steam/pavlovserver/Pavlov/Saved/Config
ls -la
</pre>

If the owner/group are not steam, using root or an id with sudo authority, change them to steam, confirm they are now set properly, then restart the pavlov server. (Note - if Rcon has wrong permissions, after fixing you should also to check the other config files like Game.ini, mods/blacklist/whitelist for the same issue. If steam can't access these files, it could cause problems.).
<pre>
cd /home/steam/pavlovserver/Pavlov/Saved/Config
sudo chown steam RconSettings.txt
sudo chgrp steam RconSettings.txt
ls -la </pre>

=== PC ONLY - Map Download stops ===

When downloading a large map from the steam workshop make sure your VPS/Dedi or Shared hosting provider (Otherwise known as a GSP's) has enough RAM assigned to store the map files in its tempfs (stored in ram)!

This is less likely to happen on Dedicated servers and VPS with a decent amount of ram unless you are using docker with RAM limits!

Most GSP's will be using docker or some other type of jailing method to limit system resource allocations and direct access to the host machine, if they are and you know what map you want to use make sure you order a service with enough ram to store your map. If in doubt contact your GSP's support team.

=== Check your ports from an outside tool ===
even if you think u did it all right it is more often than not port related .. using a free tool like this one https://portchecker.co/ check the appropriate ports for what your experiencing if the server is showing in game but has a ping of 999 that is more than likely a port problem so you would check the default ports for the server (unless u changed them) 7777, 8177 are the default ports both need to show as open . if u cannot connect to RCON check the port you set in the RconSettings.txt the default is 9100

=== Getting Help ===

There's a #pc-custom-servers channel on the official Pavlov Discord - https://discord.gg/Pavlov-VR. Lots of helpful people there!

Setting up a dedicated server

2023-07-17T15:59:14Z

SaltedCrackerJack:

== Setting up a dedicated server ==

'''There are no Windows binaries'''

This guide is written exclusively for Linux and covers Ubuntu/Debian/Debian-like and Red Hat RPM-based distros. Possible to run with other distros, but some of the commands won't work and you will need to know enough to figure out the software install of dependencies on your own.

If you are considering hosting from home, please read that section of the wiki first.

This guide assumes you know the basics of using a bash terminal: ssh'ing into a server, running bash commands, editing text files, etc.

If you have no experience using bash, maybe start [https://www.howtogeek.com/140679/beginner-geek-how-to-start-using-the-linux-terminal/ here]. Editing text files via commandline is often a challenge. Suggest using nano and reading guide [https://www.howtogeek.com/howto/42980/the-beginners-guide-to-nano-the-linux-command-line-text-editor/ here]

If you are new to linux and accessing your server from Windows, highly suggest using MobaXterm as your SSH client as that can make required editing of text files easier using built in editor instead of the native linux command line editors.

And finally, ask yourself why you want to setup a server? If you look at the list, there are many, many more servers than players. If you don't have a team, discord community, or group of friends ready to play on your server, chances are it will go unused. Got one of these... great, let's go.

If you don't want to go through the hassle yourself and want to pay for a hosting service Arctic VR (PC and Shack) and Horde (Shack) provide a server hosting services and are trusted in the community. See links below.

----

=== Server Requirements ===

'''Pavlovserver can only be hosted under Linux.'''

This can be running as a VM under windows, but this will increase the complexity of the setup beyond this guide.

Ubuntu 18.04 x86_64, Ubuntu 19/04 amd64, Ubuntu 20.04, and Rocky Linux 8 are confirmed working. Ubuntu 15.04 x86 is known to fail to install using this guide. Recommend not running on "minimal" images as some tools are missing.

* 2GB RAM + 1GB RAM per each additional server with 10 players. More RAM is recommended for larger maps, higher player counts, or complex gamemodes. Not having enough RAM is a common cause of server crashes.

* A ~2.5Ghz CPU will comfortably support a 10 player server.

* A ~4Ghz CPU will comfortably support 24 players. This is a limit built into Pavlov itself, no server will allow players to join over 24. Lower player counts are recommended for complex gamemodes (E.g. CodZ) and/or highly detailed maps, so that maximum number will often be lower.

(Note that these are '''not''' hard limits for player counts, just suggestions for the best performance, based on experiences with many server providers on different grades of hardware.)

* Pavlovserver is functionally single threaded (one thread does vast majority of work). More CPUs only help if you are running more servers. More clockspeed = higher performance = more users per server.
The maximum number of servers you can run is dependent on how many CPUs you have. For example, if you have an 8 core CPU, the maximum number of servers would be 7. You should always have at least one CPU free as overhead, as Pavlov servers can use slightly more than one thread.

----

==== Hosting at home ====
When hosting at home there are additional requirements regarding networking: Your router has to support port-forwarding, hair-pinning/LoopbackNAT, and respond to ping requests. These techniques are necessary to allow your server to be found and to talk back to the client. please see https://en.wikipedia.org/wiki/Port_forwarding, https://en.wikipedia.org/wiki/Hairpinning, and https://www.speedguide.net/faq/how-to-become-pingable-behind-a-routerfirewall-376 for more info and google for these terms in addition to your router model to find guides on how to enable/configure it properly. If you have modern Router, it may have these features already enabled, in this case you just have to configure port-forwarding. If you can see your server but not join it while others can, this is indicative of a failure of LoopbackNAT.

A second challenge to hosting at home is CGNAT (Carrier grade NAT: https://www.a10networks.com/blog/carrier-grade-nat/). Just like NAT on your home network that has to be gotten around w/ port-forwarding, CGNAT breaks the ability of external connections to be made back to your server, but the controls are solely in your ISPs hands. Sometimes if you ask, you can be removed from CGNAT pools and/or assigned a static IP. CGNAT rollouts are becoming very common now, so if your server worked then doesn't allow connections now, your ISP may have made this change.

You can check whether you’re on a CGNAT network by visiting a Web site such as ipaddress.com or whatsmyip.com and comparing the IP address listed to the public/WAN IP address assigned to your Internet gateway. To find your gateway’s public IP address, check the status page in the administrative interface. If the two IP addresses differ, you’re likely on a CGNAT network. If so, this problem must be resolved before you go any further.

'''Not understanding these requirements and configuration is a frequent cause of failed setups and questions in discord. Don't skip this if you are trying to host from home'''

'''There are serious security implications of hosting this software at home.''' None of the devs are security experts and there has been no security review of the code. You are opening up your system to the world and publicity advertising this fact. Expect that any system hosting this software is open to compromise from the Internet and act accordingly. If your router offers a DMZ network, use it. Consider hosting on a cloud based server and think twice before running this software on any system that contains data you care about or has access to networks and computers you care about.

If you're hosting at home using Oracle's VirtualBox, there are steps you can take to prevent double NAT (which can cause issues later on)

1. Select your VM and then click Settings in VirtualBox's main window.

2. Click on Network and change Attached To from NAT to Bridged Adapter.

Once you've done this, your VM should be connected directly to your home router and double NAT should no longer be a issue.

----

==== Starting Server Install ====

====Obtaining an ApiKey====
For your server to show up in the server list, there is now a requirement to have an ApiKey issued by vankrupt. This is to prevent DOS attacks against the master server

Get the key by going here: https://pavlov-ms.vankrupt.com/servers/v1/key and using your mobile number to get a SMS
(note that there have been reported failures of this SMS system for non-US mobiles. In this case DM davevillz your mobile and ask for a key)

Put this key in your Game.ini as follows:
ApiKey="ABC123FALSEKEYDONTUSEME"
or if you would like (personally untested..I would use game.ini) you can call it at server runtime with flag as follows:
-KEY="ABC123FALSEKEYDONTUSEME"

This key can be re-used for a reasonable number of servers (a limit of 10 has been mentioned). Contact the Devs if you need more servers per key.

====System setup and software installation====

Install dependencies and create the `steam` user. (You only need to do this once):

Confirm Linux version
<pre>
lsb_release -a
</pre>

'''Ubuntu 20.04'''
<pre>
sudo apt update && sudo apt install -y gdb curl lib32gcc1 libc++-dev unzip
sudo useradd -m steam
</pre>

'''Ubuntu 20.10 or higher'''
<pre>
sudo apt update && sudo apt install -y gdb curl lib32gcc-s1 libc++-dev unzip
sudo useradd -m steam
</pre>

'''Rocky Linux, CentOS 8, and RHEL 8'''

<pre>
sudo sed -i 's/^SELINUX=enforcing$/SELINUX=permissive/g' /etc/selinux/config
sudo setenforce 0
sudo yum install gdb curl glibc.i686 libstdc++.i686 libstdc++-devel.i686 libstdc++-devel.x86_64 unzip wget -y
wget https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/l/libcxx-3.8.0-3.el7.x86_64.rpm
sudo rpm -i libcxx-3.8.0-3.el7.x86_64.rpm
sudo useradd -m steam
</pre>

[Optional] Set a password for steam.
<pre>sudo passwd steam</pre>

Login as the steam user. ('''You will need to do this each time you connect to your server'''):

<pre>
sudo su -l steam
</pre>

Install Steam:

<pre>
mkdir ~/Steam && cd ~/Steam && curl -sqL "https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz" | tar zxvf -
</pre>

There are different dedicated server versions for Pavlov Server - choose which server version you want to host (PC non-beta, PC Beta, Shack Live, or Shack RC)
(You will need to run this command each time there is a Pavlov Server update).

 
To host '''PC Server (non-beta)''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta default +exit
</pre>

To host '''PC BETA''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta beta_server +exit
</pre>

To host '''Shack Live''' (Quest):

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack +exit
</pre>

To host '''Shack RC''' (Quest): 

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack_beta +exit
</pre>

Now that we've installed the server, all pavlov server versions should continue. 
Install a fresh copy of steamclient.so (May have to do this after each update):
<pre>
~/Steam/steamcmd.sh +login anonymous +app_update 1007 +quit
mkdir -p ~/.steam/sdk64
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/pavlovserver/Pavlov/Binaries/Linux/steamclient.so
</pre>

The update 29 of the PCVR version of pavlov and after added a requirement to run these commands to change the steamclient.so:
<code>sudo rm /usr/lib/x86_64-linux-gnu/libc++.so</code>
<code>sudo ln -s /usr/lib/x86_64-linux-gnu/libc++.so.1 /usr/lib/x86_64-linux-gnu/libc++.so</code>

Make the PavlovServer script executable. (You only need to do this once):

<pre>
chmod +x ~/pavlovserver/PavlovServer.sh
</pre>

----

=== Server Configuration ===

Before starting the server we need to configure it. Start by creating some directories:

<pre>
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Logs
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps
</pre>

==== Mods/Blacklist/Whitelist (optional) ====

The following three files allow you to specify mods, banned players, and whitelist players. These are optional, but go ahead and create them. Populating the files is described later.

<pre>
touch /home/steam/pavlovserver/Pavlov/Saved/Config/mods.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/blacklist.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/whitelist.txt
</pre>

====Configuring Game.ini====
Create a new Game.ini file using following command to open an editor and copy/paste the following block into it then save it. Note not all of these options are required. For instance remove or comment out the Password=0000 line to make a public server with no pin.
<pre>
nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini
</pre>

<pre>
[/Script/Pavlov.DedicatedServer]
bEnabled=true
ServerName="My_private_idaho"
MaxPlayers=10 #Set this to 10 for Shack. 24 is the max for PC, setting it higher will not allow players to join.
ApiKey="ABC123FALSEKEYDONTUSEME"
bSecured=true
bCustomServer=true
bVerboseLogging=false
bCompetitive=false #This only works for SND
bWhitelist=false
RefreshListTime=120
LimitedAmmoType=0
TickRate=90
TimeLimit=60
#Password=0000
#BalanceTableURL="vankruptgames/BalancingTable/main"
MapRotation=(MapId="UGC1758245796", GameMode="GUN")
MapRotation=(MapId="datacenter", GameMode="SND")
MapRotation=(MapId="sand", GameMode="DM")

</pre>

* '''bEnabled''' - whether the server appears in the server list (unconfirmed)
* '''ServerName''' - name it will be listed as. (approx 35 chars max)
* '''MaxPlayers''' - See suggested specs for limits. 10 standard (10 for shack), 20-24 is max recommended for large maps like Stalingrad or PUSH/RUSH modes, and servers allow a maximum of 24 players.
* '''ApiKey''' - Unique ApiKey required to register server with master server. Replace with your key
* '''bSecured''' - enabled Valve Anti-Cheat (VAC)
* '''bCustomServer''' - activates some new modding tools (save and http functions. Required to write to blacklist.txt for bans)
* '''bCompetitive''' - sets the server to competitive mode for SND. If removed the server will default to false
* '''bVerboseLogging''' - enables verbose logging, mostly detailed statistics. Be prepared for significant increase in logging.
* '''bWhitelist''' - Only allow users in whitelist.txt to join
* '''RefreshListTime''' - sets how often the running server checks for updates in ban/whitelist/mod files
* '''LimitedAmmoType''' - sets limited ammo mode, see Limited Ammo Types table below

* '''TimeLimit''' - sets time limit for each map
* '''TickRate''' - sets the server tickrate. (so far minimum stable seems around 50 and max around 120. Beware setting this changes weapon despawn time and breaks some game modes. Recommend not touching)
* '''Password''' - PIN number for server #FYI - this is now also changeable via rcon.
* '''BalanceTableURL''' - Points to a custom balance table from github. See https://github.com/vankruptgames/BalancingTable for instructions. This line isn't needed if you don't have one.
* '''MapRotation''' - you can add multiple of these. The map system has switched from the steam workshop to modio which means that the server rotation will need to be redone with modio UGCs. <nowiki>https://mod.io/g/pavlov</nowiki>. This is done by taking the resource ID from the modio page, adding “UGC” in front of it and then adding that to the rotation. For example the map gravity <nowiki>https://mod.io/g/pavlov/m/gravity1</nowiki> has a resource ID of 2773760 so the map ID to add to the server would be “UGC2773760”. When a match ends, the server will load the next map in the rotation.
* '''AFKTimeLimit''' There is now a feature to kick players who are idle in the game. Integers are measured in seconds and 0 disables AFK kicking completely.

Available game modes as of 09/06/2022: See Game modes table below

For maps running a Custom gamemode (CodZ, BR, Duel, etc.) it doesn't matter which gamemode you choose, as the map will automatically override it with the custom mode.

{| class="wikitable"
|+Limited Ammo Types
!AmmoType
!Name
!Description
|-
|0
|Unlimited
|Players have unlimited ammo, carry no ammo boxes and do not display an ammo count on the wrist.
|-
|1
|Limited Generic
|Players carry ammo boxes with a limited amount of ammo.
One box for each weapon class (Pistol, Submachine gun, Rifles/MGs, Shotgun, Sniper).

Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.

An ammo count is displayed on the wrist.
|-
|2
|Limited Specific
|Players carry ammo boxes with a limited amount of ammo.
One box for each weapon.

Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.

An ammo count is displayed on the wrist.
|-
|3
|Custom
|Allows for full control over ammo by the map.
|-
|4
| Limited Special
|'''All weapons except "special" weapons are unlimited, more clarification is needed.'''
|-
|5
|Boxless
|'''Like limited generic but without boxes? Clarification is needed.'''
|}
{| class="wikitable"
|+Game modes
!GameMode
!Name
|-
|DM
|Death match
|-
|KOTH
|King of the hill
|-
|GUN
| Gun game
|-
|OITC
| One in the chamber
|-
|SND
|Search and destroy
|-
|TANKTDM
|WW2 Team Death Match
|-
| TDM
|Team Death Match
|-
|TTT
|Trouble in Terrorist Town
|-
|WW2GUN
|WW2 gun game
|-
|ZWV
| Zombie wave survival
|-
|HIDE
|The Hidden
|-
|INFECTION
|Hidden infection
|-
|PUSH
|Push
|-
|PH
|Prop hunt
|}
= Default Map ID's =
datacenter

sand

bridge

containeryard

siberia (Prison Break)

hospital (Zombies map)

killhouse

range

tutorial

santorini

station

industry

ogcontainers (Shack only)

haguenau (Shack only)

foundation (Shack only)

stalingrad (PC only)

stalingrad_night (PC only)

santorini_night (PC only)

sand_night (PC only)

station_night (PC only)

industry_night (PC only)

bunker (PC only)

==== Firewall/Port forwarding ====
Using the default settings there are two UDP ports (7777, 8177) that need to be allowed to access the server either by firewall setup or port forwarding.

'''Ubuntu''' firewall commands to check firewall and open ports:
<pre>
sudo ufw status
sudo ufw allow 7777
sudo ufw allow 8177
sudo ufw allow 9100
sudo ufw status
</pre>

'''Rocky Linux''' firewall commands to check firewall and open ports:
<pre>
sudo firewall-cmd --zone=public --add-port=7777/tcp
sudo firewall-cmd --zone=public --add-port=7777/udp
sudo firewall-cmd --zone=public --add-port=8177/tcp
sudo firewall-cmd --zone=public --add-port=8177/udp
sudo firewall-cmd --zone=public --add-port=9100/udp
sudo firewall-cmd --zone=public --add-port=9100/tcp
sudo firewall-cmd --list-ports
firewall-cmd --runtime-to-permanent
</pre>

You may also need to allow Pings (ICMP) for the server's true latency to appear in the master list.

If you are running multiple servers and have set additional ports (see http://wiki.pavlov-vr.com/index.php?title=Dedicated_server#Running_multiple_servers_on_one_host) then you need to allow access to the defined port plus the port 400 higher. So if you use 7000 as your port, then UDP 7000 and 7400 need to be open

If you have setup rcon via RconSettings.txt (below) then that port also need to be allowed access via TCP

If you are running Shack/Quest and want to have maps that are downloadable from your server, your server ports (ex. 7777 & 8177) must also be open via TCP

----

==== Shack Maps (Quest) ====

If you try to use the steps above to add maps for Shack, youll run into issues very quickly. This is because Shack has no affiliation to Steam, and therefore cannot use Steam Workshop maps like above. In the future, these steps will apply to PC servers as well, allowing a server to hold the map itself, instead of offloading to Steam.

To get started, first create the directory to hold the maps

<pre>mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps</pre>

You can use any number of methods to move the map files onto the server, but ill go over the two simplest, starting with a GUI approach

Download and install CyberDuck onto your "home" PC (Whatever PC you use for access to the server, but not the server itsself): https://cyberduck.io/

Next, download and unzip your map of choice from https://www.pavlovquest.com/ , https://pavlovhorde.com/mapsList, or look in #shack-map-showcase channel in the discord server. I'm going to use Cheeto's WW2 Items test (http://www.mediafire.com/file/emyt9bs1z9u9ykw/SVR_Cheeto_Items.zip/file ) for this example, you do what you like

In the top left corner, open a connection, set the connection type to SFTP, and fill in the rest of the information. User will be root, password is whatever you set the root pw as (toor in Ubuntu by default)

In the directory dropdown (itll say /root) go back to /

Follow the directories until we arrive back at our "maps" folder <pre>/home/steam/pavlovserver/Pavlov/Saved/maps</pre>

Drag and drop the unzipped map folder into the main window, in this case itll be SVR_Cheeto_Items

Hit Allow

Youll now see a folder named SVR_Cheeto_Items, and within it should be nothing but 3 files. If there is another folder in it, move this folder to the maps directory, otherwise the server wont work. The 3 files (2 .PAK one .JSON) should be in home/steam/pavlovserver/Pavlov/Saved/maps/SVR_Cheeto_Items, no more, no less.

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

To play the map, you can either use RCON switch map command, or to add the map to your servers automatic map rotation list, add the map's folder name to your Game.ini. This replaces the MapID section, so for our example it would be

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

And thats all! Disconnect CyberDuck from your server before playing, otherwise youll have difficulty joining.

-----------

==== Adding Shack Maps over Command Line Interface ====

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

A bit more complicated, but adding maps over CLI has its benefits

First, CD to the maps directory you made above

<pre>cd ~/pavlovserver/Pavlov/Saved/maps</pre>

Download the map files from whatever you use to upload them. To do this, you can either use curl or wget

<pre>curl -O insertURLhere</pre>

'''If you download your map from Google Drive''', make sure that your .zip folder is shared to anyone.
Then, get the file's url from the shared link. Example : ''<nowiki>https://drive.google.com/file/d/19bI8gUHaN5tUrDvnadAacUnchQf6_k/view</nowiki>'' will be ''19bI8gUHaN5tUrDvnadAacUnchQf6_k''
Edit "fileId" and "fileName" before you execute the command.
<pre>
fileId=19bI8gUHaN5tUrDvnadAacUnchQf6_k
fileName=SVR_USER_MAPNAME
curl -sc /tmp/cookie "https://drive.google.com/uc?export=download&id=${fileId}" > /dev/null
code="$(awk '/_warning_/ {print $NF}' /tmp/cookie)"
curl -Lb /tmp/cookie "https://drive.google.com/uc?export=download&confirm=${code}&id=${fileId}" -o ${fileName} </pre>

To keep with the Items example:

<pre>curl -O https://cdn.discordapp.com/attachments/744185280759857234/745027406695366788/SVR_Cheeto_Items.zip</pre>

Next, unzip the file. If this next step errors out, saying the command is unknown, switch back to the root user (su root), and install unzip (sudo apt install unzip), then return to the steam user, and continue.

<pre>unzip SVR_Cheeto_Items.zip</pre>

Now finish like before by adding the map to your Game.ini

<pre>nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini</pre>

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

==== Admin/Moderator list (optional) ====

The only working in-game admin menu is through Arctic VR server hosting (see below).

If you add moderators to your server, they will not be subject to vote kicks.

<pre>
nano ~/pavlovserver/Pavlov/Saved/Config/mods.txt
</pre>

Example Mod List:
<pre>
76541198397498572 #Optional Comment: Player name
76541198397498573 #Some Other Player
</pre>

==== ArcticVR Admin Menu ====

[[File:Arcticmenu.jpg|500px|link=https://www.arctic-vr.com/server-admin-menu]]

Arctic-VR Offers an advanced In-Game Admin menu that is exclusive to their hosting service. Features include:
* Switch Maps+Modes
* Teleport Players to Players
* Change Player Skins
* Control Player Buying+Cash
* Spawn Items
* Clean up corpses + guns
* Spawn Bots
* Spawn Items for other players
* Control Teams + Balance/Shuffle Teams
* ResetSND
* And More

You can read more about the ArcticVR admin menu on their website: https://www.arctic-vr.com/server-admin-menu

==== Handy tools for finding steamIDs ====

Steam ID finder: https://steamidfinder.com/lookup/ or https://steamid.xyz/

You want to enter in the steamID64 format.

This tool can convert or lookup IDs: https://steamid.io/

If you are looking for a steamID of a player that has been on your server recently this is technique to find them:
<pre>
grep -i playername ~/pavlovserver/Pavlov/Saved/Logs/* | grep TicketValidation
</pre>

=== Configure Rcon ===
To enable Rcon access create config file:
<pre> nano /home/steam/pavlovserver/Pavlov/Saved/Config/RconSettings.txt </pre>

Copy in the following text - change password, and if desired the port:
<pre>
Password=ChangeThisPassword
Port=9100
</pre>
You must specify a port for the Rcon server to use as well as a Password (use a different port per sever instance if running multiple server instances off the same hardware)

=== Starting the server ===

<pre>
cd ~/pavlovserver && ./PavlovServer.sh
</pre>

That's it, your server will be automatically broadcast to the master server! :)

Two handy tools to determine quickly if your server is broadcasting are [https://pablub.xyz/ Pablub] (PC only) and [https://pavlovhorde.com/ Horde] (Shack) and [https://pavlovhorde.com/pcServers Horde] (PC version)

Note that when you close your terminal, the server will go down. See the "supervisors" section below for how to prevent this.

=== Auto-updating the server ===

Assuming you have followed this guide and used the default paths, users, and install instructions, you can paste the following into your terminal to auto-update your Pavlov server:

<pre>
cat << 'EOF' > $HOME/pavlov_daily_update_and_restart.sh
#!/bin/bash

USER="steam"
SERVICENAME="pavlovserver.service"
INSTALLDIRNAME="pavlovserver"
USERHOME="/home/$USER"

echo -e "Beginning Pavlov VR update run on $(date)\n\n"

systemctl stop "$SERVICENAME"

sleep 5
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +force_install_dir "$USERHOME/$INSTALLDIRNAME" +app_update 622970 +exit
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +app_update 1007 +quit
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/.steam/sdk64/steamclient.so"
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/pavlovserver/Pavlov/Binaries/Linux/steamclient.so"

systemctl start "$SERVICENAME"

echo -e "Ending Pavlov VR update run on $(date)\n\n"

EOF

chmod +x $HOME/pavlov_daily_update_and_restart.sh
mkdir $HOME/pavlov_update_logs && touch $HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log
CRONLINE="00 2 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
(sudo crontab -u root -l; echo "$CRONLINE" ) | sudo crontab -u root -
unset CRONLINE

</pre>

These commands will:

1. Create a shell script in the "steam" user's home directory that automatically stops the Pavlov server, pulls any updates via steam, pull updates to the Steamworks SDK Redist, and copies the latest version of steamclient.so to the Pavlov server directory

2. Make the shell script executable

3. Create a new directory called "pavlov_update_logs" in the "steam" user's directory, and create a logfile inside that directory called "pavlov_daily_update_and_restart.sh.log". You can check this logfile to see the output of the Pavlov and Steam SDK update commands.

4. Create a crontab entry for the root user that runs this shell script automatically every day at 2:00AM local time

If you want to change the time that this script runs, edit the numbers "00 2" in the line that starts with "CRONLINE=". In the example provided, 00 is the minutes column, and 2 is the hour column. For example, if you wanted the server to automatically update and restart at 4:17AM every day, change the line starting with "CRONLINE=" to:

<pre>
CRONLINE="17 4 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
</pre>

If the time is PM, use 24-hour time format, e.g. "32 18" for 6:32PM.

----

=== Supervising the server using systemd ===

Running '''./PavlovServer.sh''' in your interactive shell is easy, but the server will shut down when you close your terminal. If you want to run the server in the background,
you'll want to run it under a supervisor. There are many options, ranging from the simple (nohup, screen or tmux), to the
more robust (supervisord, systemd).

Systemd is running by default on Ubuntu Linux, so we'll use that here.

To run the server as a systemd service, create the file '''/etc/systemd/system/pavlovserver.service''' (as root) by typing
<pre>
sudo nano /etc/systemd/system/pavlovserver.service
</pre>

Copy contents below into the file and save.

<pre>
[Unit]
Description=Pavlov VR dedicated server

[Service]
Type=simple
WorkingDirectory=/home/steam/pavlovserver
ExecStart=/home/steam/pavlovserver/PavlovServer.sh

RestartSec=1
Restart=always
User=steam
Group=steam

[Install]
WantedBy = multi-user.target
</pre>

If you'd like your server to start as competitive without editing the game.ini, change the line "ExecStart=/home/steam/pavlovserver/PavlovServer.sh" to look like this below. Though it's much easier to just use the game.ini to enable competitive instead. <pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -COMPETITIVE=1</pre>

Change the user or paths as appropriate. After saving the service file, to start, restart, stop, or monitor the server:

<pre>
sudo systemctl start pavlovserver
sudo systemctl restart pavlovserver
sudo systemctl stop pavlovserver
sudo systemctl status pavlovserver
</pre>

To view the logs:

<pre>
sudo journalctl -u pavlovserver
# to live-tail the logs
sudo journalctl -u pavlovserver -f
</pre>

If you want to run the pavlov server as soon as your server boots (e.g. a VPS you turn on and off), add pavlov as a startup service:

<pre>
sudo systemctl enable pavlovserver
</pre>

----

== Advanced Server Administration ==

=== Running multiple servers on one host ===

* Pavlovserver is functionally single threaded (there are multiple threads, but vast majority of work occurs in the primary one). Make sure you have # of pavlovservers + 1 CPU available. More CPUs= more servers. Faster CPU = more players.
* Make multiple server installs by defining a separate install dir for each server.
* Run each server with a unique port. eg: '''./PavlovServer.sh -PORT="Desired Port"'''
* The Server will use the Desired Port and the Port 400 above (Example: You choose 8200 as Port. So Port 8600 will be used as well)
* If you are using RCON, each server will need a unique port defined in RconSettings.txt
* Ensure the ports are forwarded and opened in your firewall

To duplicate directories:

be in the steam home folder
<pre>
cp -r pavlovserver pavlovserver1
/home/steam/pavlovserver1/PavlovServer.sh -PORT=[Desired Port]
</pre>

=== Starting server in competitive mode ===
Competitive mode will prevent dead teammates from being able to see the match, to prevent ghosting.
You can either enable this via Game.ini (described in Game.ini file), or using the -COMPETITIVE=1 parameter.

<pre>
/home/steam/pavlovserver1/PavlovServer.sh -COMPETITIVE=1
</pre>

{| class="wikitable"

|}

=== Useful Linux Commands ===
List files / folders in directory, print current working directory,
<pre>ls -la #list files/directories along with authorities and ownership
pwd #print working directory
sudo chown <owner> <file/directory> #change owner of file/directory. If root created something and you need to change it to steam
sudo chgrp <group> <file/directory> #change group of file/directory.
</pre>

Check if pavlov is running by checking process status. If the only row you see is the grep command, pavlov server is not started.
<pre> ps -ef | grep pav </pre>

Sample output:
<pre>
steam 34044 1 0 16:52 ? 00:00:00 /bin/sh /home/steam/pavlovserver/PavlovServer.sh
steam 34066 34044 80 16:52 ? 00:00:04 /home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer
zombies+ 34101 34013 0 16:52 pts/0 00:00:00 grep --color=auto pav
</pre>

Kill a process. Note this command uses 34044, which is a process id from the command output above.
<pre> kill -9 34044 </pre>

Dump the log to the console so you can scroll through it:
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log </pre>

Search the log for a string - replace my_string with case-sensitive string
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep my_string </pre>

Setting up a dedicated server

2023-07-17T15:54:42Z

SaltedCrackerJack: /* Hosting at home */

== Setting up a dedicated server ==

'''There are no Windows binaries'''

This guide is written exclusively for Linux and covers Ubuntu/Debian/Debian-like and Red Hat RPM-based distros. Possible to run with other distros, but some of the commands won't work and you will need to know enough to figure out the software install of dependencies on your own.

If you are considering hosting from home, please read that section of the wiki first.

This guide assumes you know the basics of using a bash terminal: ssh'ing into a server, running bash commands, editing text files, etc.

If you have no experience using bash, maybe start [https://www.howtogeek.com/140679/beginner-geek-how-to-start-using-the-linux-terminal/ here]. Editing text files via commandline is often a challenge. Suggest using nano and reading guide [https://www.howtogeek.com/howto/42980/the-beginners-guide-to-nano-the-linux-command-line-text-editor/ here]

If you are new to linux and accessing your server from Windows, highly suggest using MobaXterm as your SSH client as that can make required editing of text files easier using built in editor instead of the native linux command line editors.

And finally, ask yourself why you want to setup a server? If you look at the list, there are many, many more servers than players. If you don't have a team, discord community, or group of friends ready to play on your server, chances are it will go unused. Got one of these... great, let's go.

If you don't want to go through the hassle yourself and want to pay for a hosting service Arctic VR (PC and Shack) and Horde (Shack) provide a server hosting services and are trusted in the community. See links below.

----

=== Server Requirements ===

'''Pavlovserver can only be hosted under Linux.'''

This can be running as a VM under windows, but this will increase the complexity of the setup beyond this guide.

Ubuntu 18.04 x86_64, Ubuntu 19/04 amd64, Ubuntu 20.04, and Rocky Linux 8 are confirmed working. Ubuntu 15.04 x86 is known to fail to install using this guide. Recommend not running on "minimal" images as some tools are missing.

* 2GB RAM + 1GB RAM per each additional server with 10 players. More RAM is recommended for larger maps, higher player counts, or complex gamemodes. Not having enough RAM is a common cause of server crashes.

* A ~2.5Ghz CPU will comfortably support a 10 player server.

* A ~4Ghz CPU will comfortably support 24 players. This is a limit built into Pavlov itself, no server will allow players to join over 24. Lower player counts are recommended for complex gamemodes (E.g. CodZ) and/or highly detailed maps, so that maximum number will often be lower.

(Note that these are '''not''' hard limits for player counts, just suggestions for the best performance, based on experiences with many server providers on different grades of hardware.)

* Pavlovserver is functionally single threaded (one thread does vast majority of work). More CPUs only help if you are running more servers. More clockspeed = higher performance = more users per server.
The maximum number of servers you can run is dependent on how many CPUs you have. For example, if you have an 8 core CPU, the maximum number of servers would be 7. You should always have at least one CPU free as overhead, as Pavlov servers can use slightly more than one thread.

----

==== Hosting at home ====
When hosting at home there are additional requirements regarding networking: Your router has to support port-forwarding, hair-pinning/LoopbackNAT, and respond to ping requests. These techniques are necessary to allow your server to be found and to talk back to the client. please see https://en.wikipedia.org/wiki/Port_forwarding, https://en.wikipedia.org/wiki/Hairpinning, and https://www.speedguide.net/faq/how-to-become-pingable-behind-a-routerfirewall-376 for more info and google for these terms in addition to your router model to find guides on how to enable/configure it properly. If you have modern Router, it may have these features already enabled, in this case you just have to configure port-forwarding. If you can see your server but not join it while others can, this is indicative of a failure of LoopbackNAT.

A second challenge to hosting at home is CGNAT (Carrier grade NAT: https://www.a10networks.com/blog/carrier-grade-nat/). Just like NAT on your home network that has to be gotten around w/ port-forwarding, CGNAT breaks the ability of external connections to be made back to your server, but the controls are solely in your ISPs hands. Sometimes if you ask, you can be removed from CGNAT pools and/or assigned a static IP. CGNAT rollouts are becoming very common now, so if your server worked then doesn't allow connections now, your ISP may have made this change.

You can check whether you’re on a CGNAT network by visiting a Web site such as ipaddress.com or whatsmyip.com and comparing the IP address listed to the public/WAN IP address assigned to your Internet gateway. To find your gateway’s public IP address, check the status page in the administrative interface. If the two IP addresses differ, you’re likely on a CGNAT network. If so, this problem must be resolved before you go any further.

'''Not understanding these requirements and configuration is a frequent cause of failed setups and questions in discord. Don't skip this if you are trying to host from home'''

'''There are serious security implications of hosting this software at home.''' None of the devs are security experts and there has been no security review of the code. You are opening up your system to the world and publicity advertising this fact. Expect that any system hosting this software is open to compromise from the Internet and act accordingly. If your router offers a DMZ network, use it. Consider hosting on a cloud based server and think twice before running this software on any system that contains data you care about or has access to networks and computers you care about.

If you're hosting at home using Oracle's VirtualBox, there are steps you can take to prevent double NAT (which can cause issues later on)

1. Select your VM and then click Settings in VirtualBox's main window.

2. Click on Network and change Attached To from NAT to Bridged Adapter.

Once you've done this, your VM should be connected directly to your home router and double NAT should no longer be a issue.

'''Check your ports from an outside tool ..''' using a free tool like this one https://portchecker.co/ check the appropriate ports for what your experiencing if the server is showing in game but has a ping of 999 that is more than likely a port problem so you would check the default ports for the server (unless u changed them) 7777, 8177 are the default ports both need to show as open . if u cannot connect to RCON check the port you set in the [[Rcon Overview and Commands|RconSettings.txt]]

----

==== Starting Server Install ====

====Obtaining an ApiKey====
For your server to show up in the server list, there is now a requirement to have an ApiKey issued by vankrupt. This is to prevent DOS attacks against the master server

Get the key by going here: https://pavlov-ms.vankrupt.com/servers/v1/key and using your mobile number to get a SMS
(note that there have been reported failures of this SMS system for non-US mobiles. In this case DM davevillz your mobile and ask for a key)

Put this key in your Game.ini as follows:
ApiKey="ABC123FALSEKEYDONTUSEME"
or if you would like (personally untested..I would use game.ini) you can call it at server runtime with flag as follows:
-KEY="ABC123FALSEKEYDONTUSEME"

This key can be re-used for a reasonable number of servers (a limit of 10 has been mentioned). Contact the Devs if you need more servers per key.

====System setup and software installation====

Install dependencies and create the `steam` user. (You only need to do this once):

Confirm Linux version
<pre>
lsb_release -a
</pre>

'''Ubuntu 20.04'''
<pre>
sudo apt update && sudo apt install -y gdb curl lib32gcc1 libc++-dev unzip
sudo useradd -m steam
</pre>

'''Ubuntu 20.10 or higher'''
<pre>
sudo apt update && sudo apt install -y gdb curl lib32gcc-s1 libc++-dev unzip
sudo useradd -m steam
</pre>

'''Rocky Linux, CentOS 8, and RHEL 8'''

<pre>
sudo sed -i 's/^SELINUX=enforcing$/SELINUX=permissive/g' /etc/selinux/config
sudo setenforce 0
sudo yum install gdb curl glibc.i686 libstdc++.i686 libstdc++-devel.i686 libstdc++-devel.x86_64 unzip wget -y
wget https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/l/libcxx-3.8.0-3.el7.x86_64.rpm
sudo rpm -i libcxx-3.8.0-3.el7.x86_64.rpm
sudo useradd -m steam
</pre>

[Optional] Set a password for steam.
<pre>sudo passwd steam</pre>

Login as the steam user. ('''You will need to do this each time you connect to your server'''):

<pre>
sudo su -l steam
</pre>

Install Steam:

<pre>
mkdir ~/Steam && cd ~/Steam && curl -sqL "https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz" | tar zxvf -
</pre>

There are different dedicated server versions for Pavlov Server - choose which server version you want to host (PC non-beta, PC Beta, Shack Live, or Shack RC)
(You will need to run this command each time there is a Pavlov Server update).

 
To host '''PC Server (non-beta)''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta default +exit
</pre>

To host '''PC BETA''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta beta_server +exit
</pre>

To host '''Shack Live''' (Quest):

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack +exit
</pre>

To host '''Shack RC''' (Quest): 

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack_beta +exit
</pre>

Now that we've installed the server, all pavlov server versions should continue. 
Install a fresh copy of steamclient.so (May have to do this after each update):
<pre>
~/Steam/steamcmd.sh +login anonymous +app_update 1007 +quit
mkdir -p ~/.steam/sdk64
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/pavlovserver/Pavlov/Binaries/Linux/steamclient.so
</pre>

The update 29 of the PCVR version of pavlov and after added a requirement to run these commands to change the steamclient.so:
<code>sudo rm /usr/lib/x86_64-linux-gnu/libc++.so</code>
<code>sudo ln -s /usr/lib/x86_64-linux-gnu/libc++.so.1 /usr/lib/x86_64-linux-gnu/libc++.so</code>

Make the PavlovServer script executable. (You only need to do this once):

<pre>
chmod +x ~/pavlovserver/PavlovServer.sh
</pre>

----

=== Server Configuration ===

Before starting the server we need to configure it. Start by creating some directories:

<pre>
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Logs
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps
</pre>

==== Mods/Blacklist/Whitelist (optional) ====

The following three files allow you to specify mods, banned players, and whitelist players. These are optional, but go ahead and create them. Populating the files is described later.

<pre>
touch /home/steam/pavlovserver/Pavlov/Saved/Config/mods.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/blacklist.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/whitelist.txt
</pre>

====Configuring Game.ini====
Create a new Game.ini file using following command to open an editor and copy/paste the following block into it then save it. Note not all of these options are required. For instance remove or comment out the Password=0000 line to make a public server with no pin.
<pre>
nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini
</pre>

<pre>
[/Script/Pavlov.DedicatedServer]
bEnabled=true
ServerName="My_private_idaho"
MaxPlayers=10 #Set this to 10 for Shack. 24 is the max for PC, setting it higher will not allow players to join.
ApiKey="ABC123FALSEKEYDONTUSEME"
bSecured=true
bCustomServer=true
bVerboseLogging=false
bCompetitive=false #This only works for SND
bWhitelist=false
RefreshListTime=120
LimitedAmmoType=0
TickRate=90
TimeLimit=60
#Password=0000
#BalanceTableURL="vankruptgames/BalancingTable/main"
MapRotation=(MapId="UGC1758245796", GameMode="GUN")
MapRotation=(MapId="datacenter", GameMode="SND")
MapRotation=(MapId="sand", GameMode="DM")

</pre>

* '''bEnabled''' - whether the server appears in the server list (unconfirmed)
* '''ServerName''' - name it will be listed as. (approx 35 chars max)
* '''MaxPlayers''' - See suggested specs for limits. 10 standard (10 for shack), 20-24 is max recommended for large maps like Stalingrad or PUSH/RUSH modes, and servers allow a maximum of 24 players.
* '''ApiKey''' - Unique ApiKey required to register server with master server. Replace with your key
* '''bSecured''' - enabled Valve Anti-Cheat (VAC)
* '''bCustomServer''' - activates some new modding tools (save and http functions. Required to write to blacklist.txt for bans)
* '''bCompetitive''' - sets the server to competitive mode for SND. If removed the server will default to false
* '''bVerboseLogging''' - enables verbose logging, mostly detailed statistics. Be prepared for significant increase in logging.
* '''bWhitelist''' - Only allow users in whitelist.txt to join
* '''RefreshListTime''' - sets how often the running server checks for updates in ban/whitelist/mod files
* '''LimitedAmmoType''' - sets limited ammo mode, see Limited Ammo Types table below

* '''TimeLimit''' - sets time limit for each map
* '''TickRate''' - sets the server tickrate. (so far minimum stable seems around 50 and max around 120. Beware setting this changes weapon despawn time and breaks some game modes. Recommend not touching)
* '''Password''' - PIN number for server #FYI - this is now also changeable via rcon.
* '''BalanceTableURL''' - Points to a custom balance table from github. See https://github.com/vankruptgames/BalancingTable for instructions. This line isn't needed if you don't have one.
* '''MapRotation''' - you can add multiple of these. The map system has switched from the steam workshop to modio which means that the server rotation will need to be redone with modio UGCs. <nowiki>https://mod.io/g/pavlov</nowiki>. This is done by taking the resource ID from the modio page, adding “UGC” in front of it and then adding that to the rotation. For example the map gravity <nowiki>https://mod.io/g/pavlov/m/gravity1</nowiki> has a resource ID of 2773760 so the map ID to add to the server would be “UGC2773760”. When a match ends, the server will load the next map in the rotation.
* '''AFKTimeLimit''' There is now a feature to kick players who are idle in the game. Integers are measured in seconds and 0 disables AFK kicking completely.

Available game modes as of 09/06/2022: See Game modes table below

For maps running a Custom gamemode (CodZ, BR, Duel, etc.) it doesn't matter which gamemode you choose, as the map will automatically override it with the custom mode.

{| class="wikitable"
|+Limited Ammo Types
!AmmoType
!Name
!Description
|-
|0
|Unlimited
|Players have unlimited ammo, carry no ammo boxes and do not display an ammo count on the wrist.
|-
|1
|Limited Generic
|Players carry ammo boxes with a limited amount of ammo.
One box for each weapon class (Pistol, Submachine gun, Rifles/MGs, Shotgun, Sniper).

Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.

An ammo count is displayed on the wrist.
|-
|2
|Limited Specific
|Players carry ammo boxes with a limited amount of ammo.
One box for each weapon.

Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.

An ammo count is displayed on the wrist.
|-
|3
|Custom
|Allows for full control over ammo by the map.
|-
|4
| Limited Special
|'''All weapons except "special" weapons are unlimited, more clarification is needed.'''
|-
|5
|Boxless
|'''Like limited generic but without boxes? Clarification is needed.'''
|}
{| class="wikitable"
|+Game modes
!GameMode
!Name
|-
|DM
|Death match
|-
|KOTH
|King of the hill
|-
|GUN
| Gun game
|-
|OITC
| One in the chamber
|-
|SND
|Search and destroy
|-
|TANKTDM
|WW2 Team Death Match
|-
| TDM
|Team Death Match
|-
|TTT
|Trouble in Terrorist Town
|-
|WW2GUN
|WW2 gun game
|-
|ZWV
| Zombie wave survival
|-
|HIDE
|The Hidden
|-
|INFECTION
|Hidden infection
|-
|PUSH
|Push
|-
|PH
|Prop hunt
|}
= Default Map ID's =
datacenter

sand

bridge

containeryard

siberia (Prison Break)

hospital (Zombies map)

killhouse

range

tutorial

santorini

station

industry

ogcontainers (Shack only)

haguenau (Shack only)

foundation (Shack only)

stalingrad (PC only)

stalingrad_night (PC only)

santorini_night (PC only)

sand_night (PC only)

station_night (PC only)

industry_night (PC only)

bunker (PC only)

==== Firewall/Port forwarding ====
Using the default settings there are two UDP ports (7777, 8177) that need to be allowed to access the server either by firewall setup or port forwarding.

'''Ubuntu''' firewall commands to check firewall and open ports:
<pre>
sudo ufw status
sudo ufw allow 7777
sudo ufw allow 8177
sudo ufw allow 9100
sudo ufw status
</pre>

'''Rocky Linux''' firewall commands to check firewall and open ports:
<pre>
sudo firewall-cmd --zone=public --add-port=7777/tcp
sudo firewall-cmd --zone=public --add-port=7777/udp
sudo firewall-cmd --zone=public --add-port=8177/tcp
sudo firewall-cmd --zone=public --add-port=8177/udp
sudo firewall-cmd --zone=public --add-port=9100/udp
sudo firewall-cmd --zone=public --add-port=9100/tcp
sudo firewall-cmd --list-ports
firewall-cmd --runtime-to-permanent
</pre>

You may also need to allow Pings (ICMP) for the server's true latency to appear in the master list.

If you are running multiple servers and have set additional ports (see http://wiki.pavlov-vr.com/index.php?title=Dedicated_server#Running_multiple_servers_on_one_host) then you need to allow access to the defined port plus the port 400 higher. So if you use 7000 as your port, then UDP 7000 and 7400 need to be open

If you have setup rcon via RconSettings.txt (below) then that port also need to be allowed access via TCP

If you are running Shack/Quest and want to have maps that are downloadable from your server, your server ports (ex. 7777 & 8177) must also be open via TCP

----

==== Shack Maps (Quest) ====

If you try to use the steps above to add maps for Shack, youll run into issues very quickly. This is because Shack has no affiliation to Steam, and therefore cannot use Steam Workshop maps like above. In the future, these steps will apply to PC servers as well, allowing a server to hold the map itself, instead of offloading to Steam.

To get started, first create the directory to hold the maps

<pre>mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps</pre>

You can use any number of methods to move the map files onto the server, but ill go over the two simplest, starting with a GUI approach

Download and install CyberDuck onto your "home" PC (Whatever PC you use for access to the server, but not the server itsself): https://cyberduck.io/

Next, download and unzip your map of choice from https://www.pavlovquest.com/ , https://pavlovhorde.com/mapsList, or look in #shack-map-showcase channel in the discord server. I'm going to use Cheeto's WW2 Items test (http://www.mediafire.com/file/emyt9bs1z9u9ykw/SVR_Cheeto_Items.zip/file ) for this example, you do what you like

In the top left corner, open a connection, set the connection type to SFTP, and fill in the rest of the information. User will be root, password is whatever you set the root pw as (toor in Ubuntu by default)

In the directory dropdown (itll say /root) go back to /

Follow the directories until we arrive back at our "maps" folder <pre>/home/steam/pavlovserver/Pavlov/Saved/maps</pre>

Drag and drop the unzipped map folder into the main window, in this case itll be SVR_Cheeto_Items

Hit Allow

Youll now see a folder named SVR_Cheeto_Items, and within it should be nothing but 3 files. If there is another folder in it, move this folder to the maps directory, otherwise the server wont work. The 3 files (2 .PAK one .JSON) should be in home/steam/pavlovserver/Pavlov/Saved/maps/SVR_Cheeto_Items, no more, no less.

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

To play the map, you can either use RCON switch map command, or to add the map to your servers automatic map rotation list, add the map's folder name to your Game.ini. This replaces the MapID section, so for our example it would be

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

And thats all! Disconnect CyberDuck from your server before playing, otherwise youll have difficulty joining.

-----------

==== Adding Shack Maps over Command Line Interface ====

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

A bit more complicated, but adding maps over CLI has its benefits

First, CD to the maps directory you made above

<pre>cd ~/pavlovserver/Pavlov/Saved/maps</pre>

Download the map files from whatever you use to upload them. To do this, you can either use curl or wget

<pre>curl -O insertURLhere</pre>

'''If you download your map from Google Drive''', make sure that your .zip folder is shared to anyone.
Then, get the file's url from the shared link. Example : ''<nowiki>https://drive.google.com/file/d/19bI8gUHaN5tUrDvnadAacUnchQf6_k/view</nowiki>'' will be ''19bI8gUHaN5tUrDvnadAacUnchQf6_k''
Edit "fileId" and "fileName" before you execute the command.
<pre>
fileId=19bI8gUHaN5tUrDvnadAacUnchQf6_k
fileName=SVR_USER_MAPNAME
curl -sc /tmp/cookie "https://drive.google.com/uc?export=download&id=${fileId}" > /dev/null
code="$(awk '/_warning_/ {print $NF}' /tmp/cookie)"
curl -Lb /tmp/cookie "https://drive.google.com/uc?export=download&confirm=${code}&id=${fileId}" -o ${fileName} </pre>

To keep with the Items example:

<pre>curl -O https://cdn.discordapp.com/attachments/744185280759857234/745027406695366788/SVR_Cheeto_Items.zip</pre>

Next, unzip the file. If this next step errors out, saying the command is unknown, switch back to the root user (su root), and install unzip (sudo apt install unzip), then return to the steam user, and continue.

<pre>unzip SVR_Cheeto_Items.zip</pre>

Now finish like before by adding the map to your Game.ini

<pre>nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini</pre>

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

==== Admin/Moderator list (optional) ====

The only working in-game admin menu is through Arctic VR server hosting (see below).

If you add moderators to your server, they will not be subject to vote kicks.

<pre>
nano ~/pavlovserver/Pavlov/Saved/Config/mods.txt
</pre>

Example Mod List:
<pre>
76541198397498572 #Optional Comment: Player name
76541198397498573 #Some Other Player
</pre>

==== ArcticVR Admin Menu ====

[[File:Arcticmenu.jpg|500px|link=https://www.arctic-vr.com/server-admin-menu]]

Arctic-VR Offers an advanced In-Game Admin menu that is exclusive to their hosting service. Features include:
* Switch Maps+Modes
* Teleport Players to Players
* Change Player Skins
* Control Player Buying+Cash
* Spawn Items
* Clean up corpses + guns
* Spawn Bots
* Spawn Items for other players
* Control Teams + Balance/Shuffle Teams
* ResetSND
* And More

You can read more about the ArcticVR admin menu on their website: https://www.arctic-vr.com/server-admin-menu

==== Handy tools for finding steamIDs ====

Steam ID finder: https://steamidfinder.com/lookup/ or https://steamid.xyz/

You want to enter in the steamID64 format.

This tool can convert or lookup IDs: https://steamid.io/

If you are looking for a steamID of a player that has been on your server recently this is technique to find them:
<pre>
grep -i playername ~/pavlovserver/Pavlov/Saved/Logs/* | grep TicketValidation
</pre>

=== Configure Rcon ===
To enable Rcon access create config file:
<pre> nano /home/steam/pavlovserver/Pavlov/Saved/Config/RconSettings.txt </pre>

Copy in the following text - change password, and if desired the port:
<pre>
Password=ChangeThisPassword
Port=9100
</pre>
You must specify a port for the Rcon server to use as well as a Password (use a different port per sever instance if running multiple server instances off the same hardware)

=== Starting the server ===

<pre>
cd ~/pavlovserver && ./PavlovServer.sh
</pre>

That's it, your server will be automatically broadcast to the master server! :)

Two handy tools to determine quickly if your server is broadcasting are [https://pablub.xyz/ Pablub] (PC only) and [https://pavlovhorde.com/ Horde] (Shack) and [https://pavlovhorde.com/pcServers Horde] (PC version)

Note that when you close your terminal, the server will go down. See the "supervisors" section below for how to prevent this.

=== Auto-updating the server ===

Assuming you have followed this guide and used the default paths, users, and install instructions, you can paste the following into your terminal to auto-update your Pavlov server:

<pre>
cat << 'EOF' > $HOME/pavlov_daily_update_and_restart.sh
#!/bin/bash

USER="steam"
SERVICENAME="pavlovserver.service"
INSTALLDIRNAME="pavlovserver"
USERHOME="/home/$USER"

echo -e "Beginning Pavlov VR update run on $(date)\n\n"

systemctl stop "$SERVICENAME"

sleep 5
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +force_install_dir "$USERHOME/$INSTALLDIRNAME" +app_update 622970 +exit
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +app_update 1007 +quit
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/.steam/sdk64/steamclient.so"
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/pavlovserver/Pavlov/Binaries/Linux/steamclient.so"

systemctl start "$SERVICENAME"

echo -e "Ending Pavlov VR update run on $(date)\n\n"

EOF

chmod +x $HOME/pavlov_daily_update_and_restart.sh
mkdir $HOME/pavlov_update_logs && touch $HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log
CRONLINE="00 2 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
(sudo crontab -u root -l; echo "$CRONLINE" ) | sudo crontab -u root -
unset CRONLINE

</pre>

These commands will:

1. Create a shell script in the "steam" user's home directory that automatically stops the Pavlov server, pulls any updates via steam, pull updates to the Steamworks SDK Redist, and copies the latest version of steamclient.so to the Pavlov server directory

2. Make the shell script executable

3. Create a new directory called "pavlov_update_logs" in the "steam" user's directory, and create a logfile inside that directory called "pavlov_daily_update_and_restart.sh.log". You can check this logfile to see the output of the Pavlov and Steam SDK update commands.

4. Create a crontab entry for the root user that runs this shell script automatically every day at 2:00AM local time

If you want to change the time that this script runs, edit the numbers "00 2" in the line that starts with "CRONLINE=". In the example provided, 00 is the minutes column, and 2 is the hour column. For example, if you wanted the server to automatically update and restart at 4:17AM every day, change the line starting with "CRONLINE=" to:

<pre>
CRONLINE="17 4 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
</pre>

If the time is PM, use 24-hour time format, e.g. "32 18" for 6:32PM.

----

=== Supervising the server using systemd ===

Running '''./PavlovServer.sh''' in your interactive shell is easy, but the server will shut down when you close your terminal. If you want to run the server in the background,
you'll want to run it under a supervisor. There are many options, ranging from the simple (nohup, screen or tmux), to the
more robust (supervisord, systemd).

Systemd is running by default on Ubuntu Linux, so we'll use that here.

To run the server as a systemd service, create the file '''/etc/systemd/system/pavlovserver.service''' (as root) by typing
<pre>
sudo nano /etc/systemd/system/pavlovserver.service
</pre>

Copy contents below into the file and save.

<pre>
[Unit]
Description=Pavlov VR dedicated server

[Service]
Type=simple
WorkingDirectory=/home/steam/pavlovserver
ExecStart=/home/steam/pavlovserver/PavlovServer.sh

RestartSec=1
Restart=always
User=steam
Group=steam

[Install]
WantedBy = multi-user.target
</pre>

If you'd like your server to start as competitive without editing the game.ini, change the line "ExecStart=/home/steam/pavlovserver/PavlovServer.sh" to look like this below. Though it's much easier to just use the game.ini to enable competitive instead. <pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -COMPETITIVE=1</pre>

Change the user or paths as appropriate. After saving the service file, to start, restart, stop, or monitor the server:

<pre>
sudo systemctl start pavlovserver
sudo systemctl restart pavlovserver
sudo systemctl stop pavlovserver
sudo systemctl status pavlovserver
</pre>

To view the logs:

<pre>
sudo journalctl -u pavlovserver
# to live-tail the logs
sudo journalctl -u pavlovserver -f
</pre>

If you want to run the pavlov server as soon as your server boots (e.g. a VPS you turn on and off), add pavlov as a startup service:

<pre>
sudo systemctl enable pavlovserver
</pre>

----

== Advanced Server Administration ==

=== Running multiple servers on one host ===

* Pavlovserver is functionally single threaded (there are multiple threads, but vast majority of work occurs in the primary one). Make sure you have # of pavlovservers + 1 CPU available. More CPUs= more servers. Faster CPU = more players.
* Make multiple server installs by defining a separate install dir for each server.
* Run each server with a unique port. eg: '''./PavlovServer.sh -PORT="Desired Port"'''
* The Server will use the Desired Port and the Port 400 above (Example: You choose 8200 as Port. So Port 8600 will be used as well)
* If you are using RCON, each server will need a unique port defined in RconSettings.txt
* Ensure the ports are forwarded and opened in your firewall

To duplicate directories:

be in the steam home folder
<pre>
cp -r pavlovserver pavlovserver1
/home/steam/pavlovserver1/PavlovServer.sh -PORT=[Desired Port]
</pre>

=== Starting server in competitive mode ===
Competitive mode will prevent dead teammates from being able to see the match, to prevent ghosting.
You can either enable this via Game.ini (described in Game.ini file), or using the -COMPETITIVE=1 parameter.

<pre>
/home/steam/pavlovserver1/PavlovServer.sh -COMPETITIVE=1
</pre>

{| class="wikitable"

|}

=== Useful Linux Commands ===
List files / folders in directory, print current working directory,
<pre>ls -la #list files/directories along with authorities and ownership
pwd #print working directory
sudo chown <owner> <file/directory> #change owner of file/directory. If root created something and you need to change it to steam
sudo chgrp <group> <file/directory> #change group of file/directory.
</pre>

Check if pavlov is running by checking process status. If the only row you see is the grep command, pavlov server is not started.
<pre> ps -ef | grep pav </pre>

Sample output:
<pre>
steam 34044 1 0 16:52 ? 00:00:00 /bin/sh /home/steam/pavlovserver/PavlovServer.sh
steam 34066 34044 80 16:52 ? 00:00:04 /home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer
zombies+ 34101 34013 0 16:52 pts/0 00:00:00 grep --color=auto pav
</pre>

Kill a process. Note this command uses 34044, which is a process id from the command output above.
<pre> kill -9 34044 </pre>

Dump the log to the console so you can scroll through it:
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log </pre>

Search the log for a string - replace my_string with case-sensitive string
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep my_string </pre>

[[Category:RCON automation]]

Setting up a dedicated server

2023-06-18T03:07:16Z

SaltedCrackerJack: /* Default Map ID's */

== Setting up a dedicated server ==

'''There are no Windows binaries'''

This guide is written exclusively for Linux and covers Ubuntu/Debian/Debian-like and Red Hat RPM-based distros. Possible to run with other distros, but some of the commands won't work and you will need to know enough to figure out the software install of dependencies on your own.

If you are considering hosting from home, please read that section of the wiki first.

This guide assumes you know the basics of using a bash terminal: ssh'ing into a server, running bash commands, editing text files, etc.

If you have no experience using bash, maybe start [https://www.howtogeek.com/140679/beginner-geek-how-to-start-using-the-linux-terminal/ here]. Editing text files via commandline is often a challenge. Suggest using nano and reading guide [https://www.howtogeek.com/howto/42980/the-beginners-guide-to-nano-the-linux-command-line-text-editor/ here]

If you are new to linux and accessing your server from Windows, highly suggest using MobaXterm as your SSH client as that can make required editing of text files easier using built in editor instead of the native linux command line editors.

And finally, ask yourself why you want to setup a server? If you look at the list, there are many, many more servers than players. If you don't have a team, discord community, or group of friends ready to play on your server, chances are it will go unused. Got one of these... great, let's go.

If you don't want to go through the hassle yourself and want to pay for a hosting service Arctic VR (PC and Shack) and Horde (Shack) provide a server hosting services and are trusted in the community. See links below.

----

=== Server Requirements ===

'''Pavlovserver can only be hosted under Linux.'''

This can be running as a VM under windows, but this will increase the complexity of the setup beyond this guide.

Ubuntu 18.04 x86_64, Ubuntu 19/04 amd64, Ubuntu 20.04, and Rocky Linux 8 are confirmed working. Ubuntu 15.04 x86 is known to fail to install using this guide. Recommend not running on "minimal" images as some tools are missing.

* 2GB RAM + 1GB RAM per each additional server with 10 players. More RAM is recommended for larger maps, higher player counts, or complex gamemodes. Not having enough RAM is a common cause of server crashes.

* A ~2.5Ghz CPU will comfortably support a 10 player server.

* A ~4Ghz CPU will comfortably support 24 players. This is a limit built into Pavlov itself, no server will allow players to join over 24. Lower player counts are recommended for complex gamemodes (E.g. CodZ) and/or highly detailed maps, so that maximum number will often be lower.

(Note that these are '''not''' hard limits for player counts, just suggestions for the best performance, based on experiences with many server providers on different grades of hardware.)

* Pavlovserver is functionally single threaded (one thread does vast majority of work). More CPUs only help if you are running more servers. More clockspeed = higher performance = more users per server.
The maximum number of servers you can run is dependent on how many CPUs you have. For example, if you have an 8 core CPU, the maximum number of servers would be 7. You should always have at least one CPU free as overhead, as Pavlov servers can use slightly more than one thread.

----

==== Hosting at home ====
When hosting at home there are additional requirements regarding networking: Your router has to support port-forwarding, hair-pinning/LoopbackNAT, and respond to ping requests. These techniques are necessary to allow your server to be found and to talk back to the client. please see https://en.wikipedia.org/wiki/Port_forwarding, https://en.wikipedia.org/wiki/Hairpinning, and https://www.speedguide.net/faq/how-to-become-pingable-behind-a-routerfirewall-376 for more info and google for these terms in addition to your router model to find guides on how to enable/configure it properly. If you have modern Router, it may have these features already enabled, in this case you just have to configure port-forwarding. If you can see your server but not join it while others can, this is indicative of a failure of LoopbackNAT.

A second challenge to hosting at home is CGNAT (Carrier grade NAT: https://www.a10networks.com/blog/carrier-grade-nat/). Just like NAT on your home network that has to be gotten around w/ port-forwarding, CGNAT breaks the ability of external connections to be made back to your server, but the controls are solely in your ISPs hands. Sometimes if you ask, you can be removed from CGNAT pools and/or assigned a static IP. CGNAT rollouts are becoming very common now, so if your server worked then doesn't allow connections now, your ISP may have made this change.

You can check whether you’re on a CGNAT network by visiting a Web site such as ipaddress.com or whatsmyip.com and comparing the IP address listed to the public/WAN IP address assigned to your Internet gateway. To find your gateway’s public IP address, check the status page in the administrative interface. If the two IP addresses differ, you’re likely on a CGNAT network. If so, this problem must be resolved before you go any further.

'''Not understanding these requirements and configuration is a frequent cause of failed setups and questions in discord. Don't skip this if you are trying to host from home'''

'''There are serious security implications of hosting this software at home.''' None of the devs are security experts and there has been no security review of the code. You are opening up your system to the world and publicity advertising this fact. Expect that any system hosting this software is open to compromise from the Internet and act accordingly. If your router offers a DMZ network, use it. Consider hosting on a cloud based server and think twice before running this software on any system that contains data you care about or has access to networks and computers you care about.

If you're hosting at home using Oracle's VirtualBox, there are steps you can take to prevent double NAT (which can cause issues later on)

1. Select your VM and then click Settings in VirtualBox's main window.

2. Click on Network and change Attached To from NAT to Bridged Adapter.

Once you've done this, your VM should be connected directly to your home router and double NAT should no longer be a issue.
----

==== Hosting Providers ====

Considering the suggested server specs, you may be interested in the following hosting providers. For providers promising dedicated "Pavlov hosting" as opposed to general VPS services please contact and ask how you change maps being hosted and how you get RCON access before you put your money down.

<pre>
Provider | Base CPU | Details
Arctic VR | 4.5 GHz | https://www.arctic-vr.com/server-hosting
Amazon Web Services | 4.0 GHz | https://aws.amazon.com/ec2/instance-types/z1d/
VULTR | 4.0 GHz | https://www.vultr.com/products/high-frequency-compute/
packet.com | 3.5 GHz | https://www.packet.com/cloud/servers/c1-small/
Google Cloud Platform | 3.2 GHz | https://cloud.google.com/compute/docs/cpu-platforms
</pre>

===== ARCTIC VR =====

Arctic VR is the largest and longest running Pavlov VR hosting provider. The In-Game Admin Menu is exclusive to the ArcticVR hosting service. They offer EU, NA East and NA West servers for both shack and PCVR. ArcticVR offers the fastest Pavlov servers as well as DDos Protection, RCON remote management, custom maps, low pings, unlimited slots, and expert support.

Website: https://www.arctic-vr.com/server-hosting

[[File:Arctic_options.png|link=https://www.arctic-vr.com/server-hosting|700px]]

===== VULTR =====

Consider using a referral from the community:

Carlos: https://www.vultr.com/?ref=8615589-6G

Carrot: https://www.vultr.com/?ref=8689348

Archaeo: https://www.vultr.com/?ref=8653652-6G

Cheeto: https://www.vultr.com/?ref=8717358

For a Pavlov Shack server, I recommend minimum Cloud Compute, Intel High Performance, Ubuntu 20.04, and disabled automatic backups. At the time, this was $6/m. Some of the cheap options have 1TB bandwidth, and some have 2TB+. If it's a personal server, 1TB could be fine, but 2TB should be safe.

===== Google Cloud Platform (90 day free credit available) =====

The below configuration is successfully running 4 pavlov PC instances with ~15 total maps and up to 24 players per server. If you want more maps use larger boot disk. Both can dynamically be scaled based on popularity.

<pre>

Menu -> compute engine -> VM instances
create instance
- region: wherever you like
- machine type: n1-highcpu-4 (4 vCPUs, 3.6 GB memory)
- boot disk: Ubuntu 20.04
- boot disk -> size: 25gb
- network tags: pavlov-server
- [create]

Menu -> Vpc network -> firewall rules
[Create firewall rule]
Name: pavlov server
Target Tags: pavlov-server
Source IP Ranges: 0.0.0.0/0
Protocols and Ports -> Specified protocols and ports -> UDP: 7777, 8177 (Shack and PC)
Protocols and Ports -> Specified protocols and ports -> TCP: 7777, 8177 (Shack-only)
Protocols and Ports -> Specified protocols and ports -> TCP: {RCON port - default 9100}
[save]
</pre>

===== Amazon Web Services (30 day free credit available) =====

<pre>
Login -> Change Region: Choose your region
Services -> Compute -> EC2 -> Create
Choose an AMI: Ubuntu 18.04
Instance Type: z1d.large

Instance Details -> Tenancy: Dedicated (optional: this will more than triple the cost)

Storage: 50gb disk (or whatever, you're in control of the map roster)

Security Groups:
Create a new Security Group
Security group name: pavlov-server
Description: pavlov server
Rules:
Type: Custom ICMP Rule - IPV4 / Protocol: Echo Request
Type: Custom UDP Rule / Port Range: 7777 / Source: 0.0.0.0/0
Type: Custom UDP Rule / Port Range: 8177 / Source: 0.0.0.0/0
Type: SSH (optional, but I assume you wanna SSH in..)

Launch -> Create new Keypair -> Download -> Launch

Once it's started, SSH in like:
$ ssh -i your-key.pem ubuntu@you-server-details.amazonaws.com

(I use cmder on Windows, if you're using putty or mobaxterm or something, might be different)
</pre>

=== Starting Server Install ===

====Obtaining an ApiKey====
For your server to show up in the server list, there is now a requirement to have an ApiKey issued by vankrupt. This is to prevent DOS attacks against the master server

Get the key by going here: https://pavlov-ms.vankrupt.com/servers/v1/key and using your mobile number to get a SMS
(note that there have been reported failures of this SMS system for non-US mobiles. In this case DM davevillz your mobile and ask for a key)

Put this key in your Game.ini as follows:
ApiKey="ABC123FALSEKEYDONTUSEME"
or if you would like (personally untested..I would use game.ini) you can call it at server runtime with flag as follows:
-KEY="ABC123FALSEKEYDONTUSEME"

This key can be re-used for a reasonable number of servers (a limit of 10 has been mentioned). Contact the Devs if you need more servers per key.

====System setup and software installation====

Install dependencies and create the `steam` user. (You only need to do this once):

Confirm Linux version
<pre>
lsb_release -a
</pre>

'''Ubuntu 20.04'''
<pre>
sudo apt update && sudo apt install -y gdb curl lib32gcc1 libc++-dev unzip
sudo useradd -m steam
</pre>

'''Ubuntu 20.10 or higher'''
<pre>
sudo apt update && sudo apt install -y gdb curl lib32gcc-s1 libc++-dev unzip
sudo useradd -m steam
</pre>

'''Rocky Linux, CentOS 8, and RHEL 8'''

<pre>
sudo sed -i 's/^SELINUX=enforcing$/SELINUX=permissive/g' /etc/selinux/config
sudo setenforce 0
sudo yum install gdb curl glibc.i686 libstdc++.i686 libstdc++-devel.i686 libstdc++-devel.x86_64 unzip wget -y
wget https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/l/libcxx-3.8.0-3.el7.x86_64.rpm
sudo rpm -i libcxx-3.8.0-3.el7.x86_64.rpm
sudo useradd -m steam
</pre>

[Optional] Set a password for steam.
<pre>sudo passwd steam</pre>

Login as the steam user. ('''You will need to do this each time you connect to your server'''):

<pre>
sudo su -l steam
</pre>

Install Steam:

<pre>
mkdir ~/Steam && cd ~/Steam && curl -sqL "https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz" | tar zxvf -
</pre>

There are different dedicated server versions for Pavlov Server - choose which server version you want to host (PC non-beta, PC Beta, Shack Live, or Shack RC)
(You will need to run this command each time there is a Pavlov Server update).

 
To host '''PC Server (non-beta)''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta default +exit
</pre>

To host '''PC BETA''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta beta_server +exit
</pre>

To host '''Shack Live''' (Quest):

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack +exit
</pre>

To host '''Shack RC''' (Quest): 

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack_beta +exit
</pre>

Now that we've installed the server, all pavlov server versions should continue. 
Install a fresh copy of steamclient.so (May have to do this after each update):
<pre>
~/Steam/steamcmd.sh +login anonymous +app_update 1007 +quit
mkdir -p ~/.steam/sdk64
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/pavlovserver/Pavlov/Binaries/Linux/steamclient.so
</pre>

The update 29 of the PCVR version of pavlov and after added a requirement to run these commands to change the steamclient.so:
<code>sudo rm /usr/lib/x86_64-linux-gnu/libc++.so</code>
<code>sudo ln -s /usr/lib/x86_64-linux-gnu/libc++.so.1 /usr/lib/x86_64-linux-gnu/libc++.so</code>

Make the PavlovServer script executable. (You only need to do this once):

<pre>
chmod +x ~/pavlovserver/PavlovServer.sh
</pre>

----

=== Server Configuration ===

Before starting the server we need to configure it. Start by creating some directories:

<pre>
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Logs
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps
</pre>

==== Mods/Blacklist/Whitelist (optional) ====

The following three files allow you to specify mods, banned players, and whitelist players. These are optional, but go ahead and create them. Populating the files is described later.

<pre>
touch /home/steam/pavlovserver/Pavlov/Saved/Config/mods.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/blacklist.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/whitelist.txt
</pre>

====Configuring Game.ini====
Create a new Game.ini file using following command to open an editor and copy/paste the following block into it then save it. Note not all of these options are required. For instance remove or comment out the Password=0000 line to make a public server with no pin.
<pre>
nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini
</pre>

<pre>
[/Script/Pavlov.DedicatedServer]
bEnabled=true
ServerName="My_private_idaho"
MaxPlayers=10 #Set this to 10 for Shack. 24 is the max for PC, setting it higher will not allow players to join.
ApiKey="ABC123FALSEKEYDONTUSEME"
bSecured=true
bCustomServer=true
bVerboseLogging=false
bCompetitive=false #This only works for SND
bWhitelist=false
RefreshListTime=120
LimitedAmmoType=0
TickRate=90
TimeLimit=60
#Password=0000
#BalanceTableURL="vankruptgames/BalancingTable/main"
MapRotation=(MapId="UGC1758245796", GameMode="GUN")
MapRotation=(MapId="datacenter", GameMode="SND")
MapRotation=(MapId="sand", GameMode="DM")

</pre>

* '''bEnabled''' - whether the server appears in the server list (unconfirmed)
* '''ServerName''' - name it will be listed as. (approx 35 chars max)
* '''MaxPlayers''' - See suggested specs for limits. 10 standard (10 for shack), 20-24 is max recommended for large maps like Stalingrad or PUSH/RUSH modes, and servers allow a maximum of 24 players.
* '''ApiKey''' - Unique ApiKey required to register server with master server. Replace with your key
* '''bSecured''' - enabled Valve Anti-Cheat (VAC)
* '''bCustomServer''' - activates some new modding tools (save and http functions. Required to write to blacklist.txt for bans)
* '''bCompetitive''' - sets the server to competitive mode for SND. If removed the server will default to false
* '''bVerboseLogging''' - enables verbose logging, mostly detailed statistics. Be prepared for significant increase in logging.
* '''bWhitelist''' - Only allow users in whitelist.txt to join
* '''RefreshListTime''' - sets how often the running server checks for updates in ban/whitelist/mod files
* '''LimitedAmmoType''' - sets limited ammo mode
0 = Unlimited
1 = Limited Generic
2 = Limited Specific
3 = Custom (for modders)
4 = Limited Special
5 = Boxless Mode

* '''TimeLimit''' - sets time limit for each map
* '''TickRate''' - sets the server tickrate. (so far minimum stable seems around 50 and max around 120. Beware setting this changes weapon despawn time and breaks some game modes. Recommend not touching)
* '''Password''' - PIN number for server #FYI - this is now also changeable via rcon.
* '''BalanceTableURL''' - Points to a custom balance table from github. See https://github.com/vankruptgames/BalancingTable for instructions. This line isn't needed if you don't have one.
* '''MapRotation''' - you can add multiple of these. The map system has switched from the steam workshop to modio which means that the server rotation will need to be redone with modio UGCs. <nowiki>https://mod.io/g/pavlov</nowiki>. This is done by taking the resource ID from the modio page, adding “UGC” in front of it and then adding that to the rotation. For example the map gravity <nowiki>https://mod.io/g/pavlov/m/gravity1</nowiki> has a resource ID of 2773760 so the map ID to add to the server would be “UGC2773760”. When a match ends, the server will load the next map in the rotation.

Available game modes as of 09/06/2022: SND, TDM, DM, GUN, ZWV, WW2GUN, TANKTDM, KOTH, TTT, OITC, INFECTION, HIDE, PUSH, PH

For maps running a Custom gamemode (CodZ, BR, Duel, etc.) it doesn't matter which gamemode you choose, as the map will automatically override it with the custom mode.

= Default Map ID's =
datacenter

sand

bridge

containeryard

siberia (Prison Break)

hospital (Zombies map)

killhouse

range

tutorial

santorini

station

industry

ogcontainers (Shack only)

haguenau (Shack only)

foundation (Shack only)

stalingrad (PC only)

stalingrad_night (PC only)

santorini_night (PC only)

sand_night (PC only)

station_night (PC only)

industry_night (PC only)

bunker (PC only)

==== Firewall/Port forwarding ====
Using the default settings there are two UDP ports (7777, 8177) that need to be allowed to access the server either by firewall setup or port forwarding.

'''Ubuntu''' firewall commands to check firewall and open ports:
<pre>
sudo ufw status
sudo ufw allow 7777
sudo ufw allow 8177
sudo ufw allow 9100
sudo ufw status
</pre>

'''Rocky Linux''' firewall commands to check firewall and open ports:
<pre>
sudo firewall-cmd --zone=public --add-port=7777/tcp
sudo firewall-cmd --zone=public --add-port=7777/udp
sudo firewall-cmd --zone=public --add-port=8177/tcp
sudo firewall-cmd --zone=public --add-port=8177/udp
sudo firewall-cmd --zone=public --add-port=9100/udp
sudo firewall-cmd --zone=public --add-port=9100/tcp
sudo firewall-cmd --list-ports
firewall-cmd --runtime-to-permanent
</pre>

You may also need to allow Pings (ICMP) for the server's true latency to appear in the master list.

If you are running multiple servers and have set additional ports (see http://wiki.pavlov-vr.com/index.php?title=Dedicated_server#Running_multiple_servers_on_one_host) then you need to allow access to the defined port plus the port 400 higher. So if you use 7000 as your port, then UDP 7000 and 7400 need to be open

If you have setup rcon via RconSettings.txt (below) then that port also need to be allowed access via TCP

If you are running Shack/Quest and want to have maps that are downloadable from your server, your server ports (ex. 7777 & 8177) must also be open via TCP

----

==== Shack Maps (Quest) ====

If you try to use the steps above to add maps for Shack, youll run into issues very quickly. This is because Shack has no affiliation to Steam, and therefore cannot use Steam Workshop maps like above. In the future, these steps will apply to PC servers as well, allowing a server to hold the map itself, instead of offloading to Steam.

To get started, first create the directory to hold the maps

<pre>mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps</pre>

You can use any number of methods to move the map files onto the server, but ill go over the two simplest, starting with a GUI approach

Download and install CyberDuck onto your "home" PC (Whatever PC you use for access to the server, but not the server itsself): https://cyberduck.io/

Next, download and unzip your map of choice from https://www.pavlovquest.com/ , https://pavlovhorde.com/mapsList, or look in #shack-map-showcase channel in the discord server. I'm going to use Cheeto's WW2 Items test (http://www.mediafire.com/file/emyt9bs1z9u9ykw/SVR_Cheeto_Items.zip/file ) for this example, you do what you like

In the top left corner, open a connection, set the connection type to SFTP, and fill in the rest of the information. User will be root, password is whatever you set the root pw as (toor in Ubuntu by default)

In the directory dropdown (itll say /root) go back to /

Follow the directories until we arrive back at our "maps" folder <pre>/home/steam/pavlovserver/Pavlov/Saved/maps</pre>

Drag and drop the unzipped map folder into the main window, in this case itll be SVR_Cheeto_Items

Hit Allow

Youll now see a folder named SVR_Cheeto_Items, and within it should be nothing but 3 files. If there is another folder in it, move this folder to the maps directory, otherwise the server wont work. The 3 files (2 .PAK one .JSON) should be in home/steam/pavlovserver/Pavlov/Saved/maps/SVR_Cheeto_Items, no more, no less.

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

To play the map, you can either use RCON switch map command, or to add the map to your servers automatic map rotation list, add the map's folder name to your Game.ini. This replaces the MapID section, so for our example it would be

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

And thats all! Disconnect CyberDuck from your server before playing, otherwise youll have difficulty joining.

-----------

==== Adding Shack Maps over Command Line Interface ====

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

A bit more complicated, but adding maps over CLI has its benefits

First, CD to the maps directory you made above

<pre>cd ~/pavlovserver/Pavlov/Saved/maps</pre>

Download the map files from whatever you use to upload them. To do this, you can either use curl or wget

<pre>curl -O insertURLhere</pre>

'''If you download your map from Google Drive''', make sure that your .zip folder is shared to anyone.
Then, get the file's url from the shared link. Example : ''<nowiki>https://drive.google.com/file/d/19bI8gUHaN5tUrDvnadAacUnchQf6_k/view</nowiki>'' will be ''19bI8gUHaN5tUrDvnadAacUnchQf6_k''
Edit "fileId" and "fileName" before you execute the command.
<pre>
fileId=19bI8gUHaN5tUrDvnadAacUnchQf6_k
fileName=SVR_USER_MAPNAME
curl -sc /tmp/cookie "https://drive.google.com/uc?export=download&id=${fileId}" > /dev/null
code="$(awk '/_warning_/ {print $NF}' /tmp/cookie)"
curl -Lb /tmp/cookie "https://drive.google.com/uc?export=download&confirm=${code}&id=${fileId}" -o ${fileName} </pre>

To keep with the Items example:

<pre>curl -O https://cdn.discordapp.com/attachments/744185280759857234/745027406695366788/SVR_Cheeto_Items.zip</pre>

Next, unzip the file. If this next step errors out, saying the command is unknown, switch back to the root user (su root), and install unzip (sudo apt install unzip), then return to the steam user, and continue.

<pre>unzip SVR_Cheeto_Items.zip</pre>

Now finish like before by adding the map to your Game.ini

<pre>nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini</pre>

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

==== Admin/Moderator list (optional) ====

The only working in-game admin menu is through Arctic VR server hosting (see below).

If you add moderators to your server, they will not be subject to vote kicks.

<pre>
nano ~/pavlovserver/Pavlov/Saved/Config/mods.txt
</pre>

Example Mod List:
<pre>
76541198397498572 #Optional Comment: Player name
76541198397498573 #Some Other Player
</pre>

==== ArcticVR Admin Menu ====

[[File:Arcticmenu.jpg|500px|link=https://www.arctic-vr.com/server-admin-menu]]

Arctic-VR Offers an advanced In-Game Admin menu that is exclusive to their hosting service. Features include:
* Switch Maps+Modes
* Teleport Players to Players
* Change Player Skins
* Control Player Buying+Cash
* Spawn Items
* Clean up corpses + guns
* Spawn Bots
* Spawn Items for other players
* Control Teams + Balance/Shuffle Teams
* ResetSND
* And More

You can read more about the ArcticVR admin menu on their website: https://www.arctic-vr.com/server-admin-menu

==== Handy tools for finding steamIDs ====

Steam ID finder: https://steamidfinder.com/lookup/ or https://steamid.xyz/

You want to enter in the steamID64 format.

This tool can convert or lookup IDs: https://steamid.io/

If you are looking for a steamID of a player that has been on your server recently this is technique to find them:
<pre>
grep -i playername ~/pavlovserver/Pavlov/Saved/Logs/* | grep TicketValidation
</pre>

=== Configure Rcon ===
To enable Rcon access create config file:
<pre> nano /home/steam/pavlovserver/Pavlov/Saved/Config/RconSettings.txt </pre>

Copy in the following text - change password, and if desired the port:
<pre>
Password=ChangeThisPassword
Port=9100
</pre>
You must specify a port for the Rcon server to use as well as a Password (use a different port per sever instance if running multiple server instances off the same hardware)

=== Starting the server ===

<pre>
cd ~/pavlovserver && ./PavlovServer.sh
</pre>

That's it, your server will be automatically broadcast to the master server! :)

Two handy tools to determine quickly if your server is broadcasting are [https://pablub.xyz/ Pablub] (PC only) and [https://pavlovhorde.com/ Horde] (Shack) and [https://pavlovhorde.com/pcServers Horde] (PC version)

Note that when you close your terminal, the server will go down. See the "supervisors" section below for how to prevent this.

=== Auto-updating the server ===

Assuming you have followed this guide and used the default paths, users, and install instructions, you can paste the following into your terminal to auto-update your Pavlov server:

<pre>
cat << 'EOF' > $HOME/pavlov_daily_update_and_restart.sh
#!/bin/bash

USER="steam"
SERVICENAME="pavlovserver.service"
INSTALLDIRNAME="pavlovserver"
USERHOME="/home/$USER"

echo -e "Beginning Pavlov VR update run on $(date)\n\n"

systemctl stop "$SERVICENAME"

sleep 5
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +force_install_dir "$USERHOME/$INSTALLDIRNAME" +app_update 622970 +exit
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +app_update 1007 +quit
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/.steam/sdk64/steamclient.so"
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/pavlovserver/Pavlov/Binaries/Linux/steamclient.so"

systemctl start "$SERVICENAME"

echo -e "Ending Pavlov VR update run on $(date)\n\n"

EOF

chmod +x $HOME/pavlov_daily_update_and_restart.sh
mkdir $HOME/pavlov_update_logs && touch $HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log
CRONLINE="00 2 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
(sudo crontab -u root -l; echo "$CRONLINE" ) | sudo crontab -u root -
unset CRONLINE

</pre>

These commands will:

1. Create a shell script in the "steam" user's home directory that automatically stops the Pavlov server, pulls any updates via steam, pull updates to the Steamworks SDK Redist, and copies the latest version of steamclient.so to the Pavlov server directory

2. Make the shell script executable

3. Create a new directory called "pavlov_update_logs" in the "steam" user's directory, and create a logfile inside that directory called "pavlov_daily_update_and_restart.sh.log". You can check this logfile to see the output of the Pavlov and Steam SDK update commands.

4. Create a crontab entry for the root user that runs this shell script automatically every day at 2:00AM local time

If you want to change the time that this script runs, edit the numbers "00 2" in the line that starts with "CRONLINE=". In the example provided, 00 is the minutes column, and 2 is the hour column. For example, if you wanted the server to automatically update and restart at 4:17AM every day, change the line starting with "CRONLINE=" to:

<pre>
CRONLINE="17 4 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
</pre>

If the time is PM, use 24-hour time format, e.g. "32 18" for 6:32PM.

----

=== Supervising the server using systemd ===

Running '''./PavlovServer.sh''' in your interactive shell is easy, but the server will shut down when you close your terminal. If you want to run the server in the background,
you'll want to run it under a supervisor. There are many options, ranging from the simple (nohup, screen or tmux), to the
more robust (supervisord, systemd).

Systemd is running by default on Ubuntu Linux, so we'll use that here.

To run the server as a systemd service, create the file '''/etc/systemd/system/pavlovserver.service''' (as root) by typing
<pre>
sudo nano /etc/systemd/system/pavlovserver.service
</pre>

Copy contents below into the file and save.

<pre>
[Unit]
Description=Pavlov VR dedicated server

[Service]
Type=simple
WorkingDirectory=/home/steam/pavlovserver
ExecStart=/home/steam/pavlovserver/PavlovServer.sh

RestartSec=1
Restart=always
User=steam
Group=steam

[Install]
WantedBy = multi-user.target
</pre>

If you'd like your server to start as competitive without editing the game.ini, change the line "ExecStart=/home/steam/pavlovserver/PavlovServer.sh" to look like this below. Though it's much easier to just use the game.ini to enable competitive instead. <pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -COMPETITIVE=1</pre>

Change the user or paths as appropriate. After saving the service file, to start, restart, stop, or monitor the server:

<pre>
sudo systemctl start pavlovserver
sudo systemctl restart pavlovserver
sudo systemctl stop pavlovserver
sudo systemctl status pavlovserver
</pre>

To view the logs:

<pre>
sudo journalctl -u pavlovserver
# to live-tail the logs
sudo journalctl -u pavlovserver -f
</pre>

If you want to run the pavlov server as soon as your server boots (e.g. a VPS you turn on and off), add pavlov as a startup service:

<pre>
sudo systemctl enable pavlovserver
</pre>

----

== Advanced Server Administration ==

=== Running multiple servers on one host ===

* Pavlovserver is functionally single threaded (there are multiple threads, but vast majority of work occurs in the primary one). Make sure you have # of pavlovservers + 1 CPU available. More CPUs= more servers. Faster CPU = more players.
* Make multiple server installs by defining a separate install dir for each server.
* Run each server with a unique port. eg: '''./PavlovServer.sh -PORT="Desired Port"'''
* The Server will use the Desired Port and the Port 400 above (Example: You choose 8200 as Port. So Port 8600 will be used as well)
* If you are using RCON, each server will need a unique port defined in RconSettings.txt
* Ensure the ports are forwarded and opened in your firewall

To duplicate directories:

be in the steam home folder
<pre>
cp -r pavlovserver pavlovserver1
/home/steam/pavlovserver1/PavlovServer.sh -PORT=[Desired Port]
</pre>

=== Starting server in competitive mode ===
Competitive mode will prevent dead teammates from being able to see the match, to prevent ghosting.
You can either enable this via Game.ini (described in Game.ini file), or using the -COMPETITIVE=1 parameter.

<pre>
/home/steam/pavlovserver1/PavlovServer.sh -COMPETITIVE=1
</pre>

{| class="wikitable"

|}

=== Useful Linux Commands ===
List files / folders in directory, print current working directory,
<pre>ls -la #list files/directories along with authorities and ownership
pwd #print working directory
sudo chown <owner> <file/directory> #change owner of file/directory. If root created something and you need to change it to steam
sudo chgrp <group> <file/directory> #change group of file/directory.
</pre>

Check if pavlov is running by checking process status. If the only row you see is the grep command, pavlov server is not started.
<pre> ps -ef | grep pav </pre>

Sample output:
<pre>
steam 34044 1 0 16:52 ? 00:00:00 /bin/sh /home/steam/pavlovserver/PavlovServer.sh
steam 34066 34044 80 16:52 ? 00:00:04 /home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer
zombies+ 34101 34013 0 16:52 pts/0 00:00:00 grep --color=auto pav
</pre>

Kill a process. Note this command uses 34044, which is a process id from the command output above.
<pre> kill -9 34044 </pre>

Dump the log to the console so you can scroll through it:
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log </pre>

Search the log for a string - replace my_string with case-sensitive string
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep my_string </pre>

[[Category:RCON automation]]

Rcon Overview and Commands

2023-06-14T00:03:49Z

SaltedCrackerJack: /* Rcon Overview and Commands */

RCON (Remote CONnection) is the method pavlov servers can be controlled from outside of VR. When a server is brought online, an email is sent to the owner with the RCON credentials to connect remotely. RCON can be accessed at: <nowiki>http://pavlovrcon.com/</nowiki>
----

== Rcon Overview and Commands ==
'''Ban/Unban'''

If you want Ban/Unban to work file /home/steam/pavlovserver/Pavlov/Saved/Config/blacklist.txt needs to be writable by user running server. (If you followed the instructions on the wiki, username steam is running the server and creates the file).

Commands:

<pre>
Help -Returns the full list of commands
Ban {UniqueID} -Bans the player from the server (adds them to blacklist.txt)
Kick {UniqueID} -Kicks the player from the server
Kill {UniqueID} -Kills the player
Unban {UniqueID} -Unbans the player from the server (tries to remove the unique id from blacklist.txt)'
Banlist -Shows the current list of banned players
AddMod {UniqueID} -Adds a mod ID to the mods.txt file
RemoveMod {UniqueID} -Removes a mod ID to the mods.txt file
ItemList -Shows available items for GiveItem command
RotateMap -Rotates to the next map in the game.ini
SwitchMap {MapName/ID} {GameMode} -Switches to the map/gamemode specified, ex "SwitchMap DataCenter TDM" or "SwitchMap UGC1080326389 DM"
SwitchTeam {UniqueID} {TeamId} -Switches the specified players team
GiveItem {UniqueID} {ItemId} -Give the specified player the Item
GiveCash {UniqueID} {CashAmt} -Give the specified player cash
GiveTeamCash {TeamId} {CashAmt} -Gives all members of the teamId cash
GiveVehicle {UniqueID} {VehicleID} -Spawns Vehicle on top of player, see below for vehicle IDs
InspectPlayer {UniqueID} -Returns information about the player specified (PlayerName, Cash, KDA, TeamId etc)
RefreshList -Returns a list of players on the server (unique/steamId)
Slap {UniqueID} {damage amt} -Inflicts damage amount on player. From zero to 100.
ServerInfo -Returns information about the server (ServerName, CurrentMap, PlayerCount/MaxPlayerCount etc)
Disconnect -Disconnects the player from Rcon
ResetSND -Resets the match back to round 1 keeping the same teams
SetPlayerSkin {UniqueID} {SkinId} -Sets the skin for the specified player, see below for IDs
SetLimitedAmmoType {0-5} -Sets the limited ammo type for the duration of the match. See below for the different ammo types available
SetPin {####} -Sets the password on your server, must be 4 digits e.g. "SetPin 0000". Running SetPin without a number will remove the pin from the server.
Shownametags {True/False} -Toggles if nametags are visible or not. Useful for tactical/realistic servers, or making trailers and taking screenshots for your maps.
Shutdown -Shuts down the server (Shack RC only, currently untested).

TTT-only commands:

tttflushkarma {UniqueID} -Resets a player's karma
tttsetkarma {UniqueID} {####} -Sets the karma of a player to a value
tttsetrole {UniqueID} -Currently broken
tttendround -Ends the round
tttpausetimer -Pauses the timer
TTTAlwaysEnableSkinMenu -Enables the skin menu mid-round
</pre>

PCVR UE5 update RCON CMDS<pre>
AddMapRotation [MapID] [GameMode] # add a map to the servers rotation from Mod.io
AddMod [UniqueID] # add user to mods.txt on server (make an admin) and allows them to use admin menu in pause menu
Ban [UniqueID] # ban player permanently and add there ID to blacklist.txt on server
Banlist # shows current banned players
Disconnect # close rcon connection (should always be used when done)
EnableCompMode [True/False]
EnableVerboseLogging [True/False] # more info printed to log file on server
EnableWhitelist [True/False] # only players who are on the whitelist.txt on server may join
Gag [UniqueID] [True/False] # player cant use mic
GiveAll [TeamID] [ItemID] # give all players on team a item
GiveCash [UniqueID] CashAmt # give player cash
GiveItem [UniqueID] [ItemID] # give player item
GiveTeamCash [TeamId] [CashAmt] # give team cash
InspectAll # prints detailed status for each connected player
InspectPlayer [UniqueID] # prints detailed status for a connected player
InspectTeam [TeamID] # prints detailed status for one team of connected players
ItemList # list items in game / map (custom items built into map will list too )
Kick [UniqueID] # remove player from game
Kill [UniqueID] # kills player
MapList # shows current map rotation
ModeratorList # shows current server admins
RefreshList # shows all connected players and ID
RemoveMapRotation [MapID] [GameMode] # remove map from rotation
RemoveMod [UniqueID] # remove admin
ResetSND
PauseMatch [TimeInSeconds]
RotateMap
ServerInfo
SetBalanceTableURL [GithubURL]
SetCash [UniqueID] [CashAmt]
SetLimitedAmmoType [AmmoType]
SetMaxPlayers [MaxPlayerNumber]
SetPin [PinNumber]
SetPlayerSkin [UniqueID] [SkinID]
SetTimeLimit [TimeLimitAmount]
ShowNametags [True/False]
ShutdownServer
Slap [UniqueID] [DamageAmount]
SwitchMap [MapId] [GameMode]
SwitchTeam [UniqueID] [TeamID]
Teleport [MoveUniqueID] [ToUniqueID]
TTTAlwaysEnableSkinMenu [True/False]
TTTEndRound [WinningTeamID]
TTTFlushKarma
TTTGiveCredits [UniqueID] [CreditAmount]
TTTPauseTimer [True/False]
TTTSetKarma [UniqueID] [KarmaAmt]
TTTSetRole [UniqueID] [RoleID]
Unban [UniqueID]
UpdateServerName [ServerName]
</pre>

{UniqueID} is a player's Steam ID 64. It's the 17-digit number that appears next to their names in most Rcon tools. Alternatively, if you have a player's profile URL, you can find their ID at: https://steamid.xyz/

'''Limited ammo types:'''

0 = Unlimited 
1 = Limited Generic 
2 = Limited Specific 
3 = Custom (for modders) 
4 = Limited Special 
5 = Boxless Mode

'''Item, skin, and vehicle IDs:'''

[http://wiki.pavlov-vr.com/index.php?title=ItemIDs A full list of all items, vehicles, and skin can be found here.]

You can also run the ItemList command through Rcon to receive the most recent and up to date list of all items.

'''Game Modes:''' 
DM - Death Match 
KOTH - King Of The Hill 
GUN - Gun Game 
OITC - One In The Chamber 
SND - Search and Destroy 
TANKTDM - WW2 Team Death Match 
TDM - Team Death Match 
TTT - Trouble in Terrorist Town 
WW2GUN - WW2 Gun Game 
ZWV - Zombie Wave Survival 
HIDE - The Hidden 
INFECTION - Hidden Infection 
PUSH - Push 
PH - Prophunt 
----

=== Connecting to RCON ===

Make sure whatever port you used is open in your firewall for TCP connections. Connections are simple TCP port/telnet style connections.

To test connecting to the rcon port and issuing simple commands use netcat or telnet:
<pre>nc {ip address} {port}</pre>
<pre>telnet {ip address} {port}</pre>

For the password use the md5 hash of the password in the file (this may change in the future). You can get this using <pre>echo -n password | md5sum</pre>

If successful you should get an Authenticated=1 reply

=== Tools available to access Rcon interface ===

A good first place to start is the RCON web interface run by ArcticVR. You do this at http://pavlovrcon.com/.

If you want private control of your server, you will need to do a bit more work for it. At the simplest, using netcat (nc) or telnet as described above will give you basic access to all commands

If you want to batch commands (i.e. for moving players on to teams and triggering ResetSnd) the following script can be useful to call a pre-written batch files of commands. Call with your batch file as the first argument to the script. The file should have one command per line with first line being the hashed password as above.
<pre>
#!/bin/bash
function slowcat(){ while read; do sleep .05; echo "$REPLY"; done; }
cat $1 | slowcat | nc {ip address} {port}
</pre>

Example batchfile:
<pre>
8b96753b29612d8c98d6b696140b5d9f
ResetSnd
Disconnect
</pre>

 
<hr>

'''There is a very brief example above
but it was not very detailed so i wanted to add a more detailed explanation'''

be aware that connecting and disconnecting a lot can hurt server performance

first you need to make a shell script
<pre>nano /home/steam/test.sh</pre>

<pre>#!/bin/bash
function slowcat(){ while read; do sleep .15; echo "$REPLY"; done; }
cat $1 | slowcat | nc {SERVER IP} {SERVER RCON PORT}</pre>

now exit and save the test.sh

here will will make a batch file that will just hold the rcon password and cmds we want to issue

<pre>nano /home/steam/batch</pre>
<pre>{RCON PASSWORD CONVERTED TO MD5 HASH}
{RCON CMD}
{RCON CMD}
Disconnect</pre>

here the first line has to be the rcon password converted to MD5 HASH
https://www.md5hashgenerator.com/
then each line after that u can use any rcon commands
the last line must be disconnect

now we need to give the sh permissions to run
<pre>sudo chmod +x /home/steam/test.sh</pre>

to run the bash script
<pre>./home/steam/test.sh /home/steam/batch</pre>

so to run the script we need to ./ the .sh then after a space we need to pass the batch

=== Rcon access from within VR ===

PavlovRconWebserver, pavlov-vr-rcon and pavlov_rcon_tcl have been designed to be accessible within VR using virtual desktop view.

'''pavlov_rcon_tcl''': This is a tool designed to run on your desktop for access within VR

https://github.com/Oakraven79/pavlov_rcon_tcl

'''PavlovRconWebserver''' is an interface designed to be usable from everywhere all the time. (also in VR over desktop view)
<pre>Features:
Manage multiple Linux servers with multiple pavlov servers.
Start / Stop / Update
Public player lists
Do almost all rcon commands
Change the map rotation
Determine which users can do what via roles
Manage whitelists and blacklists
Integrate the player lists on all other websites
</pre>
<pre>Requirements:
Good Linux knowledge
SSH access to a linux server
</pre>

https://github.com/devinSpitz/PavlovRconWebserver

While functional, the PavlovRconWebserver is still in development.

If you do plan on using this tool, we recommend asking for help on the official Discord or http://discord.spitzen.solutions, or contacting the creator on the Github page (devinspitz) for the latest info on how to use it. Failing to do so will likely result in you breaking your servers.

'''pavlov-vr-rcon''': This is tool designed to run on your desktop for access from within VR with SND team setup

https://github.com/Krzychu81/pavlov-vr-rcon

=== RCON access from Discord ===

For the ultimate in both control and complexity of setup, use the open-source '''pavlov-bot'''. This is a discord bot that will listen for commands in your discord and execute them. Supports all RCON commands with handy features such as discord role based authentication and authorisation, player, map and team aliases (No more SteamIDs or UGC####) and enhanced "all" and team based commands. Has support for flushing non-registered players from server. Advanced features to include alerting when servers are kicking off, team killing player kick/ban and large server (PUSH/RUSH/TankTDM) player balance (count) control.

For '''shack''' users it has been updated to support Oculus ids and map aliases, so is fully functional for both server versions. See Readme.md for shack specific tweaks.

https://github.com/makupi/pavlov-bot

'''Horde''' also offers a Discord Bot to grant RCON permissions to friends in Discord, and run commands from specific channels. Invite the Horde Bot to your Discord server with this link:
https://discord.com/oauth2/authorize?client_id=780880728992383077&scope=bot&permissions=199744

=== Tips on developing apps to use RCON ===

What is important if you are issuing commands using a program at high frequency is that you open one connection and put all of the commands through that open connection with a small (.1 sec is fine) delay. What you don't want to do is open a new connection for each command or shove all of the commands through super fast. First causes performance issues and the second dropped commands.

Setting up a dedicated server

2023-06-13T05:07:18Z

SaltedCrackerJack: /* System setup and software installation */

== Setting up a dedicated server ==

'''There are no Windows binaries'''

This guide is written exclusively for Linux and covers Ubuntu/Debian/Debian-like and Red Hat RPM-based distros. Possible to run with other distros, but some of the commands won't work and you will need to know enough to figure out the software install of dependencies on your own.

If you are considering hosting from home, please read that section of the wiki first.

This guide assumes you know the basics of using a bash terminal: ssh'ing into a server, running bash commands, editing text files, etc.

If you have no experience using bash, maybe start [https://www.howtogeek.com/140679/beginner-geek-how-to-start-using-the-linux-terminal/ here]. Editing text files via commandline is often a challenge. Suggest using nano and reading guide [https://www.howtogeek.com/howto/42980/the-beginners-guide-to-nano-the-linux-command-line-text-editor/ here]

If you are new to linux and accessing your server from Windows, highly suggest using MobaXterm as your SSH client as that can make required editing of text files easier using built in editor instead of the native linux command line editors.

And finally, ask yourself why you want to setup a server? If you look at the list, there are many, many more servers than players. If you don't have a team, discord community, or group of friends ready to play on your server, chances are it will go unused. Got one of these... great, let's go.

If you don't want to go through the hassle yourself and want to pay for a hosting service Arctic VR (PC and Shack) and Horde (Shack) provide a server hosting services and are trusted in the community. See links below.

----

=== Server Requirements ===

'''Pavlovserver can only be hosted under Linux.'''

This can be running as a VM under windows, but this will increase the complexity of the setup beyond this guide.

Ubuntu 18.04 x86_64, Ubuntu 19/04 amd64, Ubuntu 20.04, and Rocky Linux 8 are confirmed working. Ubuntu 15.04 x86 is known to fail to install using this guide. Recommend not running on "minimal" images as some tools are missing.

* 2GB RAM + 1GB RAM per each additional server with 10 players. More RAM is recommended for larger maps, higher player counts, or complex gamemodes. Not having enough RAM is a common cause of server crashes.

* A ~2.5Ghz CPU will comfortably support a 10 player server.

* A ~4Ghz CPU will comfortably support 24 players. This is a limit built into Pavlov itself, no server will allow players to join over 24. Lower player counts are recommended for complex gamemodes (E.g. CodZ) and/or highly detailed maps, so that maximum number will often be lower.

(Note that these are '''not''' hard limits for player counts, just suggestions for the best performance, based on experiences with many server providers on different grades of hardware.)

* Pavlovserver is functionally single threaded (one thread does vast majority of work). More CPUs only help if you are running more servers. More clockspeed = higher performance = more users per server.
The maximum number of servers you can run is dependent on how many CPUs you have. For example, if you have an 8 core CPU, the maximum number of servers would be 7. You should always have at least one CPU free as overhead, as Pavlov servers can use slightly more than one thread.

----

==== Hosting at home ====
When hosting at home there are additional requirements regarding networking: Your router has to support port-forwarding, hair-pinning/LoopbackNAT, and respond to ping requests. These techniques are necessary to allow your server to be found and to talk back to the client. please see https://en.wikipedia.org/wiki/Port_forwarding, https://en.wikipedia.org/wiki/Hairpinning, and https://www.speedguide.net/faq/how-to-become-pingable-behind-a-routerfirewall-376 for more info and google for these terms in addition to your router model to find guides on how to enable/configure it properly. If you have modern Router, it may have these features already enabled, in this case you just have to configure port-forwarding. If you can see your server but not join it while others can, this is indicative of a failure of LoopbackNAT.

A second challenge to hosting at home is CGNAT (Carrier grade NAT: https://www.a10networks.com/blog/carrier-grade-nat/). Just like NAT on your home network that has to be gotten around w/ port-forwarding, CGNAT breaks the ability of external connections to be made back to your server, but the controls are solely in your ISPs hands. Sometimes if you ask, you can be removed from CGNAT pools and/or assigned a static IP. CGNAT rollouts are becoming very common now, so if your server worked then doesn't allow connections now, your ISP may have made this change.

You can check whether you’re on a CGNAT network by visiting a Web site such as ipaddress.com or whatsmyip.com and comparing the IP address listed to the public/WAN IP address assigned to your Internet gateway. To find your gateway’s public IP address, check the status page in the administrative interface. If the two IP addresses differ, you’re likely on a CGNAT network. If so, this problem must be resolved before you go any further.

'''Not understanding these requirements and configuration is a frequent cause of failed setups and questions in discord. Don't skip this if you are trying to host from home'''

'''There are serious security implications of hosting this software at home.''' None of the devs are security experts and there has been no security review of the code. You are opening up your system to the world and publicity advertising this fact. Expect that any system hosting this software is open to compromise from the Internet and act accordingly. If your router offers a DMZ network, use it. Consider hosting on a cloud based server and think twice before running this software on any system that contains data you care about or has access to networks and computers you care about.

If you're hosting at home using Oracle's VirtualBox, there are steps you can take to prevent double NAT (which can cause issues later on)

1. Select your VM and then click Settings in VirtualBox's main window.

2. Click on Network and change Attached To from NAT to Bridged Adapter.

Once you've done this, your VM should be connected directly to your home router and double NAT should no longer be a issue.
----

==== Hosting Providers ====

Considering the suggested server specs, you may be interested in the following hosting providers. For providers promising dedicated "Pavlov hosting" as opposed to general VPS services please contact and ask how you change maps being hosted and how you get RCON access before you put your money down.

<pre>
Provider | Base CPU | Details
Arctic VR | 4.5 GHz | https://www.arctic-vr.com/server-hosting
Amazon Web Services | 4.0 GHz | https://aws.amazon.com/ec2/instance-types/z1d/
VULTR | 4.0 GHz | https://www.vultr.com/products/high-frequency-compute/
packet.com | 3.5 GHz | https://www.packet.com/cloud/servers/c1-small/
Google Cloud Platform | 3.2 GHz | https://cloud.google.com/compute/docs/cpu-platforms
</pre>

===== ARCTIC VR =====

Arctic VR is the largest and longest running Pavlov VR hosting provider. The In-Game Admin Menu is exclusive to the ArcticVR hosting service. They offer EU, NA East and NA West servers for both shack and PCVR. ArcticVR offers the fastest Pavlov servers as well as DDos Protection, RCON remote management, custom maps, low pings, unlimited slots, and expert support.

Website: https://www.arctic-vr.com/server-hosting

[[File:Arctic_options.png|link=https://www.arctic-vr.com/server-hosting|700px]]

===== VULTR =====

Consider using a referral from the community:

Carlos: https://www.vultr.com/?ref=8615589-6G

Carrot: https://www.vultr.com/?ref=8689348

Archaeo: https://www.vultr.com/?ref=8653652-6G

Cheeto: https://www.vultr.com/?ref=8717358

For a Pavlov Shack server, I recommend minimum Cloud Compute, Intel High Performance, Ubuntu 20.04, and disabled automatic backups. At the time, this was $6/m. Some of the cheap options have 1TB bandwidth, and some have 2TB+. If it's a personal server, 1TB could be fine, but 2TB should be safe.

===== Google Cloud Platform (90 day free credit available) =====

The below configuration is successfully running 4 pavlov PC instances with ~15 total maps and up to 24 players per server. If you want more maps use larger boot disk. Both can dynamically be scaled based on popularity.

<pre>

Menu -> compute engine -> VM instances
create instance
- region: wherever you like
- machine type: n1-highcpu-4 (4 vCPUs, 3.6 GB memory)
- boot disk: Ubuntu 20.04
- boot disk -> size: 25gb
- network tags: pavlov-server
- [create]

Menu -> Vpc network -> firewall rules
[Create firewall rule]
Name: pavlov server
Target Tags: pavlov-server
Source IP Ranges: 0.0.0.0/0
Protocols and Ports -> Specified protocols and ports -> UDP: 7777, 8177 (Shack and PC)
Protocols and Ports -> Specified protocols and ports -> TCP: 7777, 8177 (Shack-only)
Protocols and Ports -> Specified protocols and ports -> TCP: {RCON port - default 9100}
[save]
</pre>

===== Amazon Web Services (30 day free credit available) =====

<pre>
Login -> Change Region: Choose your region
Services -> Compute -> EC2 -> Create
Choose an AMI: Ubuntu 18.04
Instance Type: z1d.large

Instance Details -> Tenancy: Dedicated (optional: this will more than triple the cost)

Storage: 50gb disk (or whatever, you're in control of the map roster)

Security Groups:
Create a new Security Group
Security group name: pavlov-server
Description: pavlov server
Rules:
Type: Custom ICMP Rule - IPV4 / Protocol: Echo Request
Type: Custom UDP Rule / Port Range: 7777 / Source: 0.0.0.0/0
Type: Custom UDP Rule / Port Range: 8177 / Source: 0.0.0.0/0
Type: SSH (optional, but I assume you wanna SSH in..)

Launch -> Create new Keypair -> Download -> Launch

Once it's started, SSH in like:
$ ssh -i your-key.pem ubuntu@you-server-details.amazonaws.com

(I use cmder on Windows, if you're using putty or mobaxterm or something, might be different)
</pre>

=== Starting Server Install ===

====Obtaining an ApiKey====
For your server to show up in the server list, there is now a requirement to have an ApiKey issued by vankrupt. This is to prevent DOS attacks against the master server

Get the key by going here: https://pavlov-ms.vankrupt.com/servers/v1/key and using your mobile number to get a SMS
(note that there have been reported failures of this SMS system for non-US mobiles. In this case DM davevillz your mobile and ask for a key)

Put this key in your Game.ini as follows:
ApiKey="ABC123FALSEKEYDONTUSEME"
or if you would like (personally untested..I would use game.ini) you can call it at server runtime with flag as follows:
-KEY="ABC123FALSEKEYDONTUSEME"

This key can be re-used for a reasonable number of servers (a limit of 10 has been mentioned). Contact the Devs if you need more servers per key.

====System setup and software installation====

Install dependencies and create the `steam` user. (You only need to do this once):

Confirm Linux version
<pre>
lsb_release -a
</pre>

'''Ubuntu 20.04'''
<pre>
sudo apt update && sudo apt install -y gdb curl lib32gcc1 libc++-dev unzip
sudo useradd -m steam
</pre>

'''Ubuntu 20.10 or higher'''
<pre>
sudo apt update && sudo apt install -y gdb curl lib32gcc-s1 libc++-dev unzip
sudo useradd -m steam
</pre>

'''Rocky Linux, CentOS 8, and RHEL 8'''

<pre>
sudo sed -i 's/^SELINUX=enforcing$/SELINUX=permissive/g' /etc/selinux/config
sudo setenforce 0
sudo yum install gdb curl glibc.i686 libstdc++.i686 libstdc++-devel.i686 libstdc++-devel.x86_64 unzip wget -y
wget https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/l/libcxx-3.8.0-3.el7.x86_64.rpm
sudo rpm -i libcxx-3.8.0-3.el7.x86_64.rpm
sudo useradd -m steam
</pre>

[Optional] Set a password for steam.
<pre>sudo passwd steam</pre>

Login as the steam user. ('''You will need to do this each time you connect to your server'''):

<pre>
sudo su -l steam
</pre>

Install Steam:

<pre>
mkdir ~/Steam && cd ~/Steam && curl -sqL "https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz" | tar zxvf -
</pre>

There are different dedicated server versions for Pavlov Server - choose which server version you want to host (PC non-beta, PC Beta, Shack Live, or Shack RC)
(You will need to run this command each time there is a Pavlov Server update). 
To host '''PC Server (non-beta)''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 +exit
</pre>

To host '''PC BETA''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta beta_server +exit
</pre>

To host '''Shack Live''' (Quest):

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack +exit
</pre>

To host '''Shack RC''' (Quest): 

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack_beta +exit
</pre>

Now that we've installed the server, all pavlov server versions should continue. 
Install a fresh copy of steamclient.so (May have to do this after each update):
<pre>
~/Steam/steamcmd.sh +login anonymous +app_update 1007 +quit
mkdir -p ~/.steam/sdk64
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/pavlovserver/Pavlov/Binaries/Linux/steamclient.so
</pre>

Make the PavlovServer script executable. (You only need to do this once):

<pre>
chmod +x ~/pavlovserver/PavlovServer.sh
</pre>

----

=== Server Configuration ===

Before starting the server we need to configure it. Start by creating some directories:

<pre>
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Logs
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps
</pre>

==== Mods/Blacklist/Whitelist (optional) ====

The following three files allow you to specify mods, banned players, and whitelist players. These are optional, but go ahead and create them. Populating the files is described later.

<pre>
touch /home/steam/pavlovserver/Pavlov/Saved/Config/mods.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/blacklist.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/whitelist.txt
</pre>

====Configuring Game.ini====
Create a new Game.ini file using following command to open an editor and copy/paste the following block into it then save it. Note not all of these options are required. For instance remove or comment out the Password=0000 line to make a public server with no pin.
<pre>
nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini
</pre>

<pre>
[/Script/Pavlov.DedicatedServer]
bEnabled=true
ServerName="My_private_idaho"
MaxPlayers=10 #Set this to 10 for Shack. 24 is the max for PC, setting it higher will not allow players to join.
ApiKey="ABC123FALSEKEYDONTUSEME"
bSecured=true
bCustomServer=true
bVerboseLogging=false
bCompetitive=false #This only works for SND
bWhitelist=false
RefreshListTime=120
LimitedAmmoType=0
TickRate=90
TimeLimit=60
#Password=0000
#BalanceTableURL="vankruptgames/BalancingTable/main"
MapRotation=(MapId="UGC1758245796", GameMode="GUN")
MapRotation=(MapId="datacenter", GameMode="SND")
MapRotation=(MapId="sand", GameMode="DM")

</pre>

* '''bEnabled''' - whether the server appears in the server list (unconfirmed)
* '''ServerName''' - name it will be listed as. (approx 35 chars max)
* '''MaxPlayers''' - See suggested specs for limits. 10 standard (10 for shack), 20-24 is max recommended for large maps like Stalingrad or PUSH/RUSH modes, and servers allow a maximum of 24 players.
* '''ApiKey''' - Unique ApiKey required to register server with master server. Replace with your key
* '''bSecured''' - enabled Valve Anti-Cheat (VAC)
* '''bCustomServer''' - activates some new modding tools (save and http functions. Required to write to blacklist.txt for bans)
* '''bCompetitive''' - sets the server to competitive mode for SND. If removed the server will default to false
* '''bVerboseLogging''' - enables verbose logging, mostly detailed statistics. Be prepared for significant increase in logging.
* '''bWhitelist''' - Only allow users in whitelist.txt to join
* '''RefreshListTime''' - sets how often the running server checks for updates in ban/whitelist/mod files
* '''LimitedAmmoType''' - sets limited ammo mode
0 = Unlimited
1 = Limited Generic
2 = Limited Specific
3 = Custom (for modders)
4 = Limited Special
5 = Boxless Mode

* '''TimeLimit''' - sets time limit for each map
* '''TickRate''' - sets the server tickrate. (so far minimum stable seems around 50 and max around 120. Beware setting this changes weapon despawn time and breaks some game modes. Recommend not touching)
* '''Password''' - PIN number for server #FYI - this is now also changeable via rcon.
* '''BalanceTableURL''' - Points to a custom balance table from github. See https://github.com/vankruptgames/BalancingTable for instructions. This line isn't needed if you don't have one.
* '''MapRotation''' - you can add multiple of these. The MapId must be “UGC” followed by the map ID. you can find the map id in the URL of the steam workshop page. When a match ends, the server will load the next map in the rotation. You can also use RCON to switch to a map not included in rotation.

Available game modes as of 09/06/2022: SND, TDM, DM, GUN, ZWV, WW2GUN, TANKTDM, KOTH, TTT, OITC, INFECTION, HIDE, PUSH, PH 

And for Shack only: CTF

For maps running a Custom gamemode (CodZ, BR, Duel, etc.) it doesn't matter which gamemode you choose, as the map will automatically override it with the custom mode.

UGC###### are for custom maps from Steam workshop (PC Only). Find the map you want in the workshop. This is the URL for Mirage (https://steamcommunity.com/sharedfiles/filedetails/?id=2670152485). The 10 numbers at the end of the URL are what you need, so UGC1661803933 would be the MapId for Mirage.

==== Firewall/Port forwarding ====
Using the default settings there are two UDP ports (7777, 8177) that need to be allowed to access the server either by firewall setup or port forwarding.

'''Ubuntu''' firewall commands to check firewall and open ports:
<pre>
sudo ufw status
sudo ufw allow 7777
sudo ufw allow 8177
sudo ufw allow 9100
sudo ufw status
</pre>

'''Rocky Linux''' firewall commands to check firewall and open ports:
<pre>
sudo firewall-cmd --zone=public --add-port=7777/tcp
sudo firewall-cmd --zone=public --add-port=7777/udp
sudo firewall-cmd --zone=public --add-port=8177/tcp
sudo firewall-cmd --zone=public --add-port=8177/udp
sudo firewall-cmd --zone=public --add-port=9100/udp
sudo firewall-cmd --zone=public --add-port=9100/tcp
sudo firewall-cmd --list-ports
firewall-cmd --runtime-to-permanent
</pre>

You may also need to allow Pings (ICMP) for the server's true latency to appear in the master list.

If you are running multiple servers and have set additional ports (see http://wiki.pavlov-vr.com/index.php?title=Dedicated_server#Running_multiple_servers_on_one_host) then you need to allow access to the defined port plus the port 400 higher. So if you use 7000 as your port, then UDP 7000 and 7400 need to be open

If you have setup rcon via RconSettings.txt (below) then that port also need to be allowed access via TCP

If you are running Shack/Quest and want to have maps that are downloadable from your server, your server ports (ex. 7777 & 8177) must also be open via TCP

----

==== Shack Maps (Quest) ====

If you try to use the steps above to add maps for Shack, youll run into issues very quickly. This is because Shack has no affiliation to Steam, and therefore cannot use Steam Workshop maps like above. In the future, these steps will apply to PC servers as well, allowing a server to hold the map itself, instead of offloading to Steam.

To get started, first create the directory to hold the maps

<pre>mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps</pre>

You can use any number of methods to move the map files onto the server, but ill go over the two simplest, starting with a GUI approach

Download and install CyberDuck onto your "home" PC (Whatever PC you use for access to the server, but not the server itsself): https://cyberduck.io/

Next, download and unzip your map of choice from https://www.pavlovquest.com/ , https://pavlovhorde.com/mapsList, or look in #shack-map-showcase channel in the discord server. I'm going to use Cheeto's WW2 Items test (http://www.mediafire.com/file/emyt9bs1z9u9ykw/SVR_Cheeto_Items.zip/file ) for this example, you do what you like

In the top left corner, open a connection, set the connection type to SFTP, and fill in the rest of the information. User will be root, password is whatever you set the root pw as (toor in Ubuntu by default)

In the directory dropdown (itll say /root) go back to /

Follow the directories until we arrive back at our "maps" folder <pre>/home/steam/pavlovserver/Pavlov/Saved/maps</pre>

Drag and drop the unzipped map folder into the main window, in this case itll be SVR_Cheeto_Items

Hit Allow

Youll now see a folder named SVR_Cheeto_Items, and within it should be nothing but 3 files. If there is another folder in it, move this folder to the maps directory, otherwise the server wont work. The 3 files (2 .PAK one .JSON) should be in home/steam/pavlovserver/Pavlov/Saved/maps/SVR_Cheeto_Items, no more, no less.

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

To play the map, you can either use RCON switch map command, or to add the map to your servers automatic map rotation list, add the map's folder name to your Game.ini. This replaces the MapID section, so for our example it would be

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

And thats all! Disconnect CyberDuck from your server before playing, otherwise youll have difficulty joining.

-----------

==== Adding Shack Maps over Command Line Interface ====

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

A bit more complicated, but adding maps over CLI has its benefits

First, CD to the maps directory you made above

<pre>cd ~/pavlovserver/Pavlov/Saved/maps</pre>

Download the map files from whatever you use to upload them. To do this, you can either use curl or wget

<pre>curl -O insertURLhere</pre>

'''If you download your map from Google Drive''', make sure that your .zip folder is shared to anyone.
Then, get the file's url from the shared link. Example : ''<nowiki>https://drive.google.com/file/d/19bI8gUHaN5tUrDvnadAacUnchQf6_k/view</nowiki>'' will be ''19bI8gUHaN5tUrDvnadAacUnchQf6_k''
Edit "fileId" and "fileName" before you execute the command.
<pre>
fileId=19bI8gUHaN5tUrDvnadAacUnchQf6_k
fileName=SVR_USER_MAPNAME
curl -sc /tmp/cookie "https://drive.google.com/uc?export=download&id=${fileId}" > /dev/null
code="$(awk '/_warning_/ {print $NF}' /tmp/cookie)"
curl -Lb /tmp/cookie "https://drive.google.com/uc?export=download&confirm=${code}&id=${fileId}" -o ${fileName} </pre>

To keep with the Items example:

<pre>curl -O https://cdn.discordapp.com/attachments/744185280759857234/745027406695366788/SVR_Cheeto_Items.zip</pre>

Next, unzip the file. If this next step errors out, saying the command is unknown, switch back to the root user (su root), and install unzip (sudo apt install unzip), then return to the steam user, and continue.

<pre>unzip SVR_Cheeto_Items.zip</pre>

Now finish like before by adding the map to your Game.ini

<pre>nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini</pre>

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

==== Admin/Moderator list (optional) ====

The only working in-game admin menu is through Arctic VR server hosting (see below).

If you add moderators to your server, they will not be subject to vote kicks.

<pre>
nano ~/pavlovserver/Pavlov/Saved/Config/mods.txt
</pre>

Example Mod List:
<pre>
76541198397498572 #Optional Comment: Player name
76541198397498573 #Some Other Player
</pre>

==== ArcticVR Admin Menu ====

[[File:Arcticmenu.jpg|500px|link=https://www.arctic-vr.com/server-admin-menu]]

Arctic-VR Offers an advanced In-Game Admin menu that is exclusive to their hosting service. Features include:
* Switch Maps+Modes
* Teleport Players to Players
* Change Player Skins
* Control Player Buying+Cash
* Spawn Items
* Clean up corpses + guns
* Spawn Bots
* Spawn Items for other players
* Control Teams + Balance/Shuffle Teams
* ResetSND
* And More

You can read more about the ArcticVR admin menu on their website: https://www.arctic-vr.com/server-admin-menu

==== Handy tools for finding steamIDs ====

Steam ID finder: https://steamidfinder.com/lookup/ or https://steamid.xyz/

You want to enter in the steamID64 format.

This tool can convert or lookup IDs: https://steamid.io/

If you are looking for a steamID of a player that has been on your server recently this is technique to find them:
<pre>
grep -i playername ~/pavlovserver/Pavlov/Saved/Logs/* | grep TicketValidation
</pre>

=== Configure Rcon ===
To enable Rcon access create config file:
<pre> nano /home/steam/pavlovserver/Pavlov/Saved/Config/RconSettings.txt </pre>

Copy in the following text - change password, and if desired the port:
<pre>
Password=ChangeThisPassword
Port=9100
</pre>
You must specify a port for the Rcon server to use as well as a Password (use a different port per sever instance if running multiple server instances off the same hardware)

=== Starting the server ===

<pre>
cd ~/pavlovserver && ./PavlovServer.sh
</pre>

That's it, your server will be automatically broadcast to the master server! :)

Two handy tools to determine quickly if your server is broadcasting are [https://pablub.xyz/ Pablub] (PC only) and [https://pavlovhorde.com/ Horde] (Shack) and [https://pavlovhorde.com/pcServers Horde] (PC version)

Note that when you close your terminal, the server will go down. See the "supervisors" section below for how to prevent this.

=== Auto-updating the server ===

Assuming you have followed this guide and used the default paths, users, and install instructions, you can paste the following into your terminal to auto-update your Pavlov server:

<pre>
cat << 'EOF' > $HOME/pavlov_daily_update_and_restart.sh
#!/bin/bash

USER="steam"
SERVICENAME="pavlovserver.service"
INSTALLDIRNAME="pavlovserver"
USERHOME="/home/$USER"

echo -e "Beginning Pavlov VR update run on $(date)\n\n"

systemctl stop "$SERVICENAME"

sleep 5
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +force_install_dir "$USERHOME/$INSTALLDIRNAME" +app_update 622970 +exit
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +app_update 1007 +quit
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/.steam/sdk64/steamclient.so"
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/pavlovserver/Pavlov/Binaries/Linux/steamclient.so"

systemctl start "$SERVICENAME"

echo -e "Ending Pavlov VR update run on $(date)\n\n"

EOF

chmod +x $HOME/pavlov_daily_update_and_restart.sh
mkdir $HOME/pavlov_update_logs && touch $HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log
CRONLINE="00 2 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
(sudo crontab -u root -l; echo "$CRONLINE" ) | sudo crontab -u root -
unset CRONLINE

</pre>

These commands will:

1. Create a shell script in the "steam" user's home directory that automatically stops the Pavlov server, pulls any updates via steam, pull updates to the Steamworks SDK Redist, and copies the latest version of steamclient.so to the Pavlov server directory

2. Make the shell script executable

3. Create a new directory called "pavlov_update_logs" in the "steam" user's directory, and create a logfile inside that directory called "pavlov_daily_update_and_restart.sh.log". You can check this logfile to see the output of the Pavlov and Steam SDK update commands.

4. Create a crontab entry for the root user that runs this shell script automatically every day at 2:00AM local time

If you want to change the time that this script runs, edit the numbers "00 2" in the line that starts with "CRONLINE=". In the example provided, 00 is the minutes column, and 2 is the hour column. For example, if you wanted the server to automatically update and restart at 4:17AM every day, change the line starting with "CRONLINE=" to:

<pre>
CRONLINE="17 4 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
</pre>

If the time is PM, use 24-hour time format, e.g. "32 18" for 6:32PM.

----

=== Supervising the server using systemd ===

Running '''./PavlovServer.sh''' in your interactive shell is easy, but the server will shut down when you close your terminal. If you want to run the server in the background,
you'll want to run it under a supervisor. There are many options, ranging from the simple (nohup, screen or tmux), to the
more robust (supervisord, systemd).

Systemd is running by default on Ubuntu Linux, so we'll use that here.

To run the server as a systemd service, create the file '''/etc/systemd/system/pavlovserver.service''' (as root) by typing
<pre>
sudo nano /etc/systemd/system/pavlovserver.service
</pre>

Copy contents below into the file and save.

<pre>
[Unit]
Description=Pavlov VR dedicated server

[Service]
Type=simple
WorkingDirectory=/home/steam/pavlovserver
ExecStart=/home/steam/pavlovserver/PavlovServer.sh

RestartSec=1
Restart=always
User=steam
Group=steam

[Install]
WantedBy = multi-user.target
</pre>

If you'd like your server to start as competitive without editing the game.ini, change the line "ExecStart=/home/steam/pavlovserver/PavlovServer.sh" to look like this below. Though it's much easier to just use the game.ini to enable competitive instead. <pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -COMPETITIVE=1</pre>

Change the user or paths as appropriate. After saving the service file, to start, restart, stop, or monitor the server:

<pre>
sudo systemctl start pavlovserver
sudo systemctl restart pavlovserver
sudo systemctl stop pavlovserver
sudo systemctl status pavlovserver
</pre>

To view the logs:

<pre>
sudo journalctl -u pavlovserver
# to live-tail the logs
sudo journalctl -u pavlovserver -f
</pre>

If you want to run the pavlov server as soon as your server boots (e.g. a VPS you turn on and off), add pavlov as a startup service:

<pre>
sudo systemctl enable pavlovserver
</pre>

----

== Advanced Server Administration ==

=== Running multiple servers on one host ===

* Pavlovserver is functionally single threaded (there are multiple threads, but vast majority of work occurs in the primary one). Make sure you have # of pavlovservers + 1 CPU available. More CPUs= more servers. Faster CPU = more players.
* Make multiple server installs by defining a separate install dir for each server.
* Run each server with a unique port. eg: '''./PavlovServer.sh -PORT="Desired Port"'''
* The Server will use the Desired Port and the Port 400 above (Example: You choose 8200 as Port. So Port 8600 will be used as well)
* If you are using RCON, each server will need a unique port defined in RconSettings.txt
* Ensure the ports are forwarded and opened in your firewall

To duplicate directories:

be in the steam home folder
<pre>
cp -r pavlovserver pavlovserver1
/home/steam/pavlovserver1/PavlovServer.sh -PORT=[Desired Port]
</pre>

=== Starting server in competitive mode ===
Competitive mode will prevent dead teammates from being able to see the match, to prevent ghosting.
You can either enable this via Game.ini (described in Game.ini file), or using the -COMPETITIVE=1 parameter.

<pre>
/home/steam/pavlovserver1/PavlovServer.sh -COMPETITIVE=1
</pre>

== Automated RCON examples ==
here are some examples of scripts that interact with Pavlov RCON

=== <big>Inspect players every 5 minutes</big> [https://github.com/JTWP-org/inspect-every-5-mins (INSTALL FROM GIT )] ===
This [https://www.gnu.org/software/bash/ BASH] script connects to the server u set in the config with [https://netcat.sourceforge.net/ NETCAT] 2 times every 5 min and it uses RCON commands [[Rcon Overview and Commands|RefreshList ServerInfo]] &.<code>[[InspectPlayer 76|InspectPlayer]] {UniqueID} to build stats for the current round stats are then appended over the last one collected</code>

as for the 5 min timer we use a [https://linux.die.net/man/5/crontab crontask]

{| class="wikitable"

|}

=== <big>pending reset</big> ''(COMING SOON'') ===
----

===Useful Linux Commands===

List files / folders in directory, print current working directory,
<pre>ls -la #list files/directories along with authorities and ownership
pwd #print working directory
sudo chown <owner> <file/directory> #change owner of file/directory. If root created something and you need to change it to steam
sudo chgrp <group> <file/directory> #change group of file/directory.
</pre>

Check if pavlov is running by checking process status. If the only row you see is the grep command, pavlov server is not started.
<pre> ps -ef | grep pav </pre>

Sample output:
<pre>
steam 34044 1 0 16:52 ? 00:00:00 /bin/sh /home/steam/pavlovserver/PavlovServer.sh
steam 34066 34044 80 16:52 ? 00:00:04 /home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer
zombies+ 34101 34013 0 16:52 pts/0 00:00:00 grep --color=auto pav
</pre>

Kill a process. Note this command uses 34044, which is a process id from the command output above.
<pre> kill -9 34044 </pre>

Dump the log to the console so you can scroll through it:
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log </pre>

Search the log for a string - replace my_string with case-sensitive string
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep my_string </pre>

===Default Map ID's===
datacenter

sand

bridge

containeryard

siberia (Prison Break)

hospital (Zombies map)

killhouse

range

tutorial

santorini

station

industry

ogcontainers (Shack only)

haguenau (Shack only)

foundation (Shack only)

stalingrad (PC only)

stalingrad_night (PC only)

santorini_night (PC only)

sand_night (PC only)

station_night (PC only)

industry_night (PC only)

bunker (PC only)

===Automated server log backup ===

here is how to setup a bash script to 1x a day compress all log files and save them to protect from auto deletion it will also post a discord webhook to confirm its working and saved the days logs

https://github.com/JTWP-org/backUpLogs

==Troubleshooting==

To run the server without outputting the heartbeat:

<pre>./PavlovServer.sh | sed '/heartbeat/d'</pre>

To monitor the logs (without heartbeat) from another terminal:

<pre>tail -f -n10000 /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep -v 'Sending heartbeat to masterserver'</pre>

Check your CPU Clock Speed with:

<pre>lscpu | grep MHz</pre>

=== Server won't start ===

Error message:
<pre>
ln: failed to create hard link '/home/steam/.steam/sdk64/steamclient.so': File exists
ln: failed to create hard link '/home/steam/pavlovserver/Pavlov/Binaries/Linux/steamclient.so': File exists
/home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer: error while loading shared libraries: libc++.so.1: cannot open shared object file: No such file or directory
</pre>

First two errors are harmless. The third one is because libc++ step was skipped or failed. Using sudo capable id (probably not steam id), [re]run this line:
<pre>sudo apt update && sudo apt install -y gdb curl lib32gcc1 libc++-dev unzip </pre>

=== Map wont load (kicks to datacenter)===

try deleting all the downloaded workshop maps with:

<pre>sudo rm -rf /tmp/workshop/7777/content/555160/*</pre> for all maps or

<pre>sudo rm -rf /tmp/workshop/7777/content/555160/whatever-UGC</pre> for specific map

===Map wont load when running in a container===
The three typical container problems I have seen:

1) Steam can't write to /tmp for some reason

2) /tmp is actually tmpfs instead of real filesystem and a few gigs of maps runs you out of RAM

3) Made worse by fact that pavlovserver unpacks downloads to ram, then writes to /tmp/workshop. Not enough RAM to do this, no map for you.

===Server stuck rotating forever===

Run these 2 commands, then restart your server:

<pre>cd ~/Steam && ./steamcmd.sh +login anonymous +app_update 1007 +quit
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so</pre>

If this doesn't fix it, double check that your server isn't running on the same port as another, by running this command:

<pre>ps -ef | grep pav</pre>

Then if 2 servers are on the same port, you can fix it by editing the pavlovserver.service file, and making sure the following line:

<pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -PORT=Number</pre>

has a unique number after the port for each server you're running.

=== Server - ping 999===
Google Cloud Platform - Make sure your compute engine has a network tag and your network rules are applied to the tag.
Make sure you opened the specified ports.

Network testing tools:
Test if your server will respond to ping from outside your network:
https://www.wormly.com/test-remote-ping

Test if your ports are accessible via UDP (7777,8177,9100):
https://www.ipvoid.com/udp-port-scan/

===Can't connect to RCON===
Check the file and group owner of RconSettings file. It should be steam, or the ID used to run the pavlov server.
<pre>
cd /home/steam/pavlovserver/Pavlov/Saved/Config
ls -la
</pre>

If the owner/group are not steam, using root or an id with sudo authority, change them to steam, confirm they are now set properly, then restart the pavlov server. (Note - if Rcon has wrong permissions, after fixing you should also to check the other config files like Game.ini, mods/blacklist/whitelist for the same issue. If steam can't access these files, it could cause problems.).
<pre>
cd /home/steam/pavlovserver/Pavlov/Saved/Config
sudo chown steam RconSettings.txt
sudo chgrp steam RconSettings.txt
ls -la </pre>

===PC ONLY - Map Download stops===

When downloading a large map from the steam workshop make sure your VPS/Dedi or Shared hosting provider (Otherwise known as a GSP's) has enough RAM assigned to store the map files in its tempfs (stored in ram)!

This is less likely to happen on Dedicated servers and VPS with a decent amount of ram unless you are using docker with RAM limits!

Most GSP's will be using docker or some other type of jailing method to limit system resource allocations and direct access to the host machine, if they are and you know what map you want to use make sure you order a service with enough ram to store your map. If in doubt contact your GSP's support team.

===Getting Help===

There's a #pc-custom-servers channel on the official Pavlov Discord - https://discord.gg/Pavlov-VR. Lots of helpful people there!
[[Category:RCON automation]]

Setting up a dedicated server

2023-06-13T04:48:47Z

SaltedCrackerJack: /* System setup and software installation */

== Setting up a dedicated server ==

'''There are no Windows binaries'''

This guide is written exclusively for Linux and covers Ubuntu/Debian/Debian-like and Red Hat RPM-based distros. Possible to run with other distros, but some of the commands won't work and you will need to know enough to figure out the software install of dependencies on your own.

If you are considering hosting from home, please read that section of the wiki first.

This guide assumes you know the basics of using a bash terminal: ssh'ing into a server, running bash commands, editing text files, etc.

If you have no experience using bash, maybe start [https://www.howtogeek.com/140679/beginner-geek-how-to-start-using-the-linux-terminal/ here]. Editing text files via commandline is often a challenge. Suggest using nano and reading guide [https://www.howtogeek.com/howto/42980/the-beginners-guide-to-nano-the-linux-command-line-text-editor/ here]

If you are new to linux and accessing your server from Windows, highly suggest using MobaXterm as your SSH client as that can make required editing of text files easier using built in editor instead of the native linux command line editors.

And finally, ask yourself why you want to setup a server? If you look at the list, there are many, many more servers than players. If you don't have a team, discord community, or group of friends ready to play on your server, chances are it will go unused. Got one of these... great, let's go.

If you don't want to go through the hassle yourself and want to pay for a hosting service Arctic VR (PC and Shack) and Horde (Shack) provide a server hosting services and are trusted in the community. See links below.

----

=== Server Requirements ===

'''Pavlovserver can only be hosted under Linux.'''

This can be running as a VM under windows, but this will increase the complexity of the setup beyond this guide.

Ubuntu 18.04 x86_64, Ubuntu 19/04 amd64, Ubuntu 20.04, and Rocky Linux 8 are confirmed working. Ubuntu 15.04 x86 is known to fail to install using this guide. Recommend not running on "minimal" images as some tools are missing.

* 2GB RAM + 1GB RAM per each additional server with 10 players. More RAM is recommended for larger maps, higher player counts, or complex gamemodes. Not having enough RAM is a common cause of server crashes.

* A ~2.5Ghz CPU will comfortably support a 10 player server.

* A ~4Ghz CPU will comfortably support 24 players. This is a limit built into Pavlov itself, no server will allow players to join over 24. Lower player counts are recommended for complex gamemodes (E.g. CodZ) and/or highly detailed maps, so that maximum number will often be lower.

(Note that these are '''not''' hard limits for player counts, just suggestions for the best performance, based on experiences with many server providers on different grades of hardware.)

* Pavlovserver is functionally single threaded (one thread does vast majority of work). More CPUs only help if you are running more servers. More clockspeed = higher performance = more users per server.
The maximum number of servers you can run is dependent on how many CPUs you have. For example, if you have an 8 core CPU, the maximum number of servers would be 7. You should always have at least one CPU free as overhead, as Pavlov servers can use slightly more than one thread.

----

==== Hosting at home ====
When hosting at home there are additional requirements regarding networking: Your router has to support port-forwarding, hair-pinning/LoopbackNAT, and respond to ping requests. These techniques are necessary to allow your server to be found and to talk back to the client. please see https://en.wikipedia.org/wiki/Port_forwarding, https://en.wikipedia.org/wiki/Hairpinning, and https://www.speedguide.net/faq/how-to-become-pingable-behind-a-routerfirewall-376 for more info and google for these terms in addition to your router model to find guides on how to enable/configure it properly. If you have modern Router, it may have these features already enabled, in this case you just have to configure port-forwarding. If you can see your server but not join it while others can, this is indicative of a failure of LoopbackNAT.

A second challenge to hosting at home is CGNAT (Carrier grade NAT: https://www.a10networks.com/blog/carrier-grade-nat/). Just like NAT on your home network that has to be gotten around w/ port-forwarding, CGNAT breaks the ability of external connections to be made back to your server, but the controls are solely in your ISPs hands. Sometimes if you ask, you can be removed from CGNAT pools and/or assigned a static IP. CGNAT rollouts are becoming very common now, so if your server worked then doesn't allow connections now, your ISP may have made this change.

You can check whether you’re on a CGNAT network by visiting a Web site such as ipaddress.com or whatsmyip.com and comparing the IP address listed to the public/WAN IP address assigned to your Internet gateway. To find your gateway’s public IP address, check the status page in the administrative interface. If the two IP addresses differ, you’re likely on a CGNAT network. If so, this problem must be resolved before you go any further.

'''Not understanding these requirements and configuration is a frequent cause of failed setups and questions in discord. Don't skip this if you are trying to host from home'''

'''There are serious security implications of hosting this software at home.''' None of the devs are security experts and there has been no security review of the code. You are opening up your system to the world and publicity advertising this fact. Expect that any system hosting this software is open to compromise from the Internet and act accordingly. If your router offers a DMZ network, use it. Consider hosting on a cloud based server and think twice before running this software on any system that contains data you care about or has access to networks and computers you care about.

If you're hosting at home using Oracle's VirtualBox, there are steps you can take to prevent double NAT (which can cause issues later on)

1. Select your VM and then click Settings in VirtualBox's main window.

2. Click on Network and change Attached To from NAT to Bridged Adapter.

Once you've done this, your VM should be connected directly to your home router and double NAT should no longer be a issue.
----

==== Hosting Providers ====

Considering the suggested server specs, you may be interested in the following hosting providers. For providers promising dedicated "Pavlov hosting" as opposed to general VPS services please contact and ask how you change maps being hosted and how you get RCON access before you put your money down.

<pre>
Provider | Base CPU | Details
Arctic VR | 4.5 GHz | https://www.arctic-vr.com/server-hosting
Amazon Web Services | 4.0 GHz | https://aws.amazon.com/ec2/instance-types/z1d/
VULTR | 4.0 GHz | https://www.vultr.com/products/high-frequency-compute/
packet.com | 3.5 GHz | https://www.packet.com/cloud/servers/c1-small/
Google Cloud Platform | 3.2 GHz | https://cloud.google.com/compute/docs/cpu-platforms
</pre>

===== ARCTIC VR =====

Arctic VR is the largest and longest running Pavlov VR hosting provider. The In-Game Admin Menu is exclusive to the ArcticVR hosting service. They offer EU, NA East and NA West servers for both shack and PCVR. ArcticVR offers the fastest Pavlov servers as well as DDos Protection, RCON remote management, custom maps, low pings, unlimited slots, and expert support.

Website: https://www.arctic-vr.com/server-hosting

[[File:Arctic_options.png|link=https://www.arctic-vr.com/server-hosting|700px]]

===== VULTR =====

Consider using a referral from the community:

Carlos: https://www.vultr.com/?ref=8615589-6G

Carrot: https://www.vultr.com/?ref=8689348

Archaeo: https://www.vultr.com/?ref=8653652-6G

Cheeto: https://www.vultr.com/?ref=8717358

For a Pavlov Shack server, I recommend minimum Cloud Compute, Intel High Performance, Ubuntu 20.04, and disabled automatic backups. At the time, this was $6/m. Some of the cheap options have 1TB bandwidth, and some have 2TB+. If it's a personal server, 1TB could be fine, but 2TB should be safe.

===== Google Cloud Platform (90 day free credit available) =====

The below configuration is successfully running 4 pavlov PC instances with ~15 total maps and up to 24 players per server. If you want more maps use larger boot disk. Both can dynamically be scaled based on popularity.

<pre>

Menu -> compute engine -> VM instances
create instance
- region: wherever you like
- machine type: n1-highcpu-4 (4 vCPUs, 3.6 GB memory)
- boot disk: Ubuntu 20.04
- boot disk -> size: 25gb
- network tags: pavlov-server
- [create]

Menu -> Vpc network -> firewall rules
[Create firewall rule]
Name: pavlov server
Target Tags: pavlov-server
Source IP Ranges: 0.0.0.0/0
Protocols and Ports -> Specified protocols and ports -> UDP: 7777, 8177 (Shack and PC)
Protocols and Ports -> Specified protocols and ports -> TCP: 7777, 8177 (Shack-only)
Protocols and Ports -> Specified protocols and ports -> TCP: {RCON port - default 9100}
[save]
</pre>

===== Amazon Web Services (30 day free credit available) =====

<pre>
Login -> Change Region: Choose your region
Services -> Compute -> EC2 -> Create
Choose an AMI: Ubuntu 18.04
Instance Type: z1d.large

Instance Details -> Tenancy: Dedicated (optional: this will more than triple the cost)

Storage: 50gb disk (or whatever, you're in control of the map roster)

Security Groups:
Create a new Security Group
Security group name: pavlov-server
Description: pavlov server
Rules:
Type: Custom ICMP Rule - IPV4 / Protocol: Echo Request
Type: Custom UDP Rule / Port Range: 7777 / Source: 0.0.0.0/0
Type: Custom UDP Rule / Port Range: 8177 / Source: 0.0.0.0/0
Type: SSH (optional, but I assume you wanna SSH in..)

Launch -> Create new Keypair -> Download -> Launch

Once it's started, SSH in like:
$ ssh -i your-key.pem ubuntu@you-server-details.amazonaws.com

(I use cmder on Windows, if you're using putty or mobaxterm or something, might be different)
</pre>

=== Starting Server Install ===

====Obtaining an ApiKey====
For your server to show up in the server list, there is now a requirement to have an ApiKey issued by vankrupt. This is to prevent DOS attacks against the master server

Get the key by going here: https://pavlov-ms.vankrupt.com/servers/v1/key and using your mobile number to get a SMS
(note that there have been reported failures of this SMS system for non-US mobiles. In this case DM davevillz your mobile and ask for a key)

Put this key in your Game.ini as follows:
ApiKey="ABC123FALSEKEYDONTUSEME"
or if you would like (personally untested..I would use game.ini) you can call it at server runtime with flag as follows:
-KEY="ABC123FALSEKEYDONTUSEME"

This key can be re-used for a reasonable number of servers (a limit of 10 has been mentioned). Contact the Devs if you need more servers per key.

====System setup and software installation====

Install dependencies and create the `steam` user. (You only need to do this once):

Confirm Linux version
<pre>
lsb_release -a
</pre>

'''Ubuntu 20.04'''
<pre>
sudo apt update && sudo apt install -y gdb curl lib32gcc-s1 libc++-dev unzip
sudo useradd -m steam
</pre>

'''Ubuntu 20.10 or higher'''
<pre>
sudo apt update && sudo apt install -y gdb curl lib32gcc-s1 libc++-dev unzip
sudo useradd -m steam
</pre>

'''Rocky Linux, CentOS 8, and RHEL 8'''

<pre>
sudo sed -i 's/^SELINUX=enforcing$/SELINUX=permissive/g' /etc/selinux/config
sudo setenforce 0
sudo yum install gdb curl glibc.i686 libstdc++.i686 libstdc++-devel.i686 libstdc++-devel.x86_64 unzip wget -y
wget https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/l/libcxx-3.8.0-3.el7.x86_64.rpm
sudo rpm -i libcxx-3.8.0-3.el7.x86_64.rpm
sudo useradd -m steam
</pre>

[Optional] Set a password for steam.
<pre>sudo passwd steam</pre>

Login as the steam user. ('''You will need to do this each time you connect to your server'''):

<pre>
sudo su -l steam
</pre>

Install Steam:

<pre>
mkdir ~/Steam && cd ~/Steam && curl -sqL "https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz" | tar zxvf -
</pre>

There are different dedicated server versions for Pavlov Server - choose which server version you want to host (PC non-beta, PC Beta, Shack Live, or Shack RC)
(You will need to run this command each time there is a Pavlov Server update). 
To host '''PC Server (non-beta)''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 +exit
</pre>

To host '''PC BETA''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta beta_server +exit
</pre>

To host '''Shack Live''' (Quest):

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack +exit
</pre>

To host '''Shack RC''' (Quest): 

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack_beta +exit
</pre>

Now that we've installed the server, all pavlov server versions should continue. 
Install a fresh copy of steamclient.so (May have to do this after each update):
<pre>
~/Steam/steamcmd.sh +login anonymous +app_update 1007 +quit
mkdir -p ~/.steam/sdk64
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/pavlovserver/Pavlov/Binaries/Linux/steamclient.so
</pre>

Make the PavlovServer script executable. (You only need to do this once):

<pre>
chmod +x ~/pavlovserver/PavlovServer.sh
</pre>

----

=== Server Configuration ===

Before starting the server we need to configure it. Start by creating some directories:

<pre>
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Logs
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps
</pre>

==== Mods/Blacklist/Whitelist (optional) ====

The following three files allow you to specify mods, banned players, and whitelist players. These are optional, but go ahead and create them. Populating the files is described later.

<pre>
touch /home/steam/pavlovserver/Pavlov/Saved/Config/mods.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/blacklist.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/whitelist.txt
</pre>

====Configuring Game.ini====
Create a new Game.ini file using following command to open an editor and copy/paste the following block into it then save it. Note not all of these options are required. For instance remove or comment out the Password=0000 line to make a public server with no pin.
<pre>
nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini
</pre>

<pre>
[/Script/Pavlov.DedicatedServer]
bEnabled=true
ServerName="My_private_idaho"
MaxPlayers=10 #Set this to 10 for Shack. 24 is the max for PC, setting it higher will not allow players to join.
ApiKey="ABC123FALSEKEYDONTUSEME"
bSecured=true
bCustomServer=true
bVerboseLogging=false
bCompetitive=false #This only works for SND
bWhitelist=false
RefreshListTime=120
LimitedAmmoType=0
TickRate=90
TimeLimit=60
#Password=0000
#BalanceTableURL="vankruptgames/BalancingTable/main"
MapRotation=(MapId="UGC1758245796", GameMode="GUN")
MapRotation=(MapId="datacenter", GameMode="SND")
MapRotation=(MapId="sand", GameMode="DM")

</pre>

* '''bEnabled''' - whether the server appears in the server list (unconfirmed)
* '''ServerName''' - name it will be listed as. (approx 35 chars max)
* '''MaxPlayers''' - See suggested specs for limits. 10 standard (10 for shack), 20-24 is max recommended for large maps like Stalingrad or PUSH/RUSH modes, and servers allow a maximum of 24 players.
* '''ApiKey''' - Unique ApiKey required to register server with master server. Replace with your key
* '''bSecured''' - enabled Valve Anti-Cheat (VAC)
* '''bCustomServer''' - activates some new modding tools (save and http functions. Required to write to blacklist.txt for bans)
* '''bCompetitive''' - sets the server to competitive mode for SND. If removed the server will default to false
* '''bVerboseLogging''' - enables verbose logging, mostly detailed statistics. Be prepared for significant increase in logging.
* '''bWhitelist''' - Only allow users in whitelist.txt to join
* '''RefreshListTime''' - sets how often the running server checks for updates in ban/whitelist/mod files
* '''LimitedAmmoType''' - sets limited ammo mode
0 = Unlimited
1 = Limited Generic
2 = Limited Specific
3 = Custom (for modders)
4 = Limited Special
5 = Boxless Mode

* '''TimeLimit''' - sets time limit for each map
* '''TickRate''' - sets the server tickrate. (so far minimum stable seems around 50 and max around 120. Beware setting this changes weapon despawn time and breaks some game modes. Recommend not touching)
* '''Password''' - PIN number for server #FYI - this is now also changeable via rcon.
* '''BalanceTableURL''' - Points to a custom balance table from github. See https://github.com/vankruptgames/BalancingTable for instructions. This line isn't needed if you don't have one.
* '''MapRotation''' - you can add multiple of these. The MapId must be “UGC” followed by the map ID. you can find the map id in the URL of the steam workshop page. When a match ends, the server will load the next map in the rotation. You can also use RCON to switch to a map not included in rotation.

Available game modes as of 09/06/2022: SND, TDM, DM, GUN, ZWV, WW2GUN, TANKTDM, KOTH, TTT, OITC, INFECTION, HIDE, PUSH, PH 

And for Shack only: CTF

For maps running a Custom gamemode (CodZ, BR, Duel, etc.) it doesn't matter which gamemode you choose, as the map will automatically override it with the custom mode.

UGC###### are for custom maps from Steam workshop (PC Only). Find the map you want in the workshop. This is the URL for Mirage (https://steamcommunity.com/sharedfiles/filedetails/?id=2670152485). The 10 numbers at the end of the URL are what you need, so UGC1661803933 would be the MapId for Mirage.

==== Firewall/Port forwarding ====
Using the default settings there are two UDP ports (7777, 8177) that need to be allowed to access the server either by firewall setup or port forwarding.

'''Ubuntu''' firewall commands to check firewall and open ports:
<pre>
sudo ufw status
sudo ufw allow 7777
sudo ufw allow 8177
sudo ufw allow 9100
sudo ufw status
</pre>

'''Rocky Linux''' firewall commands to check firewall and open ports:
<pre>
sudo firewall-cmd --zone=public --add-port=7777/tcp
sudo firewall-cmd --zone=public --add-port=7777/udp
sudo firewall-cmd --zone=public --add-port=8177/tcp
sudo firewall-cmd --zone=public --add-port=8177/udp
sudo firewall-cmd --zone=public --add-port=9100/udp
sudo firewall-cmd --zone=public --add-port=9100/tcp
sudo firewall-cmd --list-ports
firewall-cmd --runtime-to-permanent
</pre>

You may also need to allow Pings (ICMP) for the server's true latency to appear in the master list.

If you are running multiple servers and have set additional ports (see http://wiki.pavlov-vr.com/index.php?title=Dedicated_server#Running_multiple_servers_on_one_host) then you need to allow access to the defined port plus the port 400 higher. So if you use 7000 as your port, then UDP 7000 and 7400 need to be open

If you have setup rcon via RconSettings.txt (below) then that port also need to be allowed access via TCP

If you are running Shack/Quest and want to have maps that are downloadable from your server, your server ports (ex. 7777 & 8177) must also be open via TCP

----

==== Shack Maps (Quest) ====

If you try to use the steps above to add maps for Shack, youll run into issues very quickly. This is because Shack has no affiliation to Steam, and therefore cannot use Steam Workshop maps like above. In the future, these steps will apply to PC servers as well, allowing a server to hold the map itself, instead of offloading to Steam.

To get started, first create the directory to hold the maps

<pre>mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps</pre>

You can use any number of methods to move the map files onto the server, but ill go over the two simplest, starting with a GUI approach

Download and install CyberDuck onto your "home" PC (Whatever PC you use for access to the server, but not the server itsself): https://cyberduck.io/

Next, download and unzip your map of choice from https://www.pavlovquest.com/ , https://pavlovhorde.com/mapsList, or look in #shack-map-showcase channel in the discord server. I'm going to use Cheeto's WW2 Items test (http://www.mediafire.com/file/emyt9bs1z9u9ykw/SVR_Cheeto_Items.zip/file ) for this example, you do what you like

In the top left corner, open a connection, set the connection type to SFTP, and fill in the rest of the information. User will be root, password is whatever you set the root pw as (toor in Ubuntu by default)

In the directory dropdown (itll say /root) go back to /

Follow the directories until we arrive back at our "maps" folder <pre>/home/steam/pavlovserver/Pavlov/Saved/maps</pre>

Drag and drop the unzipped map folder into the main window, in this case itll be SVR_Cheeto_Items

Hit Allow

Youll now see a folder named SVR_Cheeto_Items, and within it should be nothing but 3 files. If there is another folder in it, move this folder to the maps directory, otherwise the server wont work. The 3 files (2 .PAK one .JSON) should be in home/steam/pavlovserver/Pavlov/Saved/maps/SVR_Cheeto_Items, no more, no less.

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

To play the map, you can either use RCON switch map command, or to add the map to your servers automatic map rotation list, add the map's folder name to your Game.ini. This replaces the MapID section, so for our example it would be

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

And thats all! Disconnect CyberDuck from your server before playing, otherwise youll have difficulty joining.

-----------

==== Adding Shack Maps over Command Line Interface ====

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

A bit more complicated, but adding maps over CLI has its benefits

First, CD to the maps directory you made above

<pre>cd ~/pavlovserver/Pavlov/Saved/maps</pre>

Download the map files from whatever you use to upload them. To do this, you can either use curl or wget

<pre>curl -O insertURLhere</pre>

'''If you download your map from Google Drive''', make sure that your .zip folder is shared to anyone.
Then, get the file's url from the shared link. Example : ''<nowiki>https://drive.google.com/file/d/19bI8gUHaN5tUrDvnadAacUnchQf6_k/view</nowiki>'' will be ''19bI8gUHaN5tUrDvnadAacUnchQf6_k''
Edit "fileId" and "fileName" before you execute the command.
<pre>
fileId=19bI8gUHaN5tUrDvnadAacUnchQf6_k
fileName=SVR_USER_MAPNAME
curl -sc /tmp/cookie "https://drive.google.com/uc?export=download&id=${fileId}" > /dev/null
code="$(awk '/_warning_/ {print $NF}' /tmp/cookie)"
curl -Lb /tmp/cookie "https://drive.google.com/uc?export=download&confirm=${code}&id=${fileId}" -o ${fileName} </pre>

To keep with the Items example:

<pre>curl -O https://cdn.discordapp.com/attachments/744185280759857234/745027406695366788/SVR_Cheeto_Items.zip</pre>

Next, unzip the file. If this next step errors out, saying the command is unknown, switch back to the root user (su root), and install unzip (sudo apt install unzip), then return to the steam user, and continue.

<pre>unzip SVR_Cheeto_Items.zip</pre>

Now finish like before by adding the map to your Game.ini

<pre>nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini</pre>

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

==== Admin/Moderator list (optional) ====

The only working in-game admin menu is through Arctic VR server hosting (see below).

If you add moderators to your server, they will not be subject to vote kicks.

<pre>
nano ~/pavlovserver/Pavlov/Saved/Config/mods.txt
</pre>

Example Mod List:
<pre>
76541198397498572 #Optional Comment: Player name
76541198397498573 #Some Other Player
</pre>

==== ArcticVR Admin Menu ====

[[File:Arcticmenu.jpg|500px|link=https://www.arctic-vr.com/server-admin-menu]]

Arctic-VR Offers an advanced In-Game Admin menu that is exclusive to their hosting service. Features include:
* Switch Maps+Modes
* Teleport Players to Players
* Change Player Skins
* Control Player Buying+Cash
* Spawn Items
* Clean up corpses + guns
* Spawn Bots
* Spawn Items for other players
* Control Teams + Balance/Shuffle Teams
* ResetSND
* And More

You can read more about the ArcticVR admin menu on their website: https://www.arctic-vr.com/server-admin-menu

==== Handy tools for finding steamIDs ====

Steam ID finder: https://steamidfinder.com/lookup/ or https://steamid.xyz/

You want to enter in the steamID64 format.

This tool can convert or lookup IDs: https://steamid.io/

If you are looking for a steamID of a player that has been on your server recently this is technique to find them:
<pre>
grep -i playername ~/pavlovserver/Pavlov/Saved/Logs/* | grep TicketValidation
</pre>

=== Configure Rcon ===
To enable Rcon access create config file:
<pre> nano /home/steam/pavlovserver/Pavlov/Saved/Config/RconSettings.txt </pre>

Copy in the following text - change password, and if desired the port:
<pre>
Password=ChangeThisPassword
Port=9100
</pre>
You must specify a port for the Rcon server to use as well as a Password (use a different port per sever instance if running multiple server instances off the same hardware)

=== Starting the server ===

<pre>
cd ~/pavlovserver && ./PavlovServer.sh
</pre>

That's it, your server will be automatically broadcast to the master server! :)

Two handy tools to determine quickly if your server is broadcasting are [https://pablub.xyz/ Pablub] (PC only) and [https://pavlovhorde.com/ Horde] (Shack) and [https://pavlovhorde.com/pcServers Horde] (PC version)

Note that when you close your terminal, the server will go down. See the "supervisors" section below for how to prevent this.

=== Auto-updating the server ===

Assuming you have followed this guide and used the default paths, users, and install instructions, you can paste the following into your terminal to auto-update your Pavlov server:

<pre>
cat << 'EOF' > $HOME/pavlov_daily_update_and_restart.sh
#!/bin/bash

USER="steam"
SERVICENAME="pavlovserver.service"
INSTALLDIRNAME="pavlovserver"
USERHOME="/home/$USER"

echo -e "Beginning Pavlov VR update run on $(date)\n\n"

systemctl stop "$SERVICENAME"

sleep 5
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +force_install_dir "$USERHOME/$INSTALLDIRNAME" +app_update 622970 +exit
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +app_update 1007 +quit
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/.steam/sdk64/steamclient.so"
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/pavlovserver/Pavlov/Binaries/Linux/steamclient.so"

systemctl start "$SERVICENAME"

echo -e "Ending Pavlov VR update run on $(date)\n\n"

EOF

chmod +x $HOME/pavlov_daily_update_and_restart.sh
mkdir $HOME/pavlov_update_logs && touch $HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log
CRONLINE="00 2 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
(sudo crontab -u root -l; echo "$CRONLINE" ) | sudo crontab -u root -
unset CRONLINE

</pre>

These commands will:

1. Create a shell script in the "steam" user's home directory that automatically stops the Pavlov server, pulls any updates via steam, pull updates to the Steamworks SDK Redist, and copies the latest version of steamclient.so to the Pavlov server directory

2. Make the shell script executable

3. Create a new directory called "pavlov_update_logs" in the "steam" user's directory, and create a logfile inside that directory called "pavlov_daily_update_and_restart.sh.log". You can check this logfile to see the output of the Pavlov and Steam SDK update commands.

4. Create a crontab entry for the root user that runs this shell script automatically every day at 2:00AM local time

If you want to change the time that this script runs, edit the numbers "00 2" in the line that starts with "CRONLINE=". In the example provided, 00 is the minutes column, and 2 is the hour column. For example, if you wanted the server to automatically update and restart at 4:17AM every day, change the line starting with "CRONLINE=" to:

<pre>
CRONLINE="17 4 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
</pre>

If the time is PM, use 24-hour time format, e.g. "32 18" for 6:32PM.

----

=== Supervising the server using systemd ===

Running '''./PavlovServer.sh''' in your interactive shell is easy, but the server will shut down when you close your terminal. If you want to run the server in the background,
you'll want to run it under a supervisor. There are many options, ranging from the simple (nohup, screen or tmux), to the
more robust (supervisord, systemd).

Systemd is running by default on Ubuntu Linux, so we'll use that here.

To run the server as a systemd service, create the file '''/etc/systemd/system/pavlovserver.service''' (as root) by typing
<pre>
sudo nano /etc/systemd/system/pavlovserver.service
</pre>

Copy contents below into the file and save.

<pre>
[Unit]
Description=Pavlov VR dedicated server

[Service]
Type=simple
WorkingDirectory=/home/steam/pavlovserver
ExecStart=/home/steam/pavlovserver/PavlovServer.sh

RestartSec=1
Restart=always
User=steam
Group=steam

[Install]
WantedBy = multi-user.target
</pre>

If you'd like your server to start as competitive without editing the game.ini, change the line "ExecStart=/home/steam/pavlovserver/PavlovServer.sh" to look like this below. Though it's much easier to just use the game.ini to enable competitive instead. <pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -COMPETITIVE=1</pre>

Change the user or paths as appropriate. After saving the service file, to start, restart, stop, or monitor the server:

<pre>
sudo systemctl start pavlovserver
sudo systemctl restart pavlovserver
sudo systemctl stop pavlovserver
sudo systemctl status pavlovserver
</pre>

To view the logs:

<pre>
sudo journalctl -u pavlovserver
# to live-tail the logs
sudo journalctl -u pavlovserver -f
</pre>

If you want to run the pavlov server as soon as your server boots (e.g. a VPS you turn on and off), add pavlov as a startup service:

<pre>
sudo systemctl enable pavlovserver
</pre>

----

== Advanced Server Administration ==

=== Running multiple servers on one host ===

* Pavlovserver is functionally single threaded (there are multiple threads, but vast majority of work occurs in the primary one). Make sure you have # of pavlovservers + 1 CPU available. More CPUs= more servers. Faster CPU = more players.
* Make multiple server installs by defining a separate install dir for each server.
* Run each server with a unique port. eg: '''./PavlovServer.sh -PORT="Desired Port"'''
* The Server will use the Desired Port and the Port 400 above (Example: You choose 8200 as Port. So Port 8600 will be used as well)
* If you are using RCON, each server will need a unique port defined in RconSettings.txt
* Ensure the ports are forwarded and opened in your firewall

To duplicate directories:

be in the steam home folder
<pre>
cp -r pavlovserver pavlovserver1
/home/steam/pavlovserver1/PavlovServer.sh -PORT=[Desired Port]
</pre>

=== Starting server in competitive mode ===
Competitive mode will prevent dead teammates from being able to see the match, to prevent ghosting.
You can either enable this via Game.ini (described in Game.ini file), or using the -COMPETITIVE=1 parameter.

<pre>
/home/steam/pavlovserver1/PavlovServer.sh -COMPETITIVE=1
</pre>

== Automated RCON examples ==
here are some examples of scripts that interact with Pavlov RCON

=== <big>Inspect players every 5 minutes</big> [https://github.com/JTWP-org/inspect-every-5-mins (INSTALL FROM GIT )] ===
This [https://www.gnu.org/software/bash/ BASH] script connects to the server u set in the config with [https://netcat.sourceforge.net/ NETCAT] 2 times every 5 min and it uses RCON commands [[Rcon Overview and Commands|RefreshList ServerInfo]] &.<code>[[InspectPlayer 76|InspectPlayer]] {UniqueID} to build stats for the current round stats are then appended over the last one collected</code>

as for the 5 min timer we use a [https://linux.die.net/man/5/crontab crontask]

{| class="wikitable"

|}

=== <big>pending reset</big> ''(COMING SOON'') ===
----

===Useful Linux Commands===

List files / folders in directory, print current working directory,
<pre>ls -la #list files/directories along with authorities and ownership
pwd #print working directory
sudo chown <owner> <file/directory> #change owner of file/directory. If root created something and you need to change it to steam
sudo chgrp <group> <file/directory> #change group of file/directory.
</pre>

Check if pavlov is running by checking process status. If the only row you see is the grep command, pavlov server is not started.
<pre> ps -ef | grep pav </pre>

Sample output:
<pre>
steam 34044 1 0 16:52 ? 00:00:00 /bin/sh /home/steam/pavlovserver/PavlovServer.sh
steam 34066 34044 80 16:52 ? 00:00:04 /home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer
zombies+ 34101 34013 0 16:52 pts/0 00:00:00 grep --color=auto pav
</pre>

Kill a process. Note this command uses 34044, which is a process id from the command output above.
<pre> kill -9 34044 </pre>

Dump the log to the console so you can scroll through it:
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log </pre>

Search the log for a string - replace my_string with case-sensitive string
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep my_string </pre>

===Default Map ID's===
datacenter

sand

bridge

containeryard

siberia (Prison Break)

hospital (Zombies map)

killhouse

range

tutorial

santorini

station

industry

ogcontainers (Shack only)

haguenau (Shack only)

foundation (Shack only)

stalingrad (PC only)

stalingrad_night (PC only)

santorini_night (PC only)

sand_night (PC only)

station_night (PC only)

industry_night (PC only)

bunker (PC only)

===Automated server log backup ===

here is how to setup a bash script to 1x a day compress all log files and save them to protect from auto deletion it will also post a discord webhook to confirm its working and saved the days logs

https://github.com/JTWP-org/backUpLogs

==Troubleshooting==

To run the server without outputting the heartbeat:

<pre>./PavlovServer.sh | sed '/heartbeat/d'</pre>

To monitor the logs (without heartbeat) from another terminal:

<pre>tail -f -n10000 /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep -v 'Sending heartbeat to masterserver'</pre>

Check your CPU Clock Speed with:

<pre>lscpu | grep MHz</pre>

=== Server won't start ===

Error message:
<pre>
ln: failed to create hard link '/home/steam/.steam/sdk64/steamclient.so': File exists
ln: failed to create hard link '/home/steam/pavlovserver/Pavlov/Binaries/Linux/steamclient.so': File exists
/home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer: error while loading shared libraries: libc++.so.1: cannot open shared object file: No such file or directory
</pre>

First two errors are harmless. The third one is because libc++ step was skipped or failed. Using sudo capable id (probably not steam id), [re]run this line:
<pre>sudo apt update && sudo apt install -y gdb curl lib32gcc1 libc++-dev unzip </pre>

=== Map wont load (kicks to datacenter)===

try deleting all the downloaded workshop maps with:

<pre>sudo rm -rf /tmp/workshop/7777/content/555160/*</pre> for all maps or

<pre>sudo rm -rf /tmp/workshop/7777/content/555160/whatever-UGC</pre> for specific map

===Map wont load when running in a container===
The three typical container problems I have seen:

1) Steam can't write to /tmp for some reason

2) /tmp is actually tmpfs instead of real filesystem and a few gigs of maps runs you out of RAM

3) Made worse by fact that pavlovserver unpacks downloads to ram, then writes to /tmp/workshop. Not enough RAM to do this, no map for you.

===Server stuck rotating forever===

Run these 2 commands, then restart your server:

<pre>cd ~/Steam && ./steamcmd.sh +login anonymous +app_update 1007 +quit
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so</pre>

If this doesn't fix it, double check that your server isn't running on the same port as another, by running this command:

<pre>ps -ef | grep pav</pre>

Then if 2 servers are on the same port, you can fix it by editing the pavlovserver.service file, and making sure the following line:

<pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -PORT=Number</pre>

has a unique number after the port for each server you're running.

=== Server - ping 999===
Google Cloud Platform - Make sure your compute engine has a network tag and your network rules are applied to the tag.
Make sure you opened the specified ports.

Network testing tools:
Test if your server will respond to ping from outside your network:
https://www.wormly.com/test-remote-ping

Test if your ports are accessible via UDP (7777,8177,9100):
https://www.ipvoid.com/udp-port-scan/

===Can't connect to RCON===
Check the file and group owner of RconSettings file. It should be steam, or the ID used to run the pavlov server.
<pre>
cd /home/steam/pavlovserver/Pavlov/Saved/Config
ls -la
</pre>

If the owner/group are not steam, using root or an id with sudo authority, change them to steam, confirm they are now set properly, then restart the pavlov server. (Note - if Rcon has wrong permissions, after fixing you should also to check the other config files like Game.ini, mods/blacklist/whitelist for the same issue. If steam can't access these files, it could cause problems.).
<pre>
cd /home/steam/pavlovserver/Pavlov/Saved/Config
sudo chown steam RconSettings.txt
sudo chgrp steam RconSettings.txt
ls -la </pre>

===PC ONLY - Map Download stops===

When downloading a large map from the steam workshop make sure your VPS/Dedi or Shared hosting provider (Otherwise known as a GSP's) has enough RAM assigned to store the map files in its tempfs (stored in ram)!

This is less likely to happen on Dedicated servers and VPS with a decent amount of ram unless you are using docker with RAM limits!

Most GSP's will be using docker or some other type of jailing method to limit system resource allocations and direct access to the host machine, if they are and you know what map you want to use make sure you order a service with enough ram to store your map. If in doubt contact your GSP's support team.

===Getting Help===

There's a #pc-custom-servers channel on the official Pavlov Discord - https://discord.gg/Pavlov-VR. Lots of helpful people there!
[[Category:RCON automation]]

Setting up a dedicated server

2023-05-26T05:51:00Z

SaltedCrackerJack: /* Automated RCON examples */

== Setting up a dedicated server ==

'''There are no Windows binaries'''

This guide is written exclusively for Linux and covers Ubuntu/Debian/Debian-like and Red Hat RPM-based distros. Possible to run with other distros, but some of the commands won't work and you will need to know enough to figure out the software install of dependencies on your own.

If you are considering hosting from home, please read that section of the wiki first.

This guide assumes you know the basics of using a bash terminal: ssh'ing into a server, running bash commands, editing text files, etc.

If you have no experience using bash, maybe start [https://www.howtogeek.com/140679/beginner-geek-how-to-start-using-the-linux-terminal/ here]. Editing text files via commandline is often a challenge. Suggest using nano and reading guide [https://www.howtogeek.com/howto/42980/the-beginners-guide-to-nano-the-linux-command-line-text-editor/ here]

If you are new to linux and accessing your server from Windows, highly suggest using MobaXterm as your SSH client as that can make required editing of text files easier using built in editor instead of the native linux command line editors.

And finally, ask yourself why you want to setup a server? If you look at the list, there are many, many more servers than players. If you don't have a team, discord community, or group of friends ready to play on your server, chances are it will go unused. Got one of these... great, let's go.

If you don't want to go through the hassle yourself and want to pay for a hosting service Arctic VR (PC and Shack) and Horde (Shack) provide a server hosting services and are trusted in the community. See links below.

----

=== Server Requirements ===

'''Pavlovserver can only be hosted under Linux.'''

This can be running as a VM under windows, but this will increase the complexity of the setup beyond this guide.

Ubuntu 18.04 x86_64, Ubuntu 19/04 amd64, Ubuntu 20.04, and Rocky Linux 8 are confirmed working. Ubuntu 15.04 x86 is known to fail to install using this guide. Recommend not running on "minimal" images as some tools are missing.

* 2GB RAM + 1GB RAM per each additional server with 10 players. More RAM is recommended for larger maps, higher player counts, or complex gamemodes. Not having enough RAM is a common cause of server crashes.

* A ~2.5Ghz CPU will comfortably support a 10 player server.

* A ~4Ghz CPU will comfortably support 24 players. This is a limit built into Pavlov itself, no server will allow players to join over 24. Lower player counts are recommended for complex gamemodes (E.g. CodZ) and/or highly detailed maps, so that maximum number will often be lower.

(Note that these are '''not''' hard limits for player counts, just suggestions for the best performance, based on experiences with many server providers on different grades of hardware.)

* Pavlovserver is functionally single threaded (one thread does vast majority of work). More CPUs only help if you are running more servers. More clockspeed = higher performance = more users per server.
The maximum number of servers you can run is dependent on how many CPUs you have. For example, if you have an 8 core CPU, the maximum number of servers would be 7. You should always have at least one CPU free as overhead, as Pavlov servers can use slightly more than one thread.

----

==== Hosting at home ====
When hosting at home there are additional requirements regarding networking: Your router has to support port-forwarding, hair-pinning/LoopbackNAT, and respond to ping requests. These techniques are necessary to allow your server to be found and to talk back to the client. please see https://en.wikipedia.org/wiki/Port_forwarding, https://en.wikipedia.org/wiki/Hairpinning, and https://www.speedguide.net/faq/how-to-become-pingable-behind-a-routerfirewall-376 for more info and google for these terms in addition to your router model to find guides on how to enable/configure it properly. If you have modern Router, it may have these features already enabled, in this case you just have to configure port-forwarding. If you can see your server but not join it while others can, this is indicative of a failure of LoopbackNAT.

A second challenge to hosting at home is CGNAT (Carrier grade NAT: https://www.a10networks.com/blog/carrier-grade-nat/). Just like NAT on your home network that has to be gotten around w/ port-forwarding, CGNAT breaks the ability of external connections to be made back to your server, but the controls are solely in your ISPs hands. Sometimes if you ask, you can be removed from CGNAT pools and/or assigned a static IP. CGNAT rollouts are becoming very common now, so if your server worked then doesn't allow connections now, your ISP may have made this change.

You can check whether you’re on a CGNAT network by visiting a Web site such as ipaddress.com or whatsmyip.com and comparing the IP address listed to the public/WAN IP address assigned to your Internet gateway. To find your gateway’s public IP address, check the status page in the administrative interface. If the two IP addresses differ, you’re likely on a CGNAT network. If so, this problem must be resolved before you go any further.

'''Not understanding these requirements and configuration is a frequent cause of failed setups and questions in discord. Don't skip this if you are trying to host from home'''

'''There are serious security implications of hosting this software at home.''' None of the devs are security experts and there has been no security review of the code. You are opening up your system to the world and publicity advertising this fact. Expect that any system hosting this software is open to compromise from the Internet and act accordingly. If your router offers a DMZ network, use it. Consider hosting on a cloud based server and think twice before running this software on any system that contains data you care about or has access to networks and computers you care about.

If you're hosting at home using Oracle's VirtualBox, there are steps you can take to prevent double NAT (which can cause issues later on)

1. Select your VM and then click Settings in VirtualBox's main window.

2. Click on Network and change Attached To from NAT to Bridged Adapter.

Once you've done this, your VM should be connected directly to your home router and double NAT should no longer be a issue.
----

==== Hosting Providers ====

Considering the suggested server specs, you may be interested in the following hosting providers. For providers promising dedicated "Pavlov hosting" as opposed to general VPS services please contact and ask how you change maps being hosted and how you get RCON access before you put your money down.

<pre>
Provider | Base CPU | Details
Arctic VR | 4.5 GHz | https://www.arctic-vr.com/server-hosting
Amazon Web Services | 4.0 GHz | https://aws.amazon.com/ec2/instance-types/z1d/
VULTR | 4.0 GHz | https://www.vultr.com/products/high-frequency-compute/
packet.com | 3.5 GHz | https://www.packet.com/cloud/servers/c1-small/
Google Cloud Platform | 3.2 GHz | https://cloud.google.com/compute/docs/cpu-platforms
</pre>

===== ARCTIC VR =====

Arctic VR is the largest and longest running Pavlov VR hosting provider. The In-Game Admin Menu is exclusive to the ArcticVR hosting service. They offer EU, NA East and NA West servers for both shack and PCVR. ArcticVR offers the fastest Pavlov servers as well as DDos Protection, RCON remote management, custom maps, low pings, unlimited slots, and expert support.

Website: https://www.arctic-vr.com/server-hosting

[[File:Arctic_options.png|link=https://www.arctic-vr.com/server-hosting|700px]]

===== VULTR =====

Consider using a referral from the community:

Carlos: https://www.vultr.com/?ref=8615589-6G

Carrot: https://www.vultr.com/?ref=8689348

Archaeo: https://www.vultr.com/?ref=8653652-6G

Cheeto: https://www.vultr.com/?ref=8717358

For a Pavlov Shack server, I recommend minimum Cloud Compute, Intel High Performance, Ubuntu 20.04, and disabled automatic backups. At the time, this was $6/m. Some of the cheap options have 1TB bandwidth, and some have 2TB+. If it's a personal server, 1TB could be fine, but 2TB should be safe.

===== Google Cloud Platform (90 day free credit available) =====

The below configuration is successfully running 4 pavlov PC instances with ~15 total maps and up to 24 players per server. If you want more maps use larger boot disk. Both can dynamically be scaled based on popularity.

<pre>

Menu -> compute engine -> VM instances
create instance
- region: wherever you like
- machine type: n1-highcpu-4 (4 vCPUs, 3.6 GB memory)
- boot disk: Ubuntu 20.04
- boot disk -> size: 25gb
- network tags: pavlov-server
- [create]

Menu -> Vpc network -> firewall rules
[Create firewall rule]
Name: pavlov server
Target Tags: pavlov-server
Source IP Ranges: 0.0.0.0/0
Protocols and Ports -> Specified protocols and ports -> UDP: 7777, 8177 (Shack and PC)
Protocols and Ports -> Specified protocols and ports -> TCP: 7777, 8177 (Shack-only)
Protocols and Ports -> Specified protocols and ports -> TCP: {RCON port - default 9100}
[save]
</pre>

===== Amazon Web Services (30 day free credit available) =====

<pre>
Login -> Change Region: Choose your region
Services -> Compute -> EC2 -> Create
Choose an AMI: Ubuntu 18.04
Instance Type: z1d.large

Instance Details -> Tenancy: Dedicated (optional: this will more than triple the cost)

Storage: 50gb disk (or whatever, you're in control of the map roster)

Security Groups:
Create a new Security Group
Security group name: pavlov-server
Description: pavlov server
Rules:
Type: Custom ICMP Rule - IPV4 / Protocol: Echo Request
Type: Custom UDP Rule / Port Range: 7777 / Source: 0.0.0.0/0
Type: Custom UDP Rule / Port Range: 8177 / Source: 0.0.0.0/0
Type: SSH (optional, but I assume you wanna SSH in..)

Launch -> Create new Keypair -> Download -> Launch

Once it's started, SSH in like:
$ ssh -i your-key.pem ubuntu@you-server-details.amazonaws.com

(I use cmder on Windows, if you're using putty or mobaxterm or something, might be different)
</pre>

=== Starting Server Install ===

====Obtaining an ApiKey====
For your server to show up in the server list, there is now a requirement to have an ApiKey issued by vankrupt. This is to prevent DOS attacks against the master server

Get the key by going here: https://pavlov-ms.vankrupt.com/servers/v1/key and using your mobile number to get a SMS
(note that there have been reported failures of this SMS system for non-US mobiles. In this case DM davevillz your mobile and ask for a key)

Put this key in your Game.ini as follows:
ApiKey="ABC123FALSEKEYDONTUSEME"
or if you would like (personally untested..I would use game.ini) you can call it at server runtime with flag as follows:
-KEY="ABC123FALSEKEYDONTUSEME"

This key can be re-used for a reasonable number of servers (a limit of 10 has been mentioned). Contact the Devs if you need more servers per key.

====System setup and software installation====

Install dependencies and create the `steam` user. (You only need to do this once):

Confirm Linux version
<pre>
lsb_release -a
</pre>

'''Ubuntu 20.04'''
<pre>
sudo apt update && sudo apt install -y gdb curl lib32gcc1 libc++-dev unzip
sudo useradd -m steam
</pre>

'''Ubuntu 20.10 or higher'''
<pre>
sudo apt update && sudo apt install -y gdb curl lib32gcc-s1 libc++-dev unzip
sudo useradd -m steam
</pre>

'''Rocky Linux, CentOS 8, and RHEL 8'''

<pre>
sudo sed -i 's/^SELINUX=enforcing$/SELINUX=permissive/g' /etc/selinux/config
sudo setenforce 0
sudo yum install gdb curl glibc.i686 libstdc++.i686 libstdc++-devel.i686 libstdc++-devel.x86_64 unzip wget -y
wget https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/l/libcxx-3.8.0-3.el7.x86_64.rpm
sudo rpm -i libcxx-3.8.0-3.el7.x86_64.rpm
sudo useradd -m steam
</pre>

[Optional] Set a password for steam.
<pre>sudo passwd steam</pre>

Login as the steam user. ('''You will need to do this each time you connect to your server'''):

<pre>
sudo su -l steam
</pre>

Install Steam:

<pre>
mkdir ~/Steam && cd ~/Steam && curl -sqL "https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz" | tar zxvf -
</pre>

There are different dedicated server versions for Pavlov Server - choose which server version you want to host (PC non-beta, PC Beta, Shack Live, or Shack RC)
(You will need to run this command each time there is a Pavlov Server update). 
To host '''PC Server (non-beta)''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 +exit
</pre>

To host '''PC BETA''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta beta_server +exit
</pre>

To host '''Shack Live''' (Quest):

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack +exit
</pre>

To host '''Shack RC''' (Quest): 

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack_beta +exit
</pre>

Now that we've installed the server, all pavlov server versions should continue. 
Install a fresh copy of steamclient.so (May have to do this after each update):
<pre>
~/Steam/steamcmd.sh +login anonymous +app_update 1007 +quit
mkdir -p ~/.steam/sdk64
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/pavlovserver/Pavlov/Binaries/Linux/steamclient.so
</pre>

Make the PavlovServer script executable. (You only need to do this once):

<pre>
chmod +x ~/pavlovserver/PavlovServer.sh
</pre>

----

=== Server Configuration ===

Before starting the server we need to configure it. Start by creating some directories:

<pre>
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Logs
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps
</pre>

==== Mods/Blacklist/Whitelist (optional) ====

The following three files allow you to specify mods, banned players, and whitelist players. These are optional, but go ahead and create them. Populating the files is described later.

<pre>
touch /home/steam/pavlovserver/Pavlov/Saved/Config/mods.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/blacklist.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/whitelist.txt
</pre>

====Configuring Game.ini====
Create a new Game.ini file using following command to open an editor and copy/paste the following block into it then save it. Note not all of these options are required. For instance remove or comment out the Password=0000 line to make a public server with no pin.
<pre>
nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini
</pre>

<pre>
[/Script/Pavlov.DedicatedServer]
bEnabled=true
ServerName="My_private_idaho"
MaxPlayers=10 #Set this to 10 for Shack. 24 is the max for PC, setting it higher will not allow players to join.
ApiKey="ABC123FALSEKEYDONTUSEME"
bSecured=true
bCustomServer=true
bVerboseLogging=false
bCompetitive=false #This only works for SND
bWhitelist=false
RefreshListTime=120
LimitedAmmoType=0
TickRate=90
TimeLimit=60
#Password=0000
#BalanceTableURL="vankruptgames/BalancingTable/main"
MapRotation=(MapId="UGC1758245796", GameMode="GUN")
MapRotation=(MapId="datacenter", GameMode="SND")
MapRotation=(MapId="sand", GameMode="DM")

</pre>

* '''bEnabled''' - whether the server appears in the server list (unconfirmed)
* '''ServerName''' - name it will be listed as. (approx 35 chars max)
* '''MaxPlayers''' - See suggested specs for limits. 10 standard (10 for shack), 20-24 is max recommended for large maps like Stalingrad or PUSH/RUSH modes, and servers allow a maximum of 24 players.
* '''ApiKey''' - Unique ApiKey required to register server with master server. Replace with your key
* '''bSecured''' - enabled Valve Anti-Cheat (VAC)
* '''bCustomServer''' - activates some new modding tools (save and http functions. Required to write to blacklist.txt for bans)
* '''bCompetitive''' - sets the server to competitive mode for SND. If removed the server will default to false
* '''bVerboseLogging''' - enables verbose logging, mostly detailed statistics. Be prepared for significant increase in logging.
* '''bWhitelist''' - Only allow users in whitelist.txt to join
* '''RefreshListTime''' - sets how often the running server checks for updates in ban/whitelist/mod files
* '''LimitedAmmoType''' - sets limited ammo mode
0 = Unlimited
1 = Limited Generic
2 = Limited Specific
3 = Custom (for modders)
4 = Limited Special
5 = Boxless Mode

* '''TimeLimit''' - sets time limit for each map
* '''TickRate''' - sets the server tickrate. (so far minimum stable seems around 50 and max around 120. Beware setting this changes weapon despawn time and breaks some game modes. Recommend not touching)
* '''Password''' - PIN number for server #FYI - this is now also changeable via rcon.
* '''BalanceTableURL''' - Points to a custom balance table from github. See https://github.com/vankruptgames/BalancingTable for instructions. This line isn't needed if you don't have one.
* '''MapRotation''' - you can add multiple of these. The MapId must be “UGC” followed by the map ID. you can find the map id in the URL of the steam workshop page. When a match ends, the server will load the next map in the rotation. You can also use RCON to switch to a map not included in rotation.

Available game modes as of 09/06/2022: SND, TDM, DM, GUN, ZWV, WW2GUN, TANKTDM, KOTH, TTT, OITC, INFECTION, HIDE, PUSH, PH 

And for Shack only: CTF

For maps running a Custom gamemode (CodZ, BR, Duel, etc.) it doesn't matter which gamemode you choose, as the map will automatically override it with the custom mode.

UGC###### are for custom maps from Steam workshop (PC Only). Find the map you want in the workshop. This is the URL for Mirage (https://steamcommunity.com/sharedfiles/filedetails/?id=2670152485). The 10 numbers at the end of the URL are what you need, so UGC1661803933 would be the MapId for Mirage.

==== Firewall/Port forwarding ====
Using the default settings there are two UDP ports (7777, 8177) that need to be allowed to access the server either by firewall setup or port forwarding.

'''Ubuntu''' firewall commands to check firewall and open ports:
<pre>
sudo ufw status
sudo ufw allow 7777
sudo ufw allow 8177
sudo ufw allow 9100
sudo ufw status
</pre>

'''Rocky Linux''' firewall commands to check firewall and open ports:
<pre>
sudo firewall-cmd --zone=public --add-port=7777/tcp
sudo firewall-cmd --zone=public --add-port=7777/udp
sudo firewall-cmd --zone=public --add-port=8177/tcp
sudo firewall-cmd --zone=public --add-port=8177/udp
sudo firewall-cmd --zone=public --add-port=9100/udp
sudo firewall-cmd --zone=public --add-port=9100/tcp
sudo firewall-cmd --list-ports
firewall-cmd --runtime-to-permanent
</pre>

You may also need to allow Pings (ICMP) for the server's true latency to appear in the master list.

If you are running multiple servers and have set additional ports (see http://wiki.pavlov-vr.com/index.php?title=Dedicated_server#Running_multiple_servers_on_one_host) then you need to allow access to the defined port plus the port 400 higher. So if you use 7000 as your port, then UDP 7000 and 7400 need to be open

If you have setup rcon via RconSettings.txt (below) then that port also need to be allowed access via TCP

If you are running Shack/Quest and want to have maps that are downloadable from your server, your server ports (ex. 7777 & 8177) must also be open via TCP

----

==== Shack Maps (Quest) ====

If you try to use the steps above to add maps for Shack, youll run into issues very quickly. This is because Shack has no affiliation to Steam, and therefore cannot use Steam Workshop maps like above. In the future, these steps will apply to PC servers as well, allowing a server to hold the map itself, instead of offloading to Steam.

To get started, first create the directory to hold the maps

<pre>mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps</pre>

You can use any number of methods to move the map files onto the server, but ill go over the two simplest, starting with a GUI approach

Download and install CyberDuck onto your "home" PC (Whatever PC you use for access to the server, but not the server itsself): https://cyberduck.io/

Next, download and unzip your map of choice from https://www.pavlovquest.com/ , https://pavlovhorde.com/mapsList, or look in #shack-map-showcase channel in the discord server. I'm going to use Cheeto's WW2 Items test (http://www.mediafire.com/file/emyt9bs1z9u9ykw/SVR_Cheeto_Items.zip/file ) for this example, you do what you like

In the top left corner, open a connection, set the connection type to SFTP, and fill in the rest of the information. User will be root, password is whatever you set the root pw as (toor in Ubuntu by default)

In the directory dropdown (itll say /root) go back to /

Follow the directories until we arrive back at our "maps" folder <pre>/home/steam/pavlovserver/Pavlov/Saved/maps</pre>

Drag and drop the unzipped map folder into the main window, in this case itll be SVR_Cheeto_Items

Hit Allow

Youll now see a folder named SVR_Cheeto_Items, and within it should be nothing but 3 files. If there is another folder in it, move this folder to the maps directory, otherwise the server wont work. The 3 files (2 .PAK one .JSON) should be in home/steam/pavlovserver/Pavlov/Saved/maps/SVR_Cheeto_Items, no more, no less.

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

To play the map, you can either use RCON switch map command, or to add the map to your servers automatic map rotation list, add the map's folder name to your Game.ini. This replaces the MapID section, so for our example it would be

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

And thats all! Disconnect CyberDuck from your server before playing, otherwise youll have difficulty joining.

-----------

==== Adding Shack Maps over Command Line Interface ====

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

A bit more complicated, but adding maps over CLI has its benefits

First, CD to the maps directory you made above

<pre>cd ~/pavlovserver/Pavlov/Saved/maps</pre>

Download the map files from whatever you use to upload them. To do this, you can either use curl or wget

<pre>curl -O insertURLhere</pre>

'''If you download your map from Google Drive''', make sure that your .zip folder is shared to anyone.
Then, get the file's url from the shared link. Example : ''<nowiki>https://drive.google.com/file/d/19bI8gUHaN5tUrDvnadAacUnchQf6_k/view</nowiki>'' will be ''19bI8gUHaN5tUrDvnadAacUnchQf6_k''
Edit "fileId" and "fileName" before you execute the command.
<pre>
fileId=19bI8gUHaN5tUrDvnadAacUnchQf6_k
fileName=SVR_USER_MAPNAME
curl -sc /tmp/cookie "https://drive.google.com/uc?export=download&id=${fileId}" > /dev/null
code="$(awk '/_warning_/ {print $NF}' /tmp/cookie)"
curl -Lb /tmp/cookie "https://drive.google.com/uc?export=download&confirm=${code}&id=${fileId}" -o ${fileName} </pre>

To keep with the Items example:

<pre>curl -O https://cdn.discordapp.com/attachments/744185280759857234/745027406695366788/SVR_Cheeto_Items.zip</pre>

Next, unzip the file. If this next step errors out, saying the command is unknown, switch back to the root user (su root), and install unzip (sudo apt install unzip), then return to the steam user, and continue.

<pre>unzip SVR_Cheeto_Items.zip</pre>

Now finish like before by adding the map to your Game.ini

<pre>nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini</pre>

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

==== Admin/Moderator list (optional) ====

The only working in-game admin menu is through Arctic VR server hosting (see below).

If you add moderators to your server, they will not be subject to vote kicks.

<pre>
nano ~/pavlovserver/Pavlov/Saved/Config/mods.txt
</pre>

Example Mod List:
<pre>
76541198397498572 #Optional Comment: Player name
76541198397498573 #Some Other Player
</pre>

==== ArcticVR Admin Menu ====

[[File:Arcticmenu.jpg|500px|link=https://www.arctic-vr.com/server-admin-menu]]

Arctic-VR Offers an advanced In-Game Admin menu that is exclusive to their hosting service. Features include:
* Switch Maps+Modes
* Teleport Players to Players
* Change Player Skins
* Control Player Buying+Cash
* Spawn Items
* Clean up corpses + guns
* Spawn Bots
* Spawn Items for other players
* Control Teams + Balance/Shuffle Teams
* ResetSND
* And More

You can read more about the ArcticVR admin menu on their website: https://www.arctic-vr.com/server-admin-menu

==== Handy tools for finding steamIDs ====

Steam ID finder: https://steamidfinder.com/lookup/ or https://steamid.xyz/

You want to enter in the steamID64 format.

This tool can convert or lookup IDs: https://steamid.io/

If you are looking for a steamID of a player that has been on your server recently this is technique to find them:
<pre>
grep -i playername ~/pavlovserver/Pavlov/Saved/Logs/* | grep TicketValidation
</pre>

=== Configure Rcon ===
To enable Rcon access create config file:
<pre> nano /home/steam/pavlovserver/Pavlov/Saved/Config/RconSettings.txt </pre>

Copy in the following text - change password, and if desired the port:
<pre>
Password=ChangeThisPassword
Port=9100
</pre>
You must specify a port for the Rcon server to use as well as a Password (use a different port per sever instance if running multiple server instances off the same hardware)

=== Starting the server ===

<pre>
cd ~/pavlovserver && ./PavlovServer.sh
</pre>

That's it, your server will be automatically broadcast to the master server! :)

Two handy tools to determine quickly if your server is broadcasting are [https://pablub.xyz/ Pablub] (PC only) and [https://pavlovhorde.com/ Horde] (Shack) and [https://pavlovhorde.com/pcServers Horde] (PC version)

Note that when you close your terminal, the server will go down. See the "supervisors" section below for how to prevent this.

=== Auto-updating the server ===

Assuming you have followed this guide and used the default paths, users, and install instructions, you can paste the following into your terminal to auto-update your Pavlov server:

<pre>
cat << 'EOF' > $HOME/pavlov_daily_update_and_restart.sh
#!/bin/bash

USER="steam"
SERVICENAME="pavlovserver.service"
INSTALLDIRNAME="pavlovserver"
USERHOME="/home/$USER"

echo -e "Beginning Pavlov VR update run on $(date)\n\n"

systemctl stop "$SERVICENAME"

sleep 5
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +force_install_dir "$USERHOME/$INSTALLDIRNAME" +app_update 622970 +exit
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +app_update 1007 +quit
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/.steam/sdk64/steamclient.so"
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/pavlovserver/Pavlov/Binaries/Linux/steamclient.so"

systemctl start "$SERVICENAME"

echo -e "Ending Pavlov VR update run on $(date)\n\n"

EOF

chmod +x $HOME/pavlov_daily_update_and_restart.sh
mkdir $HOME/pavlov_update_logs && touch $HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log
CRONLINE="00 2 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
(sudo crontab -u root -l; echo "$CRONLINE" ) | sudo crontab -u root -
unset CRONLINE

</pre>

These commands will:

1. Create a shell script in the "steam" user's home directory that automatically stops the Pavlov server, pulls any updates via steam, pull updates to the Steamworks SDK Redist, and copies the latest version of steamclient.so to the Pavlov server directory

2. Make the shell script executable

3. Create a new directory called "pavlov_update_logs" in the "steam" user's directory, and create a logfile inside that directory called "pavlov_daily_update_and_restart.sh.log". You can check this logfile to see the output of the Pavlov and Steam SDK update commands.

4. Create a crontab entry for the root user that runs this shell script automatically every day at 2:00AM local time

If you want to change the time that this script runs, edit the numbers "00 2" in the line that starts with "CRONLINE=". In the example provided, 00 is the minutes column, and 2 is the hour column. For example, if you wanted the server to automatically update and restart at 4:17AM every day, change the line starting with "CRONLINE=" to:

<pre>
CRONLINE="17 4 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
</pre>

If the time is PM, use 24-hour time format, e.g. "32 18" for 6:32PM.

----

=== Supervising the server using systemd ===

Running '''./PavlovServer.sh''' in your interactive shell is easy, but the server will shut down when you close your terminal. If you want to run the server in the background,
you'll want to run it under a supervisor. There are many options, ranging from the simple (nohup, screen or tmux), to the
more robust (supervisord, systemd).

Systemd is running by default on Ubuntu Linux, so we'll use that here.

To run the server as a systemd service, create the file '''/etc/systemd/system/pavlovserver.service''' (as root) by typing
<pre>
sudo nano /etc/systemd/system/pavlovserver.service
</pre>

Copy contents below into the file and save.

<pre>
[Unit]
Description=Pavlov VR dedicated server

[Service]
Type=simple
WorkingDirectory=/home/steam/pavlovserver
ExecStart=/home/steam/pavlovserver/PavlovServer.sh

RestartSec=1
Restart=always
User=steam
Group=steam

[Install]
WantedBy = multi-user.target
</pre>

If you'd like your server to start as competitive without editing the game.ini, change the line "ExecStart=/home/steam/pavlovserver/PavlovServer.sh" to look like this below. Though it's much easier to just use the game.ini to enable competitive instead. <pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -COMPETITIVE=1</pre>

Change the user or paths as appropriate. After saving the service file, to start, restart, stop, or monitor the server:

<pre>
sudo systemctl start pavlovserver
sudo systemctl restart pavlovserver
sudo systemctl stop pavlovserver
sudo systemctl status pavlovserver
</pre>

To view the logs:

<pre>
sudo journalctl -u pavlovserver
# to live-tail the logs
sudo journalctl -u pavlovserver -f
</pre>

If you want to run the pavlov server as soon as your server boots (e.g. a VPS you turn on and off), add pavlov as a startup service:

<pre>
sudo systemctl enable pavlovserver
</pre>

----

== Advanced Server Administration ==

=== Running multiple servers on one host ===

* Pavlovserver is functionally single threaded (there are multiple threads, but vast majority of work occurs in the primary one). Make sure you have # of pavlovservers + 1 CPU available. More CPUs= more servers. Faster CPU = more players.
* Make multiple server installs by defining a separate install dir for each server.
* Run each server with a unique port. eg: '''./PavlovServer.sh -PORT="Desired Port"'''
* The Server will use the Desired Port and the Port 400 above (Example: You choose 8200 as Port. So Port 8600 will be used as well)
* If you are using RCON, each server will need a unique port defined in RconSettings.txt
* Ensure the ports are forwarded and opened in your firewall

To duplicate directories:

be in the steam home folder
<pre>
cp -r pavlovserver pavlovserver1
/home/steam/pavlovserver1/PavlovServer.sh -PORT=[Desired Port]
</pre>

=== Starting server in competitive mode ===
Competitive mode will prevent dead teammates from being able to see the match, to prevent ghosting.
You can either enable this via Game.ini (described in Game.ini file), or using the -COMPETITIVE=1 parameter.

<pre>
/home/steam/pavlovserver1/PavlovServer.sh -COMPETITIVE=1
</pre>

== Automated RCON examples ==
here are some examples of scripts that interact with Pavlov RCON

=== <big>Inspect players every 5 minutes</big> [https://github.com/JTWP-org/inspect-every-5-mins (INSTALL FROM GIT )] ===
This [https://www.gnu.org/software/bash/ BASH] script connects to the server u set in the config with [https://netcat.sourceforge.net/ NETCAT] 2 times every 5 min and it uses RCON commands [[Rcon Overview and Commands|RefreshList ServerInfo]] &.<code>[[InspectPlayer 76|InspectPlayer]] {UniqueID} to build stats for the current round stats are then appended over the last one collected</code>

as for the 5 min timer we use a [https://linux.die.net/man/5/crontab crontask]

{| class="wikitable"

|}

=== <big>pending reset</big> ''(COMING SOON'') ===
----

===Useful Linux Commands===

List files / folders in directory, print current working directory,
<pre>ls -la #list files/directories along with authorities and ownership
pwd #print working directory
sudo chown <owner> <file/directory> #change owner of file/directory. If root created something and you need to change it to steam
sudo chgrp <group> <file/directory> #change group of file/directory.
</pre>

Check if pavlov is running by checking process status. If the only row you see is the grep command, pavlov server is not started.
<pre> ps -ef | grep pav </pre>

Sample output:
<pre>
steam 34044 1 0 16:52 ? 00:00:00 /bin/sh /home/steam/pavlovserver/PavlovServer.sh
steam 34066 34044 80 16:52 ? 00:00:04 /home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer
zombies+ 34101 34013 0 16:52 pts/0 00:00:00 grep --color=auto pav
</pre>

Kill a process. Note this command uses 34044, which is a process id from the command output above.
<pre> kill -9 34044 </pre>

Dump the log to the console so you can scroll through it:
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log </pre>

Search the log for a string - replace my_string with case-sensitive string
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep my_string </pre>

===Default Map ID's===
datacenter

sand

bridge

containeryard

siberia (Prison Break)

hospital (Zombies map)

killhouse

range

tutorial

santorini

station

industry

ogcontainers (Shack only)

haguenau (Shack only)

foundation (Shack only)

stalingrad (PC only)

stalingrad_night (PC only)

santorini_night (PC only)

sand_night (PC only)

station_night (PC only)

industry_night (PC only)

bunker (PC only)

===Automated server log backup ===

here is how to setup a bash script to 1x a day compress all log files and save them to protect from auto deletion it will also post a discord webhook to confirm its working and saved the days logs

https://github.com/JTWP-org/backUpLogs

==Troubleshooting==

To run the server without outputting the heartbeat:

<pre>./PavlovServer.sh | sed '/heartbeat/d'</pre>

To monitor the logs (without heartbeat) from another terminal:

<pre>tail -f -n10000 /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep -v 'Sending heartbeat to masterserver'</pre>

Check your CPU Clock Speed with:

<pre>lscpu | grep MHz</pre>

=== Server won't start ===

Error message:
<pre>
ln: failed to create hard link '/home/steam/.steam/sdk64/steamclient.so': File exists
ln: failed to create hard link '/home/steam/pavlovserver/Pavlov/Binaries/Linux/steamclient.so': File exists
/home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer: error while loading shared libraries: libc++.so.1: cannot open shared object file: No such file or directory
</pre>

First two errors are harmless. The third one is because libc++ step was skipped or failed. Using sudo capable id (probably not steam id), [re]run this line:
<pre>sudo apt update && sudo apt install -y gdb curl lib32gcc1 libc++-dev unzip </pre>

=== Map wont load (kicks to datacenter)===

try deleting all the downloaded workshop maps with:

<pre>sudo rm -rf /tmp/workshop/7777/content/555160/*</pre> for all maps or

<pre>sudo rm -rf /tmp/workshop/7777/content/555160/whatever-UGC</pre> for specific map

===Map wont load when running in a container===
The three typical container problems I have seen:

1) Steam can't write to /tmp for some reason

2) /tmp is actually tmpfs instead of real filesystem and a few gigs of maps runs you out of RAM

3) Made worse by fact that pavlovserver unpacks downloads to ram, then writes to /tmp/workshop. Not enough RAM to do this, no map for you.

===Server stuck rotating forever===

Run these 2 commands, then restart your server:

<pre>cd ~/Steam && ./steamcmd.sh +login anonymous +app_update 1007 +quit
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so</pre>

If this doesn't fix it, double check that your server isn't running on the same port as another, by running this command:

<pre>ps -ef | grep pav</pre>

Then if 2 servers are on the same port, you can fix it by editing the pavlovserver.service file, and making sure the following line:

<pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -PORT=Number</pre>

has a unique number after the port for each server you're running.

=== Server - ping 999===
Google Cloud Platform - Make sure your compute engine has a network tag and your network rules are applied to the tag.
Make sure you opened the specified ports.

Network testing tools:
Test if your server will respond to ping from outside your network:
https://www.wormly.com/test-remote-ping

Test if your ports are accessible via UDP (7777,8177,9100):
https://www.ipvoid.com/udp-port-scan/

===Can't connect to RCON===
Check the file and group owner of RconSettings file. It should be steam, or the ID used to run the pavlov server.
<pre>
cd /home/steam/pavlovserver/Pavlov/Saved/Config
ls -la
</pre>

If the owner/group are not steam, using root or an id with sudo authority, change them to steam, confirm they are now set properly, then restart the pavlov server. (Note - if Rcon has wrong permissions, after fixing you should also to check the other config files like Game.ini, mods/blacklist/whitelist for the same issue. If steam can't access these files, it could cause problems.).
<pre>
cd /home/steam/pavlovserver/Pavlov/Saved/Config
sudo chown steam RconSettings.txt
sudo chgrp steam RconSettings.txt
ls -la </pre>

===PC ONLY - Map Download stops===

When downloading a large map from the steam workshop make sure your VPS/Dedi or Shared hosting provider (Otherwise known as a GSP's) has enough RAM assigned to store the map files in its tempfs (stored in ram)!

This is less likely to happen on Dedicated servers and VPS with a decent amount of ram unless you are using docker with RAM limits!

Most GSP's will be using docker or some other type of jailing method to limit system resource allocations and direct access to the host machine, if they are and you know what map you want to use make sure you order a service with enough ram to store your map. If in doubt contact your GSP's support team.

===Getting Help===

There's a #pc-custom-servers channel on the official Pavlov Discord - https://discord.gg/Pavlov-VR. Lots of helpful people there!
[[Category:RCON automation]]

Setting up a dedicated server

2023-05-26T05:17:23Z

SaltedCrackerJack: /* Automated RCON examples */

== Setting up a dedicated server ==

'''There are no Windows binaries'''

This guide is written exclusively for Linux and covers Ubuntu/Debian/Debian-like and Red Hat RPM-based distros. Possible to run with other distros, but some of the commands won't work and you will need to know enough to figure out the software install of dependencies on your own.

If you are considering hosting from home, please read that section of the wiki first.

This guide assumes you know the basics of using a bash terminal: ssh'ing into a server, running bash commands, editing text files, etc.

If you have no experience using bash, maybe start [https://www.howtogeek.com/140679/beginner-geek-how-to-start-using-the-linux-terminal/ here]. Editing text files via commandline is often a challenge. Suggest using nano and reading guide [https://www.howtogeek.com/howto/42980/the-beginners-guide-to-nano-the-linux-command-line-text-editor/ here]

If you are new to linux and accessing your server from Windows, highly suggest using MobaXterm as your SSH client as that can make required editing of text files easier using built in editor instead of the native linux command line editors.

And finally, ask yourself why you want to setup a server? If you look at the list, there are many, many more servers than players. If you don't have a team, discord community, or group of friends ready to play on your server, chances are it will go unused. Got one of these... great, let's go.

If you don't want to go through the hassle yourself and want to pay for a hosting service Arctic VR (PC and Shack) and Horde (Shack) provide a server hosting services and are trusted in the community. See links below.

----

=== Server Requirements ===

'''Pavlovserver can only be hosted under Linux.'''

This can be running as a VM under windows, but this will increase the complexity of the setup beyond this guide.

Ubuntu 18.04 x86_64, Ubuntu 19/04 amd64, Ubuntu 20.04, and Rocky Linux 8 are confirmed working. Ubuntu 15.04 x86 is known to fail to install using this guide. Recommend not running on "minimal" images as some tools are missing.

* 2GB RAM + 1GB RAM per each additional server with 10 players. More RAM is recommended for larger maps, higher player counts, or complex gamemodes. Not having enough RAM is a common cause of server crashes.

* A ~2.5Ghz CPU will comfortably support a 10 player server.

* A ~4Ghz CPU will comfortably support 24 players. This is a limit built into Pavlov itself, no server will allow players to join over 24. Lower player counts are recommended for complex gamemodes (E.g. CodZ) and/or highly detailed maps, so that maximum number will often be lower.

(Note that these are '''not''' hard limits for player counts, just suggestions for the best performance, based on experiences with many server providers on different grades of hardware.)

* Pavlovserver is functionally single threaded (one thread does vast majority of work). More CPUs only help if you are running more servers. More clockspeed = higher performance = more users per server.
The maximum number of servers you can run is dependent on how many CPUs you have. For example, if you have an 8 core CPU, the maximum number of servers would be 7. You should always have at least one CPU free as overhead, as Pavlov servers can use slightly more than one thread.

----

==== Hosting at home ====
When hosting at home there are additional requirements regarding networking: Your router has to support port-forwarding, hair-pinning/LoopbackNAT, and respond to ping requests. These techniques are necessary to allow your server to be found and to talk back to the client. please see https://en.wikipedia.org/wiki/Port_forwarding, https://en.wikipedia.org/wiki/Hairpinning, and https://www.speedguide.net/faq/how-to-become-pingable-behind-a-routerfirewall-376 for more info and google for these terms in addition to your router model to find guides on how to enable/configure it properly. If you have modern Router, it may have these features already enabled, in this case you just have to configure port-forwarding. If you can see your server but not join it while others can, this is indicative of a failure of LoopbackNAT.

A second challenge to hosting at home is CGNAT (Carrier grade NAT: https://www.a10networks.com/blog/carrier-grade-nat/). Just like NAT on your home network that has to be gotten around w/ port-forwarding, CGNAT breaks the ability of external connections to be made back to your server, but the controls are solely in your ISPs hands. Sometimes if you ask, you can be removed from CGNAT pools and/or assigned a static IP. CGNAT rollouts are becoming very common now, so if your server worked then doesn't allow connections now, your ISP may have made this change.

You can check whether you’re on a CGNAT network by visiting a Web site such as ipaddress.com or whatsmyip.com and comparing the IP address listed to the public/WAN IP address assigned to your Internet gateway. To find your gateway’s public IP address, check the status page in the administrative interface. If the two IP addresses differ, you’re likely on a CGNAT network. If so, this problem must be resolved before you go any further.

'''Not understanding these requirements and configuration is a frequent cause of failed setups and questions in discord. Don't skip this if you are trying to host from home'''

'''There are serious security implications of hosting this software at home.''' None of the devs are security experts and there has been no security review of the code. You are opening up your system to the world and publicity advertising this fact. Expect that any system hosting this software is open to compromise from the Internet and act accordingly. If your router offers a DMZ network, use it. Consider hosting on a cloud based server and think twice before running this software on any system that contains data you care about or has access to networks and computers you care about.

If you're hosting at home using Oracle's VirtualBox, there are steps you can take to prevent double NAT (which can cause issues later on)

1. Select your VM and then click Settings in VirtualBox's main window.

2. Click on Network and change Attached To from NAT to Bridged Adapter.

Once you've done this, your VM should be connected directly to your home router and double NAT should no longer be a issue.
----

==== Hosting Providers ====

Considering the suggested server specs, you may be interested in the following hosting providers. For providers promising dedicated "Pavlov hosting" as opposed to general VPS services please contact and ask how you change maps being hosted and how you get RCON access before you put your money down.

<pre>
Provider | Base CPU | Details
Arctic VR | 4.5 GHz | https://www.arctic-vr.com/server-hosting
Amazon Web Services | 4.0 GHz | https://aws.amazon.com/ec2/instance-types/z1d/
VULTR | 4.0 GHz | https://www.vultr.com/products/high-frequency-compute/
packet.com | 3.5 GHz | https://www.packet.com/cloud/servers/c1-small/
Google Cloud Platform | 3.2 GHz | https://cloud.google.com/compute/docs/cpu-platforms
</pre>

===== ARCTIC VR =====

Arctic VR is the largest and longest running Pavlov VR hosting provider. The In-Game Admin Menu is exclusive to the ArcticVR hosting service. They offer EU, NA East and NA West servers for both shack and PCVR. ArcticVR offers the fastest Pavlov servers as well as DDos Protection, RCON remote management, custom maps, low pings, unlimited slots, and expert support.

Website: https://www.arctic-vr.com/server-hosting

[[File:Arctic_options.png|link=https://www.arctic-vr.com/server-hosting|700px]]

===== VULTR =====

Consider using a referral from the community:

Carlos: https://www.vultr.com/?ref=8615589-6G

Carrot: https://www.vultr.com/?ref=8689348

Archaeo: https://www.vultr.com/?ref=8653652-6G

Cheeto: https://www.vultr.com/?ref=8717358

For a Pavlov Shack server, I recommend minimum Cloud Compute, Intel High Performance, Ubuntu 20.04, and disabled automatic backups. At the time, this was $6/m. Some of the cheap options have 1TB bandwidth, and some have 2TB+. If it's a personal server, 1TB could be fine, but 2TB should be safe.

===== Google Cloud Platform (90 day free credit available) =====

The below configuration is successfully running 4 pavlov PC instances with ~15 total maps and up to 24 players per server. If you want more maps use larger boot disk. Both can dynamically be scaled based on popularity.

<pre>

Menu -> compute engine -> VM instances
create instance
- region: wherever you like
- machine type: n1-highcpu-4 (4 vCPUs, 3.6 GB memory)
- boot disk: Ubuntu 20.04
- boot disk -> size: 25gb
- network tags: pavlov-server
- [create]

Menu -> Vpc network -> firewall rules
[Create firewall rule]
Name: pavlov server
Target Tags: pavlov-server
Source IP Ranges: 0.0.0.0/0
Protocols and Ports -> Specified protocols and ports -> UDP: 7777, 8177 (Shack and PC)
Protocols and Ports -> Specified protocols and ports -> TCP: 7777, 8177 (Shack-only)
Protocols and Ports -> Specified protocols and ports -> TCP: {RCON port - default 9100}
[save]
</pre>

===== Amazon Web Services (30 day free credit available) =====

<pre>
Login -> Change Region: Choose your region
Services -> Compute -> EC2 -> Create
Choose an AMI: Ubuntu 18.04
Instance Type: z1d.large

Instance Details -> Tenancy: Dedicated (optional: this will more than triple the cost)

Storage: 50gb disk (or whatever, you're in control of the map roster)

Security Groups:
Create a new Security Group
Security group name: pavlov-server
Description: pavlov server
Rules:
Type: Custom ICMP Rule - IPV4 / Protocol: Echo Request
Type: Custom UDP Rule / Port Range: 7777 / Source: 0.0.0.0/0
Type: Custom UDP Rule / Port Range: 8177 / Source: 0.0.0.0/0
Type: SSH (optional, but I assume you wanna SSH in..)

Launch -> Create new Keypair -> Download -> Launch

Once it's started, SSH in like:
$ ssh -i your-key.pem ubuntu@you-server-details.amazonaws.com

(I use cmder on Windows, if you're using putty or mobaxterm or something, might be different)
</pre>

=== Starting Server Install ===

====Obtaining an ApiKey====
For your server to show up in the server list, there is now a requirement to have an ApiKey issued by vankrupt. This is to prevent DOS attacks against the master server

Get the key by going here: https://pavlov-ms.vankrupt.com/servers/v1/key and using your mobile number to get a SMS
(note that there have been reported failures of this SMS system for non-US mobiles. In this case DM davevillz your mobile and ask for a key)

Put this key in your Game.ini as follows:
ApiKey="ABC123FALSEKEYDONTUSEME"
or if you would like (personally untested..I would use game.ini) you can call it at server runtime with flag as follows:
-KEY="ABC123FALSEKEYDONTUSEME"

This key can be re-used for a reasonable number of servers (a limit of 10 has been mentioned). Contact the Devs if you need more servers per key.

====System setup and software installation====

Install dependencies and create the `steam` user. (You only need to do this once):

Confirm Linux version
<pre>
lsb_release -a
</pre>

'''Ubuntu 20.04'''
<pre>
sudo apt update && sudo apt install -y gdb curl lib32gcc1 libc++-dev unzip
sudo useradd -m steam
</pre>

'''Ubuntu 20.10 or higher'''
<pre>
sudo apt update && sudo apt install -y gdb curl lib32gcc-s1 libc++-dev unzip
sudo useradd -m steam
</pre>

'''Rocky Linux, CentOS 8, and RHEL 8'''

<pre>
sudo sed -i 's/^SELINUX=enforcing$/SELINUX=permissive/g' /etc/selinux/config
sudo setenforce 0
sudo yum install gdb curl glibc.i686 libstdc++.i686 libstdc++-devel.i686 libstdc++-devel.x86_64 unzip wget -y
wget https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/l/libcxx-3.8.0-3.el7.x86_64.rpm
sudo rpm -i libcxx-3.8.0-3.el7.x86_64.rpm
sudo useradd -m steam
</pre>

[Optional] Set a password for steam.
<pre>sudo passwd steam</pre>

Login as the steam user. ('''You will need to do this each time you connect to your server'''):

<pre>
sudo su -l steam
</pre>

Install Steam:

<pre>
mkdir ~/Steam && cd ~/Steam && curl -sqL "https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz" | tar zxvf -
</pre>

There are different dedicated server versions for Pavlov Server - choose which server version you want to host (PC non-beta, PC Beta, Shack Live, or Shack RC)
(You will need to run this command each time there is a Pavlov Server update). 
To host '''PC Server (non-beta)''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 +exit
</pre>

To host '''PC BETA''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta beta_server +exit
</pre>

To host '''Shack Live''' (Quest):

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack +exit
</pre>

To host '''Shack RC''' (Quest): 

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack_beta +exit
</pre>

Now that we've installed the server, all pavlov server versions should continue. 
Install a fresh copy of steamclient.so (May have to do this after each update):
<pre>
~/Steam/steamcmd.sh +login anonymous +app_update 1007 +quit
mkdir -p ~/.steam/sdk64
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/pavlovserver/Pavlov/Binaries/Linux/steamclient.so
</pre>

Make the PavlovServer script executable. (You only need to do this once):

<pre>
chmod +x ~/pavlovserver/PavlovServer.sh
</pre>

----

=== Server Configuration ===

Before starting the server we need to configure it. Start by creating some directories:

<pre>
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Logs
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps
</pre>

==== Mods/Blacklist/Whitelist (optional) ====

The following three files allow you to specify mods, banned players, and whitelist players. These are optional, but go ahead and create them. Populating the files is described later.

<pre>
touch /home/steam/pavlovserver/Pavlov/Saved/Config/mods.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/blacklist.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/whitelist.txt
</pre>

====Configuring Game.ini====
Create a new Game.ini file using following command to open an editor and copy/paste the following block into it then save it. Note not all of these options are required. For instance remove or comment out the Password=0000 line to make a public server with no pin.
<pre>
nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini
</pre>

<pre>
[/Script/Pavlov.DedicatedServer]
bEnabled=true
ServerName="My_private_idaho"
MaxPlayers=10 #Set this to 10 for Shack. 24 is the max for PC, setting it higher will not allow players to join.
ApiKey="ABC123FALSEKEYDONTUSEME"
bSecured=true
bCustomServer=true
bVerboseLogging=false
bCompetitive=false #This only works for SND
bWhitelist=false
RefreshListTime=120
LimitedAmmoType=0
TickRate=90
TimeLimit=60
#Password=0000
#BalanceTableURL="vankruptgames/BalancingTable/main"
MapRotation=(MapId="UGC1758245796", GameMode="GUN")
MapRotation=(MapId="datacenter", GameMode="SND")
MapRotation=(MapId="sand", GameMode="DM")

</pre>

* '''bEnabled''' - whether the server appears in the server list (unconfirmed)
* '''ServerName''' - name it will be listed as. (approx 35 chars max)
* '''MaxPlayers''' - See suggested specs for limits. 10 standard (10 for shack), 20-24 is max recommended for large maps like Stalingrad or PUSH/RUSH modes, and servers allow a maximum of 24 players.
* '''ApiKey''' - Unique ApiKey required to register server with master server. Replace with your key
* '''bSecured''' - enabled Valve Anti-Cheat (VAC)
* '''bCustomServer''' - activates some new modding tools (save and http functions. Required to write to blacklist.txt for bans)
* '''bCompetitive''' - sets the server to competitive mode for SND. If removed the server will default to false
* '''bVerboseLogging''' - enables verbose logging, mostly detailed statistics. Be prepared for significant increase in logging.
* '''bWhitelist''' - Only allow users in whitelist.txt to join
* '''RefreshListTime''' - sets how often the running server checks for updates in ban/whitelist/mod files
* '''LimitedAmmoType''' - sets limited ammo mode
0 = Unlimited
1 = Limited Generic
2 = Limited Specific
3 = Custom (for modders)
4 = Limited Special
5 = Boxless Mode

* '''TimeLimit''' - sets time limit for each map
* '''TickRate''' - sets the server tickrate. (so far minimum stable seems around 50 and max around 120. Beware setting this changes weapon despawn time and breaks some game modes. Recommend not touching)
* '''Password''' - PIN number for server #FYI - this is now also changeable via rcon.
* '''BalanceTableURL''' - Points to a custom balance table from github. See https://github.com/vankruptgames/BalancingTable for instructions. This line isn't needed if you don't have one.
* '''MapRotation''' - you can add multiple of these. The MapId must be “UGC” followed by the map ID. you can find the map id in the URL of the steam workshop page. When a match ends, the server will load the next map in the rotation. You can also use RCON to switch to a map not included in rotation.

Available game modes as of 09/06/2022: SND, TDM, DM, GUN, ZWV, WW2GUN, TANKTDM, KOTH, TTT, OITC, INFECTION, HIDE, PUSH, PH 

And for Shack only: CTF

For maps running a Custom gamemode (CodZ, BR, Duel, etc.) it doesn't matter which gamemode you choose, as the map will automatically override it with the custom mode.

UGC###### are for custom maps from Steam workshop (PC Only). Find the map you want in the workshop. This is the URL for Mirage (https://steamcommunity.com/sharedfiles/filedetails/?id=2670152485). The 10 numbers at the end of the URL are what you need, so UGC1661803933 would be the MapId for Mirage.

==== Firewall/Port forwarding ====
Using the default settings there are two UDP ports (7777, 8177) that need to be allowed to access the server either by firewall setup or port forwarding.

'''Ubuntu''' firewall commands to check firewall and open ports:
<pre>
sudo ufw status
sudo ufw allow 7777
sudo ufw allow 8177
sudo ufw allow 9100
sudo ufw status
</pre>

'''Rocky Linux''' firewall commands to check firewall and open ports:
<pre>
sudo firewall-cmd --zone=public --add-port=7777/tcp
sudo firewall-cmd --zone=public --add-port=7777/udp
sudo firewall-cmd --zone=public --add-port=8177/tcp
sudo firewall-cmd --zone=public --add-port=8177/udp
sudo firewall-cmd --zone=public --add-port=9100/udp
sudo firewall-cmd --zone=public --add-port=9100/tcp
sudo firewall-cmd --list-ports
firewall-cmd --runtime-to-permanent
</pre>

You may also need to allow Pings (ICMP) for the server's true latency to appear in the master list.

If you are running multiple servers and have set additional ports (see http://wiki.pavlov-vr.com/index.php?title=Dedicated_server#Running_multiple_servers_on_one_host) then you need to allow access to the defined port plus the port 400 higher. So if you use 7000 as your port, then UDP 7000 and 7400 need to be open

If you have setup rcon via RconSettings.txt (below) then that port also need to be allowed access via TCP

If you are running Shack/Quest and want to have maps that are downloadable from your server, your server ports (ex. 7777 & 8177) must also be open via TCP

----

==== Shack Maps (Quest) ====

If you try to use the steps above to add maps for Shack, youll run into issues very quickly. This is because Shack has no affiliation to Steam, and therefore cannot use Steam Workshop maps like above. In the future, these steps will apply to PC servers as well, allowing a server to hold the map itself, instead of offloading to Steam.

To get started, first create the directory to hold the maps

<pre>mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps</pre>

You can use any number of methods to move the map files onto the server, but ill go over the two simplest, starting with a GUI approach

Download and install CyberDuck onto your "home" PC (Whatever PC you use for access to the server, but not the server itsself): https://cyberduck.io/

Next, download and unzip your map of choice from https://www.pavlovquest.com/ , https://pavlovhorde.com/mapsList, or look in #shack-map-showcase channel in the discord server. I'm going to use Cheeto's WW2 Items test (http://www.mediafire.com/file/emyt9bs1z9u9ykw/SVR_Cheeto_Items.zip/file ) for this example, you do what you like

In the top left corner, open a connection, set the connection type to SFTP, and fill in the rest of the information. User will be root, password is whatever you set the root pw as (toor in Ubuntu by default)

In the directory dropdown (itll say /root) go back to /

Follow the directories until we arrive back at our "maps" folder <pre>/home/steam/pavlovserver/Pavlov/Saved/maps</pre>

Drag and drop the unzipped map folder into the main window, in this case itll be SVR_Cheeto_Items

Hit Allow

Youll now see a folder named SVR_Cheeto_Items, and within it should be nothing but 3 files. If there is another folder in it, move this folder to the maps directory, otherwise the server wont work. The 3 files (2 .PAK one .JSON) should be in home/steam/pavlovserver/Pavlov/Saved/maps/SVR_Cheeto_Items, no more, no less.

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

To play the map, you can either use RCON switch map command, or to add the map to your servers automatic map rotation list, add the map's folder name to your Game.ini. This replaces the MapID section, so for our example it would be

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

And thats all! Disconnect CyberDuck from your server before playing, otherwise youll have difficulty joining.

-----------

==== Adding Shack Maps over Command Line Interface ====

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

A bit more complicated, but adding maps over CLI has its benefits

First, CD to the maps directory you made above

<pre>cd ~/pavlovserver/Pavlov/Saved/maps</pre>

Download the map files from whatever you use to upload them. To do this, you can either use curl or wget

<pre>curl -O insertURLhere</pre>

'''If you download your map from Google Drive''', make sure that your .zip folder is shared to anyone.
Then, get the file's url from the shared link. Example : ''<nowiki>https://drive.google.com/file/d/19bI8gUHaN5tUrDvnadAacUnchQf6_k/view</nowiki>'' will be ''19bI8gUHaN5tUrDvnadAacUnchQf6_k''
Edit "fileId" and "fileName" before you execute the command.
<pre>
fileId=19bI8gUHaN5tUrDvnadAacUnchQf6_k
fileName=SVR_USER_MAPNAME
curl -sc /tmp/cookie "https://drive.google.com/uc?export=download&id=${fileId}" > /dev/null
code="$(awk '/_warning_/ {print $NF}' /tmp/cookie)"
curl -Lb /tmp/cookie "https://drive.google.com/uc?export=download&confirm=${code}&id=${fileId}" -o ${fileName} </pre>

To keep with the Items example:

<pre>curl -O https://cdn.discordapp.com/attachments/744185280759857234/745027406695366788/SVR_Cheeto_Items.zip</pre>

Next, unzip the file. If this next step errors out, saying the command is unknown, switch back to the root user (su root), and install unzip (sudo apt install unzip), then return to the steam user, and continue.

<pre>unzip SVR_Cheeto_Items.zip</pre>

Now finish like before by adding the map to your Game.ini

<pre>nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini</pre>

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

==== Admin/Moderator list (optional) ====

The only working in-game admin menu is through Arctic VR server hosting (see below).

If you add moderators to your server, they will not be subject to vote kicks.

<pre>
nano ~/pavlovserver/Pavlov/Saved/Config/mods.txt
</pre>

Example Mod List:
<pre>
76541198397498572 #Optional Comment: Player name
76541198397498573 #Some Other Player
</pre>

==== ArcticVR Admin Menu ====

[[File:Arcticmenu.jpg|500px|link=https://www.arctic-vr.com/server-admin-menu]]

Arctic-VR Offers an advanced In-Game Admin menu that is exclusive to their hosting service. Features include:
* Switch Maps+Modes
* Teleport Players to Players
* Change Player Skins
* Control Player Buying+Cash
* Spawn Items
* Clean up corpses + guns
* Spawn Bots
* Spawn Items for other players
* Control Teams + Balance/Shuffle Teams
* ResetSND
* And More

You can read more about the ArcticVR admin menu on their website: https://www.arctic-vr.com/server-admin-menu

==== Handy tools for finding steamIDs ====

Steam ID finder: https://steamidfinder.com/lookup/ or https://steamid.xyz/

You want to enter in the steamID64 format.

This tool can convert or lookup IDs: https://steamid.io/

If you are looking for a steamID of a player that has been on your server recently this is technique to find them:
<pre>
grep -i playername ~/pavlovserver/Pavlov/Saved/Logs/* | grep TicketValidation
</pre>

=== Configure Rcon ===
To enable Rcon access create config file:
<pre> nano /home/steam/pavlovserver/Pavlov/Saved/Config/RconSettings.txt </pre>

Copy in the following text - change password, and if desired the port:
<pre>
Password=ChangeThisPassword
Port=9100
</pre>
You must specify a port for the Rcon server to use as well as a Password (use a different port per sever instance if running multiple server instances off the same hardware)

=== Starting the server ===

<pre>
cd ~/pavlovserver && ./PavlovServer.sh
</pre>

That's it, your server will be automatically broadcast to the master server! :)

Two handy tools to determine quickly if your server is broadcasting are [https://pablub.xyz/ Pablub] (PC only) and [https://pavlovhorde.com/ Horde] (Shack) and [https://pavlovhorde.com/pcServers Horde] (PC version)

Note that when you close your terminal, the server will go down. See the "supervisors" section below for how to prevent this.

=== Auto-updating the server ===

Assuming you have followed this guide and used the default paths, users, and install instructions, you can paste the following into your terminal to auto-update your Pavlov server:

<pre>
cat << 'EOF' > $HOME/pavlov_daily_update_and_restart.sh
#!/bin/bash

USER="steam"
SERVICENAME="pavlovserver.service"
INSTALLDIRNAME="pavlovserver"
USERHOME="/home/$USER"

echo -e "Beginning Pavlov VR update run on $(date)\n\n"

systemctl stop "$SERVICENAME"

sleep 5
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +force_install_dir "$USERHOME/$INSTALLDIRNAME" +app_update 622970 +exit
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +app_update 1007 +quit
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/.steam/sdk64/steamclient.so"
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/pavlovserver/Pavlov/Binaries/Linux/steamclient.so"

systemctl start "$SERVICENAME"

echo -e "Ending Pavlov VR update run on $(date)\n\n"

EOF

chmod +x $HOME/pavlov_daily_update_and_restart.sh
mkdir $HOME/pavlov_update_logs && touch $HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log
CRONLINE="00 2 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
(sudo crontab -u root -l; echo "$CRONLINE" ) | sudo crontab -u root -
unset CRONLINE

</pre>

These commands will:

1. Create a shell script in the "steam" user's home directory that automatically stops the Pavlov server, pulls any updates via steam, pull updates to the Steamworks SDK Redist, and copies the latest version of steamclient.so to the Pavlov server directory

2. Make the shell script executable

3. Create a new directory called "pavlov_update_logs" in the "steam" user's directory, and create a logfile inside that directory called "pavlov_daily_update_and_restart.sh.log". You can check this logfile to see the output of the Pavlov and Steam SDK update commands.

4. Create a crontab entry for the root user that runs this shell script automatically every day at 2:00AM local time

If you want to change the time that this script runs, edit the numbers "00 2" in the line that starts with "CRONLINE=". In the example provided, 00 is the minutes column, and 2 is the hour column. For example, if you wanted the server to automatically update and restart at 4:17AM every day, change the line starting with "CRONLINE=" to:

<pre>
CRONLINE="17 4 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
</pre>

If the time is PM, use 24-hour time format, e.g. "32 18" for 6:32PM.

----

=== Supervising the server using systemd ===

Running '''./PavlovServer.sh''' in your interactive shell is easy, but the server will shut down when you close your terminal. If you want to run the server in the background,
you'll want to run it under a supervisor. There are many options, ranging from the simple (nohup, screen or tmux), to the
more robust (supervisord, systemd).

Systemd is running by default on Ubuntu Linux, so we'll use that here.

To run the server as a systemd service, create the file '''/etc/systemd/system/pavlovserver.service''' (as root) by typing
<pre>
sudo nano /etc/systemd/system/pavlovserver.service
</pre>

Copy contents below into the file and save.

<pre>
[Unit]
Description=Pavlov VR dedicated server

[Service]
Type=simple
WorkingDirectory=/home/steam/pavlovserver
ExecStart=/home/steam/pavlovserver/PavlovServer.sh

RestartSec=1
Restart=always
User=steam
Group=steam

[Install]
WantedBy = multi-user.target
</pre>

If you'd like your server to start as competitive without editing the game.ini, change the line "ExecStart=/home/steam/pavlovserver/PavlovServer.sh" to look like this below. Though it's much easier to just use the game.ini to enable competitive instead. <pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -COMPETITIVE=1</pre>

Change the user or paths as appropriate. After saving the service file, to start, restart, stop, or monitor the server:

<pre>
sudo systemctl start pavlovserver
sudo systemctl restart pavlovserver
sudo systemctl stop pavlovserver
sudo systemctl status pavlovserver
</pre>

To view the logs:

<pre>
sudo journalctl -u pavlovserver
# to live-tail the logs
sudo journalctl -u pavlovserver -f
</pre>

If you want to run the pavlov server as soon as your server boots (e.g. a VPS you turn on and off), add pavlov as a startup service:

<pre>
sudo systemctl enable pavlovserver
</pre>

----

== Advanced Server Administration ==

=== Running multiple servers on one host ===

* Pavlovserver is functionally single threaded (there are multiple threads, but vast majority of work occurs in the primary one). Make sure you have # of pavlovservers + 1 CPU available. More CPUs= more servers. Faster CPU = more players.
* Make multiple server installs by defining a separate install dir for each server.
* Run each server with a unique port. eg: '''./PavlovServer.sh -PORT="Desired Port"'''
* The Server will use the Desired Port and the Port 400 above (Example: You choose 8200 as Port. So Port 8600 will be used as well)
* If you are using RCON, each server will need a unique port defined in RconSettings.txt
* Ensure the ports are forwarded and opened in your firewall

To duplicate directories:

be in the steam home folder
<pre>
cp -r pavlovserver pavlovserver1
/home/steam/pavlovserver1/PavlovServer.sh -PORT=[Desired Port]
</pre>

=== Starting server in competitive mode ===
Competitive mode will prevent dead teammates from being able to see the match, to prevent ghosting.
You can either enable this via Game.ini (described in Game.ini file), or using the -COMPETITIVE=1 parameter.

<pre>
/home/steam/pavlovserver1/PavlovServer.sh -COMPETITIVE=1
</pre>

== Automated RCON examples ==
here are some examples of scripts that interact with Pavlov RCON

* '''<big>Inspect players every 5 minutes</big>''' [https://github.com/JTWP-org/inspect-every-5-mins (INSTALL FROM GIT )]

This [https://www.gnu.org/software/bash/ BASH] script connects to the server u set in the config with [https://netcat.sourceforge.net/ NETCAT] 2 times every 5 min and it uses RCON commands [[Rcon Overview and Commands|RefreshList ServerInfo]] &.<code>InspectPlayer {UniqueID} to build stats for the current round stats are then appended over the last one collected</code>

as for the 5 min timer we use a [https://www.google.com/url?sa=t&rct=j&q=&esrc=s&source=web&cd=&ved=2ahUKEwj_y-OQnZL_AhWqlIkEHaudB94QFnoECAwQAQ&url=https%3A%2F%2Fdocs.spring.io%2Fspring-framework%2Fdocs%2Fcurrent%2Fjavadoc-api%2Forg%2Fspringframework%2Fscheduling%2Fconfig%2FCronTask.html&usg=AOvVaw1l8F8C093jQ_1pJMilPnPY crontask]

{| class="wikitable"

|}

----

===Useful Linux Commands===

List files / folders in directory, print current working directory,
<pre>ls -la #list files/directories along with authorities and ownership
pwd #print working directory
sudo chown <owner> <file/directory> #change owner of file/directory. If root created something and you need to change it to steam
sudo chgrp <group> <file/directory> #change group of file/directory.
</pre>

Check if pavlov is running by checking process status. If the only row you see is the grep command, pavlov server is not started.
<pre> ps -ef | grep pav </pre>

Sample output:
<pre>
steam 34044 1 0 16:52 ? 00:00:00 /bin/sh /home/steam/pavlovserver/PavlovServer.sh
steam 34066 34044 80 16:52 ? 00:00:04 /home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer
zombies+ 34101 34013 0 16:52 pts/0 00:00:00 grep --color=auto pav
</pre>

Kill a process. Note this command uses 34044, which is a process id from the command output above.
<pre> kill -9 34044 </pre>

Dump the log to the console so you can scroll through it:
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log </pre>

Search the log for a string - replace my_string with case-sensitive string
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep my_string </pre>

===Default Map ID's===
datacenter

sand

bridge

containeryard

siberia (Prison Break)

hospital (Zombies map)

killhouse

range

tutorial

santorini

station

industry

ogcontainers (Shack only)

haguenau (Shack only)

foundation (Shack only)

stalingrad (PC only)

stalingrad_night (PC only)

santorini_night (PC only)

sand_night (PC only)

station_night (PC only)

industry_night (PC only)

bunker (PC only)

===Automated server log backup ===

here is how to setup a bash script to 1x a day compress all log files and save them to protect from auto deletion it will also post a discord webhook to confirm its working and saved the days logs

https://github.com/JTWP-org/backUpLogs

==Troubleshooting==

To run the server without outputting the heartbeat:

<pre>./PavlovServer.sh | sed '/heartbeat/d'</pre>

To monitor the logs (without heartbeat) from another terminal:

<pre>tail -f -n10000 /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep -v 'Sending heartbeat to masterserver'</pre>

Check your CPU Clock Speed with:

<pre>lscpu | grep MHz</pre>

=== Server won't start ===

Error message:
<pre>
ln: failed to create hard link '/home/steam/.steam/sdk64/steamclient.so': File exists
ln: failed to create hard link '/home/steam/pavlovserver/Pavlov/Binaries/Linux/steamclient.so': File exists
/home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer: error while loading shared libraries: libc++.so.1: cannot open shared object file: No such file or directory
</pre>

First two errors are harmless. The third one is because libc++ step was skipped or failed. Using sudo capable id (probably not steam id), [re]run this line:
<pre>sudo apt update && sudo apt install -y gdb curl lib32gcc1 libc++-dev unzip </pre>

=== Map wont load (kicks to datacenter)===

try deleting all the downloaded workshop maps with:

<pre>sudo rm -rf /tmp/workshop/7777/content/555160/*</pre> for all maps or

<pre>sudo rm -rf /tmp/workshop/7777/content/555160/whatever-UGC</pre> for specific map

===Map wont load when running in a container===
The three typical container problems I have seen:

1) Steam can't write to /tmp for some reason

2) /tmp is actually tmpfs instead of real filesystem and a few gigs of maps runs you out of RAM

3) Made worse by fact that pavlovserver unpacks downloads to ram, then writes to /tmp/workshop. Not enough RAM to do this, no map for you.

===Server stuck rotating forever===

Run these 2 commands, then restart your server:

<pre>cd ~/Steam && ./steamcmd.sh +login anonymous +app_update 1007 +quit
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so</pre>

If this doesn't fix it, double check that your server isn't running on the same port as another, by running this command:

<pre>ps -ef | grep pav</pre>

Then if 2 servers are on the same port, you can fix it by editing the pavlovserver.service file, and making sure the following line:

<pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -PORT=Number</pre>

has a unique number after the port for each server you're running.

=== Server - ping 999===
Google Cloud Platform - Make sure your compute engine has a network tag and your network rules are applied to the tag.
Make sure you opened the specified ports.

Network testing tools:
Test if your server will respond to ping from outside your network:
https://www.wormly.com/test-remote-ping

Test if your ports are accessible via UDP (7777,8177,9100):
https://www.ipvoid.com/udp-port-scan/

===Can't connect to RCON===
Check the file and group owner of RconSettings file. It should be steam, or the ID used to run the pavlov server.
<pre>
cd /home/steam/pavlovserver/Pavlov/Saved/Config
ls -la
</pre>

If the owner/group are not steam, using root or an id with sudo authority, change them to steam, confirm they are now set properly, then restart the pavlov server. (Note - if Rcon has wrong permissions, after fixing you should also to check the other config files like Game.ini, mods/blacklist/whitelist for the same issue. If steam can't access these files, it could cause problems.).
<pre>
cd /home/steam/pavlovserver/Pavlov/Saved/Config
sudo chown steam RconSettings.txt
sudo chgrp steam RconSettings.txt
ls -la </pre>

===PC ONLY - Map Download stops===

When downloading a large map from the steam workshop make sure your VPS/Dedi or Shared hosting provider (Otherwise known as a GSP's) has enough RAM assigned to store the map files in its tempfs (stored in ram)!

This is less likely to happen on Dedicated servers and VPS with a decent amount of ram unless you are using docker with RAM limits!

Most GSP's will be using docker or some other type of jailing method to limit system resource allocations and direct access to the host machine, if they are and you know what map you want to use make sure you order a service with enough ram to store your map. If in doubt contact your GSP's support team.

===Getting Help===

There's a #pc-custom-servers channel on the official Pavlov Discord - https://discord.gg/Pavlov-VR. Lots of helpful people there!
[[Category:RCON automation]]

Setting up a dedicated server

2023-05-26T03:58:51Z

SaltedCrackerJack: /* Automated RCON examples */

== Setting up a dedicated server ==

'''There are no Windows binaries'''

This guide is written exclusively for Linux and covers Ubuntu/Debian/Debian-like and Red Hat RPM-based distros. Possible to run with other distros, but some of the commands won't work and you will need to know enough to figure out the software install of dependencies on your own.

If you are considering hosting from home, please read that section of the wiki first.

This guide assumes you know the basics of using a bash terminal: ssh'ing into a server, running bash commands, editing text files, etc.

If you have no experience using bash, maybe start [https://www.howtogeek.com/140679/beginner-geek-how-to-start-using-the-linux-terminal/ here]. Editing text files via commandline is often a challenge. Suggest using nano and reading guide [https://www.howtogeek.com/howto/42980/the-beginners-guide-to-nano-the-linux-command-line-text-editor/ here]

If you are new to linux and accessing your server from Windows, highly suggest using MobaXterm as your SSH client as that can make required editing of text files easier using built in editor instead of the native linux command line editors.

And finally, ask yourself why you want to setup a server? If you look at the list, there are many, many more servers than players. If you don't have a team, discord community, or group of friends ready to play on your server, chances are it will go unused. Got one of these... great, let's go.

If you don't want to go through the hassle yourself and want to pay for a hosting service Arctic VR (PC and Shack) and Horde (Shack) provide a server hosting services and are trusted in the community. See links below.

----

=== Server Requirements ===

'''Pavlovserver can only be hosted under Linux.'''

This can be running as a VM under windows, but this will increase the complexity of the setup beyond this guide.

Ubuntu 18.04 x86_64, Ubuntu 19/04 amd64, Ubuntu 20.04, and Rocky Linux 8 are confirmed working. Ubuntu 15.04 x86 is known to fail to install using this guide. Recommend not running on "minimal" images as some tools are missing.

* 2GB RAM + 1GB RAM per each additional server with 10 players. More RAM is recommended for larger maps, higher player counts, or complex gamemodes. Not having enough RAM is a common cause of server crashes.

* A ~2.5Ghz CPU will comfortably support a 10 player server.

* A ~4Ghz CPU will comfortably support 24 players. This is a limit built into Pavlov itself, no server will allow players to join over 24. Lower player counts are recommended for complex gamemodes (E.g. CodZ) and/or highly detailed maps, so that maximum number will often be lower.

(Note that these are '''not''' hard limits for player counts, just suggestions for the best performance, based on experiences with many server providers on different grades of hardware.)

* Pavlovserver is functionally single threaded (one thread does vast majority of work). More CPUs only help if you are running more servers. More clockspeed = higher performance = more users per server.
The maximum number of servers you can run is dependent on how many CPUs you have. For example, if you have an 8 core CPU, the maximum number of servers would be 7. You should always have at least one CPU free as overhead, as Pavlov servers can use slightly more than one thread.

----

==== Hosting at home ====
When hosting at home there are additional requirements regarding networking: Your router has to support port-forwarding, hair-pinning/LoopbackNAT, and respond to ping requests. These techniques are necessary to allow your server to be found and to talk back to the client. please see https://en.wikipedia.org/wiki/Port_forwarding, https://en.wikipedia.org/wiki/Hairpinning, and https://www.speedguide.net/faq/how-to-become-pingable-behind-a-routerfirewall-376 for more info and google for these terms in addition to your router model to find guides on how to enable/configure it properly. If you have modern Router, it may have these features already enabled, in this case you just have to configure port-forwarding. If you can see your server but not join it while others can, this is indicative of a failure of LoopbackNAT.

A second challenge to hosting at home is CGNAT (Carrier grade NAT: https://www.a10networks.com/blog/carrier-grade-nat/). Just like NAT on your home network that has to be gotten around w/ port-forwarding, CGNAT breaks the ability of external connections to be made back to your server, but the controls are solely in your ISPs hands. Sometimes if you ask, you can be removed from CGNAT pools and/or assigned a static IP. CGNAT rollouts are becoming very common now, so if your server worked then doesn't allow connections now, your ISP may have made this change.

You can check whether you’re on a CGNAT network by visiting a Web site such as ipaddress.com or whatsmyip.com and comparing the IP address listed to the public/WAN IP address assigned to your Internet gateway. To find your gateway’s public IP address, check the status page in the administrative interface. If the two IP addresses differ, you’re likely on a CGNAT network. If so, this problem must be resolved before you go any further.

'''Not understanding these requirements and configuration is a frequent cause of failed setups and questions in discord. Don't skip this if you are trying to host from home'''

'''There are serious security implications of hosting this software at home.''' None of the devs are security experts and there has been no security review of the code. You are opening up your system to the world and publicity advertising this fact. Expect that any system hosting this software is open to compromise from the Internet and act accordingly. If your router offers a DMZ network, use it. Consider hosting on a cloud based server and think twice before running this software on any system that contains data you care about or has access to networks and computers you care about.

If you're hosting at home using Oracle's VirtualBox, there are steps you can take to prevent double NAT (which can cause issues later on)

1. Select your VM and then click Settings in VirtualBox's main window.

2. Click on Network and change Attached To from NAT to Bridged Adapter.

Once you've done this, your VM should be connected directly to your home router and double NAT should no longer be a issue.
----

==== Hosting Providers ====

Considering the suggested server specs, you may be interested in the following hosting providers. For providers promising dedicated "Pavlov hosting" as opposed to general VPS services please contact and ask how you change maps being hosted and how you get RCON access before you put your money down.

<pre>
Provider | Base CPU | Details
Arctic VR | 4.5 GHz | https://www.arctic-vr.com/server-hosting
Amazon Web Services | 4.0 GHz | https://aws.amazon.com/ec2/instance-types/z1d/
VULTR | 4.0 GHz | https://www.vultr.com/products/high-frequency-compute/
packet.com | 3.5 GHz | https://www.packet.com/cloud/servers/c1-small/
Google Cloud Platform | 3.2 GHz | https://cloud.google.com/compute/docs/cpu-platforms
</pre>

===== ARCTIC VR =====

Arctic VR is the largest and longest running Pavlov VR hosting provider. The In-Game Admin Menu is exclusive to the ArcticVR hosting service. They offer EU, NA East and NA West servers for both shack and PCVR. ArcticVR offers the fastest Pavlov servers as well as DDos Protection, RCON remote management, custom maps, low pings, unlimited slots, and expert support.

Website: https://www.arctic-vr.com/server-hosting

[[File:Arctic_options.png|link=https://www.arctic-vr.com/server-hosting|700px]]

===== VULTR =====

Consider using a referral from the community:

Carlos: https://www.vultr.com/?ref=8615589-6G

Carrot: https://www.vultr.com/?ref=8689348

Archaeo: https://www.vultr.com/?ref=8653652-6G

Cheeto: https://www.vultr.com/?ref=8717358

For a Pavlov Shack server, I recommend minimum Cloud Compute, Intel High Performance, Ubuntu 20.04, and disabled automatic backups. At the time, this was $6/m. Some of the cheap options have 1TB bandwidth, and some have 2TB+. If it's a personal server, 1TB could be fine, but 2TB should be safe.

===== Google Cloud Platform (90 day free credit available) =====

The below configuration is successfully running 4 pavlov PC instances with ~15 total maps and up to 24 players per server. If you want more maps use larger boot disk. Both can dynamically be scaled based on popularity.

<pre>

Menu -> compute engine -> VM instances
create instance
- region: wherever you like
- machine type: n1-highcpu-4 (4 vCPUs, 3.6 GB memory)
- boot disk: Ubuntu 20.04
- boot disk -> size: 25gb
- network tags: pavlov-server
- [create]

Menu -> Vpc network -> firewall rules
[Create firewall rule]
Name: pavlov server
Target Tags: pavlov-server
Source IP Ranges: 0.0.0.0/0
Protocols and Ports -> Specified protocols and ports -> UDP: 7777, 8177 (Shack and PC)
Protocols and Ports -> Specified protocols and ports -> TCP: 7777, 8177 (Shack-only)
Protocols and Ports -> Specified protocols and ports -> TCP: {RCON port - default 9100}
[save]
</pre>

===== Amazon Web Services (30 day free credit available) =====

<pre>
Login -> Change Region: Choose your region
Services -> Compute -> EC2 -> Create
Choose an AMI: Ubuntu 18.04
Instance Type: z1d.large

Instance Details -> Tenancy: Dedicated (optional: this will more than triple the cost)

Storage: 50gb disk (or whatever, you're in control of the map roster)

Security Groups:
Create a new Security Group
Security group name: pavlov-server
Description: pavlov server
Rules:
Type: Custom ICMP Rule - IPV4 / Protocol: Echo Request
Type: Custom UDP Rule / Port Range: 7777 / Source: 0.0.0.0/0
Type: Custom UDP Rule / Port Range: 8177 / Source: 0.0.0.0/0
Type: SSH (optional, but I assume you wanna SSH in..)

Launch -> Create new Keypair -> Download -> Launch

Once it's started, SSH in like:
$ ssh -i your-key.pem ubuntu@you-server-details.amazonaws.com

(I use cmder on Windows, if you're using putty or mobaxterm or something, might be different)
</pre>

=== Starting Server Install ===

====Obtaining an ApiKey====
For your server to show up in the server list, there is now a requirement to have an ApiKey issued by vankrupt. This is to prevent DOS attacks against the master server

Get the key by going here: https://pavlov-ms.vankrupt.com/servers/v1/key and using your mobile number to get a SMS
(note that there have been reported failures of this SMS system for non-US mobiles. In this case DM davevillz your mobile and ask for a key)

Put this key in your Game.ini as follows:
ApiKey="ABC123FALSEKEYDONTUSEME"
or if you would like (personally untested..I would use game.ini) you can call it at server runtime with flag as follows:
-KEY="ABC123FALSEKEYDONTUSEME"

This key can be re-used for a reasonable number of servers (a limit of 10 has been mentioned). Contact the Devs if you need more servers per key.

====System setup and software installation====

Install dependencies and create the `steam` user. (You only need to do this once):

Confirm Linux version
<pre>
lsb_release -a
</pre>

'''Ubuntu 20.04'''
<pre>
sudo apt update && sudo apt install -y gdb curl lib32gcc1 libc++-dev unzip
sudo useradd -m steam
</pre>

'''Ubuntu 20.10 or higher'''
<pre>
sudo apt update && sudo apt install -y gdb curl lib32gcc-s1 libc++-dev unzip
sudo useradd -m steam
</pre>

'''Rocky Linux, CentOS 8, and RHEL 8'''

<pre>
sudo sed -i 's/^SELINUX=enforcing$/SELINUX=permissive/g' /etc/selinux/config
sudo setenforce 0
sudo yum install gdb curl glibc.i686 libstdc++.i686 libstdc++-devel.i686 libstdc++-devel.x86_64 unzip wget -y
wget https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/l/libcxx-3.8.0-3.el7.x86_64.rpm
sudo rpm -i libcxx-3.8.0-3.el7.x86_64.rpm
sudo useradd -m steam
</pre>

[Optional] Set a password for steam.
<pre>sudo passwd steam</pre>

Login as the steam user. ('''You will need to do this each time you connect to your server'''):

<pre>
sudo su -l steam
</pre>

Install Steam:

<pre>
mkdir ~/Steam && cd ~/Steam && curl -sqL "https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz" | tar zxvf -
</pre>

There are different dedicated server versions for Pavlov Server - choose which server version you want to host (PC non-beta, PC Beta, Shack Live, or Shack RC)
(You will need to run this command each time there is a Pavlov Server update). 
To host '''PC Server (non-beta)''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 +exit
</pre>

To host '''PC BETA''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta beta_server +exit
</pre>

To host '''Shack Live''' (Quest):

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack +exit
</pre>

To host '''Shack RC''' (Quest): 

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack_beta +exit
</pre>

Now that we've installed the server, all pavlov server versions should continue. 
Install a fresh copy of steamclient.so (May have to do this after each update):
<pre>
~/Steam/steamcmd.sh +login anonymous +app_update 1007 +quit
mkdir -p ~/.steam/sdk64
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/pavlovserver/Pavlov/Binaries/Linux/steamclient.so
</pre>

Make the PavlovServer script executable. (You only need to do this once):

<pre>
chmod +x ~/pavlovserver/PavlovServer.sh
</pre>

----

=== Server Configuration ===

Before starting the server we need to configure it. Start by creating some directories:

<pre>
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Logs
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps
</pre>

==== Mods/Blacklist/Whitelist (optional) ====

The following three files allow you to specify mods, banned players, and whitelist players. These are optional, but go ahead and create them. Populating the files is described later.

<pre>
touch /home/steam/pavlovserver/Pavlov/Saved/Config/mods.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/blacklist.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/whitelist.txt
</pre>

====Configuring Game.ini====
Create a new Game.ini file using following command to open an editor and copy/paste the following block into it then save it. Note not all of these options are required. For instance remove or comment out the Password=0000 line to make a public server with no pin.
<pre>
nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini
</pre>

<pre>
[/Script/Pavlov.DedicatedServer]
bEnabled=true
ServerName="My_private_idaho"
MaxPlayers=10 #Set this to 10 for Shack. 24 is the max for PC, setting it higher will not allow players to join.
ApiKey="ABC123FALSEKEYDONTUSEME"
bSecured=true
bCustomServer=true
bVerboseLogging=false
bCompetitive=false #This only works for SND
bWhitelist=false
RefreshListTime=120
LimitedAmmoType=0
TickRate=90
TimeLimit=60
#Password=0000
#BalanceTableURL="vankruptgames/BalancingTable/main"
MapRotation=(MapId="UGC1758245796", GameMode="GUN")
MapRotation=(MapId="datacenter", GameMode="SND")
MapRotation=(MapId="sand", GameMode="DM")

</pre>

* '''bEnabled''' - whether the server appears in the server list (unconfirmed)
* '''ServerName''' - name it will be listed as. (approx 35 chars max)
* '''MaxPlayers''' - See suggested specs for limits. 10 standard (10 for shack), 20-24 is max recommended for large maps like Stalingrad or PUSH/RUSH modes, and servers allow a maximum of 24 players.
* '''ApiKey''' - Unique ApiKey required to register server with master server. Replace with your key
* '''bSecured''' - enabled Valve Anti-Cheat (VAC)
* '''bCustomServer''' - activates some new modding tools (save and http functions. Required to write to blacklist.txt for bans)
* '''bCompetitive''' - sets the server to competitive mode for SND. If removed the server will default to false
* '''bVerboseLogging''' - enables verbose logging, mostly detailed statistics. Be prepared for significant increase in logging.
* '''bWhitelist''' - Only allow users in whitelist.txt to join
* '''RefreshListTime''' - sets how often the running server checks for updates in ban/whitelist/mod files
* '''LimitedAmmoType''' - sets limited ammo mode
0 = Unlimited
1 = Limited Generic
2 = Limited Specific
3 = Custom (for modders)
4 = Limited Special
5 = Boxless Mode

* '''TimeLimit''' - sets time limit for each map
* '''TickRate''' - sets the server tickrate. (so far minimum stable seems around 50 and max around 120. Beware setting this changes weapon despawn time and breaks some game modes. Recommend not touching)
* '''Password''' - PIN number for server #FYI - this is now also changeable via rcon.
* '''BalanceTableURL''' - Points to a custom balance table from github. See https://github.com/vankruptgames/BalancingTable for instructions. This line isn't needed if you don't have one.
* '''MapRotation''' - you can add multiple of these. The MapId must be “UGC” followed by the map ID. you can find the map id in the URL of the steam workshop page. When a match ends, the server will load the next map in the rotation. You can also use RCON to switch to a map not included in rotation.

Available game modes as of 09/06/2022: SND, TDM, DM, GUN, ZWV, WW2GUN, TANKTDM, KOTH, TTT, OITC, INFECTION, HIDE, PUSH, PH 

And for Shack only: CTF

For maps running a Custom gamemode (CodZ, BR, Duel, etc.) it doesn't matter which gamemode you choose, as the map will automatically override it with the custom mode.

UGC###### are for custom maps from Steam workshop (PC Only). Find the map you want in the workshop. This is the URL for Mirage (https://steamcommunity.com/sharedfiles/filedetails/?id=2670152485). The 10 numbers at the end of the URL are what you need, so UGC1661803933 would be the MapId for Mirage.

==== Firewall/Port forwarding ====
Using the default settings there are two UDP ports (7777, 8177) that need to be allowed to access the server either by firewall setup or port forwarding.

'''Ubuntu''' firewall commands to check firewall and open ports:
<pre>
sudo ufw status
sudo ufw allow 7777
sudo ufw allow 8177
sudo ufw allow 9100
sudo ufw status
</pre>

'''Rocky Linux''' firewall commands to check firewall and open ports:
<pre>
sudo firewall-cmd --zone=public --add-port=7777/tcp
sudo firewall-cmd --zone=public --add-port=7777/udp
sudo firewall-cmd --zone=public --add-port=8177/tcp
sudo firewall-cmd --zone=public --add-port=8177/udp
sudo firewall-cmd --zone=public --add-port=9100/udp
sudo firewall-cmd --zone=public --add-port=9100/tcp
sudo firewall-cmd --list-ports
firewall-cmd --runtime-to-permanent
</pre>

You may also need to allow Pings (ICMP) for the server's true latency to appear in the master list.

If you are running multiple servers and have set additional ports (see http://wiki.pavlov-vr.com/index.php?title=Dedicated_server#Running_multiple_servers_on_one_host) then you need to allow access to the defined port plus the port 400 higher. So if you use 7000 as your port, then UDP 7000 and 7400 need to be open

If you have setup rcon via RconSettings.txt (below) then that port also need to be allowed access via TCP

If you are running Shack/Quest and want to have maps that are downloadable from your server, your server ports (ex. 7777 & 8177) must also be open via TCP

----

==== Shack Maps (Quest) ====

If you try to use the steps above to add maps for Shack, youll run into issues very quickly. This is because Shack has no affiliation to Steam, and therefore cannot use Steam Workshop maps like above. In the future, these steps will apply to PC servers as well, allowing a server to hold the map itself, instead of offloading to Steam.

To get started, first create the directory to hold the maps

<pre>mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps</pre>

You can use any number of methods to move the map files onto the server, but ill go over the two simplest, starting with a GUI approach

Download and install CyberDuck onto your "home" PC (Whatever PC you use for access to the server, but not the server itsself): https://cyberduck.io/

Next, download and unzip your map of choice from https://www.pavlovquest.com/ , https://pavlovhorde.com/mapsList, or look in #shack-map-showcase channel in the discord server. I'm going to use Cheeto's WW2 Items test (http://www.mediafire.com/file/emyt9bs1z9u9ykw/SVR_Cheeto_Items.zip/file ) for this example, you do what you like

In the top left corner, open a connection, set the connection type to SFTP, and fill in the rest of the information. User will be root, password is whatever you set the root pw as (toor in Ubuntu by default)

In the directory dropdown (itll say /root) go back to /

Follow the directories until we arrive back at our "maps" folder <pre>/home/steam/pavlovserver/Pavlov/Saved/maps</pre>

Drag and drop the unzipped map folder into the main window, in this case itll be SVR_Cheeto_Items

Hit Allow

Youll now see a folder named SVR_Cheeto_Items, and within it should be nothing but 3 files. If there is another folder in it, move this folder to the maps directory, otherwise the server wont work. The 3 files (2 .PAK one .JSON) should be in home/steam/pavlovserver/Pavlov/Saved/maps/SVR_Cheeto_Items, no more, no less.

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

To play the map, you can either use RCON switch map command, or to add the map to your servers automatic map rotation list, add the map's folder name to your Game.ini. This replaces the MapID section, so for our example it would be

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

And thats all! Disconnect CyberDuck from your server before playing, otherwise youll have difficulty joining.

-----------

==== Adding Shack Maps over Command Line Interface ====

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

A bit more complicated, but adding maps over CLI has its benefits

First, CD to the maps directory you made above

<pre>cd ~/pavlovserver/Pavlov/Saved/maps</pre>

Download the map files from whatever you use to upload them. To do this, you can either use curl or wget

<pre>curl -O insertURLhere</pre>

'''If you download your map from Google Drive''', make sure that your .zip folder is shared to anyone.
Then, get the file's url from the shared link. Example : ''<nowiki>https://drive.google.com/file/d/19bI8gUHaN5tUrDvnadAacUnchQf6_k/view</nowiki>'' will be ''19bI8gUHaN5tUrDvnadAacUnchQf6_k''
Edit "fileId" and "fileName" before you execute the command.
<pre>
fileId=19bI8gUHaN5tUrDvnadAacUnchQf6_k
fileName=SVR_USER_MAPNAME
curl -sc /tmp/cookie "https://drive.google.com/uc?export=download&id=${fileId}" > /dev/null
code="$(awk '/_warning_/ {print $NF}' /tmp/cookie)"
curl -Lb /tmp/cookie "https://drive.google.com/uc?export=download&confirm=${code}&id=${fileId}" -o ${fileName} </pre>

To keep with the Items example:

<pre>curl -O https://cdn.discordapp.com/attachments/744185280759857234/745027406695366788/SVR_Cheeto_Items.zip</pre>

Next, unzip the file. If this next step errors out, saying the command is unknown, switch back to the root user (su root), and install unzip (sudo apt install unzip), then return to the steam user, and continue.

<pre>unzip SVR_Cheeto_Items.zip</pre>

Now finish like before by adding the map to your Game.ini

<pre>nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini</pre>

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

==== Admin/Moderator list (optional) ====

The only working in-game admin menu is through Arctic VR server hosting (see below).

If you add moderators to your server, they will not be subject to vote kicks.

<pre>
nano ~/pavlovserver/Pavlov/Saved/Config/mods.txt
</pre>

Example Mod List:
<pre>
76541198397498572 #Optional Comment: Player name
76541198397498573 #Some Other Player
</pre>

==== ArcticVR Admin Menu ====

[[File:Arcticmenu.jpg|500px|link=https://www.arctic-vr.com/server-admin-menu]]

Arctic-VR Offers an advanced In-Game Admin menu that is exclusive to their hosting service. Features include:
* Switch Maps+Modes
* Teleport Players to Players
* Change Player Skins
* Control Player Buying+Cash
* Spawn Items
* Clean up corpses + guns
* Spawn Bots
* Spawn Items for other players
* Control Teams + Balance/Shuffle Teams
* ResetSND
* And More

You can read more about the ArcticVR admin menu on their website: https://www.arctic-vr.com/server-admin-menu

==== Handy tools for finding steamIDs ====

Steam ID finder: https://steamidfinder.com/lookup/ or https://steamid.xyz/

You want to enter in the steamID64 format.

This tool can convert or lookup IDs: https://steamid.io/

If you are looking for a steamID of a player that has been on your server recently this is technique to find them:
<pre>
grep -i playername ~/pavlovserver/Pavlov/Saved/Logs/* | grep TicketValidation
</pre>

=== Configure Rcon ===
To enable Rcon access create config file:
<pre> nano /home/steam/pavlovserver/Pavlov/Saved/Config/RconSettings.txt </pre>

Copy in the following text - change password, and if desired the port:
<pre>
Password=ChangeThisPassword
Port=9100
</pre>
You must specify a port for the Rcon server to use as well as a Password (use a different port per sever instance if running multiple server instances off the same hardware)

=== Starting the server ===

<pre>
cd ~/pavlovserver && ./PavlovServer.sh
</pre>

That's it, your server will be automatically broadcast to the master server! :)

Two handy tools to determine quickly if your server is broadcasting are [https://pablub.xyz/ Pablub] (PC only) and [https://pavlovhorde.com/ Horde] (Shack) and [https://pavlovhorde.com/pcServers Horde] (PC version)

Note that when you close your terminal, the server will go down. See the "supervisors" section below for how to prevent this.

=== Auto-updating the server ===

Assuming you have followed this guide and used the default paths, users, and install instructions, you can paste the following into your terminal to auto-update your Pavlov server:

<pre>
cat << 'EOF' > $HOME/pavlov_daily_update_and_restart.sh
#!/bin/bash

USER="steam"
SERVICENAME="pavlovserver.service"
INSTALLDIRNAME="pavlovserver"
USERHOME="/home/$USER"

echo -e "Beginning Pavlov VR update run on $(date)\n\n"

systemctl stop "$SERVICENAME"

sleep 5
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +force_install_dir "$USERHOME/$INSTALLDIRNAME" +app_update 622970 +exit
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +app_update 1007 +quit
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/.steam/sdk64/steamclient.so"
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/pavlovserver/Pavlov/Binaries/Linux/steamclient.so"

systemctl start "$SERVICENAME"

echo -e "Ending Pavlov VR update run on $(date)\n\n"

EOF

chmod +x $HOME/pavlov_daily_update_and_restart.sh
mkdir $HOME/pavlov_update_logs && touch $HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log
CRONLINE="00 2 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
(sudo crontab -u root -l; echo "$CRONLINE" ) | sudo crontab -u root -
unset CRONLINE

</pre>

These commands will:

1. Create a shell script in the "steam" user's home directory that automatically stops the Pavlov server, pulls any updates via steam, pull updates to the Steamworks SDK Redist, and copies the latest version of steamclient.so to the Pavlov server directory

2. Make the shell script executable

3. Create a new directory called "pavlov_update_logs" in the "steam" user's directory, and create a logfile inside that directory called "pavlov_daily_update_and_restart.sh.log". You can check this logfile to see the output of the Pavlov and Steam SDK update commands.

4. Create a crontab entry for the root user that runs this shell script automatically every day at 2:00AM local time

If you want to change the time that this script runs, edit the numbers "00 2" in the line that starts with "CRONLINE=". In the example provided, 00 is the minutes column, and 2 is the hour column. For example, if you wanted the server to automatically update and restart at 4:17AM every day, change the line starting with "CRONLINE=" to:

<pre>
CRONLINE="17 4 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
</pre>

If the time is PM, use 24-hour time format, e.g. "32 18" for 6:32PM.

----

=== Supervising the server using systemd ===

Running '''./PavlovServer.sh''' in your interactive shell is easy, but the server will shut down when you close your terminal. If you want to run the server in the background,
you'll want to run it under a supervisor. There are many options, ranging from the simple (nohup, screen or tmux), to the
more robust (supervisord, systemd).

Systemd is running by default on Ubuntu Linux, so we'll use that here.

To run the server as a systemd service, create the file '''/etc/systemd/system/pavlovserver.service''' (as root) by typing
<pre>
sudo nano /etc/systemd/system/pavlovserver.service
</pre>

Copy contents below into the file and save.

<pre>
[Unit]
Description=Pavlov VR dedicated server

[Service]
Type=simple
WorkingDirectory=/home/steam/pavlovserver
ExecStart=/home/steam/pavlovserver/PavlovServer.sh

RestartSec=1
Restart=always
User=steam
Group=steam

[Install]
WantedBy = multi-user.target
</pre>

If you'd like your server to start as competitive without editing the game.ini, change the line "ExecStart=/home/steam/pavlovserver/PavlovServer.sh" to look like this below. Though it's much easier to just use the game.ini to enable competitive instead. <pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -COMPETITIVE=1</pre>

Change the user or paths as appropriate. After saving the service file, to start, restart, stop, or monitor the server:

<pre>
sudo systemctl start pavlovserver
sudo systemctl restart pavlovserver
sudo systemctl stop pavlovserver
sudo systemctl status pavlovserver
</pre>

To view the logs:

<pre>
sudo journalctl -u pavlovserver
# to live-tail the logs
sudo journalctl -u pavlovserver -f
</pre>

If you want to run the pavlov server as soon as your server boots (e.g. a VPS you turn on and off), add pavlov as a startup service:

<pre>
sudo systemctl enable pavlovserver
</pre>

----

== Advanced Server Administration ==

=== Running multiple servers on one host ===

* Pavlovserver is functionally single threaded (there are multiple threads, but vast majority of work occurs in the primary one). Make sure you have # of pavlovservers + 1 CPU available. More CPUs= more servers. Faster CPU = more players.
* Make multiple server installs by defining a separate install dir for each server.
* Run each server with a unique port. eg: '''./PavlovServer.sh -PORT="Desired Port"'''
* The Server will use the Desired Port and the Port 400 above (Example: You choose 8200 as Port. So Port 8600 will be used as well)
* If you are using RCON, each server will need a unique port defined in RconSettings.txt
* Ensure the ports are forwarded and opened in your firewall

To duplicate directories:

be in the steam home folder
<pre>
cp -r pavlovserver pavlovserver1
/home/steam/pavlovserver1/PavlovServer.sh -PORT=[Desired Port]
</pre>

=== Starting server in competitive mode ===
Competitive mode will prevent dead teammates from being able to see the match, to prevent ghosting.
You can either enable this via Game.ini (described in Game.ini file), or using the -COMPETITIVE=1 parameter.

<pre>
/home/steam/pavlovserver1/PavlovServer.sh -COMPETITIVE=1
</pre>

== Automated RCON examples ==
here are some examples of scripts that interact with Pavlov RCON

* '''<big>Inspect players every 5 minutes</big>''' [https://github.com/JTWP-org/inspect-every-5-mins (INSTALL FROM GIT )]

This [https://www.gnu.org/software/bash/ BASH] script connects to the server u set in the config with [https://netcat.sourceforge.net/ NETCAT] 2 times every 5 min and it uses RCON commands [[Rcon Overview and Commands|RefreshList]] &.<code>InspectPlayer {UniqueID} to build stats for the current round and match stats are then appended over the last one collected</code>

{| class="wikitable"

|}

----

===Useful Linux Commands===

List files / folders in directory, print current working directory,
<pre>ls -la #list files/directories along with authorities and ownership
pwd #print working directory
sudo chown <owner> <file/directory> #change owner of file/directory. If root created something and you need to change it to steam
sudo chgrp <group> <file/directory> #change group of file/directory.
</pre>

Check if pavlov is running by checking process status. If the only row you see is the grep command, pavlov server is not started.
<pre> ps -ef | grep pav </pre>

Sample output:
<pre>
steam 34044 1 0 16:52 ? 00:00:00 /bin/sh /home/steam/pavlovserver/PavlovServer.sh
steam 34066 34044 80 16:52 ? 00:00:04 /home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer
zombies+ 34101 34013 0 16:52 pts/0 00:00:00 grep --color=auto pav
</pre>

Kill a process. Note this command uses 34044, which is a process id from the command output above.
<pre> kill -9 34044 </pre>

Dump the log to the console so you can scroll through it:
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log </pre>

Search the log for a string - replace my_string with case-sensitive string
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep my_string </pre>

===Default Map ID's===
datacenter

sand

bridge

containeryard

siberia (Prison Break)

hospital (Zombies map)

killhouse

range

tutorial

santorini

station

industry

ogcontainers (Shack only)

haguenau (Shack only)

foundation (Shack only)

stalingrad (PC only)

stalingrad_night (PC only)

santorini_night (PC only)

sand_night (PC only)

station_night (PC only)

industry_night (PC only)

bunker (PC only)

===Automated server log backup ===

here is how to setup a bash script to 1x a day compress all log files and save them to protect from auto deletion it will also post a discord webhook to confirm its working and saved the days logs

https://github.com/JTWP-org/backUpLogs

==Troubleshooting==

To run the server without outputting the heartbeat:

<pre>./PavlovServer.sh | sed '/heartbeat/d'</pre>

To monitor the logs (without heartbeat) from another terminal:

<pre>tail -f -n10000 /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep -v 'Sending heartbeat to masterserver'</pre>

Check your CPU Clock Speed with:

<pre>lscpu | grep MHz</pre>

=== Server won't start ===

Error message:
<pre>
ln: failed to create hard link '/home/steam/.steam/sdk64/steamclient.so': File exists
ln: failed to create hard link '/home/steam/pavlovserver/Pavlov/Binaries/Linux/steamclient.so': File exists
/home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer: error while loading shared libraries: libc++.so.1: cannot open shared object file: No such file or directory
</pre>

First two errors are harmless. The third one is because libc++ step was skipped or failed. Using sudo capable id (probably not steam id), [re]run this line:
<pre>sudo apt update && sudo apt install -y gdb curl lib32gcc1 libc++-dev unzip </pre>

=== Map wont load (kicks to datacenter)===

try deleting all the downloaded workshop maps with:

<pre>sudo rm -rf /tmp/workshop/7777/content/555160/*</pre> for all maps or

<pre>sudo rm -rf /tmp/workshop/7777/content/555160/whatever-UGC</pre> for specific map

===Map wont load when running in a container===
The three typical container problems I have seen:

1) Steam can't write to /tmp for some reason

2) /tmp is actually tmpfs instead of real filesystem and a few gigs of maps runs you out of RAM

3) Made worse by fact that pavlovserver unpacks downloads to ram, then writes to /tmp/workshop. Not enough RAM to do this, no map for you.

===Server stuck rotating forever===

Run these 2 commands, then restart your server:

<pre>cd ~/Steam && ./steamcmd.sh +login anonymous +app_update 1007 +quit
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so</pre>

If this doesn't fix it, double check that your server isn't running on the same port as another, by running this command:

<pre>ps -ef | grep pav</pre>

Then if 2 servers are on the same port, you can fix it by editing the pavlovserver.service file, and making sure the following line:

<pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -PORT=Number</pre>

has a unique number after the port for each server you're running.

=== Server - ping 999===
Google Cloud Platform - Make sure your compute engine has a network tag and your network rules are applied to the tag.
Make sure you opened the specified ports.

Network testing tools:
Test if your server will respond to ping from outside your network:
https://www.wormly.com/test-remote-ping

Test if your ports are accessible via UDP (7777,8177,9100):
https://www.ipvoid.com/udp-port-scan/

===Can't connect to RCON===
Check the file and group owner of RconSettings file. It should be steam, or the ID used to run the pavlov server.
<pre>
cd /home/steam/pavlovserver/Pavlov/Saved/Config
ls -la
</pre>

If the owner/group are not steam, using root or an id with sudo authority, change them to steam, confirm they are now set properly, then restart the pavlov server. (Note - if Rcon has wrong permissions, after fixing you should also to check the other config files like Game.ini, mods/blacklist/whitelist for the same issue. If steam can't access these files, it could cause problems.).
<pre>
cd /home/steam/pavlovserver/Pavlov/Saved/Config
sudo chown steam RconSettings.txt
sudo chgrp steam RconSettings.txt
ls -la </pre>

===PC ONLY - Map Download stops===

When downloading a large map from the steam workshop make sure your VPS/Dedi or Shared hosting provider (Otherwise known as a GSP's) has enough RAM assigned to store the map files in its tempfs (stored in ram)!

This is less likely to happen on Dedicated servers and VPS with a decent amount of ram unless you are using docker with RAM limits!

Most GSP's will be using docker or some other type of jailing method to limit system resource allocations and direct access to the host machine, if they are and you know what map you want to use make sure you order a service with enough ram to store your map. If in doubt contact your GSP's support team.

===Getting Help===

There's a #pc-custom-servers channel on the official Pavlov Discord - https://discord.gg/Pavlov-VR. Lots of helpful people there!
[[Category:RCON automation]]

Setting up a dedicated server

2023-05-26T03:17:10Z

SaltedCrackerJack: /* Automated RCON examples */

== Setting up a dedicated server ==

'''There are no Windows binaries'''

This guide is written exclusively for Linux and covers Ubuntu/Debian/Debian-like and Red Hat RPM-based distros. Possible to run with other distros, but some of the commands won't work and you will need to know enough to figure out the software install of dependencies on your own.

If you are considering hosting from home, please read that section of the wiki first.

This guide assumes you know the basics of using a bash terminal: ssh'ing into a server, running bash commands, editing text files, etc.

If you have no experience using bash, maybe start [https://www.howtogeek.com/140679/beginner-geek-how-to-start-using-the-linux-terminal/ here]. Editing text files via commandline is often a challenge. Suggest using nano and reading guide [https://www.howtogeek.com/howto/42980/the-beginners-guide-to-nano-the-linux-command-line-text-editor/ here]

If you are new to linux and accessing your server from Windows, highly suggest using MobaXterm as your SSH client as that can make required editing of text files easier using built in editor instead of the native linux command line editors.

And finally, ask yourself why you want to setup a server? If you look at the list, there are many, many more servers than players. If you don't have a team, discord community, or group of friends ready to play on your server, chances are it will go unused. Got one of these... great, let's go.

If you don't want to go through the hassle yourself and want to pay for a hosting service Arctic VR (PC and Shack) and Horde (Shack) provide a server hosting services and are trusted in the community. See links below.

----

=== Server Requirements ===

'''Pavlovserver can only be hosted under Linux.'''

This can be running as a VM under windows, but this will increase the complexity of the setup beyond this guide.

Ubuntu 18.04 x86_64, Ubuntu 19/04 amd64, Ubuntu 20.04, and Rocky Linux 8 are confirmed working. Ubuntu 15.04 x86 is known to fail to install using this guide. Recommend not running on "minimal" images as some tools are missing.

* 2GB RAM + 1GB RAM per each additional server with 10 players. More RAM is recommended for larger maps, higher player counts, or complex gamemodes. Not having enough RAM is a common cause of server crashes.

* A ~2.5Ghz CPU will comfortably support a 10 player server.

* A ~4Ghz CPU will comfortably support 24 players. This is a limit built into Pavlov itself, no server will allow players to join over 24. Lower player counts are recommended for complex gamemodes (E.g. CodZ) and/or highly detailed maps, so that maximum number will often be lower.

(Note that these are '''not''' hard limits for player counts, just suggestions for the best performance, based on experiences with many server providers on different grades of hardware.)

* Pavlovserver is functionally single threaded (one thread does vast majority of work). More CPUs only help if you are running more servers. More clockspeed = higher performance = more users per server.
The maximum number of servers you can run is dependent on how many CPUs you have. For example, if you have an 8 core CPU, the maximum number of servers would be 7. You should always have at least one CPU free as overhead, as Pavlov servers can use slightly more than one thread.

----

==== Hosting at home ====
When hosting at home there are additional requirements regarding networking: Your router has to support port-forwarding, hair-pinning/LoopbackNAT, and respond to ping requests. These techniques are necessary to allow your server to be found and to talk back to the client. please see https://en.wikipedia.org/wiki/Port_forwarding, https://en.wikipedia.org/wiki/Hairpinning, and https://www.speedguide.net/faq/how-to-become-pingable-behind-a-routerfirewall-376 for more info and google for these terms in addition to your router model to find guides on how to enable/configure it properly. If you have modern Router, it may have these features already enabled, in this case you just have to configure port-forwarding. If you can see your server but not join it while others can, this is indicative of a failure of LoopbackNAT.

A second challenge to hosting at home is CGNAT (Carrier grade NAT: https://www.a10networks.com/blog/carrier-grade-nat/). Just like NAT on your home network that has to be gotten around w/ port-forwarding, CGNAT breaks the ability of external connections to be made back to your server, but the controls are solely in your ISPs hands. Sometimes if you ask, you can be removed from CGNAT pools and/or assigned a static IP. CGNAT rollouts are becoming very common now, so if your server worked then doesn't allow connections now, your ISP may have made this change.

You can check whether you’re on a CGNAT network by visiting a Web site such as ipaddress.com or whatsmyip.com and comparing the IP address listed to the public/WAN IP address assigned to your Internet gateway. To find your gateway’s public IP address, check the status page in the administrative interface. If the two IP addresses differ, you’re likely on a CGNAT network. If so, this problem must be resolved before you go any further.

'''Not understanding these requirements and configuration is a frequent cause of failed setups and questions in discord. Don't skip this if you are trying to host from home'''

'''There are serious security implications of hosting this software at home.''' None of the devs are security experts and there has been no security review of the code. You are opening up your system to the world and publicity advertising this fact. Expect that any system hosting this software is open to compromise from the Internet and act accordingly. If your router offers a DMZ network, use it. Consider hosting on a cloud based server and think twice before running this software on any system that contains data you care about or has access to networks and computers you care about.

If you're hosting at home using Oracle's VirtualBox, there are steps you can take to prevent double NAT (which can cause issues later on)

1. Select your VM and then click Settings in VirtualBox's main window.

2. Click on Network and change Attached To from NAT to Bridged Adapter.

Once you've done this, your VM should be connected directly to your home router and double NAT should no longer be a issue.
----

==== Hosting Providers ====

Considering the suggested server specs, you may be interested in the following hosting providers. For providers promising dedicated "Pavlov hosting" as opposed to general VPS services please contact and ask how you change maps being hosted and how you get RCON access before you put your money down.

<pre>
Provider | Base CPU | Details
Arctic VR | 4.5 GHz | https://www.arctic-vr.com/server-hosting
Amazon Web Services | 4.0 GHz | https://aws.amazon.com/ec2/instance-types/z1d/
VULTR | 4.0 GHz | https://www.vultr.com/products/high-frequency-compute/
packet.com | 3.5 GHz | https://www.packet.com/cloud/servers/c1-small/
Google Cloud Platform | 3.2 GHz | https://cloud.google.com/compute/docs/cpu-platforms
</pre>

===== ARCTIC VR =====

Arctic VR is the largest and longest running Pavlov VR hosting provider. The In-Game Admin Menu is exclusive to the ArcticVR hosting service. They offer EU, NA East and NA West servers for both shack and PCVR. ArcticVR offers the fastest Pavlov servers as well as DDos Protection, RCON remote management, custom maps, low pings, unlimited slots, and expert support.

Website: https://www.arctic-vr.com/server-hosting

[[File:Arctic_options.png|link=https://www.arctic-vr.com/server-hosting|700px]]

===== VULTR =====

Consider using a referral from the community:

Carlos: https://www.vultr.com/?ref=8615589-6G

Carrot: https://www.vultr.com/?ref=8689348

Archaeo: https://www.vultr.com/?ref=8653652-6G

Cheeto: https://www.vultr.com/?ref=8717358

For a Pavlov Shack server, I recommend minimum Cloud Compute, Intel High Performance, Ubuntu 20.04, and disabled automatic backups. At the time, this was $6/m. Some of the cheap options have 1TB bandwidth, and some have 2TB+. If it's a personal server, 1TB could be fine, but 2TB should be safe.

===== Google Cloud Platform (90 day free credit available) =====

The below configuration is successfully running 4 pavlov PC instances with ~15 total maps and up to 24 players per server. If you want more maps use larger boot disk. Both can dynamically be scaled based on popularity.

<pre>

Menu -> compute engine -> VM instances
create instance
- region: wherever you like
- machine type: n1-highcpu-4 (4 vCPUs, 3.6 GB memory)
- boot disk: Ubuntu 20.04
- boot disk -> size: 25gb
- network tags: pavlov-server
- [create]

Menu -> Vpc network -> firewall rules
[Create firewall rule]
Name: pavlov server
Target Tags: pavlov-server
Source IP Ranges: 0.0.0.0/0
Protocols and Ports -> Specified protocols and ports -> UDP: 7777, 8177 (Shack and PC)
Protocols and Ports -> Specified protocols and ports -> TCP: 7777, 8177 (Shack-only)
Protocols and Ports -> Specified protocols and ports -> TCP: {RCON port - default 9100}
[save]
</pre>

===== Amazon Web Services (30 day free credit available) =====

<pre>
Login -> Change Region: Choose your region
Services -> Compute -> EC2 -> Create
Choose an AMI: Ubuntu 18.04
Instance Type: z1d.large

Instance Details -> Tenancy: Dedicated (optional: this will more than triple the cost)

Storage: 50gb disk (or whatever, you're in control of the map roster)

Security Groups:
Create a new Security Group
Security group name: pavlov-server
Description: pavlov server
Rules:
Type: Custom ICMP Rule - IPV4 / Protocol: Echo Request
Type: Custom UDP Rule / Port Range: 7777 / Source: 0.0.0.0/0
Type: Custom UDP Rule / Port Range: 8177 / Source: 0.0.0.0/0
Type: SSH (optional, but I assume you wanna SSH in..)

Launch -> Create new Keypair -> Download -> Launch

Once it's started, SSH in like:
$ ssh -i your-key.pem ubuntu@you-server-details.amazonaws.com

(I use cmder on Windows, if you're using putty or mobaxterm or something, might be different)
</pre>

=== Starting Server Install ===

====Obtaining an ApiKey====
For your server to show up in the server list, there is now a requirement to have an ApiKey issued by vankrupt. This is to prevent DOS attacks against the master server

Get the key by going here: https://pavlov-ms.vankrupt.com/servers/v1/key and using your mobile number to get a SMS
(note that there have been reported failures of this SMS system for non-US mobiles. In this case DM davevillz your mobile and ask for a key)

Put this key in your Game.ini as follows:
ApiKey="ABC123FALSEKEYDONTUSEME"
or if you would like (personally untested..I would use game.ini) you can call it at server runtime with flag as follows:
-KEY="ABC123FALSEKEYDONTUSEME"

This key can be re-used for a reasonable number of servers (a limit of 10 has been mentioned). Contact the Devs if you need more servers per key.

====System setup and software installation====

Install dependencies and create the `steam` user. (You only need to do this once):

Confirm Linux version
<pre>
lsb_release -a
</pre>

'''Ubuntu 20.04'''
<pre>
sudo apt update && sudo apt install -y gdb curl lib32gcc1 libc++-dev unzip
sudo useradd -m steam
</pre>

'''Ubuntu 20.10 or higher'''
<pre>
sudo apt update && sudo apt install -y gdb curl lib32gcc-s1 libc++-dev unzip
sudo useradd -m steam
</pre>

'''Rocky Linux, CentOS 8, and RHEL 8'''

<pre>
sudo sed -i 's/^SELINUX=enforcing$/SELINUX=permissive/g' /etc/selinux/config
sudo setenforce 0
sudo yum install gdb curl glibc.i686 libstdc++.i686 libstdc++-devel.i686 libstdc++-devel.x86_64 unzip wget -y
wget https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/l/libcxx-3.8.0-3.el7.x86_64.rpm
sudo rpm -i libcxx-3.8.0-3.el7.x86_64.rpm
sudo useradd -m steam
</pre>

[Optional] Set a password for steam.
<pre>sudo passwd steam</pre>

Login as the steam user. ('''You will need to do this each time you connect to your server'''):

<pre>
sudo su -l steam
</pre>

Install Steam:

<pre>
mkdir ~/Steam && cd ~/Steam && curl -sqL "https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz" | tar zxvf -
</pre>

There are different dedicated server versions for Pavlov Server - choose which server version you want to host (PC non-beta, PC Beta, Shack Live, or Shack RC)
(You will need to run this command each time there is a Pavlov Server update). 
To host '''PC Server (non-beta)''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 +exit
</pre>

To host '''PC BETA''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta beta_server +exit
</pre>

To host '''Shack Live''' (Quest):

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack +exit
</pre>

To host '''Shack RC''' (Quest): 

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack_beta +exit
</pre>

Now that we've installed the server, all pavlov server versions should continue. 
Install a fresh copy of steamclient.so (May have to do this after each update):
<pre>
~/Steam/steamcmd.sh +login anonymous +app_update 1007 +quit
mkdir -p ~/.steam/sdk64
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/pavlovserver/Pavlov/Binaries/Linux/steamclient.so
</pre>

Make the PavlovServer script executable. (You only need to do this once):

<pre>
chmod +x ~/pavlovserver/PavlovServer.sh
</pre>

----

=== Server Configuration ===

Before starting the server we need to configure it. Start by creating some directories:

<pre>
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Logs
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps
</pre>

==== Mods/Blacklist/Whitelist (optional) ====

The following three files allow you to specify mods, banned players, and whitelist players. These are optional, but go ahead and create them. Populating the files is described later.

<pre>
touch /home/steam/pavlovserver/Pavlov/Saved/Config/mods.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/blacklist.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/whitelist.txt
</pre>

====Configuring Game.ini====
Create a new Game.ini file using following command to open an editor and copy/paste the following block into it then save it. Note not all of these options are required. For instance remove or comment out the Password=0000 line to make a public server with no pin.
<pre>
nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini
</pre>

<pre>
[/Script/Pavlov.DedicatedServer]
bEnabled=true
ServerName="My_private_idaho"
MaxPlayers=10 #Set this to 10 for Shack. 24 is the max for PC, setting it higher will not allow players to join.
ApiKey="ABC123FALSEKEYDONTUSEME"
bSecured=true
bCustomServer=true
bVerboseLogging=false
bCompetitive=false #This only works for SND
bWhitelist=false
RefreshListTime=120
LimitedAmmoType=0
TickRate=90
TimeLimit=60
#Password=0000
#BalanceTableURL="vankruptgames/BalancingTable/main"
MapRotation=(MapId="UGC1758245796", GameMode="GUN")
MapRotation=(MapId="datacenter", GameMode="SND")
MapRotation=(MapId="sand", GameMode="DM")

</pre>

* '''bEnabled''' - whether the server appears in the server list (unconfirmed)
* '''ServerName''' - name it will be listed as. (approx 35 chars max)
* '''MaxPlayers''' - See suggested specs for limits. 10 standard (10 for shack), 20-24 is max recommended for large maps like Stalingrad or PUSH/RUSH modes, and servers allow a maximum of 24 players.
* '''ApiKey''' - Unique ApiKey required to register server with master server. Replace with your key
* '''bSecured''' - enabled Valve Anti-Cheat (VAC)
* '''bCustomServer''' - activates some new modding tools (save and http functions. Required to write to blacklist.txt for bans)
* '''bCompetitive''' - sets the server to competitive mode for SND. If removed the server will default to false
* '''bVerboseLogging''' - enables verbose logging, mostly detailed statistics. Be prepared for significant increase in logging.
* '''bWhitelist''' - Only allow users in whitelist.txt to join
* '''RefreshListTime''' - sets how often the running server checks for updates in ban/whitelist/mod files
* '''LimitedAmmoType''' - sets limited ammo mode
0 = Unlimited
1 = Limited Generic
2 = Limited Specific
3 = Custom (for modders)
4 = Limited Special
5 = Boxless Mode

* '''TimeLimit''' - sets time limit for each map
* '''TickRate''' - sets the server tickrate. (so far minimum stable seems around 50 and max around 120. Beware setting this changes weapon despawn time and breaks some game modes. Recommend not touching)
* '''Password''' - PIN number for server #FYI - this is now also changeable via rcon.
* '''BalanceTableURL''' - Points to a custom balance table from github. See https://github.com/vankruptgames/BalancingTable for instructions. This line isn't needed if you don't have one.
* '''MapRotation''' - you can add multiple of these. The MapId must be “UGC” followed by the map ID. you can find the map id in the URL of the steam workshop page. When a match ends, the server will load the next map in the rotation. You can also use RCON to switch to a map not included in rotation.

Available game modes as of 09/06/2022: SND, TDM, DM, GUN, ZWV, WW2GUN, TANKTDM, KOTH, TTT, OITC, INFECTION, HIDE, PUSH, PH 

And for Shack only: CTF

For maps running a Custom gamemode (CodZ, BR, Duel, etc.) it doesn't matter which gamemode you choose, as the map will automatically override it with the custom mode.

UGC###### are for custom maps from Steam workshop (PC Only). Find the map you want in the workshop. This is the URL for Mirage (https://steamcommunity.com/sharedfiles/filedetails/?id=2670152485). The 10 numbers at the end of the URL are what you need, so UGC1661803933 would be the MapId for Mirage.

==== Firewall/Port forwarding ====
Using the default settings there are two UDP ports (7777, 8177) that need to be allowed to access the server either by firewall setup or port forwarding.

'''Ubuntu''' firewall commands to check firewall and open ports:
<pre>
sudo ufw status
sudo ufw allow 7777
sudo ufw allow 8177
sudo ufw allow 9100
sudo ufw status
</pre>

'''Rocky Linux''' firewall commands to check firewall and open ports:
<pre>
sudo firewall-cmd --zone=public --add-port=7777/tcp
sudo firewall-cmd --zone=public --add-port=7777/udp
sudo firewall-cmd --zone=public --add-port=8177/tcp
sudo firewall-cmd --zone=public --add-port=8177/udp
sudo firewall-cmd --zone=public --add-port=9100/udp
sudo firewall-cmd --zone=public --add-port=9100/tcp
sudo firewall-cmd --list-ports
firewall-cmd --runtime-to-permanent
</pre>

You may also need to allow Pings (ICMP) for the server's true latency to appear in the master list.

If you are running multiple servers and have set additional ports (see http://wiki.pavlov-vr.com/index.php?title=Dedicated_server#Running_multiple_servers_on_one_host) then you need to allow access to the defined port plus the port 400 higher. So if you use 7000 as your port, then UDP 7000 and 7400 need to be open

If you have setup rcon via RconSettings.txt (below) then that port also need to be allowed access via TCP

If you are running Shack/Quest and want to have maps that are downloadable from your server, your server ports (ex. 7777 & 8177) must also be open via TCP

----

==== Shack Maps (Quest) ====

If you try to use the steps above to add maps for Shack, youll run into issues very quickly. This is because Shack has no affiliation to Steam, and therefore cannot use Steam Workshop maps like above. In the future, these steps will apply to PC servers as well, allowing a server to hold the map itself, instead of offloading to Steam.

To get started, first create the directory to hold the maps

<pre>mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps</pre>

You can use any number of methods to move the map files onto the server, but ill go over the two simplest, starting with a GUI approach

Download and install CyberDuck onto your "home" PC (Whatever PC you use for access to the server, but not the server itsself): https://cyberduck.io/

Next, download and unzip your map of choice from https://www.pavlovquest.com/ , https://pavlovhorde.com/mapsList, or look in #shack-map-showcase channel in the discord server. I'm going to use Cheeto's WW2 Items test (http://www.mediafire.com/file/emyt9bs1z9u9ykw/SVR_Cheeto_Items.zip/file ) for this example, you do what you like

In the top left corner, open a connection, set the connection type to SFTP, and fill in the rest of the information. User will be root, password is whatever you set the root pw as (toor in Ubuntu by default)

In the directory dropdown (itll say /root) go back to /

Follow the directories until we arrive back at our "maps" folder <pre>/home/steam/pavlovserver/Pavlov/Saved/maps</pre>

Drag and drop the unzipped map folder into the main window, in this case itll be SVR_Cheeto_Items

Hit Allow

Youll now see a folder named SVR_Cheeto_Items, and within it should be nothing but 3 files. If there is another folder in it, move this folder to the maps directory, otherwise the server wont work. The 3 files (2 .PAK one .JSON) should be in home/steam/pavlovserver/Pavlov/Saved/maps/SVR_Cheeto_Items, no more, no less.

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

To play the map, you can either use RCON switch map command, or to add the map to your servers automatic map rotation list, add the map's folder name to your Game.ini. This replaces the MapID section, so for our example it would be

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

And thats all! Disconnect CyberDuck from your server before playing, otherwise youll have difficulty joining.

-----------

==== Adding Shack Maps over Command Line Interface ====

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

A bit more complicated, but adding maps over CLI has its benefits

First, CD to the maps directory you made above

<pre>cd ~/pavlovserver/Pavlov/Saved/maps</pre>

Download the map files from whatever you use to upload them. To do this, you can either use curl or wget

<pre>curl -O insertURLhere</pre>

'''If you download your map from Google Drive''', make sure that your .zip folder is shared to anyone.
Then, get the file's url from the shared link. Example : ''<nowiki>https://drive.google.com/file/d/19bI8gUHaN5tUrDvnadAacUnchQf6_k/view</nowiki>'' will be ''19bI8gUHaN5tUrDvnadAacUnchQf6_k''
Edit "fileId" and "fileName" before you execute the command.
<pre>
fileId=19bI8gUHaN5tUrDvnadAacUnchQf6_k
fileName=SVR_USER_MAPNAME
curl -sc /tmp/cookie "https://drive.google.com/uc?export=download&id=${fileId}" > /dev/null
code="$(awk '/_warning_/ {print $NF}' /tmp/cookie)"
curl -Lb /tmp/cookie "https://drive.google.com/uc?export=download&confirm=${code}&id=${fileId}" -o ${fileName} </pre>

To keep with the Items example:

<pre>curl -O https://cdn.discordapp.com/attachments/744185280759857234/745027406695366788/SVR_Cheeto_Items.zip</pre>

Next, unzip the file. If this next step errors out, saying the command is unknown, switch back to the root user (su root), and install unzip (sudo apt install unzip), then return to the steam user, and continue.

<pre>unzip SVR_Cheeto_Items.zip</pre>

Now finish like before by adding the map to your Game.ini

<pre>nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini</pre>

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

==== Admin/Moderator list (optional) ====

The only working in-game admin menu is through Arctic VR server hosting (see below).

If you add moderators to your server, they will not be subject to vote kicks.

<pre>
nano ~/pavlovserver/Pavlov/Saved/Config/mods.txt
</pre>

Example Mod List:
<pre>
76541198397498572 #Optional Comment: Player name
76541198397498573 #Some Other Player
</pre>

==== ArcticVR Admin Menu ====

[[File:Arcticmenu.jpg|500px|link=https://www.arctic-vr.com/server-admin-menu]]

Arctic-VR Offers an advanced In-Game Admin menu that is exclusive to their hosting service. Features include:
* Switch Maps+Modes
* Teleport Players to Players
* Change Player Skins
* Control Player Buying+Cash
* Spawn Items
* Clean up corpses + guns
* Spawn Bots
* Spawn Items for other players
* Control Teams + Balance/Shuffle Teams
* ResetSND
* And More

You can read more about the ArcticVR admin menu on their website: https://www.arctic-vr.com/server-admin-menu

==== Handy tools for finding steamIDs ====

Steam ID finder: https://steamidfinder.com/lookup/ or https://steamid.xyz/

You want to enter in the steamID64 format.

This tool can convert or lookup IDs: https://steamid.io/

If you are looking for a steamID of a player that has been on your server recently this is technique to find them:
<pre>
grep -i playername ~/pavlovserver/Pavlov/Saved/Logs/* | grep TicketValidation
</pre>

=== Configure Rcon ===
To enable Rcon access create config file:
<pre> nano /home/steam/pavlovserver/Pavlov/Saved/Config/RconSettings.txt </pre>

Copy in the following text - change password, and if desired the port:
<pre>
Password=ChangeThisPassword
Port=9100
</pre>
You must specify a port for the Rcon server to use as well as a Password (use a different port per sever instance if running multiple server instances off the same hardware)

=== Starting the server ===

<pre>
cd ~/pavlovserver && ./PavlovServer.sh
</pre>

That's it, your server will be automatically broadcast to the master server! :)

Two handy tools to determine quickly if your server is broadcasting are [https://pablub.xyz/ Pablub] (PC only) and [https://pavlovhorde.com/ Horde] (Shack) and [https://pavlovhorde.com/pcServers Horde] (PC version)

Note that when you close your terminal, the server will go down. See the "supervisors" section below for how to prevent this.

=== Auto-updating the server ===

Assuming you have followed this guide and used the default paths, users, and install instructions, you can paste the following into your terminal to auto-update your Pavlov server:

<pre>
cat << 'EOF' > $HOME/pavlov_daily_update_and_restart.sh
#!/bin/bash

USER="steam"
SERVICENAME="pavlovserver.service"
INSTALLDIRNAME="pavlovserver"
USERHOME="/home/$USER"

echo -e "Beginning Pavlov VR update run on $(date)\n\n"

systemctl stop "$SERVICENAME"

sleep 5
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +force_install_dir "$USERHOME/$INSTALLDIRNAME" +app_update 622970 +exit
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +app_update 1007 +quit
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/.steam/sdk64/steamclient.so"
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/pavlovserver/Pavlov/Binaries/Linux/steamclient.so"

systemctl start "$SERVICENAME"

echo -e "Ending Pavlov VR update run on $(date)\n\n"

EOF

chmod +x $HOME/pavlov_daily_update_and_restart.sh
mkdir $HOME/pavlov_update_logs && touch $HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log
CRONLINE="00 2 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
(sudo crontab -u root -l; echo "$CRONLINE" ) | sudo crontab -u root -
unset CRONLINE

</pre>

These commands will:

1. Create a shell script in the "steam" user's home directory that automatically stops the Pavlov server, pulls any updates via steam, pull updates to the Steamworks SDK Redist, and copies the latest version of steamclient.so to the Pavlov server directory

2. Make the shell script executable

3. Create a new directory called "pavlov_update_logs" in the "steam" user's directory, and create a logfile inside that directory called "pavlov_daily_update_and_restart.sh.log". You can check this logfile to see the output of the Pavlov and Steam SDK update commands.

4. Create a crontab entry for the root user that runs this shell script automatically every day at 2:00AM local time

If you want to change the time that this script runs, edit the numbers "00 2" in the line that starts with "CRONLINE=". In the example provided, 00 is the minutes column, and 2 is the hour column. For example, if you wanted the server to automatically update and restart at 4:17AM every day, change the line starting with "CRONLINE=" to:

<pre>
CRONLINE="17 4 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
</pre>

If the time is PM, use 24-hour time format, e.g. "32 18" for 6:32PM.

----

=== Supervising the server using systemd ===

Running '''./PavlovServer.sh''' in your interactive shell is easy, but the server will shut down when you close your terminal. If you want to run the server in the background,
you'll want to run it under a supervisor. There are many options, ranging from the simple (nohup, screen or tmux), to the
more robust (supervisord, systemd).

Systemd is running by default on Ubuntu Linux, so we'll use that here.

To run the server as a systemd service, create the file '''/etc/systemd/system/pavlovserver.service''' (as root) by typing
<pre>
sudo nano /etc/systemd/system/pavlovserver.service
</pre>

Copy contents below into the file and save.

<pre>
[Unit]
Description=Pavlov VR dedicated server

[Service]
Type=simple
WorkingDirectory=/home/steam/pavlovserver
ExecStart=/home/steam/pavlovserver/PavlovServer.sh

RestartSec=1
Restart=always
User=steam
Group=steam

[Install]
WantedBy = multi-user.target
</pre>

If you'd like your server to start as competitive without editing the game.ini, change the line "ExecStart=/home/steam/pavlovserver/PavlovServer.sh" to look like this below. Though it's much easier to just use the game.ini to enable competitive instead. <pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -COMPETITIVE=1</pre>

Change the user or paths as appropriate. After saving the service file, to start, restart, stop, or monitor the server:

<pre>
sudo systemctl start pavlovserver
sudo systemctl restart pavlovserver
sudo systemctl stop pavlovserver
sudo systemctl status pavlovserver
</pre>

To view the logs:

<pre>
sudo journalctl -u pavlovserver
# to live-tail the logs
sudo journalctl -u pavlovserver -f
</pre>

If you want to run the pavlov server as soon as your server boots (e.g. a VPS you turn on and off), add pavlov as a startup service:

<pre>
sudo systemctl enable pavlovserver
</pre>

----

== Advanced Server Administration ==

=== Running multiple servers on one host ===

* Pavlovserver is functionally single threaded (there are multiple threads, but vast majority of work occurs in the primary one). Make sure you have # of pavlovservers + 1 CPU available. More CPUs= more servers. Faster CPU = more players.
* Make multiple server installs by defining a separate install dir for each server.
* Run each server with a unique port. eg: '''./PavlovServer.sh -PORT="Desired Port"'''
* The Server will use the Desired Port and the Port 400 above (Example: You choose 8200 as Port. So Port 8600 will be used as well)
* If you are using RCON, each server will need a unique port defined in RconSettings.txt
* Ensure the ports are forwarded and opened in your firewall

To duplicate directories:

be in the steam home folder
<pre>
cp -r pavlovserver pavlovserver1
/home/steam/pavlovserver1/PavlovServer.sh -PORT=[Desired Port]
</pre>

=== Starting server in competitive mode ===
Competitive mode will prevent dead teammates from being able to see the match, to prevent ghosting.
You can either enable this via Game.ini (described in Game.ini file), or using the -COMPETITIVE=1 parameter.

<pre>
/home/steam/pavlovserver1/PavlovServer.sh -COMPETITIVE=1
</pre>

== Automated RCON examples ==
here are some examples of scripts that interact with Pavlov RCON

* '''<big>Inspect players every 5 minutes</big>''' [https://github.com/JTWP-org/inspect-every-5-mins (installation instructions on GITHUB )]

This [https://www.gnu.org/software/bash/ BASH] script will collect current players stats and the server match status for every one. then it will write them to a log in JSON format that can easily be handled for your records or the next project

<nowiki>*</nowiki>posted by invicta in the old wiki

{| class="wikitable"

|}

----

=== Useful Linux Commands ===

List files / folders in directory, print current working directory,
<pre>ls -la #list files/directories along with authorities and ownership
pwd #print working directory
sudo chown <owner> <file/directory> #change owner of file/directory. If root created something and you need to change it to steam
sudo chgrp <group> <file/directory> #change group of file/directory.
</pre>

Check if pavlov is running by checking process status. If the only row you see is the grep command, pavlov server is not started.
<pre> ps -ef | grep pav </pre>

Sample output:
<pre>
steam 34044 1 0 16:52 ? 00:00:00 /bin/sh /home/steam/pavlovserver/PavlovServer.sh
steam 34066 34044 80 16:52 ? 00:00:04 /home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer
zombies+ 34101 34013 0 16:52 pts/0 00:00:00 grep --color=auto pav
</pre>

Kill a process. Note this command uses 34044, which is a process id from the command output above.
<pre> kill -9 34044 </pre>

Dump the log to the console so you can scroll through it:
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log </pre>

Search the log for a string - replace my_string with case-sensitive string
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep my_string </pre>

=== Default Map ID's ===
datacenter

sand

bridge

containeryard

siberia (Prison Break)

hospital (Zombies map)

killhouse

range

tutorial

santorini

station

industry

ogcontainers (Shack only)

haguenau (Shack only)

foundation (Shack only)

stalingrad (PC only)

stalingrad_night (PC only)

santorini_night (PC only)

sand_night (PC only)

station_night (PC only)

industry_night (PC only)

bunker (PC only)

=== Automated server log backup ===

here is how to setup a bash script to 1x a day compress all log files and save them to protect from auto deletion it will also post a discord webhook to confirm its working and saved the days logs

https://github.com/JTWP-org/backUpLogs

== Troubleshooting ==

To run the server without outputting the heartbeat:

<pre>./PavlovServer.sh | sed '/heartbeat/d'</pre>

To monitor the logs (without heartbeat) from another terminal:

<pre>tail -f -n10000 /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep -v 'Sending heartbeat to masterserver'</pre>

Check your CPU Clock Speed with:

<pre>lscpu | grep MHz</pre>

=== Server won't start ===

Error message:
<pre>
ln: failed to create hard link '/home/steam/.steam/sdk64/steamclient.so': File exists
ln: failed to create hard link '/home/steam/pavlovserver/Pavlov/Binaries/Linux/steamclient.so': File exists
/home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer: error while loading shared libraries: libc++.so.1: cannot open shared object file: No such file or directory
</pre>

First two errors are harmless. The third one is because libc++ step was skipped or failed. Using sudo capable id (probably not steam id), [re]run this line:
<pre>sudo apt update && sudo apt install -y gdb curl lib32gcc1 libc++-dev unzip </pre>

=== Map wont load (kicks to datacenter) ===

try deleting all the downloaded workshop maps with:

<pre>sudo rm -rf /tmp/workshop/7777/content/555160/*</pre> for all maps or

<pre>sudo rm -rf /tmp/workshop/7777/content/555160/whatever-UGC</pre> for specific map

=== Map wont load when running in a container ===
The three typical container problems I have seen:

1) Steam can't write to /tmp for some reason

2) /tmp is actually tmpfs instead of real filesystem and a few gigs of maps runs you out of RAM

3) Made worse by fact that pavlovserver unpacks downloads to ram, then writes to /tmp/workshop. Not enough RAM to do this, no map for you.

=== Server stuck rotating forever ===

Run these 2 commands, then restart your server:

<pre>cd ~/Steam && ./steamcmd.sh +login anonymous +app_update 1007 +quit
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so</pre>

If this doesn't fix it, double check that your server isn't running on the same port as another, by running this command:

<pre>ps -ef | grep pav</pre>

Then if 2 servers are on the same port, you can fix it by editing the pavlovserver.service file, and making sure the following line:

<pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -PORT=Number</pre>

has a unique number after the port for each server you're running.

=== Server - ping 999 ===
Google Cloud Platform - Make sure your compute engine has a network tag and your network rules are applied to the tag.
Make sure you opened the specified ports.

Network testing tools:
Test if your server will respond to ping from outside your network:
https://www.wormly.com/test-remote-ping

Test if your ports are accessible via UDP (7777,8177,9100):
https://www.ipvoid.com/udp-port-scan/

=== Can't connect to RCON ===
Check the file and group owner of RconSettings file. It should be steam, or the ID used to run the pavlov server.
<pre>
cd /home/steam/pavlovserver/Pavlov/Saved/Config
ls -la
</pre>

If the owner/group are not steam, using root or an id with sudo authority, change them to steam, confirm they are now set properly, then restart the pavlov server. (Note - if Rcon has wrong permissions, after fixing you should also to check the other config files like Game.ini, mods/blacklist/whitelist for the same issue. If steam can't access these files, it could cause problems.).
<pre>
cd /home/steam/pavlovserver/Pavlov/Saved/Config
sudo chown steam RconSettings.txt
sudo chgrp steam RconSettings.txt
ls -la </pre>

=== PC ONLY - Map Download stops ===

When downloading a large map from the steam workshop make sure your VPS/Dedi or Shared hosting provider (Otherwise known as a GSP's) has enough RAM assigned to store the map files in its tempfs (stored in ram)!

This is less likely to happen on Dedicated servers and VPS with a decent amount of ram unless you are using docker with RAM limits!

Most GSP's will be using docker or some other type of jailing method to limit system resource allocations and direct access to the host machine, if they are and you know what map you want to use make sure you order a service with enough ram to store your map. If in doubt contact your GSP's support team.

=== Getting Help ===

There's a #pc-custom-servers channel on the official Pavlov Discord - https://discord.gg/Pavlov-VR. Lots of helpful people there!

Setting up a dedicated server

2023-05-26T03:02:52Z

SaltedCrackerJack: /* "PlayerInfo": */

== Setting up a dedicated server ==

'''There are no Windows binaries'''

This guide is written exclusively for Linux and covers Ubuntu/Debian/Debian-like and Red Hat RPM-based distros. Possible to run with other distros, but some of the commands won't work and you will need to know enough to figure out the software install of dependencies on your own.

If you are considering hosting from home, please read that section of the wiki first.

This guide assumes you know the basics of using a bash terminal: ssh'ing into a server, running bash commands, editing text files, etc.

If you have no experience using bash, maybe start [https://www.howtogeek.com/140679/beginner-geek-how-to-start-using-the-linux-terminal/ here]. Editing text files via commandline is often a challenge. Suggest using nano and reading guide [https://www.howtogeek.com/howto/42980/the-beginners-guide-to-nano-the-linux-command-line-text-editor/ here]

If you are new to linux and accessing your server from Windows, highly suggest using MobaXterm as your SSH client as that can make required editing of text files easier using built in editor instead of the native linux command line editors.

And finally, ask yourself why you want to setup a server? If you look at the list, there are many, many more servers than players. If you don't have a team, discord community, or group of friends ready to play on your server, chances are it will go unused. Got one of these... great, let's go.

If you don't want to go through the hassle yourself and want to pay for a hosting service Arctic VR (PC and Shack) and Horde (Shack) provide a server hosting services and are trusted in the community. See links below.

----

=== Server Requirements ===

'''Pavlovserver can only be hosted under Linux.'''

This can be running as a VM under windows, but this will increase the complexity of the setup beyond this guide.

Ubuntu 18.04 x86_64, Ubuntu 19/04 amd64, Ubuntu 20.04, and Rocky Linux 8 are confirmed working. Ubuntu 15.04 x86 is known to fail to install using this guide. Recommend not running on "minimal" images as some tools are missing.

* 2GB RAM + 1GB RAM per each additional server with 10 players. More RAM is recommended for larger maps, higher player counts, or complex gamemodes. Not having enough RAM is a common cause of server crashes.

* A ~2.5Ghz CPU will comfortably support a 10 player server.

* A ~4Ghz CPU will comfortably support 24 players. This is a limit built into Pavlov itself, no server will allow players to join over 24. Lower player counts are recommended for complex gamemodes (E.g. CodZ) and/or highly detailed maps, so that maximum number will often be lower.

(Note that these are '''not''' hard limits for player counts, just suggestions for the best performance, based on experiences with many server providers on different grades of hardware.)

* Pavlovserver is functionally single threaded (one thread does vast majority of work). More CPUs only help if you are running more servers. More clockspeed = higher performance = more users per server.
The maximum number of servers you can run is dependent on how many CPUs you have. For example, if you have an 8 core CPU, the maximum number of servers would be 7. You should always have at least one CPU free as overhead, as Pavlov servers can use slightly more than one thread.

----

==== Hosting at home ====
When hosting at home there are additional requirements regarding networking: Your router has to support port-forwarding, hair-pinning/LoopbackNAT, and respond to ping requests. These techniques are necessary to allow your server to be found and to talk back to the client. please see https://en.wikipedia.org/wiki/Port_forwarding, https://en.wikipedia.org/wiki/Hairpinning, and https://www.speedguide.net/faq/how-to-become-pingable-behind-a-routerfirewall-376 for more info and google for these terms in addition to your router model to find guides on how to enable/configure it properly. If you have modern Router, it may have these features already enabled, in this case you just have to configure port-forwarding. If you can see your server but not join it while others can, this is indicative of a failure of LoopbackNAT.

A second challenge to hosting at home is CGNAT (Carrier grade NAT: https://www.a10networks.com/blog/carrier-grade-nat/). Just like NAT on your home network that has to be gotten around w/ port-forwarding, CGNAT breaks the ability of external connections to be made back to your server, but the controls are solely in your ISPs hands. Sometimes if you ask, you can be removed from CGNAT pools and/or assigned a static IP. CGNAT rollouts are becoming very common now, so if your server worked then doesn't allow connections now, your ISP may have made this change.

You can check whether you’re on a CGNAT network by visiting a Web site such as ipaddress.com or whatsmyip.com and comparing the IP address listed to the public/WAN IP address assigned to your Internet gateway. To find your gateway’s public IP address, check the status page in the administrative interface. If the two IP addresses differ, you’re likely on a CGNAT network. If so, this problem must be resolved before you go any further.

'''Not understanding these requirements and configuration is a frequent cause of failed setups and questions in discord. Don't skip this if you are trying to host from home'''

'''There are serious security implications of hosting this software at home.''' None of the devs are security experts and there has been no security review of the code. You are opening up your system to the world and publicity advertising this fact. Expect that any system hosting this software is open to compromise from the Internet and act accordingly. If your router offers a DMZ network, use it. Consider hosting on a cloud based server and think twice before running this software on any system that contains data you care about or has access to networks and computers you care about.

If you're hosting at home using Oracle's VirtualBox, there are steps you can take to prevent double NAT (which can cause issues later on)

1. Select your VM and then click Settings in VirtualBox's main window.

2. Click on Network and change Attached To from NAT to Bridged Adapter.

Once you've done this, your VM should be connected directly to your home router and double NAT should no longer be a issue.
----

==== Hosting Providers ====

Considering the suggested server specs, you may be interested in the following hosting providers. For providers promising dedicated "Pavlov hosting" as opposed to general VPS services please contact and ask how you change maps being hosted and how you get RCON access before you put your money down.

<pre>
Provider | Base CPU | Details
Arctic VR | 4.5 GHz | https://www.arctic-vr.com/server-hosting
Amazon Web Services | 4.0 GHz | https://aws.amazon.com/ec2/instance-types/z1d/
VULTR | 4.0 GHz | https://www.vultr.com/products/high-frequency-compute/
packet.com | 3.5 GHz | https://www.packet.com/cloud/servers/c1-small/
Google Cloud Platform | 3.2 GHz | https://cloud.google.com/compute/docs/cpu-platforms
</pre>

===== ARCTIC VR =====

Arctic VR is the largest and longest running Pavlov VR hosting provider. The In-Game Admin Menu is exclusive to the ArcticVR hosting service. They offer EU, NA East and NA West servers for both shack and PCVR. ArcticVR offers the fastest Pavlov servers as well as DDos Protection, RCON remote management, custom maps, low pings, unlimited slots, and expert support.

Website: https://www.arctic-vr.com/server-hosting

[[File:Arctic_options.png|link=https://www.arctic-vr.com/server-hosting|700px]]

===== VULTR =====

Consider using a referral from the community:

Carlos: https://www.vultr.com/?ref=8615589-6G

Carrot: https://www.vultr.com/?ref=8689348

Archaeo: https://www.vultr.com/?ref=8653652-6G

Cheeto: https://www.vultr.com/?ref=8717358

For a Pavlov Shack server, I recommend minimum Cloud Compute, Intel High Performance, Ubuntu 20.04, and disabled automatic backups. At the time, this was $6/m. Some of the cheap options have 1TB bandwidth, and some have 2TB+. If it's a personal server, 1TB could be fine, but 2TB should be safe.

===== Google Cloud Platform (90 day free credit available) =====

The below configuration is successfully running 4 pavlov PC instances with ~15 total maps and up to 24 players per server. If you want more maps use larger boot disk. Both can dynamically be scaled based on popularity.

<pre>

Menu -> compute engine -> VM instances
create instance
- region: wherever you like
- machine type: n1-highcpu-4 (4 vCPUs, 3.6 GB memory)
- boot disk: Ubuntu 20.04
- boot disk -> size: 25gb
- network tags: pavlov-server
- [create]

Menu -> Vpc network -> firewall rules
[Create firewall rule]
Name: pavlov server
Target Tags: pavlov-server
Source IP Ranges: 0.0.0.0/0
Protocols and Ports -> Specified protocols and ports -> UDP: 7777, 8177 (Shack and PC)
Protocols and Ports -> Specified protocols and ports -> TCP: 7777, 8177 (Shack-only)
Protocols and Ports -> Specified protocols and ports -> TCP: {RCON port - default 9100}
[save]
</pre>

===== Amazon Web Services (30 day free credit available) =====

<pre>
Login -> Change Region: Choose your region
Services -> Compute -> EC2 -> Create
Choose an AMI: Ubuntu 18.04
Instance Type: z1d.large

Instance Details -> Tenancy: Dedicated (optional: this will more than triple the cost)

Storage: 50gb disk (or whatever, you're in control of the map roster)

Security Groups:
Create a new Security Group
Security group name: pavlov-server
Description: pavlov server
Rules:
Type: Custom ICMP Rule - IPV4 / Protocol: Echo Request
Type: Custom UDP Rule / Port Range: 7777 / Source: 0.0.0.0/0
Type: Custom UDP Rule / Port Range: 8177 / Source: 0.0.0.0/0
Type: SSH (optional, but I assume you wanna SSH in..)

Launch -> Create new Keypair -> Download -> Launch

Once it's started, SSH in like:
$ ssh -i your-key.pem ubuntu@you-server-details.amazonaws.com

(I use cmder on Windows, if you're using putty or mobaxterm or something, might be different)
</pre>

=== Starting Server Install ===

====Obtaining an ApiKey====
For your server to show up in the server list, there is now a requirement to have an ApiKey issued by vankrupt. This is to prevent DOS attacks against the master server

Get the key by going here: https://pavlov-ms.vankrupt.com/servers/v1/key and using your mobile number to get a SMS
(note that there have been reported failures of this SMS system for non-US mobiles. In this case DM davevillz your mobile and ask for a key)

Put this key in your Game.ini as follows:
ApiKey="ABC123FALSEKEYDONTUSEME"
or if you would like (personally untested..I would use game.ini) you can call it at server runtime with flag as follows:
-KEY="ABC123FALSEKEYDONTUSEME"

This key can be re-used for a reasonable number of servers (a limit of 10 has been mentioned). Contact the Devs if you need more servers per key.

====System setup and software installation====

Install dependencies and create the `steam` user. (You only need to do this once):

Confirm Linux version
<pre>
lsb_release -a
</pre>

'''Ubuntu 20.04'''
<pre>
sudo apt update && sudo apt install -y gdb curl lib32gcc1 libc++-dev unzip
sudo useradd -m steam
</pre>

'''Ubuntu 20.10 or higher'''
<pre>
sudo apt update && sudo apt install -y gdb curl lib32gcc-s1 libc++-dev unzip
sudo useradd -m steam
</pre>

'''Rocky Linux, CentOS 8, and RHEL 8'''

<pre>
sudo sed -i 's/^SELINUX=enforcing$/SELINUX=permissive/g' /etc/selinux/config
sudo setenforce 0
sudo yum install gdb curl glibc.i686 libstdc++.i686 libstdc++-devel.i686 libstdc++-devel.x86_64 unzip wget -y
wget https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/l/libcxx-3.8.0-3.el7.x86_64.rpm
sudo rpm -i libcxx-3.8.0-3.el7.x86_64.rpm
sudo useradd -m steam
</pre>

[Optional] Set a password for steam.
<pre>sudo passwd steam</pre>

Login as the steam user. ('''You will need to do this each time you connect to your server'''):

<pre>
sudo su -l steam
</pre>

Install Steam:

<pre>
mkdir ~/Steam && cd ~/Steam && curl -sqL "https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz" | tar zxvf -
</pre>

There are different dedicated server versions for Pavlov Server - choose which server version you want to host (PC non-beta, PC Beta, Shack Live, or Shack RC)
(You will need to run this command each time there is a Pavlov Server update). 
To host '''PC Server (non-beta)''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 +exit
</pre>

To host '''PC BETA''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta beta_server +exit
</pre>

To host '''Shack Live''' (Quest):

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack +exit
</pre>

To host '''Shack RC''' (Quest): 

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack_beta +exit
</pre>

Now that we've installed the server, all pavlov server versions should continue. 
Install a fresh copy of steamclient.so (May have to do this after each update):
<pre>
~/Steam/steamcmd.sh +login anonymous +app_update 1007 +quit
mkdir -p ~/.steam/sdk64
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/pavlovserver/Pavlov/Binaries/Linux/steamclient.so
</pre>

Make the PavlovServer script executable. (You only need to do this once):

<pre>
chmod +x ~/pavlovserver/PavlovServer.sh
</pre>

----

=== Server Configuration ===

Before starting the server we need to configure it. Start by creating some directories:

<pre>
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Logs
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps
</pre>

==== Mods/Blacklist/Whitelist (optional) ====

The following three files allow you to specify mods, banned players, and whitelist players. These are optional, but go ahead and create them. Populating the files is described later.

<pre>
touch /home/steam/pavlovserver/Pavlov/Saved/Config/mods.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/blacklist.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/whitelist.txt
</pre>

====Configuring Game.ini====
Create a new Game.ini file using following command to open an editor and copy/paste the following block into it then save it. Note not all of these options are required. For instance remove or comment out the Password=0000 line to make a public server with no pin.
<pre>
nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini
</pre>

<pre>
[/Script/Pavlov.DedicatedServer]
bEnabled=true
ServerName="My_private_idaho"
MaxPlayers=10 #Set this to 10 for Shack. 24 is the max for PC, setting it higher will not allow players to join.
ApiKey="ABC123FALSEKEYDONTUSEME"
bSecured=true
bCustomServer=true
bVerboseLogging=false
bCompetitive=false #This only works for SND
bWhitelist=false
RefreshListTime=120
LimitedAmmoType=0
TickRate=90
TimeLimit=60
#Password=0000
#BalanceTableURL="vankruptgames/BalancingTable/main"
MapRotation=(MapId="UGC1758245796", GameMode="GUN")
MapRotation=(MapId="datacenter", GameMode="SND")
MapRotation=(MapId="sand", GameMode="DM")

</pre>

* '''bEnabled''' - whether the server appears in the server list (unconfirmed)
* '''ServerName''' - name it will be listed as. (approx 35 chars max)
* '''MaxPlayers''' - See suggested specs for limits. 10 standard (10 for shack), 20-24 is max recommended for large maps like Stalingrad or PUSH/RUSH modes, and servers allow a maximum of 24 players.
* '''ApiKey''' - Unique ApiKey required to register server with master server. Replace with your key
* '''bSecured''' - enabled Valve Anti-Cheat (VAC)
* '''bCustomServer''' - activates some new modding tools (save and http functions. Required to write to blacklist.txt for bans)
* '''bCompetitive''' - sets the server to competitive mode for SND. If removed the server will default to false
* '''bVerboseLogging''' - enables verbose logging, mostly detailed statistics. Be prepared for significant increase in logging.
* '''bWhitelist''' - Only allow users in whitelist.txt to join
* '''RefreshListTime''' - sets how often the running server checks for updates in ban/whitelist/mod files
* '''LimitedAmmoType''' - sets limited ammo mode
0 = Unlimited
1 = Limited Generic
2 = Limited Specific
3 = Custom (for modders)
4 = Limited Special
5 = Boxless Mode

* '''TimeLimit''' - sets time limit for each map
* '''TickRate''' - sets the server tickrate. (so far minimum stable seems around 50 and max around 120. Beware setting this changes weapon despawn time and breaks some game modes. Recommend not touching)
* '''Password''' - PIN number for server #FYI - this is now also changeable via rcon.
* '''BalanceTableURL''' - Points to a custom balance table from github. See https://github.com/vankruptgames/BalancingTable for instructions. This line isn't needed if you don't have one.
* '''MapRotation''' - you can add multiple of these. The MapId must be “UGC” followed by the map ID. you can find the map id in the URL of the steam workshop page. When a match ends, the server will load the next map in the rotation. You can also use RCON to switch to a map not included in rotation.

Available game modes as of 09/06/2022: SND, TDM, DM, GUN, ZWV, WW2GUN, TANKTDM, KOTH, TTT, OITC, INFECTION, HIDE, PUSH, PH 

And for Shack only: CTF

For maps running a Custom gamemode (CodZ, BR, Duel, etc.) it doesn't matter which gamemode you choose, as the map will automatically override it with the custom mode.

UGC###### are for custom maps from Steam workshop (PC Only). Find the map you want in the workshop. This is the URL for Mirage (https://steamcommunity.com/sharedfiles/filedetails/?id=2670152485). The 10 numbers at the end of the URL are what you need, so UGC1661803933 would be the MapId for Mirage.

==== Firewall/Port forwarding ====
Using the default settings there are two UDP ports (7777, 8177) that need to be allowed to access the server either by firewall setup or port forwarding.

'''Ubuntu''' firewall commands to check firewall and open ports:
<pre>
sudo ufw status
sudo ufw allow 7777
sudo ufw allow 8177
sudo ufw allow 9100
sudo ufw status
</pre>

'''Rocky Linux''' firewall commands to check firewall and open ports:
<pre>
sudo firewall-cmd --zone=public --add-port=7777/tcp
sudo firewall-cmd --zone=public --add-port=7777/udp
sudo firewall-cmd --zone=public --add-port=8177/tcp
sudo firewall-cmd --zone=public --add-port=8177/udp
sudo firewall-cmd --zone=public --add-port=9100/udp
sudo firewall-cmd --zone=public --add-port=9100/tcp
sudo firewall-cmd --list-ports
firewall-cmd --runtime-to-permanent
</pre>

You may also need to allow Pings (ICMP) for the server's true latency to appear in the master list.

If you are running multiple servers and have set additional ports (see http://wiki.pavlov-vr.com/index.php?title=Dedicated_server#Running_multiple_servers_on_one_host) then you need to allow access to the defined port plus the port 400 higher. So if you use 7000 as your port, then UDP 7000 and 7400 need to be open

If you have setup rcon via RconSettings.txt (below) then that port also need to be allowed access via TCP

If you are running Shack/Quest and want to have maps that are downloadable from your server, your server ports (ex. 7777 & 8177) must also be open via TCP

----

==== Shack Maps (Quest) ====

If you try to use the steps above to add maps for Shack, youll run into issues very quickly. This is because Shack has no affiliation to Steam, and therefore cannot use Steam Workshop maps like above. In the future, these steps will apply to PC servers as well, allowing a server to hold the map itself, instead of offloading to Steam.

To get started, first create the directory to hold the maps

<pre>mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps</pre>

You can use any number of methods to move the map files onto the server, but ill go over the two simplest, starting with a GUI approach

Download and install CyberDuck onto your "home" PC (Whatever PC you use for access to the server, but not the server itsself): https://cyberduck.io/

Next, download and unzip your map of choice from https://www.pavlovquest.com/ , https://pavlovhorde.com/mapsList, or look in #shack-map-showcase channel in the discord server. I'm going to use Cheeto's WW2 Items test (http://www.mediafire.com/file/emyt9bs1z9u9ykw/SVR_Cheeto_Items.zip/file ) for this example, you do what you like

In the top left corner, open a connection, set the connection type to SFTP, and fill in the rest of the information. User will be root, password is whatever you set the root pw as (toor in Ubuntu by default)

In the directory dropdown (itll say /root) go back to /

Follow the directories until we arrive back at our "maps" folder <pre>/home/steam/pavlovserver/Pavlov/Saved/maps</pre>

Drag and drop the unzipped map folder into the main window, in this case itll be SVR_Cheeto_Items

Hit Allow

Youll now see a folder named SVR_Cheeto_Items, and within it should be nothing but 3 files. If there is another folder in it, move this folder to the maps directory, otherwise the server wont work. The 3 files (2 .PAK one .JSON) should be in home/steam/pavlovserver/Pavlov/Saved/maps/SVR_Cheeto_Items, no more, no less.

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

To play the map, you can either use RCON switch map command, or to add the map to your servers automatic map rotation list, add the map's folder name to your Game.ini. This replaces the MapID section, so for our example it would be

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

And thats all! Disconnect CyberDuck from your server before playing, otherwise youll have difficulty joining.

-----------

==== Adding Shack Maps over Command Line Interface ====

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

A bit more complicated, but adding maps over CLI has its benefits

First, CD to the maps directory you made above

<pre>cd ~/pavlovserver/Pavlov/Saved/maps</pre>

Download the map files from whatever you use to upload them. To do this, you can either use curl or wget

<pre>curl -O insertURLhere</pre>

'''If you download your map from Google Drive''', make sure that your .zip folder is shared to anyone.
Then, get the file's url from the shared link. Example : ''<nowiki>https://drive.google.com/file/d/19bI8gUHaN5tUrDvnadAacUnchQf6_k/view</nowiki>'' will be ''19bI8gUHaN5tUrDvnadAacUnchQf6_k''
Edit "fileId" and "fileName" before you execute the command.
<pre>
fileId=19bI8gUHaN5tUrDvnadAacUnchQf6_k
fileName=SVR_USER_MAPNAME
curl -sc /tmp/cookie "https://drive.google.com/uc?export=download&id=${fileId}" > /dev/null
code="$(awk '/_warning_/ {print $NF}' /tmp/cookie)"
curl -Lb /tmp/cookie "https://drive.google.com/uc?export=download&confirm=${code}&id=${fileId}" -o ${fileName} </pre>

To keep with the Items example:

<pre>curl -O https://cdn.discordapp.com/attachments/744185280759857234/745027406695366788/SVR_Cheeto_Items.zip</pre>

Next, unzip the file. If this next step errors out, saying the command is unknown, switch back to the root user (su root), and install unzip (sudo apt install unzip), then return to the steam user, and continue.

<pre>unzip SVR_Cheeto_Items.zip</pre>

Now finish like before by adding the map to your Game.ini

<pre>nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini</pre>

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

==== Admin/Moderator list (optional) ====

The only working in-game admin menu is through Arctic VR server hosting (see below).

If you add moderators to your server, they will not be subject to vote kicks.

<pre>
nano ~/pavlovserver/Pavlov/Saved/Config/mods.txt
</pre>

Example Mod List:
<pre>
76541198397498572 #Optional Comment: Player name
76541198397498573 #Some Other Player
</pre>

==== ArcticVR Admin Menu ====

[[File:Arcticmenu.jpg|500px|link=https://www.arctic-vr.com/server-admin-menu]]

Arctic-VR Offers an advanced In-Game Admin menu that is exclusive to their hosting service. Features include:
* Switch Maps+Modes
* Teleport Players to Players
* Change Player Skins
* Control Player Buying+Cash
* Spawn Items
* Clean up corpses + guns
* Spawn Bots
* Spawn Items for other players
* Control Teams + Balance/Shuffle Teams
* ResetSND
* And More

You can read more about the ArcticVR admin menu on their website: https://www.arctic-vr.com/server-admin-menu

==== Handy tools for finding steamIDs ====

Steam ID finder: https://steamidfinder.com/lookup/ or https://steamid.xyz/

You want to enter in the steamID64 format.

This tool can convert or lookup IDs: https://steamid.io/

If you are looking for a steamID of a player that has been on your server recently this is technique to find them:
<pre>
grep -i playername ~/pavlovserver/Pavlov/Saved/Logs/* | grep TicketValidation
</pre>

=== Configure Rcon ===
To enable Rcon access create config file:
<pre> nano /home/steam/pavlovserver/Pavlov/Saved/Config/RconSettings.txt </pre>

Copy in the following text - change password, and if desired the port:
<pre>
Password=ChangeThisPassword
Port=9100
</pre>
You must specify a port for the Rcon server to use as well as a Password (use a different port per sever instance if running multiple server instances off the same hardware)

=== Starting the server ===

<pre>
cd ~/pavlovserver && ./PavlovServer.sh
</pre>

That's it, your server will be automatically broadcast to the master server! :)

Two handy tools to determine quickly if your server is broadcasting are [https://pablub.xyz/ Pablub] (PC only) and [https://pavlovhorde.com/ Horde] (Shack) and [https://pavlovhorde.com/pcServers Horde] (PC version)

Note that when you close your terminal, the server will go down. See the "supervisors" section below for how to prevent this.

=== Auto-updating the server ===

Assuming you have followed this guide and used the default paths, users, and install instructions, you can paste the following into your terminal to auto-update your Pavlov server:

<pre>
cat << 'EOF' > $HOME/pavlov_daily_update_and_restart.sh
#!/bin/bash

USER="steam"
SERVICENAME="pavlovserver.service"
INSTALLDIRNAME="pavlovserver"
USERHOME="/home/$USER"

echo -e "Beginning Pavlov VR update run on $(date)\n\n"

systemctl stop "$SERVICENAME"

sleep 5
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +force_install_dir "$USERHOME/$INSTALLDIRNAME" +app_update 622970 +exit
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +app_update 1007 +quit
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/.steam/sdk64/steamclient.so"
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/pavlovserver/Pavlov/Binaries/Linux/steamclient.so"

systemctl start "$SERVICENAME"

echo -e "Ending Pavlov VR update run on $(date)\n\n"

EOF

chmod +x $HOME/pavlov_daily_update_and_restart.sh
mkdir $HOME/pavlov_update_logs && touch $HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log
CRONLINE="00 2 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
(sudo crontab -u root -l; echo "$CRONLINE" ) | sudo crontab -u root -
unset CRONLINE

</pre>

These commands will:

1. Create a shell script in the "steam" user's home directory that automatically stops the Pavlov server, pulls any updates via steam, pull updates to the Steamworks SDK Redist, and copies the latest version of steamclient.so to the Pavlov server directory

2. Make the shell script executable

3. Create a new directory called "pavlov_update_logs" in the "steam" user's directory, and create a logfile inside that directory called "pavlov_daily_update_and_restart.sh.log". You can check this logfile to see the output of the Pavlov and Steam SDK update commands.

4. Create a crontab entry for the root user that runs this shell script automatically every day at 2:00AM local time

If you want to change the time that this script runs, edit the numbers "00 2" in the line that starts with "CRONLINE=". In the example provided, 00 is the minutes column, and 2 is the hour column. For example, if you wanted the server to automatically update and restart at 4:17AM every day, change the line starting with "CRONLINE=" to:

<pre>
CRONLINE="17 4 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
</pre>

If the time is PM, use 24-hour time format, e.g. "32 18" for 6:32PM.

----

=== Supervising the server using systemd ===

Running '''./PavlovServer.sh''' in your interactive shell is easy, but the server will shut down when you close your terminal. If you want to run the server in the background,
you'll want to run it under a supervisor. There are many options, ranging from the simple (nohup, screen or tmux), to the
more robust (supervisord, systemd).

Systemd is running by default on Ubuntu Linux, so we'll use that here.

To run the server as a systemd service, create the file '''/etc/systemd/system/pavlovserver.service''' (as root) by typing
<pre>
sudo nano /etc/systemd/system/pavlovserver.service
</pre>

Copy contents below into the file and save.

<pre>
[Unit]
Description=Pavlov VR dedicated server

[Service]
Type=simple
WorkingDirectory=/home/steam/pavlovserver
ExecStart=/home/steam/pavlovserver/PavlovServer.sh

RestartSec=1
Restart=always
User=steam
Group=steam

[Install]
WantedBy = multi-user.target
</pre>

If you'd like your server to start as competitive without editing the game.ini, change the line "ExecStart=/home/steam/pavlovserver/PavlovServer.sh" to look like this below. Though it's much easier to just use the game.ini to enable competitive instead. <pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -COMPETITIVE=1</pre>

Change the user or paths as appropriate. After saving the service file, to start, restart, stop, or monitor the server:

<pre>
sudo systemctl start pavlovserver
sudo systemctl restart pavlovserver
sudo systemctl stop pavlovserver
sudo systemctl status pavlovserver
</pre>

To view the logs:

<pre>
sudo journalctl -u pavlovserver
# to live-tail the logs
sudo journalctl -u pavlovserver -f
</pre>

If you want to run the pavlov server as soon as your server boots (e.g. a VPS you turn on and off), add pavlov as a startup service:

<pre>
sudo systemctl enable pavlovserver
</pre>

----

== Advanced Server Administration ==

=== Running multiple servers on one host ===

* Pavlovserver is functionally single threaded (there are multiple threads, but vast majority of work occurs in the primary one). Make sure you have # of pavlovservers + 1 CPU available. More CPUs= more servers. Faster CPU = more players.
* Make multiple server installs by defining a separate install dir for each server.
* Run each server with a unique port. eg: '''./PavlovServer.sh -PORT="Desired Port"'''
* The Server will use the Desired Port and the Port 400 above (Example: You choose 8200 as Port. So Port 8600 will be used as well)
* If you are using RCON, each server will need a unique port defined in RconSettings.txt
* Ensure the ports are forwarded and opened in your firewall

To duplicate directories:

be in the steam home folder
<pre>
cp -r pavlovserver pavlovserver1
/home/steam/pavlovserver1/PavlovServer.sh -PORT=[Desired Port]
</pre>

=== Starting server in competitive mode ===
Competitive mode will prevent dead teammates from being able to see the match, to prevent ghosting.
You can either enable this via Game.ini (described in Game.ini file), or using the -COMPETITIVE=1 parameter.

<pre>
/home/steam/pavlovserver1/PavlovServer.sh -COMPETITIVE=1
</pre>

== Automated RCON examples ==
here are some examples of scripts that interact with Pavlov RCON

* '''<big>Inspect players every 5 minutes</big>''' [https://github.com/JTWP-org/inspect-every-5-mins (installation instructions on GITHUB )]

This [https://www.gnu.org/software/bash/ BASH] script will collect current players stats for every one. then it will write them to a log in JSON format that can easily be handled for your records or the next project ..

{| class="wikitable"

|}

----

=== Useful Linux Commands ===

List files / folders in directory, print current working directory,
<pre>ls -la #list files/directories along with authorities and ownership
pwd #print working directory
sudo chown <owner> <file/directory> #change owner of file/directory. If root created something and you need to change it to steam
sudo chgrp <group> <file/directory> #change group of file/directory.
</pre>

Check if pavlov is running by checking process status. If the only row you see is the grep command, pavlov server is not started.
<pre> ps -ef | grep pav </pre>

Sample output:
<pre>
steam 34044 1 0 16:52 ? 00:00:00 /bin/sh /home/steam/pavlovserver/PavlovServer.sh
steam 34066 34044 80 16:52 ? 00:00:04 /home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer
zombies+ 34101 34013 0 16:52 pts/0 00:00:00 grep --color=auto pav
</pre>

Kill a process. Note this command uses 34044, which is a process id from the command output above.
<pre> kill -9 34044 </pre>

Dump the log to the console so you can scroll through it:
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log </pre>

Search the log for a string - replace my_string with case-sensitive string
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep my_string </pre>

=== Default Map ID's ===
datacenter

sand

bridge

containeryard

siberia (Prison Break)

hospital (Zombies map)

killhouse

range

tutorial

santorini

station

industry

ogcontainers (Shack only)

haguenau (Shack only)

foundation (Shack only)

stalingrad (PC only)

stalingrad_night (PC only)

santorini_night (PC only)

sand_night (PC only)

station_night (PC only)

industry_night (PC only)

bunker (PC only)

=== Automated server log backup ===

here is how to setup a bash script to 1x a day compress all log files and save them to protect from auto deletion it will also post a discord webhook to confirm its working and saved the days logs

https://github.com/JTWP-org/backUpLogs

== Troubleshooting ==

To run the server without outputting the heartbeat:

<pre>./PavlovServer.sh | sed '/heartbeat/d'</pre>

To monitor the logs (without heartbeat) from another terminal:

<pre>tail -f -n10000 /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep -v 'Sending heartbeat to masterserver'</pre>

Check your CPU Clock Speed with:

<pre>lscpu | grep MHz</pre>

=== Server won't start ===

Error message:
<pre>
ln: failed to create hard link '/home/steam/.steam/sdk64/steamclient.so': File exists
ln: failed to create hard link '/home/steam/pavlovserver/Pavlov/Binaries/Linux/steamclient.so': File exists
/home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer: error while loading shared libraries: libc++.so.1: cannot open shared object file: No such file or directory
</pre>

First two errors are harmless. The third one is because libc++ step was skipped or failed. Using sudo capable id (probably not steam id), [re]run this line:
<pre>sudo apt update && sudo apt install -y gdb curl lib32gcc1 libc++-dev unzip </pre>

=== Map wont load (kicks to datacenter) ===

try deleting all the downloaded workshop maps with:

<pre>sudo rm -rf /tmp/workshop/7777/content/555160/*</pre> for all maps or

<pre>sudo rm -rf /tmp/workshop/7777/content/555160/whatever-UGC</pre> for specific map

=== Map wont load when running in a container ===
The three typical container problems I have seen:

1) Steam can't write to /tmp for some reason

2) /tmp is actually tmpfs instead of real filesystem and a few gigs of maps runs you out of RAM

3) Made worse by fact that pavlovserver unpacks downloads to ram, then writes to /tmp/workshop. Not enough RAM to do this, no map for you.

=== Server stuck rotating forever ===

Run these 2 commands, then restart your server:

<pre>cd ~/Steam && ./steamcmd.sh +login anonymous +app_update 1007 +quit
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so</pre>

If this doesn't fix it, double check that your server isn't running on the same port as another, by running this command:

<pre>ps -ef | grep pav</pre>

Then if 2 servers are on the same port, you can fix it by editing the pavlovserver.service file, and making sure the following line:

<pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -PORT=Number</pre>

has a unique number after the port for each server you're running.

=== Server - ping 999 ===
Google Cloud Platform - Make sure your compute engine has a network tag and your network rules are applied to the tag.
Make sure you opened the specified ports.

Network testing tools:
Test if your server will respond to ping from outside your network:
https://www.wormly.com/test-remote-ping

Test if your ports are accessible via UDP (7777,8177,9100):
https://www.ipvoid.com/udp-port-scan/

=== Can't connect to RCON ===
Check the file and group owner of RconSettings file. It should be steam, or the ID used to run the pavlov server.
<pre>
cd /home/steam/pavlovserver/Pavlov/Saved/Config
ls -la
</pre>

If the owner/group are not steam, using root or an id with sudo authority, change them to steam, confirm they are now set properly, then restart the pavlov server. (Note - if Rcon has wrong permissions, after fixing you should also to check the other config files like Game.ini, mods/blacklist/whitelist for the same issue. If steam can't access these files, it could cause problems.).
<pre>
cd /home/steam/pavlovserver/Pavlov/Saved/Config
sudo chown steam RconSettings.txt
sudo chgrp steam RconSettings.txt
ls -la </pre>

=== PC ONLY - Map Download stops ===

When downloading a large map from the steam workshop make sure your VPS/Dedi or Shared hosting provider (Otherwise known as a GSP's) has enough RAM assigned to store the map files in its tempfs (stored in ram)!

This is less likely to happen on Dedicated servers and VPS with a decent amount of ram unless you are using docker with RAM limits!

Most GSP's will be using docker or some other type of jailing method to limit system resource allocations and direct access to the host machine, if they are and you know what map you want to use make sure you order a service with enough ram to store your map. If in doubt contact your GSP's support team.

=== Getting Help ===

There's a #pc-custom-servers channel on the official Pavlov Discord - https://discord.gg/Pavlov-VR. Lots of helpful people there!

Setting up a dedicated server

2023-05-26T03:01:23Z

SaltedCrackerJack: /* Automated RCON examples */

== Setting up a dedicated server ==

'''There are no Windows binaries'''

This guide is written exclusively for Linux and covers Ubuntu/Debian/Debian-like and Red Hat RPM-based distros. Possible to run with other distros, but some of the commands won't work and you will need to know enough to figure out the software install of dependencies on your own.

If you are considering hosting from home, please read that section of the wiki first.

This guide assumes you know the basics of using a bash terminal: ssh'ing into a server, running bash commands, editing text files, etc.

If you have no experience using bash, maybe start [https://www.howtogeek.com/140679/beginner-geek-how-to-start-using-the-linux-terminal/ here]. Editing text files via commandline is often a challenge. Suggest using nano and reading guide [https://www.howtogeek.com/howto/42980/the-beginners-guide-to-nano-the-linux-command-line-text-editor/ here]

If you are new to linux and accessing your server from Windows, highly suggest using MobaXterm as your SSH client as that can make required editing of text files easier using built in editor instead of the native linux command line editors.

And finally, ask yourself why you want to setup a server? If you look at the list, there are many, many more servers than players. If you don't have a team, discord community, or group of friends ready to play on your server, chances are it will go unused. Got one of these... great, let's go.

If you don't want to go through the hassle yourself and want to pay for a hosting service Arctic VR (PC and Shack) and Horde (Shack) provide a server hosting services and are trusted in the community. See links below.

----

=== Server Requirements ===

'''Pavlovserver can only be hosted under Linux.'''

This can be running as a VM under windows, but this will increase the complexity of the setup beyond this guide.

Ubuntu 18.04 x86_64, Ubuntu 19/04 amd64, Ubuntu 20.04, and Rocky Linux 8 are confirmed working. Ubuntu 15.04 x86 is known to fail to install using this guide. Recommend not running on "minimal" images as some tools are missing.

* 2GB RAM + 1GB RAM per each additional server with 10 players. More RAM is recommended for larger maps, higher player counts, or complex gamemodes. Not having enough RAM is a common cause of server crashes.

* A ~2.5Ghz CPU will comfortably support a 10 player server.

* A ~4Ghz CPU will comfortably support 24 players. This is a limit built into Pavlov itself, no server will allow players to join over 24. Lower player counts are recommended for complex gamemodes (E.g. CodZ) and/or highly detailed maps, so that maximum number will often be lower.

(Note that these are '''not''' hard limits for player counts, just suggestions for the best performance, based on experiences with many server providers on different grades of hardware.)

* Pavlovserver is functionally single threaded (one thread does vast majority of work). More CPUs only help if you are running more servers. More clockspeed = higher performance = more users per server.
The maximum number of servers you can run is dependent on how many CPUs you have. For example, if you have an 8 core CPU, the maximum number of servers would be 7. You should always have at least one CPU free as overhead, as Pavlov servers can use slightly more than one thread.

----

==== Hosting at home ====
When hosting at home there are additional requirements regarding networking: Your router has to support port-forwarding, hair-pinning/LoopbackNAT, and respond to ping requests. These techniques are necessary to allow your server to be found and to talk back to the client. please see https://en.wikipedia.org/wiki/Port_forwarding, https://en.wikipedia.org/wiki/Hairpinning, and https://www.speedguide.net/faq/how-to-become-pingable-behind-a-routerfirewall-376 for more info and google for these terms in addition to your router model to find guides on how to enable/configure it properly. If you have modern Router, it may have these features already enabled, in this case you just have to configure port-forwarding. If you can see your server but not join it while others can, this is indicative of a failure of LoopbackNAT.

A second challenge to hosting at home is CGNAT (Carrier grade NAT: https://www.a10networks.com/blog/carrier-grade-nat/). Just like NAT on your home network that has to be gotten around w/ port-forwarding, CGNAT breaks the ability of external connections to be made back to your server, but the controls are solely in your ISPs hands. Sometimes if you ask, you can be removed from CGNAT pools and/or assigned a static IP. CGNAT rollouts are becoming very common now, so if your server worked then doesn't allow connections now, your ISP may have made this change.

You can check whether you’re on a CGNAT network by visiting a Web site such as ipaddress.com or whatsmyip.com and comparing the IP address listed to the public/WAN IP address assigned to your Internet gateway. To find your gateway’s public IP address, check the status page in the administrative interface. If the two IP addresses differ, you’re likely on a CGNAT network. If so, this problem must be resolved before you go any further.

'''Not understanding these requirements and configuration is a frequent cause of failed setups and questions in discord. Don't skip this if you are trying to host from home'''

'''There are serious security implications of hosting this software at home.''' None of the devs are security experts and there has been no security review of the code. You are opening up your system to the world and publicity advertising this fact. Expect that any system hosting this software is open to compromise from the Internet and act accordingly. If your router offers a DMZ network, use it. Consider hosting on a cloud based server and think twice before running this software on any system that contains data you care about or has access to networks and computers you care about.

If you're hosting at home using Oracle's VirtualBox, there are steps you can take to prevent double NAT (which can cause issues later on)

1. Select your VM and then click Settings in VirtualBox's main window.

2. Click on Network and change Attached To from NAT to Bridged Adapter.

Once you've done this, your VM should be connected directly to your home router and double NAT should no longer be a issue.
----

==== Hosting Providers ====

Considering the suggested server specs, you may be interested in the following hosting providers. For providers promising dedicated "Pavlov hosting" as opposed to general VPS services please contact and ask how you change maps being hosted and how you get RCON access before you put your money down.

<pre>
Provider | Base CPU | Details
Arctic VR | 4.5 GHz | https://www.arctic-vr.com/server-hosting
Amazon Web Services | 4.0 GHz | https://aws.amazon.com/ec2/instance-types/z1d/
VULTR | 4.0 GHz | https://www.vultr.com/products/high-frequency-compute/
packet.com | 3.5 GHz | https://www.packet.com/cloud/servers/c1-small/
Google Cloud Platform | 3.2 GHz | https://cloud.google.com/compute/docs/cpu-platforms
</pre>

===== ARCTIC VR =====

Arctic VR is the largest and longest running Pavlov VR hosting provider. The In-Game Admin Menu is exclusive to the ArcticVR hosting service. They offer EU, NA East and NA West servers for both shack and PCVR. ArcticVR offers the fastest Pavlov servers as well as DDos Protection, RCON remote management, custom maps, low pings, unlimited slots, and expert support.

Website: https://www.arctic-vr.com/server-hosting

[[File:Arctic_options.png|link=https://www.arctic-vr.com/server-hosting|700px]]

===== VULTR =====

Consider using a referral from the community:

Carlos: https://www.vultr.com/?ref=8615589-6G

Carrot: https://www.vultr.com/?ref=8689348

Archaeo: https://www.vultr.com/?ref=8653652-6G

Cheeto: https://www.vultr.com/?ref=8717358

For a Pavlov Shack server, I recommend minimum Cloud Compute, Intel High Performance, Ubuntu 20.04, and disabled automatic backups. At the time, this was $6/m. Some of the cheap options have 1TB bandwidth, and some have 2TB+. If it's a personal server, 1TB could be fine, but 2TB should be safe.

===== Google Cloud Platform (90 day free credit available) =====

The below configuration is successfully running 4 pavlov PC instances with ~15 total maps and up to 24 players per server. If you want more maps use larger boot disk. Both can dynamically be scaled based on popularity.

<pre>

Menu -> compute engine -> VM instances
create instance
- region: wherever you like
- machine type: n1-highcpu-4 (4 vCPUs, 3.6 GB memory)
- boot disk: Ubuntu 20.04
- boot disk -> size: 25gb
- network tags: pavlov-server
- [create]

Menu -> Vpc network -> firewall rules
[Create firewall rule]
Name: pavlov server
Target Tags: pavlov-server
Source IP Ranges: 0.0.0.0/0
Protocols and Ports -> Specified protocols and ports -> UDP: 7777, 8177 (Shack and PC)
Protocols and Ports -> Specified protocols and ports -> TCP: 7777, 8177 (Shack-only)
Protocols and Ports -> Specified protocols and ports -> TCP: {RCON port - default 9100}
[save]
</pre>

===== Amazon Web Services (30 day free credit available) =====

<pre>
Login -> Change Region: Choose your region
Services -> Compute -> EC2 -> Create
Choose an AMI: Ubuntu 18.04
Instance Type: z1d.large

Instance Details -> Tenancy: Dedicated (optional: this will more than triple the cost)

Storage: 50gb disk (or whatever, you're in control of the map roster)

Security Groups:
Create a new Security Group
Security group name: pavlov-server
Description: pavlov server
Rules:
Type: Custom ICMP Rule - IPV4 / Protocol: Echo Request
Type: Custom UDP Rule / Port Range: 7777 / Source: 0.0.0.0/0
Type: Custom UDP Rule / Port Range: 8177 / Source: 0.0.0.0/0
Type: SSH (optional, but I assume you wanna SSH in..)

Launch -> Create new Keypair -> Download -> Launch

Once it's started, SSH in like:
$ ssh -i your-key.pem ubuntu@you-server-details.amazonaws.com

(I use cmder on Windows, if you're using putty or mobaxterm or something, might be different)
</pre>

=== Starting Server Install ===

====Obtaining an ApiKey====
For your server to show up in the server list, there is now a requirement to have an ApiKey issued by vankrupt. This is to prevent DOS attacks against the master server

Get the key by going here: https://pavlov-ms.vankrupt.com/servers/v1/key and using your mobile number to get a SMS
(note that there have been reported failures of this SMS system for non-US mobiles. In this case DM davevillz your mobile and ask for a key)

Put this key in your Game.ini as follows:
ApiKey="ABC123FALSEKEYDONTUSEME"
or if you would like (personally untested..I would use game.ini) you can call it at server runtime with flag as follows:
-KEY="ABC123FALSEKEYDONTUSEME"

This key can be re-used for a reasonable number of servers (a limit of 10 has been mentioned). Contact the Devs if you need more servers per key.

====System setup and software installation====

Install dependencies and create the `steam` user. (You only need to do this once):

Confirm Linux version
<pre>
lsb_release -a
</pre>

'''Ubuntu 20.04'''
<pre>
sudo apt update && sudo apt install -y gdb curl lib32gcc1 libc++-dev unzip
sudo useradd -m steam
</pre>

'''Ubuntu 20.10 or higher'''
<pre>
sudo apt update && sudo apt install -y gdb curl lib32gcc-s1 libc++-dev unzip
sudo useradd -m steam
</pre>

'''Rocky Linux, CentOS 8, and RHEL 8'''

<pre>
sudo sed -i 's/^SELINUX=enforcing$/SELINUX=permissive/g' /etc/selinux/config
sudo setenforce 0
sudo yum install gdb curl glibc.i686 libstdc++.i686 libstdc++-devel.i686 libstdc++-devel.x86_64 unzip wget -y
wget https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/l/libcxx-3.8.0-3.el7.x86_64.rpm
sudo rpm -i libcxx-3.8.0-3.el7.x86_64.rpm
sudo useradd -m steam
</pre>

[Optional] Set a password for steam.
<pre>sudo passwd steam</pre>

Login as the steam user. ('''You will need to do this each time you connect to your server'''):

<pre>
sudo su -l steam
</pre>

Install Steam:

<pre>
mkdir ~/Steam && cd ~/Steam && curl -sqL "https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz" | tar zxvf -
</pre>

There are different dedicated server versions for Pavlov Server - choose which server version you want to host (PC non-beta, PC Beta, Shack Live, or Shack RC)
(You will need to run this command each time there is a Pavlov Server update). 
To host '''PC Server (non-beta)''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 +exit
</pre>

To host '''PC BETA''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta beta_server +exit
</pre>

To host '''Shack Live''' (Quest):

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack +exit
</pre>

To host '''Shack RC''' (Quest): 

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack_beta +exit
</pre>

Now that we've installed the server, all pavlov server versions should continue. 
Install a fresh copy of steamclient.so (May have to do this after each update):
<pre>
~/Steam/steamcmd.sh +login anonymous +app_update 1007 +quit
mkdir -p ~/.steam/sdk64
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/pavlovserver/Pavlov/Binaries/Linux/steamclient.so
</pre>

Make the PavlovServer script executable. (You only need to do this once):

<pre>
chmod +x ~/pavlovserver/PavlovServer.sh
</pre>

----

=== Server Configuration ===

Before starting the server we need to configure it. Start by creating some directories:

<pre>
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Logs
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps
</pre>

==== Mods/Blacklist/Whitelist (optional) ====

The following three files allow you to specify mods, banned players, and whitelist players. These are optional, but go ahead and create them. Populating the files is described later.

<pre>
touch /home/steam/pavlovserver/Pavlov/Saved/Config/mods.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/blacklist.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/whitelist.txt
</pre>

====Configuring Game.ini====
Create a new Game.ini file using following command to open an editor and copy/paste the following block into it then save it. Note not all of these options are required. For instance remove or comment out the Password=0000 line to make a public server with no pin.
<pre>
nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini
</pre>

<pre>
[/Script/Pavlov.DedicatedServer]
bEnabled=true
ServerName="My_private_idaho"
MaxPlayers=10 #Set this to 10 for Shack. 24 is the max for PC, setting it higher will not allow players to join.
ApiKey="ABC123FALSEKEYDONTUSEME"
bSecured=true
bCustomServer=true
bVerboseLogging=false
bCompetitive=false #This only works for SND
bWhitelist=false
RefreshListTime=120
LimitedAmmoType=0
TickRate=90
TimeLimit=60
#Password=0000
#BalanceTableURL="vankruptgames/BalancingTable/main"
MapRotation=(MapId="UGC1758245796", GameMode="GUN")
MapRotation=(MapId="datacenter", GameMode="SND")
MapRotation=(MapId="sand", GameMode="DM")

</pre>

* '''bEnabled''' - whether the server appears in the server list (unconfirmed)
* '''ServerName''' - name it will be listed as. (approx 35 chars max)
* '''MaxPlayers''' - See suggested specs for limits. 10 standard (10 for shack), 20-24 is max recommended for large maps like Stalingrad or PUSH/RUSH modes, and servers allow a maximum of 24 players.
* '''ApiKey''' - Unique ApiKey required to register server with master server. Replace with your key
* '''bSecured''' - enabled Valve Anti-Cheat (VAC)
* '''bCustomServer''' - activates some new modding tools (save and http functions. Required to write to blacklist.txt for bans)
* '''bCompetitive''' - sets the server to competitive mode for SND. If removed the server will default to false
* '''bVerboseLogging''' - enables verbose logging, mostly detailed statistics. Be prepared for significant increase in logging.
* '''bWhitelist''' - Only allow users in whitelist.txt to join
* '''RefreshListTime''' - sets how often the running server checks for updates in ban/whitelist/mod files
* '''LimitedAmmoType''' - sets limited ammo mode
0 = Unlimited
1 = Limited Generic
2 = Limited Specific
3 = Custom (for modders)
4 = Limited Special
5 = Boxless Mode

* '''TimeLimit''' - sets time limit for each map
* '''TickRate''' - sets the server tickrate. (so far minimum stable seems around 50 and max around 120. Beware setting this changes weapon despawn time and breaks some game modes. Recommend not touching)
* '''Password''' - PIN number for server #FYI - this is now also changeable via rcon.
* '''BalanceTableURL''' - Points to a custom balance table from github. See https://github.com/vankruptgames/BalancingTable for instructions. This line isn't needed if you don't have one.
* '''MapRotation''' - you can add multiple of these. The MapId must be “UGC” followed by the map ID. you can find the map id in the URL of the steam workshop page. When a match ends, the server will load the next map in the rotation. You can also use RCON to switch to a map not included in rotation.

Available game modes as of 09/06/2022: SND, TDM, DM, GUN, ZWV, WW2GUN, TANKTDM, KOTH, TTT, OITC, INFECTION, HIDE, PUSH, PH 

And for Shack only: CTF

For maps running a Custom gamemode (CodZ, BR, Duel, etc.) it doesn't matter which gamemode you choose, as the map will automatically override it with the custom mode.

UGC###### are for custom maps from Steam workshop (PC Only). Find the map you want in the workshop. This is the URL for Mirage (https://steamcommunity.com/sharedfiles/filedetails/?id=2670152485). The 10 numbers at the end of the URL are what you need, so UGC1661803933 would be the MapId for Mirage.

==== Firewall/Port forwarding ====
Using the default settings there are two UDP ports (7777, 8177) that need to be allowed to access the server either by firewall setup or port forwarding.

'''Ubuntu''' firewall commands to check firewall and open ports:
<pre>
sudo ufw status
sudo ufw allow 7777
sudo ufw allow 8177
sudo ufw allow 9100
sudo ufw status
</pre>

'''Rocky Linux''' firewall commands to check firewall and open ports:
<pre>
sudo firewall-cmd --zone=public --add-port=7777/tcp
sudo firewall-cmd --zone=public --add-port=7777/udp
sudo firewall-cmd --zone=public --add-port=8177/tcp
sudo firewall-cmd --zone=public --add-port=8177/udp
sudo firewall-cmd --zone=public --add-port=9100/udp
sudo firewall-cmd --zone=public --add-port=9100/tcp
sudo firewall-cmd --list-ports
firewall-cmd --runtime-to-permanent
</pre>

You may also need to allow Pings (ICMP) for the server's true latency to appear in the master list.

If you are running multiple servers and have set additional ports (see http://wiki.pavlov-vr.com/index.php?title=Dedicated_server#Running_multiple_servers_on_one_host) then you need to allow access to the defined port plus the port 400 higher. So if you use 7000 as your port, then UDP 7000 and 7400 need to be open

If you have setup rcon via RconSettings.txt (below) then that port also need to be allowed access via TCP

If you are running Shack/Quest and want to have maps that are downloadable from your server, your server ports (ex. 7777 & 8177) must also be open via TCP

----

==== Shack Maps (Quest) ====

If you try to use the steps above to add maps for Shack, youll run into issues very quickly. This is because Shack has no affiliation to Steam, and therefore cannot use Steam Workshop maps like above. In the future, these steps will apply to PC servers as well, allowing a server to hold the map itself, instead of offloading to Steam.

To get started, first create the directory to hold the maps

<pre>mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps</pre>

You can use any number of methods to move the map files onto the server, but ill go over the two simplest, starting with a GUI approach

Download and install CyberDuck onto your "home" PC (Whatever PC you use for access to the server, but not the server itsself): https://cyberduck.io/

Next, download and unzip your map of choice from https://www.pavlovquest.com/ , https://pavlovhorde.com/mapsList, or look in #shack-map-showcase channel in the discord server. I'm going to use Cheeto's WW2 Items test (http://www.mediafire.com/file/emyt9bs1z9u9ykw/SVR_Cheeto_Items.zip/file ) for this example, you do what you like

In the top left corner, open a connection, set the connection type to SFTP, and fill in the rest of the information. User will be root, password is whatever you set the root pw as (toor in Ubuntu by default)

In the directory dropdown (itll say /root) go back to /

Follow the directories until we arrive back at our "maps" folder <pre>/home/steam/pavlovserver/Pavlov/Saved/maps</pre>

Drag and drop the unzipped map folder into the main window, in this case itll be SVR_Cheeto_Items

Hit Allow

Youll now see a folder named SVR_Cheeto_Items, and within it should be nothing but 3 files. If there is another folder in it, move this folder to the maps directory, otherwise the server wont work. The 3 files (2 .PAK one .JSON) should be in home/steam/pavlovserver/Pavlov/Saved/maps/SVR_Cheeto_Items, no more, no less.

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

To play the map, you can either use RCON switch map command, or to add the map to your servers automatic map rotation list, add the map's folder name to your Game.ini. This replaces the MapID section, so for our example it would be

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

And thats all! Disconnect CyberDuck from your server before playing, otherwise youll have difficulty joining.

-----------

==== Adding Shack Maps over Command Line Interface ====

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

A bit more complicated, but adding maps over CLI has its benefits

First, CD to the maps directory you made above

<pre>cd ~/pavlovserver/Pavlov/Saved/maps</pre>

Download the map files from whatever you use to upload them. To do this, you can either use curl or wget

<pre>curl -O insertURLhere</pre>

'''If you download your map from Google Drive''', make sure that your .zip folder is shared to anyone.
Then, get the file's url from the shared link. Example : ''<nowiki>https://drive.google.com/file/d/19bI8gUHaN5tUrDvnadAacUnchQf6_k/view</nowiki>'' will be ''19bI8gUHaN5tUrDvnadAacUnchQf6_k''
Edit "fileId" and "fileName" before you execute the command.
<pre>
fileId=19bI8gUHaN5tUrDvnadAacUnchQf6_k
fileName=SVR_USER_MAPNAME
curl -sc /tmp/cookie "https://drive.google.com/uc?export=download&id=${fileId}" > /dev/null
code="$(awk '/_warning_/ {print $NF}' /tmp/cookie)"
curl -Lb /tmp/cookie "https://drive.google.com/uc?export=download&confirm=${code}&id=${fileId}" -o ${fileName} </pre>

To keep with the Items example:

<pre>curl -O https://cdn.discordapp.com/attachments/744185280759857234/745027406695366788/SVR_Cheeto_Items.zip</pre>

Next, unzip the file. If this next step errors out, saying the command is unknown, switch back to the root user (su root), and install unzip (sudo apt install unzip), then return to the steam user, and continue.

<pre>unzip SVR_Cheeto_Items.zip</pre>

Now finish like before by adding the map to your Game.ini

<pre>nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini</pre>

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

==== Admin/Moderator list (optional) ====

The only working in-game admin menu is through Arctic VR server hosting (see below).

If you add moderators to your server, they will not be subject to vote kicks.

<pre>
nano ~/pavlovserver/Pavlov/Saved/Config/mods.txt
</pre>

Example Mod List:
<pre>
76541198397498572 #Optional Comment: Player name
76541198397498573 #Some Other Player
</pre>

==== ArcticVR Admin Menu ====

[[File:Arcticmenu.jpg|500px|link=https://www.arctic-vr.com/server-admin-menu]]

Arctic-VR Offers an advanced In-Game Admin menu that is exclusive to their hosting service. Features include:
* Switch Maps+Modes
* Teleport Players to Players
* Change Player Skins
* Control Player Buying+Cash
* Spawn Items
* Clean up corpses + guns
* Spawn Bots
* Spawn Items for other players
* Control Teams + Balance/Shuffle Teams
* ResetSND
* And More

You can read more about the ArcticVR admin menu on their website: https://www.arctic-vr.com/server-admin-menu

==== Handy tools for finding steamIDs ====

Steam ID finder: https://steamidfinder.com/lookup/ or https://steamid.xyz/

You want to enter in the steamID64 format.

This tool can convert or lookup IDs: https://steamid.io/

If you are looking for a steamID of a player that has been on your server recently this is technique to find them:
<pre>
grep -i playername ~/pavlovserver/Pavlov/Saved/Logs/* | grep TicketValidation
</pre>

=== Configure Rcon ===
To enable Rcon access create config file:
<pre> nano /home/steam/pavlovserver/Pavlov/Saved/Config/RconSettings.txt </pre>

Copy in the following text - change password, and if desired the port:
<pre>
Password=ChangeThisPassword
Port=9100
</pre>
You must specify a port for the Rcon server to use as well as a Password (use a different port per sever instance if running multiple server instances off the same hardware)

=== Starting the server ===

<pre>
cd ~/pavlovserver && ./PavlovServer.sh
</pre>

That's it, your server will be automatically broadcast to the master server! :)

Two handy tools to determine quickly if your server is broadcasting are [https://pablub.xyz/ Pablub] (PC only) and [https://pavlovhorde.com/ Horde] (Shack) and [https://pavlovhorde.com/pcServers Horde] (PC version)

Note that when you close your terminal, the server will go down. See the "supervisors" section below for how to prevent this.

=== Auto-updating the server ===

Assuming you have followed this guide and used the default paths, users, and install instructions, you can paste the following into your terminal to auto-update your Pavlov server:

<pre>
cat << 'EOF' > $HOME/pavlov_daily_update_and_restart.sh
#!/bin/bash

USER="steam"
SERVICENAME="pavlovserver.service"
INSTALLDIRNAME="pavlovserver"
USERHOME="/home/$USER"

echo -e "Beginning Pavlov VR update run on $(date)\n\n"

systemctl stop "$SERVICENAME"

sleep 5
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +force_install_dir "$USERHOME/$INSTALLDIRNAME" +app_update 622970 +exit
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +app_update 1007 +quit
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/.steam/sdk64/steamclient.so"
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/pavlovserver/Pavlov/Binaries/Linux/steamclient.so"

systemctl start "$SERVICENAME"

echo -e "Ending Pavlov VR update run on $(date)\n\n"

EOF

chmod +x $HOME/pavlov_daily_update_and_restart.sh
mkdir $HOME/pavlov_update_logs && touch $HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log
CRONLINE="00 2 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
(sudo crontab -u root -l; echo "$CRONLINE" ) | sudo crontab -u root -
unset CRONLINE

</pre>

These commands will:

1. Create a shell script in the "steam" user's home directory that automatically stops the Pavlov server, pulls any updates via steam, pull updates to the Steamworks SDK Redist, and copies the latest version of steamclient.so to the Pavlov server directory

2. Make the shell script executable

3. Create a new directory called "pavlov_update_logs" in the "steam" user's directory, and create a logfile inside that directory called "pavlov_daily_update_and_restart.sh.log". You can check this logfile to see the output of the Pavlov and Steam SDK update commands.

4. Create a crontab entry for the root user that runs this shell script automatically every day at 2:00AM local time

If you want to change the time that this script runs, edit the numbers "00 2" in the line that starts with "CRONLINE=". In the example provided, 00 is the minutes column, and 2 is the hour column. For example, if you wanted the server to automatically update and restart at 4:17AM every day, change the line starting with "CRONLINE=" to:

<pre>
CRONLINE="17 4 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
</pre>

If the time is PM, use 24-hour time format, e.g. "32 18" for 6:32PM.

----

=== Supervising the server using systemd ===

Running '''./PavlovServer.sh''' in your interactive shell is easy, but the server will shut down when you close your terminal. If you want to run the server in the background,
you'll want to run it under a supervisor. There are many options, ranging from the simple (nohup, screen or tmux), to the
more robust (supervisord, systemd).

Systemd is running by default on Ubuntu Linux, so we'll use that here.

To run the server as a systemd service, create the file '''/etc/systemd/system/pavlovserver.service''' (as root) by typing
<pre>
sudo nano /etc/systemd/system/pavlovserver.service
</pre>

Copy contents below into the file and save.

<pre>
[Unit]
Description=Pavlov VR dedicated server

[Service]
Type=simple
WorkingDirectory=/home/steam/pavlovserver
ExecStart=/home/steam/pavlovserver/PavlovServer.sh

RestartSec=1
Restart=always
User=steam
Group=steam

[Install]
WantedBy = multi-user.target
</pre>

If you'd like your server to start as competitive without editing the game.ini, change the line "ExecStart=/home/steam/pavlovserver/PavlovServer.sh" to look like this below. Though it's much easier to just use the game.ini to enable competitive instead. <pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -COMPETITIVE=1</pre>

Change the user or paths as appropriate. After saving the service file, to start, restart, stop, or monitor the server:

<pre>
sudo systemctl start pavlovserver
sudo systemctl restart pavlovserver
sudo systemctl stop pavlovserver
sudo systemctl status pavlovserver
</pre>

To view the logs:

<pre>
sudo journalctl -u pavlovserver
# to live-tail the logs
sudo journalctl -u pavlovserver -f
</pre>

If you want to run the pavlov server as soon as your server boots (e.g. a VPS you turn on and off), add pavlov as a startup service:

<pre>
sudo systemctl enable pavlovserver
</pre>

----

== Advanced Server Administration ==

=== Running multiple servers on one host ===

* Pavlovserver is functionally single threaded (there are multiple threads, but vast majority of work occurs in the primary one). Make sure you have # of pavlovservers + 1 CPU available. More CPUs= more servers. Faster CPU = more players.
* Make multiple server installs by defining a separate install dir for each server.
* Run each server with a unique port. eg: '''./PavlovServer.sh -PORT="Desired Port"'''
* The Server will use the Desired Port and the Port 400 above (Example: You choose 8200 as Port. So Port 8600 will be used as well)
* If you are using RCON, each server will need a unique port defined in RconSettings.txt
* Ensure the ports are forwarded and opened in your firewall

To duplicate directories:

be in the steam home folder
<pre>
cp -r pavlovserver pavlovserver1
/home/steam/pavlovserver1/PavlovServer.sh -PORT=[Desired Port]
</pre>

=== Starting server in competitive mode ===
Competitive mode will prevent dead teammates from being able to see the match, to prevent ghosting.
You can either enable this via Game.ini (described in Game.ini file), or using the -COMPETITIVE=1 parameter.

<pre>
/home/steam/pavlovserver1/PavlovServer.sh -COMPETITIVE=1
</pre>

== Automated RCON examples ==
here are some examples of scripts that interact with Pavlov RCON

* '''<big>Inspect players every 5 minutes</big>''' [https://github.com/JTWP-org/inspect-every-5-mins (installation instructions on GITHUB )]

This [https://www.gnu.org/software/bash/ BASH] script will collect current players stats for every one. then it will write them to a log in JSON format that can easily be handled for your records or the next project ..

below is all the info that will be collected

==== "PlayerInfo": ====

==== { ====

==== "PlayerName": "toidi_na_llats_ot_woh", ====

==== "UniqueId": "76561199117105981", ====

==== "KDA": "7/0/2", ====

==== "Score": "16", ====

==== "Dead": false, ====

==== "Cash": "7000", ====

==== "TeamId": "1" ====

==== } ====
{| class="wikitable"

|}

----

=== Useful Linux Commands ===

List files / folders in directory, print current working directory,
<pre>ls -la #list files/directories along with authorities and ownership
pwd #print working directory
sudo chown <owner> <file/directory> #change owner of file/directory. If root created something and you need to change it to steam
sudo chgrp <group> <file/directory> #change group of file/directory.
</pre>

Check if pavlov is running by checking process status. If the only row you see is the grep command, pavlov server is not started.
<pre> ps -ef | grep pav </pre>

Sample output:
<pre>
steam 34044 1 0 16:52 ? 00:00:00 /bin/sh /home/steam/pavlovserver/PavlovServer.sh
steam 34066 34044 80 16:52 ? 00:00:04 /home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer
zombies+ 34101 34013 0 16:52 pts/0 00:00:00 grep --color=auto pav
</pre>

Kill a process. Note this command uses 34044, which is a process id from the command output above.
<pre> kill -9 34044 </pre>

Dump the log to the console so you can scroll through it:
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log </pre>

Search the log for a string - replace my_string with case-sensitive string
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep my_string </pre>

=== Default Map ID's ===
datacenter

sand

bridge

containeryard

siberia (Prison Break)

hospital (Zombies map)

killhouse

range

tutorial

santorini

station

industry

ogcontainers (Shack only)

haguenau (Shack only)

foundation (Shack only)

stalingrad (PC only)

stalingrad_night (PC only)

santorini_night (PC only)

sand_night (PC only)

station_night (PC only)

industry_night (PC only)

bunker (PC only)

=== Automated server log backup ===

here is how to setup a bash script to 1x a day compress all log files and save them to protect from auto deletion it will also post a discord webhook to confirm its working and saved the days logs

https://github.com/JTWP-org/backUpLogs

== Troubleshooting ==

To run the server without outputting the heartbeat:

<pre>./PavlovServer.sh | sed '/heartbeat/d'</pre>

To monitor the logs (without heartbeat) from another terminal:

<pre>tail -f -n10000 /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep -v 'Sending heartbeat to masterserver'</pre>

Check your CPU Clock Speed with:

<pre>lscpu | grep MHz</pre>

=== Server won't start ===

Error message:
<pre>
ln: failed to create hard link '/home/steam/.steam/sdk64/steamclient.so': File exists
ln: failed to create hard link '/home/steam/pavlovserver/Pavlov/Binaries/Linux/steamclient.so': File exists
/home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer: error while loading shared libraries: libc++.so.1: cannot open shared object file: No such file or directory
</pre>

First two errors are harmless. The third one is because libc++ step was skipped or failed. Using sudo capable id (probably not steam id), [re]run this line:
<pre>sudo apt update && sudo apt install -y gdb curl lib32gcc1 libc++-dev unzip </pre>

=== Map wont load (kicks to datacenter) ===

try deleting all the downloaded workshop maps with:

<pre>sudo rm -rf /tmp/workshop/7777/content/555160/*</pre> for all maps or

<pre>sudo rm -rf /tmp/workshop/7777/content/555160/whatever-UGC</pre> for specific map

=== Map wont load when running in a container ===
The three typical container problems I have seen:

1) Steam can't write to /tmp for some reason

2) /tmp is actually tmpfs instead of real filesystem and a few gigs of maps runs you out of RAM

3) Made worse by fact that pavlovserver unpacks downloads to ram, then writes to /tmp/workshop. Not enough RAM to do this, no map for you.

=== Server stuck rotating forever ===

Run these 2 commands, then restart your server:

<pre>cd ~/Steam && ./steamcmd.sh +login anonymous +app_update 1007 +quit
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so</pre>

If this doesn't fix it, double check that your server isn't running on the same port as another, by running this command:

<pre>ps -ef | grep pav</pre>

Then if 2 servers are on the same port, you can fix it by editing the pavlovserver.service file, and making sure the following line:

<pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -PORT=Number</pre>

has a unique number after the port for each server you're running.

=== Server - ping 999 ===
Google Cloud Platform - Make sure your compute engine has a network tag and your network rules are applied to the tag.
Make sure you opened the specified ports.

Network testing tools:
Test if your server will respond to ping from outside your network:
https://www.wormly.com/test-remote-ping

Test if your ports are accessible via UDP (7777,8177,9100):
https://www.ipvoid.com/udp-port-scan/

=== Can't connect to RCON ===
Check the file and group owner of RconSettings file. It should be steam, or the ID used to run the pavlov server.
<pre>
cd /home/steam/pavlovserver/Pavlov/Saved/Config
ls -la
</pre>

If the owner/group are not steam, using root or an id with sudo authority, change them to steam, confirm they are now set properly, then restart the pavlov server. (Note - if Rcon has wrong permissions, after fixing you should also to check the other config files like Game.ini, mods/blacklist/whitelist for the same issue. If steam can't access these files, it could cause problems.).
<pre>
cd /home/steam/pavlovserver/Pavlov/Saved/Config
sudo chown steam RconSettings.txt
sudo chgrp steam RconSettings.txt
ls -la </pre>

=== PC ONLY - Map Download stops ===

When downloading a large map from the steam workshop make sure your VPS/Dedi or Shared hosting provider (Otherwise known as a GSP's) has enough RAM assigned to store the map files in its tempfs (stored in ram)!

This is less likely to happen on Dedicated servers and VPS with a decent amount of ram unless you are using docker with RAM limits!

Most GSP's will be using docker or some other type of jailing method to limit system resource allocations and direct access to the host machine, if they are and you know what map you want to use make sure you order a service with enough ram to store your map. If in doubt contact your GSP's support team.

=== Getting Help ===

There's a #pc-custom-servers channel on the official Pavlov Discord - https://discord.gg/Pavlov-VR. Lots of helpful people there!

Setting up a dedicated server

2023-05-26T02:59:30Z

SaltedCrackerJack: /* Automated RCON examples */

== Setting up a dedicated server ==

'''There are no Windows binaries'''

This guide is written exclusively for Linux and covers Ubuntu/Debian/Debian-like and Red Hat RPM-based distros. Possible to run with other distros, but some of the commands won't work and you will need to know enough to figure out the software install of dependencies on your own.

If you are considering hosting from home, please read that section of the wiki first.

This guide assumes you know the basics of using a bash terminal: ssh'ing into a server, running bash commands, editing text files, etc.

If you have no experience using bash, maybe start [https://www.howtogeek.com/140679/beginner-geek-how-to-start-using-the-linux-terminal/ here]. Editing text files via commandline is often a challenge. Suggest using nano and reading guide [https://www.howtogeek.com/howto/42980/the-beginners-guide-to-nano-the-linux-command-line-text-editor/ here]

If you are new to linux and accessing your server from Windows, highly suggest using MobaXterm as your SSH client as that can make required editing of text files easier using built in editor instead of the native linux command line editors.

And finally, ask yourself why you want to setup a server? If you look at the list, there are many, many more servers than players. If you don't have a team, discord community, or group of friends ready to play on your server, chances are it will go unused. Got one of these... great, let's go.

If you don't want to go through the hassle yourself and want to pay for a hosting service Arctic VR (PC and Shack) and Horde (Shack) provide a server hosting services and are trusted in the community. See links below.

----

=== Server Requirements ===

'''Pavlovserver can only be hosted under Linux.'''

This can be running as a VM under windows, but this will increase the complexity of the setup beyond this guide.

Ubuntu 18.04 x86_64, Ubuntu 19/04 amd64, Ubuntu 20.04, and Rocky Linux 8 are confirmed working. Ubuntu 15.04 x86 is known to fail to install using this guide. Recommend not running on "minimal" images as some tools are missing.

* 2GB RAM + 1GB RAM per each additional server with 10 players. More RAM is recommended for larger maps, higher player counts, or complex gamemodes. Not having enough RAM is a common cause of server crashes.

* A ~2.5Ghz CPU will comfortably support a 10 player server.

* A ~4Ghz CPU will comfortably support 24 players. This is a limit built into Pavlov itself, no server will allow players to join over 24. Lower player counts are recommended for complex gamemodes (E.g. CodZ) and/or highly detailed maps, so that maximum number will often be lower.

(Note that these are '''not''' hard limits for player counts, just suggestions for the best performance, based on experiences with many server providers on different grades of hardware.)

* Pavlovserver is functionally single threaded (one thread does vast majority of work). More CPUs only help if you are running more servers. More clockspeed = higher performance = more users per server.
The maximum number of servers you can run is dependent on how many CPUs you have. For example, if you have an 8 core CPU, the maximum number of servers would be 7. You should always have at least one CPU free as overhead, as Pavlov servers can use slightly more than one thread.

----

==== Hosting at home ====
When hosting at home there are additional requirements regarding networking: Your router has to support port-forwarding, hair-pinning/LoopbackNAT, and respond to ping requests. These techniques are necessary to allow your server to be found and to talk back to the client. please see https://en.wikipedia.org/wiki/Port_forwarding, https://en.wikipedia.org/wiki/Hairpinning, and https://www.speedguide.net/faq/how-to-become-pingable-behind-a-routerfirewall-376 for more info and google for these terms in addition to your router model to find guides on how to enable/configure it properly. If you have modern Router, it may have these features already enabled, in this case you just have to configure port-forwarding. If you can see your server but not join it while others can, this is indicative of a failure of LoopbackNAT.

A second challenge to hosting at home is CGNAT (Carrier grade NAT: https://www.a10networks.com/blog/carrier-grade-nat/). Just like NAT on your home network that has to be gotten around w/ port-forwarding, CGNAT breaks the ability of external connections to be made back to your server, but the controls are solely in your ISPs hands. Sometimes if you ask, you can be removed from CGNAT pools and/or assigned a static IP. CGNAT rollouts are becoming very common now, so if your server worked then doesn't allow connections now, your ISP may have made this change.

You can check whether you’re on a CGNAT network by visiting a Web site such as ipaddress.com or whatsmyip.com and comparing the IP address listed to the public/WAN IP address assigned to your Internet gateway. To find your gateway’s public IP address, check the status page in the administrative interface. If the two IP addresses differ, you’re likely on a CGNAT network. If so, this problem must be resolved before you go any further.

'''Not understanding these requirements and configuration is a frequent cause of failed setups and questions in discord. Don't skip this if you are trying to host from home'''

'''There are serious security implications of hosting this software at home.''' None of the devs are security experts and there has been no security review of the code. You are opening up your system to the world and publicity advertising this fact. Expect that any system hosting this software is open to compromise from the Internet and act accordingly. If your router offers a DMZ network, use it. Consider hosting on a cloud based server and think twice before running this software on any system that contains data you care about or has access to networks and computers you care about.

If you're hosting at home using Oracle's VirtualBox, there are steps you can take to prevent double NAT (which can cause issues later on)

1. Select your VM and then click Settings in VirtualBox's main window.

2. Click on Network and change Attached To from NAT to Bridged Adapter.

Once you've done this, your VM should be connected directly to your home router and double NAT should no longer be a issue.
----

==== Hosting Providers ====

Considering the suggested server specs, you may be interested in the following hosting providers. For providers promising dedicated "Pavlov hosting" as opposed to general VPS services please contact and ask how you change maps being hosted and how you get RCON access before you put your money down.

<pre>
Provider | Base CPU | Details
Arctic VR | 4.5 GHz | https://www.arctic-vr.com/server-hosting
Amazon Web Services | 4.0 GHz | https://aws.amazon.com/ec2/instance-types/z1d/
VULTR | 4.0 GHz | https://www.vultr.com/products/high-frequency-compute/
packet.com | 3.5 GHz | https://www.packet.com/cloud/servers/c1-small/
Google Cloud Platform | 3.2 GHz | https://cloud.google.com/compute/docs/cpu-platforms
</pre>

===== ARCTIC VR =====

Arctic VR is the largest and longest running Pavlov VR hosting provider. The In-Game Admin Menu is exclusive to the ArcticVR hosting service. They offer EU, NA East and NA West servers for both shack and PCVR. ArcticVR offers the fastest Pavlov servers as well as DDos Protection, RCON remote management, custom maps, low pings, unlimited slots, and expert support.

Website: https://www.arctic-vr.com/server-hosting

[[File:Arctic_options.png|link=https://www.arctic-vr.com/server-hosting|700px]]

===== VULTR =====

Consider using a referral from the community:

Carlos: https://www.vultr.com/?ref=8615589-6G

Carrot: https://www.vultr.com/?ref=8689348

Archaeo: https://www.vultr.com/?ref=8653652-6G

Cheeto: https://www.vultr.com/?ref=8717358

For a Pavlov Shack server, I recommend minimum Cloud Compute, Intel High Performance, Ubuntu 20.04, and disabled automatic backups. At the time, this was $6/m. Some of the cheap options have 1TB bandwidth, and some have 2TB+. If it's a personal server, 1TB could be fine, but 2TB should be safe.

===== Google Cloud Platform (90 day free credit available) =====

The below configuration is successfully running 4 pavlov PC instances with ~15 total maps and up to 24 players per server. If you want more maps use larger boot disk. Both can dynamically be scaled based on popularity.

<pre>

Menu -> compute engine -> VM instances
create instance
- region: wherever you like
- machine type: n1-highcpu-4 (4 vCPUs, 3.6 GB memory)
- boot disk: Ubuntu 20.04
- boot disk -> size: 25gb
- network tags: pavlov-server
- [create]

Menu -> Vpc network -> firewall rules
[Create firewall rule]
Name: pavlov server
Target Tags: pavlov-server
Source IP Ranges: 0.0.0.0/0
Protocols and Ports -> Specified protocols and ports -> UDP: 7777, 8177 (Shack and PC)
Protocols and Ports -> Specified protocols and ports -> TCP: 7777, 8177 (Shack-only)
Protocols and Ports -> Specified protocols and ports -> TCP: {RCON port - default 9100}
[save]
</pre>

===== Amazon Web Services (30 day free credit available) =====

<pre>
Login -> Change Region: Choose your region
Services -> Compute -> EC2 -> Create
Choose an AMI: Ubuntu 18.04
Instance Type: z1d.large

Instance Details -> Tenancy: Dedicated (optional: this will more than triple the cost)

Storage: 50gb disk (or whatever, you're in control of the map roster)

Security Groups:
Create a new Security Group
Security group name: pavlov-server
Description: pavlov server
Rules:
Type: Custom ICMP Rule - IPV4 / Protocol: Echo Request
Type: Custom UDP Rule / Port Range: 7777 / Source: 0.0.0.0/0
Type: Custom UDP Rule / Port Range: 8177 / Source: 0.0.0.0/0
Type: SSH (optional, but I assume you wanna SSH in..)

Launch -> Create new Keypair -> Download -> Launch

Once it's started, SSH in like:
$ ssh -i your-key.pem ubuntu@you-server-details.amazonaws.com

(I use cmder on Windows, if you're using putty or mobaxterm or something, might be different)
</pre>

=== Starting Server Install ===

====Obtaining an ApiKey====
For your server to show up in the server list, there is now a requirement to have an ApiKey issued by vankrupt. This is to prevent DOS attacks against the master server

Get the key by going here: https://pavlov-ms.vankrupt.com/servers/v1/key and using your mobile number to get a SMS
(note that there have been reported failures of this SMS system for non-US mobiles. In this case DM davevillz your mobile and ask for a key)

Put this key in your Game.ini as follows:
ApiKey="ABC123FALSEKEYDONTUSEME"
or if you would like (personally untested..I would use game.ini) you can call it at server runtime with flag as follows:
-KEY="ABC123FALSEKEYDONTUSEME"

This key can be re-used for a reasonable number of servers (a limit of 10 has been mentioned). Contact the Devs if you need more servers per key.

====System setup and software installation====

Install dependencies and create the `steam` user. (You only need to do this once):

Confirm Linux version
<pre>
lsb_release -a
</pre>

'''Ubuntu 20.04'''
<pre>
sudo apt update && sudo apt install -y gdb curl lib32gcc1 libc++-dev unzip
sudo useradd -m steam
</pre>

'''Ubuntu 20.10 or higher'''
<pre>
sudo apt update && sudo apt install -y gdb curl lib32gcc-s1 libc++-dev unzip
sudo useradd -m steam
</pre>

'''Rocky Linux, CentOS 8, and RHEL 8'''

<pre>
sudo sed -i 's/^SELINUX=enforcing$/SELINUX=permissive/g' /etc/selinux/config
sudo setenforce 0
sudo yum install gdb curl glibc.i686 libstdc++.i686 libstdc++-devel.i686 libstdc++-devel.x86_64 unzip wget -y
wget https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/l/libcxx-3.8.0-3.el7.x86_64.rpm
sudo rpm -i libcxx-3.8.0-3.el7.x86_64.rpm
sudo useradd -m steam
</pre>

[Optional] Set a password for steam.
<pre>sudo passwd steam</pre>

Login as the steam user. ('''You will need to do this each time you connect to your server'''):

<pre>
sudo su -l steam
</pre>

Install Steam:

<pre>
mkdir ~/Steam && cd ~/Steam && curl -sqL "https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz" | tar zxvf -
</pre>

There are different dedicated server versions for Pavlov Server - choose which server version you want to host (PC non-beta, PC Beta, Shack Live, or Shack RC)
(You will need to run this command each time there is a Pavlov Server update). 
To host '''PC Server (non-beta)''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 +exit
</pre>

To host '''PC BETA''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta beta_server +exit
</pre>

To host '''Shack Live''' (Quest):

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack +exit
</pre>

To host '''Shack RC''' (Quest): 

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack_beta +exit
</pre>

Now that we've installed the server, all pavlov server versions should continue. 
Install a fresh copy of steamclient.so (May have to do this after each update):
<pre>
~/Steam/steamcmd.sh +login anonymous +app_update 1007 +quit
mkdir -p ~/.steam/sdk64
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/pavlovserver/Pavlov/Binaries/Linux/steamclient.so
</pre>

Make the PavlovServer script executable. (You only need to do this once):

<pre>
chmod +x ~/pavlovserver/PavlovServer.sh
</pre>

----

=== Server Configuration ===

Before starting the server we need to configure it. Start by creating some directories:

<pre>
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Logs
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps
</pre>

==== Mods/Blacklist/Whitelist (optional) ====

The following three files allow you to specify mods, banned players, and whitelist players. These are optional, but go ahead and create them. Populating the files is described later.

<pre>
touch /home/steam/pavlovserver/Pavlov/Saved/Config/mods.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/blacklist.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/whitelist.txt
</pre>

====Configuring Game.ini====
Create a new Game.ini file using following command to open an editor and copy/paste the following block into it then save it. Note not all of these options are required. For instance remove or comment out the Password=0000 line to make a public server with no pin.
<pre>
nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini
</pre>

<pre>
[/Script/Pavlov.DedicatedServer]
bEnabled=true
ServerName="My_private_idaho"
MaxPlayers=10 #Set this to 10 for Shack. 24 is the max for PC, setting it higher will not allow players to join.
ApiKey="ABC123FALSEKEYDONTUSEME"
bSecured=true
bCustomServer=true
bVerboseLogging=false
bCompetitive=false #This only works for SND
bWhitelist=false
RefreshListTime=120
LimitedAmmoType=0
TickRate=90
TimeLimit=60
#Password=0000
#BalanceTableURL="vankruptgames/BalancingTable/main"
MapRotation=(MapId="UGC1758245796", GameMode="GUN")
MapRotation=(MapId="datacenter", GameMode="SND")
MapRotation=(MapId="sand", GameMode="DM")

</pre>

* '''bEnabled''' - whether the server appears in the server list (unconfirmed)
* '''ServerName''' - name it will be listed as. (approx 35 chars max)
* '''MaxPlayers''' - See suggested specs for limits. 10 standard (10 for shack), 20-24 is max recommended for large maps like Stalingrad or PUSH/RUSH modes, and servers allow a maximum of 24 players.
* '''ApiKey''' - Unique ApiKey required to register server with master server. Replace with your key
* '''bSecured''' - enabled Valve Anti-Cheat (VAC)
* '''bCustomServer''' - activates some new modding tools (save and http functions. Required to write to blacklist.txt for bans)
* '''bCompetitive''' - sets the server to competitive mode for SND. If removed the server will default to false
* '''bVerboseLogging''' - enables verbose logging, mostly detailed statistics. Be prepared for significant increase in logging.
* '''bWhitelist''' - Only allow users in whitelist.txt to join
* '''RefreshListTime''' - sets how often the running server checks for updates in ban/whitelist/mod files
* '''LimitedAmmoType''' - sets limited ammo mode
0 = Unlimited
1 = Limited Generic
2 = Limited Specific
3 = Custom (for modders)
4 = Limited Special
5 = Boxless Mode

* '''TimeLimit''' - sets time limit for each map
* '''TickRate''' - sets the server tickrate. (so far minimum stable seems around 50 and max around 120. Beware setting this changes weapon despawn time and breaks some game modes. Recommend not touching)
* '''Password''' - PIN number for server #FYI - this is now also changeable via rcon.
* '''BalanceTableURL''' - Points to a custom balance table from github. See https://github.com/vankruptgames/BalancingTable for instructions. This line isn't needed if you don't have one.
* '''MapRotation''' - you can add multiple of these. The MapId must be “UGC” followed by the map ID. you can find the map id in the URL of the steam workshop page. When a match ends, the server will load the next map in the rotation. You can also use RCON to switch to a map not included in rotation.

Available game modes as of 09/06/2022: SND, TDM, DM, GUN, ZWV, WW2GUN, TANKTDM, KOTH, TTT, OITC, INFECTION, HIDE, PUSH, PH 

And for Shack only: CTF

For maps running a Custom gamemode (CodZ, BR, Duel, etc.) it doesn't matter which gamemode you choose, as the map will automatically override it with the custom mode.

UGC###### are for custom maps from Steam workshop (PC Only). Find the map you want in the workshop. This is the URL for Mirage (https://steamcommunity.com/sharedfiles/filedetails/?id=2670152485). The 10 numbers at the end of the URL are what you need, so UGC1661803933 would be the MapId for Mirage.

==== Firewall/Port forwarding ====
Using the default settings there are two UDP ports (7777, 8177) that need to be allowed to access the server either by firewall setup or port forwarding.

'''Ubuntu''' firewall commands to check firewall and open ports:
<pre>
sudo ufw status
sudo ufw allow 7777
sudo ufw allow 8177
sudo ufw allow 9100
sudo ufw status
</pre>

'''Rocky Linux''' firewall commands to check firewall and open ports:
<pre>
sudo firewall-cmd --zone=public --add-port=7777/tcp
sudo firewall-cmd --zone=public --add-port=7777/udp
sudo firewall-cmd --zone=public --add-port=8177/tcp
sudo firewall-cmd --zone=public --add-port=8177/udp
sudo firewall-cmd --zone=public --add-port=9100/udp
sudo firewall-cmd --zone=public --add-port=9100/tcp
sudo firewall-cmd --list-ports
firewall-cmd --runtime-to-permanent
</pre>

You may also need to allow Pings (ICMP) for the server's true latency to appear in the master list.

If you are running multiple servers and have set additional ports (see http://wiki.pavlov-vr.com/index.php?title=Dedicated_server#Running_multiple_servers_on_one_host) then you need to allow access to the defined port plus the port 400 higher. So if you use 7000 as your port, then UDP 7000 and 7400 need to be open

If you have setup rcon via RconSettings.txt (below) then that port also need to be allowed access via TCP

If you are running Shack/Quest and want to have maps that are downloadable from your server, your server ports (ex. 7777 & 8177) must also be open via TCP

----

==== Shack Maps (Quest) ====

If you try to use the steps above to add maps for Shack, youll run into issues very quickly. This is because Shack has no affiliation to Steam, and therefore cannot use Steam Workshop maps like above. In the future, these steps will apply to PC servers as well, allowing a server to hold the map itself, instead of offloading to Steam.

To get started, first create the directory to hold the maps

<pre>mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps</pre>

You can use any number of methods to move the map files onto the server, but ill go over the two simplest, starting with a GUI approach

Download and install CyberDuck onto your "home" PC (Whatever PC you use for access to the server, but not the server itsself): https://cyberduck.io/

Next, download and unzip your map of choice from https://www.pavlovquest.com/ , https://pavlovhorde.com/mapsList, or look in #shack-map-showcase channel in the discord server. I'm going to use Cheeto's WW2 Items test (http://www.mediafire.com/file/emyt9bs1z9u9ykw/SVR_Cheeto_Items.zip/file ) for this example, you do what you like

In the top left corner, open a connection, set the connection type to SFTP, and fill in the rest of the information. User will be root, password is whatever you set the root pw as (toor in Ubuntu by default)

In the directory dropdown (itll say /root) go back to /

Follow the directories until we arrive back at our "maps" folder <pre>/home/steam/pavlovserver/Pavlov/Saved/maps</pre>

Drag and drop the unzipped map folder into the main window, in this case itll be SVR_Cheeto_Items

Hit Allow

Youll now see a folder named SVR_Cheeto_Items, and within it should be nothing but 3 files. If there is another folder in it, move this folder to the maps directory, otherwise the server wont work. The 3 files (2 .PAK one .JSON) should be in home/steam/pavlovserver/Pavlov/Saved/maps/SVR_Cheeto_Items, no more, no less.

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

To play the map, you can either use RCON switch map command, or to add the map to your servers automatic map rotation list, add the map's folder name to your Game.ini. This replaces the MapID section, so for our example it would be

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

And thats all! Disconnect CyberDuck from your server before playing, otherwise youll have difficulty joining.

-----------

==== Adding Shack Maps over Command Line Interface ====

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

A bit more complicated, but adding maps over CLI has its benefits

First, CD to the maps directory you made above

<pre>cd ~/pavlovserver/Pavlov/Saved/maps</pre>

Download the map files from whatever you use to upload them. To do this, you can either use curl or wget

<pre>curl -O insertURLhere</pre>

'''If you download your map from Google Drive''', make sure that your .zip folder is shared to anyone.
Then, get the file's url from the shared link. Example : ''<nowiki>https://drive.google.com/file/d/19bI8gUHaN5tUrDvnadAacUnchQf6_k/view</nowiki>'' will be ''19bI8gUHaN5tUrDvnadAacUnchQf6_k''
Edit "fileId" and "fileName" before you execute the command.
<pre>
fileId=19bI8gUHaN5tUrDvnadAacUnchQf6_k
fileName=SVR_USER_MAPNAME
curl -sc /tmp/cookie "https://drive.google.com/uc?export=download&id=${fileId}" > /dev/null
code="$(awk '/_warning_/ {print $NF}' /tmp/cookie)"
curl -Lb /tmp/cookie "https://drive.google.com/uc?export=download&confirm=${code}&id=${fileId}" -o ${fileName} </pre>

To keep with the Items example:

<pre>curl -O https://cdn.discordapp.com/attachments/744185280759857234/745027406695366788/SVR_Cheeto_Items.zip</pre>

Next, unzip the file. If this next step errors out, saying the command is unknown, switch back to the root user (su root), and install unzip (sudo apt install unzip), then return to the steam user, and continue.

<pre>unzip SVR_Cheeto_Items.zip</pre>

Now finish like before by adding the map to your Game.ini

<pre>nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini</pre>

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

==== Admin/Moderator list (optional) ====

The only working in-game admin menu is through Arctic VR server hosting (see below).

If you add moderators to your server, they will not be subject to vote kicks.

<pre>
nano ~/pavlovserver/Pavlov/Saved/Config/mods.txt
</pre>

Example Mod List:
<pre>
76541198397498572 #Optional Comment: Player name
76541198397498573 #Some Other Player
</pre>

==== ArcticVR Admin Menu ====

[[File:Arcticmenu.jpg|500px|link=https://www.arctic-vr.com/server-admin-menu]]

Arctic-VR Offers an advanced In-Game Admin menu that is exclusive to their hosting service. Features include:
* Switch Maps+Modes
* Teleport Players to Players
* Change Player Skins
* Control Player Buying+Cash
* Spawn Items
* Clean up corpses + guns
* Spawn Bots
* Spawn Items for other players
* Control Teams + Balance/Shuffle Teams
* ResetSND
* And More

You can read more about the ArcticVR admin menu on their website: https://www.arctic-vr.com/server-admin-menu

==== Handy tools for finding steamIDs ====

Steam ID finder: https://steamidfinder.com/lookup/ or https://steamid.xyz/

You want to enter in the steamID64 format.

This tool can convert or lookup IDs: https://steamid.io/

If you are looking for a steamID of a player that has been on your server recently this is technique to find them:
<pre>
grep -i playername ~/pavlovserver/Pavlov/Saved/Logs/* | grep TicketValidation
</pre>

=== Configure Rcon ===
To enable Rcon access create config file:
<pre> nano /home/steam/pavlovserver/Pavlov/Saved/Config/RconSettings.txt </pre>

Copy in the following text - change password, and if desired the port:
<pre>
Password=ChangeThisPassword
Port=9100
</pre>
You must specify a port for the Rcon server to use as well as a Password (use a different port per sever instance if running multiple server instances off the same hardware)

=== Starting the server ===

<pre>
cd ~/pavlovserver && ./PavlovServer.sh
</pre>

That's it, your server will be automatically broadcast to the master server! :)

Two handy tools to determine quickly if your server is broadcasting are [https://pablub.xyz/ Pablub] (PC only) and [https://pavlovhorde.com/ Horde] (Shack) and [https://pavlovhorde.com/pcServers Horde] (PC version)

Note that when you close your terminal, the server will go down. See the "supervisors" section below for how to prevent this.

=== Auto-updating the server ===

Assuming you have followed this guide and used the default paths, users, and install instructions, you can paste the following into your terminal to auto-update your Pavlov server:

<pre>
cat << 'EOF' > $HOME/pavlov_daily_update_and_restart.sh
#!/bin/bash

USER="steam"
SERVICENAME="pavlovserver.service"
INSTALLDIRNAME="pavlovserver"
USERHOME="/home/$USER"

echo -e "Beginning Pavlov VR update run on $(date)\n\n"

systemctl stop "$SERVICENAME"

sleep 5
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +force_install_dir "$USERHOME/$INSTALLDIRNAME" +app_update 622970 +exit
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +app_update 1007 +quit
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/.steam/sdk64/steamclient.so"
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/pavlovserver/Pavlov/Binaries/Linux/steamclient.so"

systemctl start "$SERVICENAME"

echo -e "Ending Pavlov VR update run on $(date)\n\n"

EOF

chmod +x $HOME/pavlov_daily_update_and_restart.sh
mkdir $HOME/pavlov_update_logs && touch $HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log
CRONLINE="00 2 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
(sudo crontab -u root -l; echo "$CRONLINE" ) | sudo crontab -u root -
unset CRONLINE

</pre>

These commands will:

1. Create a shell script in the "steam" user's home directory that automatically stops the Pavlov server, pulls any updates via steam, pull updates to the Steamworks SDK Redist, and copies the latest version of steamclient.so to the Pavlov server directory

2. Make the shell script executable

3. Create a new directory called "pavlov_update_logs" in the "steam" user's directory, and create a logfile inside that directory called "pavlov_daily_update_and_restart.sh.log". You can check this logfile to see the output of the Pavlov and Steam SDK update commands.

4. Create a crontab entry for the root user that runs this shell script automatically every day at 2:00AM local time

If you want to change the time that this script runs, edit the numbers "00 2" in the line that starts with "CRONLINE=". In the example provided, 00 is the minutes column, and 2 is the hour column. For example, if you wanted the server to automatically update and restart at 4:17AM every day, change the line starting with "CRONLINE=" to:

<pre>
CRONLINE="17 4 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
</pre>

If the time is PM, use 24-hour time format, e.g. "32 18" for 6:32PM.

----

=== Supervising the server using systemd ===

Running '''./PavlovServer.sh''' in your interactive shell is easy, but the server will shut down when you close your terminal. If you want to run the server in the background,
you'll want to run it under a supervisor. There are many options, ranging from the simple (nohup, screen or tmux), to the
more robust (supervisord, systemd).

Systemd is running by default on Ubuntu Linux, so we'll use that here.

To run the server as a systemd service, create the file '''/etc/systemd/system/pavlovserver.service''' (as root) by typing
<pre>
sudo nano /etc/systemd/system/pavlovserver.service
</pre>

Copy contents below into the file and save.

<pre>
[Unit]
Description=Pavlov VR dedicated server

[Service]
Type=simple
WorkingDirectory=/home/steam/pavlovserver
ExecStart=/home/steam/pavlovserver/PavlovServer.sh

RestartSec=1
Restart=always
User=steam
Group=steam

[Install]
WantedBy = multi-user.target
</pre>

If you'd like your server to start as competitive without editing the game.ini, change the line "ExecStart=/home/steam/pavlovserver/PavlovServer.sh" to look like this below. Though it's much easier to just use the game.ini to enable competitive instead. <pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -COMPETITIVE=1</pre>

Change the user or paths as appropriate. After saving the service file, to start, restart, stop, or monitor the server:

<pre>
sudo systemctl start pavlovserver
sudo systemctl restart pavlovserver
sudo systemctl stop pavlovserver
sudo systemctl status pavlovserver
</pre>

To view the logs:

<pre>
sudo journalctl -u pavlovserver
# to live-tail the logs
sudo journalctl -u pavlovserver -f
</pre>

If you want to run the pavlov server as soon as your server boots (e.g. a VPS you turn on and off), add pavlov as a startup service:

<pre>
sudo systemctl enable pavlovserver
</pre>

----

== Advanced Server Administration ==

=== Running multiple servers on one host ===

* Pavlovserver is functionally single threaded (there are multiple threads, but vast majority of work occurs in the primary one). Make sure you have # of pavlovservers + 1 CPU available. More CPUs= more servers. Faster CPU = more players.
* Make multiple server installs by defining a separate install dir for each server.
* Run each server with a unique port. eg: '''./PavlovServer.sh -PORT="Desired Port"'''
* The Server will use the Desired Port and the Port 400 above (Example: You choose 8200 as Port. So Port 8600 will be used as well)
* If you are using RCON, each server will need a unique port defined in RconSettings.txt
* Ensure the ports are forwarded and opened in your firewall

To duplicate directories:

be in the steam home folder
<pre>
cp -r pavlovserver pavlovserver1
/home/steam/pavlovserver1/PavlovServer.sh -PORT=[Desired Port]
</pre>

=== Starting server in competitive mode ===
Competitive mode will prevent dead teammates from being able to see the match, to prevent ghosting.
You can either enable this via Game.ini (described in Game.ini file), or using the -COMPETITIVE=1 parameter.

<pre>
/home/steam/pavlovserver1/PavlovServer.sh -COMPETITIVE=1
</pre>

== Automated RCON examples ==
here are some examples of scripts that interact with Pavlov RCON

* '''<big>Inspect players every 5 minutes</big>''' [https://github.com/JTWP-org/inspect-every-5-mins (installation instructions on GITHUB )]

This [https://www.gnu.org/software/bash/ BASH] script will collect current players stats for every one. then it will write them to a log in JSON format that can easily be handled for your records or the next project ..

below is all the info that will be collected<blockquote>
====== '''''"PlayerInfo":''''' ======

====== ''''' {''''' ======

====== ''''' "PlayerName": "toidi_na_llats_ot_woh",''''' ======

====== ''''' "UniqueId": "76561199117105981",''''' ======

====== ''''' "KDA": "7/0/2",''''' ======

====== ''''' "Score": "16",''''' ======

====== ''''' "Dead": false,''''' ======

====== ''''' "Cash": "7000",''''' ======

====== ''''' "TeamId": "1"''''' ======

====== ''''' }''''' ======
</blockquote>
{| class="wikitable"

|}

----

=== Useful Linux Commands ===

List files / folders in directory, print current working directory,
<pre>ls -la #list files/directories along with authorities and ownership
pwd #print working directory
sudo chown <owner> <file/directory> #change owner of file/directory. If root created something and you need to change it to steam
sudo chgrp <group> <file/directory> #change group of file/directory.
</pre>

Check if pavlov is running by checking process status. If the only row you see is the grep command, pavlov server is not started.
<pre> ps -ef | grep pav </pre>

Sample output:
<pre>
steam 34044 1 0 16:52 ? 00:00:00 /bin/sh /home/steam/pavlovserver/PavlovServer.sh
steam 34066 34044 80 16:52 ? 00:00:04 /home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer
zombies+ 34101 34013 0 16:52 pts/0 00:00:00 grep --color=auto pav
</pre>

Kill a process. Note this command uses 34044, which is a process id from the command output above.
<pre> kill -9 34044 </pre>

Dump the log to the console so you can scroll through it:
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log </pre>

Search the log for a string - replace my_string with case-sensitive string
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep my_string </pre>

=== Default Map ID's ===
datacenter

sand

bridge

containeryard

siberia (Prison Break)

hospital (Zombies map)

killhouse

range

tutorial

santorini

station

industry

ogcontainers (Shack only)

haguenau (Shack only)

foundation (Shack only)

stalingrad (PC only)

stalingrad_night (PC only)

santorini_night (PC only)

sand_night (PC only)

station_night (PC only)

industry_night (PC only)

bunker (PC only)

=== Automated server log backup ===

here is how to setup a bash script to 1x a day compress all log files and save them to protect from auto deletion it will also post a discord webhook to confirm its working and saved the days logs

https://github.com/JTWP-org/backUpLogs

== Troubleshooting ==

To run the server without outputting the heartbeat:

<pre>./PavlovServer.sh | sed '/heartbeat/d'</pre>

To monitor the logs (without heartbeat) from another terminal:

<pre>tail -f -n10000 /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep -v 'Sending heartbeat to masterserver'</pre>

Check your CPU Clock Speed with:

<pre>lscpu | grep MHz</pre>

=== Server won't start ===

Error message:
<pre>
ln: failed to create hard link '/home/steam/.steam/sdk64/steamclient.so': File exists
ln: failed to create hard link '/home/steam/pavlovserver/Pavlov/Binaries/Linux/steamclient.so': File exists
/home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer: error while loading shared libraries: libc++.so.1: cannot open shared object file: No such file or directory
</pre>

First two errors are harmless. The third one is because libc++ step was skipped or failed. Using sudo capable id (probably not steam id), [re]run this line:
<pre>sudo apt update && sudo apt install -y gdb curl lib32gcc1 libc++-dev unzip </pre>

=== Map wont load (kicks to datacenter) ===

try deleting all the downloaded workshop maps with:

<pre>sudo rm -rf /tmp/workshop/7777/content/555160/*</pre> for all maps or

<pre>sudo rm -rf /tmp/workshop/7777/content/555160/whatever-UGC</pre> for specific map

=== Map wont load when running in a container ===
The three typical container problems I have seen:

1) Steam can't write to /tmp for some reason

2) /tmp is actually tmpfs instead of real filesystem and a few gigs of maps runs you out of RAM

3) Made worse by fact that pavlovserver unpacks downloads to ram, then writes to /tmp/workshop. Not enough RAM to do this, no map for you.

=== Server stuck rotating forever ===

Run these 2 commands, then restart your server:

<pre>cd ~/Steam && ./steamcmd.sh +login anonymous +app_update 1007 +quit
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so</pre>

If this doesn't fix it, double check that your server isn't running on the same port as another, by running this command:

<pre>ps -ef | grep pav</pre>

Then if 2 servers are on the same port, you can fix it by editing the pavlovserver.service file, and making sure the following line:

<pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -PORT=Number</pre>

has a unique number after the port for each server you're running.

=== Server - ping 999 ===
Google Cloud Platform - Make sure your compute engine has a network tag and your network rules are applied to the tag.
Make sure you opened the specified ports.

Network testing tools:
Test if your server will respond to ping from outside your network:
https://www.wormly.com/test-remote-ping

Test if your ports are accessible via UDP (7777,8177,9100):
https://www.ipvoid.com/udp-port-scan/

=== Can't connect to RCON ===
Check the file and group owner of RconSettings file. It should be steam, or the ID used to run the pavlov server.
<pre>
cd /home/steam/pavlovserver/Pavlov/Saved/Config
ls -la
</pre>

If the owner/group are not steam, using root or an id with sudo authority, change them to steam, confirm they are now set properly, then restart the pavlov server. (Note - if Rcon has wrong permissions, after fixing you should also to check the other config files like Game.ini, mods/blacklist/whitelist for the same issue. If steam can't access these files, it could cause problems.).
<pre>
cd /home/steam/pavlovserver/Pavlov/Saved/Config
sudo chown steam RconSettings.txt
sudo chgrp steam RconSettings.txt
ls -la </pre>

=== PC ONLY - Map Download stops ===

When downloading a large map from the steam workshop make sure your VPS/Dedi or Shared hosting provider (Otherwise known as a GSP's) has enough RAM assigned to store the map files in its tempfs (stored in ram)!

This is less likely to happen on Dedicated servers and VPS with a decent amount of ram unless you are using docker with RAM limits!

Most GSP's will be using docker or some other type of jailing method to limit system resource allocations and direct access to the host machine, if they are and you know what map you want to use make sure you order a service with enough ram to store your map. If in doubt contact your GSP's support team.

=== Getting Help ===

There's a #pc-custom-servers channel on the official Pavlov Discord - https://discord.gg/Pavlov-VR. Lots of helpful people there!

Setting up a dedicated server

2023-05-26T02:50:22Z

SaltedCrackerJack: /* Automated RCON examples */

== Setting up a dedicated server ==

'''There are no Windows binaries'''

This guide is written exclusively for Linux and covers Ubuntu/Debian/Debian-like and Red Hat RPM-based distros. Possible to run with other distros, but some of the commands won't work and you will need to know enough to figure out the software install of dependencies on your own.

If you are considering hosting from home, please read that section of the wiki first.

This guide assumes you know the basics of using a bash terminal: ssh'ing into a server, running bash commands, editing text files, etc.

If you have no experience using bash, maybe start [https://www.howtogeek.com/140679/beginner-geek-how-to-start-using-the-linux-terminal/ here]. Editing text files via commandline is often a challenge. Suggest using nano and reading guide [https://www.howtogeek.com/howto/42980/the-beginners-guide-to-nano-the-linux-command-line-text-editor/ here]

If you are new to linux and accessing your server from Windows, highly suggest using MobaXterm as your SSH client as that can make required editing of text files easier using built in editor instead of the native linux command line editors.

And finally, ask yourself why you want to setup a server? If you look at the list, there are many, many more servers than players. If you don't have a team, discord community, or group of friends ready to play on your server, chances are it will go unused. Got one of these... great, let's go.

If you don't want to go through the hassle yourself and want to pay for a hosting service Arctic VR (PC and Shack) and Horde (Shack) provide a server hosting services and are trusted in the community. See links below.

----

=== Server Requirements ===

'''Pavlovserver can only be hosted under Linux.'''

This can be running as a VM under windows, but this will increase the complexity of the setup beyond this guide.

Ubuntu 18.04 x86_64, Ubuntu 19/04 amd64, Ubuntu 20.04, and Rocky Linux 8 are confirmed working. Ubuntu 15.04 x86 is known to fail to install using this guide. Recommend not running on "minimal" images as some tools are missing.

* 2GB RAM + 1GB RAM per each additional server with 10 players. More RAM is recommended for larger maps, higher player counts, or complex gamemodes. Not having enough RAM is a common cause of server crashes.

* A ~2.5Ghz CPU will comfortably support a 10 player server.

* A ~4Ghz CPU will comfortably support 24 players. This is a limit built into Pavlov itself, no server will allow players to join over 24. Lower player counts are recommended for complex gamemodes (E.g. CodZ) and/or highly detailed maps, so that maximum number will often be lower.

(Note that these are '''not''' hard limits for player counts, just suggestions for the best performance, based on experiences with many server providers on different grades of hardware.)

* Pavlovserver is functionally single threaded (one thread does vast majority of work). More CPUs only help if you are running more servers. More clockspeed = higher performance = more users per server.
The maximum number of servers you can run is dependent on how many CPUs you have. For example, if you have an 8 core CPU, the maximum number of servers would be 7. You should always have at least one CPU free as overhead, as Pavlov servers can use slightly more than one thread.

----

==== Hosting at home ====
When hosting at home there are additional requirements regarding networking: Your router has to support port-forwarding, hair-pinning/LoopbackNAT, and respond to ping requests. These techniques are necessary to allow your server to be found and to talk back to the client. please see https://en.wikipedia.org/wiki/Port_forwarding, https://en.wikipedia.org/wiki/Hairpinning, and https://www.speedguide.net/faq/how-to-become-pingable-behind-a-routerfirewall-376 for more info and google for these terms in addition to your router model to find guides on how to enable/configure it properly. If you have modern Router, it may have these features already enabled, in this case you just have to configure port-forwarding. If you can see your server but not join it while others can, this is indicative of a failure of LoopbackNAT.

A second challenge to hosting at home is CGNAT (Carrier grade NAT: https://www.a10networks.com/blog/carrier-grade-nat/). Just like NAT on your home network that has to be gotten around w/ port-forwarding, CGNAT breaks the ability of external connections to be made back to your server, but the controls are solely in your ISPs hands. Sometimes if you ask, you can be removed from CGNAT pools and/or assigned a static IP. CGNAT rollouts are becoming very common now, so if your server worked then doesn't allow connections now, your ISP may have made this change.

You can check whether you’re on a CGNAT network by visiting a Web site such as ipaddress.com or whatsmyip.com and comparing the IP address listed to the public/WAN IP address assigned to your Internet gateway. To find your gateway’s public IP address, check the status page in the administrative interface. If the two IP addresses differ, you’re likely on a CGNAT network. If so, this problem must be resolved before you go any further.

'''Not understanding these requirements and configuration is a frequent cause of failed setups and questions in discord. Don't skip this if you are trying to host from home'''

'''There are serious security implications of hosting this software at home.''' None of the devs are security experts and there has been no security review of the code. You are opening up your system to the world and publicity advertising this fact. Expect that any system hosting this software is open to compromise from the Internet and act accordingly. If your router offers a DMZ network, use it. Consider hosting on a cloud based server and think twice before running this software on any system that contains data you care about or has access to networks and computers you care about.

If you're hosting at home using Oracle's VirtualBox, there are steps you can take to prevent double NAT (which can cause issues later on)

1. Select your VM and then click Settings in VirtualBox's main window.

2. Click on Network and change Attached To from NAT to Bridged Adapter.

Once you've done this, your VM should be connected directly to your home router and double NAT should no longer be a issue.
----

==== Hosting Providers ====

Considering the suggested server specs, you may be interested in the following hosting providers. For providers promising dedicated "Pavlov hosting" as opposed to general VPS services please contact and ask how you change maps being hosted and how you get RCON access before you put your money down.

<pre>
Provider | Base CPU | Details
Arctic VR | 4.5 GHz | https://www.arctic-vr.com/server-hosting
Amazon Web Services | 4.0 GHz | https://aws.amazon.com/ec2/instance-types/z1d/
VULTR | 4.0 GHz | https://www.vultr.com/products/high-frequency-compute/
packet.com | 3.5 GHz | https://www.packet.com/cloud/servers/c1-small/
Google Cloud Platform | 3.2 GHz | https://cloud.google.com/compute/docs/cpu-platforms
</pre>

===== ARCTIC VR =====

Arctic VR is the largest and longest running Pavlov VR hosting provider. The In-Game Admin Menu is exclusive to the ArcticVR hosting service. They offer EU, NA East and NA West servers for both shack and PCVR. ArcticVR offers the fastest Pavlov servers as well as DDos Protection, RCON remote management, custom maps, low pings, unlimited slots, and expert support.

Website: https://www.arctic-vr.com/server-hosting

[[File:Arctic_options.png|link=https://www.arctic-vr.com/server-hosting|700px]]

===== VULTR =====

Consider using a referral from the community:

Carlos: https://www.vultr.com/?ref=8615589-6G

Carrot: https://www.vultr.com/?ref=8689348

Archaeo: https://www.vultr.com/?ref=8653652-6G

Cheeto: https://www.vultr.com/?ref=8717358

For a Pavlov Shack server, I recommend minimum Cloud Compute, Intel High Performance, Ubuntu 20.04, and disabled automatic backups. At the time, this was $6/m. Some of the cheap options have 1TB bandwidth, and some have 2TB+. If it's a personal server, 1TB could be fine, but 2TB should be safe.

===== Google Cloud Platform (90 day free credit available) =====

The below configuration is successfully running 4 pavlov PC instances with ~15 total maps and up to 24 players per server. If you want more maps use larger boot disk. Both can dynamically be scaled based on popularity.

<pre>

Menu -> compute engine -> VM instances
create instance
- region: wherever you like
- machine type: n1-highcpu-4 (4 vCPUs, 3.6 GB memory)
- boot disk: Ubuntu 20.04
- boot disk -> size: 25gb
- network tags: pavlov-server
- [create]

Menu -> Vpc network -> firewall rules
[Create firewall rule]
Name: pavlov server
Target Tags: pavlov-server
Source IP Ranges: 0.0.0.0/0
Protocols and Ports -> Specified protocols and ports -> UDP: 7777, 8177 (Shack and PC)
Protocols and Ports -> Specified protocols and ports -> TCP: 7777, 8177 (Shack-only)
Protocols and Ports -> Specified protocols and ports -> TCP: {RCON port - default 9100}
[save]
</pre>

===== Amazon Web Services (30 day free credit available) =====

<pre>
Login -> Change Region: Choose your region
Services -> Compute -> EC2 -> Create
Choose an AMI: Ubuntu 18.04
Instance Type: z1d.large

Instance Details -> Tenancy: Dedicated (optional: this will more than triple the cost)

Storage: 50gb disk (or whatever, you're in control of the map roster)

Security Groups:
Create a new Security Group
Security group name: pavlov-server
Description: pavlov server
Rules:
Type: Custom ICMP Rule - IPV4 / Protocol: Echo Request
Type: Custom UDP Rule / Port Range: 7777 / Source: 0.0.0.0/0
Type: Custom UDP Rule / Port Range: 8177 / Source: 0.0.0.0/0
Type: SSH (optional, but I assume you wanna SSH in..)

Launch -> Create new Keypair -> Download -> Launch

Once it's started, SSH in like:
$ ssh -i your-key.pem ubuntu@you-server-details.amazonaws.com

(I use cmder on Windows, if you're using putty or mobaxterm or something, might be different)
</pre>

=== Starting Server Install ===

====Obtaining an ApiKey====
For your server to show up in the server list, there is now a requirement to have an ApiKey issued by vankrupt. This is to prevent DOS attacks against the master server

Get the key by going here: https://pavlov-ms.vankrupt.com/servers/v1/key and using your mobile number to get a SMS
(note that there have been reported failures of this SMS system for non-US mobiles. In this case DM davevillz your mobile and ask for a key)

Put this key in your Game.ini as follows:
ApiKey="ABC123FALSEKEYDONTUSEME"
or if you would like (personally untested..I would use game.ini) you can call it at server runtime with flag as follows:
-KEY="ABC123FALSEKEYDONTUSEME"

This key can be re-used for a reasonable number of servers (a limit of 10 has been mentioned). Contact the Devs if you need more servers per key.

====System setup and software installation====

Install dependencies and create the `steam` user. (You only need to do this once):

Confirm Linux version
<pre>
lsb_release -a
</pre>

'''Ubuntu 20.04'''
<pre>
sudo apt update && sudo apt install -y gdb curl lib32gcc1 libc++-dev unzip
sudo useradd -m steam
</pre>

'''Ubuntu 20.10 or higher'''
<pre>
sudo apt update && sudo apt install -y gdb curl lib32gcc-s1 libc++-dev unzip
sudo useradd -m steam
</pre>

'''Rocky Linux, CentOS 8, and RHEL 8'''

<pre>
sudo sed -i 's/^SELINUX=enforcing$/SELINUX=permissive/g' /etc/selinux/config
sudo setenforce 0
sudo yum install gdb curl glibc.i686 libstdc++.i686 libstdc++-devel.i686 libstdc++-devel.x86_64 unzip wget -y
wget https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/l/libcxx-3.8.0-3.el7.x86_64.rpm
sudo rpm -i libcxx-3.8.0-3.el7.x86_64.rpm
sudo useradd -m steam
</pre>

[Optional] Set a password for steam.
<pre>sudo passwd steam</pre>

Login as the steam user. ('''You will need to do this each time you connect to your server'''):

<pre>
sudo su -l steam
</pre>

Install Steam:

<pre>
mkdir ~/Steam && cd ~/Steam && curl -sqL "https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz" | tar zxvf -
</pre>

There are different dedicated server versions for Pavlov Server - choose which server version you want to host (PC non-beta, PC Beta, Shack Live, or Shack RC)
(You will need to run this command each time there is a Pavlov Server update). 
To host '''PC Server (non-beta)''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 +exit
</pre>

To host '''PC BETA''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta beta_server +exit
</pre>

To host '''Shack Live''' (Quest):

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack +exit
</pre>

To host '''Shack RC''' (Quest): 

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack_beta +exit
</pre>

Now that we've installed the server, all pavlov server versions should continue. 
Install a fresh copy of steamclient.so (May have to do this after each update):
<pre>
~/Steam/steamcmd.sh +login anonymous +app_update 1007 +quit
mkdir -p ~/.steam/sdk64
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/pavlovserver/Pavlov/Binaries/Linux/steamclient.so
</pre>

Make the PavlovServer script executable. (You only need to do this once):

<pre>
chmod +x ~/pavlovserver/PavlovServer.sh
</pre>

----

=== Server Configuration ===

Before starting the server we need to configure it. Start by creating some directories:

<pre>
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Logs
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps
</pre>

==== Mods/Blacklist/Whitelist (optional) ====

The following three files allow you to specify mods, banned players, and whitelist players. These are optional, but go ahead and create them. Populating the files is described later.

<pre>
touch /home/steam/pavlovserver/Pavlov/Saved/Config/mods.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/blacklist.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/whitelist.txt
</pre>

====Configuring Game.ini====
Create a new Game.ini file using following command to open an editor and copy/paste the following block into it then save it. Note not all of these options are required. For instance remove or comment out the Password=0000 line to make a public server with no pin.
<pre>
nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini
</pre>

<pre>
[/Script/Pavlov.DedicatedServer]
bEnabled=true
ServerName="My_private_idaho"
MaxPlayers=10 #Set this to 10 for Shack. 24 is the max for PC, setting it higher will not allow players to join.
ApiKey="ABC123FALSEKEYDONTUSEME"
bSecured=true
bCustomServer=true
bVerboseLogging=false
bCompetitive=false #This only works for SND
bWhitelist=false
RefreshListTime=120
LimitedAmmoType=0
TickRate=90
TimeLimit=60
#Password=0000
#BalanceTableURL="vankruptgames/BalancingTable/main"
MapRotation=(MapId="UGC1758245796", GameMode="GUN")
MapRotation=(MapId="datacenter", GameMode="SND")
MapRotation=(MapId="sand", GameMode="DM")

</pre>

* '''bEnabled''' - whether the server appears in the server list (unconfirmed)
* '''ServerName''' - name it will be listed as. (approx 35 chars max)
* '''MaxPlayers''' - See suggested specs for limits. 10 standard (10 for shack), 20-24 is max recommended for large maps like Stalingrad or PUSH/RUSH modes, and servers allow a maximum of 24 players.
* '''ApiKey''' - Unique ApiKey required to register server with master server. Replace with your key
* '''bSecured''' - enabled Valve Anti-Cheat (VAC)
* '''bCustomServer''' - activates some new modding tools (save and http functions. Required to write to blacklist.txt for bans)
* '''bCompetitive''' - sets the server to competitive mode for SND. If removed the server will default to false
* '''bVerboseLogging''' - enables verbose logging, mostly detailed statistics. Be prepared for significant increase in logging.
* '''bWhitelist''' - Only allow users in whitelist.txt to join
* '''RefreshListTime''' - sets how often the running server checks for updates in ban/whitelist/mod files
* '''LimitedAmmoType''' - sets limited ammo mode
0 = Unlimited
1 = Limited Generic
2 = Limited Specific
3 = Custom (for modders)
4 = Limited Special
5 = Boxless Mode

* '''TimeLimit''' - sets time limit for each map
* '''TickRate''' - sets the server tickrate. (so far minimum stable seems around 50 and max around 120. Beware setting this changes weapon despawn time and breaks some game modes. Recommend not touching)
* '''Password''' - PIN number for server #FYI - this is now also changeable via rcon.
* '''BalanceTableURL''' - Points to a custom balance table from github. See https://github.com/vankruptgames/BalancingTable for instructions. This line isn't needed if you don't have one.
* '''MapRotation''' - you can add multiple of these. The MapId must be “UGC” followed by the map ID. you can find the map id in the URL of the steam workshop page. When a match ends, the server will load the next map in the rotation. You can also use RCON to switch to a map not included in rotation.

Available game modes as of 09/06/2022: SND, TDM, DM, GUN, ZWV, WW2GUN, TANKTDM, KOTH, TTT, OITC, INFECTION, HIDE, PUSH, PH 

And for Shack only: CTF

For maps running a Custom gamemode (CodZ, BR, Duel, etc.) it doesn't matter which gamemode you choose, as the map will automatically override it with the custom mode.

UGC###### are for custom maps from Steam workshop (PC Only). Find the map you want in the workshop. This is the URL for Mirage (https://steamcommunity.com/sharedfiles/filedetails/?id=2670152485). The 10 numbers at the end of the URL are what you need, so UGC1661803933 would be the MapId for Mirage.

==== Firewall/Port forwarding ====
Using the default settings there are two UDP ports (7777, 8177) that need to be allowed to access the server either by firewall setup or port forwarding.

'''Ubuntu''' firewall commands to check firewall and open ports:
<pre>
sudo ufw status
sudo ufw allow 7777
sudo ufw allow 8177
sudo ufw allow 9100
sudo ufw status
</pre>

'''Rocky Linux''' firewall commands to check firewall and open ports:
<pre>
sudo firewall-cmd --zone=public --add-port=7777/tcp
sudo firewall-cmd --zone=public --add-port=7777/udp
sudo firewall-cmd --zone=public --add-port=8177/tcp
sudo firewall-cmd --zone=public --add-port=8177/udp
sudo firewall-cmd --zone=public --add-port=9100/udp
sudo firewall-cmd --zone=public --add-port=9100/tcp
sudo firewall-cmd --list-ports
firewall-cmd --runtime-to-permanent
</pre>

You may also need to allow Pings (ICMP) for the server's true latency to appear in the master list.

If you are running multiple servers and have set additional ports (see http://wiki.pavlov-vr.com/index.php?title=Dedicated_server#Running_multiple_servers_on_one_host) then you need to allow access to the defined port plus the port 400 higher. So if you use 7000 as your port, then UDP 7000 and 7400 need to be open

If you have setup rcon via RconSettings.txt (below) then that port also need to be allowed access via TCP

If you are running Shack/Quest and want to have maps that are downloadable from your server, your server ports (ex. 7777 & 8177) must also be open via TCP

----

==== Shack Maps (Quest) ====

If you try to use the steps above to add maps for Shack, youll run into issues very quickly. This is because Shack has no affiliation to Steam, and therefore cannot use Steam Workshop maps like above. In the future, these steps will apply to PC servers as well, allowing a server to hold the map itself, instead of offloading to Steam.

To get started, first create the directory to hold the maps

<pre>mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps</pre>

You can use any number of methods to move the map files onto the server, but ill go over the two simplest, starting with a GUI approach

Download and install CyberDuck onto your "home" PC (Whatever PC you use for access to the server, but not the server itsself): https://cyberduck.io/

Next, download and unzip your map of choice from https://www.pavlovquest.com/ , https://pavlovhorde.com/mapsList, or look in #shack-map-showcase channel in the discord server. I'm going to use Cheeto's WW2 Items test (http://www.mediafire.com/file/emyt9bs1z9u9ykw/SVR_Cheeto_Items.zip/file ) for this example, you do what you like

In the top left corner, open a connection, set the connection type to SFTP, and fill in the rest of the information. User will be root, password is whatever you set the root pw as (toor in Ubuntu by default)

In the directory dropdown (itll say /root) go back to /

Follow the directories until we arrive back at our "maps" folder <pre>/home/steam/pavlovserver/Pavlov/Saved/maps</pre>

Drag and drop the unzipped map folder into the main window, in this case itll be SVR_Cheeto_Items

Hit Allow

Youll now see a folder named SVR_Cheeto_Items, and within it should be nothing but 3 files. If there is another folder in it, move this folder to the maps directory, otherwise the server wont work. The 3 files (2 .PAK one .JSON) should be in home/steam/pavlovserver/Pavlov/Saved/maps/SVR_Cheeto_Items, no more, no less.

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

To play the map, you can either use RCON switch map command, or to add the map to your servers automatic map rotation list, add the map's folder name to your Game.ini. This replaces the MapID section, so for our example it would be

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

And thats all! Disconnect CyberDuck from your server before playing, otherwise youll have difficulty joining.

-----------

==== Adding Shack Maps over Command Line Interface ====

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

A bit more complicated, but adding maps over CLI has its benefits

First, CD to the maps directory you made above

<pre>cd ~/pavlovserver/Pavlov/Saved/maps</pre>

Download the map files from whatever you use to upload them. To do this, you can either use curl or wget

<pre>curl -O insertURLhere</pre>

'''If you download your map from Google Drive''', make sure that your .zip folder is shared to anyone.
Then, get the file's url from the shared link. Example : ''<nowiki>https://drive.google.com/file/d/19bI8gUHaN5tUrDvnadAacUnchQf6_k/view</nowiki>'' will be ''19bI8gUHaN5tUrDvnadAacUnchQf6_k''
Edit "fileId" and "fileName" before you execute the command.
<pre>
fileId=19bI8gUHaN5tUrDvnadAacUnchQf6_k
fileName=SVR_USER_MAPNAME
curl -sc /tmp/cookie "https://drive.google.com/uc?export=download&id=${fileId}" > /dev/null
code="$(awk '/_warning_/ {print $NF}' /tmp/cookie)"
curl -Lb /tmp/cookie "https://drive.google.com/uc?export=download&confirm=${code}&id=${fileId}" -o ${fileName} </pre>

To keep with the Items example:

<pre>curl -O https://cdn.discordapp.com/attachments/744185280759857234/745027406695366788/SVR_Cheeto_Items.zip</pre>

Next, unzip the file. If this next step errors out, saying the command is unknown, switch back to the root user (su root), and install unzip (sudo apt install unzip), then return to the steam user, and continue.

<pre>unzip SVR_Cheeto_Items.zip</pre>

Now finish like before by adding the map to your Game.ini

<pre>nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini</pre>

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

==== Admin/Moderator list (optional) ====

The only working in-game admin menu is through Arctic VR server hosting (see below).

If you add moderators to your server, they will not be subject to vote kicks.

<pre>
nano ~/pavlovserver/Pavlov/Saved/Config/mods.txt
</pre>

Example Mod List:
<pre>
76541198397498572 #Optional Comment: Player name
76541198397498573 #Some Other Player
</pre>

==== ArcticVR Admin Menu ====

[[File:Arcticmenu.jpg|500px|link=https://www.arctic-vr.com/server-admin-menu]]

Arctic-VR Offers an advanced In-Game Admin menu that is exclusive to their hosting service. Features include:
* Switch Maps+Modes
* Teleport Players to Players
* Change Player Skins
* Control Player Buying+Cash
* Spawn Items
* Clean up corpses + guns
* Spawn Bots
* Spawn Items for other players
* Control Teams + Balance/Shuffle Teams
* ResetSND
* And More

You can read more about the ArcticVR admin menu on their website: https://www.arctic-vr.com/server-admin-menu

==== Handy tools for finding steamIDs ====

Steam ID finder: https://steamidfinder.com/lookup/ or https://steamid.xyz/

You want to enter in the steamID64 format.

This tool can convert or lookup IDs: https://steamid.io/

If you are looking for a steamID of a player that has been on your server recently this is technique to find them:
<pre>
grep -i playername ~/pavlovserver/Pavlov/Saved/Logs/* | grep TicketValidation
</pre>

=== Configure Rcon ===
To enable Rcon access create config file:
<pre> nano /home/steam/pavlovserver/Pavlov/Saved/Config/RconSettings.txt </pre>

Copy in the following text - change password, and if desired the port:
<pre>
Password=ChangeThisPassword
Port=9100
</pre>
You must specify a port for the Rcon server to use as well as a Password (use a different port per sever instance if running multiple server instances off the same hardware)

=== Starting the server ===

<pre>
cd ~/pavlovserver && ./PavlovServer.sh
</pre>

That's it, your server will be automatically broadcast to the master server! :)

Two handy tools to determine quickly if your server is broadcasting are [https://pablub.xyz/ Pablub] (PC only) and [https://pavlovhorde.com/ Horde] (Shack) and [https://pavlovhorde.com/pcServers Horde] (PC version)

Note that when you close your terminal, the server will go down. See the "supervisors" section below for how to prevent this.

=== Auto-updating the server ===

Assuming you have followed this guide and used the default paths, users, and install instructions, you can paste the following into your terminal to auto-update your Pavlov server:

<pre>
cat << 'EOF' > $HOME/pavlov_daily_update_and_restart.sh
#!/bin/bash

USER="steam"
SERVICENAME="pavlovserver.service"
INSTALLDIRNAME="pavlovserver"
USERHOME="/home/$USER"

echo -e "Beginning Pavlov VR update run on $(date)\n\n"

systemctl stop "$SERVICENAME"

sleep 5
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +force_install_dir "$USERHOME/$INSTALLDIRNAME" +app_update 622970 +exit
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +app_update 1007 +quit
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/.steam/sdk64/steamclient.so"
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/pavlovserver/Pavlov/Binaries/Linux/steamclient.so"

systemctl start "$SERVICENAME"

echo -e "Ending Pavlov VR update run on $(date)\n\n"

EOF

chmod +x $HOME/pavlov_daily_update_and_restart.sh
mkdir $HOME/pavlov_update_logs && touch $HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log
CRONLINE="00 2 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
(sudo crontab -u root -l; echo "$CRONLINE" ) | sudo crontab -u root -
unset CRONLINE

</pre>

These commands will:

1. Create a shell script in the "steam" user's home directory that automatically stops the Pavlov server, pulls any updates via steam, pull updates to the Steamworks SDK Redist, and copies the latest version of steamclient.so to the Pavlov server directory

2. Make the shell script executable

3. Create a new directory called "pavlov_update_logs" in the "steam" user's directory, and create a logfile inside that directory called "pavlov_daily_update_and_restart.sh.log". You can check this logfile to see the output of the Pavlov and Steam SDK update commands.

4. Create a crontab entry for the root user that runs this shell script automatically every day at 2:00AM local time

If you want to change the time that this script runs, edit the numbers "00 2" in the line that starts with "CRONLINE=". In the example provided, 00 is the minutes column, and 2 is the hour column. For example, if you wanted the server to automatically update and restart at 4:17AM every day, change the line starting with "CRONLINE=" to:

<pre>
CRONLINE="17 4 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
</pre>

If the time is PM, use 24-hour time format, e.g. "32 18" for 6:32PM.

----

=== Supervising the server using systemd ===

Running '''./PavlovServer.sh''' in your interactive shell is easy, but the server will shut down when you close your terminal. If you want to run the server in the background,
you'll want to run it under a supervisor. There are many options, ranging from the simple (nohup, screen or tmux), to the
more robust (supervisord, systemd).

Systemd is running by default on Ubuntu Linux, so we'll use that here.

To run the server as a systemd service, create the file '''/etc/systemd/system/pavlovserver.service''' (as root) by typing
<pre>
sudo nano /etc/systemd/system/pavlovserver.service
</pre>

Copy contents below into the file and save.

<pre>
[Unit]
Description=Pavlov VR dedicated server

[Service]
Type=simple
WorkingDirectory=/home/steam/pavlovserver
ExecStart=/home/steam/pavlovserver/PavlovServer.sh

RestartSec=1
Restart=always
User=steam
Group=steam

[Install]
WantedBy = multi-user.target
</pre>

If you'd like your server to start as competitive without editing the game.ini, change the line "ExecStart=/home/steam/pavlovserver/PavlovServer.sh" to look like this below. Though it's much easier to just use the game.ini to enable competitive instead. <pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -COMPETITIVE=1</pre>

Change the user or paths as appropriate. After saving the service file, to start, restart, stop, or monitor the server:

<pre>
sudo systemctl start pavlovserver
sudo systemctl restart pavlovserver
sudo systemctl stop pavlovserver
sudo systemctl status pavlovserver
</pre>

To view the logs:

<pre>
sudo journalctl -u pavlovserver
# to live-tail the logs
sudo journalctl -u pavlovserver -f
</pre>

If you want to run the pavlov server as soon as your server boots (e.g. a VPS you turn on and off), add pavlov as a startup service:

<pre>
sudo systemctl enable pavlovserver
</pre>

----

== Advanced Server Administration ==

=== Running multiple servers on one host ===

* Pavlovserver is functionally single threaded (there are multiple threads, but vast majority of work occurs in the primary one). Make sure you have # of pavlovservers + 1 CPU available. More CPUs= more servers. Faster CPU = more players.
* Make multiple server installs by defining a separate install dir for each server.
* Run each server with a unique port. eg: '''./PavlovServer.sh -PORT="Desired Port"'''
* The Server will use the Desired Port and the Port 400 above (Example: You choose 8200 as Port. So Port 8600 will be used as well)
* If you are using RCON, each server will need a unique port defined in RconSettings.txt
* Ensure the ports are forwarded and opened in your firewall

To duplicate directories:

be in the steam home folder
<pre>
cp -r pavlovserver pavlovserver1
/home/steam/pavlovserver1/PavlovServer.sh -PORT=[Desired Port]
</pre>

=== Starting server in competitive mode ===
Competitive mode will prevent dead teammates from being able to see the match, to prevent ghosting.
You can either enable this via Game.ini (described in Game.ini file), or using the -COMPETITIVE=1 parameter.

<pre>
/home/steam/pavlovserver1/PavlovServer.sh -COMPETITIVE=1
</pre>

== Automated RCON examples ==
here are some examples of scripts that interact with Pavlov RCON

* '''<big>Inspect players every 5 minutes</big>''' [https://github.com/JTWP-org/inspect-every-5-mins (installation instructions on GITHUB )]

This [https://www.gnu.org/software/bash/ BASH] script will collect current players stats for every one. then it will write them to a log in JSON format that can easily be handled for your records or the next project ..

below is all the info that will be collected
{| class="wikitable"
|+
|PlayerName
|Salted Cracker Jack
|-
|UniqueId
|76561198210003277
|-
|Score
|NUM
|-
|KDA
|KILLS / DEATHS / ASSIST
|-
|Dead
|TRUE / FALSE
|-
|CASH
|PLAYYERS MONEY
|-
|TEAM ID
|0 / 1
|}

----

=== Useful Linux Commands ===

List files / folders in directory, print current working directory,
<pre>ls -la #list files/directories along with authorities and ownership
pwd #print working directory
sudo chown <owner> <file/directory> #change owner of file/directory. If root created something and you need to change it to steam
sudo chgrp <group> <file/directory> #change group of file/directory.
</pre>

Check if pavlov is running by checking process status. If the only row you see is the grep command, pavlov server is not started.
<pre> ps -ef | grep pav </pre>

Sample output:
<pre>
steam 34044 1 0 16:52 ? 00:00:00 /bin/sh /home/steam/pavlovserver/PavlovServer.sh
steam 34066 34044 80 16:52 ? 00:00:04 /home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer
zombies+ 34101 34013 0 16:52 pts/0 00:00:00 grep --color=auto pav
</pre>

Kill a process. Note this command uses 34044, which is a process id from the command output above.
<pre> kill -9 34044 </pre>

Dump the log to the console so you can scroll through it:
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log </pre>

Search the log for a string - replace my_string with case-sensitive string
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep my_string </pre>

=== Default Map ID's ===
datacenter

sand

bridge

containeryard

siberia (Prison Break)

hospital (Zombies map)

killhouse

range

tutorial

santorini

station

industry

ogcontainers (Shack only)

haguenau (Shack only)

foundation (Shack only)

stalingrad (PC only)

stalingrad_night (PC only)

santorini_night (PC only)

sand_night (PC only)

station_night (PC only)

industry_night (PC only)

bunker (PC only)

=== Automated server log backup ===

here is how to setup a bash script to 1x a day compress all log files and save them to protect from auto deletion it will also post a discord webhook to confirm its working and saved the days logs

https://github.com/JTWP-org/backUpLogs

== Troubleshooting ==

To run the server without outputting the heartbeat:

<pre>./PavlovServer.sh | sed '/heartbeat/d'</pre>

To monitor the logs (without heartbeat) from another terminal:

<pre>tail -f -n10000 /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep -v 'Sending heartbeat to masterserver'</pre>

Check your CPU Clock Speed with:

<pre>lscpu | grep MHz</pre>

=== Server won't start ===

Error message:
<pre>
ln: failed to create hard link '/home/steam/.steam/sdk64/steamclient.so': File exists
ln: failed to create hard link '/home/steam/pavlovserver/Pavlov/Binaries/Linux/steamclient.so': File exists
/home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer: error while loading shared libraries: libc++.so.1: cannot open shared object file: No such file or directory
</pre>

First two errors are harmless. The third one is because libc++ step was skipped or failed. Using sudo capable id (probably not steam id), [re]run this line:
<pre>sudo apt update && sudo apt install -y gdb curl lib32gcc1 libc++-dev unzip </pre>

=== Map wont load (kicks to datacenter) ===

try deleting all the downloaded workshop maps with:

<pre>sudo rm -rf /tmp/workshop/7777/content/555160/*</pre> for all maps or

<pre>sudo rm -rf /tmp/workshop/7777/content/555160/whatever-UGC</pre> for specific map

=== Map wont load when running in a container ===
The three typical container problems I have seen:

1) Steam can't write to /tmp for some reason

2) /tmp is actually tmpfs instead of real filesystem and a few gigs of maps runs you out of RAM

3) Made worse by fact that pavlovserver unpacks downloads to ram, then writes to /tmp/workshop. Not enough RAM to do this, no map for you.

=== Server stuck rotating forever ===

Run these 2 commands, then restart your server:

<pre>cd ~/Steam && ./steamcmd.sh +login anonymous +app_update 1007 +quit
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so</pre>

If this doesn't fix it, double check that your server isn't running on the same port as another, by running this command:

<pre>ps -ef | grep pav</pre>

Then if 2 servers are on the same port, you can fix it by editing the pavlovserver.service file, and making sure the following line:

<pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -PORT=Number</pre>

has a unique number after the port for each server you're running.

=== Server - ping 999 ===
Google Cloud Platform - Make sure your compute engine has a network tag and your network rules are applied to the tag.
Make sure you opened the specified ports.

Network testing tools:
Test if your server will respond to ping from outside your network:
https://www.wormly.com/test-remote-ping

Test if your ports are accessible via UDP (7777,8177,9100):
https://www.ipvoid.com/udp-port-scan/

=== Can't connect to RCON ===
Check the file and group owner of RconSettings file. It should be steam, or the ID used to run the pavlov server.
<pre>
cd /home/steam/pavlovserver/Pavlov/Saved/Config
ls -la
</pre>

If the owner/group are not steam, using root or an id with sudo authority, change them to steam, confirm they are now set properly, then restart the pavlov server. (Note - if Rcon has wrong permissions, after fixing you should also to check the other config files like Game.ini, mods/blacklist/whitelist for the same issue. If steam can't access these files, it could cause problems.).
<pre>
cd /home/steam/pavlovserver/Pavlov/Saved/Config
sudo chown steam RconSettings.txt
sudo chgrp steam RconSettings.txt
ls -la </pre>

=== PC ONLY - Map Download stops ===

When downloading a large map from the steam workshop make sure your VPS/Dedi or Shared hosting provider (Otherwise known as a GSP's) has enough RAM assigned to store the map files in its tempfs (stored in ram)!

This is less likely to happen on Dedicated servers and VPS with a decent amount of ram unless you are using docker with RAM limits!

Most GSP's will be using docker or some other type of jailing method to limit system resource allocations and direct access to the host machine, if they are and you know what map you want to use make sure you order a service with enough ram to store your map. If in doubt contact your GSP's support team.

=== Getting Help ===

There's a #pc-custom-servers channel on the official Pavlov Discord - https://discord.gg/Pavlov-VR. Lots of helpful people there!

Setting up a dedicated server

2023-05-26T02:45:57Z

SaltedCrackerJack: /* Automated RCON examples */

== Setting up a dedicated server ==

'''There are no Windows binaries'''

This guide is written exclusively for Linux and covers Ubuntu/Debian/Debian-like and Red Hat RPM-based distros. Possible to run with other distros, but some of the commands won't work and you will need to know enough to figure out the software install of dependencies on your own.

If you are considering hosting from home, please read that section of the wiki first.

This guide assumes you know the basics of using a bash terminal: ssh'ing into a server, running bash commands, editing text files, etc.

If you have no experience using bash, maybe start [https://www.howtogeek.com/140679/beginner-geek-how-to-start-using-the-linux-terminal/ here]. Editing text files via commandline is often a challenge. Suggest using nano and reading guide [https://www.howtogeek.com/howto/42980/the-beginners-guide-to-nano-the-linux-command-line-text-editor/ here]

If you are new to linux and accessing your server from Windows, highly suggest using MobaXterm as your SSH client as that can make required editing of text files easier using built in editor instead of the native linux command line editors.

And finally, ask yourself why you want to setup a server? If you look at the list, there are many, many more servers than players. If you don't have a team, discord community, or group of friends ready to play on your server, chances are it will go unused. Got one of these... great, let's go.

If you don't want to go through the hassle yourself and want to pay for a hosting service Arctic VR (PC and Shack) and Horde (Shack) provide a server hosting services and are trusted in the community. See links below.

----

=== Server Requirements ===

'''Pavlovserver can only be hosted under Linux.'''

This can be running as a VM under windows, but this will increase the complexity of the setup beyond this guide.

Ubuntu 18.04 x86_64, Ubuntu 19/04 amd64, Ubuntu 20.04, and Rocky Linux 8 are confirmed working. Ubuntu 15.04 x86 is known to fail to install using this guide. Recommend not running on "minimal" images as some tools are missing.

* 2GB RAM + 1GB RAM per each additional server with 10 players. More RAM is recommended for larger maps, higher player counts, or complex gamemodes. Not having enough RAM is a common cause of server crashes.

* A ~2.5Ghz CPU will comfortably support a 10 player server.

* A ~4Ghz CPU will comfortably support 24 players. This is a limit built into Pavlov itself, no server will allow players to join over 24. Lower player counts are recommended for complex gamemodes (E.g. CodZ) and/or highly detailed maps, so that maximum number will often be lower.

(Note that these are '''not''' hard limits for player counts, just suggestions for the best performance, based on experiences with many server providers on different grades of hardware.)

* Pavlovserver is functionally single threaded (one thread does vast majority of work). More CPUs only help if you are running more servers. More clockspeed = higher performance = more users per server.
The maximum number of servers you can run is dependent on how many CPUs you have. For example, if you have an 8 core CPU, the maximum number of servers would be 7. You should always have at least one CPU free as overhead, as Pavlov servers can use slightly more than one thread.

----

==== Hosting at home ====
When hosting at home there are additional requirements regarding networking: Your router has to support port-forwarding, hair-pinning/LoopbackNAT, and respond to ping requests. These techniques are necessary to allow your server to be found and to talk back to the client. please see https://en.wikipedia.org/wiki/Port_forwarding, https://en.wikipedia.org/wiki/Hairpinning, and https://www.speedguide.net/faq/how-to-become-pingable-behind-a-routerfirewall-376 for more info and google for these terms in addition to your router model to find guides on how to enable/configure it properly. If you have modern Router, it may have these features already enabled, in this case you just have to configure port-forwarding. If you can see your server but not join it while others can, this is indicative of a failure of LoopbackNAT.

A second challenge to hosting at home is CGNAT (Carrier grade NAT: https://www.a10networks.com/blog/carrier-grade-nat/). Just like NAT on your home network that has to be gotten around w/ port-forwarding, CGNAT breaks the ability of external connections to be made back to your server, but the controls are solely in your ISPs hands. Sometimes if you ask, you can be removed from CGNAT pools and/or assigned a static IP. CGNAT rollouts are becoming very common now, so if your server worked then doesn't allow connections now, your ISP may have made this change.

You can check whether you’re on a CGNAT network by visiting a Web site such as ipaddress.com or whatsmyip.com and comparing the IP address listed to the public/WAN IP address assigned to your Internet gateway. To find your gateway’s public IP address, check the status page in the administrative interface. If the two IP addresses differ, you’re likely on a CGNAT network. If so, this problem must be resolved before you go any further.

'''Not understanding these requirements and configuration is a frequent cause of failed setups and questions in discord. Don't skip this if you are trying to host from home'''

'''There are serious security implications of hosting this software at home.''' None of the devs are security experts and there has been no security review of the code. You are opening up your system to the world and publicity advertising this fact. Expect that any system hosting this software is open to compromise from the Internet and act accordingly. If your router offers a DMZ network, use it. Consider hosting on a cloud based server and think twice before running this software on any system that contains data you care about or has access to networks and computers you care about.

If you're hosting at home using Oracle's VirtualBox, there are steps you can take to prevent double NAT (which can cause issues later on)

1. Select your VM and then click Settings in VirtualBox's main window.

2. Click on Network and change Attached To from NAT to Bridged Adapter.

Once you've done this, your VM should be connected directly to your home router and double NAT should no longer be a issue.
----

==== Hosting Providers ====

Considering the suggested server specs, you may be interested in the following hosting providers. For providers promising dedicated "Pavlov hosting" as opposed to general VPS services please contact and ask how you change maps being hosted and how you get RCON access before you put your money down.

<pre>
Provider | Base CPU | Details
Arctic VR | 4.5 GHz | https://www.arctic-vr.com/server-hosting
Amazon Web Services | 4.0 GHz | https://aws.amazon.com/ec2/instance-types/z1d/
VULTR | 4.0 GHz | https://www.vultr.com/products/high-frequency-compute/
packet.com | 3.5 GHz | https://www.packet.com/cloud/servers/c1-small/
Google Cloud Platform | 3.2 GHz | https://cloud.google.com/compute/docs/cpu-platforms
</pre>

===== ARCTIC VR =====

Arctic VR is the largest and longest running Pavlov VR hosting provider. The In-Game Admin Menu is exclusive to the ArcticVR hosting service. They offer EU, NA East and NA West servers for both shack and PCVR. ArcticVR offers the fastest Pavlov servers as well as DDos Protection, RCON remote management, custom maps, low pings, unlimited slots, and expert support.

Website: https://www.arctic-vr.com/server-hosting

[[File:Arctic_options.png|link=https://www.arctic-vr.com/server-hosting|700px]]

===== VULTR =====

Consider using a referral from the community:

Carlos: https://www.vultr.com/?ref=8615589-6G

Carrot: https://www.vultr.com/?ref=8689348

Archaeo: https://www.vultr.com/?ref=8653652-6G

Cheeto: https://www.vultr.com/?ref=8717358

For a Pavlov Shack server, I recommend minimum Cloud Compute, Intel High Performance, Ubuntu 20.04, and disabled automatic backups. At the time, this was $6/m. Some of the cheap options have 1TB bandwidth, and some have 2TB+. If it's a personal server, 1TB could be fine, but 2TB should be safe.

===== Google Cloud Platform (90 day free credit available) =====

The below configuration is successfully running 4 pavlov PC instances with ~15 total maps and up to 24 players per server. If you want more maps use larger boot disk. Both can dynamically be scaled based on popularity.

<pre>

Menu -> compute engine -> VM instances
create instance
- region: wherever you like
- machine type: n1-highcpu-4 (4 vCPUs, 3.6 GB memory)
- boot disk: Ubuntu 20.04
- boot disk -> size: 25gb
- network tags: pavlov-server
- [create]

Menu -> Vpc network -> firewall rules
[Create firewall rule]
Name: pavlov server
Target Tags: pavlov-server
Source IP Ranges: 0.0.0.0/0
Protocols and Ports -> Specified protocols and ports -> UDP: 7777, 8177 (Shack and PC)
Protocols and Ports -> Specified protocols and ports -> TCP: 7777, 8177 (Shack-only)
Protocols and Ports -> Specified protocols and ports -> TCP: {RCON port - default 9100}
[save]
</pre>

===== Amazon Web Services (30 day free credit available) =====

<pre>
Login -> Change Region: Choose your region
Services -> Compute -> EC2 -> Create
Choose an AMI: Ubuntu 18.04
Instance Type: z1d.large

Instance Details -> Tenancy: Dedicated (optional: this will more than triple the cost)

Storage: 50gb disk (or whatever, you're in control of the map roster)

Security Groups:
Create a new Security Group
Security group name: pavlov-server
Description: pavlov server
Rules:
Type: Custom ICMP Rule - IPV4 / Protocol: Echo Request
Type: Custom UDP Rule / Port Range: 7777 / Source: 0.0.0.0/0
Type: Custom UDP Rule / Port Range: 8177 / Source: 0.0.0.0/0
Type: SSH (optional, but I assume you wanna SSH in..)

Launch -> Create new Keypair -> Download -> Launch

Once it's started, SSH in like:
$ ssh -i your-key.pem ubuntu@you-server-details.amazonaws.com

(I use cmder on Windows, if you're using putty or mobaxterm or something, might be different)
</pre>

=== Starting Server Install ===

====Obtaining an ApiKey====
For your server to show up in the server list, there is now a requirement to have an ApiKey issued by vankrupt. This is to prevent DOS attacks against the master server

Get the key by going here: https://pavlov-ms.vankrupt.com/servers/v1/key and using your mobile number to get a SMS
(note that there have been reported failures of this SMS system for non-US mobiles. In this case DM davevillz your mobile and ask for a key)

Put this key in your Game.ini as follows:
ApiKey="ABC123FALSEKEYDONTUSEME"
or if you would like (personally untested..I would use game.ini) you can call it at server runtime with flag as follows:
-KEY="ABC123FALSEKEYDONTUSEME"

This key can be re-used for a reasonable number of servers (a limit of 10 has been mentioned). Contact the Devs if you need more servers per key.

====System setup and software installation====

Install dependencies and create the `steam` user. (You only need to do this once):

Confirm Linux version
<pre>
lsb_release -a
</pre>

'''Ubuntu 20.04'''
<pre>
sudo apt update && sudo apt install -y gdb curl lib32gcc1 libc++-dev unzip
sudo useradd -m steam
</pre>

'''Ubuntu 20.10 or higher'''
<pre>
sudo apt update && sudo apt install -y gdb curl lib32gcc-s1 libc++-dev unzip
sudo useradd -m steam
</pre>

'''Rocky Linux, CentOS 8, and RHEL 8'''

<pre>
sudo sed -i 's/^SELINUX=enforcing$/SELINUX=permissive/g' /etc/selinux/config
sudo setenforce 0
sudo yum install gdb curl glibc.i686 libstdc++.i686 libstdc++-devel.i686 libstdc++-devel.x86_64 unzip wget -y
wget https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/l/libcxx-3.8.0-3.el7.x86_64.rpm
sudo rpm -i libcxx-3.8.0-3.el7.x86_64.rpm
sudo useradd -m steam
</pre>

[Optional] Set a password for steam.
<pre>sudo passwd steam</pre>

Login as the steam user. ('''You will need to do this each time you connect to your server'''):

<pre>
sudo su -l steam
</pre>

Install Steam:

<pre>
mkdir ~/Steam && cd ~/Steam && curl -sqL "https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz" | tar zxvf -
</pre>

There are different dedicated server versions for Pavlov Server - choose which server version you want to host (PC non-beta, PC Beta, Shack Live, or Shack RC)
(You will need to run this command each time there is a Pavlov Server update). 
To host '''PC Server (non-beta)''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 +exit
</pre>

To host '''PC BETA''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta beta_server +exit
</pre>

To host '''Shack Live''' (Quest):

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack +exit
</pre>

To host '''Shack RC''' (Quest): 

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack_beta +exit
</pre>

Now that we've installed the server, all pavlov server versions should continue. 
Install a fresh copy of steamclient.so (May have to do this after each update):
<pre>
~/Steam/steamcmd.sh +login anonymous +app_update 1007 +quit
mkdir -p ~/.steam/sdk64
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/pavlovserver/Pavlov/Binaries/Linux/steamclient.so
</pre>

Make the PavlovServer script executable. (You only need to do this once):

<pre>
chmod +x ~/pavlovserver/PavlovServer.sh
</pre>

----

=== Server Configuration ===

Before starting the server we need to configure it. Start by creating some directories:

<pre>
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Logs
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps
</pre>

==== Mods/Blacklist/Whitelist (optional) ====

The following three files allow you to specify mods, banned players, and whitelist players. These are optional, but go ahead and create them. Populating the files is described later.

<pre>
touch /home/steam/pavlovserver/Pavlov/Saved/Config/mods.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/blacklist.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/whitelist.txt
</pre>

====Configuring Game.ini====
Create a new Game.ini file using following command to open an editor and copy/paste the following block into it then save it. Note not all of these options are required. For instance remove or comment out the Password=0000 line to make a public server with no pin.
<pre>
nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini
</pre>

<pre>
[/Script/Pavlov.DedicatedServer]
bEnabled=true
ServerName="My_private_idaho"
MaxPlayers=10 #Set this to 10 for Shack. 24 is the max for PC, setting it higher will not allow players to join.
ApiKey="ABC123FALSEKEYDONTUSEME"
bSecured=true
bCustomServer=true
bVerboseLogging=false
bCompetitive=false #This only works for SND
bWhitelist=false
RefreshListTime=120
LimitedAmmoType=0
TickRate=90
TimeLimit=60
#Password=0000
#BalanceTableURL="vankruptgames/BalancingTable/main"
MapRotation=(MapId="UGC1758245796", GameMode="GUN")
MapRotation=(MapId="datacenter", GameMode="SND")
MapRotation=(MapId="sand", GameMode="DM")

</pre>

* '''bEnabled''' - whether the server appears in the server list (unconfirmed)
* '''ServerName''' - name it will be listed as. (approx 35 chars max)
* '''MaxPlayers''' - See suggested specs for limits. 10 standard (10 for shack), 20-24 is max recommended for large maps like Stalingrad or PUSH/RUSH modes, and servers allow a maximum of 24 players.
* '''ApiKey''' - Unique ApiKey required to register server with master server. Replace with your key
* '''bSecured''' - enabled Valve Anti-Cheat (VAC)
* '''bCustomServer''' - activates some new modding tools (save and http functions. Required to write to blacklist.txt for bans)
* '''bCompetitive''' - sets the server to competitive mode for SND. If removed the server will default to false
* '''bVerboseLogging''' - enables verbose logging, mostly detailed statistics. Be prepared for significant increase in logging.
* '''bWhitelist''' - Only allow users in whitelist.txt to join
* '''RefreshListTime''' - sets how often the running server checks for updates in ban/whitelist/mod files
* '''LimitedAmmoType''' - sets limited ammo mode
0 = Unlimited
1 = Limited Generic
2 = Limited Specific
3 = Custom (for modders)
4 = Limited Special
5 = Boxless Mode

* '''TimeLimit''' - sets time limit for each map
* '''TickRate''' - sets the server tickrate. (so far minimum stable seems around 50 and max around 120. Beware setting this changes weapon despawn time and breaks some game modes. Recommend not touching)
* '''Password''' - PIN number for server #FYI - this is now also changeable via rcon.
* '''BalanceTableURL''' - Points to a custom balance table from github. See https://github.com/vankruptgames/BalancingTable for instructions. This line isn't needed if you don't have one.
* '''MapRotation''' - you can add multiple of these. The MapId must be “UGC” followed by the map ID. you can find the map id in the URL of the steam workshop page. When a match ends, the server will load the next map in the rotation. You can also use RCON to switch to a map not included in rotation.

Available game modes as of 09/06/2022: SND, TDM, DM, GUN, ZWV, WW2GUN, TANKTDM, KOTH, TTT, OITC, INFECTION, HIDE, PUSH, PH 

And for Shack only: CTF

For maps running a Custom gamemode (CodZ, BR, Duel, etc.) it doesn't matter which gamemode you choose, as the map will automatically override it with the custom mode.

UGC###### are for custom maps from Steam workshop (PC Only). Find the map you want in the workshop. This is the URL for Mirage (https://steamcommunity.com/sharedfiles/filedetails/?id=2670152485). The 10 numbers at the end of the URL are what you need, so UGC1661803933 would be the MapId for Mirage.

==== Firewall/Port forwarding ====
Using the default settings there are two UDP ports (7777, 8177) that need to be allowed to access the server either by firewall setup or port forwarding.

'''Ubuntu''' firewall commands to check firewall and open ports:
<pre>
sudo ufw status
sudo ufw allow 7777
sudo ufw allow 8177
sudo ufw allow 9100
sudo ufw status
</pre>

'''Rocky Linux''' firewall commands to check firewall and open ports:
<pre>
sudo firewall-cmd --zone=public --add-port=7777/tcp
sudo firewall-cmd --zone=public --add-port=7777/udp
sudo firewall-cmd --zone=public --add-port=8177/tcp
sudo firewall-cmd --zone=public --add-port=8177/udp
sudo firewall-cmd --zone=public --add-port=9100/udp
sudo firewall-cmd --zone=public --add-port=9100/tcp
sudo firewall-cmd --list-ports
firewall-cmd --runtime-to-permanent
</pre>

You may also need to allow Pings (ICMP) for the server's true latency to appear in the master list.

If you are running multiple servers and have set additional ports (see http://wiki.pavlov-vr.com/index.php?title=Dedicated_server#Running_multiple_servers_on_one_host) then you need to allow access to the defined port plus the port 400 higher. So if you use 7000 as your port, then UDP 7000 and 7400 need to be open

If you have setup rcon via RconSettings.txt (below) then that port also need to be allowed access via TCP

If you are running Shack/Quest and want to have maps that are downloadable from your server, your server ports (ex. 7777 & 8177) must also be open via TCP

----

==== Shack Maps (Quest) ====

If you try to use the steps above to add maps for Shack, youll run into issues very quickly. This is because Shack has no affiliation to Steam, and therefore cannot use Steam Workshop maps like above. In the future, these steps will apply to PC servers as well, allowing a server to hold the map itself, instead of offloading to Steam.

To get started, first create the directory to hold the maps

<pre>mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps</pre>

You can use any number of methods to move the map files onto the server, but ill go over the two simplest, starting with a GUI approach

Download and install CyberDuck onto your "home" PC (Whatever PC you use for access to the server, but not the server itsself): https://cyberduck.io/

Next, download and unzip your map of choice from https://www.pavlovquest.com/ , https://pavlovhorde.com/mapsList, or look in #shack-map-showcase channel in the discord server. I'm going to use Cheeto's WW2 Items test (http://www.mediafire.com/file/emyt9bs1z9u9ykw/SVR_Cheeto_Items.zip/file ) for this example, you do what you like

In the top left corner, open a connection, set the connection type to SFTP, and fill in the rest of the information. User will be root, password is whatever you set the root pw as (toor in Ubuntu by default)

In the directory dropdown (itll say /root) go back to /

Follow the directories until we arrive back at our "maps" folder <pre>/home/steam/pavlovserver/Pavlov/Saved/maps</pre>

Drag and drop the unzipped map folder into the main window, in this case itll be SVR_Cheeto_Items

Hit Allow

Youll now see a folder named SVR_Cheeto_Items, and within it should be nothing but 3 files. If there is another folder in it, move this folder to the maps directory, otherwise the server wont work. The 3 files (2 .PAK one .JSON) should be in home/steam/pavlovserver/Pavlov/Saved/maps/SVR_Cheeto_Items, no more, no less.

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

To play the map, you can either use RCON switch map command, or to add the map to your servers automatic map rotation list, add the map's folder name to your Game.ini. This replaces the MapID section, so for our example it would be

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

And thats all! Disconnect CyberDuck from your server before playing, otherwise youll have difficulty joining.

-----------

==== Adding Shack Maps over Command Line Interface ====

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

A bit more complicated, but adding maps over CLI has its benefits

First, CD to the maps directory you made above

<pre>cd ~/pavlovserver/Pavlov/Saved/maps</pre>

Download the map files from whatever you use to upload them. To do this, you can either use curl or wget

<pre>curl -O insertURLhere</pre>

'''If you download your map from Google Drive''', make sure that your .zip folder is shared to anyone.
Then, get the file's url from the shared link. Example : ''<nowiki>https://drive.google.com/file/d/19bI8gUHaN5tUrDvnadAacUnchQf6_k/view</nowiki>'' will be ''19bI8gUHaN5tUrDvnadAacUnchQf6_k''
Edit "fileId" and "fileName" before you execute the command.
<pre>
fileId=19bI8gUHaN5tUrDvnadAacUnchQf6_k
fileName=SVR_USER_MAPNAME
curl -sc /tmp/cookie "https://drive.google.com/uc?export=download&id=${fileId}" > /dev/null
code="$(awk '/_warning_/ {print $NF}' /tmp/cookie)"
curl -Lb /tmp/cookie "https://drive.google.com/uc?export=download&confirm=${code}&id=${fileId}" -o ${fileName} </pre>

To keep with the Items example:

<pre>curl -O https://cdn.discordapp.com/attachments/744185280759857234/745027406695366788/SVR_Cheeto_Items.zip</pre>

Next, unzip the file. If this next step errors out, saying the command is unknown, switch back to the root user (su root), and install unzip (sudo apt install unzip), then return to the steam user, and continue.

<pre>unzip SVR_Cheeto_Items.zip</pre>

Now finish like before by adding the map to your Game.ini

<pre>nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini</pre>

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

==== Admin/Moderator list (optional) ====

The only working in-game admin menu is through Arctic VR server hosting (see below).

If you add moderators to your server, they will not be subject to vote kicks.

<pre>
nano ~/pavlovserver/Pavlov/Saved/Config/mods.txt
</pre>

Example Mod List:
<pre>
76541198397498572 #Optional Comment: Player name
76541198397498573 #Some Other Player
</pre>

==== ArcticVR Admin Menu ====

[[File:Arcticmenu.jpg|500px|link=https://www.arctic-vr.com/server-admin-menu]]

Arctic-VR Offers an advanced In-Game Admin menu that is exclusive to their hosting service. Features include:
* Switch Maps+Modes
* Teleport Players to Players
* Change Player Skins
* Control Player Buying+Cash
* Spawn Items
* Clean up corpses + guns
* Spawn Bots
* Spawn Items for other players
* Control Teams + Balance/Shuffle Teams
* ResetSND
* And More

You can read more about the ArcticVR admin menu on their website: https://www.arctic-vr.com/server-admin-menu

==== Handy tools for finding steamIDs ====

Steam ID finder: https://steamidfinder.com/lookup/ or https://steamid.xyz/

You want to enter in the steamID64 format.

This tool can convert or lookup IDs: https://steamid.io/

If you are looking for a steamID of a player that has been on your server recently this is technique to find them:
<pre>
grep -i playername ~/pavlovserver/Pavlov/Saved/Logs/* | grep TicketValidation
</pre>

=== Configure Rcon ===
To enable Rcon access create config file:
<pre> nano /home/steam/pavlovserver/Pavlov/Saved/Config/RconSettings.txt </pre>

Copy in the following text - change password, and if desired the port:
<pre>
Password=ChangeThisPassword
Port=9100
</pre>
You must specify a port for the Rcon server to use as well as a Password (use a different port per sever instance if running multiple server instances off the same hardware)

=== Starting the server ===

<pre>
cd ~/pavlovserver && ./PavlovServer.sh
</pre>

That's it, your server will be automatically broadcast to the master server! :)

Two handy tools to determine quickly if your server is broadcasting are [https://pablub.xyz/ Pablub] (PC only) and [https://pavlovhorde.com/ Horde] (Shack) and [https://pavlovhorde.com/pcServers Horde] (PC version)

Note that when you close your terminal, the server will go down. See the "supervisors" section below for how to prevent this.

=== Auto-updating the server ===

Assuming you have followed this guide and used the default paths, users, and install instructions, you can paste the following into your terminal to auto-update your Pavlov server:

<pre>
cat << 'EOF' > $HOME/pavlov_daily_update_and_restart.sh
#!/bin/bash

USER="steam"
SERVICENAME="pavlovserver.service"
INSTALLDIRNAME="pavlovserver"
USERHOME="/home/$USER"

echo -e "Beginning Pavlov VR update run on $(date)\n\n"

systemctl stop "$SERVICENAME"

sleep 5
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +force_install_dir "$USERHOME/$INSTALLDIRNAME" +app_update 622970 +exit
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +app_update 1007 +quit
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/.steam/sdk64/steamclient.so"
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/pavlovserver/Pavlov/Binaries/Linux/steamclient.so"

systemctl start "$SERVICENAME"

echo -e "Ending Pavlov VR update run on $(date)\n\n"

EOF

chmod +x $HOME/pavlov_daily_update_and_restart.sh
mkdir $HOME/pavlov_update_logs && touch $HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log
CRONLINE="00 2 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
(sudo crontab -u root -l; echo "$CRONLINE" ) | sudo crontab -u root -
unset CRONLINE

</pre>

These commands will:

1. Create a shell script in the "steam" user's home directory that automatically stops the Pavlov server, pulls any updates via steam, pull updates to the Steamworks SDK Redist, and copies the latest version of steamclient.so to the Pavlov server directory

2. Make the shell script executable

3. Create a new directory called "pavlov_update_logs" in the "steam" user's directory, and create a logfile inside that directory called "pavlov_daily_update_and_restart.sh.log". You can check this logfile to see the output of the Pavlov and Steam SDK update commands.

4. Create a crontab entry for the root user that runs this shell script automatically every day at 2:00AM local time

If you want to change the time that this script runs, edit the numbers "00 2" in the line that starts with "CRONLINE=". In the example provided, 00 is the minutes column, and 2 is the hour column. For example, if you wanted the server to automatically update and restart at 4:17AM every day, change the line starting with "CRONLINE=" to:

<pre>
CRONLINE="17 4 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
</pre>

If the time is PM, use 24-hour time format, e.g. "32 18" for 6:32PM.

----

=== Supervising the server using systemd ===

Running '''./PavlovServer.sh''' in your interactive shell is easy, but the server will shut down when you close your terminal. If you want to run the server in the background,
you'll want to run it under a supervisor. There are many options, ranging from the simple (nohup, screen or tmux), to the
more robust (supervisord, systemd).

Systemd is running by default on Ubuntu Linux, so we'll use that here.

To run the server as a systemd service, create the file '''/etc/systemd/system/pavlovserver.service''' (as root) by typing
<pre>
sudo nano /etc/systemd/system/pavlovserver.service
</pre>

Copy contents below into the file and save.

<pre>
[Unit]
Description=Pavlov VR dedicated server

[Service]
Type=simple
WorkingDirectory=/home/steam/pavlovserver
ExecStart=/home/steam/pavlovserver/PavlovServer.sh

RestartSec=1
Restart=always
User=steam
Group=steam

[Install]
WantedBy = multi-user.target
</pre>

If you'd like your server to start as competitive without editing the game.ini, change the line "ExecStart=/home/steam/pavlovserver/PavlovServer.sh" to look like this below. Though it's much easier to just use the game.ini to enable competitive instead. <pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -COMPETITIVE=1</pre>

Change the user or paths as appropriate. After saving the service file, to start, restart, stop, or monitor the server:

<pre>
sudo systemctl start pavlovserver
sudo systemctl restart pavlovserver
sudo systemctl stop pavlovserver
sudo systemctl status pavlovserver
</pre>

To view the logs:

<pre>
sudo journalctl -u pavlovserver
# to live-tail the logs
sudo journalctl -u pavlovserver -f
</pre>

If you want to run the pavlov server as soon as your server boots (e.g. a VPS you turn on and off), add pavlov as a startup service:

<pre>
sudo systemctl enable pavlovserver
</pre>

----

== Advanced Server Administration ==

=== Running multiple servers on one host ===

* Pavlovserver is functionally single threaded (there are multiple threads, but vast majority of work occurs in the primary one). Make sure you have # of pavlovservers + 1 CPU available. More CPUs= more servers. Faster CPU = more players.
* Make multiple server installs by defining a separate install dir for each server.
* Run each server with a unique port. eg: '''./PavlovServer.sh -PORT="Desired Port"'''
* The Server will use the Desired Port and the Port 400 above (Example: You choose 8200 as Port. So Port 8600 will be used as well)
* If you are using RCON, each server will need a unique port defined in RconSettings.txt
* Ensure the ports are forwarded and opened in your firewall

To duplicate directories:

be in the steam home folder
<pre>
cp -r pavlovserver pavlovserver1
/home/steam/pavlovserver1/PavlovServer.sh -PORT=[Desired Port]
</pre>

=== Starting server in competitive mode ===
Competitive mode will prevent dead teammates from being able to see the match, to prevent ghosting.
You can either enable this via Game.ini (described in Game.ini file), or using the -COMPETITIVE=1 parameter.

<pre>
/home/steam/pavlovserver1/PavlovServer.sh -COMPETITIVE=1
</pre>

== Automated RCON examples ==
here are some examples of scripts that interact with Pavlov RCON

'''<big>Inspect players every 5 minutes</big>''' [https://github.com/JTWP-org/inspect-every-5-mins (installation instructions on GITHUB )]

This [https://www.gnu.org/software/bash/ BASH] script will collect current players stats for every one. then it will write them to a log in JSON format that can easily be handled for your records or the next project ..

below is all the info that will be collected every 5

{| class="wikitable"
|+
|PlayerName
|Salted Cracker Jack
|-
|UniqueId
|76561198210003277
|-
|Score
|NUM
|-
|KDA
|KILLS / DEATHS / ASSIST
|-
|Dead
|TRUE / FALSE
|-
|CASH
|PLAYYERS MONEY
|-
|TEAM ID
|0 / 1
|}

----

=== Useful Linux Commands ===

List files / folders in directory, print current working directory,
<pre>ls -la #list files/directories along with authorities and ownership
pwd #print working directory
sudo chown <owner> <file/directory> #change owner of file/directory. If root created something and you need to change it to steam
sudo chgrp <group> <file/directory> #change group of file/directory.
</pre>

Check if pavlov is running by checking process status. If the only row you see is the grep command, pavlov server is not started.
<pre> ps -ef | grep pav </pre>

Sample output:
<pre>
steam 34044 1 0 16:52 ? 00:00:00 /bin/sh /home/steam/pavlovserver/PavlovServer.sh
steam 34066 34044 80 16:52 ? 00:00:04 /home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer
zombies+ 34101 34013 0 16:52 pts/0 00:00:00 grep --color=auto pav
</pre>

Kill a process. Note this command uses 34044, which is a process id from the command output above.
<pre> kill -9 34044 </pre>

Dump the log to the console so you can scroll through it:
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log </pre>

Search the log for a string - replace my_string with case-sensitive string
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep my_string </pre>

=== Default Map ID's ===
datacenter

sand

bridge

containeryard

siberia (Prison Break)

hospital (Zombies map)

killhouse

range

tutorial

santorini

station

industry

ogcontainers (Shack only)

haguenau (Shack only)

foundation (Shack only)

stalingrad (PC only)

stalingrad_night (PC only)

santorini_night (PC only)

sand_night (PC only)

station_night (PC only)

industry_night (PC only)

bunker (PC only)

=== Automated server log backup ===

here is how to setup a bash script to 1x a day compress all log files and save them to protect from auto deletion it will also post a discord webhook to confirm its working and saved the days logs

https://github.com/JTWP-org/backUpLogs

== Troubleshooting ==

To run the server without outputting the heartbeat:

<pre>./PavlovServer.sh | sed '/heartbeat/d'</pre>

To monitor the logs (without heartbeat) from another terminal:

<pre>tail -f -n10000 /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep -v 'Sending heartbeat to masterserver'</pre>

Check your CPU Clock Speed with:

<pre>lscpu | grep MHz</pre>

=== Server won't start ===

Error message:
<pre>
ln: failed to create hard link '/home/steam/.steam/sdk64/steamclient.so': File exists
ln: failed to create hard link '/home/steam/pavlovserver/Pavlov/Binaries/Linux/steamclient.so': File exists
/home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer: error while loading shared libraries: libc++.so.1: cannot open shared object file: No such file or directory
</pre>

First two errors are harmless. The third one is because libc++ step was skipped or failed. Using sudo capable id (probably not steam id), [re]run this line:
<pre>sudo apt update && sudo apt install -y gdb curl lib32gcc1 libc++-dev unzip </pre>

=== Map wont load (kicks to datacenter) ===

try deleting all the downloaded workshop maps with:

<pre>sudo rm -rf /tmp/workshop/7777/content/555160/*</pre> for all maps or

<pre>sudo rm -rf /tmp/workshop/7777/content/555160/whatever-UGC</pre> for specific map

=== Map wont load when running in a container ===
The three typical container problems I have seen:

1) Steam can't write to /tmp for some reason

2) /tmp is actually tmpfs instead of real filesystem and a few gigs of maps runs you out of RAM

3) Made worse by fact that pavlovserver unpacks downloads to ram, then writes to /tmp/workshop. Not enough RAM to do this, no map for you.

=== Server stuck rotating forever ===

Run these 2 commands, then restart your server:

<pre>cd ~/Steam && ./steamcmd.sh +login anonymous +app_update 1007 +quit
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so</pre>

If this doesn't fix it, double check that your server isn't running on the same port as another, by running this command:

<pre>ps -ef | grep pav</pre>

Then if 2 servers are on the same port, you can fix it by editing the pavlovserver.service file, and making sure the following line:

<pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -PORT=Number</pre>

has a unique number after the port for each server you're running.

=== Server - ping 999 ===
Google Cloud Platform - Make sure your compute engine has a network tag and your network rules are applied to the tag.
Make sure you opened the specified ports.

Network testing tools:
Test if your server will respond to ping from outside your network:
https://www.wormly.com/test-remote-ping

Test if your ports are accessible via UDP (7777,8177,9100):
https://www.ipvoid.com/udp-port-scan/

=== Can't connect to RCON ===
Check the file and group owner of RconSettings file. It should be steam, or the ID used to run the pavlov server.
<pre>
cd /home/steam/pavlovserver/Pavlov/Saved/Config
ls -la
</pre>

If the owner/group are not steam, using root or an id with sudo authority, change them to steam, confirm they are now set properly, then restart the pavlov server. (Note - if Rcon has wrong permissions, after fixing you should also to check the other config files like Game.ini, mods/blacklist/whitelist for the same issue. If steam can't access these files, it could cause problems.).
<pre>
cd /home/steam/pavlovserver/Pavlov/Saved/Config
sudo chown steam RconSettings.txt
sudo chgrp steam RconSettings.txt
ls -la </pre>

=== PC ONLY - Map Download stops ===

When downloading a large map from the steam workshop make sure your VPS/Dedi or Shared hosting provider (Otherwise known as a GSP's) has enough RAM assigned to store the map files in its tempfs (stored in ram)!

This is less likely to happen on Dedicated servers and VPS with a decent amount of ram unless you are using docker with RAM limits!

Most GSP's will be using docker or some other type of jailing method to limit system resource allocations and direct access to the host machine, if they are and you know what map you want to use make sure you order a service with enough ram to store your map. If in doubt contact your GSP's support team.

=== Getting Help ===

There's a #pc-custom-servers channel on the official Pavlov Discord - https://discord.gg/Pavlov-VR. Lots of helpful people there!

Setting up a dedicated server

2023-05-26T02:44:20Z

SaltedCrackerJack: /* Automated RCON */

== Setting up a dedicated server ==

'''There are no Windows binaries'''

This guide is written exclusively for Linux and covers Ubuntu/Debian/Debian-like and Red Hat RPM-based distros. Possible to run with other distros, but some of the commands won't work and you will need to know enough to figure out the software install of dependencies on your own.

If you are considering hosting from home, please read that section of the wiki first.

This guide assumes you know the basics of using a bash terminal: ssh'ing into a server, running bash commands, editing text files, etc.

If you have no experience using bash, maybe start [https://www.howtogeek.com/140679/beginner-geek-how-to-start-using-the-linux-terminal/ here]. Editing text files via commandline is often a challenge. Suggest using nano and reading guide [https://www.howtogeek.com/howto/42980/the-beginners-guide-to-nano-the-linux-command-line-text-editor/ here]

If you are new to linux and accessing your server from Windows, highly suggest using MobaXterm as your SSH client as that can make required editing of text files easier using built in editor instead of the native linux command line editors.

And finally, ask yourself why you want to setup a server? If you look at the list, there are many, many more servers than players. If you don't have a team, discord community, or group of friends ready to play on your server, chances are it will go unused. Got one of these... great, let's go.

If you don't want to go through the hassle yourself and want to pay for a hosting service Arctic VR (PC and Shack) and Horde (Shack) provide a server hosting services and are trusted in the community. See links below.

----

=== Server Requirements ===

'''Pavlovserver can only be hosted under Linux.'''

This can be running as a VM under windows, but this will increase the complexity of the setup beyond this guide.

Ubuntu 18.04 x86_64, Ubuntu 19/04 amd64, Ubuntu 20.04, and Rocky Linux 8 are confirmed working. Ubuntu 15.04 x86 is known to fail to install using this guide. Recommend not running on "minimal" images as some tools are missing.

* 2GB RAM + 1GB RAM per each additional server with 10 players. More RAM is recommended for larger maps, higher player counts, or complex gamemodes. Not having enough RAM is a common cause of server crashes.

* A ~2.5Ghz CPU will comfortably support a 10 player server.

* A ~4Ghz CPU will comfortably support 24 players. This is a limit built into Pavlov itself, no server will allow players to join over 24. Lower player counts are recommended for complex gamemodes (E.g. CodZ) and/or highly detailed maps, so that maximum number will often be lower.

(Note that these are '''not''' hard limits for player counts, just suggestions for the best performance, based on experiences with many server providers on different grades of hardware.)

* Pavlovserver is functionally single threaded (one thread does vast majority of work). More CPUs only help if you are running more servers. More clockspeed = higher performance = more users per server.
The maximum number of servers you can run is dependent on how many CPUs you have. For example, if you have an 8 core CPU, the maximum number of servers would be 7. You should always have at least one CPU free as overhead, as Pavlov servers can use slightly more than one thread.

----

==== Hosting at home ====
When hosting at home there are additional requirements regarding networking: Your router has to support port-forwarding, hair-pinning/LoopbackNAT, and respond to ping requests. These techniques are necessary to allow your server to be found and to talk back to the client. please see https://en.wikipedia.org/wiki/Port_forwarding, https://en.wikipedia.org/wiki/Hairpinning, and https://www.speedguide.net/faq/how-to-become-pingable-behind-a-routerfirewall-376 for more info and google for these terms in addition to your router model to find guides on how to enable/configure it properly. If you have modern Router, it may have these features already enabled, in this case you just have to configure port-forwarding. If you can see your server but not join it while others can, this is indicative of a failure of LoopbackNAT.

A second challenge to hosting at home is CGNAT (Carrier grade NAT: https://www.a10networks.com/blog/carrier-grade-nat/). Just like NAT on your home network that has to be gotten around w/ port-forwarding, CGNAT breaks the ability of external connections to be made back to your server, but the controls are solely in your ISPs hands. Sometimes if you ask, you can be removed from CGNAT pools and/or assigned a static IP. CGNAT rollouts are becoming very common now, so if your server worked then doesn't allow connections now, your ISP may have made this change.

You can check whether you’re on a CGNAT network by visiting a Web site such as ipaddress.com or whatsmyip.com and comparing the IP address listed to the public/WAN IP address assigned to your Internet gateway. To find your gateway’s public IP address, check the status page in the administrative interface. If the two IP addresses differ, you’re likely on a CGNAT network. If so, this problem must be resolved before you go any further.

'''Not understanding these requirements and configuration is a frequent cause of failed setups and questions in discord. Don't skip this if you are trying to host from home'''

'''There are serious security implications of hosting this software at home.''' None of the devs are security experts and there has been no security review of the code. You are opening up your system to the world and publicity advertising this fact. Expect that any system hosting this software is open to compromise from the Internet and act accordingly. If your router offers a DMZ network, use it. Consider hosting on a cloud based server and think twice before running this software on any system that contains data you care about or has access to networks and computers you care about.

If you're hosting at home using Oracle's VirtualBox, there are steps you can take to prevent double NAT (which can cause issues later on)

1. Select your VM and then click Settings in VirtualBox's main window.

2. Click on Network and change Attached To from NAT to Bridged Adapter.

Once you've done this, your VM should be connected directly to your home router and double NAT should no longer be a issue.
----

==== Hosting Providers ====

Considering the suggested server specs, you may be interested in the following hosting providers. For providers promising dedicated "Pavlov hosting" as opposed to general VPS services please contact and ask how you change maps being hosted and how you get RCON access before you put your money down.

<pre>
Provider | Base CPU | Details
Arctic VR | 4.5 GHz | https://www.arctic-vr.com/server-hosting
Amazon Web Services | 4.0 GHz | https://aws.amazon.com/ec2/instance-types/z1d/
VULTR | 4.0 GHz | https://www.vultr.com/products/high-frequency-compute/
packet.com | 3.5 GHz | https://www.packet.com/cloud/servers/c1-small/
Google Cloud Platform | 3.2 GHz | https://cloud.google.com/compute/docs/cpu-platforms
</pre>

===== ARCTIC VR =====

Arctic VR is the largest and longest running Pavlov VR hosting provider. The In-Game Admin Menu is exclusive to the ArcticVR hosting service. They offer EU, NA East and NA West servers for both shack and PCVR. ArcticVR offers the fastest Pavlov servers as well as DDos Protection, RCON remote management, custom maps, low pings, unlimited slots, and expert support.

Website: https://www.arctic-vr.com/server-hosting

[[File:Arctic_options.png|link=https://www.arctic-vr.com/server-hosting|700px]]

===== VULTR =====

Consider using a referral from the community:

Carlos: https://www.vultr.com/?ref=8615589-6G

Carrot: https://www.vultr.com/?ref=8689348

Archaeo: https://www.vultr.com/?ref=8653652-6G

Cheeto: https://www.vultr.com/?ref=8717358

For a Pavlov Shack server, I recommend minimum Cloud Compute, Intel High Performance, Ubuntu 20.04, and disabled automatic backups. At the time, this was $6/m. Some of the cheap options have 1TB bandwidth, and some have 2TB+. If it's a personal server, 1TB could be fine, but 2TB should be safe.

===== Google Cloud Platform (90 day free credit available) =====

The below configuration is successfully running 4 pavlov PC instances with ~15 total maps and up to 24 players per server. If you want more maps use larger boot disk. Both can dynamically be scaled based on popularity.

<pre>

Menu -> compute engine -> VM instances
create instance
- region: wherever you like
- machine type: n1-highcpu-4 (4 vCPUs, 3.6 GB memory)
- boot disk: Ubuntu 20.04
- boot disk -> size: 25gb
- network tags: pavlov-server
- [create]

Menu -> Vpc network -> firewall rules
[Create firewall rule]
Name: pavlov server
Target Tags: pavlov-server
Source IP Ranges: 0.0.0.0/0
Protocols and Ports -> Specified protocols and ports -> UDP: 7777, 8177 (Shack and PC)
Protocols and Ports -> Specified protocols and ports -> TCP: 7777, 8177 (Shack-only)
Protocols and Ports -> Specified protocols and ports -> TCP: {RCON port - default 9100}
[save]
</pre>

===== Amazon Web Services (30 day free credit available) =====

<pre>
Login -> Change Region: Choose your region
Services -> Compute -> EC2 -> Create
Choose an AMI: Ubuntu 18.04
Instance Type: z1d.large

Instance Details -> Tenancy: Dedicated (optional: this will more than triple the cost)

Storage: 50gb disk (or whatever, you're in control of the map roster)

Security Groups:
Create a new Security Group
Security group name: pavlov-server
Description: pavlov server
Rules:
Type: Custom ICMP Rule - IPV4 / Protocol: Echo Request
Type: Custom UDP Rule / Port Range: 7777 / Source: 0.0.0.0/0
Type: Custom UDP Rule / Port Range: 8177 / Source: 0.0.0.0/0
Type: SSH (optional, but I assume you wanna SSH in..)

Launch -> Create new Keypair -> Download -> Launch

Once it's started, SSH in like:
$ ssh -i your-key.pem ubuntu@you-server-details.amazonaws.com

(I use cmder on Windows, if you're using putty or mobaxterm or something, might be different)
</pre>

=== Starting Server Install ===

====Obtaining an ApiKey====
For your server to show up in the server list, there is now a requirement to have an ApiKey issued by vankrupt. This is to prevent DOS attacks against the master server

Get the key by going here: https://pavlov-ms.vankrupt.com/servers/v1/key and using your mobile number to get a SMS
(note that there have been reported failures of this SMS system for non-US mobiles. In this case DM davevillz your mobile and ask for a key)

Put this key in your Game.ini as follows:
ApiKey="ABC123FALSEKEYDONTUSEME"
or if you would like (personally untested..I would use game.ini) you can call it at server runtime with flag as follows:
-KEY="ABC123FALSEKEYDONTUSEME"

This key can be re-used for a reasonable number of servers (a limit of 10 has been mentioned). Contact the Devs if you need more servers per key.

====System setup and software installation====

Install dependencies and create the `steam` user. (You only need to do this once):

Confirm Linux version
<pre>
lsb_release -a
</pre>

'''Ubuntu 20.04'''
<pre>
sudo apt update && sudo apt install -y gdb curl lib32gcc1 libc++-dev unzip
sudo useradd -m steam
</pre>

'''Ubuntu 20.10 or higher'''
<pre>
sudo apt update && sudo apt install -y gdb curl lib32gcc-s1 libc++-dev unzip
sudo useradd -m steam
</pre>

'''Rocky Linux, CentOS 8, and RHEL 8'''

<pre>
sudo sed -i 's/^SELINUX=enforcing$/SELINUX=permissive/g' /etc/selinux/config
sudo setenforce 0
sudo yum install gdb curl glibc.i686 libstdc++.i686 libstdc++-devel.i686 libstdc++-devel.x86_64 unzip wget -y
wget https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/l/libcxx-3.8.0-3.el7.x86_64.rpm
sudo rpm -i libcxx-3.8.0-3.el7.x86_64.rpm
sudo useradd -m steam
</pre>

[Optional] Set a password for steam.
<pre>sudo passwd steam</pre>

Login as the steam user. ('''You will need to do this each time you connect to your server'''):

<pre>
sudo su -l steam
</pre>

Install Steam:

<pre>
mkdir ~/Steam && cd ~/Steam && curl -sqL "https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz" | tar zxvf -
</pre>

There are different dedicated server versions for Pavlov Server - choose which server version you want to host (PC non-beta, PC Beta, Shack Live, or Shack RC)
(You will need to run this command each time there is a Pavlov Server update). 
To host '''PC Server (non-beta)''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 +exit
</pre>

To host '''PC BETA''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta beta_server +exit
</pre>

To host '''Shack Live''' (Quest):

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack +exit
</pre>

To host '''Shack RC''' (Quest): 

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack_beta +exit
</pre>

Now that we've installed the server, all pavlov server versions should continue. 
Install a fresh copy of steamclient.so (May have to do this after each update):
<pre>
~/Steam/steamcmd.sh +login anonymous +app_update 1007 +quit
mkdir -p ~/.steam/sdk64
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/pavlovserver/Pavlov/Binaries/Linux/steamclient.so
</pre>

Make the PavlovServer script executable. (You only need to do this once):

<pre>
chmod +x ~/pavlovserver/PavlovServer.sh
</pre>

----

=== Server Configuration ===

Before starting the server we need to configure it. Start by creating some directories:

<pre>
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Logs
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps
</pre>

==== Mods/Blacklist/Whitelist (optional) ====

The following three files allow you to specify mods, banned players, and whitelist players. These are optional, but go ahead and create them. Populating the files is described later.

<pre>
touch /home/steam/pavlovserver/Pavlov/Saved/Config/mods.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/blacklist.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/whitelist.txt
</pre>

====Configuring Game.ini====
Create a new Game.ini file using following command to open an editor and copy/paste the following block into it then save it. Note not all of these options are required. For instance remove or comment out the Password=0000 line to make a public server with no pin.
<pre>
nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini
</pre>

<pre>
[/Script/Pavlov.DedicatedServer]
bEnabled=true
ServerName="My_private_idaho"
MaxPlayers=10 #Set this to 10 for Shack. 24 is the max for PC, setting it higher will not allow players to join.
ApiKey="ABC123FALSEKEYDONTUSEME"
bSecured=true
bCustomServer=true
bVerboseLogging=false
bCompetitive=false #This only works for SND
bWhitelist=false
RefreshListTime=120
LimitedAmmoType=0
TickRate=90
TimeLimit=60
#Password=0000
#BalanceTableURL="vankruptgames/BalancingTable/main"
MapRotation=(MapId="UGC1758245796", GameMode="GUN")
MapRotation=(MapId="datacenter", GameMode="SND")
MapRotation=(MapId="sand", GameMode="DM")

</pre>

* '''bEnabled''' - whether the server appears in the server list (unconfirmed)
* '''ServerName''' - name it will be listed as. (approx 35 chars max)
* '''MaxPlayers''' - See suggested specs for limits. 10 standard (10 for shack), 20-24 is max recommended for large maps like Stalingrad or PUSH/RUSH modes, and servers allow a maximum of 24 players.
* '''ApiKey''' - Unique ApiKey required to register server with master server. Replace with your key
* '''bSecured''' - enabled Valve Anti-Cheat (VAC)
* '''bCustomServer''' - activates some new modding tools (save and http functions. Required to write to blacklist.txt for bans)
* '''bCompetitive''' - sets the server to competitive mode for SND. If removed the server will default to false
* '''bVerboseLogging''' - enables verbose logging, mostly detailed statistics. Be prepared for significant increase in logging.
* '''bWhitelist''' - Only allow users in whitelist.txt to join
* '''RefreshListTime''' - sets how often the running server checks for updates in ban/whitelist/mod files
* '''LimitedAmmoType''' - sets limited ammo mode
0 = Unlimited
1 = Limited Generic
2 = Limited Specific
3 = Custom (for modders)
4 = Limited Special
5 = Boxless Mode

* '''TimeLimit''' - sets time limit for each map
* '''TickRate''' - sets the server tickrate. (so far minimum stable seems around 50 and max around 120. Beware setting this changes weapon despawn time and breaks some game modes. Recommend not touching)
* '''Password''' - PIN number for server #FYI - this is now also changeable via rcon.
* '''BalanceTableURL''' - Points to a custom balance table from github. See https://github.com/vankruptgames/BalancingTable for instructions. This line isn't needed if you don't have one.
* '''MapRotation''' - you can add multiple of these. The MapId must be “UGC” followed by the map ID. you can find the map id in the URL of the steam workshop page. When a match ends, the server will load the next map in the rotation. You can also use RCON to switch to a map not included in rotation.

Available game modes as of 09/06/2022: SND, TDM, DM, GUN, ZWV, WW2GUN, TANKTDM, KOTH, TTT, OITC, INFECTION, HIDE, PUSH, PH 

And for Shack only: CTF

For maps running a Custom gamemode (CodZ, BR, Duel, etc.) it doesn't matter which gamemode you choose, as the map will automatically override it with the custom mode.

UGC###### are for custom maps from Steam workshop (PC Only). Find the map you want in the workshop. This is the URL for Mirage (https://steamcommunity.com/sharedfiles/filedetails/?id=2670152485). The 10 numbers at the end of the URL are what you need, so UGC1661803933 would be the MapId for Mirage.

==== Firewall/Port forwarding ====
Using the default settings there are two UDP ports (7777, 8177) that need to be allowed to access the server either by firewall setup or port forwarding.

'''Ubuntu''' firewall commands to check firewall and open ports:
<pre>
sudo ufw status
sudo ufw allow 7777
sudo ufw allow 8177
sudo ufw allow 9100
sudo ufw status
</pre>

'''Rocky Linux''' firewall commands to check firewall and open ports:
<pre>
sudo firewall-cmd --zone=public --add-port=7777/tcp
sudo firewall-cmd --zone=public --add-port=7777/udp
sudo firewall-cmd --zone=public --add-port=8177/tcp
sudo firewall-cmd --zone=public --add-port=8177/udp
sudo firewall-cmd --zone=public --add-port=9100/udp
sudo firewall-cmd --zone=public --add-port=9100/tcp
sudo firewall-cmd --list-ports
firewall-cmd --runtime-to-permanent
</pre>

You may also need to allow Pings (ICMP) for the server's true latency to appear in the master list.

If you are running multiple servers and have set additional ports (see http://wiki.pavlov-vr.com/index.php?title=Dedicated_server#Running_multiple_servers_on_one_host) then you need to allow access to the defined port plus the port 400 higher. So if you use 7000 as your port, then UDP 7000 and 7400 need to be open

If you have setup rcon via RconSettings.txt (below) then that port also need to be allowed access via TCP

If you are running Shack/Quest and want to have maps that are downloadable from your server, your server ports (ex. 7777 & 8177) must also be open via TCP

----

==== Shack Maps (Quest) ====

If you try to use the steps above to add maps for Shack, youll run into issues very quickly. This is because Shack has no affiliation to Steam, and therefore cannot use Steam Workshop maps like above. In the future, these steps will apply to PC servers as well, allowing a server to hold the map itself, instead of offloading to Steam.

To get started, first create the directory to hold the maps

<pre>mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps</pre>

You can use any number of methods to move the map files onto the server, but ill go over the two simplest, starting with a GUI approach

Download and install CyberDuck onto your "home" PC (Whatever PC you use for access to the server, but not the server itsself): https://cyberduck.io/

Next, download and unzip your map of choice from https://www.pavlovquest.com/ , https://pavlovhorde.com/mapsList, or look in #shack-map-showcase channel in the discord server. I'm going to use Cheeto's WW2 Items test (http://www.mediafire.com/file/emyt9bs1z9u9ykw/SVR_Cheeto_Items.zip/file ) for this example, you do what you like

In the top left corner, open a connection, set the connection type to SFTP, and fill in the rest of the information. User will be root, password is whatever you set the root pw as (toor in Ubuntu by default)

In the directory dropdown (itll say /root) go back to /

Follow the directories until we arrive back at our "maps" folder <pre>/home/steam/pavlovserver/Pavlov/Saved/maps</pre>

Drag and drop the unzipped map folder into the main window, in this case itll be SVR_Cheeto_Items

Hit Allow

Youll now see a folder named SVR_Cheeto_Items, and within it should be nothing but 3 files. If there is another folder in it, move this folder to the maps directory, otherwise the server wont work. The 3 files (2 .PAK one .JSON) should be in home/steam/pavlovserver/Pavlov/Saved/maps/SVR_Cheeto_Items, no more, no less.

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

To play the map, you can either use RCON switch map command, or to add the map to your servers automatic map rotation list, add the map's folder name to your Game.ini. This replaces the MapID section, so for our example it would be

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

And thats all! Disconnect CyberDuck from your server before playing, otherwise youll have difficulty joining.

-----------

==== Adding Shack Maps over Command Line Interface ====

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

A bit more complicated, but adding maps over CLI has its benefits

First, CD to the maps directory you made above

<pre>cd ~/pavlovserver/Pavlov/Saved/maps</pre>

Download the map files from whatever you use to upload them. To do this, you can either use curl or wget

<pre>curl -O insertURLhere</pre>

'''If you download your map from Google Drive''', make sure that your .zip folder is shared to anyone.
Then, get the file's url from the shared link. Example : ''<nowiki>https://drive.google.com/file/d/19bI8gUHaN5tUrDvnadAacUnchQf6_k/view</nowiki>'' will be ''19bI8gUHaN5tUrDvnadAacUnchQf6_k''
Edit "fileId" and "fileName" before you execute the command.
<pre>
fileId=19bI8gUHaN5tUrDvnadAacUnchQf6_k
fileName=SVR_USER_MAPNAME
curl -sc /tmp/cookie "https://drive.google.com/uc?export=download&id=${fileId}" > /dev/null
code="$(awk '/_warning_/ {print $NF}' /tmp/cookie)"
curl -Lb /tmp/cookie "https://drive.google.com/uc?export=download&confirm=${code}&id=${fileId}" -o ${fileName} </pre>

To keep with the Items example:

<pre>curl -O https://cdn.discordapp.com/attachments/744185280759857234/745027406695366788/SVR_Cheeto_Items.zip</pre>

Next, unzip the file. If this next step errors out, saying the command is unknown, switch back to the root user (su root), and install unzip (sudo apt install unzip), then return to the steam user, and continue.

<pre>unzip SVR_Cheeto_Items.zip</pre>

Now finish like before by adding the map to your Game.ini

<pre>nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini</pre>

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

==== Admin/Moderator list (optional) ====

The only working in-game admin menu is through Arctic VR server hosting (see below).

If you add moderators to your server, they will not be subject to vote kicks.

<pre>
nano ~/pavlovserver/Pavlov/Saved/Config/mods.txt
</pre>

Example Mod List:
<pre>
76541198397498572 #Optional Comment: Player name
76541198397498573 #Some Other Player
</pre>

==== ArcticVR Admin Menu ====

[[File:Arcticmenu.jpg|500px|link=https://www.arctic-vr.com/server-admin-menu]]

Arctic-VR Offers an advanced In-Game Admin menu that is exclusive to their hosting service. Features include:
* Switch Maps+Modes
* Teleport Players to Players
* Change Player Skins
* Control Player Buying+Cash
* Spawn Items
* Clean up corpses + guns
* Spawn Bots
* Spawn Items for other players
* Control Teams + Balance/Shuffle Teams
* ResetSND
* And More

You can read more about the ArcticVR admin menu on their website: https://www.arctic-vr.com/server-admin-menu

==== Handy tools for finding steamIDs ====

Steam ID finder: https://steamidfinder.com/lookup/ or https://steamid.xyz/

You want to enter in the steamID64 format.

This tool can convert or lookup IDs: https://steamid.io/

If you are looking for a steamID of a player that has been on your server recently this is technique to find them:
<pre>
grep -i playername ~/pavlovserver/Pavlov/Saved/Logs/* | grep TicketValidation
</pre>

=== Configure Rcon ===
To enable Rcon access create config file:
<pre> nano /home/steam/pavlovserver/Pavlov/Saved/Config/RconSettings.txt </pre>

Copy in the following text - change password, and if desired the port:
<pre>
Password=ChangeThisPassword
Port=9100
</pre>
You must specify a port for the Rcon server to use as well as a Password (use a different port per sever instance if running multiple server instances off the same hardware)

=== Starting the server ===

<pre>
cd ~/pavlovserver && ./PavlovServer.sh
</pre>

That's it, your server will be automatically broadcast to the master server! :)

Two handy tools to determine quickly if your server is broadcasting are [https://pablub.xyz/ Pablub] (PC only) and [https://pavlovhorde.com/ Horde] (Shack) and [https://pavlovhorde.com/pcServers Horde] (PC version)

Note that when you close your terminal, the server will go down. See the "supervisors" section below for how to prevent this.

=== Auto-updating the server ===

Assuming you have followed this guide and used the default paths, users, and install instructions, you can paste the following into your terminal to auto-update your Pavlov server:

<pre>
cat << 'EOF' > $HOME/pavlov_daily_update_and_restart.sh
#!/bin/bash

USER="steam"
SERVICENAME="pavlovserver.service"
INSTALLDIRNAME="pavlovserver"
USERHOME="/home/$USER"

echo -e "Beginning Pavlov VR update run on $(date)\n\n"

systemctl stop "$SERVICENAME"

sleep 5
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +force_install_dir "$USERHOME/$INSTALLDIRNAME" +app_update 622970 +exit
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +app_update 1007 +quit
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/.steam/sdk64/steamclient.so"
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/pavlovserver/Pavlov/Binaries/Linux/steamclient.so"

systemctl start "$SERVICENAME"

echo -e "Ending Pavlov VR update run on $(date)\n\n"

EOF

chmod +x $HOME/pavlov_daily_update_and_restart.sh
mkdir $HOME/pavlov_update_logs && touch $HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log
CRONLINE="00 2 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
(sudo crontab -u root -l; echo "$CRONLINE" ) | sudo crontab -u root -
unset CRONLINE

</pre>

These commands will:

1. Create a shell script in the "steam" user's home directory that automatically stops the Pavlov server, pulls any updates via steam, pull updates to the Steamworks SDK Redist, and copies the latest version of steamclient.so to the Pavlov server directory

2. Make the shell script executable

3. Create a new directory called "pavlov_update_logs" in the "steam" user's directory, and create a logfile inside that directory called "pavlov_daily_update_and_restart.sh.log". You can check this logfile to see the output of the Pavlov and Steam SDK update commands.

4. Create a crontab entry for the root user that runs this shell script automatically every day at 2:00AM local time

If you want to change the time that this script runs, edit the numbers "00 2" in the line that starts with "CRONLINE=". In the example provided, 00 is the minutes column, and 2 is the hour column. For example, if you wanted the server to automatically update and restart at 4:17AM every day, change the line starting with "CRONLINE=" to:

<pre>
CRONLINE="17 4 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
</pre>

If the time is PM, use 24-hour time format, e.g. "32 18" for 6:32PM.

----

=== Supervising the server using systemd ===

Running '''./PavlovServer.sh''' in your interactive shell is easy, but the server will shut down when you close your terminal. If you want to run the server in the background,
you'll want to run it under a supervisor. There are many options, ranging from the simple (nohup, screen or tmux), to the
more robust (supervisord, systemd).

Systemd is running by default on Ubuntu Linux, so we'll use that here.

To run the server as a systemd service, create the file '''/etc/systemd/system/pavlovserver.service''' (as root) by typing
<pre>
sudo nano /etc/systemd/system/pavlovserver.service
</pre>

Copy contents below into the file and save.

<pre>
[Unit]
Description=Pavlov VR dedicated server

[Service]
Type=simple
WorkingDirectory=/home/steam/pavlovserver
ExecStart=/home/steam/pavlovserver/PavlovServer.sh

RestartSec=1
Restart=always
User=steam
Group=steam

[Install]
WantedBy = multi-user.target
</pre>

If you'd like your server to start as competitive without editing the game.ini, change the line "ExecStart=/home/steam/pavlovserver/PavlovServer.sh" to look like this below. Though it's much easier to just use the game.ini to enable competitive instead. <pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -COMPETITIVE=1</pre>

Change the user or paths as appropriate. After saving the service file, to start, restart, stop, or monitor the server:

<pre>
sudo systemctl start pavlovserver
sudo systemctl restart pavlovserver
sudo systemctl stop pavlovserver
sudo systemctl status pavlovserver
</pre>

To view the logs:

<pre>
sudo journalctl -u pavlovserver
# to live-tail the logs
sudo journalctl -u pavlovserver -f
</pre>

If you want to run the pavlov server as soon as your server boots (e.g. a VPS you turn on and off), add pavlov as a startup service:

<pre>
sudo systemctl enable pavlovserver
</pre>

----

== Advanced Server Administration ==

=== Running multiple servers on one host ===

* Pavlovserver is functionally single threaded (there are multiple threads, but vast majority of work occurs in the primary one). Make sure you have # of pavlovservers + 1 CPU available. More CPUs= more servers. Faster CPU = more players.
* Make multiple server installs by defining a separate install dir for each server.
* Run each server with a unique port. eg: '''./PavlovServer.sh -PORT="Desired Port"'''
* The Server will use the Desired Port and the Port 400 above (Example: You choose 8200 as Port. So Port 8600 will be used as well)
* If you are using RCON, each server will need a unique port defined in RconSettings.txt
* Ensure the ports are forwarded and opened in your firewall

To duplicate directories:

be in the steam home folder
<pre>
cp -r pavlovserver pavlovserver1
/home/steam/pavlovserver1/PavlovServer.sh -PORT=[Desired Port]
</pre>

=== Starting server in competitive mode ===
Competitive mode will prevent dead teammates from being able to see the match, to prevent ghosting.
You can either enable this via Game.ini (described in Game.ini file), or using the -COMPETITIVE=1 parameter.

<pre>
/home/steam/pavlovserver1/PavlovServer.sh -COMPETITIVE=1
</pre>

== Automated RCON examples ==
here are some examples of scripts that interact with Pavlov RCON

'''<big>Inspect players every 5 minutes</big>''' [https://github.com/JTWP-org/inspect-every-5-mins/blob/main/log/inspectPlayer-04-23-2023-21-50.demo.json (installation instructions on GITHUB )]

This [https://www.gnu.org/software/bash/ BASH] script will collect current players stats for every one. then it will write them to a log in JSON format that can easily be handled for your records or the next project ..

below is all the info that will be collected every 5

{| class="wikitable"
|+
|PlayerName
|Salted Cracker Jack
|-
|UniqueId
|76561198210003277
|-
|Score
|NUM
|-
|KDA
|KILLS / DEATHS / ASSIST
|-
|Dead
|TRUE / FALSE
|-
|CASH
|PLAYYERS MONEY
|-
|TEAM ID
|0 / 1
|}

----

=== Useful Linux Commands ===

List files / folders in directory, print current working directory,
<pre>ls -la #list files/directories along with authorities and ownership
pwd #print working directory
sudo chown <owner> <file/directory> #change owner of file/directory. If root created something and you need to change it to steam
sudo chgrp <group> <file/directory> #change group of file/directory.
</pre>

Check if pavlov is running by checking process status. If the only row you see is the grep command, pavlov server is not started.
<pre> ps -ef | grep pav </pre>

Sample output:
<pre>
steam 34044 1 0 16:52 ? 00:00:00 /bin/sh /home/steam/pavlovserver/PavlovServer.sh
steam 34066 34044 80 16:52 ? 00:00:04 /home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer
zombies+ 34101 34013 0 16:52 pts/0 00:00:00 grep --color=auto pav
</pre>

Kill a process. Note this command uses 34044, which is a process id from the command output above.
<pre> kill -9 34044 </pre>

Dump the log to the console so you can scroll through it:
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log </pre>

Search the log for a string - replace my_string with case-sensitive string
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep my_string </pre>

=== Default Map ID's ===
datacenter

sand

bridge

containeryard

siberia (Prison Break)

hospital (Zombies map)

killhouse

range

tutorial

santorini

station

industry

ogcontainers (Shack only)

haguenau (Shack only)

foundation (Shack only)

stalingrad (PC only)

stalingrad_night (PC only)

santorini_night (PC only)

sand_night (PC only)

station_night (PC only)

industry_night (PC only)

bunker (PC only)

=== Automated server log backup ===

here is how to setup a bash script to 1x a day compress all log files and save them to protect from auto deletion it will also post a discord webhook to confirm its working and saved the days logs

https://github.com/JTWP-org/backUpLogs

== Troubleshooting ==

To run the server without outputting the heartbeat:

<pre>./PavlovServer.sh | sed '/heartbeat/d'</pre>

To monitor the logs (without heartbeat) from another terminal:

<pre>tail -f -n10000 /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep -v 'Sending heartbeat to masterserver'</pre>

Check your CPU Clock Speed with:

<pre>lscpu | grep MHz</pre>

=== Server won't start ===

Error message:
<pre>
ln: failed to create hard link '/home/steam/.steam/sdk64/steamclient.so': File exists
ln: failed to create hard link '/home/steam/pavlovserver/Pavlov/Binaries/Linux/steamclient.so': File exists
/home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer: error while loading shared libraries: libc++.so.1: cannot open shared object file: No such file or directory
</pre>

First two errors are harmless. The third one is because libc++ step was skipped or failed. Using sudo capable id (probably not steam id), [re]run this line:
<pre>sudo apt update && sudo apt install -y gdb curl lib32gcc1 libc++-dev unzip </pre>

=== Map wont load (kicks to datacenter) ===

try deleting all the downloaded workshop maps with:

<pre>sudo rm -rf /tmp/workshop/7777/content/555160/*</pre> for all maps or

<pre>sudo rm -rf /tmp/workshop/7777/content/555160/whatever-UGC</pre> for specific map

=== Map wont load when running in a container ===
The three typical container problems I have seen:

1) Steam can't write to /tmp for some reason

2) /tmp is actually tmpfs instead of real filesystem and a few gigs of maps runs you out of RAM

3) Made worse by fact that pavlovserver unpacks downloads to ram, then writes to /tmp/workshop. Not enough RAM to do this, no map for you.

=== Server stuck rotating forever ===

Run these 2 commands, then restart your server:

<pre>cd ~/Steam && ./steamcmd.sh +login anonymous +app_update 1007 +quit
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so</pre>

If this doesn't fix it, double check that your server isn't running on the same port as another, by running this command:

<pre>ps -ef | grep pav</pre>

Then if 2 servers are on the same port, you can fix it by editing the pavlovserver.service file, and making sure the following line:

<pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -PORT=Number</pre>

has a unique number after the port for each server you're running.

=== Server - ping 999 ===
Google Cloud Platform - Make sure your compute engine has a network tag and your network rules are applied to the tag.
Make sure you opened the specified ports.

Network testing tools:
Test if your server will respond to ping from outside your network:
https://www.wormly.com/test-remote-ping

Test if your ports are accessible via UDP (7777,8177,9100):
https://www.ipvoid.com/udp-port-scan/

=== Can't connect to RCON ===
Check the file and group owner of RconSettings file. It should be steam, or the ID used to run the pavlov server.
<pre>
cd /home/steam/pavlovserver/Pavlov/Saved/Config
ls -la
</pre>

If the owner/group are not steam, using root or an id with sudo authority, change them to steam, confirm they are now set properly, then restart the pavlov server. (Note - if Rcon has wrong permissions, after fixing you should also to check the other config files like Game.ini, mods/blacklist/whitelist for the same issue. If steam can't access these files, it could cause problems.).
<pre>
cd /home/steam/pavlovserver/Pavlov/Saved/Config
sudo chown steam RconSettings.txt
sudo chgrp steam RconSettings.txt
ls -la </pre>

=== PC ONLY - Map Download stops ===

When downloading a large map from the steam workshop make sure your VPS/Dedi or Shared hosting provider (Otherwise known as a GSP's) has enough RAM assigned to store the map files in its tempfs (stored in ram)!

This is less likely to happen on Dedicated servers and VPS with a decent amount of ram unless you are using docker with RAM limits!

Most GSP's will be using docker or some other type of jailing method to limit system resource allocations and direct access to the host machine, if they are and you know what map you want to use make sure you order a service with enough ram to store your map. If in doubt contact your GSP's support team.

=== Getting Help ===

There's a #pc-custom-servers channel on the official Pavlov Discord - https://discord.gg/Pavlov-VR. Lots of helpful people there!

Setting up a dedicated server

2023-05-26T02:41:50Z

SaltedCrackerJack: /* Automated RCON */

== Setting up a dedicated server ==

'''There are no Windows binaries'''

This guide is written exclusively for Linux and covers Ubuntu/Debian/Debian-like and Red Hat RPM-based distros. Possible to run with other distros, but some of the commands won't work and you will need to know enough to figure out the software install of dependencies on your own.

If you are considering hosting from home, please read that section of the wiki first.

This guide assumes you know the basics of using a bash terminal: ssh'ing into a server, running bash commands, editing text files, etc.

If you have no experience using bash, maybe start [https://www.howtogeek.com/140679/beginner-geek-how-to-start-using-the-linux-terminal/ here]. Editing text files via commandline is often a challenge. Suggest using nano and reading guide [https://www.howtogeek.com/howto/42980/the-beginners-guide-to-nano-the-linux-command-line-text-editor/ here]

If you are new to linux and accessing your server from Windows, highly suggest using MobaXterm as your SSH client as that can make required editing of text files easier using built in editor instead of the native linux command line editors.

And finally, ask yourself why you want to setup a server? If you look at the list, there are many, many more servers than players. If you don't have a team, discord community, or group of friends ready to play on your server, chances are it will go unused. Got one of these... great, let's go.

If you don't want to go through the hassle yourself and want to pay for a hosting service Arctic VR (PC and Shack) and Horde (Shack) provide a server hosting services and are trusted in the community. See links below.

----

=== Server Requirements ===

'''Pavlovserver can only be hosted under Linux.'''

This can be running as a VM under windows, but this will increase the complexity of the setup beyond this guide.

Ubuntu 18.04 x86_64, Ubuntu 19/04 amd64, Ubuntu 20.04, and Rocky Linux 8 are confirmed working. Ubuntu 15.04 x86 is known to fail to install using this guide. Recommend not running on "minimal" images as some tools are missing.

* 2GB RAM + 1GB RAM per each additional server with 10 players. More RAM is recommended for larger maps, higher player counts, or complex gamemodes. Not having enough RAM is a common cause of server crashes.

* A ~2.5Ghz CPU will comfortably support a 10 player server.

* A ~4Ghz CPU will comfortably support 24 players. This is a limit built into Pavlov itself, no server will allow players to join over 24. Lower player counts are recommended for complex gamemodes (E.g. CodZ) and/or highly detailed maps, so that maximum number will often be lower.

(Note that these are '''not''' hard limits for player counts, just suggestions for the best performance, based on experiences with many server providers on different grades of hardware.)

* Pavlovserver is functionally single threaded (one thread does vast majority of work). More CPUs only help if you are running more servers. More clockspeed = higher performance = more users per server.
The maximum number of servers you can run is dependent on how many CPUs you have. For example, if you have an 8 core CPU, the maximum number of servers would be 7. You should always have at least one CPU free as overhead, as Pavlov servers can use slightly more than one thread.

----

==== Hosting at home ====
When hosting at home there are additional requirements regarding networking: Your router has to support port-forwarding, hair-pinning/LoopbackNAT, and respond to ping requests. These techniques are necessary to allow your server to be found and to talk back to the client. please see https://en.wikipedia.org/wiki/Port_forwarding, https://en.wikipedia.org/wiki/Hairpinning, and https://www.speedguide.net/faq/how-to-become-pingable-behind-a-routerfirewall-376 for more info and google for these terms in addition to your router model to find guides on how to enable/configure it properly. If you have modern Router, it may have these features already enabled, in this case you just have to configure port-forwarding. If you can see your server but not join it while others can, this is indicative of a failure of LoopbackNAT.

A second challenge to hosting at home is CGNAT (Carrier grade NAT: https://www.a10networks.com/blog/carrier-grade-nat/). Just like NAT on your home network that has to be gotten around w/ port-forwarding, CGNAT breaks the ability of external connections to be made back to your server, but the controls are solely in your ISPs hands. Sometimes if you ask, you can be removed from CGNAT pools and/or assigned a static IP. CGNAT rollouts are becoming very common now, so if your server worked then doesn't allow connections now, your ISP may have made this change.

You can check whether you’re on a CGNAT network by visiting a Web site such as ipaddress.com or whatsmyip.com and comparing the IP address listed to the public/WAN IP address assigned to your Internet gateway. To find your gateway’s public IP address, check the status page in the administrative interface. If the two IP addresses differ, you’re likely on a CGNAT network. If so, this problem must be resolved before you go any further.

'''Not understanding these requirements and configuration is a frequent cause of failed setups and questions in discord. Don't skip this if you are trying to host from home'''

'''There are serious security implications of hosting this software at home.''' None of the devs are security experts and there has been no security review of the code. You are opening up your system to the world and publicity advertising this fact. Expect that any system hosting this software is open to compromise from the Internet and act accordingly. If your router offers a DMZ network, use it. Consider hosting on a cloud based server and think twice before running this software on any system that contains data you care about or has access to networks and computers you care about.

If you're hosting at home using Oracle's VirtualBox, there are steps you can take to prevent double NAT (which can cause issues later on)

1. Select your VM and then click Settings in VirtualBox's main window.

2. Click on Network and change Attached To from NAT to Bridged Adapter.

Once you've done this, your VM should be connected directly to your home router and double NAT should no longer be a issue.
----

==== Hosting Providers ====

Considering the suggested server specs, you may be interested in the following hosting providers. For providers promising dedicated "Pavlov hosting" as opposed to general VPS services please contact and ask how you change maps being hosted and how you get RCON access before you put your money down.

<pre>
Provider | Base CPU | Details
Arctic VR | 4.5 GHz | https://www.arctic-vr.com/server-hosting
Amazon Web Services | 4.0 GHz | https://aws.amazon.com/ec2/instance-types/z1d/
VULTR | 4.0 GHz | https://www.vultr.com/products/high-frequency-compute/
packet.com | 3.5 GHz | https://www.packet.com/cloud/servers/c1-small/
Google Cloud Platform | 3.2 GHz | https://cloud.google.com/compute/docs/cpu-platforms
</pre>

===== ARCTIC VR =====

Arctic VR is the largest and longest running Pavlov VR hosting provider. The In-Game Admin Menu is exclusive to the ArcticVR hosting service. They offer EU, NA East and NA West servers for both shack and PCVR. ArcticVR offers the fastest Pavlov servers as well as DDos Protection, RCON remote management, custom maps, low pings, unlimited slots, and expert support.

Website: https://www.arctic-vr.com/server-hosting

[[File:Arctic_options.png|link=https://www.arctic-vr.com/server-hosting|700px]]

===== VULTR =====

Consider using a referral from the community:

Carlos: https://www.vultr.com/?ref=8615589-6G

Carrot: https://www.vultr.com/?ref=8689348

Archaeo: https://www.vultr.com/?ref=8653652-6G

Cheeto: https://www.vultr.com/?ref=8717358

For a Pavlov Shack server, I recommend minimum Cloud Compute, Intel High Performance, Ubuntu 20.04, and disabled automatic backups. At the time, this was $6/m. Some of the cheap options have 1TB bandwidth, and some have 2TB+. If it's a personal server, 1TB could be fine, but 2TB should be safe.

===== Google Cloud Platform (90 day free credit available) =====

The below configuration is successfully running 4 pavlov PC instances with ~15 total maps and up to 24 players per server. If you want more maps use larger boot disk. Both can dynamically be scaled based on popularity.

<pre>

Menu -> compute engine -> VM instances
create instance
- region: wherever you like
- machine type: n1-highcpu-4 (4 vCPUs, 3.6 GB memory)
- boot disk: Ubuntu 20.04
- boot disk -> size: 25gb
- network tags: pavlov-server
- [create]

Menu -> Vpc network -> firewall rules
[Create firewall rule]
Name: pavlov server
Target Tags: pavlov-server
Source IP Ranges: 0.0.0.0/0
Protocols and Ports -> Specified protocols and ports -> UDP: 7777, 8177 (Shack and PC)
Protocols and Ports -> Specified protocols and ports -> TCP: 7777, 8177 (Shack-only)
Protocols and Ports -> Specified protocols and ports -> TCP: {RCON port - default 9100}
[save]
</pre>

===== Amazon Web Services (30 day free credit available) =====

<pre>
Login -> Change Region: Choose your region
Services -> Compute -> EC2 -> Create
Choose an AMI: Ubuntu 18.04
Instance Type: z1d.large

Instance Details -> Tenancy: Dedicated (optional: this will more than triple the cost)

Storage: 50gb disk (or whatever, you're in control of the map roster)

Security Groups:
Create a new Security Group
Security group name: pavlov-server
Description: pavlov server
Rules:
Type: Custom ICMP Rule - IPV4 / Protocol: Echo Request
Type: Custom UDP Rule / Port Range: 7777 / Source: 0.0.0.0/0
Type: Custom UDP Rule / Port Range: 8177 / Source: 0.0.0.0/0
Type: SSH (optional, but I assume you wanna SSH in..)

Launch -> Create new Keypair -> Download -> Launch

Once it's started, SSH in like:
$ ssh -i your-key.pem ubuntu@you-server-details.amazonaws.com

(I use cmder on Windows, if you're using putty or mobaxterm or something, might be different)
</pre>

=== Starting Server Install ===

====Obtaining an ApiKey====
For your server to show up in the server list, there is now a requirement to have an ApiKey issued by vankrupt. This is to prevent DOS attacks against the master server

Get the key by going here: https://pavlov-ms.vankrupt.com/servers/v1/key and using your mobile number to get a SMS
(note that there have been reported failures of this SMS system for non-US mobiles. In this case DM davevillz your mobile and ask for a key)

Put this key in your Game.ini as follows:
ApiKey="ABC123FALSEKEYDONTUSEME"
or if you would like (personally untested..I would use game.ini) you can call it at server runtime with flag as follows:
-KEY="ABC123FALSEKEYDONTUSEME"

This key can be re-used for a reasonable number of servers (a limit of 10 has been mentioned). Contact the Devs if you need more servers per key.

====System setup and software installation====

Install dependencies and create the `steam` user. (You only need to do this once):

Confirm Linux version
<pre>
lsb_release -a
</pre>

'''Ubuntu 20.04'''
<pre>
sudo apt update && sudo apt install -y gdb curl lib32gcc1 libc++-dev unzip
sudo useradd -m steam
</pre>

'''Ubuntu 20.10 or higher'''
<pre>
sudo apt update && sudo apt install -y gdb curl lib32gcc-s1 libc++-dev unzip
sudo useradd -m steam
</pre>

'''Rocky Linux, CentOS 8, and RHEL 8'''

<pre>
sudo sed -i 's/^SELINUX=enforcing$/SELINUX=permissive/g' /etc/selinux/config
sudo setenforce 0
sudo yum install gdb curl glibc.i686 libstdc++.i686 libstdc++-devel.i686 libstdc++-devel.x86_64 unzip wget -y
wget https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/l/libcxx-3.8.0-3.el7.x86_64.rpm
sudo rpm -i libcxx-3.8.0-3.el7.x86_64.rpm
sudo useradd -m steam
</pre>

[Optional] Set a password for steam.
<pre>sudo passwd steam</pre>

Login as the steam user. ('''You will need to do this each time you connect to your server'''):

<pre>
sudo su -l steam
</pre>

Install Steam:

<pre>
mkdir ~/Steam && cd ~/Steam && curl -sqL "https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz" | tar zxvf -
</pre>

There are different dedicated server versions for Pavlov Server - choose which server version you want to host (PC non-beta, PC Beta, Shack Live, or Shack RC)
(You will need to run this command each time there is a Pavlov Server update). 
To host '''PC Server (non-beta)''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 +exit
</pre>

To host '''PC BETA''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta beta_server +exit
</pre>

To host '''Shack Live''' (Quest):

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack +exit
</pre>

To host '''Shack RC''' (Quest): 

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack_beta +exit
</pre>

Now that we've installed the server, all pavlov server versions should continue. 
Install a fresh copy of steamclient.so (May have to do this after each update):
<pre>
~/Steam/steamcmd.sh +login anonymous +app_update 1007 +quit
mkdir -p ~/.steam/sdk64
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/pavlovserver/Pavlov/Binaries/Linux/steamclient.so
</pre>

Make the PavlovServer script executable. (You only need to do this once):

<pre>
chmod +x ~/pavlovserver/PavlovServer.sh
</pre>

----

=== Server Configuration ===

Before starting the server we need to configure it. Start by creating some directories:

<pre>
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Logs
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps
</pre>

==== Mods/Blacklist/Whitelist (optional) ====

The following three files allow you to specify mods, banned players, and whitelist players. These are optional, but go ahead and create them. Populating the files is described later.

<pre>
touch /home/steam/pavlovserver/Pavlov/Saved/Config/mods.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/blacklist.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/whitelist.txt
</pre>

====Configuring Game.ini====
Create a new Game.ini file using following command to open an editor and copy/paste the following block into it then save it. Note not all of these options are required. For instance remove or comment out the Password=0000 line to make a public server with no pin.
<pre>
nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini
</pre>

<pre>
[/Script/Pavlov.DedicatedServer]
bEnabled=true
ServerName="My_private_idaho"
MaxPlayers=10 #Set this to 10 for Shack. 24 is the max for PC, setting it higher will not allow players to join.
ApiKey="ABC123FALSEKEYDONTUSEME"
bSecured=true
bCustomServer=true
bVerboseLogging=false
bCompetitive=false #This only works for SND
bWhitelist=false
RefreshListTime=120
LimitedAmmoType=0
TickRate=90
TimeLimit=60
#Password=0000
#BalanceTableURL="vankruptgames/BalancingTable/main"
MapRotation=(MapId="UGC1758245796", GameMode="GUN")
MapRotation=(MapId="datacenter", GameMode="SND")
MapRotation=(MapId="sand", GameMode="DM")

</pre>

* '''bEnabled''' - whether the server appears in the server list (unconfirmed)
* '''ServerName''' - name it will be listed as. (approx 35 chars max)
* '''MaxPlayers''' - See suggested specs for limits. 10 standard (10 for shack), 20-24 is max recommended for large maps like Stalingrad or PUSH/RUSH modes, and servers allow a maximum of 24 players.
* '''ApiKey''' - Unique ApiKey required to register server with master server. Replace with your key
* '''bSecured''' - enabled Valve Anti-Cheat (VAC)
* '''bCustomServer''' - activates some new modding tools (save and http functions. Required to write to blacklist.txt for bans)
* '''bCompetitive''' - sets the server to competitive mode for SND. If removed the server will default to false
* '''bVerboseLogging''' - enables verbose logging, mostly detailed statistics. Be prepared for significant increase in logging.
* '''bWhitelist''' - Only allow users in whitelist.txt to join
* '''RefreshListTime''' - sets how often the running server checks for updates in ban/whitelist/mod files
* '''LimitedAmmoType''' - sets limited ammo mode
0 = Unlimited
1 = Limited Generic
2 = Limited Specific
3 = Custom (for modders)
4 = Limited Special
5 = Boxless Mode

* '''TimeLimit''' - sets time limit for each map
* '''TickRate''' - sets the server tickrate. (so far minimum stable seems around 50 and max around 120. Beware setting this changes weapon despawn time and breaks some game modes. Recommend not touching)
* '''Password''' - PIN number for server #FYI - this is now also changeable via rcon.
* '''BalanceTableURL''' - Points to a custom balance table from github. See https://github.com/vankruptgames/BalancingTable for instructions. This line isn't needed if you don't have one.
* '''MapRotation''' - you can add multiple of these. The MapId must be “UGC” followed by the map ID. you can find the map id in the URL of the steam workshop page. When a match ends, the server will load the next map in the rotation. You can also use RCON to switch to a map not included in rotation.

Available game modes as of 09/06/2022: SND, TDM, DM, GUN, ZWV, WW2GUN, TANKTDM, KOTH, TTT, OITC, INFECTION, HIDE, PUSH, PH 

And for Shack only: CTF

For maps running a Custom gamemode (CodZ, BR, Duel, etc.) it doesn't matter which gamemode you choose, as the map will automatically override it with the custom mode.

UGC###### are for custom maps from Steam workshop (PC Only). Find the map you want in the workshop. This is the URL for Mirage (https://steamcommunity.com/sharedfiles/filedetails/?id=2670152485). The 10 numbers at the end of the URL are what you need, so UGC1661803933 would be the MapId for Mirage.

==== Firewall/Port forwarding ====
Using the default settings there are two UDP ports (7777, 8177) that need to be allowed to access the server either by firewall setup or port forwarding.

'''Ubuntu''' firewall commands to check firewall and open ports:
<pre>
sudo ufw status
sudo ufw allow 7777
sudo ufw allow 8177
sudo ufw allow 9100
sudo ufw status
</pre>

'''Rocky Linux''' firewall commands to check firewall and open ports:
<pre>
sudo firewall-cmd --zone=public --add-port=7777/tcp
sudo firewall-cmd --zone=public --add-port=7777/udp
sudo firewall-cmd --zone=public --add-port=8177/tcp
sudo firewall-cmd --zone=public --add-port=8177/udp
sudo firewall-cmd --zone=public --add-port=9100/udp
sudo firewall-cmd --zone=public --add-port=9100/tcp
sudo firewall-cmd --list-ports
firewall-cmd --runtime-to-permanent
</pre>

You may also need to allow Pings (ICMP) for the server's true latency to appear in the master list.

If you are running multiple servers and have set additional ports (see http://wiki.pavlov-vr.com/index.php?title=Dedicated_server#Running_multiple_servers_on_one_host) then you need to allow access to the defined port plus the port 400 higher. So if you use 7000 as your port, then UDP 7000 and 7400 need to be open

If you have setup rcon via RconSettings.txt (below) then that port also need to be allowed access via TCP

If you are running Shack/Quest and want to have maps that are downloadable from your server, your server ports (ex. 7777 & 8177) must also be open via TCP

----

==== Shack Maps (Quest) ====

If you try to use the steps above to add maps for Shack, youll run into issues very quickly. This is because Shack has no affiliation to Steam, and therefore cannot use Steam Workshop maps like above. In the future, these steps will apply to PC servers as well, allowing a server to hold the map itself, instead of offloading to Steam.

To get started, first create the directory to hold the maps

<pre>mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps</pre>

You can use any number of methods to move the map files onto the server, but ill go over the two simplest, starting with a GUI approach

Download and install CyberDuck onto your "home" PC (Whatever PC you use for access to the server, but not the server itsself): https://cyberduck.io/

Next, download and unzip your map of choice from https://www.pavlovquest.com/ , https://pavlovhorde.com/mapsList, or look in #shack-map-showcase channel in the discord server. I'm going to use Cheeto's WW2 Items test (http://www.mediafire.com/file/emyt9bs1z9u9ykw/SVR_Cheeto_Items.zip/file ) for this example, you do what you like

In the top left corner, open a connection, set the connection type to SFTP, and fill in the rest of the information. User will be root, password is whatever you set the root pw as (toor in Ubuntu by default)

In the directory dropdown (itll say /root) go back to /

Follow the directories until we arrive back at our "maps" folder <pre>/home/steam/pavlovserver/Pavlov/Saved/maps</pre>

Drag and drop the unzipped map folder into the main window, in this case itll be SVR_Cheeto_Items

Hit Allow

Youll now see a folder named SVR_Cheeto_Items, and within it should be nothing but 3 files. If there is another folder in it, move this folder to the maps directory, otherwise the server wont work. The 3 files (2 .PAK one .JSON) should be in home/steam/pavlovserver/Pavlov/Saved/maps/SVR_Cheeto_Items, no more, no less.

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

To play the map, you can either use RCON switch map command, or to add the map to your servers automatic map rotation list, add the map's folder name to your Game.ini. This replaces the MapID section, so for our example it would be

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

And thats all! Disconnect CyberDuck from your server before playing, otherwise youll have difficulty joining.

-----------

==== Adding Shack Maps over Command Line Interface ====

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

A bit more complicated, but adding maps over CLI has its benefits

First, CD to the maps directory you made above

<pre>cd ~/pavlovserver/Pavlov/Saved/maps</pre>

Download the map files from whatever you use to upload them. To do this, you can either use curl or wget

<pre>curl -O insertURLhere</pre>

'''If you download your map from Google Drive''', make sure that your .zip folder is shared to anyone.
Then, get the file's url from the shared link. Example : ''<nowiki>https://drive.google.com/file/d/19bI8gUHaN5tUrDvnadAacUnchQf6_k/view</nowiki>'' will be ''19bI8gUHaN5tUrDvnadAacUnchQf6_k''
Edit "fileId" and "fileName" before you execute the command.
<pre>
fileId=19bI8gUHaN5tUrDvnadAacUnchQf6_k
fileName=SVR_USER_MAPNAME
curl -sc /tmp/cookie "https://drive.google.com/uc?export=download&id=${fileId}" > /dev/null
code="$(awk '/_warning_/ {print $NF}' /tmp/cookie)"
curl -Lb /tmp/cookie "https://drive.google.com/uc?export=download&confirm=${code}&id=${fileId}" -o ${fileName} </pre>

To keep with the Items example:

<pre>curl -O https://cdn.discordapp.com/attachments/744185280759857234/745027406695366788/SVR_Cheeto_Items.zip</pre>

Next, unzip the file. If this next step errors out, saying the command is unknown, switch back to the root user (su root), and install unzip (sudo apt install unzip), then return to the steam user, and continue.

<pre>unzip SVR_Cheeto_Items.zip</pre>

Now finish like before by adding the map to your Game.ini

<pre>nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini</pre>

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

==== Admin/Moderator list (optional) ====

The only working in-game admin menu is through Arctic VR server hosting (see below).

If you add moderators to your server, they will not be subject to vote kicks.

<pre>
nano ~/pavlovserver/Pavlov/Saved/Config/mods.txt
</pre>

Example Mod List:
<pre>
76541198397498572 #Optional Comment: Player name
76541198397498573 #Some Other Player
</pre>

==== ArcticVR Admin Menu ====

[[File:Arcticmenu.jpg|500px|link=https://www.arctic-vr.com/server-admin-menu]]

Arctic-VR Offers an advanced In-Game Admin menu that is exclusive to their hosting service. Features include:
* Switch Maps+Modes
* Teleport Players to Players
* Change Player Skins
* Control Player Buying+Cash
* Spawn Items
* Clean up corpses + guns
* Spawn Bots
* Spawn Items for other players
* Control Teams + Balance/Shuffle Teams
* ResetSND
* And More

You can read more about the ArcticVR admin menu on their website: https://www.arctic-vr.com/server-admin-menu

==== Handy tools for finding steamIDs ====

Steam ID finder: https://steamidfinder.com/lookup/ or https://steamid.xyz/

You want to enter in the steamID64 format.

This tool can convert or lookup IDs: https://steamid.io/

If you are looking for a steamID of a player that has been on your server recently this is technique to find them:
<pre>
grep -i playername ~/pavlovserver/Pavlov/Saved/Logs/* | grep TicketValidation
</pre>

=== Configure Rcon ===
To enable Rcon access create config file:
<pre> nano /home/steam/pavlovserver/Pavlov/Saved/Config/RconSettings.txt </pre>

Copy in the following text - change password, and if desired the port:
<pre>
Password=ChangeThisPassword
Port=9100
</pre>
You must specify a port for the Rcon server to use as well as a Password (use a different port per sever instance if running multiple server instances off the same hardware)

=== Starting the server ===

<pre>
cd ~/pavlovserver && ./PavlovServer.sh
</pre>

That's it, your server will be automatically broadcast to the master server! :)

Two handy tools to determine quickly if your server is broadcasting are [https://pablub.xyz/ Pablub] (PC only) and [https://pavlovhorde.com/ Horde] (Shack) and [https://pavlovhorde.com/pcServers Horde] (PC version)

Note that when you close your terminal, the server will go down. See the "supervisors" section below for how to prevent this.

=== Auto-updating the server ===

Assuming you have followed this guide and used the default paths, users, and install instructions, you can paste the following into your terminal to auto-update your Pavlov server:

<pre>
cat << 'EOF' > $HOME/pavlov_daily_update_and_restart.sh
#!/bin/bash

USER="steam"
SERVICENAME="pavlovserver.service"
INSTALLDIRNAME="pavlovserver"
USERHOME="/home/$USER"

echo -e "Beginning Pavlov VR update run on $(date)\n\n"

systemctl stop "$SERVICENAME"

sleep 5
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +force_install_dir "$USERHOME/$INSTALLDIRNAME" +app_update 622970 +exit
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +app_update 1007 +quit
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/.steam/sdk64/steamclient.so"
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/pavlovserver/Pavlov/Binaries/Linux/steamclient.so"

systemctl start "$SERVICENAME"

echo -e "Ending Pavlov VR update run on $(date)\n\n"

EOF

chmod +x $HOME/pavlov_daily_update_and_restart.sh
mkdir $HOME/pavlov_update_logs && touch $HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log
CRONLINE="00 2 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
(sudo crontab -u root -l; echo "$CRONLINE" ) | sudo crontab -u root -
unset CRONLINE

</pre>

These commands will:

1. Create a shell script in the "steam" user's home directory that automatically stops the Pavlov server, pulls any updates via steam, pull updates to the Steamworks SDK Redist, and copies the latest version of steamclient.so to the Pavlov server directory

2. Make the shell script executable

3. Create a new directory called "pavlov_update_logs" in the "steam" user's directory, and create a logfile inside that directory called "pavlov_daily_update_and_restart.sh.log". You can check this logfile to see the output of the Pavlov and Steam SDK update commands.

4. Create a crontab entry for the root user that runs this shell script automatically every day at 2:00AM local time

If you want to change the time that this script runs, edit the numbers "00 2" in the line that starts with "CRONLINE=". In the example provided, 00 is the minutes column, and 2 is the hour column. For example, if you wanted the server to automatically update and restart at 4:17AM every day, change the line starting with "CRONLINE=" to:

<pre>
CRONLINE="17 4 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
</pre>

If the time is PM, use 24-hour time format, e.g. "32 18" for 6:32PM.

----

=== Supervising the server using systemd ===

Running '''./PavlovServer.sh''' in your interactive shell is easy, but the server will shut down when you close your terminal. If you want to run the server in the background,
you'll want to run it under a supervisor. There are many options, ranging from the simple (nohup, screen or tmux), to the
more robust (supervisord, systemd).

Systemd is running by default on Ubuntu Linux, so we'll use that here.

To run the server as a systemd service, create the file '''/etc/systemd/system/pavlovserver.service''' (as root) by typing
<pre>
sudo nano /etc/systemd/system/pavlovserver.service
</pre>

Copy contents below into the file and save.

<pre>
[Unit]
Description=Pavlov VR dedicated server

[Service]
Type=simple
WorkingDirectory=/home/steam/pavlovserver
ExecStart=/home/steam/pavlovserver/PavlovServer.sh

RestartSec=1
Restart=always
User=steam
Group=steam

[Install]
WantedBy = multi-user.target
</pre>

If you'd like your server to start as competitive without editing the game.ini, change the line "ExecStart=/home/steam/pavlovserver/PavlovServer.sh" to look like this below. Though it's much easier to just use the game.ini to enable competitive instead. <pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -COMPETITIVE=1</pre>

Change the user or paths as appropriate. After saving the service file, to start, restart, stop, or monitor the server:

<pre>
sudo systemctl start pavlovserver
sudo systemctl restart pavlovserver
sudo systemctl stop pavlovserver
sudo systemctl status pavlovserver
</pre>

To view the logs:

<pre>
sudo journalctl -u pavlovserver
# to live-tail the logs
sudo journalctl -u pavlovserver -f
</pre>

If you want to run the pavlov server as soon as your server boots (e.g. a VPS you turn on and off), add pavlov as a startup service:

<pre>
sudo systemctl enable pavlovserver
</pre>

----

== Advanced Server Administration ==

=== Running multiple servers on one host ===

* Pavlovserver is functionally single threaded (there are multiple threads, but vast majority of work occurs in the primary one). Make sure you have # of pavlovservers + 1 CPU available. More CPUs= more servers. Faster CPU = more players.
* Make multiple server installs by defining a separate install dir for each server.
* Run each server with a unique port. eg: '''./PavlovServer.sh -PORT="Desired Port"'''
* The Server will use the Desired Port and the Port 400 above (Example: You choose 8200 as Port. So Port 8600 will be used as well)
* If you are using RCON, each server will need a unique port defined in RconSettings.txt
* Ensure the ports are forwarded and opened in your firewall

To duplicate directories:

be in the steam home folder
<pre>
cp -r pavlovserver pavlovserver1
/home/steam/pavlovserver1/PavlovServer.sh -PORT=[Desired Port]
</pre>

=== Starting server in competitive mode ===
Competitive mode will prevent dead teammates from being able to see the match, to prevent ghosting.
You can either enable this via Game.ini (described in Game.ini file), or using the -COMPETITIVE=1 parameter.

<pre>
/home/steam/pavlovserver1/PavlovServer.sh -COMPETITIVE=1
</pre>

== Automated RCON ==
here are some examples of scripts that interact with Pavlov RCON

'''<big>Inspect players every 5 minutes</big>''' [https://github.com/JTWP-org/inspect-every-5-mins/blob/main/log/inspectPlayer-04-23-2023-21-50.demo.json (installation instructions on GITHUB )]

This [https://www.gnu.org/software/bash/ BASH] script will collect current players stats for every one. then it will write them to a log in JSON format that can easily be handled for your records or the next project ..

below is all the info that will be collected every 5

{| class="wikitable"
|+
|PlayerName
|Salted Cracker Jack
|-
|UniqueId
|76561198210003277
|-
|Score
|NUM
|-
|KDA
|KILLS / DEATHS / ASSIST
|-
|Dead
|TRUE / FALSE
|-
|CASH
|PLAYYERS MONEY
|-
|TEAM ID
|0 / 1
|}

----

=== Useful Linux Commands ===

List files / folders in directory, print current working directory,
<pre>ls -la #list files/directories along with authorities and ownership
pwd #print working directory
sudo chown <owner> <file/directory> #change owner of file/directory. If root created something and you need to change it to steam
sudo chgrp <group> <file/directory> #change group of file/directory.
</pre>

Check if pavlov is running by checking process status. If the only row you see is the grep command, pavlov server is not started.
<pre> ps -ef | grep pav </pre>

Sample output:
<pre>
steam 34044 1 0 16:52 ? 00:00:00 /bin/sh /home/steam/pavlovserver/PavlovServer.sh
steam 34066 34044 80 16:52 ? 00:00:04 /home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer
zombies+ 34101 34013 0 16:52 pts/0 00:00:00 grep --color=auto pav
</pre>

Kill a process. Note this command uses 34044, which is a process id from the command output above.
<pre> kill -9 34044 </pre>

Dump the log to the console so you can scroll through it:
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log </pre>

Search the log for a string - replace my_string with case-sensitive string
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep my_string </pre>

=== Default Map ID's ===
datacenter

sand

bridge

containeryard

siberia (Prison Break)

hospital (Zombies map)

killhouse

range

tutorial

santorini

station

industry

ogcontainers (Shack only)

haguenau (Shack only)

foundation (Shack only)

stalingrad (PC only)

stalingrad_night (PC only)

santorini_night (PC only)

sand_night (PC only)

station_night (PC only)

industry_night (PC only)

bunker (PC only)

=== Automated server log backup ===

here is how to setup a bash script to 1x a day compress all log files and save them to protect from auto deletion it will also post a discord webhook to confirm its working and saved the days logs

https://github.com/JTWP-org/backUpLogs

== Troubleshooting ==

To run the server without outputting the heartbeat:

<pre>./PavlovServer.sh | sed '/heartbeat/d'</pre>

To monitor the logs (without heartbeat) from another terminal:

<pre>tail -f -n10000 /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep -v 'Sending heartbeat to masterserver'</pre>

Check your CPU Clock Speed with:

<pre>lscpu | grep MHz</pre>

=== Server won't start ===

Error message:
<pre>
ln: failed to create hard link '/home/steam/.steam/sdk64/steamclient.so': File exists
ln: failed to create hard link '/home/steam/pavlovserver/Pavlov/Binaries/Linux/steamclient.so': File exists
/home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer: error while loading shared libraries: libc++.so.1: cannot open shared object file: No such file or directory
</pre>

First two errors are harmless. The third one is because libc++ step was skipped or failed. Using sudo capable id (probably not steam id), [re]run this line:
<pre>sudo apt update && sudo apt install -y gdb curl lib32gcc1 libc++-dev unzip </pre>

=== Map wont load (kicks to datacenter) ===

try deleting all the downloaded workshop maps with:

<pre>sudo rm -rf /tmp/workshop/7777/content/555160/*</pre> for all maps or

<pre>sudo rm -rf /tmp/workshop/7777/content/555160/whatever-UGC</pre> for specific map

=== Map wont load when running in a container ===
The three typical container problems I have seen:

1) Steam can't write to /tmp for some reason

2) /tmp is actually tmpfs instead of real filesystem and a few gigs of maps runs you out of RAM

3) Made worse by fact that pavlovserver unpacks downloads to ram, then writes to /tmp/workshop. Not enough RAM to do this, no map for you.

=== Server stuck rotating forever ===

Run these 2 commands, then restart your server:

<pre>cd ~/Steam && ./steamcmd.sh +login anonymous +app_update 1007 +quit
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so</pre>

If this doesn't fix it, double check that your server isn't running on the same port as another, by running this command:

<pre>ps -ef | grep pav</pre>

Then if 2 servers are on the same port, you can fix it by editing the pavlovserver.service file, and making sure the following line:

<pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -PORT=Number</pre>

has a unique number after the port for each server you're running.

=== Server - ping 999 ===
Google Cloud Platform - Make sure your compute engine has a network tag and your network rules are applied to the tag.
Make sure you opened the specified ports.

Network testing tools:
Test if your server will respond to ping from outside your network:
https://www.wormly.com/test-remote-ping

Test if your ports are accessible via UDP (7777,8177,9100):
https://www.ipvoid.com/udp-port-scan/

=== Can't connect to RCON ===
Check the file and group owner of RconSettings file. It should be steam, or the ID used to run the pavlov server.
<pre>
cd /home/steam/pavlovserver/Pavlov/Saved/Config
ls -la
</pre>

If the owner/group are not steam, using root or an id with sudo authority, change them to steam, confirm they are now set properly, then restart the pavlov server. (Note - if Rcon has wrong permissions, after fixing you should also to check the other config files like Game.ini, mods/blacklist/whitelist for the same issue. If steam can't access these files, it could cause problems.).
<pre>
cd /home/steam/pavlovserver/Pavlov/Saved/Config
sudo chown steam RconSettings.txt
sudo chgrp steam RconSettings.txt
ls -la </pre>

=== PC ONLY - Map Download stops ===

When downloading a large map from the steam workshop make sure your VPS/Dedi or Shared hosting provider (Otherwise known as a GSP's) has enough RAM assigned to store the map files in its tempfs (stored in ram)!

This is less likely to happen on Dedicated servers and VPS with a decent amount of ram unless you are using docker with RAM limits!

Most GSP's will be using docker or some other type of jailing method to limit system resource allocations and direct access to the host machine, if they are and you know what map you want to use make sure you order a service with enough ram to store your map. If in doubt contact your GSP's support team.

=== Getting Help ===

There's a #pc-custom-servers channel on the official Pavlov Discord - https://discord.gg/Pavlov-VR. Lots of helpful people there!

Setting up a dedicated server

2023-05-26T02:37:09Z

SaltedCrackerJack: /* Pending Restart */

== Setting up a dedicated server ==

'''There are no Windows binaries'''

This guide is written exclusively for Linux and covers Ubuntu/Debian/Debian-like and Red Hat RPM-based distros. Possible to run with other distros, but some of the commands won't work and you will need to know enough to figure out the software install of dependencies on your own.

If you are considering hosting from home, please read that section of the wiki first.

This guide assumes you know the basics of using a bash terminal: ssh'ing into a server, running bash commands, editing text files, etc.

If you have no experience using bash, maybe start [https://www.howtogeek.com/140679/beginner-geek-how-to-start-using-the-linux-terminal/ here]. Editing text files via commandline is often a challenge. Suggest using nano and reading guide [https://www.howtogeek.com/howto/42980/the-beginners-guide-to-nano-the-linux-command-line-text-editor/ here]

If you are new to linux and accessing your server from Windows, highly suggest using MobaXterm as your SSH client as that can make required editing of text files easier using built in editor instead of the native linux command line editors.

And finally, ask yourself why you want to setup a server? If you look at the list, there are many, many more servers than players. If you don't have a team, discord community, or group of friends ready to play on your server, chances are it will go unused. Got one of these... great, let's go.

If you don't want to go through the hassle yourself and want to pay for a hosting service Arctic VR (PC and Shack) and Horde (Shack) provide a server hosting services and are trusted in the community. See links below.

----

=== Server Requirements ===

'''Pavlovserver can only be hosted under Linux.'''

This can be running as a VM under windows, but this will increase the complexity of the setup beyond this guide.

Ubuntu 18.04 x86_64, Ubuntu 19/04 amd64, Ubuntu 20.04, and Rocky Linux 8 are confirmed working. Ubuntu 15.04 x86 is known to fail to install using this guide. Recommend not running on "minimal" images as some tools are missing.

* 2GB RAM + 1GB RAM per each additional server with 10 players. More RAM is recommended for larger maps, higher player counts, or complex gamemodes. Not having enough RAM is a common cause of server crashes.

* A ~2.5Ghz CPU will comfortably support a 10 player server.

* A ~4Ghz CPU will comfortably support 24 players. This is a limit built into Pavlov itself, no server will allow players to join over 24. Lower player counts are recommended for complex gamemodes (E.g. CodZ) and/or highly detailed maps, so that maximum number will often be lower.

(Note that these are '''not''' hard limits for player counts, just suggestions for the best performance, based on experiences with many server providers on different grades of hardware.)

* Pavlovserver is functionally single threaded (one thread does vast majority of work). More CPUs only help if you are running more servers. More clockspeed = higher performance = more users per server.
The maximum number of servers you can run is dependent on how many CPUs you have. For example, if you have an 8 core CPU, the maximum number of servers would be 7. You should always have at least one CPU free as overhead, as Pavlov servers can use slightly more than one thread.

----

==== Hosting at home ====
When hosting at home there are additional requirements regarding networking: Your router has to support port-forwarding, hair-pinning/LoopbackNAT, and respond to ping requests. These techniques are necessary to allow your server to be found and to talk back to the client. please see https://en.wikipedia.org/wiki/Port_forwarding, https://en.wikipedia.org/wiki/Hairpinning, and https://www.speedguide.net/faq/how-to-become-pingable-behind-a-routerfirewall-376 for more info and google for these terms in addition to your router model to find guides on how to enable/configure it properly. If you have modern Router, it may have these features already enabled, in this case you just have to configure port-forwarding. If you can see your server but not join it while others can, this is indicative of a failure of LoopbackNAT.

A second challenge to hosting at home is CGNAT (Carrier grade NAT: https://www.a10networks.com/blog/carrier-grade-nat/). Just like NAT on your home network that has to be gotten around w/ port-forwarding, CGNAT breaks the ability of external connections to be made back to your server, but the controls are solely in your ISPs hands. Sometimes if you ask, you can be removed from CGNAT pools and/or assigned a static IP. CGNAT rollouts are becoming very common now, so if your server worked then doesn't allow connections now, your ISP may have made this change.

You can check whether you’re on a CGNAT network by visiting a Web site such as ipaddress.com or whatsmyip.com and comparing the IP address listed to the public/WAN IP address assigned to your Internet gateway. To find your gateway’s public IP address, check the status page in the administrative interface. If the two IP addresses differ, you’re likely on a CGNAT network. If so, this problem must be resolved before you go any further.

'''Not understanding these requirements and configuration is a frequent cause of failed setups and questions in discord. Don't skip this if you are trying to host from home'''

'''There are serious security implications of hosting this software at home.''' None of the devs are security experts and there has been no security review of the code. You are opening up your system to the world and publicity advertising this fact. Expect that any system hosting this software is open to compromise from the Internet and act accordingly. If your router offers a DMZ network, use it. Consider hosting on a cloud based server and think twice before running this software on any system that contains data you care about or has access to networks and computers you care about.

If you're hosting at home using Oracle's VirtualBox, there are steps you can take to prevent double NAT (which can cause issues later on)

1. Select your VM and then click Settings in VirtualBox's main window.

2. Click on Network and change Attached To from NAT to Bridged Adapter.

Once you've done this, your VM should be connected directly to your home router and double NAT should no longer be a issue.
----

==== Hosting Providers ====

Considering the suggested server specs, you may be interested in the following hosting providers. For providers promising dedicated "Pavlov hosting" as opposed to general VPS services please contact and ask how you change maps being hosted and how you get RCON access before you put your money down.

<pre>
Provider | Base CPU | Details
Arctic VR | 4.5 GHz | https://www.arctic-vr.com/server-hosting
Amazon Web Services | 4.0 GHz | https://aws.amazon.com/ec2/instance-types/z1d/
VULTR | 4.0 GHz | https://www.vultr.com/products/high-frequency-compute/
packet.com | 3.5 GHz | https://www.packet.com/cloud/servers/c1-small/
Google Cloud Platform | 3.2 GHz | https://cloud.google.com/compute/docs/cpu-platforms
</pre>

===== ARCTIC VR =====

Arctic VR is the largest and longest running Pavlov VR hosting provider. The In-Game Admin Menu is exclusive to the ArcticVR hosting service. They offer EU, NA East and NA West servers for both shack and PCVR. ArcticVR offers the fastest Pavlov servers as well as DDos Protection, RCON remote management, custom maps, low pings, unlimited slots, and expert support.

Website: https://www.arctic-vr.com/server-hosting

[[File:Arctic_options.png|link=https://www.arctic-vr.com/server-hosting|700px]]

===== VULTR =====

Consider using a referral from the community:

Carlos: https://www.vultr.com/?ref=8615589-6G

Carrot: https://www.vultr.com/?ref=8689348

Archaeo: https://www.vultr.com/?ref=8653652-6G

Cheeto: https://www.vultr.com/?ref=8717358

For a Pavlov Shack server, I recommend minimum Cloud Compute, Intel High Performance, Ubuntu 20.04, and disabled automatic backups. At the time, this was $6/m. Some of the cheap options have 1TB bandwidth, and some have 2TB+. If it's a personal server, 1TB could be fine, but 2TB should be safe.

===== Google Cloud Platform (90 day free credit available) =====

The below configuration is successfully running 4 pavlov PC instances with ~15 total maps and up to 24 players per server. If you want more maps use larger boot disk. Both can dynamically be scaled based on popularity.

<pre>

Menu -> compute engine -> VM instances
create instance
- region: wherever you like
- machine type: n1-highcpu-4 (4 vCPUs, 3.6 GB memory)
- boot disk: Ubuntu 20.04
- boot disk -> size: 25gb
- network tags: pavlov-server
- [create]

Menu -> Vpc network -> firewall rules
[Create firewall rule]
Name: pavlov server
Target Tags: pavlov-server
Source IP Ranges: 0.0.0.0/0
Protocols and Ports -> Specified protocols and ports -> UDP: 7777, 8177 (Shack and PC)
Protocols and Ports -> Specified protocols and ports -> TCP: 7777, 8177 (Shack-only)
Protocols and Ports -> Specified protocols and ports -> TCP: {RCON port - default 9100}
[save]
</pre>

===== Amazon Web Services (30 day free credit available) =====

<pre>
Login -> Change Region: Choose your region
Services -> Compute -> EC2 -> Create
Choose an AMI: Ubuntu 18.04
Instance Type: z1d.large

Instance Details -> Tenancy: Dedicated (optional: this will more than triple the cost)

Storage: 50gb disk (or whatever, you're in control of the map roster)

Security Groups:
Create a new Security Group
Security group name: pavlov-server
Description: pavlov server
Rules:
Type: Custom ICMP Rule - IPV4 / Protocol: Echo Request
Type: Custom UDP Rule / Port Range: 7777 / Source: 0.0.0.0/0
Type: Custom UDP Rule / Port Range: 8177 / Source: 0.0.0.0/0
Type: SSH (optional, but I assume you wanna SSH in..)

Launch -> Create new Keypair -> Download -> Launch

Once it's started, SSH in like:
$ ssh -i your-key.pem ubuntu@you-server-details.amazonaws.com

(I use cmder on Windows, if you're using putty or mobaxterm or something, might be different)
</pre>

=== Starting Server Install ===

====Obtaining an ApiKey====
For your server to show up in the server list, there is now a requirement to have an ApiKey issued by vankrupt. This is to prevent DOS attacks against the master server

Get the key by going here: https://pavlov-ms.vankrupt.com/servers/v1/key and using your mobile number to get a SMS
(note that there have been reported failures of this SMS system for non-US mobiles. In this case DM davevillz your mobile and ask for a key)

Put this key in your Game.ini as follows:
ApiKey="ABC123FALSEKEYDONTUSEME"
or if you would like (personally untested..I would use game.ini) you can call it at server runtime with flag as follows:
-KEY="ABC123FALSEKEYDONTUSEME"

This key can be re-used for a reasonable number of servers (a limit of 10 has been mentioned). Contact the Devs if you need more servers per key.

====System setup and software installation====

Install dependencies and create the `steam` user. (You only need to do this once):

Confirm Linux version
<pre>
lsb_release -a
</pre>

'''Ubuntu 20.04'''
<pre>
sudo apt update && sudo apt install -y gdb curl lib32gcc1 libc++-dev unzip
sudo useradd -m steam
</pre>

'''Ubuntu 20.10 or higher'''
<pre>
sudo apt update && sudo apt install -y gdb curl lib32gcc-s1 libc++-dev unzip
sudo useradd -m steam
</pre>

'''Rocky Linux, CentOS 8, and RHEL 8'''

<pre>
sudo sed -i 's/^SELINUX=enforcing$/SELINUX=permissive/g' /etc/selinux/config
sudo setenforce 0
sudo yum install gdb curl glibc.i686 libstdc++.i686 libstdc++-devel.i686 libstdc++-devel.x86_64 unzip wget -y
wget https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/l/libcxx-3.8.0-3.el7.x86_64.rpm
sudo rpm -i libcxx-3.8.0-3.el7.x86_64.rpm
sudo useradd -m steam
</pre>

[Optional] Set a password for steam.
<pre>sudo passwd steam</pre>

Login as the steam user. ('''You will need to do this each time you connect to your server'''):

<pre>
sudo su -l steam
</pre>

Install Steam:

<pre>
mkdir ~/Steam && cd ~/Steam && curl -sqL "https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz" | tar zxvf -
</pre>

There are different dedicated server versions for Pavlov Server - choose which server version you want to host (PC non-beta, PC Beta, Shack Live, or Shack RC)
(You will need to run this command each time there is a Pavlov Server update). 
To host '''PC Server (non-beta)''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 +exit
</pre>

To host '''PC BETA''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta beta_server +exit
</pre>

To host '''Shack Live''' (Quest):

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack +exit
</pre>

To host '''Shack RC''' (Quest): 

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack_beta +exit
</pre>

Now that we've installed the server, all pavlov server versions should continue. 
Install a fresh copy of steamclient.so (May have to do this after each update):
<pre>
~/Steam/steamcmd.sh +login anonymous +app_update 1007 +quit
mkdir -p ~/.steam/sdk64
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/pavlovserver/Pavlov/Binaries/Linux/steamclient.so
</pre>

Make the PavlovServer script executable. (You only need to do this once):

<pre>
chmod +x ~/pavlovserver/PavlovServer.sh
</pre>

----

=== Server Configuration ===

Before starting the server we need to configure it. Start by creating some directories:

<pre>
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Logs
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps
</pre>

==== Mods/Blacklist/Whitelist (optional) ====

The following three files allow you to specify mods, banned players, and whitelist players. These are optional, but go ahead and create them. Populating the files is described later.

<pre>
touch /home/steam/pavlovserver/Pavlov/Saved/Config/mods.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/blacklist.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/whitelist.txt
</pre>

====Configuring Game.ini====
Create a new Game.ini file using following command to open an editor and copy/paste the following block into it then save it. Note not all of these options are required. For instance remove or comment out the Password=0000 line to make a public server with no pin.
<pre>
nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini
</pre>

<pre>
[/Script/Pavlov.DedicatedServer]
bEnabled=true
ServerName="My_private_idaho"
MaxPlayers=10 #Set this to 10 for Shack. 24 is the max for PC, setting it higher will not allow players to join.
ApiKey="ABC123FALSEKEYDONTUSEME"
bSecured=true
bCustomServer=true
bVerboseLogging=false
bCompetitive=false #This only works for SND
bWhitelist=false
RefreshListTime=120
LimitedAmmoType=0
TickRate=90
TimeLimit=60
#Password=0000
#BalanceTableURL="vankruptgames/BalancingTable/main"
MapRotation=(MapId="UGC1758245796", GameMode="GUN")
MapRotation=(MapId="datacenter", GameMode="SND")
MapRotation=(MapId="sand", GameMode="DM")

</pre>

* '''bEnabled''' - whether the server appears in the server list (unconfirmed)
* '''ServerName''' - name it will be listed as. (approx 35 chars max)
* '''MaxPlayers''' - See suggested specs for limits. 10 standard (10 for shack), 20-24 is max recommended for large maps like Stalingrad or PUSH/RUSH modes, and servers allow a maximum of 24 players.
* '''ApiKey''' - Unique ApiKey required to register server with master server. Replace with your key
* '''bSecured''' - enabled Valve Anti-Cheat (VAC)
* '''bCustomServer''' - activates some new modding tools (save and http functions. Required to write to blacklist.txt for bans)
* '''bCompetitive''' - sets the server to competitive mode for SND. If removed the server will default to false
* '''bVerboseLogging''' - enables verbose logging, mostly detailed statistics. Be prepared for significant increase in logging.
* '''bWhitelist''' - Only allow users in whitelist.txt to join
* '''RefreshListTime''' - sets how often the running server checks for updates in ban/whitelist/mod files
* '''LimitedAmmoType''' - sets limited ammo mode
0 = Unlimited
1 = Limited Generic
2 = Limited Specific
3 = Custom (for modders)
4 = Limited Special
5 = Boxless Mode

* '''TimeLimit''' - sets time limit for each map
* '''TickRate''' - sets the server tickrate. (so far minimum stable seems around 50 and max around 120. Beware setting this changes weapon despawn time and breaks some game modes. Recommend not touching)
* '''Password''' - PIN number for server #FYI - this is now also changeable via rcon.
* '''BalanceTableURL''' - Points to a custom balance table from github. See https://github.com/vankruptgames/BalancingTable for instructions. This line isn't needed if you don't have one.
* '''MapRotation''' - you can add multiple of these. The MapId must be “UGC” followed by the map ID. you can find the map id in the URL of the steam workshop page. When a match ends, the server will load the next map in the rotation. You can also use RCON to switch to a map not included in rotation.

Available game modes as of 09/06/2022: SND, TDM, DM, GUN, ZWV, WW2GUN, TANKTDM, KOTH, TTT, OITC, INFECTION, HIDE, PUSH, PH 

And for Shack only: CTF

For maps running a Custom gamemode (CodZ, BR, Duel, etc.) it doesn't matter which gamemode you choose, as the map will automatically override it with the custom mode.

UGC###### are for custom maps from Steam workshop (PC Only). Find the map you want in the workshop. This is the URL for Mirage (https://steamcommunity.com/sharedfiles/filedetails/?id=2670152485). The 10 numbers at the end of the URL are what you need, so UGC1661803933 would be the MapId for Mirage.

==== Firewall/Port forwarding ====
Using the default settings there are two UDP ports (7777, 8177) that need to be allowed to access the server either by firewall setup or port forwarding.

'''Ubuntu''' firewall commands to check firewall and open ports:
<pre>
sudo ufw status
sudo ufw allow 7777
sudo ufw allow 8177
sudo ufw allow 9100
sudo ufw status
</pre>

'''Rocky Linux''' firewall commands to check firewall and open ports:
<pre>
sudo firewall-cmd --zone=public --add-port=7777/tcp
sudo firewall-cmd --zone=public --add-port=7777/udp
sudo firewall-cmd --zone=public --add-port=8177/tcp
sudo firewall-cmd --zone=public --add-port=8177/udp
sudo firewall-cmd --zone=public --add-port=9100/udp
sudo firewall-cmd --zone=public --add-port=9100/tcp
sudo firewall-cmd --list-ports
firewall-cmd --runtime-to-permanent
</pre>

You may also need to allow Pings (ICMP) for the server's true latency to appear in the master list.

If you are running multiple servers and have set additional ports (see http://wiki.pavlov-vr.com/index.php?title=Dedicated_server#Running_multiple_servers_on_one_host) then you need to allow access to the defined port plus the port 400 higher. So if you use 7000 as your port, then UDP 7000 and 7400 need to be open

If you have setup rcon via RconSettings.txt (below) then that port also need to be allowed access via TCP

If you are running Shack/Quest and want to have maps that are downloadable from your server, your server ports (ex. 7777 & 8177) must also be open via TCP

----

==== Shack Maps (Quest) ====

If you try to use the steps above to add maps for Shack, youll run into issues very quickly. This is because Shack has no affiliation to Steam, and therefore cannot use Steam Workshop maps like above. In the future, these steps will apply to PC servers as well, allowing a server to hold the map itself, instead of offloading to Steam.

To get started, first create the directory to hold the maps

<pre>mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps</pre>

You can use any number of methods to move the map files onto the server, but ill go over the two simplest, starting with a GUI approach

Download and install CyberDuck onto your "home" PC (Whatever PC you use for access to the server, but not the server itsself): https://cyberduck.io/

Next, download and unzip your map of choice from https://www.pavlovquest.com/ , https://pavlovhorde.com/mapsList, or look in #shack-map-showcase channel in the discord server. I'm going to use Cheeto's WW2 Items test (http://www.mediafire.com/file/emyt9bs1z9u9ykw/SVR_Cheeto_Items.zip/file ) for this example, you do what you like

In the top left corner, open a connection, set the connection type to SFTP, and fill in the rest of the information. User will be root, password is whatever you set the root pw as (toor in Ubuntu by default)

In the directory dropdown (itll say /root) go back to /

Follow the directories until we arrive back at our "maps" folder <pre>/home/steam/pavlovserver/Pavlov/Saved/maps</pre>

Drag and drop the unzipped map folder into the main window, in this case itll be SVR_Cheeto_Items

Hit Allow

Youll now see a folder named SVR_Cheeto_Items, and within it should be nothing but 3 files. If there is another folder in it, move this folder to the maps directory, otherwise the server wont work. The 3 files (2 .PAK one .JSON) should be in home/steam/pavlovserver/Pavlov/Saved/maps/SVR_Cheeto_Items, no more, no less.

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

To play the map, you can either use RCON switch map command, or to add the map to your servers automatic map rotation list, add the map's folder name to your Game.ini. This replaces the MapID section, so for our example it would be

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

And thats all! Disconnect CyberDuck from your server before playing, otherwise youll have difficulty joining.

-----------

==== Adding Shack Maps over Command Line Interface ====

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

A bit more complicated, but adding maps over CLI has its benefits

First, CD to the maps directory you made above

<pre>cd ~/pavlovserver/Pavlov/Saved/maps</pre>

Download the map files from whatever you use to upload them. To do this, you can either use curl or wget

<pre>curl -O insertURLhere</pre>

'''If you download your map from Google Drive''', make sure that your .zip folder is shared to anyone.
Then, get the file's url from the shared link. Example : ''<nowiki>https://drive.google.com/file/d/19bI8gUHaN5tUrDvnadAacUnchQf6_k/view</nowiki>'' will be ''19bI8gUHaN5tUrDvnadAacUnchQf6_k''
Edit "fileId" and "fileName" before you execute the command.
<pre>
fileId=19bI8gUHaN5tUrDvnadAacUnchQf6_k
fileName=SVR_USER_MAPNAME
curl -sc /tmp/cookie "https://drive.google.com/uc?export=download&id=${fileId}" > /dev/null
code="$(awk '/_warning_/ {print $NF}' /tmp/cookie)"
curl -Lb /tmp/cookie "https://drive.google.com/uc?export=download&confirm=${code}&id=${fileId}" -o ${fileName} </pre>

To keep with the Items example:

<pre>curl -O https://cdn.discordapp.com/attachments/744185280759857234/745027406695366788/SVR_Cheeto_Items.zip</pre>

Next, unzip the file. If this next step errors out, saying the command is unknown, switch back to the root user (su root), and install unzip (sudo apt install unzip), then return to the steam user, and continue.

<pre>unzip SVR_Cheeto_Items.zip</pre>

Now finish like before by adding the map to your Game.ini

<pre>nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini</pre>

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

==== Admin/Moderator list (optional) ====

The only working in-game admin menu is through Arctic VR server hosting (see below).

If you add moderators to your server, they will not be subject to vote kicks.

<pre>
nano ~/pavlovserver/Pavlov/Saved/Config/mods.txt
</pre>

Example Mod List:
<pre>
76541198397498572 #Optional Comment: Player name
76541198397498573 #Some Other Player
</pre>

==== ArcticVR Admin Menu ====

[[File:Arcticmenu.jpg|500px|link=https://www.arctic-vr.com/server-admin-menu]]

Arctic-VR Offers an advanced In-Game Admin menu that is exclusive to their hosting service. Features include:
* Switch Maps+Modes
* Teleport Players to Players
* Change Player Skins
* Control Player Buying+Cash
* Spawn Items
* Clean up corpses + guns
* Spawn Bots
* Spawn Items for other players
* Control Teams + Balance/Shuffle Teams
* ResetSND
* And More

You can read more about the ArcticVR admin menu on their website: https://www.arctic-vr.com/server-admin-menu

==== Handy tools for finding steamIDs ====

Steam ID finder: https://steamidfinder.com/lookup/ or https://steamid.xyz/

You want to enter in the steamID64 format.

This tool can convert or lookup IDs: https://steamid.io/

If you are looking for a steamID of a player that has been on your server recently this is technique to find them:
<pre>
grep -i playername ~/pavlovserver/Pavlov/Saved/Logs/* | grep TicketValidation
</pre>

=== Configure Rcon ===
To enable Rcon access create config file:
<pre> nano /home/steam/pavlovserver/Pavlov/Saved/Config/RconSettings.txt </pre>

Copy in the following text - change password, and if desired the port:
<pre>
Password=ChangeThisPassword
Port=9100
</pre>
You must specify a port for the Rcon server to use as well as a Password (use a different port per sever instance if running multiple server instances off the same hardware)

=== Starting the server ===

<pre>
cd ~/pavlovserver && ./PavlovServer.sh
</pre>

That's it, your server will be automatically broadcast to the master server! :)

Two handy tools to determine quickly if your server is broadcasting are [https://pablub.xyz/ Pablub] (PC only) and [https://pavlovhorde.com/ Horde] (Shack) and [https://pavlovhorde.com/pcServers Horde] (PC version)

Note that when you close your terminal, the server will go down. See the "supervisors" section below for how to prevent this.

=== Auto-updating the server ===

Assuming you have followed this guide and used the default paths, users, and install instructions, you can paste the following into your terminal to auto-update your Pavlov server:

<pre>
cat << 'EOF' > $HOME/pavlov_daily_update_and_restart.sh
#!/bin/bash

USER="steam"
SERVICENAME="pavlovserver.service"
INSTALLDIRNAME="pavlovserver"
USERHOME="/home/$USER"

echo -e "Beginning Pavlov VR update run on $(date)\n\n"

systemctl stop "$SERVICENAME"

sleep 5
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +force_install_dir "$USERHOME/$INSTALLDIRNAME" +app_update 622970 +exit
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +app_update 1007 +quit
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/.steam/sdk64/steamclient.so"
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/pavlovserver/Pavlov/Binaries/Linux/steamclient.so"

systemctl start "$SERVICENAME"

echo -e "Ending Pavlov VR update run on $(date)\n\n"

EOF

chmod +x $HOME/pavlov_daily_update_and_restart.sh
mkdir $HOME/pavlov_update_logs && touch $HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log
CRONLINE="00 2 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
(sudo crontab -u root -l; echo "$CRONLINE" ) | sudo crontab -u root -
unset CRONLINE

</pre>

These commands will:

1. Create a shell script in the "steam" user's home directory that automatically stops the Pavlov server, pulls any updates via steam, pull updates to the Steamworks SDK Redist, and copies the latest version of steamclient.so to the Pavlov server directory

2. Make the shell script executable

3. Create a new directory called "pavlov_update_logs" in the "steam" user's directory, and create a logfile inside that directory called "pavlov_daily_update_and_restart.sh.log". You can check this logfile to see the output of the Pavlov and Steam SDK update commands.

4. Create a crontab entry for the root user that runs this shell script automatically every day at 2:00AM local time

If you want to change the time that this script runs, edit the numbers "00 2" in the line that starts with "CRONLINE=". In the example provided, 00 is the minutes column, and 2 is the hour column. For example, if you wanted the server to automatically update and restart at 4:17AM every day, change the line starting with "CRONLINE=" to:

<pre>
CRONLINE="17 4 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
</pre>

If the time is PM, use 24-hour time format, e.g. "32 18" for 6:32PM.

----

=== Supervising the server using systemd ===

Running '''./PavlovServer.sh''' in your interactive shell is easy, but the server will shut down when you close your terminal. If you want to run the server in the background,
you'll want to run it under a supervisor. There are many options, ranging from the simple (nohup, screen or tmux), to the
more robust (supervisord, systemd).

Systemd is running by default on Ubuntu Linux, so we'll use that here.

To run the server as a systemd service, create the file '''/etc/systemd/system/pavlovserver.service''' (as root) by typing
<pre>
sudo nano /etc/systemd/system/pavlovserver.service
</pre>

Copy contents below into the file and save.

<pre>
[Unit]
Description=Pavlov VR dedicated server

[Service]
Type=simple
WorkingDirectory=/home/steam/pavlovserver
ExecStart=/home/steam/pavlovserver/PavlovServer.sh

RestartSec=1
Restart=always
User=steam
Group=steam

[Install]
WantedBy = multi-user.target
</pre>

If you'd like your server to start as competitive without editing the game.ini, change the line "ExecStart=/home/steam/pavlovserver/PavlovServer.sh" to look like this below. Though it's much easier to just use the game.ini to enable competitive instead. <pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -COMPETITIVE=1</pre>

Change the user or paths as appropriate. After saving the service file, to start, restart, stop, or monitor the server:

<pre>
sudo systemctl start pavlovserver
sudo systemctl restart pavlovserver
sudo systemctl stop pavlovserver
sudo systemctl status pavlovserver
</pre>

To view the logs:

<pre>
sudo journalctl -u pavlovserver
# to live-tail the logs
sudo journalctl -u pavlovserver -f
</pre>

If you want to run the pavlov server as soon as your server boots (e.g. a VPS you turn on and off), add pavlov as a startup service:

<pre>
sudo systemctl enable pavlovserver
</pre>

----

== Advanced Server Administration ==

=== Running multiple servers on one host ===

* Pavlovserver is functionally single threaded (there are multiple threads, but vast majority of work occurs in the primary one). Make sure you have # of pavlovservers + 1 CPU available. More CPUs= more servers. Faster CPU = more players.
* Make multiple server installs by defining a separate install dir for each server.
* Run each server with a unique port. eg: '''./PavlovServer.sh -PORT="Desired Port"'''
* The Server will use the Desired Port and the Port 400 above (Example: You choose 8200 as Port. So Port 8600 will be used as well)
* If you are using RCON, each server will need a unique port defined in RconSettings.txt
* Ensure the ports are forwarded and opened in your firewall

To duplicate directories:

be in the steam home folder
<pre>
cp -r pavlovserver pavlovserver1
/home/steam/pavlovserver1/PavlovServer.sh -PORT=[Desired Port]
</pre>

=== Starting server in competitive mode ===
Competitive mode will prevent dead teammates from being able to see the match, to prevent ghosting.
You can either enable this via Game.ini (described in Game.ini file), or using the -COMPETITIVE=1 parameter.

<pre>
/home/steam/pavlovserver1/PavlovServer.sh -COMPETITIVE=1
</pre>

=== Automated RCON ===
here are some examples of scripts that interact with Pavlov RCON

'''<big>Inspect players every 5 minutes</big>''' [https://github.com/JTWP-org/inspect-every-5-mins/blob/main/log/inspectPlayer-04-23-2023-21-50.demo.json (installation instructions on GITHUB )]

This [https://www.gnu.org/software/bash/ BASH] script will collect current players stats for every one. then it will write them to a log in JSON format that can easily be handled for your records or the next project ..

below is all the info that will be collected every 5

{| class="wikitable"
|+
|PlayerName
|Salted Cracker Jack
|-
|UniqueId
|76561198210003277
|-
|Score
|NUM
|-
|KDA
|KILLS / DEATHS / ASSIST
|-
|Dead
|TRUE / FALSE
|-
|CASH
|PLAYYERS MONEY
|-
|TEAM ID
|0 / 1
|}

=== Pending Restart ===
when this [https://www.gnu.org/software/bash/ BASH] script is triggered it will start a loop that checks every 15 mins if the server is empty and

----

=== Useful Linux Commands ===

List files / folders in directory, print current working directory,
<pre>ls -la #list files/directories along with authorities and ownership
pwd #print working directory
sudo chown <owner> <file/directory> #change owner of file/directory. If root created something and you need to change it to steam
sudo chgrp <group> <file/directory> #change group of file/directory.
</pre>

Check if pavlov is running by checking process status. If the only row you see is the grep command, pavlov server is not started.
<pre> ps -ef | grep pav </pre>

Sample output:
<pre>
steam 34044 1 0 16:52 ? 00:00:00 /bin/sh /home/steam/pavlovserver/PavlovServer.sh
steam 34066 34044 80 16:52 ? 00:00:04 /home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer
zombies+ 34101 34013 0 16:52 pts/0 00:00:00 grep --color=auto pav
</pre>

Kill a process. Note this command uses 34044, which is a process id from the command output above.
<pre> kill -9 34044 </pre>

Dump the log to the console so you can scroll through it:
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log </pre>

Search the log for a string - replace my_string with case-sensitive string
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep my_string </pre>

=== Default Map ID's ===
datacenter

sand

bridge

containeryard

siberia (Prison Break)

hospital (Zombies map)

killhouse

range

tutorial

santorini

station

industry

ogcontainers (Shack only)

haguenau (Shack only)

foundation (Shack only)

stalingrad (PC only)

stalingrad_night (PC only)

santorini_night (PC only)

sand_night (PC only)

station_night (PC only)

industry_night (PC only)

bunker (PC only)

=== Automated server log backup ===

here is how to setup a bash script to 1x a day compress all log files and save them to protect from auto deletion it will also post a discord webhook to confirm its working and saved the days logs

https://github.com/JTWP-org/backUpLogs

== Troubleshooting ==

To run the server without outputting the heartbeat:

<pre>./PavlovServer.sh | sed '/heartbeat/d'</pre>

To monitor the logs (without heartbeat) from another terminal:

<pre>tail -f -n10000 /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep -v 'Sending heartbeat to masterserver'</pre>

Check your CPU Clock Speed with:

<pre>lscpu | grep MHz</pre>

=== Server won't start ===

Error message:
<pre>
ln: failed to create hard link '/home/steam/.steam/sdk64/steamclient.so': File exists
ln: failed to create hard link '/home/steam/pavlovserver/Pavlov/Binaries/Linux/steamclient.so': File exists
/home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer: error while loading shared libraries: libc++.so.1: cannot open shared object file: No such file or directory
</pre>

First two errors are harmless. The third one is because libc++ step was skipped or failed. Using sudo capable id (probably not steam id), [re]run this line:
<pre>sudo apt update && sudo apt install -y gdb curl lib32gcc1 libc++-dev unzip </pre>

=== Map wont load (kicks to datacenter) ===

try deleting all the downloaded workshop maps with:

<pre>sudo rm -rf /tmp/workshop/7777/content/555160/*</pre> for all maps or

<pre>sudo rm -rf /tmp/workshop/7777/content/555160/whatever-UGC</pre> for specific map

=== Map wont load when running in a container ===
The three typical container problems I have seen:

1) Steam can't write to /tmp for some reason

2) /tmp is actually tmpfs instead of real filesystem and a few gigs of maps runs you out of RAM

3) Made worse by fact that pavlovserver unpacks downloads to ram, then writes to /tmp/workshop. Not enough RAM to do this, no map for you.

=== Server stuck rotating forever ===

Run these 2 commands, then restart your server:

<pre>cd ~/Steam && ./steamcmd.sh +login anonymous +app_update 1007 +quit
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so</pre>

If this doesn't fix it, double check that your server isn't running on the same port as another, by running this command:

<pre>ps -ef | grep pav</pre>

Then if 2 servers are on the same port, you can fix it by editing the pavlovserver.service file, and making sure the following line:

<pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -PORT=Number</pre>

has a unique number after the port for each server you're running.

=== Server - ping 999 ===
Google Cloud Platform - Make sure your compute engine has a network tag and your network rules are applied to the tag.
Make sure you opened the specified ports.

Network testing tools:
Test if your server will respond to ping from outside your network:
https://www.wormly.com/test-remote-ping

Test if your ports are accessible via UDP (7777,8177,9100):
https://www.ipvoid.com/udp-port-scan/

=== Can't connect to RCON ===
Check the file and group owner of RconSettings file. It should be steam, or the ID used to run the pavlov server.
<pre>
cd /home/steam/pavlovserver/Pavlov/Saved/Config
ls -la
</pre>

If the owner/group are not steam, using root or an id with sudo authority, change them to steam, confirm they are now set properly, then restart the pavlov server. (Note - if Rcon has wrong permissions, after fixing you should also to check the other config files like Game.ini, mods/blacklist/whitelist for the same issue. If steam can't access these files, it could cause problems.).
<pre>
cd /home/steam/pavlovserver/Pavlov/Saved/Config
sudo chown steam RconSettings.txt
sudo chgrp steam RconSettings.txt
ls -la </pre>

=== PC ONLY - Map Download stops ===

When downloading a large map from the steam workshop make sure your VPS/Dedi or Shared hosting provider (Otherwise known as a GSP's) has enough RAM assigned to store the map files in its tempfs (stored in ram)!

This is less likely to happen on Dedicated servers and VPS with a decent amount of ram unless you are using docker with RAM limits!

Most GSP's will be using docker or some other type of jailing method to limit system resource allocations and direct access to the host machine, if they are and you know what map you want to use make sure you order a service with enough ram to store your map. If in doubt contact your GSP's support team.

=== Getting Help ===

There's a #pc-custom-servers channel on the official Pavlov Discord - https://discord.gg/Pavlov-VR. Lots of helpful people there!

Setting up a dedicated server

2023-05-26T02:33:11Z

SaltedCrackerJack: /* Inspect players every 5 (GitHub ) */

== Setting up a dedicated server ==

'''There are no Windows binaries'''

This guide is written exclusively for Linux and covers Ubuntu/Debian/Debian-like and Red Hat RPM-based distros. Possible to run with other distros, but some of the commands won't work and you will need to know enough to figure out the software install of dependencies on your own.

If you are considering hosting from home, please read that section of the wiki first.

This guide assumes you know the basics of using a bash terminal: ssh'ing into a server, running bash commands, editing text files, etc.

If you have no experience using bash, maybe start [https://www.howtogeek.com/140679/beginner-geek-how-to-start-using-the-linux-terminal/ here]. Editing text files via commandline is often a challenge. Suggest using nano and reading guide [https://www.howtogeek.com/howto/42980/the-beginners-guide-to-nano-the-linux-command-line-text-editor/ here]

If you are new to linux and accessing your server from Windows, highly suggest using MobaXterm as your SSH client as that can make required editing of text files easier using built in editor instead of the native linux command line editors.

And finally, ask yourself why you want to setup a server? If you look at the list, there are many, many more servers than players. If you don't have a team, discord community, or group of friends ready to play on your server, chances are it will go unused. Got one of these... great, let's go.

If you don't want to go through the hassle yourself and want to pay for a hosting service Arctic VR (PC and Shack) and Horde (Shack) provide a server hosting services and are trusted in the community. See links below.

----

=== Server Requirements ===

'''Pavlovserver can only be hosted under Linux.'''

This can be running as a VM under windows, but this will increase the complexity of the setup beyond this guide.

Ubuntu 18.04 x86_64, Ubuntu 19/04 amd64, Ubuntu 20.04, and Rocky Linux 8 are confirmed working. Ubuntu 15.04 x86 is known to fail to install using this guide. Recommend not running on "minimal" images as some tools are missing.

* 2GB RAM + 1GB RAM per each additional server with 10 players. More RAM is recommended for larger maps, higher player counts, or complex gamemodes. Not having enough RAM is a common cause of server crashes.

* A ~2.5Ghz CPU will comfortably support a 10 player server.

* A ~4Ghz CPU will comfortably support 24 players. This is a limit built into Pavlov itself, no server will allow players to join over 24. Lower player counts are recommended for complex gamemodes (E.g. CodZ) and/or highly detailed maps, so that maximum number will often be lower.

(Note that these are '''not''' hard limits for player counts, just suggestions for the best performance, based on experiences with many server providers on different grades of hardware.)

* Pavlovserver is functionally single threaded (one thread does vast majority of work). More CPUs only help if you are running more servers. More clockspeed = higher performance = more users per server.
The maximum number of servers you can run is dependent on how many CPUs you have. For example, if you have an 8 core CPU, the maximum number of servers would be 7. You should always have at least one CPU free as overhead, as Pavlov servers can use slightly more than one thread.

----

==== Hosting at home ====
When hosting at home there are additional requirements regarding networking: Your router has to support port-forwarding, hair-pinning/LoopbackNAT, and respond to ping requests. These techniques are necessary to allow your server to be found and to talk back to the client. please see https://en.wikipedia.org/wiki/Port_forwarding, https://en.wikipedia.org/wiki/Hairpinning, and https://www.speedguide.net/faq/how-to-become-pingable-behind-a-routerfirewall-376 for more info and google for these terms in addition to your router model to find guides on how to enable/configure it properly. If you have modern Router, it may have these features already enabled, in this case you just have to configure port-forwarding. If you can see your server but not join it while others can, this is indicative of a failure of LoopbackNAT.

A second challenge to hosting at home is CGNAT (Carrier grade NAT: https://www.a10networks.com/blog/carrier-grade-nat/). Just like NAT on your home network that has to be gotten around w/ port-forwarding, CGNAT breaks the ability of external connections to be made back to your server, but the controls are solely in your ISPs hands. Sometimes if you ask, you can be removed from CGNAT pools and/or assigned a static IP. CGNAT rollouts are becoming very common now, so if your server worked then doesn't allow connections now, your ISP may have made this change.

You can check whether you’re on a CGNAT network by visiting a Web site such as ipaddress.com or whatsmyip.com and comparing the IP address listed to the public/WAN IP address assigned to your Internet gateway. To find your gateway’s public IP address, check the status page in the administrative interface. If the two IP addresses differ, you’re likely on a CGNAT network. If so, this problem must be resolved before you go any further.

'''Not understanding these requirements and configuration is a frequent cause of failed setups and questions in discord. Don't skip this if you are trying to host from home'''

'''There are serious security implications of hosting this software at home.''' None of the devs are security experts and there has been no security review of the code. You are opening up your system to the world and publicity advertising this fact. Expect that any system hosting this software is open to compromise from the Internet and act accordingly. If your router offers a DMZ network, use it. Consider hosting on a cloud based server and think twice before running this software on any system that contains data you care about or has access to networks and computers you care about.

If you're hosting at home using Oracle's VirtualBox, there are steps you can take to prevent double NAT (which can cause issues later on)

1. Select your VM and then click Settings in VirtualBox's main window.

2. Click on Network and change Attached To from NAT to Bridged Adapter.

Once you've done this, your VM should be connected directly to your home router and double NAT should no longer be a issue.
----

==== Hosting Providers ====

Considering the suggested server specs, you may be interested in the following hosting providers. For providers promising dedicated "Pavlov hosting" as opposed to general VPS services please contact and ask how you change maps being hosted and how you get RCON access before you put your money down.

<pre>
Provider | Base CPU | Details
Arctic VR | 4.5 GHz | https://www.arctic-vr.com/server-hosting
Amazon Web Services | 4.0 GHz | https://aws.amazon.com/ec2/instance-types/z1d/
VULTR | 4.0 GHz | https://www.vultr.com/products/high-frequency-compute/
packet.com | 3.5 GHz | https://www.packet.com/cloud/servers/c1-small/
Google Cloud Platform | 3.2 GHz | https://cloud.google.com/compute/docs/cpu-platforms
</pre>

===== ARCTIC VR =====

Arctic VR is the largest and longest running Pavlov VR hosting provider. The In-Game Admin Menu is exclusive to the ArcticVR hosting service. They offer EU, NA East and NA West servers for both shack and PCVR. ArcticVR offers the fastest Pavlov servers as well as DDos Protection, RCON remote management, custom maps, low pings, unlimited slots, and expert support.

Website: https://www.arctic-vr.com/server-hosting

[[File:Arctic_options.png|link=https://www.arctic-vr.com/server-hosting|700px]]

===== VULTR =====

Consider using a referral from the community:

Carlos: https://www.vultr.com/?ref=8615589-6G

Carrot: https://www.vultr.com/?ref=8689348

Archaeo: https://www.vultr.com/?ref=8653652-6G

Cheeto: https://www.vultr.com/?ref=8717358

For a Pavlov Shack server, I recommend minimum Cloud Compute, Intel High Performance, Ubuntu 20.04, and disabled automatic backups. At the time, this was $6/m. Some of the cheap options have 1TB bandwidth, and some have 2TB+. If it's a personal server, 1TB could be fine, but 2TB should be safe.

===== Google Cloud Platform (90 day free credit available) =====

The below configuration is successfully running 4 pavlov PC instances with ~15 total maps and up to 24 players per server. If you want more maps use larger boot disk. Both can dynamically be scaled based on popularity.

<pre>

Menu -> compute engine -> VM instances
create instance
- region: wherever you like
- machine type: n1-highcpu-4 (4 vCPUs, 3.6 GB memory)
- boot disk: Ubuntu 20.04
- boot disk -> size: 25gb
- network tags: pavlov-server
- [create]

Menu -> Vpc network -> firewall rules
[Create firewall rule]
Name: pavlov server
Target Tags: pavlov-server
Source IP Ranges: 0.0.0.0/0
Protocols and Ports -> Specified protocols and ports -> UDP: 7777, 8177 (Shack and PC)
Protocols and Ports -> Specified protocols and ports -> TCP: 7777, 8177 (Shack-only)
Protocols and Ports -> Specified protocols and ports -> TCP: {RCON port - default 9100}
[save]
</pre>

===== Amazon Web Services (30 day free credit available) =====

<pre>
Login -> Change Region: Choose your region
Services -> Compute -> EC2 -> Create
Choose an AMI: Ubuntu 18.04
Instance Type: z1d.large

Instance Details -> Tenancy: Dedicated (optional: this will more than triple the cost)

Storage: 50gb disk (or whatever, you're in control of the map roster)

Security Groups:
Create a new Security Group
Security group name: pavlov-server
Description: pavlov server
Rules:
Type: Custom ICMP Rule - IPV4 / Protocol: Echo Request
Type: Custom UDP Rule / Port Range: 7777 / Source: 0.0.0.0/0
Type: Custom UDP Rule / Port Range: 8177 / Source: 0.0.0.0/0
Type: SSH (optional, but I assume you wanna SSH in..)

Launch -> Create new Keypair -> Download -> Launch

Once it's started, SSH in like:
$ ssh -i your-key.pem ubuntu@you-server-details.amazonaws.com

(I use cmder on Windows, if you're using putty or mobaxterm or something, might be different)
</pre>

=== Starting Server Install ===

====Obtaining an ApiKey====
For your server to show up in the server list, there is now a requirement to have an ApiKey issued by vankrupt. This is to prevent DOS attacks against the master server

Get the key by going here: https://pavlov-ms.vankrupt.com/servers/v1/key and using your mobile number to get a SMS
(note that there have been reported failures of this SMS system for non-US mobiles. In this case DM davevillz your mobile and ask for a key)

Put this key in your Game.ini as follows:
ApiKey="ABC123FALSEKEYDONTUSEME"
or if you would like (personally untested..I would use game.ini) you can call it at server runtime with flag as follows:
-KEY="ABC123FALSEKEYDONTUSEME"

This key can be re-used for a reasonable number of servers (a limit of 10 has been mentioned). Contact the Devs if you need more servers per key.

====System setup and software installation====

Install dependencies and create the `steam` user. (You only need to do this once):

Confirm Linux version
<pre>
lsb_release -a
</pre>

'''Ubuntu 20.04'''
<pre>
sudo apt update && sudo apt install -y gdb curl lib32gcc1 libc++-dev unzip
sudo useradd -m steam
</pre>

'''Ubuntu 20.10 or higher'''
<pre>
sudo apt update && sudo apt install -y gdb curl lib32gcc-s1 libc++-dev unzip
sudo useradd -m steam
</pre>

'''Rocky Linux, CentOS 8, and RHEL 8'''

<pre>
sudo sed -i 's/^SELINUX=enforcing$/SELINUX=permissive/g' /etc/selinux/config
sudo setenforce 0
sudo yum install gdb curl glibc.i686 libstdc++.i686 libstdc++-devel.i686 libstdc++-devel.x86_64 unzip wget -y
wget https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/l/libcxx-3.8.0-3.el7.x86_64.rpm
sudo rpm -i libcxx-3.8.0-3.el7.x86_64.rpm
sudo useradd -m steam
</pre>

[Optional] Set a password for steam.
<pre>sudo passwd steam</pre>

Login as the steam user. ('''You will need to do this each time you connect to your server'''):

<pre>
sudo su -l steam
</pre>

Install Steam:

<pre>
mkdir ~/Steam && cd ~/Steam && curl -sqL "https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz" | tar zxvf -
</pre>

There are different dedicated server versions for Pavlov Server - choose which server version you want to host (PC non-beta, PC Beta, Shack Live, or Shack RC)
(You will need to run this command each time there is a Pavlov Server update). 
To host '''PC Server (non-beta)''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 +exit
</pre>

To host '''PC BETA''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta beta_server +exit
</pre>

To host '''Shack Live''' (Quest):

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack +exit
</pre>

To host '''Shack RC''' (Quest): 

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack_beta +exit
</pre>

Now that we've installed the server, all pavlov server versions should continue. 
Install a fresh copy of steamclient.so (May have to do this after each update):
<pre>
~/Steam/steamcmd.sh +login anonymous +app_update 1007 +quit
mkdir -p ~/.steam/sdk64
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/pavlovserver/Pavlov/Binaries/Linux/steamclient.so
</pre>

Make the PavlovServer script executable. (You only need to do this once):

<pre>
chmod +x ~/pavlovserver/PavlovServer.sh
</pre>

----

=== Server Configuration ===

Before starting the server we need to configure it. Start by creating some directories:

<pre>
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Logs
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps
</pre>

==== Mods/Blacklist/Whitelist (optional) ====

The following three files allow you to specify mods, banned players, and whitelist players. These are optional, but go ahead and create them. Populating the files is described later.

<pre>
touch /home/steam/pavlovserver/Pavlov/Saved/Config/mods.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/blacklist.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/whitelist.txt
</pre>

====Configuring Game.ini====
Create a new Game.ini file using following command to open an editor and copy/paste the following block into it then save it. Note not all of these options are required. For instance remove or comment out the Password=0000 line to make a public server with no pin.
<pre>
nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini
</pre>

<pre>
[/Script/Pavlov.DedicatedServer]
bEnabled=true
ServerName="My_private_idaho"
MaxPlayers=10 #Set this to 10 for Shack. 24 is the max for PC, setting it higher will not allow players to join.
ApiKey="ABC123FALSEKEYDONTUSEME"
bSecured=true
bCustomServer=true
bVerboseLogging=false
bCompetitive=false #This only works for SND
bWhitelist=false
RefreshListTime=120
LimitedAmmoType=0
TickRate=90
TimeLimit=60
#Password=0000
#BalanceTableURL="vankruptgames/BalancingTable/main"
MapRotation=(MapId="UGC1758245796", GameMode="GUN")
MapRotation=(MapId="datacenter", GameMode="SND")
MapRotation=(MapId="sand", GameMode="DM")

</pre>

* '''bEnabled''' - whether the server appears in the server list (unconfirmed)
* '''ServerName''' - name it will be listed as. (approx 35 chars max)
* '''MaxPlayers''' - See suggested specs for limits. 10 standard (10 for shack), 20-24 is max recommended for large maps like Stalingrad or PUSH/RUSH modes, and servers allow a maximum of 24 players.
* '''ApiKey''' - Unique ApiKey required to register server with master server. Replace with your key
* '''bSecured''' - enabled Valve Anti-Cheat (VAC)
* '''bCustomServer''' - activates some new modding tools (save and http functions. Required to write to blacklist.txt for bans)
* '''bCompetitive''' - sets the server to competitive mode for SND. If removed the server will default to false
* '''bVerboseLogging''' - enables verbose logging, mostly detailed statistics. Be prepared for significant increase in logging.
* '''bWhitelist''' - Only allow users in whitelist.txt to join
* '''RefreshListTime''' - sets how often the running server checks for updates in ban/whitelist/mod files
* '''LimitedAmmoType''' - sets limited ammo mode
0 = Unlimited
1 = Limited Generic
2 = Limited Specific
3 = Custom (for modders)
4 = Limited Special
5 = Boxless Mode

* '''TimeLimit''' - sets time limit for each map
* '''TickRate''' - sets the server tickrate. (so far minimum stable seems around 50 and max around 120. Beware setting this changes weapon despawn time and breaks some game modes. Recommend not touching)
* '''Password''' - PIN number for server #FYI - this is now also changeable via rcon.
* '''BalanceTableURL''' - Points to a custom balance table from github. See https://github.com/vankruptgames/BalancingTable for instructions. This line isn't needed if you don't have one.
* '''MapRotation''' - you can add multiple of these. The MapId must be “UGC” followed by the map ID. you can find the map id in the URL of the steam workshop page. When a match ends, the server will load the next map in the rotation. You can also use RCON to switch to a map not included in rotation.

Available game modes as of 09/06/2022: SND, TDM, DM, GUN, ZWV, WW2GUN, TANKTDM, KOTH, TTT, OITC, INFECTION, HIDE, PUSH, PH 

And for Shack only: CTF

For maps running a Custom gamemode (CodZ, BR, Duel, etc.) it doesn't matter which gamemode you choose, as the map will automatically override it with the custom mode.

UGC###### are for custom maps from Steam workshop (PC Only). Find the map you want in the workshop. This is the URL for Mirage (https://steamcommunity.com/sharedfiles/filedetails/?id=2670152485). The 10 numbers at the end of the URL are what you need, so UGC1661803933 would be the MapId for Mirage.

==== Firewall/Port forwarding ====
Using the default settings there are two UDP ports (7777, 8177) that need to be allowed to access the server either by firewall setup or port forwarding.

'''Ubuntu''' firewall commands to check firewall and open ports:
<pre>
sudo ufw status
sudo ufw allow 7777
sudo ufw allow 8177
sudo ufw allow 9100
sudo ufw status
</pre>

'''Rocky Linux''' firewall commands to check firewall and open ports:
<pre>
sudo firewall-cmd --zone=public --add-port=7777/tcp
sudo firewall-cmd --zone=public --add-port=7777/udp
sudo firewall-cmd --zone=public --add-port=8177/tcp
sudo firewall-cmd --zone=public --add-port=8177/udp
sudo firewall-cmd --zone=public --add-port=9100/udp
sudo firewall-cmd --zone=public --add-port=9100/tcp
sudo firewall-cmd --list-ports
firewall-cmd --runtime-to-permanent
</pre>

You may also need to allow Pings (ICMP) for the server's true latency to appear in the master list.

If you are running multiple servers and have set additional ports (see http://wiki.pavlov-vr.com/index.php?title=Dedicated_server#Running_multiple_servers_on_one_host) then you need to allow access to the defined port plus the port 400 higher. So if you use 7000 as your port, then UDP 7000 and 7400 need to be open

If you have setup rcon via RconSettings.txt (below) then that port also need to be allowed access via TCP

If you are running Shack/Quest and want to have maps that are downloadable from your server, your server ports (ex. 7777 & 8177) must also be open via TCP

----

==== Shack Maps (Quest) ====

If you try to use the steps above to add maps for Shack, youll run into issues very quickly. This is because Shack has no affiliation to Steam, and therefore cannot use Steam Workshop maps like above. In the future, these steps will apply to PC servers as well, allowing a server to hold the map itself, instead of offloading to Steam.

To get started, first create the directory to hold the maps

<pre>mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps</pre>

You can use any number of methods to move the map files onto the server, but ill go over the two simplest, starting with a GUI approach

Download and install CyberDuck onto your "home" PC (Whatever PC you use for access to the server, but not the server itsself): https://cyberduck.io/

Next, download and unzip your map of choice from https://www.pavlovquest.com/ , https://pavlovhorde.com/mapsList, or look in #shack-map-showcase channel in the discord server. I'm going to use Cheeto's WW2 Items test (http://www.mediafire.com/file/emyt9bs1z9u9ykw/SVR_Cheeto_Items.zip/file ) for this example, you do what you like

In the top left corner, open a connection, set the connection type to SFTP, and fill in the rest of the information. User will be root, password is whatever you set the root pw as (toor in Ubuntu by default)

In the directory dropdown (itll say /root) go back to /

Follow the directories until we arrive back at our "maps" folder <pre>/home/steam/pavlovserver/Pavlov/Saved/maps</pre>

Drag and drop the unzipped map folder into the main window, in this case itll be SVR_Cheeto_Items

Hit Allow

Youll now see a folder named SVR_Cheeto_Items, and within it should be nothing but 3 files. If there is another folder in it, move this folder to the maps directory, otherwise the server wont work. The 3 files (2 .PAK one .JSON) should be in home/steam/pavlovserver/Pavlov/Saved/maps/SVR_Cheeto_Items, no more, no less.

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

To play the map, you can either use RCON switch map command, or to add the map to your servers automatic map rotation list, add the map's folder name to your Game.ini. This replaces the MapID section, so for our example it would be

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

And thats all! Disconnect CyberDuck from your server before playing, otherwise youll have difficulty joining.

-----------

==== Adding Shack Maps over Command Line Interface ====

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

A bit more complicated, but adding maps over CLI has its benefits

First, CD to the maps directory you made above

<pre>cd ~/pavlovserver/Pavlov/Saved/maps</pre>

Download the map files from whatever you use to upload them. To do this, you can either use curl or wget

<pre>curl -O insertURLhere</pre>

'''If you download your map from Google Drive''', make sure that your .zip folder is shared to anyone.
Then, get the file's url from the shared link. Example : ''<nowiki>https://drive.google.com/file/d/19bI8gUHaN5tUrDvnadAacUnchQf6_k/view</nowiki>'' will be ''19bI8gUHaN5tUrDvnadAacUnchQf6_k''
Edit "fileId" and "fileName" before you execute the command.
<pre>
fileId=19bI8gUHaN5tUrDvnadAacUnchQf6_k
fileName=SVR_USER_MAPNAME
curl -sc /tmp/cookie "https://drive.google.com/uc?export=download&id=${fileId}" > /dev/null
code="$(awk '/_warning_/ {print $NF}' /tmp/cookie)"
curl -Lb /tmp/cookie "https://drive.google.com/uc?export=download&confirm=${code}&id=${fileId}" -o ${fileName} </pre>

To keep with the Items example:

<pre>curl -O https://cdn.discordapp.com/attachments/744185280759857234/745027406695366788/SVR_Cheeto_Items.zip</pre>

Next, unzip the file. If this next step errors out, saying the command is unknown, switch back to the root user (su root), and install unzip (sudo apt install unzip), then return to the steam user, and continue.

<pre>unzip SVR_Cheeto_Items.zip</pre>

Now finish like before by adding the map to your Game.ini

<pre>nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini</pre>

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

==== Admin/Moderator list (optional) ====

The only working in-game admin menu is through Arctic VR server hosting (see below).

If you add moderators to your server, they will not be subject to vote kicks.

<pre>
nano ~/pavlovserver/Pavlov/Saved/Config/mods.txt
</pre>

Example Mod List:
<pre>
76541198397498572 #Optional Comment: Player name
76541198397498573 #Some Other Player
</pre>

==== ArcticVR Admin Menu ====

[[File:Arcticmenu.jpg|500px|link=https://www.arctic-vr.com/server-admin-menu]]

Arctic-VR Offers an advanced In-Game Admin menu that is exclusive to their hosting service. Features include:
* Switch Maps+Modes
* Teleport Players to Players
* Change Player Skins
* Control Player Buying+Cash
* Spawn Items
* Clean up corpses + guns
* Spawn Bots
* Spawn Items for other players
* Control Teams + Balance/Shuffle Teams
* ResetSND
* And More

You can read more about the ArcticVR admin menu on their website: https://www.arctic-vr.com/server-admin-menu

==== Handy tools for finding steamIDs ====

Steam ID finder: https://steamidfinder.com/lookup/ or https://steamid.xyz/

You want to enter in the steamID64 format.

This tool can convert or lookup IDs: https://steamid.io/

If you are looking for a steamID of a player that has been on your server recently this is technique to find them:
<pre>
grep -i playername ~/pavlovserver/Pavlov/Saved/Logs/* | grep TicketValidation
</pre>

=== Configure Rcon ===
To enable Rcon access create config file:
<pre> nano /home/steam/pavlovserver/Pavlov/Saved/Config/RconSettings.txt </pre>

Copy in the following text - change password, and if desired the port:
<pre>
Password=ChangeThisPassword
Port=9100
</pre>
You must specify a port for the Rcon server to use as well as a Password (use a different port per sever instance if running multiple server instances off the same hardware)

=== Starting the server ===

<pre>
cd ~/pavlovserver && ./PavlovServer.sh
</pre>

That's it, your server will be automatically broadcast to the master server! :)

Two handy tools to determine quickly if your server is broadcasting are [https://pablub.xyz/ Pablub] (PC only) and [https://pavlovhorde.com/ Horde] (Shack) and [https://pavlovhorde.com/pcServers Horde] (PC version)

Note that when you close your terminal, the server will go down. See the "supervisors" section below for how to prevent this.

=== Auto-updating the server ===

Assuming you have followed this guide and used the default paths, users, and install instructions, you can paste the following into your terminal to auto-update your Pavlov server:

<pre>
cat << 'EOF' > $HOME/pavlov_daily_update_and_restart.sh
#!/bin/bash

USER="steam"
SERVICENAME="pavlovserver.service"
INSTALLDIRNAME="pavlovserver"
USERHOME="/home/$USER"

echo -e "Beginning Pavlov VR update run on $(date)\n\n"

systemctl stop "$SERVICENAME"

sleep 5
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +force_install_dir "$USERHOME/$INSTALLDIRNAME" +app_update 622970 +exit
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +app_update 1007 +quit
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/.steam/sdk64/steamclient.so"
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/pavlovserver/Pavlov/Binaries/Linux/steamclient.so"

systemctl start "$SERVICENAME"

echo -e "Ending Pavlov VR update run on $(date)\n\n"

EOF

chmod +x $HOME/pavlov_daily_update_and_restart.sh
mkdir $HOME/pavlov_update_logs && touch $HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log
CRONLINE="00 2 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
(sudo crontab -u root -l; echo "$CRONLINE" ) | sudo crontab -u root -
unset CRONLINE

</pre>

These commands will:

1. Create a shell script in the "steam" user's home directory that automatically stops the Pavlov server, pulls any updates via steam, pull updates to the Steamworks SDK Redist, and copies the latest version of steamclient.so to the Pavlov server directory

2. Make the shell script executable

3. Create a new directory called "pavlov_update_logs" in the "steam" user's directory, and create a logfile inside that directory called "pavlov_daily_update_and_restart.sh.log". You can check this logfile to see the output of the Pavlov and Steam SDK update commands.

4. Create a crontab entry for the root user that runs this shell script automatically every day at 2:00AM local time

If you want to change the time that this script runs, edit the numbers "00 2" in the line that starts with "CRONLINE=". In the example provided, 00 is the minutes column, and 2 is the hour column. For example, if you wanted the server to automatically update and restart at 4:17AM every day, change the line starting with "CRONLINE=" to:

<pre>
CRONLINE="17 4 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
</pre>

If the time is PM, use 24-hour time format, e.g. "32 18" for 6:32PM.

----

=== Supervising the server using systemd ===

Running '''./PavlovServer.sh''' in your interactive shell is easy, but the server will shut down when you close your terminal. If you want to run the server in the background,
you'll want to run it under a supervisor. There are many options, ranging from the simple (nohup, screen or tmux), to the
more robust (supervisord, systemd).

Systemd is running by default on Ubuntu Linux, so we'll use that here.

To run the server as a systemd service, create the file '''/etc/systemd/system/pavlovserver.service''' (as root) by typing
<pre>
sudo nano /etc/systemd/system/pavlovserver.service
</pre>

Copy contents below into the file and save.

<pre>
[Unit]
Description=Pavlov VR dedicated server

[Service]
Type=simple
WorkingDirectory=/home/steam/pavlovserver
ExecStart=/home/steam/pavlovserver/PavlovServer.sh

RestartSec=1
Restart=always
User=steam
Group=steam

[Install]
WantedBy = multi-user.target
</pre>

If you'd like your server to start as competitive without editing the game.ini, change the line "ExecStart=/home/steam/pavlovserver/PavlovServer.sh" to look like this below. Though it's much easier to just use the game.ini to enable competitive instead. <pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -COMPETITIVE=1</pre>

Change the user or paths as appropriate. After saving the service file, to start, restart, stop, or monitor the server:

<pre>
sudo systemctl start pavlovserver
sudo systemctl restart pavlovserver
sudo systemctl stop pavlovserver
sudo systemctl status pavlovserver
</pre>

To view the logs:

<pre>
sudo journalctl -u pavlovserver
# to live-tail the logs
sudo journalctl -u pavlovserver -f
</pre>

If you want to run the pavlov server as soon as your server boots (e.g. a VPS you turn on and off), add pavlov as a startup service:

<pre>
sudo systemctl enable pavlovserver
</pre>

----

== Advanced Server Administration ==

=== Running multiple servers on one host ===

* Pavlovserver is functionally single threaded (there are multiple threads, but vast majority of work occurs in the primary one). Make sure you have # of pavlovservers + 1 CPU available. More CPUs= more servers. Faster CPU = more players.
* Make multiple server installs by defining a separate install dir for each server.
* Run each server with a unique port. eg: '''./PavlovServer.sh -PORT="Desired Port"'''
* The Server will use the Desired Port and the Port 400 above (Example: You choose 8200 as Port. So Port 8600 will be used as well)
* If you are using RCON, each server will need a unique port defined in RconSettings.txt
* Ensure the ports are forwarded and opened in your firewall

To duplicate directories:

be in the steam home folder
<pre>
cp -r pavlovserver pavlovserver1
/home/steam/pavlovserver1/PavlovServer.sh -PORT=[Desired Port]
</pre>

=== Starting server in competitive mode ===
Competitive mode will prevent dead teammates from being able to see the match, to prevent ghosting.
You can either enable this via Game.ini (described in Game.ini file), or using the -COMPETITIVE=1 parameter.

<pre>
/home/steam/pavlovserver1/PavlovServer.sh -COMPETITIVE=1
</pre>

<nowiki><hr></nowiki>

=== Automated RCON ===
here are some examples of scripts that interact with Pavlov RCON

'''<big>Inspect players every 5 minutes</big>''' [https://github.com/JTWP-org/inspect-every-5-mins/blob/main/log/inspectPlayer-04-23-2023-21-50.demo.json (installation instructions on GITHUB )]

This [https://www.gnu.org/software/bash/ BASH] script will collect current players stats for every one. then it will write them to a log in JSON format that can easily be handled for your records or the next project ..

below is all the info that will be collected every 5

"PlayerName": "Salted Cracker Jack",

"UniqueId": "76561198210003277",
{| class="wikitable"
|+
|PLAYERS NAME
|Salted Cracker Jack
|-
|
|
|-
|
|
|}
"KDA": "27/0/18",

"Score": "72",

"Dead": false,

"Cash": "13000",

"TeamId": "1"

=== Pending Restart ===
when this [https://www.gnu.org/software/bash/ BASH] script is triggered it will start a loop that checks every 15 mins if the server is empty and

----

=== Useful Linux Commands ===

List files / folders in directory, print current working directory,
<pre>ls -la #list files/directories along with authorities and ownership
pwd #print working directory
sudo chown <owner> <file/directory> #change owner of file/directory. If root created something and you need to change it to steam
sudo chgrp <group> <file/directory> #change group of file/directory.
</pre>

Check if pavlov is running by checking process status. If the only row you see is the grep command, pavlov server is not started.
<pre> ps -ef | grep pav </pre>

Sample output:
<pre>
steam 34044 1 0 16:52 ? 00:00:00 /bin/sh /home/steam/pavlovserver/PavlovServer.sh
steam 34066 34044 80 16:52 ? 00:00:04 /home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer
zombies+ 34101 34013 0 16:52 pts/0 00:00:00 grep --color=auto pav
</pre>

Kill a process. Note this command uses 34044, which is a process id from the command output above.
<pre> kill -9 34044 </pre>

Dump the log to the console so you can scroll through it:
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log </pre>

Search the log for a string - replace my_string with case-sensitive string
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep my_string </pre>

=== Default Map ID's ===
datacenter

sand

bridge

containeryard

siberia (Prison Break)

hospital (Zombies map)

killhouse

range

tutorial

santorini

station

industry

ogcontainers (Shack only)

haguenau (Shack only)

foundation (Shack only)

stalingrad (PC only)

stalingrad_night (PC only)

santorini_night (PC only)

sand_night (PC only)

station_night (PC only)

industry_night (PC only)

bunker (PC only)

=== Automated server log backup ===

here is how to setup a bash script to 1x a day compress all log files and save them to protect from auto deletion it will also post a discord webhook to confirm its working and saved the days logs

https://github.com/JTWP-org/backUpLogs

== Troubleshooting ==

To run the server without outputting the heartbeat:

<pre>./PavlovServer.sh | sed '/heartbeat/d'</pre>

To monitor the logs (without heartbeat) from another terminal:

<pre>tail -f -n10000 /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep -v 'Sending heartbeat to masterserver'</pre>

Check your CPU Clock Speed with:

<pre>lscpu | grep MHz</pre>

=== Server won't start ===

Error message:
<pre>
ln: failed to create hard link '/home/steam/.steam/sdk64/steamclient.so': File exists
ln: failed to create hard link '/home/steam/pavlovserver/Pavlov/Binaries/Linux/steamclient.so': File exists
/home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer: error while loading shared libraries: libc++.so.1: cannot open shared object file: No such file or directory
</pre>

First two errors are harmless. The third one is because libc++ step was skipped or failed. Using sudo capable id (probably not steam id), [re]run this line:
<pre>sudo apt update && sudo apt install -y gdb curl lib32gcc1 libc++-dev unzip </pre>

=== Map wont load (kicks to datacenter) ===

try deleting all the downloaded workshop maps with:

<pre>sudo rm -rf /tmp/workshop/7777/content/555160/*</pre> for all maps or

<pre>sudo rm -rf /tmp/workshop/7777/content/555160/whatever-UGC</pre> for specific map

=== Map wont load when running in a container ===
The three typical container problems I have seen:

1) Steam can't write to /tmp for some reason

2) /tmp is actually tmpfs instead of real filesystem and a few gigs of maps runs you out of RAM

3) Made worse by fact that pavlovserver unpacks downloads to ram, then writes to /tmp/workshop. Not enough RAM to do this, no map for you.

=== Server stuck rotating forever ===

Run these 2 commands, then restart your server:

<pre>cd ~/Steam && ./steamcmd.sh +login anonymous +app_update 1007 +quit
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so</pre>

If this doesn't fix it, double check that your server isn't running on the same port as another, by running this command:

<pre>ps -ef | grep pav</pre>

Then if 2 servers are on the same port, you can fix it by editing the pavlovserver.service file, and making sure the following line:

<pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -PORT=Number</pre>

has a unique number after the port for each server you're running.

=== Server - ping 999 ===
Google Cloud Platform - Make sure your compute engine has a network tag and your network rules are applied to the tag.
Make sure you opened the specified ports.

Network testing tools:
Test if your server will respond to ping from outside your network:
https://www.wormly.com/test-remote-ping

Test if your ports are accessible via UDP (7777,8177,9100):
https://www.ipvoid.com/udp-port-scan/

=== Can't connect to RCON ===
Check the file and group owner of RconSettings file. It should be steam, or the ID used to run the pavlov server.
<pre>
cd /home/steam/pavlovserver/Pavlov/Saved/Config
ls -la
</pre>

If the owner/group are not steam, using root or an id with sudo authority, change them to steam, confirm they are now set properly, then restart the pavlov server. (Note - if Rcon has wrong permissions, after fixing you should also to check the other config files like Game.ini, mods/blacklist/whitelist for the same issue. If steam can't access these files, it could cause problems.).
<pre>
cd /home/steam/pavlovserver/Pavlov/Saved/Config
sudo chown steam RconSettings.txt
sudo chgrp steam RconSettings.txt
ls -la </pre>

=== PC ONLY - Map Download stops ===

When downloading a large map from the steam workshop make sure your VPS/Dedi or Shared hosting provider (Otherwise known as a GSP's) has enough RAM assigned to store the map files in its tempfs (stored in ram)!

This is less likely to happen on Dedicated servers and VPS with a decent amount of ram unless you are using docker with RAM limits!

Most GSP's will be using docker or some other type of jailing method to limit system resource allocations and direct access to the host machine, if they are and you know what map you want to use make sure you order a service with enough ram to store your map. If in doubt contact your GSP's support team.

=== Getting Help ===

There's a #pc-custom-servers channel on the official Pavlov Discord - https://discord.gg/Pavlov-VR. Lots of helpful people there!

Setting up a dedicated server

2023-05-26T01:00:32Z

SaltedCrackerJack: /* Advanced Server Administration */

== Setting up a dedicated server ==

'''There are no Windows binaries'''

This guide is written exclusively for Linux and covers Ubuntu/Debian/Debian-like and Red Hat RPM-based distros. Possible to run with other distros, but some of the commands won't work and you will need to know enough to figure out the software install of dependencies on your own.

If you are considering hosting from home, please read that section of the wiki first.

This guide assumes you know the basics of using a bash terminal: ssh'ing into a server, running bash commands, editing text files, etc.

If you have no experience using bash, maybe start [https://www.howtogeek.com/140679/beginner-geek-how-to-start-using-the-linux-terminal/ here]. Editing text files via commandline is often a challenge. Suggest using nano and reading guide [https://www.howtogeek.com/howto/42980/the-beginners-guide-to-nano-the-linux-command-line-text-editor/ here]

If you are new to linux and accessing your server from Windows, highly suggest using MobaXterm as your SSH client as that can make required editing of text files easier using built in editor instead of the native linux command line editors.

And finally, ask yourself why you want to setup a server? If you look at the list, there are many, many more servers than players. If you don't have a team, discord community, or group of friends ready to play on your server, chances are it will go unused. Got one of these... great, let's go.

If you don't want to go through the hassle yourself and want to pay for a hosting service Arctic VR (PC and Shack) and Horde (Shack) provide a server hosting services and are trusted in the community. See links below.

----

=== Server Requirements ===

'''Pavlovserver can only be hosted under Linux.'''

This can be running as a VM under windows, but this will increase the complexity of the setup beyond this guide.

Ubuntu 18.04 x86_64, Ubuntu 19/04 amd64, Ubuntu 20.04, and Rocky Linux 8 are confirmed working. Ubuntu 15.04 x86 is known to fail to install using this guide. Recommend not running on "minimal" images as some tools are missing.

* 2GB RAM + 1GB RAM per each additional server with 10 players. More RAM is recommended for larger maps, higher player counts, or complex gamemodes. Not having enough RAM is a common cause of server crashes.

* A ~2.5Ghz CPU will comfortably support a 10 player server.

* A ~4Ghz CPU will comfortably support 24 players. This is a limit built into Pavlov itself, no server will allow players to join over 24. Lower player counts are recommended for complex gamemodes (E.g. CodZ) and/or highly detailed maps, so that maximum number will often be lower.

(Note that these are '''not''' hard limits for player counts, just suggestions for the best performance, based on experiences with many server providers on different grades of hardware.)

* Pavlovserver is functionally single threaded (one thread does vast majority of work). More CPUs only help if you are running more servers. More clockspeed = higher performance = more users per server.
The maximum number of servers you can run is dependent on how many CPUs you have. For example, if you have an 8 core CPU, the maximum number of servers would be 7. You should always have at least one CPU free as overhead, as Pavlov servers can use slightly more than one thread.

----

==== Hosting at home ====
When hosting at home there are additional requirements regarding networking: Your router has to support port-forwarding, hair-pinning/LoopbackNAT, and respond to ping requests. These techniques are necessary to allow your server to be found and to talk back to the client. please see https://en.wikipedia.org/wiki/Port_forwarding, https://en.wikipedia.org/wiki/Hairpinning, and https://www.speedguide.net/faq/how-to-become-pingable-behind-a-routerfirewall-376 for more info and google for these terms in addition to your router model to find guides on how to enable/configure it properly. If you have modern Router, it may have these features already enabled, in this case you just have to configure port-forwarding. If you can see your server but not join it while others can, this is indicative of a failure of LoopbackNAT.

A second challenge to hosting at home is CGNAT (Carrier grade NAT: https://www.a10networks.com/blog/carrier-grade-nat/). Just like NAT on your home network that has to be gotten around w/ port-forwarding, CGNAT breaks the ability of external connections to be made back to your server, but the controls are solely in your ISPs hands. Sometimes if you ask, you can be removed from CGNAT pools and/or assigned a static IP. CGNAT rollouts are becoming very common now, so if your server worked then doesn't allow connections now, your ISP may have made this change.

You can check whether you’re on a CGNAT network by visiting a Web site such as ipaddress.com or whatsmyip.com and comparing the IP address listed to the public/WAN IP address assigned to your Internet gateway. To find your gateway’s public IP address, check the status page in the administrative interface. If the two IP addresses differ, you’re likely on a CGNAT network. If so, this problem must be resolved before you go any further.

'''Not understanding these requirements and configuration is a frequent cause of failed setups and questions in discord. Don't skip this if you are trying to host from home'''

'''There are serious security implications of hosting this software at home.''' None of the devs are security experts and there has been no security review of the code. You are opening up your system to the world and publicity advertising this fact. Expect that any system hosting this software is open to compromise from the Internet and act accordingly. If your router offers a DMZ network, use it. Consider hosting on a cloud based server and think twice before running this software on any system that contains data you care about or has access to networks and computers you care about.

If you're hosting at home using Oracle's VirtualBox, there are steps you can take to prevent double NAT (which can cause issues later on)

1. Select your VM and then click Settings in VirtualBox's main window.

2. Click on Network and change Attached To from NAT to Bridged Adapter.

Once you've done this, your VM should be connected directly to your home router and double NAT should no longer be a issue.
----

==== Hosting Providers ====

Considering the suggested server specs, you may be interested in the following hosting providers. For providers promising dedicated "Pavlov hosting" as opposed to general VPS services please contact and ask how you change maps being hosted and how you get RCON access before you put your money down.

<pre>
Provider | Base CPU | Details
Arctic VR | 4.5 GHz | https://www.arctic-vr.com/server-hosting
Amazon Web Services | 4.0 GHz | https://aws.amazon.com/ec2/instance-types/z1d/
VULTR | 4.0 GHz | https://www.vultr.com/products/high-frequency-compute/
packet.com | 3.5 GHz | https://www.packet.com/cloud/servers/c1-small/
Google Cloud Platform | 3.2 GHz | https://cloud.google.com/compute/docs/cpu-platforms
</pre>

===== ARCTIC VR =====

Arctic VR is the largest and longest running Pavlov VR hosting provider. The In-Game Admin Menu is exclusive to the ArcticVR hosting service. They offer EU, NA East and NA West servers for both shack and PCVR. ArcticVR offers the fastest Pavlov servers as well as DDos Protection, RCON remote management, custom maps, low pings, unlimited slots, and expert support.

Website: https://www.arctic-vr.com/server-hosting

[[File:Arctic_options.png|link=https://www.arctic-vr.com/server-hosting|700px]]

===== VULTR =====

Consider using a referral from the community:

Carlos: https://www.vultr.com/?ref=8615589-6G

Carrot: https://www.vultr.com/?ref=8689348

Archaeo: https://www.vultr.com/?ref=8653652-6G

Cheeto: https://www.vultr.com/?ref=8717358

For a Pavlov Shack server, I recommend minimum Cloud Compute, Intel High Performance, Ubuntu 20.04, and disabled automatic backups. At the time, this was $6/m. Some of the cheap options have 1TB bandwidth, and some have 2TB+. If it's a personal server, 1TB could be fine, but 2TB should be safe.

===== Google Cloud Platform (90 day free credit available) =====

The below configuration is successfully running 4 pavlov PC instances with ~15 total maps and up to 24 players per server. If you want more maps use larger boot disk. Both can dynamically be scaled based on popularity.

<pre>

Menu -> compute engine -> VM instances
create instance
- region: wherever you like
- machine type: n1-highcpu-4 (4 vCPUs, 3.6 GB memory)
- boot disk: Ubuntu 20.04
- boot disk -> size: 25gb
- network tags: pavlov-server
- [create]

Menu -> Vpc network -> firewall rules
[Create firewall rule]
Name: pavlov server
Target Tags: pavlov-server
Source IP Ranges: 0.0.0.0/0
Protocols and Ports -> Specified protocols and ports -> UDP: 7777, 8177 (Shack and PC)
Protocols and Ports -> Specified protocols and ports -> TCP: 7777, 8177 (Shack-only)
Protocols and Ports -> Specified protocols and ports -> TCP: {RCON port - default 9100}
[save]
</pre>

===== Amazon Web Services (30 day free credit available) =====

<pre>
Login -> Change Region: Choose your region
Services -> Compute -> EC2 -> Create
Choose an AMI: Ubuntu 18.04
Instance Type: z1d.large

Instance Details -> Tenancy: Dedicated (optional: this will more than triple the cost)

Storage: 50gb disk (or whatever, you're in control of the map roster)

Security Groups:
Create a new Security Group
Security group name: pavlov-server
Description: pavlov server
Rules:
Type: Custom ICMP Rule - IPV4 / Protocol: Echo Request
Type: Custom UDP Rule / Port Range: 7777 / Source: 0.0.0.0/0
Type: Custom UDP Rule / Port Range: 8177 / Source: 0.0.0.0/0
Type: SSH (optional, but I assume you wanna SSH in..)

Launch -> Create new Keypair -> Download -> Launch

Once it's started, SSH in like:
$ ssh -i your-key.pem ubuntu@you-server-details.amazonaws.com

(I use cmder on Windows, if you're using putty or mobaxterm or something, might be different)
</pre>

=== Starting Server Install ===

====Obtaining an ApiKey====
For your server to show up in the server list, there is now a requirement to have an ApiKey issued by vankrupt. This is to prevent DOS attacks against the master server

Get the key by going here: https://pavlov-ms.vankrupt.com/servers/v1/key and using your mobile number to get a SMS
(note that there have been reported failures of this SMS system for non-US mobiles. In this case DM davevillz your mobile and ask for a key)

Put this key in your Game.ini as follows:
ApiKey="ABC123FALSEKEYDONTUSEME"
or if you would like (personally untested..I would use game.ini) you can call it at server runtime with flag as follows:
-KEY="ABC123FALSEKEYDONTUSEME"

This key can be re-used for a reasonable number of servers (a limit of 10 has been mentioned). Contact the Devs if you need more servers per key.

====System setup and software installation====

Install dependencies and create the `steam` user. (You only need to do this once):

Confirm Linux version
<pre>
lsb_release -a
</pre>

'''Ubuntu 20.04'''
<pre>
sudo apt update && sudo apt install -y gdb curl lib32gcc1 libc++-dev unzip
sudo useradd -m steam
</pre>

'''Ubuntu 20.10 or higher'''
<pre>
sudo apt update && sudo apt install -y gdb curl lib32gcc-s1 libc++-dev unzip
sudo useradd -m steam
</pre>

'''Rocky Linux, CentOS 8, and RHEL 8'''

<pre>
sudo sed -i 's/^SELINUX=enforcing$/SELINUX=permissive/g' /etc/selinux/config
sudo setenforce 0
sudo yum install gdb curl glibc.i686 libstdc++.i686 libstdc++-devel.i686 libstdc++-devel.x86_64 unzip wget -y
wget https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/l/libcxx-3.8.0-3.el7.x86_64.rpm
sudo rpm -i libcxx-3.8.0-3.el7.x86_64.rpm
sudo useradd -m steam
</pre>

[Optional] Set a password for steam.
<pre>sudo passwd steam</pre>

Login as the steam user. ('''You will need to do this each time you connect to your server'''):

<pre>
sudo su -l steam
</pre>

Install Steam:

<pre>
mkdir ~/Steam && cd ~/Steam && curl -sqL "https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz" | tar zxvf -
</pre>

There are different dedicated server versions for Pavlov Server - choose which server version you want to host (PC non-beta, PC Beta, Shack Live, or Shack RC)
(You will need to run this command each time there is a Pavlov Server update). 
To host '''PC Server (non-beta)''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 +exit
</pre>

To host '''PC BETA''':

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta beta_server +exit
</pre>

To host '''Shack Live''' (Quest):

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack +exit
</pre>

To host '''Shack RC''' (Quest): 

<pre>
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack_beta +exit
</pre>

Now that we've installed the server, all pavlov server versions should continue. 
Install a fresh copy of steamclient.so (May have to do this after each update):
<pre>
~/Steam/steamcmd.sh +login anonymous +app_update 1007 +quit
mkdir -p ~/.steam/sdk64
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/pavlovserver/Pavlov/Binaries/Linux/steamclient.so
</pre>

Make the PavlovServer script executable. (You only need to do this once):

<pre>
chmod +x ~/pavlovserver/PavlovServer.sh
</pre>

----

=== Server Configuration ===

Before starting the server we need to configure it. Start by creating some directories:

<pre>
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Logs
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps
</pre>

==== Mods/Blacklist/Whitelist (optional) ====

The following three files allow you to specify mods, banned players, and whitelist players. These are optional, but go ahead and create them. Populating the files is described later.

<pre>
touch /home/steam/pavlovserver/Pavlov/Saved/Config/mods.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/blacklist.txt
touch /home/steam/pavlovserver/Pavlov/Saved/Config/whitelist.txt
</pre>

====Configuring Game.ini====
Create a new Game.ini file using following command to open an editor and copy/paste the following block into it then save it. Note not all of these options are required. For instance remove or comment out the Password=0000 line to make a public server with no pin.
<pre>
nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini
</pre>

<pre>
[/Script/Pavlov.DedicatedServer]
bEnabled=true
ServerName="My_private_idaho"
MaxPlayers=10 #Set this to 10 for Shack. 24 is the max for PC, setting it higher will not allow players to join.
ApiKey="ABC123FALSEKEYDONTUSEME"
bSecured=true
bCustomServer=true
bVerboseLogging=false
bCompetitive=false #This only works for SND
bWhitelist=false
RefreshListTime=120
LimitedAmmoType=0
TickRate=90
TimeLimit=60
#Password=0000
#BalanceTableURL="vankruptgames/BalancingTable/main"
MapRotation=(MapId="UGC1758245796", GameMode="GUN")
MapRotation=(MapId="datacenter", GameMode="SND")
MapRotation=(MapId="sand", GameMode="DM")

</pre>

* '''bEnabled''' - whether the server appears in the server list (unconfirmed)
* '''ServerName''' - name it will be listed as. (approx 35 chars max)
* '''MaxPlayers''' - See suggested specs for limits. 10 standard (10 for shack), 20-24 is max recommended for large maps like Stalingrad or PUSH/RUSH modes, and servers allow a maximum of 24 players.
* '''ApiKey''' - Unique ApiKey required to register server with master server. Replace with your key
* '''bSecured''' - enabled Valve Anti-Cheat (VAC)
* '''bCustomServer''' - activates some new modding tools (save and http functions. Required to write to blacklist.txt for bans)
* '''bCompetitive''' - sets the server to competitive mode for SND. If removed the server will default to false
* '''bVerboseLogging''' - enables verbose logging, mostly detailed statistics. Be prepared for significant increase in logging.
* '''bWhitelist''' - Only allow users in whitelist.txt to join
* '''RefreshListTime''' - sets how often the running server checks for updates in ban/whitelist/mod files
* '''LimitedAmmoType''' - sets limited ammo mode
0 = Unlimited
1 = Limited Generic
2 = Limited Specific
3 = Custom (for modders)
4 = Limited Special
5 = Boxless Mode

* '''TimeLimit''' - sets time limit for each map
* '''TickRate''' - sets the server tickrate. (so far minimum stable seems around 50 and max around 120. Beware setting this changes weapon despawn time and breaks some game modes. Recommend not touching)
* '''Password''' - PIN number for server #FYI - this is now also changeable via rcon.
* '''BalanceTableURL''' - Points to a custom balance table from github. See https://github.com/vankruptgames/BalancingTable for instructions. This line isn't needed if you don't have one.
* '''MapRotation''' - you can add multiple of these. The MapId must be “UGC” followed by the map ID. you can find the map id in the URL of the steam workshop page. When a match ends, the server will load the next map in the rotation. You can also use RCON to switch to a map not included in rotation.

Available game modes as of 09/06/2022: SND, TDM, DM, GUN, ZWV, WW2GUN, TANKTDM, KOTH, TTT, OITC, INFECTION, HIDE, PUSH, PH 

And for Shack only: CTF

For maps running a Custom gamemode (CodZ, BR, Duel, etc.) it doesn't matter which gamemode you choose, as the map will automatically override it with the custom mode.

UGC###### are for custom maps from Steam workshop (PC Only). Find the map you want in the workshop. This is the URL for Mirage (https://steamcommunity.com/sharedfiles/filedetails/?id=2670152485). The 10 numbers at the end of the URL are what you need, so UGC1661803933 would be the MapId for Mirage.

==== Firewall/Port forwarding ====
Using the default settings there are two UDP ports (7777, 8177) that need to be allowed to access the server either by firewall setup or port forwarding.

'''Ubuntu''' firewall commands to check firewall and open ports:
<pre>
sudo ufw status
sudo ufw allow 7777
sudo ufw allow 8177
sudo ufw allow 9100
sudo ufw status
</pre>

'''Rocky Linux''' firewall commands to check firewall and open ports:
<pre>
sudo firewall-cmd --zone=public --add-port=7777/tcp
sudo firewall-cmd --zone=public --add-port=7777/udp
sudo firewall-cmd --zone=public --add-port=8177/tcp
sudo firewall-cmd --zone=public --add-port=8177/udp
sudo firewall-cmd --zone=public --add-port=9100/udp
sudo firewall-cmd --zone=public --add-port=9100/tcp
sudo firewall-cmd --list-ports
firewall-cmd --runtime-to-permanent
</pre>

You may also need to allow Pings (ICMP) for the server's true latency to appear in the master list.

If you are running multiple servers and have set additional ports (see http://wiki.pavlov-vr.com/index.php?title=Dedicated_server#Running_multiple_servers_on_one_host) then you need to allow access to the defined port plus the port 400 higher. So if you use 7000 as your port, then UDP 7000 and 7400 need to be open

If you have setup rcon via RconSettings.txt (below) then that port also need to be allowed access via TCP

If you are running Shack/Quest and want to have maps that are downloadable from your server, your server ports (ex. 7777 & 8177) must also be open via TCP

----

==== Shack Maps (Quest) ====

If you try to use the steps above to add maps for Shack, youll run into issues very quickly. This is because Shack has no affiliation to Steam, and therefore cannot use Steam Workshop maps like above. In the future, these steps will apply to PC servers as well, allowing a server to hold the map itself, instead of offloading to Steam.

To get started, first create the directory to hold the maps

<pre>mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps</pre>

You can use any number of methods to move the map files onto the server, but ill go over the two simplest, starting with a GUI approach

Download and install CyberDuck onto your "home" PC (Whatever PC you use for access to the server, but not the server itsself): https://cyberduck.io/

Next, download and unzip your map of choice from https://www.pavlovquest.com/ , https://pavlovhorde.com/mapsList, or look in #shack-map-showcase channel in the discord server. I'm going to use Cheeto's WW2 Items test (http://www.mediafire.com/file/emyt9bs1z9u9ykw/SVR_Cheeto_Items.zip/file ) for this example, you do what you like

In the top left corner, open a connection, set the connection type to SFTP, and fill in the rest of the information. User will be root, password is whatever you set the root pw as (toor in Ubuntu by default)

In the directory dropdown (itll say /root) go back to /

Follow the directories until we arrive back at our "maps" folder <pre>/home/steam/pavlovserver/Pavlov/Saved/maps</pre>

Drag and drop the unzipped map folder into the main window, in this case itll be SVR_Cheeto_Items

Hit Allow

Youll now see a folder named SVR_Cheeto_Items, and within it should be nothing but 3 files. If there is another folder in it, move this folder to the maps directory, otherwise the server wont work. The 3 files (2 .PAK one .JSON) should be in home/steam/pavlovserver/Pavlov/Saved/maps/SVR_Cheeto_Items, no more, no less.

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

To play the map, you can either use RCON switch map command, or to add the map to your servers automatic map rotation list, add the map's folder name to your Game.ini. This replaces the MapID section, so for our example it would be

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

And thats all! Disconnect CyberDuck from your server before playing, otherwise youll have difficulty joining.

-----------

==== Adding Shack Maps over Command Line Interface ====

Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''

A bit more complicated, but adding maps over CLI has its benefits

First, CD to the maps directory you made above

<pre>cd ~/pavlovserver/Pavlov/Saved/maps</pre>

Download the map files from whatever you use to upload them. To do this, you can either use curl or wget

<pre>curl -O insertURLhere</pre>

'''If you download your map from Google Drive''', make sure that your .zip folder is shared to anyone.
Then, get the file's url from the shared link. Example : ''<nowiki>https://drive.google.com/file/d/19bI8gUHaN5tUrDvnadAacUnchQf6_k/view</nowiki>'' will be ''19bI8gUHaN5tUrDvnadAacUnchQf6_k''
Edit "fileId" and "fileName" before you execute the command.
<pre>
fileId=19bI8gUHaN5tUrDvnadAacUnchQf6_k
fileName=SVR_USER_MAPNAME
curl -sc /tmp/cookie "https://drive.google.com/uc?export=download&id=${fileId}" > /dev/null
code="$(awk '/_warning_/ {print $NF}' /tmp/cookie)"
curl -Lb /tmp/cookie "https://drive.google.com/uc?export=download&confirm=${code}&id=${fileId}" -o ${fileName} </pre>

To keep with the Items example:

<pre>curl -O https://cdn.discordapp.com/attachments/744185280759857234/745027406695366788/SVR_Cheeto_Items.zip</pre>

Next, unzip the file. If this next step errors out, saying the command is unknown, switch back to the root user (su root), and install unzip (sudo apt install unzip), then return to the steam user, and continue.

<pre>unzip SVR_Cheeto_Items.zip</pre>

Now finish like before by adding the map to your Game.ini

<pre>nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini</pre>

<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>

==== Admin/Moderator list (optional) ====

The only working in-game admin menu is through Arctic VR server hosting (see below).

If you add moderators to your server, they will not be subject to vote kicks.

<pre>
nano ~/pavlovserver/Pavlov/Saved/Config/mods.txt
</pre>

Example Mod List:
<pre>
76541198397498572 #Optional Comment: Player name
76541198397498573 #Some Other Player
</pre>

==== ArcticVR Admin Menu ====

[[File:Arcticmenu.jpg|500px|link=https://www.arctic-vr.com/server-admin-menu]]

Arctic-VR Offers an advanced In-Game Admin menu that is exclusive to their hosting service. Features include:
* Switch Maps+Modes
* Teleport Players to Players
* Change Player Skins
* Control Player Buying+Cash
* Spawn Items
* Clean up corpses + guns
* Spawn Bots
* Spawn Items for other players
* Control Teams + Balance/Shuffle Teams
* ResetSND
* And More

You can read more about the ArcticVR admin menu on their website: https://www.arctic-vr.com/server-admin-menu

==== Handy tools for finding steamIDs ====

Steam ID finder: https://steamidfinder.com/lookup/ or https://steamid.xyz/

You want to enter in the steamID64 format.

This tool can convert or lookup IDs: https://steamid.io/

If you are looking for a steamID of a player that has been on your server recently this is technique to find them:
<pre>
grep -i playername ~/pavlovserver/Pavlov/Saved/Logs/* | grep TicketValidation
</pre>

=== Configure Rcon ===
To enable Rcon access create config file:
<pre> nano /home/steam/pavlovserver/Pavlov/Saved/Config/RconSettings.txt </pre>

Copy in the following text - change password, and if desired the port:
<pre>
Password=ChangeThisPassword
Port=9100
</pre>
You must specify a port for the Rcon server to use as well as a Password (use a different port per sever instance if running multiple server instances off the same hardware)

=== Starting the server ===

<pre>
cd ~/pavlovserver && ./PavlovServer.sh
</pre>

That's it, your server will be automatically broadcast to the master server! :)

Two handy tools to determine quickly if your server is broadcasting are [https://pablub.xyz/ Pablub] (PC only) and [https://pavlovhorde.com/ Horde] (Shack) and [https://pavlovhorde.com/pcServers Horde] (PC version)

Note that when you close your terminal, the server will go down. See the "supervisors" section below for how to prevent this.

=== Auto-updating the server ===

Assuming you have followed this guide and used the default paths, users, and install instructions, you can paste the following into your terminal to auto-update your Pavlov server:

<pre>
cat << 'EOF' > $HOME/pavlov_daily_update_and_restart.sh
#!/bin/bash

USER="steam"
SERVICENAME="pavlovserver.service"
INSTALLDIRNAME="pavlovserver"
USERHOME="/home/$USER"

echo -e "Beginning Pavlov VR update run on $(date)\n\n"

systemctl stop "$SERVICENAME"

sleep 5
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +force_install_dir "$USERHOME/$INSTALLDIRNAME" +app_update 622970 +exit
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +app_update 1007 +quit
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/.steam/sdk64/steamclient.so"
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/pavlovserver/Pavlov/Binaries/Linux/steamclient.so"

systemctl start "$SERVICENAME"

echo -e "Ending Pavlov VR update run on $(date)\n\n"

EOF

chmod +x $HOME/pavlov_daily_update_and_restart.sh
mkdir $HOME/pavlov_update_logs && touch $HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log
CRONLINE="00 2 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
(sudo crontab -u root -l; echo "$CRONLINE" ) | sudo crontab -u root -
unset CRONLINE

</pre>

These commands will:

1. Create a shell script in the "steam" user's home directory that automatically stops the Pavlov server, pulls any updates via steam, pull updates to the Steamworks SDK Redist, and copies the latest version of steamclient.so to the Pavlov server directory

2. Make the shell script executable

3. Create a new directory called "pavlov_update_logs" in the "steam" user's directory, and create a logfile inside that directory called "pavlov_daily_update_and_restart.sh.log". You can check this logfile to see the output of the Pavlov and Steam SDK update commands.

4. Create a crontab entry for the root user that runs this shell script automatically every day at 2:00AM local time

If you want to change the time that this script runs, edit the numbers "00 2" in the line that starts with "CRONLINE=". In the example provided, 00 is the minutes column, and 2 is the hour column. For example, if you wanted the server to automatically update and restart at 4:17AM every day, change the line starting with "CRONLINE=" to:

<pre>
CRONLINE="17 4 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
</pre>

If the time is PM, use 24-hour time format, e.g. "32 18" for 6:32PM.

----

=== Supervising the server using systemd ===

Running '''./PavlovServer.sh''' in your interactive shell is easy, but the server will shut down when you close your terminal. If you want to run the server in the background,
you'll want to run it under a supervisor. There are many options, ranging from the simple (nohup, screen or tmux), to the
more robust (supervisord, systemd).

Systemd is running by default on Ubuntu Linux, so we'll use that here.

To run the server as a systemd service, create the file '''/etc/systemd/system/pavlovserver.service''' (as root) by typing
<pre>
sudo nano /etc/systemd/system/pavlovserver.service
</pre>

Copy contents below into the file and save.

<pre>
[Unit]
Description=Pavlov VR dedicated server

[Service]
Type=simple
WorkingDirectory=/home/steam/pavlovserver
ExecStart=/home/steam/pavlovserver/PavlovServer.sh

RestartSec=1
Restart=always
User=steam
Group=steam

[Install]
WantedBy = multi-user.target
</pre>

If you'd like your server to start as competitive without editing the game.ini, change the line "ExecStart=/home/steam/pavlovserver/PavlovServer.sh" to look like this below. Though it's much easier to just use the game.ini to enable competitive instead. <pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -COMPETITIVE=1</pre>

Change the user or paths as appropriate. After saving the service file, to start, restart, stop, or monitor the server:

<pre>
sudo systemctl start pavlovserver
sudo systemctl restart pavlovserver
sudo systemctl stop pavlovserver
sudo systemctl status pavlovserver
</pre>

To view the logs:

<pre>
sudo journalctl -u pavlovserver
# to live-tail the logs
sudo journalctl -u pavlovserver -f
</pre>

If you want to run the pavlov server as soon as your server boots (e.g. a VPS you turn on and off), add pavlov as a startup service:

<pre>
sudo systemctl enable pavlovserver
</pre>

----

== Advanced Server Administration ==

=== Running multiple servers on one host ===

* Pavlovserver is functionally single threaded (there are multiple threads, but vast majority of work occurs in the primary one). Make sure you have # of pavlovservers + 1 CPU available. More CPUs= more servers. Faster CPU = more players.
* Make multiple server installs by defining a separate install dir for each server.
* Run each server with a unique port. eg: '''./PavlovServer.sh -PORT="Desired Port"'''
* The Server will use the Desired Port and the Port 400 above (Example: You choose 8200 as Port. So Port 8600 will be used as well)
* If you are using RCON, each server will need a unique port defined in RconSettings.txt
* Ensure the ports are forwarded and opened in your firewall

To duplicate directories:

be in the steam home folder
<pre>
cp -r pavlovserver pavlovserver1
/home/steam/pavlovserver1/PavlovServer.sh -PORT=[Desired Port]
</pre>

=== Starting server in competitive mode ===
Competitive mode will prevent dead teammates from being able to see the match, to prevent ghosting.
You can either enable this via Game.ini (described in Game.ini file), or using the -COMPETITIVE=1 parameter.

<pre>
/home/steam/pavlovserver1/PavlovServer.sh -COMPETITIVE=1
</pre>

=== Automated Rcon ===
here are some examples of scripts that interact with a Pavlov server

=== Inspect players every 5 [https://github.com/JTWP-org/inspect-every-5-mins/blob/main/log/inspectPlayer-04-23-2023-21-50.demo.json (GitHub )] ===
This script will collect a large pool of data about the players on your server the stats will be collected every 5 mins by default (can be changed)

below is all the info that will be collected every 5 mins

"PlayerInfo":

{

"PlayerName": "Salted Cracker Jack",

"UniqueId": "76561198210003277",

"KDA": "27/0/18",

"Score": "72",

"Dead": false,

"Cash": "13000",

"TeamId": "1"

},

----

=== Useful Linux Commands ===

List files / folders in directory, print current working directory,
<pre>ls -la #list files/directories along with authorities and ownership
pwd #print working directory
sudo chown <owner> <file/directory> #change owner of file/directory. If root created something and you need to change it to steam
sudo chgrp <group> <file/directory> #change group of file/directory.
</pre>

Check if pavlov is running by checking process status. If the only row you see is the grep command, pavlov server is not started.
<pre> ps -ef | grep pav </pre>

Sample output:
<pre>
steam 34044 1 0 16:52 ? 00:00:00 /bin/sh /home/steam/pavlovserver/PavlovServer.sh
steam 34066 34044 80 16:52 ? 00:00:04 /home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer
zombies+ 34101 34013 0 16:52 pts/0 00:00:00 grep --color=auto pav
</pre>

Kill a process. Note this command uses 34044, which is a process id from the command output above.
<pre> kill -9 34044 </pre>

Dump the log to the console so you can scroll through it:
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log </pre>

Search the log for a string - replace my_string with case-sensitive string
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep my_string </pre>

=== Default Map ID's ===
datacenter

sand

bridge

containeryard

siberia (Prison Break)

hospital (Zombies map)

killhouse

range

tutorial

santorini

station

industry

ogcontainers (Shack only)

haguenau (Shack only)

foundation (Shack only)

stalingrad (PC only)

stalingrad_night (PC only)

santorini_night (PC only)

sand_night (PC only)

station_night (PC only)

industry_night (PC only)

bunker (PC only)

=== Automated server log backup ===

here is how to setup a bash script to 1x a day compress all log files and save them to protect from auto deletion it will also post a discord webhook to confirm its working and saved the days logs

https://github.com/JTWP-org/backUpLogs

== Troubleshooting ==

To run the server without outputting the heartbeat:

<pre>./PavlovServer.sh | sed '/heartbeat/d'</pre>

To monitor the logs (without heartbeat) from another terminal:

<pre>tail -f -n10000 /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep -v 'Sending heartbeat to masterserver'</pre>

Check your CPU Clock Speed with:

<pre>lscpu | grep MHz</pre>

=== Server won't start ===

Error message:
<pre>
ln: failed to create hard link '/home/steam/.steam/sdk64/steamclient.so': File exists
ln: failed to create hard link '/home/steam/pavlovserver/Pavlov/Binaries/Linux/steamclient.so': File exists
/home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer: error while loading shared libraries: libc++.so.1: cannot open shared object file: No such file or directory
</pre>

First two errors are harmless. The third one is because libc++ step was skipped or failed. Using sudo capable id (probably not steam id), [re]run this line:
<pre>sudo apt update && sudo apt install -y gdb curl lib32gcc1 libc++-dev unzip </pre>

=== Map wont load (kicks to datacenter) ===

try deleting all the downloaded workshop maps with:

<pre>sudo rm -rf /tmp/workshop/7777/content/555160/*</pre> for all maps or

<pre>sudo rm -rf /tmp/workshop/7777/content/555160/whatever-UGC</pre> for specific map

=== Map wont load when running in a container ===
The three typical container problems I have seen:

1) Steam can't write to /tmp for some reason

2) /tmp is actually tmpfs instead of real filesystem and a few gigs of maps runs you out of RAM

3) Made worse by fact that pavlovserver unpacks downloads to ram, then writes to /tmp/workshop. Not enough RAM to do this, no map for you.

=== Server stuck rotating forever ===

Run these 2 commands, then restart your server:

<pre>cd ~/Steam && ./steamcmd.sh +login anonymous +app_update 1007 +quit
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so</pre>

If this doesn't fix it, double check that your server isn't running on the same port as another, by running this command:

<pre>ps -ef | grep pav</pre>

Then if 2 servers are on the same port, you can fix it by editing the pavlovserver.service file, and making sure the following line:

<pre>ExecStart=/home/steam/pavlovserver/PavlovServer.sh -PORT=Number</pre>

has a unique number after the port for each server you're running.

=== Server - ping 999 ===
Google Cloud Platform - Make sure your compute engine has a network tag and your network rules are applied to the tag.
Make sure you opened the specified ports.

Network testing tools:
Test if your server will respond to ping from outside your network:
https://www.wormly.com/test-remote-ping

Test if your ports are accessible via UDP (7777,8177,9100):
https://www.ipvoid.com/udp-port-scan/

=== Can't connect to RCON ===
Check the file and group owner of RconSettings file. It should be steam, or the ID used to run the pavlov server.
<pre>
cd /home/steam/pavlovserver/Pavlov/Saved/Config
ls -la
</pre>

If the owner/group are not steam, using root or an id with sudo authority, change them to steam, confirm they are now set properly, then restart the pavlov server. (Note - if Rcon has wrong permissions, after fixing you should also to check the other config files like Game.ini, mods/blacklist/whitelist for the same issue. If steam can't access these files, it could cause problems.).
<pre>
cd /home/steam/pavlovserver/Pavlov/Saved/Config
sudo chown steam RconSettings.txt
sudo chgrp steam RconSettings.txt
ls -la </pre>

=== PC ONLY - Map Download stops ===

When downloading a large map from the steam workshop make sure your VPS/Dedi or Shared hosting provider (Otherwise known as a GSP's) has enough RAM assigned to store the map files in its tempfs (stored in ram)!

This is less likely to happen on Dedicated servers and VPS with a decent amount of ram unless you are using docker with RAM limits!

Most GSP's will be using docker or some other type of jailing method to limit system resource allocations and direct access to the host machine, if they are and you know what map you want to use make sure you order a service with enough ram to store your map. If in doubt contact your GSP's support team.

=== Getting Help ===

There's a #pc-custom-servers channel on the official Pavlov Discord - https://discord.gg/Pavlov-VR. Lots of helpful people there!

ItemIDs

2023-05-25T22:35:55Z

SaltedCrackerJack: how to use rcon to find custom item id and they can be spawned too

Here is a full list of items, vehicles, and skin IDs for Pavlov VR, for use in either map making or spawning items through Rcon:

 
__TOC__
 

=Weapons=
====Pistols====
: 1911
: 57
: cet9
: de
: goldengun
: luger
: m9
: revolver
: silentcet9
: sock
: tokarev
: webley

====SMGs====
: ak
: ar9
: detectivesmg
: kross
: mp40
: mp5
: p90
: ppsh
: skorpion
: smg
: sten
: thompson
: uzi

====Shotguns====
: autoshotgun
: drumshotgun
: sawedoff
: shotgun
: trenchgun

====Rifles====
: ak12
: ak47
: akshorty
: ar
: aug
: autosniper
: g43
: galul
: m16
: m1garand
: sks
: stg44
: svt40
: vanas

====LMGs====
: bar
: bren
: dp27
: lmga
: mg42
: pkm
: tankmg (Old MG42)

====Snipers====
: antitank
: awp
: hunting
: kar98
: leeenfield
: mosin
: scur
: springfield
: vzz

====Rocket Launchers====
: rl_m1a1
: rl_panzer
: rl_piat
: rl_rpg
: tankturret (Old M1A1 rocket)

====Knives====
: knife
: tttknife
: ww2knife

====Other====
: flaregun
: newtonlauncher
: taser
: tranqgun

=Items=

====Attachments====
: acog
: bayonet_kar98
: bayonet_leeenfield
: bayonet_m1garand
: bayonet_mosin
: bayonet_springfield
: bayonet_trenchgun
: canted_reddot
: flashlight_rifle
: grip_angled
: grip_vertical
: holo
: laser_pistol
: laser_rifle
: reddot
: reddot_pistol
: scope
: scope_kar98
: scope_leeenfield
: scope_mosin
: scope_springfield
: supp_pistol
: supp_rifle

====Meds====
: adrenaline
: bandage
: medkit
: painkillers
: syringe
: ww2bandage
: ww2medkit
: ww2painkillers
: ww2syringe

====Grenades====
: flash
: flash_aurora
: flash_ru
: grenade
: grenade_aurora
: grenade_dis
: grenade_ger
: grenade_ru
: grenade_svt
: grenade_us
: smoke
: smoke_ger
: smoke_ru
: smoke_svt
: smoke_us

====Mines====
: antipersonnelmine
: antitankmine
: tripalarm

====Ammo====
: ammo_pistol
: ammo_rifle
: ammo_shotgun
: ammo_smg
: ammo_sniper
: ammo_special
: ammocrate

====Other====
: armour
: ballisticsshield
: boltcutters
: cloakdisrupter
: crowbar
: dnascanner
: handcuffs
: healthstation
: kevlarhelmet
: keycard
: lockpick
: monocular
: pickaxe
: pipe
: pliers
: pushBomb
: repairtool
: skinhelmet_ger
: skinhelmet_svt
: skinhelmet_us
: snowball
: teleporter
: tttc4

=Skins=
[[File:T_Portrait_HDNSoldier_Face.png|frameless|32x32px]] aurora 
[[File:T_Portrait_Clown_Face.png|frameless|32x32px]] clown 
[[File:T_Portrait_Cop_Face.png|frameless|32x32px]] cop 
[[File:T_Portrait_Farmer_Face.png|frameless|32x32px]] farmer 
[[File:T_Portrait_Ger_Face.png|frameless|32x32px]] german 
[[File:T_Portrait_Hidden_Face.png|frameless|32x32px]] kevin 
[[File:T_Portrait_Naked_Face.png|frameless|32x32px]] naked 
[[File:T_NATOv2_Face.png|frameless|32x32px]] nato 
[[File:T_Portrait_Prisoner_Face.png|frameless|32x32px]] prisoner 
[[File:T_Portrait_Rusv2_Face.png|frameless|32x32px]] russian 
[[File:T_Portrait_Svt_Face.png|frameless|32x32px]] soviet 
[[File:T_Portrait_US_Face.png|frameless|32x32px]] us

=Vehicles=
[[File:ATV.png|57x57px]] atv 
[[File:Kubelwagen.png|57x57px]] kubel 
motorcycle (Shack only) 
[[File:Panzer4.png|57x57px]] panzer 
[[File:Sherman.png|57x57px]] sherman 
[[File:T34.png|57x57px]] t34 
[[File:Tiger.png|57x57px]] tiger 
[[File:Truck.png|57x57px]] truck 
[[File:Willys.png|57x57px]] willys 
[[File:Willys_Soviet.png|57x57px]] willys_svt 

=TTT Roles (Case Sensitive)=
[[File:T_InnocentIcon.png|frameless|20x20px]] Innocent 
[[File:T_TraitorIcon.png|frameless|20x20px]] Traitor 
[[File:T_DetectiveIcon.png|frameless|20x20px]] Detective 
[[File:T_MercenaryIcon.png|frameless|20x20px]] Mercenary 
[[File:T_GlitchIcon.png|frameless|20x20px]] Glitch 
[[File:T_AssassinIcon.png|frameless|20x20px]] Assassin 
[[File:T_JesterIcon.png|frameless|20x20px]] Jester 
[[File:T_SurvivalistIcon.png|frameless|20x20px]] Survivalist 
[[File:T_SheriffIcon.png|frameless|20x20px]] Sheriff 
[[File:T_TankIcon.png|frameless|20x20px]] Tank 
[[File:T_LonwWolfIcon.png|frameless|20x20px]] LoneWolf

= Custom items ? (map specific) =
Spawning custom items can be done like any of the base game items you will just need the item id and use the rcon command <code>ITEMLIST</code> when the map is loaded ( it may show some as there is a max to the items it can list and the custom items will be listed with the default ones)

Making Skins

2023-05-24T22:33:43Z

SaltedCrackerJack: /* Creating Skins - Beginner */

Note: Making custom skins is not officially supported. There has been some drama in the past about users getting banned for messing with the game files. With an official skin shop planned at being released at some time in the future it is very possible that these methods will not be recomended in the future.

== Creating Skins - Beginner ==
(the most common way ) When creating skins for your Pavlov Map you will need a few things.

You will need:

* [https://www.substance3d.com/ Adobe Substance Painter 3D]
* (Alternatives) [https://quixel.com/mixer/ Quixel Mixer], [https://www.blender.org/download/ Blender] or [https://substance3d.adobe.com/education/ Substance Painter Student License]

* Your weapon model with bake maps from [https://discord.gg/TFkKrVhE3A Pavlov Artists]

Now you have those things you can find a tutorial for [https://youtu.be/NP7XnnIvkOs Adobe Substance 3D], or you can find one for your alternative '''(We strongly do not encourage you pirate or fraud for a version of Adobe Substance as it puts you at risk)'''

If you are looking to get custom weapons then you can find how to here: [[Custom Guns]]

== Problems with Gun Skin Making ==
Common problems with Gun Skin Making are:

* Skin showing up as grey checkerboard
* Skin not working at all or in different place

* Lighting or skin flickering problems

===== Skin showing up as a grey checkerboard: =====
Make sure skeletal mesh is checked on the mat editor. If that doesn't work then it is mostly caused from you not

using the custom materials in [https://ptb.discord.com/channels/1018963448383680553/1020750094443741317 Pavlov Artist's modkit] or your material isn't set up correctly, make sure you follow the tutorial and install the custom materials modkit in the project files.

You will also need to correctly install M_PavlovGunMaster and create a material instance so you can mix your ORM, Occlusion and Base Colour etc.

===== Skin not working at all or in different place: =====
Two things: Your skin requires the switch slots to be ticked or you haven't touched your skin box zone which is the outline box surrounding your skinbox blueprint in the editor.

Mostly rifles and not handguns or throwables use switch slots according to Chalk (Pavlov Artists founder)

If you do not touch your skinbox zone then it will not apply the skin. If you want a constant skin then make sure the skin box zone covers the spawns or the whole map with scaling.

===== Lighting or skin flickering problems =====
You haven't set up your sphere reflection or built the light, but if you have then you haven't setup the skinbox correctly.

== Creating Character Skins ==
Pretty much your doing the same as you do with guns using the character models found in the resource channel of Pavlov Artists. I would stick to to the normal character textures.

But if you want for an example an all gold NATO skin then you can make one, just expect a few issues a long the way.

a big problem with trying to edit the default skins or vehicles is the gore and damage will break the skin the first time they are shot so u would need to find a way to disable that

if you are looking to change the models of them, you can here: [[Changing the character model]]

== Personal Skins ==
In order to make a personal skin you will need to have it built into a map because as of now there is no skin support so they must be built into the map however if u wanted to go that route someone already made some logic that can help you with that, [https://drive.google.com/file/d/1FtDn79igDXZfMCXRvF3mIVPHiv1wU2I9/view?usp=share_link THW Reaper's skinbox] (CustomPlayers Skinbox) it uses player ids (names/steamids) to assign personal skins, as of now it works.

If it breaks in the future contact TWH Reaper or SmallDvrkOne.

ItemIDs

2023-05-03T09:04:36Z

SaltedCrackerJack: /* Weapons */

Here is a full list of items, vehicles, and skin IDs for Pavlov VR, for use in either map making or spawning items through Rcon:

 
__TOC__
 

== Weapons ==
1911 
57 
AK12 
AK47 
AR 
AUG 
AntiTank 
AutoShotgun 
AutoSniper 
DE 
DrumShotgun 
G43 
LMGA 
RL_M1A1 
RL_PIAT 
Revolver 
Tokarev 
ak 
akshorty 
ar9 
awp 
bar 
bren 
cet9 
detectivesmg 
dp27 
flaregun 
galul 
goldengun 
hunting 
kar98 
kross 
leeenfield 
luger 
m16 
m1garand 
m9 
mg42 
mosin 
mp40 
mp5 
newtonlauncher 
p90 
ppsh 
rl_panzer 
rl_rpg 
sawedoff 
scur 
shotgun 
silentcet9 
skorpion (Shack only) 
sks 
smg 
sock 
springfield 
sten 
stg44 
svt40 
tankmg (Old MG42) 
tankturret (Old M1A1 rocket) 
taser 
thompson 
tranqgun 
trenchgun 
uzi 
vanas 
vzz 
webley 

==Items/Grenades==
Armour 
BallisticsShield 
Canted_Reddot 
Flashlight_Rifle 
Grenade 
Grip_Angled 
Grip_Vertical 
Holo 
Knife 
Laser_Pistol 
Laser_Rifle 
Painkillers 
Pliers 
PushBomb 
Scope 
Smoke 
Syringe 
acog 
adrenaline 
ammo_pistol 
ammo_rifle 
ammo_shotgun 
ammo_smg 
ammo_sniper 
ammo_special 
ammocrate 
antipersonnelmine 
antitankmine 
bandage 
bayonet_kar98 
bayonet_leeenfield 
bayonet_m1garand 
bayonet_mosin 
bayonet_springfield 
bayonet_trenchgun 
boltcutters 
cloakdisrupter 
crowbar 
dnascanner 
flash 
flash_aurora 
flash_ru 
grenade_dis 
grenade_ger 
grenade_aurora 
grenade_ru 
grenade_svt 
grenade_us 
handcuffs 
healthstation 
kevlarhelmet 
keycard 
lockpick 
medkit 
monocular 
pickaxe 
pipe 
reddot 
reddot_pistol 
repairtool 
scope_kar98 
scope_leeenfield 
scope_mosin 
scope_springfield 
skinhelmet_ger 
skinhelmet_svt 
skinhelmet_us 
smoke_ger 
smoke_ru 
smoke_svt 
smoke_us 
snowball 
supp_pistol 
supp_rifle 
teleporter 
tripalarm 
tttc4 
tttknife 
ww2bandage 
ww2knife 
ww2medkit 
ww2painkillers 
ww2syringe 

==Skins==
[[File:T_Portrait_HDNSoldier_Face.png|frameless|32x32px]] aurora 
[[File:T_Portrait_Clown_Face.png|frameless|32x32px]] clown 
[[File:T_Portrait_Cop_Face.png|frameless|32x32px]] cop 
[[File:T_Portrait_Farmer_Face.png|frameless|32x32px]] farmer 
[[File:T_Portrait_Ger_Face.png|frameless|32x32px]] german 
[[File:T_Portrait_Hidden_Face.png|frameless|32x32px]] kevin 
[[File:T_Portrait_Naked_Face.png|frameless|32x32px]] naked 
[[File:T_NATOv2_Face.png|frameless|32x32px]] nato 
[[File:T_Portrait_Prisoner_Face.png|frameless|32x32px]] prisoner 
[[File:T_Portrait_Rusv2_Face.png|frameless|32x32px]] russian 
[[File:T_Portrait_Svt_Face.png|frameless|32x32px]] soviet 
[[File:T_Portrait_US_Face.png|frameless|32x32px]] us

==Vehicles==
[[File:ATV.png|57x57px]] atv 
[[File:Kubelwagen.png|57x57px]] kubel 
motorcycle (Shack only) 
[[File:Panzer4.png|57x57px]] panzer 
[[File:Sherman.png|57x57px]] sherman 
[[File:T34.png|57x57px]] t34 
[[File:Tiger.png|57x57px]] tiger 
[[File:Truck.png|57x57px]] truck 
[[File:Willys.png|57x57px]] willys 
[[File:Willys_Soviet.png|57x57px]] willys_svt 

==TTT Roles (Case Sensitive)==
[[File:T_InnocentIcon.png|frameless|20x20px]] Innocent 
[[File:T_TraitorIcon.png|frameless|20x20px]] Traitor 
[[File:T_DetectiveIcon.png|frameless|20x20px]] Detective 
[[File:T_MercenaryIcon.png|frameless|20x20px]] Mercenary 
[[File:T_GlitchIcon.png|frameless|20x20px]] Glitch 
[[File:T_AssassinIcon.png|frameless|20x20px]] Assassin 
[[File:T_JesterIcon.png|frameless|20x20px]] Jester 
[[File:T_SurvivalistIcon.png|frameless|20x20px]] Survivalist 
[[File:T_SheriffIcon.png|frameless|20x20px]] Sheriff 
[[File:T_TankIcon.png|frameless|20x20px]] Tank 
[[File:T_LonwWolfIcon.png|frameless|20x20px]] LoneWolf

ItemIDs

2023-05-03T09:02:29Z

SaltedCrackerJack: /* Weapons */

Here is a full list of items, vehicles, and skin IDs for Pavlov VR, for use in either map making or spawning items through Rcon:

 
__TOC__
 

== Weapons ==
[[File:T GunThumb 1911.png|thumb]]
'''[[:File:T_GunThumb_1911.png]]'''1911 
57 
AK12 
AK47 
[[AR]] 
AUG 
AntiTank 
AutoShotgun 
AutoSniper 
DE 
DrumShotgun 
G43 
LMGA 
RL_M1A1 
RL_PIAT 
Revolver 
Tokarev 
ak 
akshorty 
ar9 
awp 
bar 
bren 
cet9 
detectivesmg 
dp27 
flaregun 
galul 
goldengun 
hunting 
kar98 
kross 
leeenfield 
luger 
m16 
m1garand 
m9 
mg42 
mosin 
mp40 
mp5 
newtonlauncher 
p90 
ppsh 
rl_panzer 
rl_rpg 
sawedoff 
scur 
shotgun 
silentcet9 
skorpion (Shack only) 
sks 
smg 
sock 
springfield 
sten 
stg44 
svt40 
tankmg (Old MG42) 
tankturret (Old M1A1 rocket) 
taser 
thompson 
tranqgun 
trenchgun 
uzi 
vanas 
vzz 
webley 

==Items/Grenades==
Armour 
BallisticsShield 
Canted_Reddot 
Flashlight_Rifle 
Grenade 
Grip_Angled 
Grip_Vertical 
Holo 
Knife 
Laser_Pistol 
Laser_Rifle 
Painkillers 
Pliers 
PushBomb 
Scope 
Smoke 
Syringe 
acog 
adrenaline 
ammo_pistol 
ammo_rifle 
ammo_shotgun 
ammo_smg 
ammo_sniper 
ammo_special 
ammocrate 
antipersonnelmine 
antitankmine 
bandage 
bayonet_kar98 
bayonet_leeenfield 
bayonet_m1garand 
bayonet_mosin 
bayonet_springfield 
bayonet_trenchgun 
boltcutters 
cloakdisrupter 
crowbar 
dnascanner 
flash 
flash_aurora 
flash_ru 
grenade_dis 
grenade_ger 
grenade_aurora 
grenade_ru 
grenade_svt 
grenade_us 
handcuffs 
healthstation 
kevlarhelmet 
keycard 
lockpick 
medkit 
monocular 
pickaxe 
pipe 
reddot 
reddot_pistol 
repairtool 
scope_kar98 
scope_leeenfield 
scope_mosin 
scope_springfield 
skinhelmet_ger 
skinhelmet_svt 
skinhelmet_us 
smoke_ger 
smoke_ru 
smoke_svt 
smoke_us 
snowball 
supp_pistol 
supp_rifle 
teleporter 
tripalarm 
tttc4 
tttknife 
ww2bandage 
ww2knife 
ww2medkit 
ww2painkillers 
ww2syringe 

==Skins==
[[File:T_Portrait_HDNSoldier_Face.png|frameless|32x32px]] aurora 
[[File:T_Portrait_Clown_Face.png|frameless|32x32px]] clown 
[[File:T_Portrait_Cop_Face.png|frameless|32x32px]] cop 
[[File:T_Portrait_Farmer_Face.png|frameless|32x32px]] farmer 
[[File:T_Portrait_Ger_Face.png|frameless|32x32px]] german 
[[File:T_Portrait_Hidden_Face.png|frameless|32x32px]] kevin 
[[File:T_Portrait_Naked_Face.png|frameless|32x32px]] naked 
[[File:T_NATOv2_Face.png|frameless|32x32px]] nato 
[[File:T_Portrait_Prisoner_Face.png|frameless|32x32px]] prisoner 
[[File:T_Portrait_Rusv2_Face.png|frameless|32x32px]] russian 
[[File:T_Portrait_Svt_Face.png|frameless|32x32px]] soviet 
[[File:T_Portrait_US_Face.png|frameless|32x32px]] us

==Vehicles==
[[File:ATV.png|57x57px]] atv 
[[File:Kubelwagen.png|57x57px]] kubel 
motorcycle (Shack only) 
[[File:Panzer4.png|57x57px]] panzer 
[[File:Sherman.png|57x57px]] sherman 
[[File:T34.png|57x57px]] t34 
[[File:Tiger.png|57x57px]] tiger 
[[File:Truck.png|57x57px]] truck 
[[File:Willys.png|57x57px]] willys 
[[File:Willys_Soviet.png|57x57px]] willys_svt 

==TTT Roles (Case Sensitive)==
[[File:T_InnocentIcon.png|frameless|20x20px]] Innocent 
[[File:T_TraitorIcon.png|frameless|20x20px]] Traitor 
[[File:T_DetectiveIcon.png|frameless|20x20px]] Detective 
[[File:T_MercenaryIcon.png|frameless|20x20px]] Mercenary 
[[File:T_GlitchIcon.png|frameless|20x20px]] Glitch 
[[File:T_AssassinIcon.png|frameless|20x20px]] Assassin 
[[File:T_JesterIcon.png|frameless|20x20px]] Jester 
[[File:T_SurvivalistIcon.png|frameless|20x20px]] Survivalist 
[[File:T_SheriffIcon.png|frameless|20x20px]] Sheriff 
[[File:T_TankIcon.png|frameless|20x20px]] Tank 
[[File:T_LonwWolfIcon.png|frameless|20x20px]] LoneWolf

File:T GunThumb 1911.png

2023-05-03T09:00:02Z

SaltedCrackerJack:

1911

Game Settings

2023-05-03T08:54:00Z

SaltedCrackerJack: added how to open settings from outside game

{{Template:Capsule-game}}
== General ==

'''Startup Behavior:''' This will, when the game starts up, allow the option to start at the main menu, either of the shooting ranges, or the killhouse.

'''bHaptic Suit:''' Enables bHaptic Suit events. (Goes as fast as your real time speed)

'''ForceTube Haptics:''' Enables ForceTube haptic events. (Adds more "realistic" functions, like pressing buttons in shooting range as soon hands come into contact) Assists with mag hitting making it easier.

'''Left Eye Rendering:''' This makes that the game will render the video for the left eye instead of the right. This can be nifty for wanting to record or stream gameplay.

== Player ==

'''Free Spectating:''' Flies in a smooth motion while spectating.

'''Arm Kill Feed:''' Switches if the Kill Feed is on the scoreboard or the non-dominant arm.

'''Hide Ammo Count:''' Hides ammo counter in TTTv2, Hide, ect.

'''Virtual stock:''' Simulates physical gun stock.

'''Vignette Effects:''' Enables on-screen effects. (Blood when getting damaged, sweat when taking adrenaline)

== Input ==

'''Dominant Hand:''' Selects which hand to spawn guns into.

'''Input Vector:''' Selects to move from head, dominant or non-dominant hand.

'''Inventory Lock:''' Locks inventory if looking down.

'''Auto Sprint:''' Automatically sprint when moving.

'''Swap Locomotion Hand:''' Switches hand used for movement into dominant hand.

'''Artificial Turn:''' Enables Snap Turn.

'''Smooth Turn:''' Switches Snap Turn to Smooth turn. Must have ''Artificial Turn'' enabled to function.

== Audio ==
'''Ambisonics:''' An enhanced way of playing spatial audio at the price of higher CPU usage.

'''Audio Quality:''' Overall quality of gun sounds, firing, and anything else you may hear.

'''Realtime Reverb:''' Enhanced reverb based on geometry around you.

'''Audio Thread:''' May increase audio performance if enabled. Not recommended for CPUs with fewer than six cores.

== Video ==
'''Anti-Aliasing:''' A process that smooths out jagged edges of small and/or far away objects to improve overall image clarity. The higher this is set to the more it will tax on performance.

'''Texture Quality:''' The resolution of item, player, and map textures. It is not recommended to use a setting that exceeds the amount of VRAM on your GPU.

'''Effects Quality:''' Overall quality of explosions, muzzle flash, and other effects. The higher this setting is set to, the more likely you are to receive frame drops where there is a lot of action.

'''Post Processing (Beta Only):''' The only known post processing effect right now is the double vision effect caused by flashbangs.

'''Resolution Scale:''' Overall render resolution of the scene. Turning this down will result in a significant boost in performance at the expense of image quality and clarity.

== Troubleshooting ==
In the event you need to change a setting and cant launch the game there is a text file with them

like if you changed a setting and its crashing on launch or your audio source is buried in a long list and u cant select it .

to do it you press the '''windows key and R''' at the same time then in the small box that opens u enter <blockquote>%LocalAppData%\Pavlov\Saved\Config\WindowsNoEditor</blockquote>then press enter and it will open a folder inside that folder u will see '''''GameUserSettings.ini'''''

go ahead and open that with a text editor and inside that u will have a text version of the ingame settings edit what u needed / wanted to then save and close the file

here is what one looks like <blockquote>[/Script/Pavlov.PavlovGameUserSettings]

bSmoothTurn=True

PlayerCrouchHeight=0.000000

bAutoUngrip=False

bLegacyGrip=False

bSnapTurnEnabled=True

bMountFriendly=False

PrimaryRegion=America

bHideFullServers=False

bHideEmptyServers=True

bHidePinLockedServers=True

ServerSearchType=ShowCommunityServer

ServerSortType=PingAscending

FavoriteServers=(ServerName="JTWP.org Castlewars Official",ServerIdentifier="66.59.211.184:10000")

FavoriteServers=(ServerName="JTWP.org PrisonBreak Official",ServerIdentifier="66.59.211.184:11000")

FavoriteServers=(ServerName="JTWP.org MAP Escape From Pavlov",ServerIdentifier="66.59.211.184:12000")

FavoriteServers=(ServerName="JTWP.org PUSH USA EAST",ServerIdentifier="66.59.211.184:13000")

FavoriteServers=(ServerName="JTWP.org Joseph\'s TDM [game.jtwp.org For Leaderboard]",ServerIdentifier="15.204.9.216:7777")

FavoriteServers=(ServerName="JTWP.org Castlewars GAME.JTWP.ORG for stats USA EAST",ServerIdentifier="23.139.82.34:10000")

FavoriteServers=(ServerName="JTWP.org Pirates of Pavlov GAME.JTWP.ORG for stats USA EAST",ServerIdentifier="23.139.82.34:18000")

FavoriteServers=(ServerName="JTWP.org Pistol Playground GAME.JTWP.ORG for stats USA EAST",ServerIdentifier="23.139.82.34:11000")

FavoriteServers=(ServerName="JTWP.org PrisonBreak Official GAME.JTWP.ORG for stats USA EAST",ServerIdentifier="23.139.82.34:17000")

FavoriteServers=(ServerName="JTWP.org Escape From Pavlov (Passive Income 400$ a hour)",ServerIdentifier="23.139.82.34:12000")

RegionFilters=Europe

RegionFilters=AsiaPacific

bForceNoPostProcess=True

bAutoSwapHands=False

bLeftEyeRendering=False

GripModeVive=Click

GripModeOculus=Hold

MainHandAction=None

OffHandAction=None

bAutoSprint=True

bLiteFootStepHaptics=True

bLockInventory=True

bHeadLocomotion=False

bFreeSpectating=True

bInvertTouchpad=False

bArmKillfeed=True

VoiceDevice=Default Device

bRealTimeReverb=True

bUseAudioThread=False

bNoAmbisonics=False

bSwapMenuScoreboard=False

GripMode=Auto

SmoothLocomotionMode=Offhand

GoreLevel=Gruesome

GrabForceThreashold=0.250000

bUseGrabForce=True

StartUpMap=

bForceTubeHaptics=False

bHapticsSuit=False

bUseAdvancedVehicleInput=True

bHideAmmoCounter=False

bMicMuted=True

bOnScreenEffects=True

PavlovVersion=1

bUseVSync=False

bUseDynamicResolution=False

ResolutionSizeX=1280

ResolutionSizeY=720

LastUserConfirmedResolutionSizeX=1280

LastUserConfirmedResolutionSizeY=720

WindowPosX=-1

WindowPosY=-1

FullscreenMode=1

LastConfirmedFullscreenMode=1

PreferredFullscreenMode=1

Version=5

AudioQualityLevel=0

LastConfirmedAudioQualityLevel=0

FrameRateLimit=0.000000

DesiredScreenWidth=1280

DesiredScreenHeight=720

LastUserConfirmedDesiredScreenWidth=1280

LastUserConfirmedDesiredScreenHeight=720

LastRecommendedScreenWidth=-1.000000

LastRecommendedScreenHeight=-1.000000

LastCPUBenchmarkResult=-1.000000

LastGPUBenchmarkResult=-1.000000

LastGPUBenchmarkMultiplier=1.000000

bUseHDRDisplayOutput=False

HDRDisplayOutputNits=1000

GMFiltersV2=PUSH

[/Script/Engine.GameUserSettings]

bUseDesiredScreenHeight=False

[ShaderPipelineCache.CacheFile]

LastOpened=Pavlov</blockquote>

Making Skins

2023-05-01T22:01:54Z

SaltedCrackerJack: /* Creating Character Skins */

== Creating Skins - Beginner ==
When creating skins for your Pavlov Map you will need a few things.

You will need:

* [https://www.substance3d.com/ Adobe Substance Painter 3D]
* (Alternatives) [https://quixel.com/mixer/ Quixel Mixer], [https://www.blender.org/download/ Blender] or [https://substance3d.adobe.com/education/ Substance Painter Student License]

* Your weapon model with bake maps from [https://discord.gg/TFkKrVhE3A Pavlov Artists]

Now you have those things you can find a tutorial for [https://youtu.be/NP7XnnIvkOs Adobe Substance 3D], or you can find one for your alternative '''(We strongly do not encourage you pirate or fraud for a version of Adobe Substance as it puts you at risk)'''

If you are looking to get custom weapons then you can find how to here: [[Custom Guns]]

== Problems with Gun Skin Making ==
Common problems with Gun Skin Making are:

* Skin showing up as grey checkerboard
* Skin not working at all or in different place

* Lighting or skin flickering problems

===== Skin showing up as a grey checkerboard: =====
Mostly caused from you not using the custom materials in Pavlov Artist's modkit or your material isn't set up correctly, make sure you follow the tutorial and install the custom materials modkit in the project files.

You will also need to correctly install M_PavlovGunMaster and create a material instance so you can mix your ORM, Occlusion and Base Colour etc.

===== Skin not working at all or in different place: =====
Two things: Your skin requires the switch slots to be ticked or you haven't touched your skin box zone which is the outline box surrounding your skinbox blueprint in the editor.

Mostly rifles and not handguns or throwables use switch slots according to Chalk (Pavlov Artists founder)

If you do not touch your skinbox zone then it will not apply the skin. If you want a constant skin then make sure the skin box zone covers the spawns or the whole map with scaling.

===== Lighting or skin flickering problems =====
You haven't set up your sphere reflection or built the light, but if you have then you haven't setup the skinbox correctly.

== Creating Character Skins ==
Pretty much your doing the same as you do with guns using the character models found in the resource channel of Pavlov Artists. I would stick to to the normal character textures.

But if you want for an example an all gold NATO skin then you can make one, just expect a few issues a long the way.

a big problem with trying to edit the default skins or vehicles is the gore and damage will break the skin the first time they are shot so u would need to find a way to disable that

if you are looking to change the models of them, you can here: [[Changing the character model]]

== Personal Skins ==
In order to make a personal skin you will need to have it built into a map because as of now there is no skin support so they must be built into the map however if u wanted to go that route someone already made some logic that can help you with that, [https://drive.google.com/file/d/1FtDn79igDXZfMCXRvF3mIVPHiv1wU2I9/view?usp=share_link THW Reaper's skinbox] (CustomPlayers Skinbox) it uses player ids (names/steamids) to assign personal skins, as of now it works.

If it breaks in the future contact TWH Reaper or SmallDvrkOne.