diff --git a/README.md b/README.md index 89986e0..d975b2a 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,38 @@ -# Dell iDRAC fan controller Docker Image +
-- `IDRAC_HOST` parameter can be set to "local" or to your distant iDRAC's IP address. Default value is "local". -- `IDRAC_USERNAME` parameter is only necessary if you're adressing a distant iDRAC. Default value is "root". -- `IDRAC_PASSWORD` parameter is only necessary if you're adressing a distant iDRAC. Default value is "calvin". -- `FAN_SPEED` parameter can be set as a decimal (from 0 to 100%) or hexadecimal value (from 0x00 to 0x64) you want to set the fans to. Default value is 5(%). -- `CPU_TEMPERATURE_TRESHOLD` parameter is the T°junction (junction temperature) threshold beyond which the Dell fan mode defined in your BIOS will become active again (to protect the server hardware against overheat). Default value is 50(°C). -- `CHECK_INTERVAL` parameter is the time (in seconds) between each temperature check. Default value is 60(s). +# Dell iDRAC fan controller Docker image -To use: + +
+ Table of Contents +
    +
  1. Container console log example
    2. +
  2. Usage
    3. +
  3. Parameters
    4. +
  4. Contributing
    5. +
+
+ +## Container console log example + +![image](https://user-images.githubusercontent.com/37409593/163174925-d3d20ed6-0f95-44e6-827d-368939435ba4.png) + +

(back to top)

+ + +## Usage 1. with local iDRAC: ```bash docker run -d \ --name Dell_iDRAC_fan_controller \ - --restart unless-stopped \ + --restart=unless-stopped \ + -e IDRAC_HOST=local \ -e FAN_SPEED= \ - -e CPU_TEMPERATURE_TRESHOLD= \ - alombardo4/idrac-fan-control:latest + -e CPU_TEMPERATURE_TRESHOLD= \ + -e CHECK_INTERVAL= \ + tigerblue77/dell_idrac_fan_controller:latest ``` 2. with LAN iDRAC: @@ -25,13 +40,14 @@ docker run -d \ ```bash docker run -d \ --name Dell_iDRAC_fan_controller \ - --restart unless-stopped \ + --restart=unless-stopped \ -e IDRAC_HOST= \ -e IDRAC_USERNAME= \ -e IDRAC_PASSWORD= \ -e FAN_SPEED= \ - -e CPU_TEMPERATURE_TRESHOLD= \ - alombardo4/idrac-fan-control:latest + -e CPU_TEMPERATURE_TRESHOLD= \ + -e CHECK_INTERVAL= \ + tigerblue77/dell_idrac_fan_controller:latest ``` `docker-compose.yml` examples: @@ -43,13 +59,14 @@ version: '3' services: Dell_iDRAC_fan_controller: - image: alombardo4/idrac-fan-control + image: tigerblue77/dell_idrac_fan_controller container_name: Dell_iDRAC_fan_controller restart: unless-stopped environment: - - IDRAC_HOST=local # can be omitted as it is the default value - - FAN_SPEED=0x05 # set to the decimal or hexadecimal value you want to set the fans to (from 0 to 100%) - - CPU_TEMPERATURE_TRESHOLD= + - IDRAC_HOST=local + - FAN_SPEED= + - CPU_TEMPERATURE_TRESHOLD= + - CHECK_INTERVAL= devices: - /dev/ipmi0:/dev/ipmi0 ``` @@ -61,17 +78,46 @@ version: '3' services: Dell_iDRAC_fan_controller: - image: alombardo4/idrac-fan-control + image: tigerblue77/dell_idrac_fan_controller container_name: Dell_iDRAC_fan_controller restart: unless-stopped environment: - - IDRAC_HOST=192.168.1.100 # override to the IP address of your IDRAC - - IDRAC_USERNAME=root # set to your IPMI username - - IDRAC_PASSWORD=calvin # set to your IPMI password - - FAN_SPEED=0x05 # set to the decimal or hexadecimal value you want to set the fans to (from 0 to 100%) - - CPU_TEMPERATURE_TRESHOLD= + - IDRAC_HOST= + - IDRAC_USERNAME= + - IDRAC_PASSWORD= + - FAN_SPEED= + - CPU_TEMPERATURE_TRESHOLD= + - CHECK_INTERVAL= ``` -Container console log example: +

(back to top)

-![image](https://user-images.githubusercontent.com/37409593/163174925-d3d20ed6-0f95-44e6-827d-368939435ba4.png) + +## Parameters + +All parameters are optional as they have default values (including default iDRAC username and password). + +- `IDRAC_HOST` parameter can be set to "local" or to your distant iDRAC's IP address. **Default** value is "local". +- `IDRAC_USERNAME` parameter is only necessary if you're adressing a distant iDRAC. **Default** value is "root". +- `IDRAC_PASSWORD` parameter is only necessary if you're adressing a distant iDRAC. **Default** value is "calvin". +- `FAN_SPEED` parameter can be set as a decimal (from 0 to 100%) or hexadecimal value (from 0x00 to 0x64) you want to set the fans to. **Default** value is 5(%). +- `CPU_TEMPERATURE_TRESHOLD` parameter is the T°junction (junction temperature) threshold beyond which the Dell fan mode defined in your BIOS will become active again (to protect the server hardware against overheat). **Default** value is 50(°C). +- `CHECK_INTERVAL` parameter is the time (in seconds) between each temperature check and potential profile change. **Default** value is 60(s). + +

(back to top)

+ + +## Contributing + +Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. + +If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". +Don't forget to give the project a star! Thanks again! + +1. Fork the Project +2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) +3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) +4. Push to the Branch (`git push origin feature/AmazingFeature`) +5. Open a Pull Request + +

(back to top)