Documentation

• 1: Overview
• 2: Getting Started
• 2.1: Compile from source code
• 2.2: Installation on Linux
• 2.3: Installation on Windows
• 2.4: Run with Docker
• 3: Tutorials
• 3.1: Setting up everything
• 3.2: Uploading content
• 3.3: Video player
• 3.4: Image viewer
• 3.5: Audio player
• 3.6: Navigating and searching
• 3.7: Using albums
• 3.8: Making backups
• 4: Technical Documentation
• 4.1: API documentation
• 4.2: Frontend customization
• 4.3: Server Options
• 4.4: Setting up as service (systemd)
• 4.5: Storage model
• 5: Console Client
• 5.1: Manual

1 - Overview

PersonalMediaVault is an open source tool you can use to create an encrypted, easy to backup and easy to access media gallery.

PersonalMediaVault is a solution to store your personal media files in a secure way, while being able to easily access them from a web browser.

What do I want it for?

You can use PersonalMediaVault to store and organize your media files, being able to securely backup them in the cloud, thanks to them being encrypted.

You can run the server in local, or in a remote server.

If you run it in a server, you can access it from multiple devices, only requiring a modern web browser.

Features

PersonalMediaVault has many useful features. Here is a list of them.

Encrypted storage

Your media files are encrypted with your password.

PersonalMediaVault uses the AES encryption algorithm, with a key length of 256 bits.

Only you, and who you allow, can access the vault. Use a strong password, combined with a password manager for more security.

Easy to backup

The vault is stored in a folder, and always in a consistent status.

You can easily make a backup of the vault by making a copy of the folder.

You can safely store your vault in any cloud service without worrying your files being accessed, since they are encrypted.

Access your vault with a web browser

PersonalMediaVault is implemented as a web application. You can run the server in local, or in a security-hardened server depending on your needs.

You can access the vault from any modern web browser, using the user-friendly and feature-rich web interface it provides.

Support for videos, audios and pictures

You can upload videos, audios or pictures to the vault.

They are automatically classified, given a thumbnail if possible, and encoded for the playback in the browser.

Each kind of media has its own player interface, with both generic and specific features.

Classify your media files with tags

You can give each media file a title, description and classify it with tags.

You can then make searches using those parameters to easily find your media files.

Use albums to create media lists

You can create ordered lists of media files by creating albums.

Albums are the perfect way to easily accessing your favorite media files, or keeping a list of media files in order.

For example a series, a music playlist or a collection of photos of a particular event.

Video player features

The web video player the tool provides has many features, including timeline previews, support for subtitles, support for multiple audio tracks, support for multiple resolutions and event timeline slices.

The audio player also has many of these features, including a sound wave animation to fill the blank space.

Image viewer features

The web image viewer has also many features, including scaling, multiple resolutions and image annotations.

With image annotations, you can add a text that appears on hovering or clicking a zone of the image. It’s very useful for translations or any extra information to add to the image.

Attachments

You can attach any file to a media file.

The attachment will also be encrypted with the same level of security and stored into the media vault, within the media file.

This can be very useful to store related documents, or original media files you don’t want to be encoded, but stored raw.

Fast and performant

PersonalMediaVault is made to be fast and performant.

The server and main tools are built with the Go programming language. The web interface has very small bundle sizes. Multiple caches are in place to further reduce latency.

Docker

PersonalMediaVault provides a Docker image, so you can easily run a server in the cloud without worrying about dependencies or installations.

You can find the images both on Docker Hub and in GitHub Packages.

Console client

PersonalMediaVault provides a command line interface client for PersonalMediaVault, so you can access your vault even from a terminal.

This CLI tool can be also used to make automated scripts, in case you need them for advanced tasks.

What is it not for?

PersonalMediaVault is not an end-to-end encryption storage service. The server is meant to be run by the owner of the media files, either in local or into a personal server.

Where should I go next?

• Getting Started: Download, install and run PersonalMediaVault
• Tutorials: Check out some guides and tutorials on how to use PersonalMediaVault.

2 - Getting Started

In this section we explain how to download, install and run PersonalMediaVault for the first time.

Download

Check out the Releases section on GitHub to find pre-compiled installation packages.

If you do not find installation packages for your system, you can:

• Compile it from source code
• Run it with Docker

Installation

Depending on your operating system, we offer you the following installation guides:

• Installation on Linux
• Installation on Windows

The installation guides also explain how to create a vault and run it in your system.

Next steps

After installing and creating your first vault, you may want to check out the Tutorials section for more guides and tutorial on how to use PersonalMediaVault.

2.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.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.

2.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.

2.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

3 - Tutorials

This section contains tutorials on varios aspects of PersonalMediaVault.

Check the list below in order to find what you are looking for.

If you can’t find what you’re looking for, feel free to start a discussion on GitHub.

3.1 - Setting up everything

After you launched the vault server, you will be given an URL to connect to the vault using a web browser.

Most modern browsers are supported, including Chromium-based browser, Firefox-based browsers or Webkit-based browsers.

The fist screen you will see is a login screen asking for your vault credentials to unlock the vault. You have to use the credentials you provide when creating the vault. If you didn’t specify any credentials, by default, the username is admin and the password is also admin.

After you successfully log into your vault, you will be presented with the PersonalMediaVault main interface:

Let’s get familiar with the interface elements!

Menu sidebar

First, you have sidebar at the left. You can toggle its visibility with the button at the top left corner. The sidebar has the following elements:

• The Home view, where you can access to all the media assets you have, in upload order.
• The Search results view, only visible when you are filtering by a tag. Very similar to the Home view, but filtered.
• The Albums view, when you can access every album existing in your vault.
• The Upload view, where you can upload media files into your vault.
• The Random view, witch gives you random media files existing in your vault.
• The Advanced search view, where you can search for media files in your vault, by title, description, type, tags or album.

Below the main options, a list of albums will be displayed, ordered by usage or preference.

Top bar

In the top bar you will find a search bar, and three buttons.

The search bar lets you find tags and albums in your vault. You can type the name, or part of it, and filter by a tag or go into an album.

The top bar buttons are the following, from left to right:

• The question mark button will display the help menu, letting you know the current version of your PersonalMediaVault instance or giving your information about the documentation or the keyboard shortcuts.
• The cog button will display the vault settings menu. We’ll explain this menu in details in the next section of this tutorial.
• The log out button will display a confirmation modal asking you to close the vault session and lock the vault.

