Vlmcsd - KMS
Container
This is a replacement for Microsoft's KMS server.
Image details
Configuration
TypeContainerlinuxmikolatero/vlmcsd:latest1688:1688/tcpunless-stoppedTemplate by novaspirit
Notes
Check our Github page: https://github.com/pi-hosted/pi-hosted
Official Webpage: https://hub.docker.com/r/mikolatero/vlmcsd
Official Docker Documentation: https://github.com/mikolatero/docker-vlmcsd
Standalone Install
Select an install method, to see config/commands for deploying Vlmcsd - KMS
Install on Portainer
Import all app templates into your Portainer instance, for easy 1-click deploys
- Ensure both Docker and Portainer are installed, and up-to-date
- Log into your Portainer web UI
- Under Settings → App Templates, paste the below URL
- Head to Home → App Templates, and the list of apps will show up
- Select Vlmcsd - KMS, fill in any config options, and hit Deploy
Template Import URL
https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me
More install options in our documentation.
vlmcsd is a replacement for Microsoft's KMS server.
It contains vlmcs, a KMS test client, mainly for debugging purposes, that also can "charge" a genuine KMS server designed to run on an always-on or often-on device, e.g. router, NAS Box, ...intended to help people who lost activation of their legally-owned licenses, e.g. due to a change of hardware (motherboard, CPU, ...)
vlmcsd is not a one-click activation or crack tool intended to activate illegal copies of software (Windows, Office, Project, Visio)
Info / About this docker
Docker based in Alpine OS with vlmcsd compiled from "source" (Wind4 GitHub)Server Usage:
$ docker run -d -p 1688:1688 --restart=always --name vlmcsd mikolatero/vlmcsd
To view docker log:
Now (thanks to embii74) vlmcsd process send logs to docker.$ docker logs vlmcsd (change 'vlmcsd' with the docker's name)
Client
Windows
>slmgr.vbs -upk>slmgr.vbs -ipk XXXXX-XXXXX-XXXXX-XXXXX-XXXXX
>slmgr.vbs -skms DOCKERIP
>slmgr.vbs -ato
>slmgr.vbs -dlv
Office x86
>cd \Program Files (x86)\Microsoft Office\Office16>cscript ospp.vbs /sethst:DOCKERIP
>cscript ospp.vbs /inpkey:xxxxx-xxxxx-xxxxx-xxxxx-xxxxx
>cscript ospp.vbs /act
>cscript ospp.vbs /dstatusall
Office x8664
>cd \Program Files\Microsoft Office\Office16>cscript ospp.vbs /sethst:DOCKERIP
>cscript ospp.vbs /inpkey:xxxxx-xxxxx-xxxxx-xxxxx-xxxxx
>cscript ospp.vbs /act
>cscript ospp.vbs /dstatusall
Sources
https://forums.mydigitallife.info/threads/50234-Emulated-KMS-Servers-on-non-Windows-platformshttps://github.com/Wind4/vlmcsd
GVLK keys
Windows: https://docs.microsoft.com/en-us/windows-server/get-started/kmsclientkeys
Office 2013: https://technet.microsoft.com/en-us/library/dn385360.aspx
Office 2016 & 2019: https://technet.microsoft.com/en-us/library/dn385360(v=office.16).aspx
Docker Link
https://hub.docker.com/r/mikolatero/vlmcsd/
Serve Vlmcsd - KMS on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.
Proxying vlmcsd-kms.example.com to http://vlmcsd-kms:1688
Add this to your Caddyfile
vlmcsd-kms.example.com {
reverse_proxy http://vlmcsd-kms:1688
}Check the logs first
Nine times out of ten the logs tell you exactly what went wrong.
- In Portainer, go to Containers, click the container, then Logs. Or run
docker logs vlmcsd-kms - Exit codes help too:
137means killed, usually out of memory.126or127means the command inside the image is broken.
Port already in use
If deployment fails with "Bind for 0.0.0.0:1688 failed: port is already allocated", something else on your server is using that port.
- Find what's using it:
sudo ss -tlnp | grep :1688 - Stop the other service, or pick a different host port. In
1688:1688only the left number is yours to change, the right one belongs to the app.
Running but the page won't load
The container is up but nothing appears in your browser.
- Use your server's real IP:
http://your-server-ip:1688. The 0.0.0.0 link Portainer shows isn't a real address. - Give it a minute after first deploy, vlmcsd-kms can take a while to initialise.
- Make sure your firewall allows the port, e.g.
sudo ufw allow 1688
Image won't pull
Test the pull directly on the host: docker pull mikolatero/vlmcsd:latest
- "manifest unknown" means the tag no longer exists. This template uses
latest, so try pinning a specific version instead. - "toomanyrequests" is the Docker Hub rate limit. Log in with
docker loginto raise it. - "no space left on device" means a full disk. Reclaim space with
docker system prune
"exec format error"
This means the image was built for a different CPU architecture than your server.
- This image supports:
amd64, arm64, arm/v7, arm/v6, 386 - Check yours with
uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.
Container keeps restarting
The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.
- Check the logs right after a restart, the last few lines before it died are the useful ones.
- Get the exit code with
docker inspect vlmcsd-kms --format '{{.State.ExitCode}}' - Still stuck? Redeploy once with the restart policy set to
noso the failure stays visible.
Data disappears when the container is recreated
This template doesn't define any volumes, so everything vlmcsd-kms saves lives inside the container and is lost on update or recreate.
- Add a volume mapping for vlmcsd-kms's data folder before storing anything you care about.
Raise an issue
Found something which isn't working as it should? Here's how to report it.
- Bug within the app: Open an issue within vlmcsd-kms's repo
- Template not working: Open an issue on novaspirit/pi-hosted
- This website not working: Open an issue on lissy93/portainer-templates
A single container
Vlmcsd - KMS runs as one container, the simplest kind of app here. Just the one image to pull and nothing else wired up alongside it.
The app image
An image is the app packed up ready to go, everything Vlmcsd - KMS needs bundled into one download. This template pulls mikolatero/vlmcsd:latest, which Docker fetches once (about 4 MB) and then starts your own copy from.
Where the image comes from
Docker pulls its images from registries, public libraries of ready-built apps. Vlmcsd - KMS's comes from Docker Hub, published by mikolatero.
Version tags
The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Pin a specific tag if you would rather stay on one version.
Which machines it runs on
Every image is built for particular CPU types. This one ships for amd64, arm64, arm/v7, arm/v6, 386, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.
Ports
A port is the door the app answers on. A mapping like 1688:1688 means it's reachable on port 1688 of your server, where the left number is yours to change and the right one belongs to the app. It opens:
1688:1688
No stored data
This template doesn't mount any storage, so whatever Vlmcsd - KMS writes stays inside the container and is wiped if it's recreated or updated. That's fine for something stateless, but add a volume before trusting it with anything you want to keep.
Restart policy
The restart policy here is unless-stopped, so Docker restarts Vlmcsd - KMS after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).
Networking
Nothing custom is set, so Vlmcsd - KMS sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.
Container name
Once it's deployed, Portainer names the container vlmcsd-kms. That's what you'll spot in the containers list and use in commands like docker logs vlmcsd-kms.
Platform
The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.
Portainer app templates
Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Vlmcsd - KMS up. Add the template list to Portainer once, then deploying Vlmcsd - KMS is a click rather than a wall of config.