NixOS Wiki

Dokuwiki: Difference between revisions

← Older edit
VisualWikitext
imported>Onny
Add information about templates
Klinger (talk | contribs)
trusted
904 edits
m explained the „no need for databases"
 
(10 intermediate revisions by 4 users not shown)
Line 1: Line 1:
[https://www.dokuwiki.org 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.
[https://www.dokuwiki.org 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. It stores all information in plain text files to be available even without the DokuWiki software (e.g. to read directly from backup).


== Installation ==
== Installation ==
Line 8: Line 8:
services.dokuwiki.sites."localhost" = {
services.dokuwiki.sites."localhost" = {
   enable = true;
   enable = true;
   extraConfig = ''
   settings.title = "My Wiki";
    $conf['title'] = 'My Wiki';
  '';
};
};
</nowiki>}}
</nowiki>}}
Line 18: Line 16:
== Configuration ==
== Configuration ==


Besides several options which are exposed by the DokuWiki module in NixOS, you can also use <code>extraConfig</code> to add custom options to your DokuWiki configuration. See the [https://www.dokuwiki.org/config upstream documentation] for available options.
Besides several options which are exposed by the DokuWiki module in NixOS, you can also use <code>settings</code> option to add custom options to your DokuWiki configuration. See the [https://www.dokuwiki.org/config upstream documentation] for available options.


=== Templates ===
=== Templates ===


Unfortunately no templates are packaged yet in nixpkgs. It is possible to manually package a template and include it in your Dokuwiki instance. In the following example the tempalte [https://www.dokuwiki.org/template:mindthedark mindthedark] is packaged and enabled
Unfortunately no templates are packaged yet in nixpkgs. It is possible to manually package a template, for example from the [https://www.dokuwiki.org/template official template repository], and include it in your Dokuwiki instance. In the following example the template [https://www.dokuwiki.org/template:mindthedark mindthedark] is packaged and enabled


{{file|/etc/nixos/configuration.nix|nix|<nowiki>
{{file|/etc/nixos/configuration.nix|nix|<nowiki>
let
let


   dokuwiki-template-mindthedark = pkgs.stdenv.mkDerivation {
   dokuwiki-template-mindthedark = pkgs.stdenv.mkDerivation rec {
     name = "mindthedark";
     name = "mindthedark";
     src = pkgs.fetchurl {
    version = "2021-12-24";
       url = "https://github.com/MrReSc/MindTheDark/archive/2021-12-24.zip";
     src = pkgs.fetchFromGitHub {
       sha256 = "12qwd8cz4ay4lzp69ra5cmpssqwav6nxn767l43s86ja2b7m7zia";
       owner = "MrReSc";
      repo = "MindTheDark";
      rev = version;
       sha256 = "sha256-8wWwwAYYQcUYzHpnSKOubZh7UzwfxvWXXNU7CUAiS3o=";
     };
     };
    buildInputs = [ pkgs.unzip ];
     installPhase = "mkdir -p $out; cp -R * $out/";
     installPhase = "mkdir -p $out; cp -R * $out/";
   };
   };


in {
in {
   services.dokuwiki.sites."localhost".templates = [ dokuwiki-template-mindthedark ];
   services.dokuwiki.sites."localhost" = {
    templates = [ dokuwiki-template-mindthedark ];
    settings = {
      template = "mindthedark";
      tpl.mindthedark.autoDark = true;
    };
  };
};
};
</nowiki>}}
</nowiki>}}
Please note that you'll have to manually update the tempalte source and checksum in case there's a new version.
=== Plugins ===
The following example packages the [https://www.dokuwiki.org/plugin:edittable edittable plugin]
{{file|/etc/nixos/configuration.nix|nix|<nowiki>
let
  dokuwiki-plugin-edittable = pkgs.stdenv.mkDerivation {
    name = "edittable";
    src = pkgs.fetchzip {
      url = "https://github.com/cosmocode/edittable/archive/master.zip";
      sha256 = "sha256-l+GZdFGp6wyNuCbAZB9IbwpY5c/S4vSW12VP0mJHKXs=";
    };
    sourceRoot = ".";
    installPhase = "mkdir -p $out; cp -R edittable-master/* $out/";
  };
in {
  services.dokuwiki.sites."localhost" = {
    plugins = [ dokuwiki-plugin-edittable ];
  };
};
</nowiki>}}
The plugin is enabled automatically. Note that in case of this plugin, we strip the root directory called ''edittable-master'' and only copy the plugin files to the ''out''-folder. Please note that you'll have to manually update the plugin source and checksum in case there's a new version.


=== Clean URLs ===
=== Clean URLs ===
Line 47: Line 81:


{{file|/etc/nixos/configuration.nix|nix|<nowiki>
{{file|/etc/nixos/configuration.nix|nix|<nowiki>
services.dokuwiki.sites."localhost".extraConfig = ''
services.dokuwiki.sites."localhost".settings = {
   $conf['userewrite'] = 1;
   userewrite = true;
'';
};
};
</nowiki>}}
</nowiki>}}
Line 60: Line 93:


{{file|/etc/nixos/configuration.nix|nix|<nowiki>
{{file|/etc/nixos/configuration.nix|nix|<nowiki>
services.dokuwiki.sites."localhost".aclUse = false;
services.dokuwiki.sites."localhost".settings = {
  acluse = false;
};
</nowiki>}}
</nowiki>}}


Line 70: Line 105:


{{file|/etc/nixos/configuration.nix|nix|<nowiki>
{{file|/etc/nixos/configuration.nix|nix|<nowiki>
services.dokuwiki.sites."localhost".extraConfig = ''
services.dokuwiki.sites."localhost".settings = {
   $conf['baseurl'] = 'https://example.org';
   baseurl = "https://example.org";
'';
};
};
</nowiki>}}
</nowiki>}}


== See also ==
* [[Mediawiki]], PHP- and web-based wiki software.
* [[Outline]], a modern web based wiki and knowledge base for teams.
[[Category:Server]]
[[Category:Web Applications]]
[[Category:Web Applications]]
Retrieved from "https://wiki.nixos.org/wiki/Dokuwiki"