Skip to content

Latest commit

 

History

History
147 lines (114 loc) · 5.39 KB

DOCKER.md

File metadata and controls

147 lines (114 loc) · 5.39 KB
Raw

Using the app with Docker (HA Core)

There are multiple ways of using the Docker images created by this project with HA Core.

This bit of documentation will outline one of those methods. Namely by creating your own startup script file.

Prerequisites

This document assumes:

  1. That you have a basic understanding of how to use docker and docker-compose.yml files.
  2. That you know which architecture your docker instance is running on. The app supports 5 architecture types which you can find here. You will need this in the steps described below.
  3. A linux-based docker host. The app relies on the network_mode: host option of docker to function and unfortunatly this option is only available on linux and not mac or windows as you can see here.

Steps

The following steps describe how you can use a docker-compose.yml and a custom run.sh file to start the add-on.

This allows you to circumvent the default startup command, which depends on bashio, which is only available when using the app as a Home Assistant Add-on. And instead provide the required configuration through the .sh file we will create.

Directory structure of the example.

.  
│
├─── config                     # we will need a separate directory to use as a volume
│    │
│    └─── run.sh                # custom startup script
│   
└─── docker-compose.yml         # configuration of our container

1. Create a docker-compose.yml file

Create a docker-compose.yml file with the following contents.

The example uses the architecture "amd64" in the image reference, but you should of course adapt this to match that of the instance that you're running docker on.

You can find the available images here.

Option 1: configuring the app through environment variables

docker-compose.yml example 1

version: '3'

services:
  ps5-mqtt:
    container_name: PS5-MQTT                            # choose whatever name you like
    image: ghcr.io/funkeyflo/ps5-mqtt/amd64:latest      # you can also use a specific version
    entrypoint: /config/run.sh                          # the file that will be executed at startup
    volumes:                                            # we will use this volume to get our custom startup script into the container
      - ./config:/config
    network_mode: host                                  # changing/omiting this option WILL BREAK the app.
    environment:
      - MQTT_HOST=192.168.0.132                         # (ip)address of your mqtt broker
      - MQTT_PORT=1883                                  # port of your mqtt broker
      - MQTT_USERNAME=mqttuser                          # username used for connecting to your mqtt broker
      - MQTT_PASSWORD=mqttpassword                      # password used for connecting to your mqtt broker

      - DEVICE_CHECK_INTERVAL=5000
      - DEVICE_DISCOVERY_INTERVAL=60000
      - ACCOUNT_CHECK_INTERVAL=5000

      - 'PSN_ACCOUNTS=[{"username": "MyPsnUser", "npsso":"npsso_value"}]'

      - INCLUDE_PS4_DEVICES=false

      - FRONTEND_PORT=8645

      - CREDENTIAL_STORAGE_PATH=/config/credentials.json
      - DEBUG=@ha:ps5:*

NOTE: for more information on configuration variables please refer to the add-on docs and the regular startup script.

Option 2. configuring the app with a json file.

docker-compose.yml example 2

version: '3'

services:
  ps5-mqtt:
    # ...
    # same as Option 1.
    # ...
    volumes:
      - ./config:/config
    # ...
    environment:
      - CONFIG_PATH=/config/options.json
      - DEBUG=@ha:ps5:*

options.json example

{
  "mqtt": {
      "host": "192.168.0.132",
      "port": "1883",
      "user": "mqttuser",
      "pass": "mqttpassword"
  },

  "device_check_interval": 5000,
  "device_discovery_interval": 60000,

  "include_ps4_devices": false,

  "psn_accounts": [
    {
      "username": "MyPsnUser", 
      "npsso":"npsso_value"
    }
  ],

  "account_check_interval": 5000,

  "credentialsStoragePath": "/config/credentials.json",
  "frontendPort": "8645"
}

NOTE: you can also combine json config and environment variables. If duplicate values are detected the environment variable value wins.

2. Create a startup file

The only thing left to do is to simply point the app to the server executable using node.js. We'll do this by creating a shell script called run.sh as mentioned before with the following contents.

#!/bin/sh
set -e

echo Starting PS5-MQTT...
node app/server/dist/index.js

Note: if you create the .sh file on windows make sure to convert to LF line endings.

Need help or have a comment?

  • Can't figure out how to setup the component? Please consult our discord community!
  • See something in the documentation that's incorrect or missing? Create an issue on github!