Ansible Role for Dokuwiki

=========

This role installs and sets up Dokuwiki from splitbrain on your servers. It is based on the work from PeterMosmans in ansible-role-dokuwiki. However, we created this new role because the old one didn't fit our setup, especially with the new "hogfather" version of Dokuwiki.

Requirements

You need to have PHP installed on your system. While it is not necessary for the installation, you also need a web server like nginx or apache2 to run Dokuwiki.

Role Variables

TODO

This section will describe the variables you can set for this role, including those found in defaults/main.yml, vars/main.yml, and any parameters you can pass to the role. Any variables used from other roles or the global scope (like hostvars, group vars, etc.) will also be mentioned here.

Example Playbook

Here's an example of how to use your role, including variables:

Note: When defining multi-dimensional configuration parameters in dokuwiki_additional_configuration, use > as a separator. For example, auth>mysql>server will be written as $conf['auth']['mysql']['server'].

Additionally, all the strings in the dokuwiki_additional_configuration list must be in two quotation marks like this: "'my string'". The double quotes indicate to Ansible that it’s a string, and the single quotes will be treated as part of that string in the local.php. For a further explanation, check here.

---
- hosts: dokuwiki
  roles:
    - chaos-jetzt.dokuwiki
  vars:
    dokuwiki_basedir: /var/www/dokuwiki
    dokuwiki_template: bootstrap3
    dokuwiki_authtype: mysql
    dokuwiki_user: www-data
    dokuwiki_plugins:
      - name: popularity
        state: absent
      - name: move
        state: enabled
      - name: "template:bootstrap3"
        state: enabled
    dokuwiki_additional_acronyms:
      - short: CCC
        long: Chaos Computer Club e.V.
    dokuwiki_additional_entities:
      - from: mü
        to: µ
        state: present
    dokuwiki_additional_schemes:
      - xmpp
      - scheme: gopher
        state: absent
    dokuwiki_additional_interwikis:
      - code: ddg
        url: https://duckduckgo.com/?q={NAME}
    dokuwiki_additional_smileys:
      - code: ":dwiki:"
        image: dwiki.png
        source: "https://www.dokuwiki.org/lib/tpl/dokuwiki/images/logo.png"
    dokuwiki_additional_configuration:
      - name: 'auth>mysql>server'
        value: "'localhost'"
      - name: 'auth>mysql>user'
        value: "'dbuser'"
      - name: 'auth>mysql>password'
        value: "'localhost'"
      - name: 'auth>mysql>database'
        value: "'localhost'"

License

This project is licensed under the BSD 3-Clause license. You can find the full license text in the LICENSE file.

Author Information

This role is inspired by PeterMosmans and his work on ansible-role-dokuwiki. We decided to create our own role because we needed additional features in Dokuwiki, such as a command-line interface for managing plugins.

The initial code comes from e1mo for the chaos.jetzt project.