mirror of
https://github.com/funkypenguin/geek-cookbook/
synced 2025-12-13 09:46:23 +00:00
114 lines
4.1 KiB
Markdown
114 lines
4.1 KiB
Markdown
# Realms
|
|
|
|
Realms is a git-based wiki (_like [Gollum](/recipes/gollum/), but with basic authentication and registration_)
|
|
|
|
|
|
|
|
Features include:
|
|
|
|
* Built with Bootstrap 3.
|
|
* Markdown (w/ HTML Support).
|
|
* Syntax highlighting (Ace Editor).
|
|
* Live preview.
|
|
* Collaboration (TogetherJS / Firepad).
|
|
* Drafts saved to local storage.
|
|
* Handlebars for templates and logic.
|
|
|
|
!!! warning "Project likely abandoned"
|
|
|
|
In my limited trial, Realms seems _less_ useful than [Gollum](/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](/ha-docker-swarm/design/) with [persistent shared storage](/ha-docker-swarm/shared-storage-ceph.md)
|
|
2. [Traefik](/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
|
|
|
|
### Setup data locations
|
|
|
|
Since we'll start with a basic Realms install, let's just create a single directory to hold the realms (SQLite) data:
|
|
|
|
```
|
|
mkdir /var/data/realms/
|
|
```
|
|
|
|
Create realms.env, and populate with the following variables (_if you intend to use an [oauth_proxy](/reference/oauth_proxy) to double-secure your installation, which I recommend_)
|
|
```
|
|
OAUTH2_PROXY_CLIENT_ID=
|
|
OAUTH2_PROXY_CLIENT_SECRET=
|
|
OAUTH2_PROXY_COOKIE_SECRET=
|
|
```
|
|
|
|
### Setup Docker Swarm
|
|
|
|
Create a docker swarm config file in docker-compose syntax (v3), something like this:
|
|
|
|
!!! tip
|
|
I share (_with my [patreon patrons](https://www.patreon.com/funkypenguin)_) a private "_premix_" git repository, which includes necessary docker-compose and env files for all published recipes. This means that patrons can launch any recipe with just a ```git pull``` and a ```docker stack deploy``` 👍
|
|
|
|
|
|
```
|
|
version: "3"
|
|
|
|
services:
|
|
realms:
|
|
image: realms/realms-wiki:latest
|
|
env_file: /var/data/config/realms/realms.env
|
|
volumes:
|
|
- /var/data/realms:/home/wiki/data
|
|
networks:
|
|
- internal
|
|
|
|
realms_proxy:
|
|
image: funkypenguin/oauth2_proxy:latest
|
|
env_file : /var/data/config/realms/realms.env
|
|
networks:
|
|
- internal
|
|
- traefik_public
|
|
deploy:
|
|
labels:
|
|
- traefik.frontend.rule=Host:realms.funkypenguin.co.nz
|
|
- traefik.docker.network=traefik_public
|
|
- traefik.port=4180
|
|
volumes:
|
|
- /var/data/config/realms/authenticated-emails.txt:/authenticated-emails.txt
|
|
command: |
|
|
-cookie-secure=false
|
|
-upstream=http://realms:5000
|
|
-redirect-url=https://realms.funkypenguin.co.nz
|
|
-http-address=http://0.0.0.0:4180
|
|
-email-domain=funkypenguin.co.nz
|
|
-provider=github
|
|
-authenticated-emails-file=/authenticated-emails.txt
|
|
|
|
networks:
|
|
traefik_public:
|
|
external: true
|
|
internal:
|
|
driver: overlay
|
|
ipam:
|
|
config:
|
|
- subnet: 172.16.35.0/24
|
|
```
|
|
|
|
!!! 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](/reference/networks/) here.
|
|
|
|
|
|
|
|
## Serving
|
|
|
|
### Launch Realms stack
|
|
|
|
Launch the Wekan stack by running ```docker stack deploy realms -c <path -to-docker-compose.yml>```
|
|
|
|
Log into your new instance at https://**YOUR-FQDN**, authenticate against oauth_proxy, and you're immediately presented with Realms wiki, waiting for a fresh edit ;)
|
|
|
|
## Chef's Notes 📓
|
|
|
|
1. If you wanted to expose the Realms UI directly, you could remove the oauth2_proxy from the design, and move the traefik_public-related labels directly to the realms container. You'd also need to add the traefik_public network to the realms container.
|
|
2. The inclusion of Realms was due to the efforts of @gkoerk in our [Discord server](http://chat.funkypenguin.co.nz). Thanks gkoerk! |