This is an old revision of the document!

Information

Prerequisites

Dependencies

sudo apt install git php-bz2 php-gd php-intl php-mbstring php-xml

Download Source

https://github.com/dokuwiki/dokuwiki/commits/master/

sudo git clone --branch 'master' --depth '1' --recurse-submodules 'https://github.com/splitbrain/dokuwiki.git' '/var/www/wiki' && sudo chown -R 'www-data':'www-data' '/var/www/wiki' && sudo chmod -R '0755' '/var/www/wiki'

nginx + PHP-FPM Configuration

PHP-FPM Socket

sudo -e '/etc/php/8.4/fpm/pool.d/wiki.conf' && sudo systemctl restart 'php8.4-fpm'

[wiki]

; User/Group
user = "www-data"
group = "www-data"

; Socket
listen = "/run/php/wiki.sock"
listen.owner = "www-data"
listen.group = "www-data"
listen.mode = "0662"

; Process Management
pm = "ondemand"
pm.max_children = "4"
pm.process_idle_timeout = "30"

; Logging
php_value[log_errors] = "0"
php_value[error_reporting] = "~E_ALL"

; General
php_value[date.timezone] = "America/New_York"

; End

FastCGI

sudo -e '/etc/nginx/snippets/wiki.conf'

location '~' '\.(php|phar)(/.*)?$' {

 fastcgi_split_path_info '^(.+\.(?:php|phar))(/.*)$';
 fastcgi_intercept_errors 'on';
 fastcgi_index 'doku.php';
 include 'fastcgi_params';
 fastcgi_param 'SCRIPT_FILENAME' '$document_root$fastcgi_script_name';
 fastcgi_param 'PATH_INFO' '$fastcgi_path_info';
 fastcgi_param 'HTTPS' 'on';

 fastcgi_pass 'unix:/run/php/wiki.sock';

}

# End

Server Block

sudo -e '/etc/nginx/sites-available/wiki.conf'

server {

 listen '443' 'ssl';
 http2 'on';
 server_name 'wiki.realmofespionage.xyz';
 root '/var/www/wiki';
 index 'doku.php';

 include '/etc/nginx/snippets/wiki.conf';
 include '/etc/nginx/snippets/headers.conf';

 client_max_body_size '10M';

 add_header 'Content-Security-Policy' "default-src 'self'; script-src 'self' 'unsafe-inline'; style-src 'self' 'unsafe-inline'; img-src 'self' data:" 'always';

# access_log '/var/log/nginx/wiki-access.log';
# error_log '/var/log/nginx/wiki-error.log';

# location = '/install.php' {
#  deny 'all';
# }

# location '~' '/(conf|bin|inc)/' {
#  deny 'all';
# }

# location '~' '/data/' {
#  internal;
# }

 location '/' {
  try_files '$uri' '$uri/' '@dokuwiki';
 }

 location '@dokuwiki' {
  rewrite '^/_media/(.*)' '/lib/exe/fetch.php?media=$1' 'last';
  rewrite '^/_detail/(.*)' '/lib/exe/detail.php?media=$1' 'last';
  rewrite '^/_export/([^/]+)/(.*)' '/doku.php?do=export_$1&id=$2' 'last';
  rewrite '^/(.*)' '/doku.php?id=$1&$args' 'last';
 }

}

# End

sudo ln -s -f '/etc/nginx/sites-available/wiki.conf' '/etc/nginx/sites-enabled/wiki.conf' && sudo systemctl reload 'nginx'

Initial Setup

https://wiki.realmofespionage.xyz/install.php

Settings

Plugins

https://www.dokuwiki.org/plugin:searchindex

Template Style Settings

Alternative background color: #484848 (gray)
The general link color: #3d8bff (blue)
The width of the full site: 85%

nginx Server Block Deny Directives

Uncomment commented sections (except logs)
Do after initial setup

sudo -e '/etc/nginx/sites-available/wiki.conf' && sudo ln -s -f '/etc/nginx/sites-available/wiki.conf' '/etc/nginx/sites-enabled/wiki.conf' && sudo systemctl reload 'nginx'

