Ultimate Guide To VPS

How to set up a VPS (virtual private server) from 0 to 100, resources and notes for my linux server

Introduction

The goal of this guide is to help you to set up a VPS from 0 to 100, with all the necessary tools to self-host services such as a website, mail server, file server, git server, database server, game server, chat server and more.

What is a VPS?

A virtual private server (VPS) is a virtual machine sold as a service by a hosting provider. A VPS runs its own copy of an operating system (OS), and users have root access to that operating system instance, so they can install almost any software that runs on that OS. They are priced much lower than an equivalent physical server, but as they share the underlying physical hardware with other VPSs, performance may be lower, and may depend on the workload of other instances on the same hardware node.

VPS Providers

Disclaimer: I'm from Germany, it could be possible that some providers are not available in your country. I'm also not affiliated with any of these providers, I just want to share my experience with them.

I'm really interested to get the most out of my money, so I'm always looking for the best price-performance ratio. I have never tried Hetzner, but I heard only good things about them, so if you are looking for a no-brainer, I can also recommend them, but they are a bit pricey.

VPS Setup

Initial Setup

Operating System

If you are new to Linux, I recommend you to use Debian or Ubuntu, because they are the most beginner-friendly distributions. I'll use Debian 12 in this guide. In general, all providers offer a pre-installed Linux distribution, so you don't have to install it yourself you have to choose the OS you want to use and the provider will install it for you.

SSH

What is SSH?

SSH stands for Secure Shell. It is a cryptographic network protocol for operating network services securely over an unsecured network. It is used for remote login to a computer and to execute commands on a remote machine. You can read more about SSH here.

TLDR: It is a way to connect to a remote machine and execute commands on it. That's how you will interact with your VPS.

Getting started

There are two types, how providers give you access to your VPS:

You get a password, and you have to change it on your first login
You have to upload a public SSH key to your provider, and you can only connect with your private SSH key

If you get a password, you can skip the following sections and go to Create a new user, but you will have to return to this section later to Generate an SSH Key.

What is an SSH Key?

An SSH key is a pair of cryptographic keys that can be used to authenticate to an SSH server as an alternative to password-based logins. One key is a public key that you share with others, and the other is a private key that you keep to yourself. Even if someone gains access to the public key, they won't be able to derive the private key from it. You can read more about public-key cryptography here.

TLDR: It is a way to authenticate yourself to an SSH server. It's more secure than a password, so you should use it. Also, many providers require you to use one.

Generate an SSH Key

Since my provider requires me to use an SSH key, I will show you how to generate one. I will use Windows for this.

Open a terminal and type:

ssh-keygen

You will be asked to enter a file in which to save the key. You can use for example C:\Users\Name\.ssh\vps_rsa.
You will be asked to enter a passphrase. You can leave it empty, but I recommend you to use one.
You will be asked to enter the passphrase again.

Now you should have two files in C:\Users\Name\.ssh\: vps_rsa and vps_rsa.pub. The first one is your private key, the second one is your public key. Keep in mind that you should never share your private key with anyone in this example vps_rsa. Only share your public key vps_rsa.pub.

Now you can upload your public key to your provider.

SSH config

SSH config is a nice way to save your SSH settings on your local machine. It is located in C:\Users\Name\.ssh\config.

Open the file with your favorite text editor.
Add the following lines:

Host Name
    HostName IP
    Port 22
    User root
    IdentityFile C:\Users\Name\.ssh\vps_rsa

Replace the values if necessary.
Save the file and exit the text editor.
Now you can open your terminal and connect to your VPS with:

ssh <Name>

Create a new user

It is not recommended to use the root user for everything, so we will create a new user. Later we will also remove the option to login as root, to increase security.

Create a new user:

adduser <Name>

Choose and enter a password for your new user.
You will be asked to enter some information about your new user. You can just press enter to skip them.
Verify that your information is correct by typing Y and pressing enter.
Add your new user to the sudo group:

usermod -aG sudo <Name>

Switch to your new user:

su <Name>