Vault settings menu

The vault settings menu has all the options you need to set your vault up. Let’s dive into them and make the necessary actions.

Change theme

Click in the Change theme (Dark / Light) option in order to select the theme you prefer for the web interface.

By default, PersonalMediaVault will detect your browser theme.

By selecting your preferred theme, PersonalMediaVault will save that preference in the local storage of your browser. In order to remember it in future sessions.

Change language

Click in the Change language option to select your language.

By default, PersonalMediaVault will detect your browser language.

By selecting your preferred language, PersonalMediaVault will save that preference in the local storage of your browser. In order to remember it in future sessions.

Isn’t your language yet supported? Feel free to contribute with a pull request to add a new language. In order to add a new language, check the frontend/src/locales folder. Copy locale-en.json and translate every key to your language.

Change username

Click in the Change username option in order to change your username. This is the username you use to unlock the vault.

In order to change it, you must also provide your current password.

Change password

Click in the Change password option in order to change your password. This is the password you use to unlock the vault.

In order to change it, you must also provide your current password.

Make sure to use a very strong password, using letters (uppercase and lowercase), numbers and symbols.

Is it recommended to use a password manager, and making a backup of your password. If you lose your password, it will be impossible to recover the vault content, since it’s encrypted with that password.

Invite

Click in the Invite option in order to invite users or devices to access the vault.

This feature will allow you to generate single-use codes that can be used to access the vault in read-only mode.

Administrate accounts

The Administrate accounts option will show you a list of extra accounts for your vault, allowing you to create new ones or delete existing ones.

This feature is useful when you have family or friend you want to share the vault with. You can make read-only accounts for them.

If this use case does not fit your needs, you can just ignore this option.

Tasks

The Tasks option will show you the list of current tasks running for the vault. These tasks and encoding or resizing tasks. They will be created the moment you upload media to your vault.

This option is rarely used, but it can give you a global view of all the tasks running, in case you need to know.

Advanced settings

Click in the Advanced settings option to configure your vault advanced settings. This option will show a modal with 3 tabs.

The first tab, called General will allow you to configure the following:

• The vault title, displayed as the website title. By default is it Personal Media Vault.
• The max number of tasks allowed to run in parallel. Depending on your server capabilities, you may want to increase or decrease it.
• The max number of threads to use for each task. By default is 0, meaning it will use as many as optimal. You can set it in order to restrict the CPU usage.
• The video previews interval, in seconds. Each interval, PersonalMediaVault will make a preview of a video in order to display them when hovering the timeline.

The second tab, called Extra resolutions will allow you to enable certain extra resolutions to use for small screens, in order to save memory and bandwidth. If you plan to use from a tablet or a mobile device, you may want to enable some of them.

The third tab, called Custom style will let you specify custom CSS code to apply to the web interface. You can use this to make your own theme. However, this option is very advanced and requires CSS knowledge. If you do not have such knowledge or you are not interesting in a custom theme, just ignore this option.

Batch operation

The Batch operation option will let you apply a batch operation to a subset of your vault media assets.

You can filter by title, description, tags or album.

You can apply any of the following operations:

• Adding tags.
• Removing tags
• Adding media into an album
• Removing media from an album
• Deleting media from the vault

This can be useful if you want to make a change to many media assets, saving you time.

3.2 - Uploading content

In order to add media files into your vault, you may use the Upload option in the main menu.

You can drag and drop files into the box with dotted border, or click it to open the file selector.

Once you select a file, a modal will open asking you to confirm it, while allowing you to add the media into an album, and add tags. This is very useful when you upload multiple times at once that share some tags.

When the upload process finishes, you can check the uploaded media in the Ready tab.

If the upload process fails for some reason, it will be placed in the Error tab.

Max number of uploads in parallel

You can easily change the max number of uploads in parallel to speed up an upload process of many items.

By default it is 1, but you can increase it up to 64, and it will take effect even in the middle of the upload process, so do not worry changing it to upload the speed if you need it.

There is a inconvenience when doing this, when adding into an album, parallel uploads will place the items in an arbitrary order, depending on how fast the upload finishes. Thats is why, when uploading items into an album in order, usually you will prefer uploading one by one.

3.3 - Video player

When selecting a video in the media vault, the video player will be used in order to play it.

The PersonalMediaVault video player is a feature rich player based on the YouTube video player:

• At the top-left, you have the video title
• At the top-right, you have a button to open the video metadata editor.
• At the bottom you have the player controls, and on top of them, you have the timeline.

Basic controls

In order to play or pause, you can simply click the player at the center, use the play button in the player controls bar, or using a keyboard shortcut: Space Bar or K.

In order to change the volume, you can use the volume control in the player controls bar, which displays a slider when hovering it or clicking it. You can also use a keyboard shortcut, being the Up and Down arrow keys, which will change the volume by 5%. You can press Shift while using the vertical arrow keys in order to fine-tune the volume by changing it 1% each key press.

You can mute or un-mute the video by clicking on the volume control in the player controls bar, or using the key M.

By pressing the configuration button or the S key, you can open the video player configuration.

By pressing the full screen button, or the F key, you can toggle the full screen mode for the video player.

Timeline

You can hover the timeline in order to get the timestamp you are hovering into, and an image preview, if available.

You can click the timeline in order to change the current time.

You can use the Home key to go to the beginning of the video. Also, you can use the End key to go to the end of the video.

You can also use the Left and Right arrow keys to go backward or forward by 5 seconds respectively.

Also, if the player is paused, you can use the dot and comma keys to go backward or forward by a single frame respectively.

Configuration

You can open the player configuration by pressing the configuration button or the S key.

You can find several options:

• You can toggle the loop option. If enabled, the player will automatically replay the video from the beginning after it ending. You can press the L key to do the same.
• You can toggle the auto-next option. If enabled, the player will attempt to play the next media in the list after the current video finishes playing.
• You can change the playback speed, to accelerate it or slow it down.
• You can change the scale of the video, in order to zoom-in to check small details.
• You can change the video quality (resolution and frames per seconds) between the available ones.
• You can also change the subtitles, and the audio track, if they are available for your video.
• You can also change the toggle play delay, being the play/pause delay when you click the player at its center.

Context menu

When right clicking with a mouse, or with a long tap in touch devices, it will open the player context menu, with several options for fast access to them.

You can find several options:

