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. Before running Oblecto, you must configure Oblecto according to your database installation and library paths.

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

Now to start Oblecto, run

npm start

Install using docker

Coming soon

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.