Navigate to your home directory:

cd ~

Create a new directory called .ssh:

mkdir .ssh

Navigate to your new directory:

cd .ssh

Create a new file called authorized_keys:

touch authorized_keys

Open the file with your favorite text editor and paste your public key into it.
Save the file and exit the text editor.
Set the correct permissions for the file:

chmod 600 authorized_keys

Navigate back to your home directory:

cd ~

Open the file /etc/ssh/sshd_config with your favorite text editor:

sudo nano /etc/ssh/sshd_config

Find the line PermitRootLogin yes uncomment it and change it to PermitRootLogin no.
Find the line PasswordAuthentication yes uncomment it and change it to PasswordAuthentication no.
Add PubkeyAuthentication yes to the file.
Save the file and exit the text editor.
Restart the SSH service:

sudo service ssh restart

Now you have to adjust your SSH config of your local machine:

Host Name
    HostName IP
    Port 22
    User <Name>
    IdentityFile C:\Users\Name\.ssh\vps_rsa

Now you should only be able to log in with your new user.
You can test it by opening your terminal and connecting to your VPS with:

ssh <Name>

Additional Security

SSH

Open the file /etc/ssh/sshd_config with your favorite text editor:

sudo nano /etc/ssh/sshd_config

Find the line Port 22 uncomment it and change it to a custom port.
With Port 22 you are using the default port, so it is easier for attackers to find your server. Even though it is not a big deal, because you are using an SSH key, I still recommend you to change it.
Save the file and exit the text editor.
Restart the SSH service:

sudo service ssh restart

Now you have to adjust your SSH config of your local machine:

Host Name
    HostName IP
    Port <Port>
    User <Name>
    IdentityFile C:\Users\Name\.ssh\vps_rsa

Now you should only be able to log in with your custom port.

WireGuard

What is WireGuard?

WireGuard is an application and communication protocol that implements virtual private network (VPN) techniques to create secure point-to-point connections. We will use it to access services that we don't want to expose to the internet.

Install WireGuard

I like to install WireGuard with the following script, because it is easy to use. You can find the script here.

wget https://git.io/wireguard -O wireguard-install.sh

sudo bash wireguard-install.sh

After the installation, you find your wireguard config, that you can use to connect to your server, in the /root/username.conf file.

sudo mv /root/username.conf /home/user/

Firewall

What is a firewall?

A firewall is a crucial component of network security. UFW (Uncomplicated Firewall) helps protect your system from unauthorized access, controlling both incoming and outgoing network traffic based on your rules. You want some services to be accessible from the internet, but some services should only be accessible from a local network or not accessible at all. For example, you can emulate a local network with a VPN, so you can access your services from anywhere. That's why we have set up WireGuard previously.

Install ufw

sudo apt install ufw

Allow your custom SSH port

sudo ufw allow <Port>/tcp

Enable ufw

sudo ufw enable

Check the status of ufw

sudo ufw status

Install Docker

What is Docker?

Docker is a set of platform as a service (PaaS) products that use OS-level virtualization to deliver software in packages called containers. Containers are isolated from one another and bundle their own software, libraries, and configuration files; they can communicate with each other through well-defined channels. Containers are created from images that specify their contents. Images downloaded from public repositories.

TLDR: It is a way to run applications in a container, so you don't have to install them on your host system, I use it to run my services.

Install Docker

The best way to install Docker is to use the official Docker documentation you can find the documentation here.

For Debian 12 you find the documentation here.

UFW configuration for Docker

Due to the way Docker manipulates iptables on Linux, you have to make some changes to your firewall configuration. If you want to read more about this problem, you can find some more information here. I like to use the ufw-docker util tool, you can find it in the same repository.

Download ufw-docker util tool

sudo wget -O /usr/local/bin/ufw-docker \
  https://github.com/chaifeng/ufw-docker/raw/master/ufw-docker
sudo chmod +x /usr/local/bin/ufw-docker

Install ufw-docker

ufw-docker install

Here you can find out how to use it, we will use it later to allow access from the internet to our containers.

