> For the complete documentation index, see [llms.txt](https://docs.wproofreader.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.wproofreader.com/v6.18.1/deployment/installation/kubernetes.md). # Kubernetes Deploy WProofreader Server on Kubernetes with Helm, with or without Admin-panel and MySQL. Use these guides to deploy WProofreader on Kubernetes with Helm. Select the installation that you need: | Installation | Use it for | Guide | | ------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------- | | WProofreader Server only | Spell check and grammar check without Admin-panel or a database. Manage the server with configuration files and APIs. | [Install WProofreader Server only](/v6.18.1/deployment/installation/kubernetes/install-wproofreader-server-only.md) | | Full stack | WProofreader Server with Admin-panel and MySQL. Manage products, team members, and service settings through Admin-panel. | [Install the full stack](#install-the-full-stack) | You can copy each command and paste it into a terminal. Each step identifies the values that you must replace. {% hint style="info" %} Text in angle brackets is a placeholder, for example ``. Replace the complete placeholder, including the brackets. {% endhint %} ### Components of the full stack | Component | Function | How you install it | | ------------------- | --------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | | WProofreader Server | Checks spelling and grammar. | With the [wproofreader-helm](https://github.com/WebSpellChecker/wproofreader-helm) chart | | Admin-panel | Web application where administrators activate products, invite team members, and read the license status. | With the [admin-panel-helm](https://github.com/WebSpellChecker/admin-panel-helm) chart | | MySQL 8.4 | Keeps two databases: `admin_panel_db` for Admin-panel and `cloud_service` for WProofreader Server. | Use your MySQL server, or install it with the [mysql-server-helm](https://github.com/WebSpellChecker/mysql-server-helm) chart | For the full stack, the WProofreader Server chart creates the `cloud_service` database for you. During each install and upgrade, it runs db-manager one time. db-manager creates or updates the tables and the database users, and then stops. The server-only installation does not run db-manager. ### How the full-stack components work together * Administrators open Admin-panel in a web browser. * The WProofreader products in the browser send their requests to WProofreader Server. * Admin-panel reads the license status from WProofreader Server. * Admin-panel and WProofreader Server keep their data in MySQL, in two different databases. ### Deployment options for the full stack | Option | Use it for | Guide | | -------------------------- | --------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | | Docker Compose on one host | Evaluation, demonstrations, and small installations | [Docker Compose example](https://github.com/WebSpellChecker/wproofreader-docker/tree/master/examples/admin-panel) | | Kubernetes with Helm | Production installations | [Install the full stack](#install-the-full-stack) | | Kubernetes with GitOps | Repeatable deployments for one or more environments | [GitOps examples](https://github.com/WebSpellChecker/wproofreader-gitops) | ### GitOps examples for the full stack Use the [wproofreader-gitops](https://github.com/WebSpellChecker/wproofreader-gitops) repository to manage the stack from Git. It contains: * An Argo CD example that uses an App-of-Apps structure and an ApplicationSet. * A Flux example that uses Kustomizations and HelmReleases. * Helm values for WProofreader Server, Admin-panel, and MySQL. * Shared configurations for Gateway API, Traefik, cert-manager, and TLS. * Instructions to add an environment, update chart versions, and remove the stack. The examples reference Kubernetes Secrets, but they do not keep secret values in Git. Create the Secrets with your secret-management system before the GitOps controller deploys the stack. Check all pinned versions, host names, storage settings, and TLS settings before you use an example in production. ### Install the full stack Do the steps in this order: 1. [Prerequisites](/v6.18.1/deployment/installation/kubernetes/prerequisites.md) 2. [Prepare MySQL](/v6.18.1/deployment/installation/kubernetes/prepare-mysql.md) 3. [Install WProofreader Server](/v6.18.1/deployment/installation/kubernetes/install-wproofreader-server.md) 4. [Install Admin-panel](/v6.18.1/deployment/installation/kubernetes/install-admin-panel.md) 5. [Create the first administrator](/v6.18.1/deployment/installation/kubernetes/create-the-first-administrator.md) 6. [Set up external access](/v6.18.1/deployment/installation/kubernetes/set-up-external-access.md) To upgrade or remove the stack later, see [Upgrade and uninstall](/v6.18.1/deployment/installation/kubernetes/upgrade-and-uninstall.md). ### Versions for the full stack The server-only installation uses the same Kubernetes, Helm, and WProofreader Server versions. It does not need Admin-panel or MySQL. | Component | Version | | ---------- | ------------- | | Kubernetes | 1.27 or later | | Helm | 3.15 or later | | MySQL | 8.4 | For the compatible versions of WProofreader Server, admin-panel and their Helm charts, see [Admin-panel compatibility](/v6.18.1/deployment/installation-requirements/on-premise-versions-support.md#admin-panel-compatibility).