How to Install

LibreVS — Self-Hosted Installation Guide (Ubuntu Server)

This guide explains how to deploy LibreVS on your own Linux server using Docker.

Requirements:

  • Ubuntu 22.04+ server
  • SSH access
  • Minimum 2 GB RAM recommended
  • Docker and Docker Compose

1. Connect to your server via SSH

Open your terminal and connect:

ssh username@your-server-ip

2. Update your server

Copy following text into terminal and press enter:

sudo apt update && sudo apt upgrade -y

3. Install required tools

Install Git and Curl:

sudo apt install -y git curl

4. Install Docker

Install Docker packages:

sudo apt install -y docker.io docker-compose

5. Enable Docker service

Start Docker and enable it on system startup:

sudo systemctl enable docker
sudo systemctl start docker

6. Add your user to Docker group

Allow Docker commands without sudo:

sudo usermod -aG docker $USER

Log out and reconnect after this step.

7. Verify Docker installation

Check that Docker is running:

docker --version

docker compose version

8. Download LibreVS

Clone the LibreVS repository:

git clone https://github.com/mvplvx/librevs.git

Enter the project folder:

cd librevs

9. Configure environment variables

Create your environment configuration:

cp .env.example .env

Update required settings if needed.

10. Start LibreVS

Build and start the application:

docker compose up -d --build

11. Verify deployment

Check running containers:

docker ps

You should see:

  • LibreVS application container
  • PostgreSQL database container

12. Access LibreVS

Open your browser:

http://your-server-ip:3000

Your LibreVS instance is now running on your own infrastructure.

Data remains under your control.

Returning to LibreVS

After the initial installation, LibreVS remains available on your server and does not need to be reinstalled.

Connect to your server

Open a terminal and connect via SSH:

ssh username@your-server-ip

Navigate to the LibreVS directory

cd librevs

Replace librevs with your installation directory if different.

Check container status

Verify that LibreVS is running:

docker ps

You should see:

  • LibreVS application container
  • PostgreSQL database container

Start LibreVS

If the system is stopped:

docker compose up -d

Stop LibreVS

If you want to shut down the application:

docker compose down

Your data will remain محفوظ in the database and Docker volumes.

View application logs

To view live application logs:

docker compose logs -f

Access LibreVS

Open your browser and navigate to:

http://your-server-ip:3000

LibreVS will load with all previously saved reporting data intact.

Update LibreVS

To install the latest version:

git pull
docker compose up -d --build

Always create a backup before upgrading a production instance.

Backup Recommendation

Regularly back up:

  • PostgreSQL database
  • Docker volumes
  • Exported reports

LibreVS is designed as a self-hosted system. Data ownership and backup responsibility remain with the organization operating the server.