binwiederhier/ntfy
1
0
Fork 0
mirror of https://github.com/binwiederhier/ntfy.git synced 2024-12-25 01:41:45 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

Rolled back formatting on existing manual docs.

Browse Source
This commit is contained in:
Maciek 2022-11-05 14:28:26 +01:00
parent 95e087390f
commit 2fb7523d06
1 changed files with 17 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
docs/install.md
View File

@ -299,11 +299,11 @@ This image can be pushed to a container registry and shipped independently. All
The setup for Kubernetes is very similar to that for Docker, and requires a fairly minimal deployment or pod definition to function. There The setup for Kubernetes is very similar to that for Docker, and requires a fairly minimal deployment or pod definition to function. There
are a few options to mix and match, including a deployment without a cache file, a stateful set with a persistent cache, and a standalone are a few options to mix and match, including a deployment without a cache file, a stateful set with a persistent cache, and a standalone
unmanaged pod. unmanned pod.
Deployment
=== === "deployment"
```yaml ```yaml
apiVersion: apps/v1 apiVersion: apps/v1
kind: Deployment kind: Deployment
metadata: metadata:
@ -348,12 +348,10 @@ Deployment
ports: ports:
- port: 80 - port: 80
targetPort: 80 targetPort: 80
``` ```
=== "stateful set"
Stateful set ```yaml
===
```yaml
apiVersion: apps/v1 apiVersion: apps/v1
kind: StatefulSet kind: StatefulSet
metadata: metadata:
@ -391,12 +389,10 @@ Stateful set
resources: resources:
requests: requests:
storage: 1Gi storage: 1Gi
``` ```
Pod === "pod"
=== ```yaml
```yaml
apiVersion: v1 apiVersion: v1
kind: Pod kind: Pod
metadata: metadata:
@ -422,15 +418,12 @@ Pod
- name: config - name: config
configMap: configMap:
name: ntfy name: ntfy
``` ```
Configuration is relatively straightforward. As an example, a minimal configuration is provided. Configuration is relatively straightforward. As an example, a minimal configuration is provided.
=== "resource definition"
Resource definition ```yaml
===
```yaml
apiVersion: v1 apiVersion: v1
kind: ConfigMap kind: ConfigMap
metadata: metadata:
@ -439,20 +432,12 @@ Resource definition
server.yml: | server.yml: |
# Template: https://github.com/binwiederhier/ntfy/blob/main/server/server.yml # Template: https://github.com/binwiederhier/ntfy/blob/main/server/server.yml
base-url: https://ntfy.sh base-url: https://ntfy.sh
``` ```
=== "from-file"
from-file ```bash
===
```bash
kubectl create configmap ntfy --from-file=server.yml kubectl create configmap ntfy --from-file=server.yml
``` ```
Kustomize-based deployment with persistent storage and Traefik ingress
===
Kustomize allows for deploying templated configurations in easy way
### Kustomization ### Kustomization
Create new folder, name it nfty and create kustomization.yaml within along all resources listed below. Create new folder, name it nfty and create kustomization.yaml within along all resources listed below.