Skip to content

Commit efb8b5b

Browse files
claudejeboehm
authored andcommitted
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 efb8b5b

3 files changed

Lines changed: 33 additions & 17 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: 23 additions & 10 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,14 @@ 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 reference](../reference/environment-variables.md) for the full list.
1822

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.
23+
See the
24+
[example-configs/kustomize/external-db-and-https-ingress](../example-configs/kustomize/external-db-and-https-ingress/)
25+
directory for a sample configuration showing how to structure these
26+
resources.
2027

2128
### 2. Create namespace
2229

@@ -30,7 +37,9 @@ kubectl create namespace mail
3037
bin/create-tls-certs.sh
3138
```
3239

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.
40+
This writes a self-signed certificate to `config/tls/tls.crt` and key to
41+
`config/tls/tls.key`. For production, use CA certificates (e.g.
42+
cert-manager with Let's Encrypt) instead.
3443

3544
### 4. Create TLS secret
3645

@@ -62,20 +71,24 @@ Wait until all pods are running and healthy.
6271
kubectl exec -n mail -it deployment/web -c php-fpm -- setup.sh
6372
```
6473

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

6777
### 8. Access the management interface
6878

6979
Use your configured ingress and the admin credentials from the wizard.
7080

7181
## Post-installation
7282

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).
83+
- Configure DNS and TLS like Docker deployment. See [How to configure DNS](configure-dns.md) and [How to configure TLS certificates](configure-tls.md).
7484
- Change `DOVEADM_API_KEY` from default if using observability (v7.3+).
7585

7686
## Troubleshooting
7787

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.
88+
- **Pods not starting:** Check logs with `kubectl logs -n mail <pod-name>`
89+
and events with `kubectl describe pod -n mail <pod-name>`.
90+
- **Database errors:** Verify database connectivity and that the
91+
`MYSQL_*` variables in ConfigMap/Secrets are correct.
92+
- **TLS errors:** Confirm the `tls-certs` secret exists in the `mail`
93+
namespace and certificate paths are correct.
8194
- **Setup wizard fails:** Ensure the web pod is running (`kubectl get pods -n mail`) before running the exec command.

docs/reference/environment-variables.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,10 @@ When using the Redis service provided by docker-mailserver compose or kustomize,
4646

4747
Set `RELAYHOST` to `[hostname]:port` to route all outgoing mail through an external SMTP server. Leave unset to deliver directly.
4848

49-
| Variable | Default | Description |
50-
| ------------------- | -------------- | --------------------------------- |
51-
| `RELAYHOST` | _(disabled)_ | SMTP relay host for outgoing mail (e.g. `[smtp.example.com]:587`) |
52-
| `RELAY_PASSWD_FILE` | _(disabled)_ | Path to relay authentication file (inside the MTA container) |
49+
| Variable | Default | Description |
50+
| ------------------- | ------------ | ----------------------------------------------------------------- |
51+
| `RELAYHOST` | _(disabled)_ | SMTP relay host for outgoing mail (e.g. `[smtp.example.com]:587`) |
52+
| `RELAY_PASSWD_FILE` | _(disabled)_ | Path to relay authentication file (inside the MTA container) |
5353

5454
### Filter
5555

0 commit comments

Comments
 (0)