Sign inSign up

cgspeck/gollum

By cgspeck

•Updated over 5 years ago

Gollum wiki with frontend in a Docker container

Image
1

7.8K

cgspeck/gollum repository overview

⁠Docker-Gollum

⁠Usage

With Docker run:

docker run \
    --rm \
    --name=golum \
    -e PUID=1000 \
    -e PGID=1000 \
    -p 4567:4567 \
    -v </path/to/your/share>:/wiki \
    cgspeck/gollum:latest

You can also add the following commands to the end of the run command to change the way it behaves:

console

Bring up a bash terminal within the container.

root

Bring up a root terminal within the container.

⁠Ports

PortFunction
4567Gollum server

⁠Volumes

VolumeFunction
/wikiGit repository for this wiki

⁠Parameters

ParameterFunction
-e PUID=1000User ID
-e PGID=1000Group ID
-e GOLLUM_OPTIONS="--h1-title --allow-uploads page"Options to pass to Gollum, detailed here⁠
-e GOLLUM_AUTHOR_USERNAME="Gollum User"Username to put on the git commits
-e GOLLUM_AUTHOR_EMAIL="[email protected]⁠"Email to put on the git commits
⁠User / Group Identifiers

You can specify user ID and group IDs for use in the container to avoid permission issues between the container and the host.

Ensure any volume directories on the host are owned by the same user you specify.

You can use id to find your user id and group id:

$ id foo
uid=1000(foo) gid=1000(foo)

⁠Credits/thank you

wrapper.rb from gollum-portable⁠ by PJ Eby⁠

Tag summary

Content type

Image

Digest

Size

442.6 MB

Last updated

over 5 years ago

docker pull cgspeck/gollum