From 7f8242cf9850b2934caba44185715871e7c57bdd Mon Sep 17 00:00:00 2001
From: taichunmin <taichunmin@gmail.com>
Date: Thu, 13 Feb 2025 10:55:48 +0800
Subject: [PATCH] Added docker-compose.yml to build firmware in local docker

---
 CHANGELOG.md                |  1 +
 firmware/docker-compose.yml | 27 +++++++++++++++++++++++++++
 2 files changed, 28 insertions(+)
 create mode 100644 firmware/docker-compose.yml

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 398b0b3..107defc 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -3,6 +3,7 @@ All notable changes to this project will be documented in this file.
 This project uses the changelog in accordance with [keepchangelog](http://keepachangelog.com/). Please use this to write notable changes, which is not the same as git commit log...
 
 ## [unreleased][unreleased]
+ - Added `firmware/docker-compose.yml` to build firmware in local docker (@taichunmin)
  - Added command to check keys of multiple sectors at once (@taichunmin)
  - Fixed unused target key type parameter for nested (@petepriority)
  - Skip already used items `hf mf elog --decrypt` (@p-l-)
diff --git a/firmware/docker-compose.yml b/firmware/docker-compose.yml
new file mode 100644
index 0000000..2703bde
--- /dev/null
+++ b/firmware/docker-compose.yml
@@ -0,0 +1,27 @@
+# How to use this docker-compose.yml file:
+# ========================================
+# 1. Install [Docker](https://www.docker.com/)
+# 2. Change the current directory to the `firmware/` directory
+# 3. Run `docker compose up --pull=always build-ultra` to build the firmware for the ChameleonUltra
+# 4. Run `docker compose up --pull=always build-lite` to build the firmware for the ChameleonLite
+# 5. The firmware will be available in the `firmware/objects/` directory, you can build only one firmware at once.
+# 6. Install the firmware `ultra-dfu-app.zip` or `lite-dfu-app.zip` (in DFU mode)
+services:
+  build-ultra:
+    image: ghcr.io/rfidresearchgroup/chameleonultra-fw-builder:main
+    # image: ghcr.io/chameleonultra/chameleonultra-fw-builder:main
+    platform: linux/amd64
+    volumes:
+      - '../:/workdir:rw'
+    environment:
+      CURRENT_DEVICE_TYPE: ultra
+    command: bash ./firmware/build.sh
+  build-lite:
+    image: ghcr.io/rfidresearchgroup/chameleonultra-fw-builder:main
+    # image: ghcr.io/chameleonultra/chameleonultra-fw-builder:main
+    platform: linux/amd64
+    volumes:
+      - '../:/workdir:rw'
+    environment:
+      CURRENT_DEVICE_TYPE: lite
+    command: bash ./firmware/build.sh
\ No newline at end of file