NGINX Unit
v. 1.19.0

MediaWiki§

To run the MediaWiki collaboration and documentation platform using Unit:

  1. Install Unit with a PHP language module.

  2. Install MediaWiki’s core files. Here, we install it at /path/to/app/; use a real path in your configuration.

  3. Set installation path permissions to secure access, for example:

    # chown -R unit_user:unit_group /path/to/app/
    

    Note the values to be used in Unit configuration.

  4. Next, put together the MediaWiki configuration for Unit:

    {
        "listeners": {
            "*:80": {
                "pass": "routes/mediawiki"
            }
    
        },
    
        "routes": {
            "mediawiki": [
                {
                    "match": {
                        "uri": [
                            "!/tests/qunit/*",
                            "/cache/*",
                            "/includes/*",
                            "/languages/*",
                            "/maintenance/*",
                            "/tests/*",
                            "/vendor/*"
                        ]
                    },
    
                    "action": {
                        "return": 403
                    }
                },
                {
                    "match": {
                        "uri": [
                            "/api.php*",
                            "/img_auth.php*",
                            "/index.php*",
                            "/load.php*",
                            "/mw-config/*.php",
                            "/opensearch_desc.php*",
                            "/profileinfo.php*",
                            "/rest.php*",
                            "/tests/qunit/*.php",
                            "/thumb.php*",
                            "/thumb_handler.php*"
                        ]
                    },
    
                    "action": {
                        "pass": "applications/mw/direct"
                    }
                },
                {
                    "match": {
                        "uri": [
                            "!*.php",
                            "!*.json",
                            "!*.htaccess",
                            "/extensions/*",
                            "/images/*",
                            "/resources/assets/*",
                            "/resources/lib/*",
                            "/resources/src/*",
                            "/skins/*"
                        ]
                    },
    
                    "action": {
                        "share": "/path/to/app/"
                    }
                },
                {
                    "action": {
                        "pass": "applications/mw/index"
                    }
                }
            ]
        },
    
        "applications": {
            "mw": {
                "type": "php",
                "user": "unit_user",
                "group": "unit_group",
                "targets": {
                    "direct": {
                        "root": "/path/to/app/"
                    },
    
                    "index": {
                        "root": "/path/to/app/",
                        "script": "index.php"
                    }
                }
            }
        }
    }
    

    Note

    The difference between the pass targets is their usage of the script setting:

    • The direct target runs the .php script from the URI or defaults to index.php if the w omits it.
    • The index target specifies the script that Unit runs for any URIs the target receives.
  5. Upload the updated configuration. Assuming the JSON above was added to config.json:

    # curl -X PUT --data-binary @config.json --unix-socket \
           /path/to/control.unit.sock http://localhost/config/
    

    Note

    The control socket path may vary; run unitd --help or see Startup for details.

  6. Browse to http://localhost/mw-config/index.php and set MediaWiki up using the settings noted earlier:

    MediaWiki on Unit

    Download the newly generated LocalSettings.php file and place it appropriately:

    $ mv LocalSettings.php /path/to/app/
    $ chmod 600 /path/to/app/LocalSettings.php
    # chown unit_user /path/to/app/LocalSettings.php
    
  7. After installation, add a match condition to the first step to disable access to the mw-config/ directory:

    # curl -X POST -d '"/mw-config/*"' --unix-socket \
           /path/to/control.unit.sock                \
           http://localhost/config/routes/mediawiki/0/match/uri/
    
          {
              "success": "Reconfiguration done."
          }
    

    Finally, your wiki is ready!

    MediaWiki on Unit