mirror of
https://github.com/11notes/docker-kms-gui.git
synced 2025-10-23 04:52:15 +00:00
94 lines
4.4 KiB
Markdown
94 lines
4.4 KiB
Markdown
|
||
|
||
# KMS-GUI
|
||
[<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
|
||
|
||
|
||
|
||
# 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:
|
||
app:
|
||
image: "11notes/kms:1.0.0"
|
||
environment:
|
||
TZ: "Europe/Zurich"
|
||
volumes:
|
||
- "var:/kms/var"
|
||
ports:
|
||
- "1688:1688/tcp"
|
||
restart: "always"
|
||
|
||
gui:
|
||
image: "11notes/kms-gui:latest"
|
||
depends_on:
|
||
app:
|
||
condition: "service_healthy"
|
||
restart: true
|
||
environment:
|
||
TZ: "Europe/Zurich"
|
||
volumes:
|
||
- "var:/kms/var"
|
||
ports:
|
||
- "3000:3000/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 |
|
||
|
||
# MAIN TAGS 🏷️
|
||
These are the main tags for the image. There is also a tag for each commit and its shorthand sha256 value.
|
||
|
||
* [latest](https://hub.docker.com/r/11notes/kms-gui/tags?name=latest)
|
||
* [latest-unraid](https://hub.docker.com/r/11notes/kms-gui/tags?name=latest-unraid)
|
||
|
||
# REGISTRIES ☁️
|
||
```
|
||
docker pull 11notes/kms-gui:latest
|
||
docker pull ghcr.io/11notes/kms-gui:latest
|
||
docker pull quay.io/11notes/kms-gui:latest
|
||
```
|
||
|
||
# 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.
|
||
|
||
# SOURCE 💾
|
||
* [11notes/kms-gui](https://github.com/11notes/docker-KMS-GUI)
|
||
|
||
# PARENT IMAGE 🏛️
|
||
* [11notes/kms](${{ json_readme_parent_url }})
|
||
|
||
# BUILT WITH 🧰
|
||
* [11notes/fork-pykms-frontend](https://github.com/11notes/fork-pykms-frontend)
|
||
* [11notes/util](https://github.com/11notes/docker-util)
|
||
|
||
# GENERAL TIPS 📌
|
||
> [!TIP]
|
||
>* 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
|
||
|
||
# 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).
|
||
|
||
*created 20.07.2025, 13:19:01 (CET)* |