• You can toggle the loop option. If enabled, the player will automatically replay the video from the beginning after it ending. You can press the L key to do the same.
• You can hide or show the controls. When done with this options, the controls will stay hidden until you disable the option. You can press the C key to do the same.
• You can open the tags editor. You can also press the T key to open it.
• You can open the time slices editor. You can also press the N key to open it.
• You can open the extended description, being an arbitrary text to attach to the media. You can also press the I key to open it.
• You can download the video file.
• You can check the size of the files stored in the vault.
• You can refresh the media, reloading it from the server.

Editor

You can open the player editor by clicking the expand button at the top right corner of the player. Also you can press the E key.

The player editor allows you to change any aspect of the video.

In the General tab you can change the title of the video, its description and thumbnail. You can also enable extra flags, like resetting the time when loading the video every time, instead of restoring the previous time.

In the Tags tab you can change the media tags. You can use the tags to find the media later when searching for it.

You also have other tabs we explain in detail in the sections below.

Subtitles

You can add subtitles to the video in the Subtitles tab of the player editor. You can add them by uploading SubRip files, with .srt extension.

If you upload a Matroska file (.mkv extension) to the vault, the available subtitles will be automatically extracted.

When a video has subtitles, you can select them at the player configuration menu, while also being able to customize their style.

Audio tracks

You can add extra audio tracks for the video in the Audio Tracks tab of the player editor. You can add them by uploading audio files, for example with .mp3 extension.

If you upload a Matroska file (.mkv extension) to the vault, the available audio tracks will be automatically extracted.

When a video has extra audio tracks, you can select the one that will play at the player configuration menu.

Time slices

You can split the video in different slices by clicking the option in the context menu, or pressing the N key. This will open an editor where you can add time slices, specifying the start time, and a name.

You can also change the time slices in text mode by going to the Time slices tab of the player editor.

Attachments

You can add attachments to the video by going to the Attachments tab of the player editor.

Attachments are arbitrary files you can store in the vault along with the media file, for example the original uncompressed video or the assets used to make it.

Resolutions

In the Resolutions tab of the player editor, you will be able to resize the video to different resolutions, in order to play it in smaller screens without wasting bandwidth.

Once a resolution is available, you will be able to select it from the player configuration menu.

Danger zone

In the Danger zone tab of the player editor, you can:

• Re-encode the video, in order to attempt to fix encoding errors.
• Delete the video from the vault, which requires confirmation. You can also use the Delete key.

3.4 - Image viewer

When selecting an image in the media vault, the image viewer will be used in order to display it.

The PersonalMediaVault image viewer is very similar to the video player:

• At the top-left, you have the image title
• At the top-right, you have a button to open the image metadata editor.
• At the bottom you have the viewer controls.

Basic controls

You can change the image scale with the scale control, which displays when hovering or clicking on it. The scale can be a percentage of the display width, or can be set to fit the image into the available space:

• Click the scale button, or press the Space bar, in order to toggle the image fitting mode.
• Drag the scale control or press the + and - keys to increase or decrease the scale by 10% respectively.
• You can press the Shift key, along with the + and - keys to increase or decrease the scale by 1% respectively.

By pressing the configuration button or the S key, you can open the image viewer configuration.

By pressing the full screen button, or the F key, you can toggle the full screen mode for the image viewer.

Configuration

You can open the viewer configuration by pressing the configuration button or the S key.

You can find several options:

• You can hide or show image notes.
• You can change the image quality (resolution), between the available ones.
• You can change the image background, for images with transparency.
• You can change the auto-next option. If enabled, the next media in the list will play after a certain number of seconds have passed.

Context menu

When right clicking with a mouse, or with a long tap in touch devices, it will open the viewer context menu, with several options for fast access to them.

You can find several options:

• You can toggle the image size fitting mode. If enabled, the image will be automatically resized and centered to fit in the available size.
• You can hide or show the controls. When done with this options, the controls will stay hidden until you disable the option. You can press the C key to do the same.
• You can open the tags editor. You can also press the T key to open it.
• You can open the image notes editor. You can also press the N key to open it.
• You can open the extended description, being an arbitrary text to attach to the media. You can also press the I key to open it.
• You can download the image file.
• You can check the size of the files stored in the vault.
• You can refresh the media, reloading it from the server.

Editor

You can open the viewer editor by clicking the expand button at the top right corner of the viewer. Also you can press the E key.

The viewer editor allows you to change any aspect of the image.

In the General tab you can change the title of the image, its description and thumbnail.

In the Tags tab you can change the media tags. You can use the tags to find the media later when searching for it.

You also have other tabs we explain in detail in the sections below.

Image notes

You can add annotation to the image by clicking the option in the context menu, or pressing the N key. This will toggle a mode where you can drag in order to add notes to the image, while being able to move and resize the existing ones.

When out of the image notes editor mode, they will be displayed as translucid squares that will display its corresponding text by hovering or clicking on them.

You can use image notes, for example, to name elements of the image, add extra information or translate texts in a foreign language.

You can also change the image notes in text mode by going to the Image Notes tab of the viewer editor, very useful to import and export notes.

Attachments

You can add attachments to the video by going to the Attachments tab of the viewer editor.

Attachments are arbitrary files you can store in the vault along with the media file, for example the original uncompressed image or the assets used to make it.

Resolutions

In the Resolutions tab of the viewer editor, you will be able to resize the image to different resolutions, in order to display it in smaller screens without wasting bandwidth.

Once a resolution is available, you will be able to select it from the viewer configuration menu.

Danger zone

In the Danger zone tab of the viewer editor, you can:

• Re-encode the image, in order to attempt to fix encoding errors.
• Delete the image from the vault, which requires confirmation. You can also use the Delete key.

3.5 - Audio player

When selecting an audio in the media vault, the audio player will be used in order to play it.

The PersonalMediaVault video player is very similar to the video player, adapted for audio files:

• At the top-left, you have the audio title
• At the top-right, you have a button to open the audio metadata editor.
• At the bottom you have the player controls, and on top of them, you have the timeline.

Basic controls

In order to play or pause, you can simply click the player at the center, use the play button in the player controls bar, or using a keyboard shortcut: Space Bar or K.

In order to change the volume, you can use the volume control in the player controls bar, which displays a slider when hovering it or clicking it. You can also use a keyboard shortcut, being the Up and Down arrow keys, which will change the volume by 5%. You can press Shift while using the vertical arrow keys in order to fine-tune the volume by changing it 1% each key press.

