Dokuwiki - Revision history

Klinger: explained the „no need for databases"

2024-06-04T16:57:44Z

explained the „no need for databases"

← Older revision		Revision as of 16:57, 4 June 2024
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 ==

Onny: Remove unstable notice

2024-06-04T16:26:51Z

Remove unstable notice

← Older revision		Revision as of 16:26, 4 June 2024
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.

	~~{{Note\|Parts of this instruction and module are not yet stable and will be available in the upcoming NixOS 23.05 release.}}~~

	== Installation ==		== Installation ==

Klinger: Category:Server Category:Web Applications

2024-04-24T19:15:24Z

Category:Server Category:Web Applications

← Older revision		Revision as of 19:15, 24 April 2024
Line 116:		Line 116:
	* [[Outline]], a modern web based wiki and knowledge base for teams.		* [[Outline]], a modern web based wiki and knowledge base for teams.

			[[Category:Server]]
	[[Category:Web Applications]]		[[Category:Web Applications]]

imported>Onny: Add links to other web-based wiki software

2023-01-19T16:41:46Z

Add links to other web-based wiki software

← Older revision		Revision as of 16:41, 19 January 2023
Line 111:		Line 111:
	};		};
	</nowiki>}}		</nowiki>}}

			== See also ==
			* [[Mediawiki]], PHP- and web-based wiki software.
			* [[Outline]], a modern web based wiki and knowledge base for teams.

	[[Category:Web Applications]]		[[Category:Web Applications]]

imported>Onny: Update and cleanup configuration options

2023-01-07T00:28:34Z

Update and cleanup configuration options

← Older revision		Revision as of 00:28, 7 January 2023
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.

			{{Note\|Parts of this instruction and module are not yet stable and will be available in the upcoming NixOS 23.05 release.}}

	== Installation ==		== Installation ==
Line 8:		Line 10:
	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 18:
	== 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 ===
Line 27:		Line 27:
	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/";
	};		};
Line 40:		Line 42:
	services.dokuwiki.sites."localhost" = {		services.dokuwiki.sites."localhost" = {
	templates = [ dokuwiki-template-mindthedark ];		templates = [ dokuwiki-template-mindthedark ];
	~~extraConfig~~ = ''		settings = {
	~~$conf['~~template'] = "mindthedark";		template = "mindthedark";
	~~$conf['~~tpl~~']['~~mindthedark~~']['~~autoDark'] = true;		tpl.mindthedark.autoDark = true;
	'';		};
	};		};
	};		};
Line 59:		Line 61:
	dokuwiki-plugin-edittable = pkgs.stdenv.mkDerivation {		dokuwiki-plugin-edittable = pkgs.stdenv.mkDerivation {
	name = "edittable";		name = "edittable";
	src = pkgs.~~fetchurl~~ {		src = pkgs.fetchzip {
	url = "https://github.com/cosmocode/edittable/archive/master.zip";		url = "https://github.com/cosmocode/edittable/archive/master.zip";
	sha256 = "sha256-l+GZdFGp6wyNuCbAZB9IbwpY5c/S4vSW12VP0mJHKXs=";		sha256 = "sha256-l+GZdFGp6wyNuCbAZB9IbwpY5c/S4vSW12VP0mJHKXs=";
	};		};
	sourceRoot = ".";		sourceRoot = ".";
	~~buildInputs = [ pkgs.unzip ];~~
	installPhase = "mkdir -p $out; cp -R edittable-master/* $out/";		installPhase = "mkdir -p $out; cp -R edittable-master/* $out/";
	};		};
Line 82:		Line 83:

	{{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 95:		Line 95:

	{{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 105:		Line 107:

	{{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>}}

	[[Category:Web Applications]]		[[Category:Web Applications]]

imported>Onny at 21:37, 20 November 2022

2022-11-20T21:37:49Z

← Older revision		Revision as of 21:37, 20 November 2022
Line 75:		Line 75:
	</nowiki>}}		</nowiki>}}

	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.		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 ===

imported>Onny: Plugin usage

2022-11-20T21:35:24Z

Plugin usage

← Older revision		Revision as of 21:35, 20 November 2022
Line 49:		Line 49:

	Please note that you'll have to manually update the tempalte source and checksum in case there's a new version.		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.fetchurl {
			url = "https://github.com/cosmocode/edittable/archive/master.zip";
			sha256 = "sha256-l+GZdFGp6wyNuCbAZB9IbwpY5c/S4vSW12VP0mJHKXs=";
			};
			sourceRoot = ".";
			buildInputs = [ pkgs.unzip ];
			installPhase = "mkdir -p $out; cp -R edittable-master/* $out/";
			};

			in {
			services.dokuwiki.sites."localhost" = {
			plugins = [ dokuwiki-plugin-edittable ];
			};
			};
			</nowiki>}}

			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 ===

imported>Onny at 22:56, 21 October 2022

2022-10-21T22:56:35Z

← Older revision		Revision as of 22:56, 21 October 2022
Line 42:		Line 42:
	extraConfig = ''		extraConfig = ''
	$conf['template'] = "mindthedark";		$conf['template'] = "mindthedark";
			$conf['tpl']['mindthedark']['autoDark'] = true;
	'';		'';
	};		};

imported>Fadenb: /* Templates */ typo fix

2022-10-21T18:52:16Z

Templates: typo fix

← Older revision		Revision as of 18:52, 21 October 2022
Line 22:		Line 22:
	=== Templates ===		=== Templates ===

	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 ~~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>

imported>Onny at 15:59, 21 October 2022

2022-10-21T15:59:30Z

← Older revision		Revision as of 15:59, 21 October 2022
Line 22:		Line 22:
	=== 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 tempalte [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>
Line 46:		Line 46:
	};		};
	</nowiki>}}		</nowiki>}}

			Please note that you'll have to manually update the tempalte source and checksum in case there's a new version.

	=== Clean URLs ===		=== Clean URLs ===