From b9c5b148a1cd5d9820c648d8ee31b7e427de384c Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 19 Feb 2025 00:12:17 +0000 Subject: [PATCH] update README.md --- .inputs | 4 ++ README.md | 142 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 146 insertions(+) create mode 100644 .inputs create mode 100644 README.md diff --git a/.inputs b/.inputs new file mode 100644 index 0000000..4b7cc38 --- /dev/null +++ b/.inputs @@ -0,0 +1,4 @@ +{ + "readme": "true", + "release": "true" +} diff --git a/README.md b/README.md new file mode 100644 index 0000000..a2c482c --- /dev/null +++ b/README.md @@ -0,0 +1,142 @@ +![banner](https://github.com/11notes/defaults/blob/main/static/img/banner.png?raw=true) + +# ⛰️ kms +[](https://github.com/11notes/docker-kms)![size](https://img.shields.io/docker/image-size/11notes/kms/465f4d1?color=0eb305)![version](https://img.shields.io/docker/v/11notes/kms/465f4d1?color=eb7a09)![pulls](https://img.shields.io/docker/pulls/11notes/kms?color=2b75d6)[](https://github.com/11notes/docker-kms/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/tags?name=465f4d1) +* [stable](https://hub.docker.com/r/11notes/kms/tags?name=stable) +* [latest](https://hub.docker.com/r/11notes/kms/tags?name=latest) +* [465f4d1-unraid](https://hub.docker.com/r/11notes/kms/tags?name=465f4d1-unraid) +* [stable-unraid](https://hub.docker.com/r/11notes/kms/tags?name=stable-unraid) +* [latest-unraid](https://hub.docker.com/r/11notes/kms/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. + +![Windows Server 2025](https://github.com/11notes/docker-kms/blob/master/img/WindowsSRV2025.png?raw=true) +![Windows 11 LTSC 2024](https://github.com/11notes/docker-kms/blob/master/img/Windows11ENTLTSC.png?raw=true) +![Web GUI](https://github.com/11notes/docker-kms/blob/master/img/webGUICustomIcon.png?raw=true) + +# SYNOPSIS 📖 +**What can I do with this?** This image will run a KMS server you can use to activate any version of Windows and Office, forever. + +Works with: +- Windows Vista +- Windows 7 +- Windows 8 +- Windows 8.1 +- Windows 10 +- Windows 11 +- Windows Server 2008 +- Windows Server 2008 R2 +- Windows Server 2012 +- Windows Server 2012 R2 +- Windows Server 2016 +- Windows Server 2019 +- Windows Server 2022 +- Windows Server 2025 +- Microsoft Office 2010 ( Volume License ) +- Microsoft Office 2013 ( Volume License ) +- Microsoft Office 2016 ( Volume License ) +- Microsoft Office 2019 ( Volume License ) +- Microsoft Office 2021 ( Volume License ) +- Microsoft Office 2024 ( Volume License ) + +# VOLUMES 📁 +* **/kms/var** - Directory of the activation database + +# COMPOSE ✂️ +```yaml +name: "kms" +services: + kms: + image: "11notes/kms:465f4d1" + container_name: "kms" + environment: + TZ: "Europe/Zurich" + volumes: + - "var:/kms/var" + ports: + - "1688:1688/tcp" + restart: "always" + kms-gui: + image: "11notes/kms-gui:stable" + container_name: "kms-gui" + environment: + TZ: "Europe/Zurich" + volumes: + - "var:/kms/var" + ports: + - "8080:8080/tcp" + restart: "always" +volumes: + var: +``` + +# EXAMPLE +## Windows Server 2025 Datacenter. List of [GVLK](https://learn.microsoft.com/en-us/windows-server/get-started/kms-client-activation-keys) +```cmd +slmgr /ipk D764K-2NDRG-47T6Q-P8T8W-YP6DF +``` +Add your KMS server information to server via registry +```powershell +Set-ItemProperty -Path "HKLM:\SOFTWARE\Microsoft\Windows NT\CurrentVersion\SoftwareProtectionPlatform" -Name "KeyManagementServiceName" -Value "KMS_IP" +Set-ItemProperty -Path "HKLM:\SOFTWARE\Microsoft\Windows NT\CurrentVersion\SoftwareProtectionPlatform" -Name "KeyManagementServicePort" -Value "KMS_PORT" + +Set-ItemProperty -Path "HKLM:\SOFTWARE\Microsoft\OfficeSoftwareProtectionPlatform" -Name "KeyManagementServiceName" -Value "KMS_IP" +Set-ItemProperty -Path "HKLM:\SOFTWARE\Microsoft\OfficeSoftwareProtectionPlatform" -Name "KeyManagementServicePort" -Value "KMS_PORT" +``` +Activate server +```cmd +slmgr /ato +``` + +# 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 | +| `database` | /kms/var/kms.db | SQlite database holding all client data | + +# 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_LOCALE` | see Microsoft LICD specification | 1033 (en-US) | +| `KMS_CLIENTCOUNT` | client count > 25 | 26 | +| `KMS_ACTIVATIONINTERVAL` | Retry unsuccessful after N minutes | 120 (2 hours) | +| `KMS_RENEWALINTERVAL` | re-activation after N minutes | 259200 (180 days) | +| `KMS_LOGLEVEL` | CRITICAL, ERROR, WARNING, INFO, DEBUG, MININFO | INFO | + +# SOURCE 💾 +* [11notes/kms](https://github.com/11notes/docker-kms) + +# PARENT IMAGE 🏛️ +* [11notes/alpine:stable](https://hub.docker.com/r/11notes/alpine) + +# BUILT WITH 🧰 +* [py-kms](https://github.com/Py-KMS-Organization/py-kms) + +# 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 +* Do not expose this image to WAN! You will get notified from Microsoft via your ISP to terminate the service if you do so +* [Microsoft LICD](https://learn.microsoft.com/en-us/openspecs/office_standards/ms-oe376/6c085406-a698-4e12-9d4d-c3b0ee3dbc4a) +* Use [11notes/kms-gui](https://github.com/11notes/docker-kms-gui) if you want to see the clients you activated in a nice web GUI + +# 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/releases) for breaking changes. If you have any problems with using this image simply raise an [issue](https://github.com/11notes/docker-kms/issues), thanks. If you have a question or inputs please create a new [discussion](https://github.com/11notes/docker-kms/discussions) instead of an issue. You can find all my other repositories on [github](https://github.com/11notes?tab=repositories). \ No newline at end of file