Dokuwiki: Difference between revisions

From NixOS Wiki
imported>Onny
Better explanation for config examples
imported>Onny
m Update example URL
Line 49: Line 49:
{{file|/etc/nixos/configuration.nix|nix|<nowiki>
{{file|/etc/nixos/configuration.nix|nix|<nowiki>
services.dokuwiki.sites."localhost".extraConfig = ''
services.dokuwiki.sites."localhost".extraConfig = ''
   $conf['baseurl'] = 'https://wiki.project-insanity.org';
   $conf['baseurl'] = 'https://example.org';
'';
'';
};
};

Revision as of 06:53, 5 August 2022

DokuWiki is a web application and simple Wiki software for creating documentation and editable pages in markdown language. Compared to other Wikis, it is more minimal and only depends on PHP and file access without any need for databases.

Installation

To setup DokuWiki locally, this is the most minimal configuration to get started

/etc/nixos/configuration.nix
services.dokuwiki.sites."localhost" = {
  enable = true;
  extraConfig = ''
    $conf['title'] = 'My Wiki';
  '';
};

After that DokuWiki will be available at http://localhost .

Configuration

Besides several options which are exposed by the DokuWiki module in NixOS, you can also use extraConfig to add custom options to your DokuWiki configuration. See the upstream documentation for available options.

Clean URLs

If supported by the webserver you've choosen (using the webserver option), you can enable clean urls or url rewriting by enabling the option userewrite. This means you can access your sites with the simple URL scheme like http://localhost/my_project .

/etc/nixos/configuration.nix
services.dokuwiki.sites."localhost".extraConfig = ''
  $conf['userewrite'] = 1;
'';
};

Clean URLs are reported to work with the webserver Caddy.

Anonymous editing

To disable the user authentication completely and make the Wiki editable by anyone (even anonymous users), you can disable the config useacl with the following option

/etc/nixos/configuration.nix
services.dokuwiki.sites."localhost".aclUse = false;

Tips and tricks

SSL behind reverse proxy

In case you're running DokuWiki behind a reverse proxy which offers ssl/https to the outside, you might have to enforce https protocol by changing the baseurl

/etc/nixos/configuration.nix
services.dokuwiki.sites."localhost".extraConfig = ''
  $conf['baseurl'] = 'https://example.org';
'';
};