Getting Started

Installation

Oblecto can be installed in a variety of ways. The docker and npm provide easy installation methods. Oblecto can also be run directly from the source repo.

When not installing through docker, please install the requirements shown in Installation Requirements for your respective system.

Install from NPM

Install from npm using

sudo npm install -g oblecto --unsafe-perm

--unsafe-perm is required as bcrypt need to be compiled on the host machine. bcrypt is used for password authentication.

This will install Oblecto to your path, making the oblecto command available to you. Now you must setup the config files and databases. If you wish to use a mysql database, edit /etc/oblecto/config.json before running oblecto init database.

sudo mkdir /etc/oblecto/
sudo chown $USER:$USER /etc/oblecto/
oblecto init
oblecto init database

To start Oblecto, run:

oblecto start

Install from GIT

If you wish to assist in the development of Oblecto, checkout the repo using

git clone --recurse-submodules https://github.com/robinp7720/Oblecto.git

After checkout, install all dependencies using

npm install

Run npm run build:web to build the frontend for Oblecto

Build oblecto with npm run build.

Now you must setup the config files and databases. If you wish to use a mysql database, edit /etc/oblecto/config.json before running oblecto init database.

sudo mkdir /etc/oblecto/
sudo chown $USER:$USER /etc/oblecto/
./dist/bin/oblecto.js init
./dist/bin/oblecto.js init database

Now to start Oblecto, run

npm start

Install Using Docker

Note: these instructions will become shorter once this is available from the Docker Registry

Clone the repo using

git clone --recurse-submodules https://github.com/robinp7720/Oblecto.git

After the clone is complete, change directories to the repo and build the container with the following

docker build -t oblecto .

After building, go to the directory where you want to store configuration files and assets

Optional: edit/create config.json in the directory you plan on initializing Oblecto in, if you want to edit Oblecto configuration

Next, you can generate configuration files with

docker run --rm -v "$PWD:/etc/oblecto" oblecto /bin/bash -c "node /build/dist/bin/oblecto init && node /build/dist/bin/oblecto init database"

After the files are generated, they will appear in your current directory, unless you changed $PWD

Lastly, the following following docker-compose configuration can be used, after changing all directories in the brackets.

    oblecto:
        image: oblecto
        restart: unless-stopped
        ports:
            - "8080:8080"
            - "9131:9131"
            - "9132:9132"
        volumes:
            - "[movie directory]:/mnt/Movies/:ro"
            - "[show directory]:/mnt/Shows/:ro"
            - "[folder from init]:/etc/oblecto"

After starting the server you may need to create an account. This can be done with

docker-compose exec oblecto node /build/dist/bin/oblecto.js adduser [username] [password] [name] [email]

Configuration

After the installation of Oblecto, Oblecto must be configured to define the location of your media libraries and the credentials the MySQL database.

Please follow Configuration for help on how to configure Oblecto

User accounts are not configured in this file. They are configured either through the CLI tool or through the web interface.