update README.md

2025-11-04 13:03:13 +00:00 · 2025-02-19 00:14:17 +00:00
parent d161bab2d8
commit e555a3b1e3
2 changed files with 94 additions and 0 deletions
--- a/.inputs
+++ b/.inputs
@@ -0,0 +1,4 @@
+{
+  "readme": "true",
+  "release": "false"
+}
--- a/README.md
+++ b/README.md
@@ -0,0 +1,90 @@
+![banner](https://github.com/11notes/defaults/blob/main/static/img/banner.png?raw=true)
+
+# ⛰️ kms-gui
+[<img src="https://img.shields.io/badge/github-source-blue?logo=github&color=040308">](https://github.com/11notes/docker-kms-gui)![size](https://img.shields.io/docker/image-size/11notes/kms-gui/465f4d1?color=0eb305)![version](https://img.shields.io/docker/v/11notes/kms-gui/465f4d1?color=eb7a09)![pulls](https://img.shields.io/docker/pulls/11notes/kms-gui?color=2b75d6)[<img src="https://img.shields.io/github/issues/11notes/docker-kms-gui?color=7842f5">](https://github.com/11notes/docker-kms-gui/issues)
+
+Activate any version of Windows and Office, forever
+
+# MAIN TAGS 🏷️
+These are the main tags for the image. There is also a tag for each commit and its shorthand sha256 value.
+
+* [465f4d1](https://hub.docker.com/r/11notes/kms-gui/tags?name=465f4d1)
+* [stable](https://hub.docker.com/r/11notes/kms-gui/tags?name=stable)
+* [latest](https://hub.docker.com/r/11notes/kms-gui/tags?name=latest)
+* [465f4d1-unraid](https://hub.docker.com/r/11notes/kms-gui/tags?name=465f4d1-unraid)
+* [stable-unraid](https://hub.docker.com/r/11notes/kms-gui/tags?name=stable-unraid)
+* [latest-unraid](https://hub.docker.com/r/11notes/kms-gui/tags?name=latest-unraid)
+
+# UNRAID VERSION 🟠
+This image supports unraid by default. Simply add **-unraid** to any tag and the image will run as 99:100 instead of 1000:1000 causing no issues on unraid. Enjoy.
+
+![Web GUI](https://github.com/11notes/docker-kms-gui/blob/master/img/webGUICustomIcon.png?raw=true)
+
+# SYNOPSIS 📖
+**What can I do with this?** This image will run a web GUI for your [11notes/kms](https://hub.docker.com/r/11notes/kms) server.
+
+# COMPOSE ✂️
+```yaml
+name: "kms"
+services:
+  kms:
+    image: "11notes/kms:stable"
+    container_name: "kms"
+    environment:
+      TZ: Europe/Zurich
+    volumes:
+      - "var:/kms/var"
+    ports:
+      - "1688:1688/tcp"
+    restart: always
+  kms-gui:
+    image: "11notes/kms-gui:465f4d1"
+    container_name: "kms-gui"
+    environment:
+      TZ: Europe/Zurich
+    volumes:
+      - "var:/kms/var"
+    ports:
+      - "8080:8080/tcp"
+    restart: always
+volumes:
+  var:
+```
+
+# DEFAULT SETTINGS 🗃️
+| Parameter | Value | Description |
+| --- | --- | --- |
+| `user` | docker | user name |
+| `uid` | 1000 | [user identifier](https://en.wikipedia.org/wiki/User_identifier) |
+| `gid` | 1000 | [group identifier](https://en.wikipedia.org/wiki/Group_identifier) |
+| `home` | /kms | home directory of user docker |
+
+# ENVIRONMENT 📝
+| Parameter | Value | Default |
+| --- | --- | --- |
+| `TZ` | [Time Zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) | |
+| `DEBUG` | Will activate debug option for container image and app (if available) | |
+| `KMS_GUI_STYLE` | switch the UI style of the webinterface (py-kms, custom-icon) | custom-icon, py-kms |
+
+# SOURCE 💾
+* [11notes/kms-gui](https://github.com/11notes/docker-kms-gui)
+
+# PARENT IMAGE 🏛️
+* [11notes/kms:465f4d1](https://hub.docker.com/r/11notes/kms)
+
+# BUILT WITH 🧰
+* [py-kms](https://github.com/Py-KMS-Organization/py-kms)
+* [CustomIcon/pykms-frontend](https://github.com/CustomIcon/pykms-frontend)
+
+# GENERAL TIPS 📌
+* Use a reverse proxy like Traefik, Nginx, HAproxy to terminate TLS and to protect your endpoints
+* Use Let’s Encrypt DNS-01 challenge to obtain valid SSL certificates for your services
+
+# SECURITY VULNERABILITIES REPORT ⚡
+| Severity | Package | Version | Fix Version | Type | Location | Data Namespace | Link |
+| --- | --- | --- | --- | --- | --- | --- | --- |
+| 4.7 (Medium) | linux-pam  | 1.6.1-r1  |   | apk  | /lib/apk/db/installed  | nvd:cpe  | [CVE-2024-10041](https://nvd.nist.gov/vuln/detail/CVE-2024-10041)  |
+
+
+# ElevenNotes™️
+This image is provided to you at your own risk. Always make backups before updating an image to a different version. Check the [releases](https://github.com/11notes/docker-kms-gui/releases) for breaking changes. If you have any problems with using this image simply raise an [issue](https://github.com/11notes/docker-kms-gui/issues), thanks. If you have a question or inputs please create a new [discussion](https://github.com/11notes/docker-kms-gui/discussions) instead of an issue. You can find all my other repositories on [github](https://github.com/11notes?tab=repositories).