Skip to content

Commit 06e6bdf

Browse files
committed
fix: break long lines to comply with markdown linting rules
- Reformat lines exceeding 80 character limit in README.md - Break long lines in docs/how-to/install-kubernetes.md - Improve readability while maintaining markdown formatting https://claude.ai/code/session_01UJodgmvR7sQz79waMx2bq4
1 parent 07cccbc commit 06e6bdf

2 files changed

Lines changed: 34 additions & 14 deletions

File tree

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,15 +60,18 @@ bin/production.sh up -d --wait
6060
bin/production.sh run --rm web setup.sh
6161
```
6262

63-
After setup, the management interface is at `http://127.0.0.1:81/manager/` and webmail at `http://127.0.0.1:81/webmail/`.
63+
After setup, access the management interface at
64+
`http://127.0.0.1:81/manager/` and webmail at `http://127.0.0.1:81/webmail/`.
6465

65-
For a complete walkthrough, see the [Getting Started tutorial](docs/tutorials/getting-started.md).
66+
For a complete walkthrough, see the
67+
[Getting Started tutorial](docs/tutorials/getting-started.md).
6668

6769
## Setup
6870

6971
`docker-mailserver` can be set up using Docker or Kubernetes.
7072

71-
For detailed installation instructions, see the [Installation Guide](docs/installation.md) in the documentation.
73+
For detailed installation instructions, see the
74+
[Installation Guide](docs/installation.md).
7275

7376
## Screenshots
7477

docs/how-to/install-kubernetes.md

Lines changed: 28 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
# How to Install on Kubernetes
22

3-
This guide describes how to deploy docker-mailserver on Kubernetes with Kustomize. An external MySQL-compatible database is required; the kustomization does not provision a database.
3+
This guide describes how to deploy docker-mailserver on Kubernetes with
4+
Kustomize. An external MySQL-compatible database is required; the
5+
kustomization does not provision a database.
46

5-
A full example is in [example-configs/kustomize/external-db-and-https-ingress](https://github.com/jeboehm/docker-mailserver/tree/main/docs/example-configs/kustomize/external-db-and-https-ingress).
7+
A full example is in [example-configs/kustomize/external-db-and-https-ingress](../example-configs/kustomize/external-db-and-https-ingress/).
68

79
## Prerequisites
810

@@ -14,9 +16,15 @@ A full example is in [example-configs/kustomize/external-db-and-https-ingress](h
1416

1517
### 1. Configure environment (ConfigMap and Secrets)
1618

17-
Use `.env.dist` as a reference for the required variables. Create a Kubernetes ConfigMap from the non-sensitive values and Kubernetes Secrets for sensitive values (database credentials, passwords, API keys). See [Environment variables reference](../reference/environment-variables.md) for the full variable list.
19+
Use `.env.dist` as a reference for required variables. Create a Kubernetes
20+
ConfigMap for non-sensitive values and Secrets for sensitive values
21+
(credentials, passwords, API keys). See [Environment variables
22+
reference](../reference/environment-variables.md) for the full list.
1823

19-
The example configuration in [example-configs/kustomize/external-db-and-https-ingress](../example-configs/kustomize/external-db-and-https-ingress/) shows how to structure these resources.
24+
See the
25+
[example-configs/kustomize/external-db-and-https-ingress](../example-configs/kustomize/external-db-and-https-ingress/)
26+
directory for a sample configuration showing how to structure these
27+
resources.
2028

2129
### 2. Create namespace
2230

@@ -30,7 +38,9 @@ kubectl create namespace mail
3038
bin/create-tls-certs.sh
3139
```
3240

33-
This writes a self-signed certificate and key to `config/tls/tls.crt` and `config/tls/tls.key`. For production, use certificates from a CA (e.g. cert-manager with Let's Encrypt) instead.
41+
This writes a self-signed certificate to `config/tls/tls.crt` and key to
42+
`config/tls/tls.key`. For production, use CA certificates (e.g.
43+
cert-manager with Let's Encrypt) instead.
3444

3545
### 4. Create TLS secret
3646

@@ -62,20 +72,27 @@ Wait until all pods are running and healthy.
6272
kubectl exec -n mail -it deployment/web -c php-fpm -- setup.sh
6373
```
6474

65-
Use the wizard to set initial configuration, create the first email address, and create an admin user.
75+
Use the wizard to set initial configuration, create the first email
76+
address, and create an admin user.
6677

6778
### 8. Access the management interface
6879

6980
Use your configured ingress and the admin credentials from the wizard.
7081

7182
## Post-installation
7283

73-
- Configure DNS and TLS as for Docker. See [How to configure DNS](configure-dns.md) and [How to configure TLS certificates](configure-tls.md).
84+
- Configure DNS and TLS like Docker deployment. See [How to configure
85+
DNS](configure-dns.md) and [How to configure TLS
86+
certificates](configure-tls.md).
7487
- Change `DOVEADM_API_KEY` from default if using observability (v7.3+).
7588

7689
## Troubleshooting
7790

78-
- **Pods not starting:** Check pod logs with `kubectl logs -n mail <pod-name>` and events with `kubectl describe pod -n mail <pod-name>`.
79-
- **Database errors:** Verify database connectivity and that the `MYSQL_*` variables in the ConfigMap/Secrets are correct.
80-
- **TLS errors:** Confirm the `tls-certs` secret exists in the `mail` namespace and the certificate paths are correct.
81-
- **Setup wizard fails:** Ensure the web pod is running (`kubectl get pods -n mail`) before running the exec command.
91+
- **Pods not starting:** Check logs with `kubectl logs -n mail <pod-name>`
92+
and events with `kubectl describe pod -n mail <pod-name>`.
93+
- **Database errors:** Verify database connectivity and that the
94+
`MYSQL_*` variables in ConfigMap/Secrets are correct.
95+
- **TLS errors:** Confirm the `tls-certs` secret exists in the `mail`
96+
namespace and certificate paths are correct.
97+
- **Setup wizard fails:** Ensure the web pod is running (`kubectl get pods
98+
-n mail`) before running the exec command.

0 commit comments

Comments
 (0)