https://github.com/gesinn-it/ansible-role-mediawiki-extension

Ansible role for installing MediaWiki extensions via Composer or tar.gz archives.
https://github.com/gesinn-it/ansible-role-mediawiki-extension

ansible ansible-role mediawiki mediawiki-extension

Last synced: 26 days ago
JSON representation

Ansible role for installing MediaWiki extensions via Composer or tar.gz archives.

• Host: GitHub
• URL: https://github.com/gesinn-it/ansible-role-mediawiki-extension
• Owner: gesinn-it
• License: apache-2.0
• Created: 2021-08-10T06:55:03.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-09-27T13:04:51.000Z (over 3 years ago)
• Last Synced: 2024-11-08T12:44:31.473Z (3 months ago)
• Topics: ansible, ansible-role, mediawiki, mediawiki-extension
• Homepage:
• Size: 8.79 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# mediawiki_extension

Ansible role for installing MediaWiki extensions via Composer or tar.gz archives.

Compatible with https://github.com/robertdebock/ansible-role-mediawiki

## Usage

| Variable | Type | Description | Default | Example

|---|---|---|---|---

| `mediawiki_extension_name` | String | Name of the extension used during registration in LocalSettings | | `Mermaid`

| `mediawiki_extension_registration_type` | String | One of "wfLoadExtension", "require_once" | wfLoadExtension | `wfLoadExtension` 

| `mediawiki_extension_install_type` | String | One of "composer" or "tar" | composer | `composer`

| `mediawiki_extension_strip_components` | Integer | Strip NUMBER leading components from file names on extraction | 1 |

| `mediawiki_extension_disabled` | Boolean | Decide, if the extension shall be installed but disabled (commented out) | false | `false`

| `mediawiki_extension_source` | String | | composer: name on packagist.org |  `mediawiki/mermaid`

| `mediawiki_extension_source_version` | String | The extension version as used by the source | | `3.0.1`

| `mediawiki_extension_config` | String | Any extension specific configuration that should be added to LocalSettings after extension registration |

## Examples

**Composer**

```yaml

- name: install Mermaid extension

  include_role:

    name: gesinnit.mediawiki_extension

  vars:

    mediawiki_extension_name: "Mermaid"

    mediawiki_extension_install_type: "composer"

    mediawiki_extension_disabled: false

    mediawiki_extension_source: "mediawiki/mermaid"

    mediawiki_extension_source_version: "2.1.0"

```

**TAR**

```yaml

- name: install AdminLinks extension

  include_role:

    name: gesinnit.mediawiki_extension

  vars:

    mediawiki_extension_name: "AdminLinks"

    mediawiki_extension_install_type: "tar"

    mediawiki_extension_disabled: false

    mediawiki_extension_source: "http://gitlab.local.gesinn.it/mediawiki-extension/AdminLinks/repository/archive.tar.gz?ref=0.4"

```

## Versioning

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/gesinn-it/QRLite/tags). 

## Author(s)

* Alexander Gesinn (gesinn.it GmbH & Co. KG)