URL Rewrite

Admin → Configuration Settings → DokuWiki → Advanced → userewrite

.htaccess

Double-hyphen Convert Disable

This prevents -- from becoming a – (long hyphen), which breaks some command's syntax

echo '--      --' | sudo -u 'www-data' tee '/var/www/wiki/conf/entities.local.conf' > '/dev/null'

Scripts

Git Fix

Set email for user.email

sudo mkdir -p '/etc/nginx/scripts/wiki' && sudo -e '/etc/nginx/scripts/wiki/git-fix.sh' && sudo chmod '0500' '/etc/nginx/scripts/wiki/git-fix.sh' && sudo chown 'www-data':'www-data' '/etc/nginx/scripts/wiki/git-fix.sh'

#!/bin/bash

rm -Rf '/var/www/wiki/.git'
git -C '/var/www/wiki' init --initial-branch='master'
git -C '/var/www/wiki' add '.'

########################################
git -C '/var/www/wiki' config 'user.email' 'espionage724@x'
########################################

git -C '/var/www/wiki' commit --message='x'

git -C '/var/www/wiki' remote add 'origin' 'https://github.com/dokuwiki/dokuwiki.git'
git -C '/var/www/wiki' pull --depth '1' --recurse-submodules 'origin' 'master' --rebase

git -C '/var/www/wiki' reset --hard 'origin/master'
git -C '/var/www/wiki' gc --aggressive --prune='all'
git -C '/var/www/wiki' fsck --full --strict

# End

sudo -u 'www-data' '/etc/nginx/scripts/wiki/git-fix.sh'

Services

Updater

Service

sudo -e '/etc/systemd/system/wiki-up.service'

[Service]
User=www-data
Group=www-data
Type=oneshot

WorkingDirectory=/var/www/wiki

ExecStart='/usr/bin/git' -C '/var/www/wiki' reset --hard
ExecStart='/usr/bin/git' -C '/var/www/wiki' pull origin 'master' --rebase

ExecStart='/usr/bin/php' '/var/www/wiki/bin/indexer.php' --clear
ExecStart='/usr/bin/touch' '/var/www/wiki/conf/local.php'

ExecStartPost='/usr/bin/sync'

# End

Timer

Daily 12:00:00 AM

sudo -e '/etc/systemd/system/wiki-up.timer' && sudo systemctl daemon-reload && sudo systemctl enable 'wiki-up.timer' --now && sudo systemctl start 'wiki-up' && sudo systemctl status 'wiki-up' -l

[Unit]
Description=DokuWiki Git Updater
After=network-online.target
Wants=network-online.target

[Timer]
OnCalendar=*-*-* 00:00:00
Persistent=true

[Install]
WantedBy=timers.target

# End

Backup

TODO: NAS mount

Service

mkdir -p ~/'backups' && sudo -e '/etc/systemd/system/wiki-fb.service' && sudo sed -i 's/CHANGEME/'$USER'/g' '/etc/systemd/system/wiki-fb.service'

[Service]
Type=oneshot

WorkingDirectory=/var/www/wiki

ExecStart='/usr/bin/bash' -c '"/usr/bin/tar" -czf "/home/CHANGEME/backups/dokuwiki-files-auto-"$$(date +%%Y-%%m-%%d)".tar.gz" -C "/var/www/wiki" "data/pages" "data/meta" "data/media" "data/media_meta" "data/attic" "data/media_attic" "conf"'

ExecStartPost='/usr/bin/sync'

# End

Timer

Weekly (Monday) 12:15:00 AM

sudo -e '/etc/systemd/system/wiki-fb.timer' && sudo systemctl daemon-reload && sudo systemctl enable 'wiki-fb.timer' --now && sudo systemctl start 'wiki-fb' && sudo systemctl status 'wiki-fb' -l

[Unit]
Description=DokuWiki Files Backup

