hueget 0.7.4 → 0.7.6

package/CHANGELOG.md

@@ -5,13 +5,22 @@ See the [Readme file](https://github.com/jsiegenthaler/hueget/blob/master/README
 # Bug Fixes and Improvements
 
 
+## 0.7.6 (2024-12-13)
+* Added Docker config (thanks @Yannis4444)
+* Updated README.md to include Docker notes
+
+## 0.7.5 (2024-12-06)
+* Bumped dependencies: "node": "^22"
+* Bumped dependencies: "axios": "^1.7.9"
+* Bumped dependencies: "express": "^4.21.2"
+
 ## 0.7.4 (2024-10-19)
 * Added pm2 describe example to the Readme file
-* Bumped dependencies: "express": "^4.21.1",
+* Bumped dependencies: "express": "^4.21.1"
 
 ## 0.7.3 (2024-09-17)
 * Bumped dependencies: "axios": "^1.7.7"
-* Bumped dependencies: "express": "^4.21.0",
+* Bumped dependencies: "express": "^4.21.0"
 
 ## 0.7.2 (2024-08-17)
 * Bumped dependencies: "axios": "^1.7.4"

package/Dockerfile

@@ -0,0 +1,17 @@
+FROM node:22-slim
+
+ENV HUE_BRIDGE_IP="yourPhilipsHueBridgeIpAddress"
+ENV HUE_USERNAME="yourPhilipsHueApiUsername"
+ENV PORT=3000
+
+WORKDIR /usr/src/app
+COPY . .
+
+# Install hueget
+RUN npm install hueget
+
+# Expose the API port
+EXPOSE $PORT
+
+# Start hueget
+CMD ["sh", "-c", "node hueget.js -i $HUE_BRIDGE_IP -u $HUE_USERNAME -p $PORT"]

package/README.md

@@ -84,7 +84,7 @@ $ node /home/pi/node_modules/hueget/hueget.js -i 192.168.0.101 -u UBxWZChHseyjeF
 ```
 A successful start of hueget (using the above command to specify ip address 192.168.0.100 and port 1234) will show:
 ```
-hueget v0.7.3
+hueget v0.7.6
 commands will be sent to 192.168.0.101 with username UBxWZChHseyjeFwAkwgbdQ08x9XASWpanZZVg-mj
 listening on port 1234
 ```
@@ -119,6 +119,7 @@ $ pm2 describe hueget
 ```
 For more information about pm2, see https://github.com/Unitech/pm2
 
+
 # Getting your Philips Hue Bridge API Username
 If you have [Homebridge](https://homebridge.io/), and the [homebridge-hue](https://github.com/ebaauw/homebridge-hue) plugin, look at the **users** section of the hue config. You will see the Hue bridge MAC address folowed by the Hue bridge api username
 ```
@@ -131,6 +132,21 @@ The username will look something like this:
 UBxWZChHseyjeFwAkwgbdQ08x9XASWpanZZVg-mj
 ```
 
+# Running hueget with Docker (optional, only if you use a Docker environment)
+You can run hueget easily using Docker and Docker Compose. This approach simplifies the setup in a Docker environment and ensures hueget is isolated and always running reliably.
+
+## Prerequisites
+- Install [Docker](https://www.docker.com/) and [Docker Compose](https://docs.docker.com/compose/).
+
+## Steps
+1. Use the provided `HUE_BRIDGE_IP` and `HUE_USERNAME` environment variables in the `docker-compose.yml` file to configure your Philips Hue Bridge connection.
+
+2. Build and run the Docker container:
+   ```bash
+   docker compose up -d
+   ```
+
+
 # Reading the Status of your Hue Lights or Groups with hueget
 Enter a URL (in the format shown below) into your browser and press Enter. The ip address is the ip address of the device running hueget, eg: a raspberry pi.
 Examples:

package/docker-compose.yml

@@ -0,0 +1,11 @@
+services:
+  hueget:
+    build:
+      context: .
+    container_name: hueget
+    ports:
+      - "3000:3000"
+    environment:
+      HUE_BRIDGE_IP: "yourPhilipsHueBridgeIpAddress" # Replace with your Philips Hue bridge IP address
+      HUE_USERNAME: "yourPhilipsHueApiUsername" # Replace with your Philips Hue api username
+    restart: unless-stopped

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hueget",
-  "version": "0.7.4",
+  "version": "0.7.6",
   "description": "A simple API that converts the Philips Hue API PUT to GET requests, allowing control of Philips Hue lights via http GET requests",
   "main": "hueget.js",
   "scripts": {
@@ -25,11 +25,11 @@
   "author": "Jochen Siegenthaler (https://github.com/jsiegenthaler)",
   "license": "ISC",
   "dependencies": {
-    "axios": "^1.7.7",
-    "express": "^4.21.1",
+    "axios": "^1.7.9",
+    "express": "^4.21.2",
     "stdio": "^2.1.3"
   },
   "engines": {
-    "node": "^20"
+    "node": "^22"
   }
 }