Installing¶

Using with Docker¶

Start by copying the appropriate commands for your OS over onto a file. Then edit the variables so that they point to the appropriate folders and ports.

Finally, copy your edit of commands over to a command-line and execute them.

Linux & Mac OS:

HPX_PORT=7007
HPX_WEBPORT=7008
HPX_TORRENTPORT=7006
HPX_DATA="/path/to/desired/hpx/datadir"
HPX_CONTENT="/path/to/desired/hpx/contentdir"
RUN_IN_BACKGROUND=true
AUTOSTART_ON_BOOT=always
docker run -p $HPX_PORT:7007 -p $HPX_WEBPORT:7008 -p $HPX_TORRENTPORT:7006 --name happypandax --restart AUTOSTART_ON_BOOT --volume=$HPX_DATA:/data --volume=$HPX_CONTENT:/content -d=$RUN_IN_BACKGROUND twiddly/happypandax

Windows:

NOTE: This is intended for cmd.exe not PowerShell

set HPX_PORT=7007
set HPX_WEBPORT=7008
set HPX_TORRENTPORT=7006
set HPX_DATA="C:\path\to\desired\hpx\datadir"
set HPX_CONTENT="C:\path\to\desired\hpx\content"
set RUN_IN_BACKGROUND=false
set AUTOSTART_ON_BOOT=always
docker run -p %HPX_PORT%:7007 -p %HPX_WEBPORT%:7008 -p %HPX_TORRENTPORT%:7006 --name happypandax --restart %AUTOSTART_ON_BOOT% --volume=%HPX_DATA%:/data --volume=%HPX_CONTENT%:/content -d=%RUN_IN_BACKGROUND% twiddly/happypandax

import:
    skip_existing_galleries: true
    transparent_nested_folders: true
watch:
    enable: true
    dirs:
      - ${HPX_CONTENT}
    options:
      ${HPX_CONTENT}:
        import.scan_on_startup: true
plugin:
    plugin_dir: ${HPX_DATA}/plugins

Using with Docker Compose¶

Using HPX with Docker Compose lets us avoid those complicated-looking commands. And while we are at it, we might as well set up HPX to use postgresql with docker as well.

Start by creating a folder for where you want your HPX config and data to be. You can just name this folder HappyPanda X.

In that folder, create a folder named data and a file named docker-compose.yml with these contents:

version: '3'

services:
  happypandax:
    image: twiddly/happypandax:latest
    # start this container automatically on boot
    restart: always
    ports:
      - "7006:7006"
      - "7007:7007"
      - "7008:7008"
    volumes:
      - ./data:/data
      - ./content:/content
    links:
      - db

  db:
    image: postgres:latest
    restart: always
    ports:
      - 7005:5432
    environment:
      POSTGRES_USER: 'happypandax'
      POSTGRES_PASSWORD: 'postgres'
    volumes:
      - database:/var/lib/postgresql/data
    logging:
      driver: none

volumes:
  database:
    driver: local

Change the ports and folder mappings as desired. In particular you should change ./content:/content to <where your manga folder is located>:/content, or else the expected content folder will be a folder named content in the HappyPanda X folder.

You can also change the ports, if you wish to do so, do it like this: <your custom port>:7008

Notice that the port to postgres is set to 7005:5432, meaning unless you change it, you will have to use port 7005 to connect to it with from outside.

Now, create a config.yaml file with these contents and save it inside the data folder (unless you changed it then this folder is expected to be named data inside the HappyPanda X folder, create it if it doesn’t exist):

import:
    skip_existing_galleries: true
    transparent_nested_folders: true
watch:
    enable: true
    dirs:
      - ${HPX_CONTENT}
    options:
      ${HPX_CONTENT}:
        import.scan_on_startup: true
plugin:
    plugin_dir: ${HPX_DATA}/plugins

db:
    dialect: postgres
    username: happypandax
    password: postgres
    host: db
    port: 5432
    name: happypanda

The config file supports environment variables, so ${HPX_CONTENT} will automatically expand to your specified content folder inside docker. Another useful variable is ${HPX_DATA} pointing to the data folder inside dicker. Note that these environment variables are pre-defined by the image inside docker. This means you can’t just define new variables from outside and expect the docker instance to see them.

Notice that the postgres host is the name of the database service as defined in docker-compose.yml to be named db. And the port is set to 5432 because that’s the port postgres listens on inside the container, but to access it from outside docker, you will need to use 7005 or whatever was defined.

This config does a few things. It sets HPX to use the dockerized postgres service and also puts the content folder under watch so that new items in it will be added to HPX automatically.

Lastly, if you don’t wish to use a postgres backend with docker, just remove this part from docker-compose.yml:

    links:
      - db

  db:
    image: postgres:latest
    restart: always
    ports:
      - 7005:5432
    environment:
      POSTGRES_USER: 'happypandax'
      POSTGRES_PASSWORD: 'postgres'
    volumes:
      - database:/var/lib/postgresql/data


volumes:
  database:
    driver: local

Make sure to edit your config.yaml to reflect this change.

With all that done, we can now start up everything. Run this command to start everything:

docker-compose up

If everything was successful, you should be able to open your browser and access HPX on localhost:7008 (replace 7008 with whatever you set that port mapping to).

To run in the background, supply the -d flag:

docker-compose up -d

You can stop everything with:

docker-compose down

Read more about what commands are available here.

In the same vein as with docker run, you can also pass commands to HPX in the same way, like:

docker-compose run happypandax --help

To create a new user:

docker-compose run happypandax user create -t "admin" -u "twiddly" -p "twiddly123"