README: Add Docker pull installation method

[FabioCanavarro]

Fixes #71

This PR adds a new installation method for Bifrost using pre-built Docker images.

Changes

• Updated installation methods list to include Docker Pull option
• Added comprehensive Docker Pull section in README
• Included platform-specific Docker pull commands
• Provided guidance on running the Docker image with a local configuration file
• Split the docker installation methods into its own file

[rohankapoorcom]

One suggestion I would make - add an example docker-compose config as well.

[FabioCanavarro]

Hmmm, alright, I see, I will edit the pull request later in the afternoon

[rohankapoorcom]

Overall I think this is a great set of instructions to add, just the docker compose instructions make it even easier to configure. One page I think that shows an amazing set of docker installation instructions is Zigbee 2 MQTT: https://www.zigbee2mqtt.io/guide/installation/02_docker.html#docker-compose if you want something to reference.

[FabioCanavarro]

I agree, and also I wish to thank you for making my life easier, I will try checking it out 😁

[FabioCanavarro]

@rohankapoorcom to double check what you have meant, instead of docker pull, I edit the readme.md file to only include docker compose up -d, from the docker-compose.yml itself? (As I am quite not sure if the original issue wanted me to add docker pull also)

1. Create a docker-compose.yml file with the following content:

version: '3.8'
services:
  bifrost:
    image: ghcr.io/chrivers/bifrost:master-2025-02-04
    container_name: bifrost
    restart: unless-stopped
    network_mode: host  # Required for mDNS discovery
    volumes:
      - ./config.yaml:/app/config.yaml
      - ./certs:/app/certs  # Certificate storage
    environment:
      - TZ=Europe/Copenhagen  # Set your timezone
 
2. Curl and rename the example configuration file:

```sh
curl -O https://raw.githubusercontent.com/chrivers/bifrost/master/config.example.yaml
cp config.example.yaml config.yaml

2. Start the container:

docker compose up -d

is it something like this? (Feel free to point my mistakes, as I haven't really touched docker much)

[danieledwardgeorgehitchcock]

If you are willing to sacrifice mDNS discovery in favour of a more isolated Docker network, you can do the following:

docker-compose.yaml:

services:
  bifrost:
    image: ghcr.io/chrivers/bifrost:latest
    container_name: bifrost
    restart: unless-stopped
    networks:
      home-automation: # Docker Compose Defined Network (See Below Networks Section)
        ipv4_address: 172.21.0.6 # Suggest To Run Compose Up Without This Line To Generate IP, Then Make It Static As IP's And MAC's Get Recycled On Reboot
        mac_address: 00:11:22:33:44:55 # See Above Note
    volumes:
      - type: bind # Would Be Great For The Config File To Be In A Separate Directory, And Generated If Missing, Then We Could Use A Docker Volume For This
        source: ./bifrost/config.yaml
        target: /app/config.yaml
      - type: volume # Docker Compose Defined Volume (See Below Volumes Section)
        source: bifrost-certs
        target: /app/certs
    depends_on: # Not Necessarily Needed, But Good To Have When Controlling Service Startup On Boot
      zigbee2mqtt:
        condition: service_started
    ports:
      - 80:80/tcp
      - 443:443/tcp

volumes:
  bifrost-certs:

networks:
  home-automation:
    driver: bridge

config.yaml:

bifrost:
  cert_file: certs/cert.pem
bridge:
  name: Bifrost
  mac: 00:11:22:33:44:55 # Docker Container MAC
  ipaddress: 172.21.0.6 # Docker Container IP
  netmask: 255.255.255.0
  gateway: 172.21.0.1 # Docker Network Gateway
  timezone: Europe/London
z2m:
  zigbee2mqtt:
    url: ws://zigbee2mqtt:8080/api?token=ABC123 # If Your Z2M Instance Is Bound To The Same Docker Network As Bifrost, You Can Use The Container Name

[chrivers]

without mDNS discovery, am I correct in assuming the hue app will stop working?

If so, we should probably make that very clear. I'd prefer not to have more people frustrated and confused about connection problems :)

[chrivers]

@FabioCanavarro thank you for your contribution! I'll take a look 👍

[danieledwardgeorgehitchcock]

without mDNS discovery, am I correct in assuming the hue app will stop working?

If so, we should probably make that very clear. I'd prefer not to have more people frustrated and confused about connection problems :)

It'll work, but the process in the app isn't as straightforward.. you have to click on "I need help" then "Manually add IP"

[rohankapoorcom]

without mDNS discovery, am I correct in assuming the hue app will stop working?

No, the hue app let's you manually specify the IP address of the bridge instead. But some other devices won't find the hue bridge that way (for example Harmony Hub).

I believe both Docker Compose examples look good!

[chrivers]

Looking good - a couple of things to fix, but on the right path for sure. Thank you for submitting this :)

[FabioCanavarro]

My bad, had an exam at school, i will start updating it

[chrivers]

@FabioCanavarro thanks for updating it!

Don't worry about the delay - exams are important, and we all have a real life to take care of outside of github :)

I have a few more changes, but then I think we're good 👍

[FabioCanavarro]

I have synced my new commit; can you review my new commit?

[chrivers]

@FabioCanavarro Merged! Thanks for your contribution 🥳