This chart deploys WProofreader Admin-panel on Kubernetes.
It is intended for operators who already have WProofreader Server and access to MySQL 8.4.
Admin-panel 3.0.0 or newer is required.
For a first installation, follow the quick start.
After the first release, the chart is available from the WebSpellChecker Helm repository. Prepare the dependencies and the Secret as described in the quick start.
Download the minimal example as your values file, then set your URLs and database settings in it, as described in step 4 of the quick start:
curl -fsSL -o values.local.yaml \
https://raw.githubusercontent.com/WebSpellChecker/admin-panel-helm/main/docs/examples/values-minimal.yamlTo match a pinned chart version, replace main with its release tag, for example v1.0.0.
Install the chart:
helm repo add webspellchecker https://webspellchecker.github.io/admin-panel-helm
helm repo update webspellchecker
helm upgrade --install admin-panel webspellchecker/admin-panel \
--namespace wsc \
--values values.local.yaml \
--atomic \
--timeout 10mAdd --version <chart version> to pin a release.
Until the first release, install from a source checkout with ./admin-panel,
as the quick start shows.
These services must be reachable from the namespace where you install the chart:
| Dependency | Purpose | Where to get it |
|---|---|---|
| Admin-panel MySQL database | Stores users, teams, sessions, cache, and queues | Any MySQL 8.4 server you operate, or a managed MySQL service |
| WProofreader service database | Stores WProofreader service and usage data | Follow Connect to and provision a database in wproofreader-helm |
| WProofreader Server | Provides proofreading services | wproofreader-helm |
The Admin-panel and WProofreader databases are separate logical databases, but they can use the same MySQL 8.4 instance. Use separate database names, users, and permissions.
This chart does not install MySQL, provision the WProofreader database, or install WProofreader Server. It migrates only the Admin-panel database.
- Quick start: first deployment and verification
- Environment variables: Helm values, generated environment variables, secrets, and overrides
- Routing: Gateway API, Ingress, and TLS
- Operator guide: storage, scaling, upgrades, and troubleshooting
- Examples: minimal, routing, and storage values
- Chart values: generated value reference
- Changelog
| Repository | What it contains |
|---|---|
| wproofreader-helm | The Helm chart for WProofreader Server. It also creates the WProofreader service database with db-manager. |
| mysql-server-helm | A Helm chart that runs MySQL in the cluster. |
| wproofreader-gitops | Argo CD and Flux configurations that deploy the full stack from Git: MySQL, WProofreader Server, Admin-panel, cert-manager, and a Gateway API controller. |
| wproofreader-docker | Docker build files for WProofreader Server, and a Docker Compose example of the full stack on one host. |
Read CONTRIBUTING.md before you send a pull request. Use GitHub issues for reproducible chart defects and WebSpellChecker support for product support. Report suspected vulnerabilities through the security policy.