public/geek-cookbook
1
0 Fork 0
mirror of https://github.com/funkypenguin/geek-cookbook/ synced 2026-11-04 06:38:18 +00:00
Code Issues Releases Wiki Activity

Update for leanpub preview

Browse Source
This commit is contained in:
AutoPenguin committed 2020-06-03 02:43:21 +00:00
1 parent 3862d7c2f6
commit bbe30c872c
89 files changed
+636 -648
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

manuscript/recipes/realms.md
+6 -6
View File
@@ -1,6 +1,6 @@
# Realms
Realms is a git-based wiki (_like [Gollum]https://geek-cookbook.funkypenguin.co.nz/recipes/gollum/), but with basic authentication and registration_)
Realms is a git-based wiki (_like [Gollum](https://geek-cookbook.funkypenguin.co.nz/recipes/gollum/), but with basic authentication and registration_)
![Realms Screenshot](../images/realms.png)
@@ -16,14 +16,14 @@ Features include:
!!! warning "Project likely abandoned"
In my limited trial, Realms seems _less_ useful than [Gollum]https://geek-cookbook.funkypenguin.co.nz/recipes/gollum/) for my particular use-case (_i.e., you're limited to markdown syntax only_), but other users may enjoy the basic user authentication and registration features, which Gollum lacks.
In my limited trial, Realms seems _less_ useful than [Gollum](https://geek-cookbook.funkypenguin.co.nz/recipes/gollum/) for my particular use-case (_i.e., you're limited to markdown syntax only_), but other users may enjoy the basic user authentication and registration features, which Gollum lacks.
Also of note is that the docker image is 1.17GB in size, and the handful of commits to the [source GitHub repo](https://github.com/scragg0x/realms-wiki/commits/master) in the past year has listed TravisCI build failures. This has many of the hallmarks of an abandoned project, to my mind.
## Ingredients
1. [Docker swarm cluster]https://geek-cookbook.funkypenguin.co.nz/ha-docker-swarm/design/) with [persistent shared storage]https://geek-cookbook.funkypenguin.co.nz/ha-docker-swarm/shared-storage-ceph.md)
2. [Traefik]https://geek-cookbook.funkypenguin.co.nz/ha-docker-swarm/traefik_public) configured per design
1. [Docker swarm cluster](https://geek-cookbook.funkypenguin.co.nz/ha-docker-swarm/design/) with [persistent shared storage](https://geek-cookbook.funkypenguin.co.nz/ha-docker-swarm/shared-storage-ceph.md)
2. [Traefik](https://geek-cookbook.funkypenguin.co.nz/ha-docker-swarm/traefik_public) configured per design
3. DNS entry for the hostname you intend to use, pointed to your [keepalived](ha-docker-swarm/keepalived/) IP
## Preparation
@@ -36,7 +36,7 @@ Since we'll start with a basic Realms install, let's just create a single direct
mkdir /var/data/realms/
```
Create realms.env, and populate with the following variables (_if you intend to use an [oauth_proxy]https://geek-cookbook.funkypenguin.co.nz/reference/oauth_proxy) to double-secure your installation, which I recommend_)
Create realms.env, and populate with the following variables (_if you intend to use an [oauth_proxy](https://geek-cookbook.funkypenguin.co.nz/reference/oauth_proxy) to double-secure your installation, which I recommend_)
```
OAUTH2_PROXY_CLIENT_ID=
OAUTH2_PROXY_CLIENT_SECRET=
@@ -96,7 +96,7 @@ networks:
```
!!! note
Setup unique static subnets for every stack you deploy. This avoids IP/gateway conflicts which can otherwise occur when you're creating/removing stacks a lot. See [my list]https://geek-cookbook.funkypenguin.co.nz/reference/networks/) here.
Setup unique static subnets for every stack you deploy. This avoids IP/gateway conflicts which can otherwise occur when you're creating/removing stacks a lot. See [my list](https://geek-cookbook.funkypenguin.co.nz/reference/networks/) here.