smeagol-galore

KO | EN

gitlite — search

#javascript #hacktoberfest #typescript #golang #go #docker #nodejs #windows #cli #awesome-list #vue #pytorch #mcp #openai

(★ 25)

A git-based wiki featuring markdown, a WYSIWYG Editor, PlantUML, and much more

smeagol-galore Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

Smeagol galore
============================
[![Build Status](https://img.shields.io/github/workflow/status/schnatterer/smeagol-galore/Build)](https://github.com/schnatterer/smeagol-galore/actions)

A lightweight version of [cloudogu's](https://cloudogu.com) git-based wiki system [smeagol](https://github.com/cloudogu/smeagol),
the lightning-fast alternative to [gollum](https://github.com/gollum/gollum).

![GIF showcasing smeagol-galore](https://github.com/schnatterer/smeagol-galore/wiki/smeagol-galore.gif)

Runs without a full Cloudogu ecosystem, but still features
* Markdown,
* WYSIWYG Editors,
* [PlantUML](http://plantuml.com/),
* [SCM-Manager](https://www.scm-manager.org/) as Git backend,
* Single Sign On using [CAS](https://github.com/apereo/cas),
* built-in let's encrypt support,
* everything deployed on an [Apache Tomcat](https://github.com/apache/tomcat) and
* neatly packed into a docker image.

[![Diagram showing components and their relationships](http://www.plantuml.com/plantuml/svg/Z9BVIYCn58VlvocEkXSkE9Fw1oaYijsfYj1kfRNiXKWv9d4QEac69ACBuhjl9ZETjagbkJhjxvkJBoVvPHqQLyeyscFyHIWEwM0qxOzkfzFn0ERE5VQ248DlIIRSl7mkBJTKAyULIwYMXEQwP3ehIP6Zglh4otzYMnZXk2KIhUCcYlQ4edd9U6dozKr81LjYgKoAuF4z9ZbcEg_Hrlak7VtPpTUL1J9pkj8LFerVFD7wlfuadQIpuT7q9xw3rEgBPvip_bhrirwMBhZP3eODyOrRBJdnYgyxmuBDA1hsQG2J-_7Tm_LajnaOVEOvLmm93QTlPz5Eu3ZfaER7Xj5g6-AqfEXg3R_iGgW23Kf0O_GRl4S0gSwrWODEMD77EgGquu7vhGtZfY6Fpy-xNRP98dNQr2ZIHMPqgLY3dvpYAMDRcW3SQEM-ADJjfhPwa45Yln-kQX_G0WibmENbZxgykeA3bx22GVt1GpXv-C25ikBhQfCFgtg-iqawFBHK7e4luY4gpBZvkKGtmE5rxtOqE6oUkV-WBZx3DxtPNN-MziRzGuhs2DBUP1tvg8vQszvNbpiT3eBlygOhusNjdTyhl9e9nF4LD7l31LmpuU2lM8Yra4eVt787Orve6otXxoAVUKcVzKetvye9Yev77jyQhPgsnfuPSyMy1XEO6PGsQhFuSIuOu-gfRXT5KVrueJqaF9vr_vrroV7vq_zcwo39SH26ml2LdgGdmBl19Bx_aKQ9WPwakojcD_yovIyInOOuBLPIO0rm5QH5a6mDMC4Iu1P6hmDMI5PS1beXTMMbZIYs0eg6MG5EvBe2a20xLm0KsPO0u5W4M0Ba4c1oKg-3dDrfPfV1LX9f2if5K4hEPagx3B9R8e45G24MWVv_m7u5SWNedj0pAdfRav-1RBVMTaKapaWG-H7bdm3RcGEaHMJW_NYsopkmUckzFPan3CbypD8ho6ssjvRjGOncwNxSkzZ_0MnlxMwFGjXspAfR1tlxLhPH31arGf-WRhNzCiHUXsJhe6pVHEK0h5-20-HStmQ0fs0YZju6J92yjDaj2pf8Bi1vZ1ln0kXZoAQ8B01TWFFwxXaOm4vWLcwFl_V-EvaCpqfSW-8B0Aa4e8dLLZ1oeiUnpGHWJW5Kn1696u1pCLT0vCae4qJk3p2-4fbZ5BriEi7vrGJIb-yJXdLv0H3Q2Juq0Q2w221ga4zrCCXdy7Wt_ucdLpoZ_W80)](http://www.plantuml.com/plantuml/uml/Z9BVIYCn58VlvocEkXSkE9Fw1oaYijsfYj1kfRNiXKWv9d4QEac69ACBuhjl9ZETjagbkJhjxvkJBoVvPHqQLyeyscFyHIWEwM0qxOzkfzFn0ERE5VQ248DlIIRSl7mkBJTKAyULIwYMXEQwP3ehIP6Zglh4otzYMnZXk2KIhUCcYlQ4edd9U6dozKr81LjYgKoAuF4z9ZbcEg_Hrlak7VtPpTUL1J9pkj8LFerVFD7wlfuadQIpuT7q9xw3rEgBPvip_bhrirwMBhZP3eODyOrRBJdnYgyxmuBDA1hsQG2J-_7Tm_LajnaOVEOvLmm93QTlPz5Eu3ZfaER7Xj5g6-AqfEXg3R_iGgW23Kf0O_GRl4S0gSwrWODEMD77EgGquu7vhGtZfY6Fpy-xNRP98dNQr2ZIHMPqgLY3dvpYAMDRcW3SQEM-ADJjfhPwa45Yln-kQX_G0WibmENbZxgykeA3bx22GVt1GpXv-C25ikBhQfCFgtg-iqawFBHK7e4luY4gpBZvkKGtmE5rxtOqE6oUkV-WBZx3DxtPNN-MziRzGuhs2DBUP1tvg8vQszvNbpiT3eBlygOhusNjdTyhl9e9nF4LD7l31LmpuU2lM8Yra4eVt787Orve6otXxoAVUKcVzKetvye9Yev77jyQhPgsnfuPSyMy1XEO6PGsQhFuSIuOu-gfRXT5KVrueJqaF9vr_vrroV7vq_zcwo39SH26ml2LdgGdmBl19Bx_aKQ9WPwakojcD_yovIyInOOuBLPIO0rm5QH5a6mDMC4Iu1P6hmDMI5PS1beXTMMbZIYs0eg6MG5EvBe2a20xLm0KsPO0u5W4M0Ba4c1oKg-3dDrfPfV1LX9f2if5K4hEPagx3B9R8e45G24MWVv_m7u5SWNedj0pAdfRav-1RBVMTaKapaWG-H7bdm3RcGEaHMJW_NYsopkmUckzFPan3CbypD8ho6ssjvRjGOncwNxSkzZ_0MnlxMwFGjXspAfR1tlxLhPH31arGf-WRhNzCiHUXsJhe6pVHEK0h5-20-HStmQ0fs0YZju6J92yjDaj2pf8Bi1vZ1ln0kXZoAQ8B01TWFFwxXaOm4vWLcwFl_V-EvaCpqfSW-8B0Aa4e8dLLZ1oeiUnpGHWJW5Kn1696u1pCLT0vCae4qJk3p2-4fbZ5BriEi7vrGJIb-yJXdLv0H3Q2Juq0Q2w221ga4zrCCXdy7Wt_ucdLpoZ_W80)

# Table of contents

- [Usage](#usage)
  - [Getting started](#getting-started)
  - [Persist state](#persist-state)
    - [SCM-Manager (Repos/Wikis)](#scm-manager-reposwikis)
    - [Smeagol's Repo Cache](#smeagols-repo-cache)
  - [Custom Certificate](#custom-certificate)
    - [Mount your own certs](#mount-your-own-certs)
    - [Built-in Let's Encrypt support](#built-in-lets-encrypt-support)
  - [Create more wikis](#create-more-wikis)
  - [Credentials](#credentials)
  - [Configuration](#configuration)
  - [More substantial example](#more-substantial-example)
  - [Kubernetes](#kubernetes)
- [Import from Gollum](#import-from-gollum)
- [Troubleshooting](#troubleshooting)
  - [Extend Log output](#extend-log-output)
    - [SCM-Manager](#scm-manager)
    - [Smeagol](#smeagol)
    - [CAS](#cas)
  - [Debugging](#debugging)
- [Links](#links)
  - [SCM](#scm)
  - [CAS](#cas-1)
- [Building](#building)
- [TODOs](#todos)

# Usage

## Getting started

```bash
docker run -p 8443:8443 ghcr.io/schnatterer/smeagol-galore
```

Note that

* SCM-Manager installs plugins via the internet on first startup, so it might take some time.  
  You can choose which plugins are installed by editing `plugin-config.yml`, e.g. by mounting your own version into the
  container: `-v your-plugin-config.yml:/etc/scm/plugin-config.yml`.  
  See [SCM-Jenkins](https://oss.cloudogu.com/jenkins/job/scm-manager/) for available plugins.
* A self-signed certificate will be created on startup.
  These will result in warnings in your browser.  
  See bellow for custom certificates.
* Smeagol galore will be available on [https://localhost:8443](https://localhost:8443) (and via `/smeagol`).  
  SCM-Manager will be available on [https://localhost:8443/scm](https://localhost:8443/scm).
* Default user/pw: `admin/admin` (see bellow for custom credentials)
* PlantUML Rendering uses plantuml.com by default. Note that this might be blocked by browser plugins such as uBlock 🤔
  You can use your own instance with a custom image, though. See [Building](#building).
* You might find older versions of smeagol galore on [DockerHub](https://hub.docker.com/repository/docker/schnatterer/smeagol-galore/tags), if they haven't been deleted by their
  [image retention policy](https://www.docker.com/blog/scaling-dockers-business-to-serve-millions-more-developers-storage/).

## Persist state

### SCM-Manager (Repos/Wikis)
Mount SCMM Volume to persist your repos/wikis: `-v $(pwd)/dev/scm:/home/tomcat/.scm `.
This will also persist SCMM plugins, so the second start will be much faster.

Make sure the smeagol galore container use (UID 1001) is allowed to write to this folder by either `chown`ing or
`chmod`. For development the following will do

```bash
mkdir -p dev/scm
chmod 777 dev/scm
docker run --rm --name smeagol-galore -p 8443:8443 -v $(pwd)/dev/scm:/home/tomcat/.scm schnatterer/s
meagol-galore
```

### Smeagol's Repo Cache

Although not strictly necessary, it is recommended to persist Smeagol's repo Cache at `/home/tomcat/.smeagol`.
Without it smeagol will have to clone every repo from SCM-Manager again. Especially for large repos (100MB+) this will
slow down the first request to each repo after the container has been restarted.

## Custom Certificate

The self-signed certificate that is generated on startup by default is only a valid option for trying out and development.
In production, you should provide a proper certificate, which can be done by either:
* mounting your certs
* enabling built'in Lets's Encrypt support

Note that smeagol, cas and SCMM communicate with each other via HTTPS.
If you're certificate is not trusted by the JVM you should add it to the trust store and then mount it like so:
`-v $(pwd)/dev/cacerts:/opt/java/openjdk/lib/security/cacerts`.

See [entrypoint.sh](entrypoint.sh) for an example.

### Mount your own certs

Just mount your certs into the container like so: `-v $(pwd)/certs:/config/certs/${FQDN}`.

Smeagol galore's server loads the certs from the following files inside the `/config/certs/${FQDN}` folder:

* `cert.pem`
* `fullchain.pem`
* `privkey.pem`

### Built-in Let's Encrypt support

If you don't have any reverse proxy infrastructure that handles TLS temrination, the most convenient way of handling
TLS is to use Smeagol Galore's built-in Let's Encrypt support.

Before getting started, make sure

* to set the DNS record to match the external IP address of your host and
* that ports 80 and 443 are routed to the container ports. By default:
  * external port 443 to container port 8443 (`-p443:8443`) and
  * external port 80 to container port 8080 (`-p80:8080`)

Then just enable let's encrypt via the environment:
* `-e ENABLE_LETSENCRYPT=true` - enable let's encrypt support
* `-eFQDN=example.com` - determines the domain to request the cert for
* `-eSTAGING=true` - If set to `true` creates certs against Lets Encrypt's staging, which has no rate limit but is not
  accepted by your browser.

For a full example see [examples](example/docker-compose-letsencrypt.yaml).

At startup Smeagol Galore still generates self-signed certs, if none are there, as it needs cert files to get the
server started.  
Once the server is up, a background process queries the certs from Let's Encrypt, if their validity is less than 30 days.
The process checks once a day if the certs are valid less than 30 days and renews them, if necessary.

## Create more wikis

Note that the git arg `-c http.sslVerify=false ` is only necessary for testing with a self-signed cert .
If you use an official TLS cert this won't be necessary.

* Go to https://localhost:8443/scm
* Log in as administrator
* Create a git repo
* Clone into git wiki, e.g. for localhost: `git -c http.sslVerify=false clone https://admin@localhost:8443/scm/git/test`
* Add empty `.smeagol.yml` file: `touch .smeagol.yml && git add .smeagol.yml && git commit -m 'Create smeagol wiki'`
* Push, e.g. for localhost: `git -c http.sslVerify=false push`
* Go to https://localhost:8443/smeagol

All in one:

```bash
git -c http.sslVerify=false clone https://admin@localhost:8443/scm/git/test
cd test
touch .smeagol.yml
git add .smeagol.yml
git commit -m 'Creates smeagol wiki'
git -c http.sslVerify=false push --set-upstream origin master
```

## Credentials

Default user/pw: `admin/admin`

Credentials defined in `/etc/cas/users.txt` and `/etc/cas/attributes.xml`. Custom ones can be mounted into the container like so for example: `-v $(pwd)/dev/users.txt:/etc/cas/users.txt`.

See [users.txt](cas/etc/cas/users.txt) and [attributes.xml](cas/etc/cas/attributes.xml).

CAS has "pluggable authentication support (LDAP, database, X.509, 2-factor)" see [CAS 4 docs](https://apereo.github.io/cas/4.0.x/index.html).
Get started at [deployerConfigContext.xml](cas/src/main/webapp/WEB-INF/deployerConfigContext.xml)

## Configuration

Via Environment Variables:

* Set the name of SCM-Manager's `ADMIN_GROUP`
* Set your Fully Qualified Domain name (including Port) - `FQDN`  
  Note that the smeagol galore container must be able to resolve this address as well,
  because the webb apps communicate with each other (smeagol -> cas, smeagol -> scm, scm -> cas).
  You can try this out locally, by adding the following entry to your `/etc/hosts`: `127.0.0.1 smeagol` and then passing
  the following parameters to the container: `-v /etc/hosts:/etc/hosts -e FQDN=smeagol:8443`. You can then reach smeagol
  at `https://smeagol:8443`.
* `HTTP_PORT` and `HTTPS_PORT`. Ports to listen on. Note that FQDN contains the HTTPS port (if != 443).  
  For now, the `tomcat` user is allowed to listen on ports 80,443 and of course > 1024.  
  Other ports are only possible when run as root (`docker run -u0`), which you shouldn't.  
  **Note*: This seems to only work when the image is built with newer versions of docker (tested with 19.03.08) but not
  with the one use by DockerHub. As the image is built from source there, these image will result in
  `Socket bind failed: [13] [Permission denied].`  
  To showcase the feature I pushed an image with tag `0.2.0-SNAPSHOT-2e1ec28f`. If this works for you, you might want to
  build the most recent version from source yourself.
* `-e DEBUG=true` exposes port 8000 as Tomcat debug port
* Additional arguments can be passed to tomcat, or the webapps (CAS, smeagol, SCM-Manager)
  * As Docker `CMD`, e.g.  
    `docker run ghcr.io/schnatterer/smeagol-galore '-Xmx1g -Dabc=def'`
  * Via env var `EXTRA_JVM_ARGUMENTS`, e.g.   
    `docker run -e EXTRA_JVM_ARGUMENTS='-Xmx1g -Dabc=def' ghcr.io/schnatterer/smeagol-galore`
  * Examples:
    * `-XmX2g` to virtual machine / tomcat process
    * See CAS's [`cas.properties`](cas/etc/cas/cas.properties) and
    * Smeagol's [application.yml](https://github.com/cloudogu/smeagol/blob/develop/src/main/resources/application.yml)
    * for options. These can either be set
      * as System Property, e.g. `docker run -e EXTRA_JVM_ARGUMENTS='-Dproperty.name=value'...`) or
      * Environment Variable, e.g. (`docker run -e -e PROPERTY_NAME=value ...`).
    * This is used in the [example](example/docker-compose.yaml) to increase session timeout / token expiration.
* Via `SMEAGOL_GALORE_LOGIN_WELCOME` you can customize the welcome message on the login screen. Default is `Smeagol Galore`

The container is run as with UID and GID = 1000.
If you want to run it as a different user you pass `-u` param when running the container.
However, you should make sure that the user exists (e.g. mount `/etc/passwd`).

Another option is to build your own image and set `--build-arg USER_ID` and `GROUP_ID` to your liking.

## More substantial example

See [example](example/README.md) for a more substantial example using docker-compose.

## Kubernetes

There was an example on how to deploy to kubernetes see [this revision](https://github.com/schnatterer/smeagol-galore/tree/d51bfbfca8dda63a2675cc3f14c66b0106403bf3/k8s).
It was no longer maintained, so if needed it could be used as a starting point.
Even more convenient would be a helm chart.
PRs welcome.

# Import from Gollum

- Just create a new repo in SCM-Manager and push Gollum's wiki there. Then do the following, add and commit each step. Finally push.
- `touch .smeagol.yml`
- `mkdir docs`
- Move all files to /docs
    ```bash
    mkdir docs
    git mv -k * docs #-k ignores errors such as moving docs to docs
    git mv -k .* docs #hidden files
    ```
- There are [a couple of limitations regarding file names](https://github.com/cloudogu/smeagol/blob/50330fa6ded55d8cf62ced9d9b45e5ca8bbbe7a4/src/main/java/com/cloudogu/smeagol/wiki/domain/Path.java#L74).    
  Find an `rename` or `git mv` them.
  - For example, find files that end with a blank before the file extension: `ll | grep ' \.md'.`
  - Find files that do not match the [character whitelist of smeagol](https://github.com/cloudogu/smeagol/blob/50330fa6ded55d8cf62ced9d9b45e5ca8bbbe7a4/src/main/java/com/cloudogu/smeagol/wiki/domain/Path.java#L20):
    `find ./  -printf "%f\n" | grep -Pv '^[\w\.\-_/ ]+$'`.  
    You could just replace them: `rename 's/[(),#+~&]/_/g' *` (add more characters to replace in the first part of the regex, if needed).      
    But keep in mind that changing the name of a file might break links to those.
  - If you used uploads in Gollum, you might have to change the links.  
    If you used fully qualified (absolute) links (like `https://mygoll.um/uploads`) or relative links starting in `/`
    (like `/uploads`) you should change all to `uploads`.  
    You can find them like so: ` grep -r https://mygoll.um/uploads/` and `grep -r /uploads/`.
- For some reason the version overview in smeagol shows only changes occurred after moving the files.  
  However, the history can still be found in git via scm-manager.
- Note that it is also possible to run Gollum and Smeagol in parallel:
  - Just add a git origin to Gollum's Git repo pointing to the Git Repo in SCM-Manager.
  - You can then sync via push and pull in Gollum's git repo.

# Troubleshooting

## Extend Log output

Details for SCM-Manager, CAS, and Smeagol bellow. Process is the same for each component:

* Copy log files from source
* Increase levels for appenders
* Mount into container

See also [more substantial example ](example/README.md) using docker-compose.

### SCM-Manager

* [`logback.xml`](scm/logback.xml)
* Run Container with `-v $(pwd)scm-logback.xml:/tomcat/webapps/scm/WEB-INF/classes/logback.xml`
* [See also](https://bitbucket.org/sdorra/scm-manager/src/default/scm-webapp/src/main/resources/logback.default.xml)

### Smeagol

* [`logback.xml`](smeagol/logback.xml)
* Run Container with `-v $(pwd)/smeagol-logback.xml:/tomcat/webapps/smeagol/WEB-INF/classes/logback.xml`
* [See also](https://github.com/cloudogu/smeagol/blob/develop/src/main/resources/logback.xml)

### CAS

* [`log4j.xml`](cas/src/main/resources/log4j.xml)
* Run Container with `-v $(pwd)/cas-log4j.xml:/tomcat/webapps/cas/WEB-INF/classes/log4j.xml`

## Debugging

* Start container with `-p8000:8000 -e DEBUG=true`
* Load sources for [SCM-Manager](https://github.com/sdorra/scm-manager) and related plugins, CAS from this repo and/or [smeagol](https://github.com/cloudogu/smeagol) into your IDE.
* Start debugger, e.g. in [IntelliJ](https://stackoverflow.com/a/6734028/1845976) on port 8000

# Security
## Log4Shell / CVE-2021-44228

[CVE-2021-44228](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-44228).

Smeagol-galore does not use Log4j version 2, so it is not affected. 
* CAS includes log4j version 1, Smeagol includes log4j-api and log4j-to-slf4j and SCM-Manager uses logback [which all are not vulnerable in terms of CVE-2021-44228](https://wwe.e.slf4j.org/log4shell.html).
* However, when an attacker has write access to the cas log4j config, the `JMSAppender` class could abused for an attack similar to log4shell.  
  This class was removed preventively in 1.6.1-1-r1.
* A similar attack vector exists in Logback used in SCM-Manager, which [was patched in version 2.27.3 of SCM-Manager](https://scm-manager.org/blog/posts/2021-12-13-log4shell/), contained in galore 1.6.1-1-r1.  
  The above link states that SCM-Manager plugins _might_ be affected, which you should check via script plugin.

So in Smeagol galore >= 1.6.1-1-r1, with default SCM-Manager plugins there is no vulnerability similar to log4shell, according to current knowledge, 
as of 22 December, 2021.

# Links

[Unidata/tomcat-docker: Security-hardened Tomcat container](https://github.com/Unidata/tomcat-docker)

## SCM

* [scm-cas-plugin](https://bitbucket.org/scm-manager/scm-cas-plugin/src/master/)
* [cloudogu/scm docker image](https://github.com/cloudogu/scm/blob/master/Dockerfile)

## CAS

* [Cas 4 Overlay example](https://github.com/UniconLabs/simple-cas4-overlay-template/blob/master/pom.xml)
* [CAS 4 code](https://github.com/apereo/cas/tree/v4.0.7)
* [CAS 4 docs](https://apereo.github.io/cas/4.0.x/index.html)

# Building

`docker build -t smeagol-galore .`

* Optionally, you can choose your own PlantUML server like so: `--build-arg PLANTUMLSERVER="https://[...]/png/"`

# TODOs

- Convert to a more 12-factor-like app using multiple containers and docker-compose
- Create helm chart
- Maybe persist CAS Tickets, so we can stay logged in even in case of a restart? HSQL stored to file=
  Docs seem a bit unconsistent for cas [4.0.x](https://apereo.github.io/cas/4.0.x/installation/JPA-Ticket-Registry.html), though. Better with 4.1.x.

smeagol-galore

smeagol-galore Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

smeagol-galore

smeagol-galore Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README