====== Information ======

  * DokuWiki ((https://www.dokuwiki.org/dokuwiki))
  * [[information:realm_of_espionage|Realm of Espionage]]
  * https://wiki.realmofespionage.xyz ((you are here :p))

===== Prerequisites =====

  * [[bsd:server:freebsd_16.0|FreeBSD 16.0]]
  * [[servers:bsd:freenginx_php_php-fpm|freenginx + PHP + PHP-FPM]]
  * [[servers:bsd:nginx:lets_encrypt|Certbot (Let's Encrypt)]]

====== Dependencies ======

  * https://www.dokuwiki.org/requirements
  * https://www.dokuwiki.org/install:php
  * https://github.com/dokuwiki/dokuwiki/blob/master/composer.json

  su -

  pkg install git-lite php85-session php85-bz2 php85-filter php85-gd php85-intl php85-mbstring php85-xml php85-zlib

====== Download Source ======

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

  su -

  git clone --branch 'master' --depth '1' --recurse-submodules 'https://github.com/splitbrain/dokuwiki.git' '/usr/local/www/wiki' && chown -R 'www':'www' '/usr/local/www/wiki'

====== nginx + PHP-FPM Configuration ======

===== PHP-FPM Socket =====

  su -

  ee '/usr/local/etc/php-fpm.d/wiki.conf' && service 'php_fpm' reload

<code>
[wiki]

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

; Socket
listen = "127.0.0.1:9002"
listen.allowed_clients = "127.0.0.1"

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

; Logging
php_value[log_errors] = "Off"
php_value[error_reporting] = "~E_ALL"
php_value[display_errors] = "Off"
php_value[display_startup_errors] = "Off"
php_value[html_errors] = "Off"

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

; End</code>

===== FastCGI =====

  su -

  ee '/usr/local/etc/freenginx/default.d/wiki.conf'

<code>
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 '127.0.0.1:9002';
}

# End</code>

===== Server Block ======

  su -

  ee '/usr/local/etc/freenginx/vhosts.d/wiki.conf' && service 'nginx' reload

<code>
server {
 listen '443' 'ssl';
 http2 'on';
 server_name 'wiki.realmofespionage.xyz';
 root '/usr/local/www/wiki';
 index 'doku.php';

 include '/usr/local/etc/freenginx/default.d/wiki.conf';
 include '/usr/local/etc/freenginx/default.d/headers.conf';

 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</code>

====== Initial Setup ======

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

====== Settings ======

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

  su -

  ee '/usr/local/etc/freenginx/vhosts.d/wiki.conf' && service 'nginx' reload

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

  su -

  su -m 'www' -c "echo '--      --' | tee '/usr/local/www/wiki/conf/entities.local.conf' > '/dev/null'"

====== Scripts ======

===== Updater =====

  mkdir -p ~/'.local/scripts/www/wiki' && ee ~/'.local/scripts/www/wiki/updater.sh' && chmod +x ~/'.local/scripts/www/wiki/updater.sh'

<code>
#!/bin/sh

cd '/tmp'

'/usr/bin/su' -m 'www' -c "'/usr/local/bin/git' -C '/usr/local/www/wiki' reset --hard 'origin/master'"
'/usr/bin/su' -m 'www' -c "'/usr/local/bin/git' -C '/usr/local/www/wiki' pull 'origin' 'master' --rebase"

'/usr/bin/su' -m 'www' -c "'/usr/local/bin/php' '/usr/local/www/wiki/bin/indexer.php' --clear"
'/usr/bin/su' -m 'www' -c "'/usr/bin/touch' '/usr/local/www/wiki/conf/local.php'"

'/bin/sync'

# End</code>

  su 'root' -c ~/'.local/scripts/www/wiki/updater.sh'

===== Backup =====

  mkdir -p ~/'backups' ~/'.local/scripts/www/wiki' && ee ~/'.local/scripts/www/wiki/backup.sh' && chmod +x ~/'.local/scripts/www/wiki/backup.sh'

<code>
#!/bin/sh

cd '/tmp'

'/usr/bin/tar' -czf '/home/espionage724/backups/dokuwiki-files-auto-'$(date +%Y-%m-%d)'.tar.gz' -C '/usr/local/www/wiki' 'data/pages' 'data/meta' 'data/media' 'data/media_meta' 'data/attic' 'data/media_attic' 'conf'

'/bin/sync'

# End</code>

  su 'root' -c ~/'.local/scripts/www/wiki/backup.sh'

===== Maintenance =====

  mkdir -p ~/'.local/scripts/www/wiki' && ee ~/'.local/scripts/www/wiki/maintenance.sh' && chmod +x ~/'.local/scripts/www/wiki/maintenance.sh'

<code>
#!/bin/sh

cd '/tmp'

'/usr/bin/su' -m 'www' -c "'/usr/local/bin/git' -C '/usr/local/www/wiki' gc --aggressive --prune='all'"
'/usr/bin/su' -m 'www' -c "'/usr/local/bin/git' -C '/usr/local/www/wiki' fsck --full --strict"

# End</code>

  su 'root' -c ~/'.local/scripts/www/wiki/maintenance.sh'

===== Git Fix =====

  * :!: Set email for ''user.email''

  mkdir -p ~/'.local/scripts/www/wiki' && ee ~/'.local/scripts/www/wiki/git-fix.sh' && chmod +x ~/'.local/scripts/www/wiki/git-fix.sh'

<code>
#!/bin/sh

cd '/tmp'

'/usr/bin/su' -m 'www' -c "'/bin/rm' -Rf '/usr/local/www/wiki/.git'"
'/usr/bin/su' -m 'www' -c "'/usr/local/bin/git' -C '/usr/local/www/wiki' init --initial-branch='master'"
'/usr/bin/su' -m 'www' -c "'/usr/local/bin/git' -C '/usr/local/www/wiki' add '.'"

########################################
'/usr/bin/su' -m 'www' -c "'/usr/local/bin/git' -C '/usr/local/www/wiki' config 'user.email' 'espionage724@x'"
########################################

'/usr/bin/su' -m 'www' -c "'/usr/local/bin/git' -C '/usr/local/www/wiki' commit --message='x'"

'/usr/bin/su' -m 'www' -c "'/usr/local/bin/git' -C '/usr/local/www/wiki' remote add 'origin' 'https://github.com/dokuwiki/dokuwiki.git'"
'/usr/bin/su' -m 'www' -c "'/usr/local/bin/git' -C '/usr/local/www/wiki' pull --depth '1' --recurse-submodules 'origin' 'master' --rebase"

'/usr/bin/su' -m 'www' -c "'/usr/local/bin/git' -C '/usr/local/www/wiki' reset --hard 'origin/master'"
'/usr/bin/su' -m 'www' -c "'/usr/local/bin/git' -C '/usr/local/www/wiki' gc --aggressive --prune='all'"
'/usr/bin/su' -m 'www' -c "'/usr/local/bin/git' -C '/usr/local/www/wiki' fsck --full --strict"

'/bin/sync'

# End</code>

  su 'root' -c ~/'.local/scripts/www/wiki/git-fix.sh'

====== cron ======

===== Updater =====

  * Daily ''12:00:00 AM''

  su -

  ee '/etc/cron.d/wiki-updater'

<code>
#
SHELL=/bin/sh

0 0 * * * root '/home/espionage724/.local/scripts/www/wiki/updater.sh'

# End</code>

===== Backup =====

  * Weekly (Monday) ''12:15:00 AM''

  su -

  ee '/etc/cron.d/wiki-backup'

<code>
#
SHELL=/bin/sh

15 0 * * mon root '/home/espionage724/.local/scripts/www/wiki/backup.sh'

# End</code>

===== Maintenance =====

  * Monthly (1st) ''12:30:00 AM''

  su -

  ee '/etc/cron.d/wiki-maintenance'

<code>
#
SHELL=/bin/sh

30 0 1 * * root '/home/espionage724/.local/scripts/www/wiki/maintenance.sh'

# End</code>

====== Backup ======

===== Folder =====

****

  su 'root' -c "tar -czf '/home/'$USER'/dokuwiki-files-manual-'$(date +%Y-%m-%d)'.tar.gz' -C '/usr/local/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:~

===== Folder =====

  su

  ls '/home/'$USER'/dokuwiki-files-'*'.tar.gz' && rm -Rf '/usr/local/www/wiki/data/pages' '/usr/local/www/wiki/data/meta' '/usr/local/www/wiki/data/media' '/usr/local/www/wiki/data/media_meta' '/usr/local/www/wiki/data/attic' '/usr/local/www/wiki/data/media_attic' '/usr/local/www/wiki/conf'

  tar -xzf '/home/'$USER'/dokuwiki-files-'*'.tar.gz' -C '/usr/local/www/wiki' 'data/pages' 'data/meta' 'data/media' 'data/media_meta' 'data/attic' 'data/media_attic' 'conf' && chown -R 'www':'www' '/usr/local/www/wiki' && sync