You can mute or un-mute the audio by clicking on the volume control in the player controls bar, or using the key M.

By pressing the configuration button or the S key, you can open the audio player configuration.

By pressing the full screen button, or the F key, you can toggle the full screen mode for the audio player.

Timeline

You can hover the timeline in order to get the timestamp you are hovering into.

You can click the timeline in order to change the current time.

You can use the Home key to go to the beginning of the audio. Also, you can use the End key to go to the end of the audio.

You can also use the Left and Right arrow keys to go backward or forward by 5 seconds respectively.

Also, if the player is paused, you can use the dot and comma keys to go backward or forward by a single frame respectively.

Configuration

You can open the player configuration by pressing the configuration button or the S key.

You can find several options:

• You can toggle the loop option. If enabled, the player will automatically replay the audio from the beginning after it ending. You can press the L key to do the same.
• You can toggle the auto-next option. If enabled, the player will attempt to play the next media in the list after the current audio finishes playing.
• You can change the playback speed, to accelerate it or slow it down.
• You can change the animation style used to represent the audio wave.

Context menu

When right clicking with a mouse, or with a long tap in touch devices, it will open the player context menu, with several options for fast access to them.

You can find several options:

• You can toggle the loop option. If enabled, the player will automatically replay the video from the beginning after it ending. You can press the L key to do the same.
• You can open the tags editor. You can also press the T key to open it.
• You can open the time slices editor. You can also press the N key to open it.
• You can open the extended description, being an arbitrary text to attach to the media. You can also press the I key to open it.
• You can download the audio file.
• You can check the size of the files stored in the vault.
• You can refresh the media, reloading it from the server.

Editor

You can open the player editor by clicking the expand button at the top right corner of the player. Also you can press the E key.

The player editor allows you to change any aspect of the audio.

In the General tab you can change the title of the audio, its description and thumbnail. You can also enable extra flags, like resetting the time when loading the audio every time, instead of restoring the previous time.

In the Tags tab you can change the media tags. You can use the tags to find the media later when searching for it.

You also have other tabs we explain in detail in the sections below.

Subtitles

You can add subtitles to the audio in the Subtitles tab of the player editor. You can add them by uploading SubRip files, with .srt extension.

When an audio has subtitles, you can select them at the player configuration menu, while also being able to customize their style.

Time slices

You can split the audio in different slices by clicking the option in the context menu, or pressing the N key. This will open an editor where you can add time slices, specifying the start time, and a name.

You can also change the time slices in text mode by going to the Time slices tab of the player editor.

Attachments

You can add attachments to the audio by going to the Attachments tab of the player editor.

Attachments are arbitrary files you can store in the vault along with the media file, for example the original uncompressed audio or the assets used to make it.

Danger zone

In the Danger zone tab of the player editor, you can:

• Re-encode the audio, in order to attempt to fix encoding errors.
• Delete the audio from the vault, which requires confirmation. You can also use the Delete key.

3.6 - Navigating and searching

Home page

When you unlock the vault, the first page you see is the Home page, which consists on a paginated gallery containing all the media files you stored in your vault.

By default, it will show the most recent media files first. You can change this clicking on the arrow icon at the top-right, in order to show the oldest media files first.

You can also customize the page by clicking in the cog button at the top-right. This will open a modal where you can change:

• The maximum number of items to load each page.
• The size range of the thumbnails.
• The number of items to try fit in a single row (may not be possible if the size of the thumbnails is too big or too small, try changing both until you get the sizes you like).
• The padding of the thumbnails
• The corner style of the thumbnails
• If you want to display or hide titles.

Random Results

In case you want to load random media files from your media vault, you can try the Random page. This page works similar to the Home page, without the menu.

Each time you reload, a new seed is used, giving you a new set of random results.

Fast search

By typing in the search bar at the top, you can find any album or tag in the vault.

When selecting a tag, it will filter by that tag, showing you a Search results page, identical to the Home page, but only showing the media files containing the tag.

This filter also applies to the Random page, in order to get random, filtered results.

You can clear the filter by clicking on the X button that appears in the search bar when there is an active filter.

Advanced search

If you want a more advanced search system, in order to find a particular file in your vault, you can use the Advanced search page. This page will offer you a variety of options like:

• Filtering by text in title or description
• Filtering by multiple tags
• Filtering by media type (video, audio, picture)
• Filtering by album

Once your filter is set, you can scroll down until you find what you’re looking for.

3.7 - Using albums

You can use albums in order to keep ordered lists of media files in your vault.

In this tutorial we will explain how to create and use them.

Albums list

If you visit the Albums page, you will see the full list of albums existing in your vault.

You can filter by name, and also create new ones from this page.

Creating an album

From the Albums page, click the Create album button in order to create a new album.

You must provide a name for the album and proceed.

After the album is created, you will be redirected to it, being an empty album since it was just created.

Adding media to the album

The first step after creating the album is adding the media files we want inside it.

In order to do this, you have two alternatives:

• Clicking the + button in the album options. This will open a modal where you can upload or search media files in order to add them to the album.

• If you are playing or viewing a media file, you can click the albums button, or press A, in order to open the albums list of the media, where you can add or remove the media from different albums.

Navigating

Once you have multiple media files inside an album, you can navigate using multiple methods:

• Using the Previous and Next buttons of the player.
• Using the Left and Right arrow keys (in combination with Shift if the current media is a video or an audio).
• Using the Page Up and Page Down keys.
• By scrolling through the list and clicking the element you want to navigate to.
• By pressing the G key and specifying the position to navigate into.

In the player configuration you can set the Auto next option, in order to automatically navigate to the next media when the video / audio ends or after a certain amount of time in the case of pictures.

You can set the Loop option for the album by clicking in the corresponding button in the album options. When enabled, the next media of the last element will be the first element, and the previous media of the first element will be the last element.

You can set the Random option for the album by clicking in the corresponding button in the album options. When enabled, the next media will be randomly chosen, and the previous media will be disabled.

Re-ordering and removing elements

By clicking in the Options button of a media file inside the vault, you will get a menu where you can change the position of the media file inside the album, and also delete it from the album.

Also, if you are using a computer, you can drag and drop the elements in order to re-order them in a mode efficient way.

Favorites

You can add the album into favorites by clicking the star button in the album options.

If the album is in favorites, it will appear at the top of the menu sidebar, in order to easily access it.

