Giter Club home page Giter Club logo

plexus's Introduction

Plexus

A suite of tools to help manage the media behind a Plex server.

Docker

Rather than installing the dependencies and downloading Plexus locally, you can run the Plexus Docker image:

docker run -v $HOME/.config/plexus:/config wolveix/Plexus:latest 

Install

Automatic

You can automatically install Plexus by running the following line via a supported command line interface:

curl https://plexus.wolveix.com/install.sh | sudo bash

If you don't have superuser priviledges or are using macOS, use this instead:

curl https://plexus.wolveix.com/install.sh | bash

Manual

Alternatively, you can manually install Plexus to a custom location on your device. You should install sudo if it doesn't already exist on your system. Install any missing dependencies (Debian/Ubuntu):

sudo apt-get -qq -y update && sudo apt-get -qq -y upgrade
sudo apt-get -qq -y install curl ffmpeg rsync

Install any missing dependencies (CentOS/Rhel):

sudo yum -q -y install epel-release
sudo yum -q -y update && sudo yum -q -y upgrade
sudo yum -q -y localinstall --nogpgcheck https://download1.rpmfusion.org/free/el/rpmfusion-free-release-7.noarch.rpm https://download1.rpmfusion.org/nonfree/el/rpmfusion-nonfree-release-7.noarch.rpm
sudo yum -q -y install curl ffmpeg ffmpeg-devel rsync

Install any missing dependencies (macOS):

brew update && brew upgrade
brew install curl ffmpeg rsync

Create all of the temporary folders required:

mkdir -p $HOME/.config/plexus $HOME/.plexus/encode/convert $HOME/.plexus/encode/converted $HOME/.plexus/rclone /tmp/plexus

Download the default config file and move it into the correct location:

curl -O https://raw.githubusercontent.com/Wolveix/Plexus/master/plexus.conf
mv plexus.conf "$HOME"/.config/plexus/

Next, download the executable itself:

curl -O https://raw.githubusercontent.com/Wolveix/Plexus/master/plexus

Finally, correct the file permissions and move it into your respective operating system's application directory. The following example is for Linux:

chmod u+x plexus && chmod 755 plexus
sudo chown root:root plexus
sudo mv plexus /usr/bin/plexus

That's it!

Plexus natively supports RClone and a custom build of FFmpeg. You can install any dependencies via Plexus' built-in install function.

Configuration

This is the default config file:

audio_codec="aac"
blacklist_file="$HOME/.plexus/blacklist"
convert_dir="$HOME/.plexus/encode/convert"
converted_dir="$HOME/.plexus/encode/converted"
deinterlacing="true"
ffmpeg_binary=""
ffmpeg_threads="2"
ffmpeg_preset="faster"
ffprobe_binary=""
force_overwrite="true"
fusermount_binary=""
hardware_acceleration="false"
hardware_codec="opencl"
list_file="$HOME/.plexus/list.txt"
media_container="mkv"
media_dir="/mnt/plexdrive"
mount_dir=""
rclone_binary=""
rsync_binary=""
video_codec="h264"
video_library="libx264"

Without changing any options, Plexus will create a list of your files that either don't use the MKV container, x264 video codec or the aac audio codec. You can then process this list by running the encode command which will move through the list and re-encode each file to fit the above three conditions.

Original files are replaced by default, but you can disable this by changing the force_overwrite value to false. You can edit the config file directly ($HOME/.config/plexus/plexus.conf) or you can use the built-in config function by running plexus config.

Usage

This somewhat varies depending on whether you're planning on encoding local media or media contained on an RClone remote. Firstly, specify your ideal codecs via the config function.

Local Media

Run plexus list -d /path/to/media to start building a recursive list of your media which needs to be re-encoded.

Once the list function has finished its process, you can begin the encoding process by running plexus encode -l /path/to/list.

Remote Media

Run plexus list -d /mount/path/path/to/media -m /mount/path to start building a recursive list of your media which needs to be re-encoded.

Once the list function has finished its process, you can begin the encoding process by running plexus encode -l /path/to/list -r RCloneRemote:.

Support

If you run into any issues, please submit an issue via this repo. If the issue occurs during the encode command, please run the command again with the --verbose flag so that we may have a better idea of what's happening.

Credits

plexus's People

Contributors

aianus avatar gorgarp avatar wolveix avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.