This project provides the Docker Compose (v1.9.x) configuration files necessary to setup and run your own installation of the Pynab indexer using Docker containers. It includes running the Scanning, Postprocessing, Prebot and API/WebUI features backed by a PostgreSQL database.
This project assumes the user has some familiarity with how Pynab, Docker and Docker Compose work.
You must already have Docker and Docker Compose setup and running on your host.
To complete the installation please run through the following steps:
-
Obtain the latest config sample file and edit to match your configuration:
wget -O config.py https://raw.githubusercontent.com/Murodese/pynab/development-postgres/config_sample.py
-
cp .dbenv-dist .dbenv and edit
-
cp .apienv-dist .apienv and edit
This should be the hostname that you expect to use when connecting to your api.
-
cp api/config.js-dist api/config.js and edit
This should be where you expect the webui to be available, if you've chosen to not enable the webui then this value can be whatever you'd like.
-
docker-compose build
This step will take some time as it pulls down various images and code and builds the required files.
-
docker-compose up -d postgres
This will launch the postgres container for the first time to generate the required database and tuning files.
NOTE: To change how much memory the database uses you need to modify the docker-compose.yml file as well as updating local.conf (see file for more details).
If you are updating from a previous release and have a database backup you may restore that backup, run an alembic upgrade and proceed to the startup phase.
If you are starting from scratch or converting from a Newznab installation please see below.
docker-compose run --rm scan python3 install.py
This will setup the proper database tables and download a pre database to get your started on your indexing.
Once this step completes you are free to add users, groups, etc and proceed to the startup phase.
If you would like to pull in your old Newznab settings (users, groups, etc) then run the following commands:
docker-compose run --rm scan python3 scripts/convert_from_newznab.py --mysql-passwd
Run that command with --help to see other options, such as skipping the conversion of some tables.
If you have nzb files to import you can move them into the backup directory nd then run the following command:
docker-compose run --rm scan python3 scripts/import.py /backup/nzbfiles
You can now proceed to the startup phase.
Once you have properly installed, configured and initialized your installation then you are ready for startup.
docker-compose up -d
Generally you will use the pynab.py script to interact with your Pynab install (add users, add groups, etc). To perform this action while running in Docker containers it takes a little more effort.
NOTE: This assumes that you have the scan container currently
running. If you do not then replace exec with run --rm to get the
same results.
To print a list of users you can use this command:
docker-compose exec scan python3 pynab.py user list
Run with --help to see all of the commands available:
docker-compose exec scan python3 pynab.py --help
To make things easier you can always do this:
alias pynab="docker-compose exec scan python3 pynab.py"
This means you can simply run command such as this:
pynab regex pynab group list
NOTE: The following pynab.py commands do not work when running under docker:
- start
- stop
- scan
- postprocess
- api
- update
- backfill
- pubsub
- prebot
- stats
Future releases may make these command more useful.
The backup directory is a special mount point for the scan and postgres containers. This allows you to perform backup/exports/restores/imports with the system.
Special scripts have been added to the postgres container to help facilitate backups and restores.
To perform a backup you can run:
docker-compose exec postgres /backupdb.sh
To perform a restore, place the file you wish to restore from in the backup directory and run:
docker-compose exec postgres /restoredb.sh
NOTE: That file MUST exist in the backup directory.