| Next revision | Previous revision |
| servers:linux:nginx:dokuwiki [2024/08/13 22:15] – created Sean Rhone | servers:linux:nginx:dokuwiki [2025/10/20 15:50] (current) – [Initial Setup] Sean Rhone |
|---|
| ====== Information ====== | ====== Information ====== |
| |
| * DokuWiki ((https://www.dokuwiki.org)) ((https://github.com/splitbrain/dokuwiki)) | * DokuWiki |
| * [[Information:Realm of Espionage]] | * [[information:realm_of_espionage|Realm of Espionage]] |
| * https://wiki.realmofespionage.xyz ((you are here :p)) | * https://wiki.realmofespionage.xyz ((you are here :p)) |
| |
| ===== Prerequisites ===== | ===== Prerequisites ===== |
| |
| * [[distros:fedora_server|Fedora Server]] | * [[linux:distros:server:opensuse_tumbleweed_server|openSUSE Tumbleweed (Server)]] |
| * [[servers:nginx_php_php-fpm|nginx + PHP + PHP-FPM]] | * [[servers:linux:nginx_php_php-fpm|nginx + PHP + PHP-FPM]] |
| * [[servers:nginx:lets_encrypt|Let's Encrypt]] | * [[servers:linux:nginx:lets_encrypt|Certbot (Let's Encrypt)]] |
| |
| ====== TODO ====== | ====== TODOs ====== |
| |
| * https://www.dokuwiki.org/cli?s%5B%5D=wantedpages.php | * https://www.dokuwiki.org/cli?s%5B%5D=wantedpages.php |
| ====== Dependencies ====== | ====== Dependencies ====== |
| |
| * PHP Modules: gd sodium zip zlib xml | * https://www.dokuwiki.org/requirements |
| | * https://www.dokuwiki.org/install:php |
| | * https://github.com/dokuwiki/dokuwiki/blob/master/composer.json |
| |
| sudo dnf install php-gd php-sodium php-pecl-zip php-xml | sudo zypper install php8-bz2 php8-gd php8-intl php8-mbstring php8-sodium php8-zlib |
| |
| ====== Download Source ====== | ====== 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 semanage fcontext --add --type 'httpd_sys_rw_content_t' '/var/www/wiki(/.*)?' && sudo restorecon -F -I -R '/var/www/wiki' && sudo chown -R 'nginx':'nginx' '/var/www/wiki' && sync | sudo git clone --branch 'master' --depth '1' --recurse-submodules 'https://github.com/splitbrain/dokuwiki.git' '/srv/www/wiki' && sudo chown -R 'wwwrun':'www' '/srv/www/wiki' && sudo chmod -R '0755' '/srv/www/wiki' |
| |
| ====== nginx + PHP-FPM Configuration ====== | ====== nginx + PHP-FPM Configuration ====== |
| ===== PHP-FPM Socket ===== | ===== PHP-FPM Socket ===== |
| |
| sudo -e '/etc/php-fpm.d/wiki.conf' && sudo systemctl restart 'php-fpm' | sudo -e '/etc/php8/fpm/php-fpm.d/wiki.conf' && sudo systemctl restart 'php-fpm' |
| |
| <code> | <code> |
| |
| ; User/Group | ; User/Group |
| user = nginx | user = "wwwrun" |
| group = nginx | group = "www" |
| |
| ; Socket | ; Socket |
| listen = /run/php-fpm/wiki.sock | listen = "/run/php-fpm/wiki.sock" |
| listen.acl_users = nginx | listen.owner = "wwwrun" |
| listen.allowed_clients = 127.0.0.1 | listen.group = "www" |
| | listen.mode = "0662" |
| |
| ; Process Management | ; Process Management |
| pm = ondemand | pm = "ondemand" |
| pm.max_children = 4 | pm.max_children = "4" |
| pm.process_idle_timeout = 30 | pm.process_idle_timeout = "30" |
| |
| ; Fedora php.ini Defaults | ; openSUSE php.ini Defaults |
| php_value[session.save_handler] = "files" | php_value[session.save_path] = "/var/lib/php8/sessions" |
| php_value[session.save_path] = "/var/lib/php/session" | |
| |
| ; General | ; General |
| | php_value[log_errors] = "0" |
| | php_value[error_reporting] = "~E_ALL" |
| php_value[date.timezone] = "America/New_York" | php_value[date.timezone] = "America/New_York" |
| ;php_value[max_execution_time] = "200" | |
| ;php_value[memory_limit] = "512M" | |
| ;php_value[post_max_size] = "10M" | |
| ;php_value[upload_max_filesize] = "10M" | |
| ;php_value[max_file_uploads] = "100" | |
| |
| ; End</code> | ; End</code> |
| |
| ===== FastCGI ===== | ===== FastCGI ===== |
| | |
| | * ''wiki.sock'' |
| |
| sudo -e '/etc/nginx/default.d/wiki.conf' | sudo -e '/etc/nginx/default.d/wiki.conf' |
| |
| <code> | <code> |
| # PHP-FPM | |
| location ~ \.(php|phar)(/.*)?$ { | location ~ \.(php|phar)(/.*)?$ { |
| fastcgi_split_path_info ^(.+\.(?:php|phar))(/.*)$; | fastcgi_split_path_info ^(.+\.(?:php|phar))(/.*)$; |
| fastcgi_param HTTPS on; | fastcgi_param HTTPS on; |
| fastcgi_pass unix:/run/php-fpm/wiki.sock; | fastcgi_pass unix:/run/php-fpm/wiki.sock; |
| }</code> | } |
| | |
| | # End</code> |
| |
| ===== Server Block ====== | ===== Server Block ====== |
| |
| sudo -e '/etc/nginx/vhosts.d/wiki.conf' && sudo systemctl reload 'nginx' && sync | sudo -e '/etc/nginx/vhosts.d/wiki.conf' && sudo systemctl reload 'nginx' |
| |
| <code> | <code> |
| http2 'on'; | http2 'on'; |
| server_name 'wiki.realmofespionage.xyz'; | server_name 'wiki.realmofespionage.xyz'; |
| root '/var/www/wiki'; | root '/srv/www/wiki'; |
| index 'doku.php'; | index 'doku.php'; |
| |
| rewrite ^/(.*) /doku.php?id=$1&$args last; | rewrite ^/(.*) /doku.php?id=$1&$args last; |
| } | } |
| }</code> | } |
| | |
| | # End</code> |
| |
| ====== Initial Setup ====== | ====== Initial Setup ====== |
| |
| * :!: TODO: https://www.dokuwiki.org/rewrite | * TODO: https://www.dokuwiki.org/rewrite ((notes; rewrite's been working fine though)) |
| |
| * https://wiki.realmofespionage.xyz/install.php | * https://wiki.realmofespionage.xyz/install.php |
| ===== Template Style Settings ===== | ===== Template Style Settings ===== |
| |
| * Alternative background color: ''#484848'' | * Alternative background color: ''#484848'' (gray) |
| * The general link color: ''#3d8bff'' | * The general link color: ''#3d8bff'' (blue) |
| * :!: The width of the full site: ''100em'' ((this caused some kind of scrollbar I believe on a 1280x800 laptop)) | * The width of the full site: ''85%'' |
| |
| ===== nginx Server Block Deny Directives ===== | ===== nginx Server Block Deny Directives ===== |
| * This prevents -- from becoming a – (long hyphen), which breaks some command's syntax | * This prevents -- from becoming a – (long hyphen), which breaks some command's syntax |
| |
| echo '-- --' | sudo tee '/var/www/wiki/conf/entities.local.conf' > '/dev/null' && sudo chown 'nginx':'nginx' '/var/www/wiki/conf/entities.local.conf' && sync | echo '-- --' | sudo tee '/srv/www/wiki/conf/entities.local.conf' > '/dev/null' && sudo chown 'wwwrun':'www' '/srv/www/wiki/conf/entities.local.conf' |
| |
| ====== Services ====== | ====== Services ====== |
| <code> | <code> |
| [Service] | [Service] |
| User=nginx | User=wwwrun |
| Group=nginx | Group=www |
| Type=oneshot | Type=oneshot |
| ExecStart='/usr/bin/git' -C '/var/www/wiki' pull origin 'master' | |
| ExecStartPost='/usr/bin/touch' '/var/www/wiki/conf/local.php' | ExecStart='/usr/bin/git' -C '/srv/www/wiki' pull origin 'master' |
| | |
| | ExecStartPost='/usr/bin/touch' '/srv/www/wiki/conf/local.php' |
| ExecStartPost='/usr/bin/sync' | ExecStartPost='/usr/bin/sync' |
| |
| ==== Timer ==== | ==== Timer ==== |
| |
| * Every day at ''00:30:00'' | * Every day at ''00:00:00'' |
| |
| 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 | 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 |
| |
| [Timer] | [Timer] |
| OnCalendar=*-*-* 00:30:00 | OnCalendar=*-*-* 00:00:00 |
| Persistent=true | Persistent=true |
| |
| # End</code> | # End</code> |
| |
| ===== Maintenance ===== | ===== Backup ===== |
| | |
| * https://www.dokuwiki.org/tips:maintenance | |
| |
| ==== Service ==== | ==== Service ==== |
| |
| * :!: The commented ''ExecStart'' would remove page edits older than 90 days | mkdir -p ~/'backups' && sudo -e '/etc/systemd/system/wiki-fb.service' && sudo sed -i 's/CHANGEME/'$USER'/g' '/etc/systemd/system/wiki-fb.service' |
| | |
| sudo -e '/etc/systemd/system/wiki-m.service' | |
| |
| <code> | <code> |
| [Service] | [Service] |
| User=nginx | |
| Group=nginx | |
| Type=oneshot | Type=oneshot |
| WorkingDirectory=/var/www/wiki | |
| ExecStart='/usr/bin/git' -C '/var/www/wiki' gc --aggressive --prune='all' | ExecStart='/usr/bin/bash' -c '"/usr/bin/tar" -czf "/home/CHANGEME/backups/dokuwiki-files-auto-"$$(date +%%Y-%%m-%%d)".tar.gz" -C "/srv/www/wiki" "data/pages" "data/meta" "data/media" "data/media_meta" "data/attic" "data/media_attic" "conf"' |
| ExecStart='/usr/bin/git' -C '/var/www/wiki' fsck --full --strict | |
| #ExecStart='/usr/bin/bash' -c "find '/var/www/wiki/data'/{attic,cache,locks,media_attic}/ -type 'f' -mtime +'90' -delete" | |
| ExecStart='/usr/bin/bash' -c "find '/var/www/wiki/data'/{attic,cache,index,locks,media,media_attic,media_meta,meta,pages,tmp}/ -mindepth '1' -type 'd' -empty -delete" | |
| ExecStart='/usr/bin/php' '/var/www/wiki/bin/indexer.php' --clear | |
| ExecStartPost='/usr/bin/sync' | ExecStartPost='/usr/bin/sync' |
| |
| ==== Timer ==== | ==== Timer ==== |
| |
| * ''01'' day of every month at ''01:00:00'' | * Every day at ''00:15:00'' |
| |
| sudo -e '/etc/systemd/system/wiki-m.timer' && sudo systemctl daemon-reload && sudo systemctl enable 'wiki-m.timer' --now | 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 |
| |
| <code> | <code> |
| [Unit] | [Unit] |
| Description=DokuWiki Maintenance | Description=DokuWiki Files Backup |
| |
| [Timer] | [Timer] |
| OnCalendar=*-*-01 01:00:00 | OnCalendar=*-*-* 00:15:00 |
| Persistent=true | Persistent=true |
| |
| # End</code> | # End</code> |
| |
| ===== Backup ===== | ===== Maintenance ===== |
| | |
| * This backs up an archive to the local disk and to a NAS | |
| |
| ==== Service ==== | ==== Service ==== |
| |
| * The extra ''ExecStart''s are additional backup locations that expect [[servers:vsftpd|vsftpd]] | sudo -e '/etc/systemd/system/wiki-m.service' |
| * TODO: Remove additional backup locations and put it on a system-wide script direct from the ''~/backups'' folder | |
| | |
| mkdir -p ~/'backups' && sudo -e '/etc/systemd/system/wiki-fb.service' && sudo sed -i 's/CHANGEME/'$USER'/g' '/etc/systemd/system/wiki-fb.service' | |
| |
| <code> | <code> |
| [Service] | [Service] |
| | User=wwwrun |
| | Group=www |
| Type=oneshot | 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" "data/pages" "data/meta" "data/media" "data/media_meta" "data/attic" "data/media_attic" "conf"' | ExecStart='/usr/bin/git' -C '/srv/www/wiki' reset --hard |
| #ExecStart='/usr/bin/bash' -c '"/usr/bin/tar" -czf "/var/ftp/nas1/Servers/Scheduled Backups/dokuwiki-files-auto-"$$(date +%%Y-%%m-%%d)".tar.gz" "data/pages" "data/meta" "data/media" "data/media_meta" "data/attic" "data/media_attic" "conf"' | ExecStart='/usr/bin/git' -C '/srv/www/wiki' gc --aggressive --prune='all' |
| #ExecStart='/usr/bin/bash' -c '"/usr/bin/tar" -czf "/srv/ftp/nas2/Servers/Scheduled Backups/dokuwiki-files-auto-"$$(date +%%Y-%%m-%%d)".tar.gz" "data/pages" "data/meta" "data/media" "data/media_meta" "data/attic" "data/media_attic" "conf"' | ExecStart='/usr/bin/git' -C '/srv/www/wiki' fsck --full --strict |
| | |
| | ExecStart='/usr/bin/bash' -c "find '/srv/www/wiki/data'/{attic,cache,index,locks,media,media_attic,media_meta,meta,pages,tmp}/ -mindepth '1' -type 'd' -empty -delete" |
| | ExecStart='/usr/bin/php' '/srv/www/wiki/bin/indexer.php' --clear |
| ExecStartPost='/usr/bin/sync' | ExecStartPost='/usr/bin/sync' |
| |
| ==== Timer ==== | ==== Timer ==== |
| |
| * Every day at ''01:30:00'' | * ''01'' day of every month at ''00:30:00'' |
| |
| 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 | sudo -e '/etc/systemd/system/wiki-m.timer' && sudo systemctl daemon-reload && sudo systemctl enable 'wiki-m.timer' --now |
| |
| <code> | <code> |
| [Unit] | [Unit] |
| Description=DokuWiki Files Backup | Description=DokuWiki Maintenance |
| |
| [Timer] | [Timer] |
| OnCalendar=*-*-* 01:30:00 | OnCalendar=*-*-01 00:30:00 |
| Persistent=true | Persistent=true |
| |
| |
| # End</code> | # End</code> |
| | |
| | sudo systemctl start 'wiki-m' && sudo systemctl status 'wiki-m' -l |
| |
| ====== Backup ====== | ====== Backup ====== |
| |
| * Create backup archive on server and transfer to client computer | ===== Files ===== |
| |
| ===== Server ===== | **** |
| |
| ==== Archive Folders ==== | sudo tar -czf ~/'dokuwiki-files-manual-'$(date +%Y-%m-%d)'.tar.gz' -C '/srv/www/wiki' 'data/pages' 'data/meta' 'data/media' 'data/media_meta' 'data/attic' 'data/media_attic' 'conf' |
| | |
| | ===== scp ===== |
| |
| **** | **** |
| |
| cd '/var/www/wiki' && sudo tar -cvzf ~/'dokuwiki-files-manual-'$(date +%Y-%m-%d)'.tar.gz' 'data/pages' 'data/meta' 'data/media' 'data/media_meta' 'data/attic' 'data/media_attic' 'conf' && cd ~ && sync | scp espionage724@192.168.1.152:~/'dokuwiki-files-'*'.tar.gz' ~/'Downloads' |
| |
| ===== Client ===== | ====== Restore ====== |
| |
| ==== Transfer Archive to Client ==== | ===== scp ===== |
| |
| **** | **** |
| |
| scp espionage724@192.168.1.152:~/'dokuwiki-files-'*'.tar.gz' ~/'Downloads' && sync | scp ~/'Downloads/dokuwiki-files-'*'.tar.gz' espionage724@192.168.1.152:~ |
| |
| ====== Restore ====== | ===== Stop nginx ===== |
| |
| ===== Client ===== | **** |
| | |
| | sudo systemctl stop 'nginx' |
| |
| ==== Transfer Archive to Server ==== | ===== Remove Existing Files ===== |
| |
| **** | **** |
| |
| scp ~/'Downloads/dokuwiki-files-'*'.tar.gz' espionage724@192.168.1.152:~ | ls ~/'dokuwiki-files-'*'.tar.gz' && sudo rm -Rf '/srv/www/wiki/data/pages' '/srv/www/wiki/data/meta' '/srv/www/wiki/data/media' '/srv/www/wiki/data/media_meta' '/srv/www/wiki/data/attic' '/srv/www/wiki/data/media_attic' '/srv/www/wiki/conf' |
| |
| ==== Remove Archive ==== | ===== Restore Files ===== |
| |
| **** | **** |
| |
| rm ~/'Downloads/dokuwiki-files-'*'.tar.gz' && sync | sudo tar -xzf ~/'dokuwiki-files-'*'.tar.gz' -C '/srv/www/wiki' 'data/pages' 'data/meta' 'data/media' 'data/media_meta' 'data/attic' 'data/media_attic' 'conf' && sudo chown -R 'wwwrun' '/srv/www/wiki' && sudo chmod -R '0755' '/srv/www/wiki' |
| |
| ===== Server ===== | ===== Git Fix ===== |
| |
| ==== Stop nginx ==== | * :!: Set email for ''user.email'' |
| |
| **** | sudo su 'wwwrun' -s '/bin/bash' |
| |
| sudo systemctl stop 'nginx' | rm -Rf '/srv/www/wiki/.git' |
| |
| ==== Remove Previous Folders ==== | git -C '/srv/www/wiki' init --initial-branch='master' |
| |
| **** | git -C '/srv/www/wiki' add '.' |
| |
| 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' | git -C '/srv/www/wiki' config 'user.email' 'espionage724@x' |
| |
| ==== Restore Folders ==== | git -C '/srv/www/wiki' commit --message='x' |
| |
| **** | git -C '/srv/www/wiki' remote add 'origin' 'https://github.com/dokuwiki/dokuwiki.git' |
| |
| cd '/var/www/wiki' && sudo tar -xvzf ~/'dokuwiki-files-'*'.tar.gz' 'data/pages' 'data/meta' 'data/media' 'data/media_meta' 'data/attic' 'data/media_attic' 'conf' && sudo restorecon -F -I -R '/var/www/wiki' && sudo chown -R 'nginx':'nginx' '/var/www/wiki' && cd ~ && sync | git -C '/srv/www/wiki' pull --depth '1' --recurse-submodules 'origin' 'master' --rebase |
| |
| ==== Start nginx ==== | git -C '/srv/www/wiki' reset --hard 'origin/master' |
| | |
| | git -C '/srv/www/wiki' gc --aggressive --prune='all' |
| | |
| | git -C '/srv/www/wiki' fsck --full --strict |
| | |
| | exit |
| | |
| | ===== Start nginx ===== |
| |
| **** | **** |
| sudo systemctl start 'nginx' | sudo systemctl start 'nginx' |
| |
| ==== Remove Archive ==== | ===== Clean-up ===== |
| |
| * Verify that DokuWiki works before running | **** |
| |
| rm -R ~/'dokuwiki-files-'*'.tar.gz' && sync | rm -fv ~/'dokuwiki-files-'*'.tar.gz' |
| |