diff --git a/docs/kubernetes/README.md b/docs/kubernetes/README.md new file mode 100644 index 00000000..810e31f7 --- /dev/null +++ b/docs/kubernetes/README.md @@ -0,0 +1,14 @@ +# Installing Mailu with Kubernetes # + +# Prerequisites # + +The resource configurations in this folder assume that you have [Kubernetes Ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/) set up for your cluster. If you are not using the [NGINX Ingress Controller for Kubernetes](https://github.com/kubernetes/ingress/tree/master/controllers/nginx), please ensure that the configuration specified in the file matches your set up. + +# How to use # + +Using the resource configurations is simple: + +1. `kubectl apply -f kubernetes-nginx-ingress-controller.yaml` to configure an ingress controller with the proper settings. (If you have one set up already you may need to port the configuration to your own ingress). +2. `kubectl apply -f kubernetes-mailu.yaml` to create the resources required to run Mailu. + +Based on the configuration, your Mailu instance should be available at `mail..tld/admin` (note that visiting just `mail..tld` will likely result in a 404. diff --git a/kubernetes-mailu.yaml b/docs/kubernetes/kubernetes-mailu.yaml similarity index 100% rename from kubernetes-mailu.yaml rename to docs/kubernetes/kubernetes-mailu.yaml diff --git a/kubernetes-nginx-ingress-controller.yaml b/docs/kubernetes/kubernetes-nginx-ingress-controller.yaml similarity index 100% rename from kubernetes-nginx-ingress-controller.yaml rename to docs/kubernetes/kubernetes-nginx-ingress-controller.yaml