diff --git a/README.md b/README.md index d835973..332f7d7 100644 --- a/README.md +++ b/README.md @@ -6,17 +6,36 @@ To use, `FANSPEED` should be set as a hex value, e.g. `0x05` -Example `docker-compose.yml`: +`docker-compose.yml` examples: + +1. to use with local iDRAC: ```yml version: '3' services: - fan-controller: + Dell_iDRAC_fan_controller: image: alombardo4/idrac-fan-control + restart: unless-stopped + environment: + - IDRAC_HOST=local # can be omitted as it is the default value + - FANSPEED=0x05 # set to the hex value you want to set the fans to (from 0 to 100%) + devices: + - /dev/ipmi0:/dev/ipmi0 +``` + +2. to use with LAN iDRAC: + +```yml +version: '3' + +services: + Dell_iDRAC_fan_controller: + image: alombardo4/idrac-fan-control + restart: unless-stopped environment: - IDRAC_HOST=192.168.1.100 # override to the IP of your IDRAC - IDRAC_USER=root # set to your IPMI username - IDRAC_PW=calvin # set to your IPMI password - - FANSPEED=0x05 # set to the hex value you want to set the fans to (from 0 to 100) + - FANSPEED=0x05 # set to the hex value you want to set the fans to (from 0 to 100%) ```