Renaming

In order to rename the album, click in the pencil button in the album options.

Deleting

In order to delete the album, click in the trash button in the album options.

Note: Deleting the album will not delete any media file inside of it.

3.8 - Making backups

In order to make backups of your vault, you can just make regular copies of the vault folder. Due to its design, it’s always in a consistent status and spreads the data into multiple files, so any external backup tool will work.

Here is the list of alternatives you can use:

• Using the specific tool provided By PersonalMediaVault.
• Using an standard tool, like rsync.
• Using any other external tool, for example the ones provided by the main cloud storage providers.

In this tutorial we’ll explain how to use the backup tool provided by the PersonalMediaVault installation.

Using the backup tool from the launcher

When opening a vault from the launcher, you get a CLI interface with multiple commands.

In order to make a backup, use the backup command:

backup /path/to/backup/folder

In case the destination path is not empty, it will only copy the new files and update the ones that have been modified.

Using the backup tool from the terminal

You can also use the backup tool from the terminal, running the pmv-backup binary:

pmv-backup /path/to/vault /path/to/backup/folder

Re-encrypting

In case you got the encryption key leaked, and it’s no longer secure, you can make a backup re-encrypting everything with a brand new randomly generated encryption key.

In order to do that, use the --re-encrypt option:

pmv-backup /path/to/vault /path/to/backup/folder --re-encrypt

Note: The re-encryption process may take a very long time. Make sure to always use a secure password in order to prevent data leaks in the first place.

4 - Technical Documentation

This section contains technical documents and guides about multiple aspects of PersonalMediaVault.

Check the list below in order to find the information you are looking for.

If you can’t find what you’re looking for, feel free to start a discussion on GitHub.

4.1 - API documentation

4.2 - Frontend customization

This document specifies the vault frontend customization capabilities implemented by the PersonalMediaVault backend, such as custom title, custom style or custom icons.

Custom title and frontend style

You can customize the vault frontend title and also setup custom CSS code if you need it. Simply go to Settings and then Advanced Settings.

The custom title will affect the page base title.

The custom CSS code can be used to do complex stuff, like changing colors or font sizes. Note that this is not a recommended feature, since the style is already optimized for both dark and light theme.

Custom favicon

By default, the PersonalMediaVault backend will serve the official icon.

You can change it by adding a custom favicon.ico into your vault folder.

You may have to clear cache to see the change, since the browser caches the icon to prevent requesting it multiple times.

Custom logos

Similar to the favicon, by default, the official logos will be served.

If you want to change them, you must create a folder inside your vault folder with the name img/icons.

You can copy the official ones and modify them.

4.3 - Server Options

This is a list of all available server options for the PersonalMediaVault backend.

Usage

In order to run the server, you can run the pmvd binary.

In order to see the options, use:

pmvd --help

In order to run the daemon, use:

pmvd --daemon [OPTIONS]

Here is the full list of available options:

Also, here is a list of available debug options:

Also, here is a list of environment variables to configure other options:

4.4 - Setting up as service (systemd)

This technical guide explains how to set up PersonalMediaVault as a service in a Linux machine using systemd.

Make sure to follow the installation guide on Linux before doing this. This guide expects you to have PersonalMediaVault already installed in your system.

The first step for creating a systemd service is to create an user for that service.

In order to create the user, run the following commands:

sudo groupadd pmv
sudo useradd -M pmv -g pmv
sudo usermod -L pmv

After you did this, now it’s time to create a folder to store the vault. In this guide we are going to use /var/pmv/vault.

Run the following commands:

sudo mkdir /var/pmv
sudo mkdir /var/pmv/vault
sudo chown -R pmv:pmv /var/pmv

Then, it’s time to create the service file, run the following command:

sudo nano /etc/systemd/system/pmv.service

Copy the following contents and save it:

[Unit]
Description=PersonalMediaVault
After=network.target auditd.service

[Service]
Type=simple
ExecStart=/usr/bin/pmvd --daemon --log-requests --skip-lock --vault-path /var/pmv/vault
User=pmv
Group=pmv
WorkingDirectory=/var/pmv/vault
Environment=FRONTEND_PATH=/usr/lib/pmv/www
Environment=FFMPEG_PATH=/usr/bin/ffmpeg
Environment=FFPROBE_PATH=/usr/bin/ffprobe
Environment=TEMP_PATH=/tmp/pmv
LimitNOFILE=infinity
LimitCORE=infinity
KillMode=process
StandardInput=null
StandardOutput=syslog
StandardError=syslog
Restart=always

[Install]
WantedBy=multi-user.target

Note: You may want to change some options. For that, make sure to check the following:

• Server options for PersonalMediaVault
• Systemd service file manual

After you saved the service file, and exited the editor, run the following command to enable the service, so it runs every time the system starts:

sudo systemctl enable pmv

Then, you can start it:

sudo systemctl start pmv

After it was started, you can check the logs with journalctl. Example:

sudo journalctl -u pmv

You can also check the service status with:

sudo systemctl status pmv

4.5 - Storage model

This is the documentation for the vault storage model, including the types of files it uses, their internal structure and the encryption algorithms used.

Use this document as reference for any software development that requires interaction with the vault files.

File types

The vault storage model uses different types of files:

• Lock file: File used to prevent multiple instances of PersonalMediaVault accessing the same vault.
• Unencrypted JSON files: Configuration files that do not contain any protected vault data.
• Encrypted JSON files: Used to store metadata.
• Index files: Used to store lists of media asset IDs, in order to make searching faster.
• Encrypted assets: Encrypted files containing the media assets. They can be single-file or multi-file.

Lock file

The lock file has the .lock extension.

It stores in plain text, a decimal number representing the PID of the current Process accessing the vault.

PersonalMediaVault backend should check for the existence of this file and the process before accessing the vault.

Unencrypted JSON files

Unencrypted JSON files have the .json extension.

They follow the JSON format. The schema varies depending on the specific file.

Since they are not encrypted, they just store configuration, like the port it should listen, or the encryption parameters.

Encrypted JSON files

Encrypted JSON files have the .pmv extension.

They take as a base a JSON plaintext, that is encrypted using an algorithm like AES.

They are binary files, with the following structure:

The system is flexible enough to allow multiple encryption algorithms. Currently, there are 2 supported ones:

• AES256_FLAT: ID = 1, Uses ZLIB (RFC 1950) to compress the data, and then uses AES with a key of 256 bits to encrypt the data, CBC as the mode of operation and an IV of 128 bits. This algorithm uses a header containing the following fields:

• AES256_FLAT: ID = 2, Uses AES with a key of 256 bits to encrypt the data, CBC as the mode of operation and an IV of 128 bits. This algorithm uses a header containing the following fields:

Index files

Index files have the .index extension.

They are sorted lists of media assets identifiers. They can store all the existing identifiers, or a fraction of them, for example, for a tag.

Thanks to being sorted, searching for a specific identifier can be achieved using binary search.

They are binary files, consisting of the following fields:

Encrypted assets

Encrypted assets have the .pma extension.

They stored one or multiple encrypted files.

They are also binary files, and they can be of two types:

• Single-File encrypted assets: They store a single file in size-limited chunks. Their name usually starts with s_.
• Multi-File encrypted assets: They store multiple smaller files. Their name usually starts with m_.

Single-File encrypted assets

These asset files are used to store a single and possibly big file in chunks, encrypted each chunk using the same method described by the Encrypted JSON files section.

They are binary files consisting of 3 contiguous sections: The header, the chunk index and the encrypted chunks.

The header contains the following fields:

After the header, the chunk index is stored. For each chunk the file was split into, the chunk index will store a metadata entry, withe the following fields:

After the chunk index, the encrypted chunks are stored following the same structure described in the Encrypted JSON files section.

This chunked structure allows to randomly access any point in the file as a low cost, since you don’t need to decrypt the entire file, only the corresponding chunks. This capability is specially great for video rewinding and seeking.

Multi-File encrypted assets

These asset files are used to store multiple smaller files, meant to be sorted and accessed by an index number.

They are binary files consisting of 3 contiguous sections: The header, the file table and the encrypted files.

The header contains the following fields:

After the header, a file table is stored. For each file stored by the asset, a metadata entry is stored, with the following fields:

After the file table, each file is stored following the same structure described in the Encrypted JSON files section.

This format is useful to store video previews, without the need to use too many files.

Vault folder structure

Media vaults are stored in folders. A vault folder may contain the following files and folders:

Media assets folder

The media assets are stored inside the media folder.

In order to prevent the folder size to increase too much, the assets are distributed evenly in 256 sub-folders. The sub-folder name for each media asset is calculated from its identifier, since it’s a 64 bit unsigned integer, the folder name is the identifier module 256, and the result turned into a 2 character hex lowercased string

Examples: 00, 01, 02…, fd, fe, ff.

Inside each subfolder, the assets are stored inside their own folders, named by turning their identifier into a decimal string. Examples:

• media_id=0 - Stored inside {VAULT_FOLDER}/media/00/0
• media_id=15 - Stored inside {VAULT_FOLDER}/media/0f/15

import (
    "fmt",
    "hex", 
    "path",
)

func GetMediaAssetFolder(vault_path string, media_id uint64) string {
    subFolderName := hex.EncodeToString([]byte{ byte(media_id % 256) });

    return path.Join(vault_path, "media", subFolderName, fmt.Sprint(media_id))
}

The media asset folder may contain up to 3 types of files:

• Media asset metadata file: Named meta.pmv and used to store metadata.
• Single-File assets: Named concatenating the s_ prefix and the asset ID in decimal, with .pma extension.
• Multi-File assets: Named concatenating the m_ prefix and the asset ID in decimal, with .pma extension.

Media asset metadata file

Each media asset folder must contain a file named meta.pmv, being an encrypted JSON file containing the metadata of the media asset.

The file contains the following fields:

The Resolution object has the following fields:

The Subtitle object has the following fields:

The TimeSplit object has the following fields:

The AudioTrack object has the following fields:

The Attachment object has the following fields:

The image notes asset is a JSON file, containing an array of ImageNote objects, with the following fields:

Tag indexes folder

When a tag is added to the vault, a new index file is created inside the tags folder, with a name made by concatenating the tag_ prefix with the tag identifier encoded in decimal, and the .index extension.

import (
    "fmt",
    "path",
)

func GetTagIndexPath(vault_path string, tag_id uint64) string {
	return path.Join(vault_path, "tags", "tag_"+fmt.Sprint(tag_id)+".index")
}

Each tag index file contains the list of media asset identifiers that have such tag.

Credentials file

The credentials file, named credentials.json is an unencrypted JSON file used to store the hashed credentials, along with the encrypted vault key.

The JSON file contains the following fields:

Each Account is an object with the following fields:

Currently, the following methods are implemented:

• AES256 + SHA256 + SALT16 - Identifier: aes256/sha256/salt16

AES256 + SHA256 + SALT16

This algorithm uses a random salt of 16 bytes (128 bits).

The password hash is calculated by using the SHA256 algorithm 2 times on the binary concatenation of the password (as UTF-8) and the random salt:

import (
    "sha256"
)

func ComputePasswordHash(password string, salt []byte) []byte {
	firstHash := sha256.Sum256(append([]byte(password), salt...))
	secondHash := sha256.Sum256(firstHash[:])
	return secondHash[:]
}

The vault ket is encrypted using the AES256 algorithm, using the system defined in the Encrypted JSON files section. Specifically using the AES256_FLAT mode.

The key for the encryption is calculated by hashing with SHA256 the the binary concatenation of the password (as UTF-8) and the random salt:

import (
    "sha256"
)

func ComputeAESEncryptionKey(password string, salt []byte) []byte {
	passwordHash := sha256.Sum256(append([]byte(password), salt...))
	return passwordHash[:]
}

Media ID tracker

The media ID tracker file, named media_ids.json is an unencrypted JSON file used to store the number of used media identifiers, very important to prevent duplicated identifiers.

The JSON file has just one field:

Tasks tracker

The task tracker file, named tasks.json is an unencrypted JSON file used to store the number of used task identifiers, in order to prevent duplicates. It also stores the pending tasks, in order to continue them in case of a vault restart.

The JSON file contains the following fields:

The PendingTask objects have the following fields:

Albums file

The albums file, named albums.pmv is an encrypted JSON file used to store the list of existing albums in the vault.

The file has the following fields:

The Album object has the following fields:

Tags file

The tags file, named tag_list.pmv is an encrypted JSON file used to store the list of existing tags in the vault.

The file has the following fields:

User configuration file