Script to update ufw rules after reboot

ufw-docker uses the current ip address of the container, so we have to update the firewall rules after a reboot, because the ip addresses of the containers can change otherwise the firewall rules won't work anymore, and we can't access our services from the internet anymore.

For example, if you want to add a new firewall rule for a container, you have to use the following command:

sudo ufw-docker allow <Container Name>

Then the ufw-docker util tool will look up the ip address of the container and add a new firewall rule for it. But since the ip address of the container can change after a reboot, we have to update the firewall rules every time we reboot our server. To automate this process, we will use a script that will update the firewall rules after a reboot.

Create a new file called update-ufw-rules.sh in your home directory

nano update-ufw-rules.sh

Paste the following code into the file

#!/bin/bash

# Sleep for 30 seconds to give Docker time to start
sleep 30

# Full path to the ufw-docker command
UFW_DOCKER_CMD="/usr/local/bin/ufw-docker"

# Array of container names
CONTAINERS=("container-1" "container-2")

# Loop through each container and update UFW rules
for CONTAINER in "${CONTAINERS[@]}"; do
    echo "Updating UFW rules for $CONTAINER..."

    # Delete existing UFW rule for the container
    $UFW_DOCKER_CMD delete allow $CONTAINER

    # Add a new UFW rule for the container
    $UFW_DOCKER_CMD allow $CONTAINER

    echo "UFW rules updated for $CONTAINER."
done

echo "All UFW rules have been updated."

Save the file and exit the text editor
Make the file executable

chmod +x update-ufw-rules.sh

Add the script to the crontab

sudo crontab -e

Add the following line to the crontab

@reboot /home/<name>/update-ufw-rules.sh

Save the file and exit the text editor
Now the script will run every time you reboot your server
Remember to add your containers to the container array in the script

Set up a TeamSpeak 3 Server with Docker Compose

create a folder in your home directory called teamspeak3

mkdir teamspeak3

navigate to your new folder

cd teamspeak3

create a docker-compose.yml file

nano docker-compose.yml

paste the following code into the file

version: '3'
services:
  teamspeak:
    image: teamspeak:latest
    environment:
      TS3SERVER_LICENSE: accept
    ports:
      - "9987:9987/udp"
      - "10011:10011"
      - "30033:30033"
    volumes:
      - ./ts3_data:/var/ts3server/
    restart: always

save the file and exit the text editor
start the container

docker-compose up -d

get the teamspeak docker container name

docker ps

use the ufw-docker util tool to add a new firewall rule for the teamspeak container

sudo ufw-docker allow <Container Name>

Don't forget to update the update-ufw-rules.sh script as well
now you can connect to your teamspeak server with your teamspeak client at IP:9987

Install portainer (skip for now, this section is not final yet)

What is portainer?

Portainer is an open-source lightweight management UI that allows you to easily manage your Docker environments.

TLDR: It is a nice UI to manage your Docker containers.

Install portainer

The best way to install portainer is to use the official portainer documentation you can find the documentation here.

If you want to use my commands, that I used to install portainer, you can expand this section.

First, create the volume that Portainer will use to store its database:
Create the volume:

sudo docker volume create portainer_data

Then, download and install the Portainer container:

sudo docker run -d -p 8000:8000 -p 9443:9443 --name portainer --restart=always -v /var/run/docker.sock:/var/run/docker.sock -v portainer_data:/data portainer/portainer-ce:latest

Add firewall rules:

sudo ufw route allow proto tcp from any to any port 9443

Now you can access portainer with your browser at https://<IP>:9443.

Install nginx proxy manager (skip for now, this section is not final yet)

What is nginx proxy manager?

We use nginx proxy manager to manage our reverse proxies and SSL certificates.

Install nginx proxy manager

Follow the official Quick Setup here, it should be up to date.

If you want to use my commands, that I used to install nginx proxy manager, you can expand this section.

Create a new stack in portainer.
Paste the following code into the Web editor:

version: '3.8'
services:
  app:
    image: 'jc21/nginx-proxy-manager:latest'
    restart: unless-stopped
    ports:
      - '80:80'
      - '81:81'
      - '443:443'
    volumes:
      - ./data:/data
      - ./letsencrypt:/etc/letsencrypt

Click on Deploy the stack.
Wait until the stack is deployed.

After the stack is deployed, you have to add some firewall rules:

sudo ufw route allow proto tcp from any to any port 80
sudo ufw route allow proto tcp from any to any port 81
sudo ufw route allow proto tcp from any to any port 443

Now you can access nginx proxy manager with your browser at https://<IP>:81.

Configure nginx proxy manager and portainer

Open nginx proxy manager with your browser at https://<IP>:81.
Click on Proxy Hosts and then on Add Proxy Host.
Enter the following values for portainer proxy host:

Details
  Domain Names: portainer.<your domain>
  Scheme: https
  Forward Hostname / IP: IP Address of portainer in portainer (navigate to containers -> portainer -> inspect -> ip address)
  Forward Port: 9443
SSL
  SSL Certificate: Request a new SSL Certificate
  Force SSL: yes

Click on Save.
Now you can access portainer with your browser at https://portainer.<your domain>.
Click on Proxy Hosts and then on Add Proxy Host.
Enter the following values for nginx proxy manager proxy host:

Details
  Domain Names: npm.<your domain>
  Scheme: https
  Forward Hostname / IP: IP Address of nginx proxy manager in portainer (navigate to containers -> nginx proxy manager -> inspect -> ip address)
  Forward Port: 81
SSL
  SSL Certificate: Request a new SSL Certificate
  Force SSL: yes

Click on Save.
Now you can access nginx proxy manager with your browser at https://npm.<your domain>.
Because we now access portainer and nginx proxy manager through the reverse proxy, we don't need the firewall rules anymore:
List all firewall rules:

sudo ufw status numbered

Delete the firewall rules:

sudo ufw delete <number>

Remove the rule for 81, 9443

Minecraft Server (skip for now, this section is not final yet)

Minecraft Docker Compose

version: "3.9"

services:
  minecraft:
    container_name: valhelsia
    hostname: valhelsia
    image: itzg/minecraft-server
    volumes:
    - /opt/valhelsia/modpacks:/modpacks:ro
    - /opt/valhelsia/data:/data
    - /mnt:/mnt
    environment:
    - EULA=TRUE
    - TYPE=AUTO_CURSEFORGE
    - CF_SLUG=valhelsia-5
    - CF_FILE_ID=modpack id
    - CF_API_KEY=api key
    - TZ=Europe/Berlin
    - MEMORY=4G
    - ENABLE_RCON=true
    - RCON_PASSWORD=secret
    - RCON_PORT=25575
    ports:
      - 25565:25565
      - 25575:25575
    restart: unless-stopped

Name		Name	Last commit message	Last commit date
Latest commit History 20 Commits
tutorials/wordpress		tutorials/wordpress
.gitignore		.gitignore
README.md		README.md

DannieKr/Ultimate-Guide-To-VPS

Folders and files

Latest commit

History

Repository files navigation

Ultimate Guide To VPS

Introduction

What is a VPS?

Table of Contents

VPS Providers

VPS Setup

Initial Setup

Operating System

SSH

What is SSH?

Getting started

What is an SSH Key?

Generate an SSH Key

SSH config

Create a new user

Additional Security

SSH

WireGuard

What is WireGuard?

Install WireGuard

Firewall

What is a firewall?

Install Docker

What is Docker?

Install Docker

UFW configuration for Docker

Script to update ufw rules after reboot

Set up a TeamSpeak 3 Server with Docker Compose

Install portainer (skip for now, this section is not final yet)

What is portainer?

Install portainer

Install nginx proxy manager (skip for now, this section is not final yet)

What is nginx proxy manager?

Install nginx proxy manager

Configure nginx proxy manager and portainer

Minecraft Server (skip for now, this section is not final yet)

About

Topics

Resources

Stars

Watchers

Forks