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

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

===== Prerequisites =====

  * [[bsd:server:freebsd_15.0|FreeBSD 15.0]]
  * [[servers:bsd:freenginx_php_php-fpm|freenginx + PHP + PHP-FPM]]
  * [[servers:bsd:nginx:lets_encrypt|Let's Encrypt]]

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

  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

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

; Errors
php_value[error_reporting] = "~E_ALL"
php_value[display_errors] = "Off"

; 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';

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

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

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

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

===== Plugins =====

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

===== Template Style Settings =====

  * Alternative background color: ''#484848''
  * The general link color: ''#3d8bff''
  * :!: The width of the full site: ''100em'' ((this caused some kind of scrollbar I believe on a 1280x800 laptop))

===== 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
  * :!: TODO: FreeBSD

  echo '--      --' | sudo tee '/var/www/wiki/conf/entities.local.conf' > '/dev/null' && sudo chown 'nginx':'nginx' '/var/www/wiki/conf/entities.local.conf' && sync

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

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

# End</code>

  ~/'.local/scripts/www/wiki/updater.sh'

  su 'root' -c ~/'.local/scripts/www/wiki/updater.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

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

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

# End</code>

  ~/'.local/scripts/www/wiki/maintenance.sh'

  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

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

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

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

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

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

# End</code>

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

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

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

===== Updater =====

  * 12:00AM Every day

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

===== Folder =====

  su -

  tar -czf '/home/espionage724/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/espionage724/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/espionage724/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