SGH_WIKI

User Tools

Site Tools

Trace: • malay
mywiki:experience:dokuwiki

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
mywiki:experience:dokuwiki [2020/08/16 10:16] – [Backup Dokuwiki] supermywiki:experience:dokuwiki [2025/07/22 20:48] (current) – [Secure dokuwiki in conf/local.php] gshao
Line 1: Line 1:
 +**DokuWIKI Experience and skill**
 +Reference: [[https://www.dokuwiki.org/wiki:syntax#tables|Wiki Formatting Syntax]]
 +
 +======= WIKI Directory Layout =======
 +Main Directory layout as below. For details, refer to https://www.dokuwiki.org/devel:dirlayout
 +  * **conf** – Configuration data is stored here
 +  * **data** – All data that is written by DokuWiki is stored here (see savedir)
 +  * **attic** – old page revisions are stored here, it contains namespaces directories
 +  * cache – DokuWiki creates cachefiles to speed things up 
 +  * index – Stores lookup tables for the fulltext search index -- No need to save, use plugin to re-generate   
 +  * **media** – Here are all image files stored, it contains namespaces directories
 +  * **media_attic**– old revisions of media files
 +  * **media_meta** – meta data for media files
 +  * **meta** – Stores meta data for pages, it contains namespaces directories, the time of last update, ...
 +  * **pages** – Here are the raw pages stored, it contains namespaces directories        
 +  * auth – Authentication backends (removed since 2013-05-10 Weatherwax)
 +Note: If the content stored in a wiki page is data, things like the time of last update, who updated it, the filesize etc. could all be regarded as metadata for the wiki page. This page describes where and how such additional data is stored in DokuWiki. The detail meta information refer to https://www.dokuwiki.org/devel:metadata#data_structure
 +
 +
 +====== Backup Dokuwiki ======
 +Official proposal to backup dokuwiki: Only below two folder is a must  
 +  * **data/pages**: for my wiki, it is data/pages/**mywiki**
 +  * **data/media**: for my wiki, it is data/media/**mywiki**
 +
 +If need to save version history, below 4 folders are needed
 +  * data/meta          
 +  * data/media_meta        
 +  * data/media_attic   
 +  * data/attic         
 +
 +Options since seldom change configuration
 +  * conf\acl.auth.php
 +  * conf\local.php
 +  * conf\plugins.local.php
 +  * conf\users.auth.php
 +    
 +Take note: no need to backup below folders
 +  * <del>data/cached</del>
 +  * <del>data/index</del>   Note: index can be rebuild with plugin **searchindex**
 +  * <del>data/locks</del>
 +  * <del>data/tmp</del>
 +
 +<code batch Windows_backup_script.bat>
 +@echo off
 +rem place this script in the parent directory of dokuBackup folder.
 +IF EXIST dokuBackup (
 +  echo dokuBackup already exist
 +  echo renaming ...
 +  IF EXIST dokuBackup_old (
 +    echo are you confused? dokuBackup_old already exist!
 +    exit /B 1
 +  ) ELSE (
 +    move /Y dokuBackup dokuBackup_old
 +  )
 +) ELSE (
 +  mkdir dokuBackup
 +)
 + 
 +ncftpget -R -u yourUsername -p yourPassword yourWebspaceFTPurl "./dokuBackup" "yourWebSpaceFtpDokuwikiPath/data/pages/mywiki"
 +ncftpget -R -u yourUsername -p yourPassword yourWebspaceFTPurl "./dokuBackup" "yourWebSpaceFtpDokuwikiPath/media/mywiki"
 +</code>
 +
 +<code bash bash_script.sh>
 +#!/bin/sh -e
 +# backup data from wiki (FTP)
 +unset
 +url="ftp://example.net/"
 +backup="/path/to/backup"
 +wget -q --no-cache -nH -c -t0 --mirror -P$backup -i- <<EOF
 +        $url/data/pages/mywiki
 +        $url/data/media/mywiki
 +
 +EOF
 +</code>
 +
 +====== Upgrade Dokuwiki to Web Hosting Site ======
 +**Firstly Fully delete original folders and files under dokuwiki in order to avoid old plugin mismatch and clean some old files:**
 +  * bin
 +  * conf: all files except **acl.auth.php, local.php, plugins.local.php, users.auth.php**
 +  * inc
 +  * lib
 +  * vendor
 +  * data folder:
 +    * data\media\wiki
 +    * data\pages\wiki
 +    * data\pages\playground
 +    * data\attic
 +    * data\cache
 +    * data\index
 +    * data\locks
 +    * data\media_attic
 +    * data\media_meta
 +    * data\meta
 +  * all files directly under dokuwiki, like .htaccess.dist, COPYING, doku.php and so on
 +
 +**Secondly upload new dokuwiki unzip files/folders via ftp**
 +
 +**Lastly reconfigure dokuwiki: dokuwiki/install.php **
 +  
 +====== Skill ====== 
 +
 +^Function ^ syntax ^ Example ^
 +| Escape pipe(%%|%%) | <nowiki>%%</nowiki> %%|%%  <nowiki>%%</nowiki> | <nowiki>%%</nowiki> %%|%%  <nowiki>%%</nowiki> |
 +| simple escape way to no format for single line with **nowiki** | <nowiki><nowiki>--</nowiki></nowiki> |  <nowiki><nowiki>--</nowiki></nowiki>. |
 +| simple escape way to no format for a block with **file** | <nowiki><file>--</file></nowiki> | <file>a b </file>|
 +| simple escape way to no format for a block with **file** | <nowiki><file bash t.sh>--</file></nowiki> | <file bash t.sh>ls -al </file>|
 +| simple escape way to no format for a block with **code** | <nowiki><code> a  b </code></nowiki> | <code>a
 +b </code> |
 +| Delete words with **del**| <nowiki><del>deleted</del</nowiki> | <del>deleted</del> |
 +| Create Paragraphs or forced line with **\\**  \\ Valid for WIKI Table also |  <nowiki> \\ Force line added here\\ force line1 \\ force line2 </file></nowiki> | Force line added here\\ force line1 \\ force line2 |
 +| iframe plugin test | [[dokuwiki_iframe|iframe example]] | [[dokuwiki_html example ]] |
 +
 +
 +====== Admin ======
 +===== Secure dokuwiki in conf/local.php =====
 +
 +| Goal | Setting |
 +| Disable public reset | $conf['disableactions'] = 'resendpwd'; |
 +| Disable register & reset | $conf['disableactions'] = 'register,resendpwd'; |
 +| Secure email reset (if enabled) | Configure SMTP settings properly in conf/local.php |
 +
 +===== Dokuwiki Gmail SMTP configuration =====
 +
 +  * Step 1: Enable 2FA & Create an App Password: Go to https://myaccount.google.com/
 +  * Enable 2-Step Verification (if not already).
 +  * Go to Security → App Passwords: https://myaccount.google.com/apppasswords
 +  * Create an app password:
 +    * App: Mail
 +    * Device: Other → Enter "DokuWiki"
 +    * Click Generate
 +  * Copy the 16-character app password.
 +
 +Add or update the following lines:
 +<code>
 +$conf['mailfrom']     = 'youraddress@gmail.com';
 +$conf['mailprefix']   = '[DokuWiki] ';
 +$conf['smtphost']     = 'smtp.gmail.com';
 +$conf['smtpport']     = 587;
 +$conf['authsmtp']     = 1;
 +$conf['smtpuser']     = 'youraddress@gmail.com';
 +$conf['smtppass']     = 'your_app_password_here';  // NOT your Gmail password!
 +$conf['securemail']   = 1;  // Enables TLS
 +
 +</code>
 +Replace youraddress@gmail.com and your_app_password_here with your Gmail and the app password from step 1.
 +