scratch docs

This commit is contained in:
cupcakearmy 2022-03-06 12:27:08 +01:00
parent 45f6f3af32
commit 44f43dbc2c
No known key found for this signature in database
GPG Key ID: 3235314B4D31232F

View File

@ -5,6 +5,7 @@ This is a tiny guide to install cryptgeon on (probably) any unix system (and may
1. Install Docker & Docker Compose. 1. Install Docker & Docker Compose.
2. Install Traefik. 2. Install Traefik.
3. Run the cryptgeon. 3. Run the cryptgeon.
4. [Optional] install watchtower to keep up to date.
## Install Docker & DOcker Compose ## Install Docker & DOcker Compose
@ -13,6 +14,8 @@ This is a tiny guide to install cryptgeon on (probably) any unix system (and may
## Install Traefik 2.0 ## Install Traefik 2.0
[Traefik](https://doc.traefik.io/traefik/) is a router & proxy that makes deployment of containers incredibly easy. It will manage all the https certificates, routing, etc.
```sh ```sh
/foo/bar/traefik/ /foo/bar/traefik/
├── docker-compose.yaml ├── docker-compose.yaml
@ -89,7 +92,7 @@ docker-compose up -d
## Cryptgeon ## Cryptgeon
Create another docker-compose.yaml file in another folder. Create another docker-compose.yaml file in another folder. We will assume that the domain is `cryptgeon.example.org`.
```sh ```sh
/foo/bar/cryptgeon/ /foo/bar/cryptgeon/
@ -131,3 +134,28 @@ services:
```sh ```sh
docker-compose up -d docker-compose up -d
``` ```
## Watchtower
> A container-based solution for automating Docker container base image updates.
[Watchtower](https://containrrr.dev/watchtower/) will keep our containers up to date. The interval is set to once a day and also configured to delete old images to prevent cluttering.
```sh
/foo/bar/watchtower/
└── docker-compose.yaml
```
```yaml
# docker-compose.yaml
version: '3.8'
services:
watchtower:
image: containrrr/watchtower
restart: unless-stopped
volumes:
- /var/run/docker.sock:/var/run/docker.sock
command: --cleanup --interval 86400
```