Getting Started

• 1: Compile from source code
• 2: Installation on Linux
• 3: Installation on Windows
• 4: Run with Docker

1 - Compile from source code

This guide explains how to compile PersonalMediaVault from source code.

Requirements

You will need the following tools installed on your system to compile PersonalMediaVault:

• Git
• Golang, latest stable version
• NodeJS, latest stable version

Install FFMpeg (Dependency)

PersonalMediaVault uses FFmpeg as a dependency to encode media, generate thumbnails among other things.

Download it from the official website and install it into your system.

Make sure the ffmpeg and ffprobe binaries are located inside /usr/bin. If they are not, please, set up the following environment variables in your system:

Clone repository

Clone the PersonalMediaVault repository with the following command:

git clone https://github.com/AgustinSRG/PersonalMediaVault
cd PersonalMediaVault

Compile backend

Navigate to the backend folder and run the compilation script:

cd backend
./build-production.sh
cd ..

The result will be a binary named pmvd. Copy it into /usr/bin

Compile backup tool

Navigate to the backup-tool folder and run the compilation script:

cd backup-tool
./build-production.sh
cd ..

The result will be a binary named pmv-backup. Copy it into /usr/bin

Compile launcher

Navigate to the launcher folder and run the compilation script:

cd launcher
./build-production.sh
cd ..

The result will be a binary named pmv. Copy it into /usr/bin

Compile frontend

Navigate to the frontend folder and run the compilation script:

cd frontend
npm install
npm run build
cd ..

The result will be a folder named dist. Copy its contents into /usr/lib/pmv/www

If you prefer to store the frontend into another path, make sure to set the following environment variable in your system:

Creating and running a vault

In order to create, or open a vault, run the launcher command:

pmv ./my_vault

This command will create a new vault on that folder, asking you for the initial username and password.

After it’s created, it will ask you for the port to run the server, and will start it, opening your default browser.

2 - Installation on Linux

This guide explains how to download and install PersonalMediaVault on a Linux system, using the provided DEB package.

Download

First, download the pre-compiled DEB package from any of the available mirrors.

The file should have a name formatted similar to personalmediavault_A.B-C.deb, replacing A, B and C for the major, minor and patch version number respectively.

Make sure to check the file hash with the sha256sum utility and compare it to the provided hash on GitHub.

sha256sum ./personalmediavault_A.B-C.deb

The hash should perfectly match with the provided one. It is doesn’t, do not continue the installation process, and make an Issue to report the problem.

Installing

Once downloaded, you can install the DEB package into your system with apt:

sudo apt install ./personalmediavault_A.B-C.deb

The installation will also install FFmpeg as a dependency.

After the installation, the binary files will be available in /usr/bin, and the frontend files will be available in /usr/lib/pmv/www.

Creating and running a vault

In order to create, or open a vault, run the launcher command:

pmv ./my_vault

This command will create a new vault on that folder, asking you for the initial username and password.

After it’s created, it will ask you for the port to run the server, and will start it, opening your default browser.

3 - Installation on Windows

This guide explains how to download and install PersonalMediaVault on a Windows system.

Download

Download the MSI installation package from any of the available mirrors.

The file should have a name formatted similar to PersonalMediaVault-A.B.C-x64.msi, replacing A, B and C for the major, minor and patch version number respectively.

Make sure to check the file hash with Powershell and compare it to the provided hash on GitHub.

Get-FileHash -Path "PersonalMediaVault-A.B.C-x64.msi" -Algorithm SHA256

The hash should perfectly match with the provided one. It is doesn’t, do not continue the installation process, and make an Issue to report the problem.

Installing

Once downloaded, run the installer and follow the steps.

The installer should take care of everything for you, installing all the dependencies and placing the binaries in the Program Files folder.

Creating and running a vault

The installer will add an option to the file explorer to open a folder with PersonalMediaVault.

Create a new folder, and use that option to open with PersonalMediaVault.

That will open the launcher, asking you for an initial username and password for your vault.

After the vault is created, it will ask you for a port to run the server, and will start it, opening your default browser.

4 - Run with Docker

This guide explains how to run PersonalMediaVault with Docker.

Pull image

First, select a Docker repository and pull the image

• Docker Hub
• GitHub Packages

Here is an example, if you choose Docker Hub:

docker pull asanrom/pmv

Setup vault

Create a folder where you wish to install the vault, and create a file named docker-compose.yml, with the following content:

version: '3.9'

services:

  pmv:
    image: asanrom/pmv
    ports:
      - '80:80'
      - '443:443'
    volumes:
      - './:/vault'
    restart: unless-stopped
    command: --daemon --clean --log-requests --skip-lock --vault-path /vault

Check the server options for more information of all the available options to run the server.

Running the vault

In order to run the vault, run Docker compose:

docker compose up -d

Go to http://localhost to check out your vault. You can login with:

• Username: admin
• Password: admin

Change your password, and possibly username, and start using your vault.

If you want to stop the vault server, run the following command:

docker compose down