The user configuration file, named user_config.pmv is an encrypted JSON file used to store the vault configuration set by the user.

The file has the following fields:

The VideoResolution object has the following fields:

The ImageResolution object has the following fields:

Main index file

The main index file, named main.index is an index file containing every single media asset identifier existing in the vault.

This file is used to check if a media asset exists and to perform searches when a tag filter is not specified.

5 - Console Client

This section contains the documentation about the PersonalMediaVault console client.

The PersonalMediaVault console client is a CLI application developed in the Rust programming language that can be used to interact with the PersonalMediaVault server without a GUI environment or inside shell scripts.

Download

In order to download the tool, go to the Releases and download the binary for your system

You can find its source code at the pmv-cli repository. You can compile it yourself following the instructions provided in the README document.

Usage

In order to use the tool, place the binary inside a folder in your PATH environment variable.

Run the tool help command to see the manual:

pmv-cli --help

For more information, check the Manual

5.1 - Manual

This is the manual for the PersonalMediaVault console client.

Usage:

pmv-cli [OPTIONS] <COMMAND>

Commands:

Options:

Command: login

Logins into an active vault, printing a session URL into the standard output

Usage:

pmv-cli login [OPTIONS]

Options:

Command: logout

Closes the active session, given a session URL

Usage:

pmv-cli logout

Options:

Command: account

Manages accounts

Usage:

pmv-cli account <COMMAND>

Commands:

Options:

Command: account context

Prints account context to the standard output

Usage:

pmv-cli account context

Options:

Command: account change-username

Changes username (only for root account)

Usage:

pmv-cli account change-username <USERNAME>

Arguments:

Options:

Command: account change-password

Changes account password

Usage:

pmv-cli account change-password

Options:

Command: account list

List accounts

Usage:

pmv-cli account list [OPTIONS]

Options:

Command: account create

Creates new account

Usage:

pmv-cli account create [OPTIONS] <USERNAME>

Arguments:

Options:

Command: account delete

Deletes an existing account

Usage:

pmv-cli account delete <USERNAME>

Arguments:

Options:

Command: media

Manages media assets

Usage:

pmv-cli media <COMMAND>

Commands:

Options:

Command: media get

Gets media asset metadata and download links

Usage:

pmv-cli media get <MEDIA>

Arguments:

Options:

Command: media stats

Gets media asset size stats

Usage:

pmv-cli media stats <MEDIA>

Arguments:

Options:

Command: media download

Downloads a media asset

Usage:

pmv-cli media download [OPTIONS] <MEDIA> [ASSET]

Arguments:

Options:

Command: media export

Exports a media asset, downloading everything (metadata + assets) into a folder

Usage:

pmv-cli media export [OPTIONS] <MEDIA>

Arguments:

Options:

Command: media upload

Uploads a new media asset, waits for encryption and adds tags if specified

Usage:

pmv-cli media upload [OPTIONS] <PATH>

Arguments:

Options:

Command: media import

Imports a media asset, expecting a folder with the same format the export command uses

Usage:

pmv-cli media import [OPTIONS] <PATH>

Arguments:

Options:

Command: media set-title

Changes the title of a media asset

Usage:

pmv-cli media set-title <MEDIA> <TITLE>

Arguments:

Options:

Command: media set-description

Changes the description of a media asset

Usage:

pmv-cli media set-description <MEDIA> <DESCRIPTION>

Arguments:

Options:

Command: media set-extended-description

Changes the extended description of a media asset

Usage:

pmv-cli media set-extended-description <MEDIA> <PATH>

Arguments:

Options:

Command: media set-force-start-beginning

Changes the forced start from beginning parameter of a media asset

Usage:

pmv-cli media set-force-start-beginning <MEDIA> <FORCE_START_BEGINNING>

Arguments:

Options:

Command: media set-is-animation

Changes the is-animation parameter of a media asset

Usage:

pmv-cli media set-is-animation <MEDIA> <IS_ANIMATION>

Arguments:

Options:

Command: media set-thumbnail

Sets the thumbnail of a media asset

Usage:

pmv-cli media set-thumbnail <MEDIA> <PATH>

Arguments:

Options:

Command: media get-time-slices

Prints the time slices of a media asset

Usage:

pmv-cli media get-time-slices <MEDIA>

Arguments:

Options:

Command: media set-time-slices

Sets the time slices of a media asset

Usage:

pmv-cli media set-time-slices <MEDIA> <PATH>

Arguments:

Options:

Command: media set-image-notes

Sets the image notes of a media asset

Usage:

pmv-cli media set-image-notes <MEDIA> <PATH>

Arguments:

Options:

Command: media add-resolution

Adds new resolution to the media asset

Usage:

pmv-cli media add-resolution <MEDIA> <RESOLUTION>

Arguments:

Options:

Command: media remove-resolution

Removes a resolution from the media asset

Usage:

pmv-cli media remove-resolution <MEDIA> <RESOLUTION>

Arguments:

Options:

Command: media add-subtitle

Adds subtitle file to a media asset

Usage:

pmv-cli media add-subtitle [OPTIONS] <MEDIA> <SUB_ID> <PATH>

Arguments:

Options:

Command: media rename-subtitle

Renames a subtitles file

Usage:

pmv-cli media rename-subtitle [OPTIONS] <MEDIA> <SUB_ID>

Arguments:

Options:

Command: media remove-subtitle

Removes subtitle file from a media asset

Usage:

pmv-cli media remove-subtitle <MEDIA> <SUB_ID>

Arguments:

Options:

Command: media add-audio

Adds audio track file to a media asset

Usage:

pmv-cli media add-audio [OPTIONS] <MEDIA> <TRACK_ID> <PATH>

Arguments:

Options:

Command: media rename-audio

Renames an audio track file

Usage:

pmv-cli media rename-audio [OPTIONS] <MEDIA> <TRACK_ID>

Arguments:

Options:

Command: media remove-audio

Removes audio track file from a media asset

Usage:

pmv-cli media remove-audio <MEDIA> <TRACK_ID>

Arguments:

Options:

Command: media add-attachment

Adds attachment file

Usage:

pmv-cli media add-attachment <MEDIA> <PATH>

Arguments:

Options:

Command: media rename-attachment

Renames attachment file

Usage:

pmv-cli media rename-attachment <MEDIA> <ATTACHMENT_ID> <NAME>

Arguments:

Options:

Command: media remove-attachment

Removes attachment file

Usage:

