# 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][network-mode-windows].

## Steps

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

This allows you to circumvent the default startup command, which depends on [bashio][bashio], which is only available when using the app as a Home Assistant Add-on. And instead provide the required configuration directly.
<br><br>

_Directory structure of the example._

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

### Create a `docker-compose.yml` file

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

The standalone image is multi-arch, so the same `image` reference works on every supported architecture.

You can find the available images [here][docker-images].

#### Option 1: configuring the app through environment variables

**`docker-compose.yml` example 1**

```yaml
version: "3"

services:
  ps5-mqtt:
    container_name: PS5-MQTT # choose whatever name you like
    image: ghcr.io/funkeyflo/ps5-mqtt:latest # you can also use a specific version
    volumes: # we will use this volume to save credentials
      - ./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
      - DISCOVERY_TOPIC=your_custom_discovery_topic # Home Assistant discovery topic. Only needs to be set if you've changed the discovery topic in Home Assistant. Default: homeassistant

      - 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:*
    healthcheck: # Optional add docker healthcheck as it may be important for some setups
      test: ls -l /proc/*/exe | grep node
      interval: 5m00s
      timeout: 10s
      retries: 2
      start_period: 30s
```

_NOTE: for more information on configuration variables please refer to the [add-on docs][add-on-docs] and the [regular startup script][regular-startup-script]._

#### Option 2. configuring the app with a `json` file.

`docker-compose.yml` example 2

```yaml
version: "3"

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

**`options.json` example**

```json
{
  "mqtt": {
    "host": "192.168.0.132",
    "port": "1883",
    "user": "mqttuser",
    "pass": "mqttpassword",
    "discovery_topic": "your_custom_discovery_topic"
  },

  "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.

Start the docker container and proceed to the web-ui found at http://localhost:8645. From there select authenticate and complete the instructions. This will create a credentials.json file inside the /config folder.

From there, add the MQTT integration and follow directions. From there the PS5 should be detected in HASS.

## Need help or have a comment?

- See something in the documentation that's incorrect or missing? [Create an issue][github-issues] on github!

<!-- links -->

[bashio]: https://github.com/hassio-addons/bashio
[docker-images]: https://github.com/FunkeyFlo?tab=packages&repo_name=ps5-mqtt
[add-on-docs]: ./DOCS.md
[network-mode-windows]: https://stackoverflow.com/questions/48915458/windows-run-docker-with-network-host-and-access-with-127-0-0-1
[github-issues]: https://github.com/FunkeyFlo/ps5-mqtt/issues/new/choose