[Timer]
OnCalendar=Mon *-*-* 00:15:00
Persistent=true

[Install]
WantedBy=timers.target

# End

Maintenance

Service

sudo -e '/etc/systemd/system/wiki-m.service'

[Service]
User=www-data
Group=www-data
Type=oneshot

WorkingDirectory=/var/www/wiki

ExecStart='/usr/bin/git' -C '/var/www/wiki' gc --aggressive --prune='all'
ExecStart='/usr/bin/git' -C '/var/www/wiki' fsck --full --strict

ExecStartPost='/usr/bin/sync'

# End

Timer

Monthly (1st) 12:30:00 AM

sudo -e '/etc/systemd/system/wiki-m.timer' && sudo systemctl daemon-reload && sudo systemctl enable 'wiki-m.timer' --now

[Unit]
Description=DokuWiki Maintenance

[Timer]
OnCalendar=*-*-01 00:30:00
Persistent=true

[Install]
WantedBy=timers.target

# End

sudo systemctl start 'wiki-m' && sudo systemctl status 'wiki-m' -l

Backup

Files

sudo tar -czf ~/'dokuwiki-files-manual-'$(date +%Y-%m-%d)'.tar.gz' -C '/var/www/wiki' 'data/pages' 'data/meta' 'data/media' 'data/media_meta' 'data/attic' 'data/media_attic' 'conf'

scp

scp espionage724@192.168.1.152:~/'dokuwiki-files-'*'.tar.gz' ~/'Downloads'

Restore

scp

scp ~/'Downloads/dokuwiki-files-'*'.tar.gz' espionage724@192.168.1.152:~

Stop nginx

sudo systemctl stop 'nginx'

Remove Existing Files

ls ~/'dokuwiki-files-'*'.tar.gz' && sudo rm -Rf '/var/www/wiki/data/pages' '/var/www/wiki/data/meta' '/var/www/wiki/data/media' '/var/www/wiki/data/media_meta' '/var/www/wiki/data/attic' '/var/www/wiki/data/media_attic' '/var/www/wiki/conf'

Restore Files

sudo tar -xzf ~/'dokuwiki-files-'*'.tar.gz' -C '/var/www/wiki' 'data/pages' 'data/meta' 'data/media' 'data/media_meta' 'data/attic' 'data/media_attic' 'conf' && sudo chown -R 'www-data':'www-data' '/var/www/wiki' && sudo chmod -R '0755' '/var/www/wiki'

Git Fix

Set email for user.email

sudo su 'www-data' -s '/bin/bash'

rm -Rf '/var/www/wiki/.git'

git -C '/var/www/wiki' init --initial-branch='master'

git -C '/var/www/wiki' add '.'

git -C '/var/www/wiki' config 'user.email' 'espionage724@x'

git -C '/var/www/wiki' commit --message='x'

git -C '/var/www/wiki' remote add 'origin' 'https://github.com/dokuwiki/dokuwiki.git'

git -C '/var/www/wiki' pull --depth '1' --recurse-submodules 'origin' 'master' --rebase

git -C '/var/www/wiki' reset --hard 'origin/master'

git -C '/var/www/wiki' gc --aggressive --prune='all'

git -C '/var/www/wiki' fsck --full --strict

exit

Start nginx

sudo systemctl start 'nginx'

Clean-up

rm -fv ~/'dokuwiki-files-'*'.tar.gz'

TODOs

¹⁾

you are here :p

Table of Contents

Information

Prerequisites

Dependencies

Download Source

nginx + PHP-FPM Configuration

PHP-FPM Socket

FastCGI

Server Block

Initial Setup

Settings

Plugins

Template Style Settings

nginx Server Block Deny Directives

URL Rewrite

Double-hyphen Convert Disable

Scripts

Git Fix

Services

Updater

Service

Timer

Backup

Service

Timer

Maintenance

Service

Timer

Backup

Files

scp

Restore

scp

Stop nginx

Remove Existing Files

Restore Files

Git Fix

Start nginx

Clean-up

TODOs