Skip to content

Latest commit

 

History

History
126 lines (83 loc) · 7.08 KB

README.md

File metadata and controls

126 lines (83 loc) · 7.08 KB
Raw

PersonalMediaVault Personal Media Vault

Backend (Go) CI Backup tool (Go) CI Launcher (Go) CI Frontend (Vue) CI License

Web application to store media files (video, audio and pictures) in an encrypted storage, and visualize them using a web browser.

Project motivation

This is a personal project developed with the goal of making a media management tool that has a similar web interface to YouTube, while keeping the media files encrypted in disk.

Why encryption?: When storing your personal pictures, videos or audio recordings, if you store them unencrypted in your computer, any malware that is able to infect your device will be able to easily get them from the file system. By encrypting them, it makes harder for those media files to be stolen. Also, by being encrypted, you can easily make backups of them in cloud storage services like Google Drive, without giving Google the ability to peek into your personal media files.

Why a web application?: By making it a web application, its usage becomes very flexible. You can run the backend in a computer in your LAN or a remote server and you are able to use the app from all the devices connected to the Internet without any extra installation. Also, web interfaces are easier to develop to work in multiple devices and they offer standard features already implemented that are required for the app, like the video player.

Features

  • Support for videos, audios and pictures.
  • Web interface: The project provides a Web interface, allowing the access to the vault from multiple devices and operating systems.
  • Encrypted and easy to back-up storage: The vault is encrypted using the user's password, and is stored in files in a data folder. It's possible to make backups of the vault just by copying the folder, ideal for tools like rsync. This project also provides its own backup tool for doing that.
  • Indexed tags: Each media asset can be tagged, so the user can search for it with a tag based search system.
  • Albums: Media files can be sorted using albums.
  • Media encoding: Media files are encoded into multiple formats in order to allow the playback from multiple browsers. For videos and pictures, they can also be resized into multiple resolutions for different kind of devices.
  • Automated thumbnail generation.
  • Subtitles support for videos and audios.
  • Multiple audio track support for videos
  • Video timeline previews.
  • Video timeline slices.
  • Image annotations.

Installation

Depending on the operating system you are using, there are multiple installation options.

Linux with DEB package support

For apt-compatible Linux distributions, we provide a DEB package:

Version Arch Download Hash Hash alg.
1.19.0 amd64 Drive
Mega		 7eed7287dd3ae03b181a02275e10ddc165d52d4e5d43313f0fc204bc114d875d SHA256

Download it, and check its integrity using:

sha256sum ./personalmediavault_1.19-0.deb

Then, install it using apt:

sudo apt install ./personalmediavault_1.19-0.deb

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

To run a vault, type:

pmv /path/to/vault

You can change the language the launcher uses setting the PMV_LANGUAGE environment variable to en or es.

Windows

For Windows, we provide a MSI installer:

Version Arch Language Download Hash
1.19.0 x64 English Mega SHA256: 51EFAB3CC196B3068AEEDE001A7A8A8C9F53C021D0891DE9827FDA279E2B2CA6
1.19.0 x64 Spanish Mega SHA256: F3A31846A72172C9A90AD7B742F2233DB12A2A38E35213723B17E2E6F7F269CC

In order to install Personal Media Vault in Windows, run the installer and everything will be set up for the application to work.

When downloading the MSI installer, check the file hash with PowerShell to make sure the file was not modified:

Get-FileHash -Path "PersonalMediaVault-1.19.0-x64.msi" -Algorithm SHA256
Get-FileHash -Path "PersonalMediaVault-1.19.0-x64-es.msi" -Algorithm SHA256

After it's installed, create an empty folder to store your media vault and right click it. You should see a new option "Open with PersonalMediaVault". Click it to run the vault launcher.

Docker

You can run this project with docker, using the official image uploaded to Docker Hub.

In order to pull the image, type:

docker pull asanrom/pmv

To run a personal media vault instance, you can create a container, which is going to run the backend binary inside it.

Here is an example command to create a container:

docker run -p 80:80 -v /path/to/the/vault:/vault -e VAULT_INITIAL_USER=admin -e VAULT_INITIAL_PASSWORD=admin asanrom/pmv --daemon --clean --log-requests --vault-path /vault

You can replace /path/to/the/vault for the path where you have your vault stored.

For empty vaults, a default admin, with password admin will be created. You can also override them by changing the environment variables VAULT_INITIAL_USER and VAULT_INITIAL_PASSWORD respectively. You should change the password as soon as you first login into your vault to protect it with a strong password.

For more options, run:

docker run asanrom/pmv --help

Project components

  • Backend: Manages the vault, encodes and stores the media files and provides a HTTP API for clients to access it.
  • Frontend: Uses the HTTP API to access the vault, providing a web interface to the user.
  • Backup tool: Tool to make backups of media vaults (copies the new files and replaces the old ones, using the last modified date).
  • Launcher: CLI program to launch the web app. This component is made in order to make it easier to use in local, when you do not have the backend configured as a system service.
  • Installation Packages: Collection of installation packages for multiple operating systems.

License

This project is under the MIT License.