pmv-cli media remove-attachment <MEDIA> <ATTACHMENT_ID>

Arguments:

Options:

Command: media re-encode

Re-Encodes a media asset

Usage:

pmv-cli media re-encode <MEDIA>

Arguments:

Options:

Command: media replace

Replaces the media asset with another file

Usage:

pmv-cli media replace <MEDIA> <PATH>

Arguments:

Options:

Command: media delete

Deletes a media asset

Usage:

pmv-cli media delete <MEDIA>

Arguments:

Options:

Command: random

Retrieves random media assets from the vault

Usage:

pmv-cli random [OPTIONS]

Options:

Command: search

Searches for media assets in the vault (Basic)

Usage:

pmv-cli search [OPTIONS]

Options:

Command: advanced-search

Searches for media assets in the vault (Advanced)

Usage:

pmv-cli advanced-search [OPTIONS]

Options:

Command: tag

Manages tags

Usage:

pmv-cli tag <COMMAND>

Commands:

Options:

Command: tag list

List tags

Usage:

pmv-cli tag list [OPTIONS]

Options:

Command: tag add

Adds a tag to a media asset

Usage:

pmv-cli tag add <TAG> <MEDIA>

Arguments:

Options:

Command: tag remove

Removes a tag from a media asset

Usage:

pmv-cli tag remove <TAG> <MEDIA>

Arguments:

Options:

Command: album

Manages albums

Usage:

pmv-cli album <COMMAND>

Commands:

Options:

Command: album list

List albums

Usage:

pmv-cli album list [OPTIONS]

Options:

Command: album get

Get album and prints it

Usage:

pmv-cli album get [OPTIONS] <ALBUM>

Arguments:

Options:

Command: album create

Creates a new album

Usage:

pmv-cli album create <NAME>

Arguments:

Options:

Command: album rename

Renames an album

Usage:

pmv-cli album rename <ALBUM> <NAME>

Arguments:

Options:

Command: album delete

Deletes album

Usage:

pmv-cli album delete <ALBUM>

Arguments:

Options:

Command: album add

Adds a media asset to an album

Usage:

pmv-cli album add <ALBUM> <MEDIA>

Arguments:

Options:

Command: album remove

Removes a media asset from an album

Usage:

pmv-cli album remove <ALBUM> <MEDIA>

Arguments:

Options:

Command: album set-position

Changes the position of a media asset inside al album

Usage:

pmv-cli album set-position <ALBUM> <MEDIA> <POSITION>

Arguments:

Options:

Command: config

Manages vault configuration

Usage:

pmv-cli config <COMMAND>

Commands:

Options:

Command: config get

Gets vault configuration

Usage:

pmv-cli config get

Options:

Command: config get-css

Gets custom CSS code configured for the vault

Usage:

pmv-cli config get-css

Options:

Command: config set-title

Sets vault title

Usage:

pmv-cli config set-title <TITLE>

Arguments:

Options:

Command: config set-max-tasks

Sets max tasks in parallel

Usage:

pmv-cli config set-max-tasks <MAX_TASKS>

Arguments:

Options:

Command: config set-encoding-threads

Sets number of encoding threads to use

Usage:

pmv-cli config set-encoding-threads <ENCODING_THREADS>

Arguments:

Options:

Command: config set-video-previews-interval

Sets the video previews interval in seconds

Usage:

pmv-cli config set-video-previews-interval <INTERVAL_SECONDS>

Arguments:

Options:

Command: config set-css

Sets custom CSS for the vault

Usage:

pmv-cli config set-css <FILE_PATH>

Arguments:

Options:

Command: config clear-css

Clears custom CSS for the vault

Usage:

pmv-cli config clear-css

Options:

Command: config add-video-resolution

Adds video resolution

Usage:

pmv-cli config add-video-resolution <RESOLUTION>

Arguments:

Options:

Command: config remove-video-resolution

Removes video resolution

Usage:

pmv-cli config remove-video-resolution <RESOLUTION>

Arguments:

Options:

Command: config add-image-resolution

Adds image resolution

Usage:

pmv-cli config add-image-resolution <RESOLUTION>

Arguments:

Options:

Command: config remove-image-resolution

Removes image resolution

Usage:

pmv-cli config remove-image-resolution <RESOLUTION>

Arguments:

Options:

Command: task

Retrieves tasks information

Usage:

pmv-cli task <COMMAND>

Commands:

Options:

Command: task list

Lists current existing tasks

Usage:

pmv-cli task list [OPTIONS]

Options:

Command: task monitor

Monitors tasks

Usage:

pmv-cli task monitor

Options:

Command: task get

Get task status

Usage:

pmv-cli task get <TASK>

Arguments:

Options:

Command: task wait

Waits for a task to finish, monitoring its status

Usage:

pmv-cli task wait <TASK>

Arguments:

Options:

Command: invites

Manages invites

Usage:

pmv-cli invites <COMMAND>

Commands:

Options:

Command: invites check

Prints the current invite code, if any

Usage:

pmv-cli invites check

Options:

Command: invites generate

Generates a new invite code

Usage:

pmv-cli invites generate [OPTIONS]

Options:

Command: invites clear

Clears the current invite code

Usage:

pmv-cli invites clear

Options:

Command: invites list-sessions

List active invited sessions

Usage:

pmv-cli invites list-sessions [OPTIONS]

Options:

Command: invites close-session

Closes an invited session

Usage:

pmv-cli invites close-session <INDEX>

Arguments:

Options:

Command: batch

Applies a batch operation to a list of media assets

Usage:

pmv-cli batch [OPTIONS] <COMMAND>

Commands:

Options:

Command: batch add-tags

Adds tags to the media assets

Usage:

pmv-cli batch add-tags <TAGS>

Arguments:

Options:

Command: batch remove-tags

Removes tags from the media assets

Usage:

pmv-cli batch remove-tags <TAGS>

Arguments:

Options:

Command: batch add-to-album

Adds media assets into an album

Usage:

pmv-cli batch add-to-album <ALBUM>

Arguments:

Options:

Command: batch remove-from-album

Removes media assets from an album, if they were in it

Usage:

pmv-cli batch remove-from-album <ALBUM>

Arguments:

Options:

Command: batch delete

Delete media assets

Usage:

pmv-cli batch delete

Options:

Command: get-server-information

Gets server information, like the version it is using

Usage:

pmv-cli get-server-information

Options: