Skip to content

mbillen/jspwiki

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

JSPWiki Docker Image

License: MIT GitHub Release GitHub Actions Workflow Status GitHub issues

Overview

This repository provides a Docker image for Apache JSPWiki on Tomcat application server.

About JSPWiki

JSPWiki is a simple (well, not anymore) WikiWiki clone, written in Java and JSP. A WikiWiki is a website which allows anyone to participate in its development. JSPWiki supports all the traditional wiki features, as well as very detailed access control and security integration using JAAS.

Usage/Examples

Run a JSPWiki container on host port 8080 with a default configuration.

docker run --name jspwiki \
  -p 8080:8080/tcp \
  ghcr.io/mbillen/jspwiki

Optionally use a volume to store your Wiki pages and configurations between container restarts.

docker run --name jspwiki \
  -p 8080:8080/tcp \
  -v /path/on/host:/var/jspwiki \
  ghcr.io/mbillen/jspwiki

The directory structure within the mounted directory is as follows:

jspwiki
├── pages
├── etc 
├── logs
└── work

Supported Architectures

  • linux/amd64
  • linux/arm/v7
  • linux/arm64

Changes to the official Docker image

  • changed directory structure (see above)
  • modified policy to prevent page modifications without being authorized (except sandbox)
  • added InterWiki links for Lotus Notes and AdBlock Plus
  • completely disabled cache for BasicAttachmentProvider
  • using German default pages (can be replaced by any other language)

Customizing

All parameters of the JSPWiki configuration file can be overwritten using environment variables within the container's environment. Every "_" in the variables is converted to ".". To change the name attribute of your Wiki simply set the variable jspwiki_applicationName.

docker run --name jspwiki \
  -p 8080:8080/tcp \
  -e jspwiki_applicationName='MyWiki' \
  ghcr.io/mbillen/jspwiki

Development

To build the Docker image locally, clone the repository and use the following command:

docker build -t mbillen/jspwiki .

Contributing

Contributions are welcome! Please open an issue or submit a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.