Portainer Templates logo

Portainer Templates

Xwiki Xwiki

Stack

Wiki

Xwiki s a free wiki software platform written in Java with a design emphasis on extensibility. XWiki is an enterprise wiki.

Configuration

Type
Compose
Platform
linux
Source
Repo

Template by xneo1·Source

Services

web

Configuration

Image
xwiki:lts-mariadb-tomcat
Ports
8080:8080
Volumes
/usr/local/xwiki : /portainer/Files/AppData/Config/xwiki/data
Env vars
DB_USER=xwikiDB_PASSWORD=xwikiDB_HOST=xwiki-mariadb-db

Image details

Pulls: 34.4M
User: library
Created: Feb 08, 2017
Updated: 1 day ago
Status: active

db

Configuration

Image
mariadb:10.5
Volumes
/etc/mysql/conf.d/xwiki.cnf : /portainer/Files/AppData/Config/xwiki/xwiki.cnf/var/lib/mysql : /portainer/Files/AppData/Config/xwiki/mariadb/docker-entrypoint-initdb.d/init.sql : ./init.sql
Env vars
MYSQL_ROOT_PASSWORD=xwikiMYSQL_USER=xwikiMYSQL_PASSWORD=xwikiMYSQL_DATABASE=xwiki

Image details

Pulls: 3.2B
User: stackbrew
Created: Nov 25, 2014
Updated: 2 days ago
Status: active

Standalone Install

Select an install method, to see config/commands for deploying Xwiki

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Xwiki, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo
Original stackfile

The compose file this template deploys, straight from its repo:

networks:
  bridge:
    driver: bridge
services:
  web:
    image: "xwiki:lts-mariadb-tomcat"
    container_name: xwiki-mariadb-tomcat-web
    depends_on:
      - db
    ports:
      - "8080:8080"
    environment:
      - DB_USER=xwiki
      - DB_PASSWORD=xwiki
      - DB_HOST=xwiki-mariadb-db
    volumes:
      - /portainer/Files/AppData/Config/xwiki/data:/usr/local/xwiki
    networks:
      - bridge
  db:
    image: "mariadb:10.5"
    container_name: xwiki-mariadb-db
    volumes:
      - /portainer/Files/AppData/Config/xwiki/xwiki.cnf:/etc/mysql/conf.d/xwiki.cnf
      - /portainer/Files/AppData/Config/xwiki/mariadb:/var/lib/mysql
      - ./init.sql:/docker-entrypoint-initdb.d/init.sql
    environment:
      - MYSQL_ROOT_PASSWORD=xwiki
      - MYSQL_USER=xwiki
      - MYSQL_PASSWORD=xwiki
      - MYSQL_DATABASE=xwiki
    networks:
      - bridge
volumes:
  mariadb-data: {}
  xwiki-data: {}

Or deploy it directly from the source:

git clone https://github.com/xneo1/portainer_templates
cd portainer_templates
docker compose -f Template/Stack/xwiki.yml up -d

More install options in our documentation.

Container Documentation

web Documentation

XWiki: The Advanced Open Source Enterprise Wiki.

db Documentation

MariaDB Server is a high performing open source relational database, forked from MySQL.

Serve Xwiki on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying xwiki.example.com to http://web:8080

Add this to your Caddyfile

xwiki.example.com {
	reverse_proxy http://web:8080
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:8080 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :8080
  • Stop the other service, or pick a different host port. In 8080:8080 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:8080. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, xwiki can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 8080

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

  • Fix the ownership: sudo chown -R 1000:1000 /portainer/Files/AppData/Config/xwiki/data (and the same for the other mapped folders)

Image won't pull

Test the pull directly on the host: docker pull xwiki:lts-mariadb-tomcat

  • "manifest unknown" means the tag no longer exists.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.
  • Relative volume paths like ./init.sql often fail in Portainer because there's no working directory. Swap them for absolute paths.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A Compose stack

Xwiki is a Compose stack, a set of containers (2 of them) defined in one file and brought up together by Portainer, then started and stopped as a single app.

The services

This stack is built from 2 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:

  • web runs xwiki:lts-mariadb-tomcat, starts after db
  • db runs mariadb:10.5

Ports

A port is the door the app answers on. A mapping like 8080:8080 means it's reachable on port 8080 of your server, where the left number is yours to change and the right one belongs to the app. Once it's running, open http://your-server-ip:8080 in a browser. It opens:

  • 8080:8080, likely the web interface

Volumes

A volume is where Xwiki keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /usr/local/xwiki from /portainer/Files/AppData/Config/xwiki/data on the host
  • /etc/mysql/conf.d/xwiki.cnf from /portainer/Files/AppData/Config/xwiki/xwiki.cnf on the host
  • /var/lib/mysql from /portainer/Files/AppData/Config/xwiki/mariadb on the host
  • /docker-entrypoint-initdb.d/init.sql from ./init.sql on the host

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Xwiki takes 7 of them, all with defaults you can leave alone or tweak:

  • DB_USER, defaults to xwiki
  • DB_PASSWORD, defaults to xwiki
  • DB_HOST, defaults to xwiki-mariadb-db
  • MYSQL_ROOT_PASSWORD, defaults to xwiki
  • MYSQL_USER, defaults to xwiki
  • MYSQL_PASSWORD, defaults to xwiki
  • MYSQL_DATABASE, defaults to xwiki

Networking

Portainer puts these services on one shared private network, so they can find each other by name (like web) while only the ports above are open to you.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Xwiki up. Add the template list to Portainer once, then deploying Xwiki is a click rather than a wall of config.