Skip to content

Self-hosting the Server

VelNet's server can be self-hosted with modest resources. The limiting factor will almost always be network bandwidth.

Make sure you have Docker installed, then pull the Docker image using:

docker run -p 5000:5000 -p 5000:5000/udp velaboratory/velnet

or

docker run -p 5050:5000 -p 5050:5000/udp --name velnet velaboratory/velnet

to run on a different port and change the name of the container.

  1. Clone the repo

    • git clone https://github.com/velaboratory/VelNetServerRust.git
  2. Make sure you have Docker and docker-compose installed.

  3. The docker compose file runs both the control panel and the server.

    • To start:
      docker compose up -d
      
    • To stop:

      docker compose stop
      

This builds the images from the local data in the folder, and doesn't pull anything from Docker Hub.

  1. Clone the repo
    • git clone https://github.com/velaboratory/VelNetServerRust.git
  2. Edit config.json to an open port on your firewall
  3. Modify the user field in control-panel/config.json to be your username.
  4. Install rust through using rustup
  5. Install: sudo ./install.sh
  6. Run server: sudo systemctl start velnet
  7. Run control panel: sudo systemctl start velnet-control-panel
  8. Install tuptime: cargo install tuptime
  9. Install onefetch: cargo install onefetch