README.md

What is XWiki

XWiki is a free wiki software platform written in Java with a design emphasis on extensibility. XWiki is an enterprise wiki. It includes WYSIWYG editing, OpenDocument based document import/export, semantic annotations and tagging, and advanced permissions management.

As an application wiki, XWiki allows for the storing of structured data and the execution of server side script within the wiki interface. Scripting languages including Velocity, Groovy, Python, Ruby and PHP can be written directly into wiki pages using wiki macros. User-created data structures can be defined in wiki documents and instances of those structures can be attached to wiki documents, stored in a database, and queried using either Hibernate query language or XWiki's own query language.

XWiki.org's extension wiki is home to XWiki extensions ranging from code snippets which can be pasted into wiki pages to loadable core modules. Many of XWiki Enterprise's features are provided by extensions which are bundled with it.

Table of contents

• Introduction
• How to use this image
  • Pulling existing image
    • Using docker run
    • Using docker-compose
    • Using Docker Swarm
  • Using an external Solr service
    • Preparing Solr container
    • Docker run example
    • Docker Compose example
  • Configuring Tomcat
  • Building
• Upgrading XWiki
• Troubleshooting
• Details for the xwiki image
  • Configuration Options
  • Passing JVM options
  • Configuration Files
  • Miscellaneous
• For Maintainers
  • Update Docker Images
  • Testing Docker Images
  • Clean Up
• License
• Support
• Contribute
• Credits

Introduction

The goal is to provide a production-ready XWiki system running in Docker. This is why:

• The OS is based on Debian and not on some smaller-footprint distribution like Alpine
• Several containers are used with Docker Compose: one for the DB and another for XWiki + Servlet container. This allows the ability to run them on different machines for example.