How to document your software and hardware with DokuWiki

Looking for a location to house your documentation, checklists, and other bits of information and facts for your personnel? Jack Wallen exhibits you how to put in DokuWiki, which can serve this intent very well.

Image: Getty Photographs/iStockphoto

Your in-home info centre (or your cloud-dependent info center) is challenging. You could possibly have various typical products and services running these as world-wide-web servers, HRM tools, backup servers, info shares, and SaaS equipment, and many others. Or, you may possibly have a cluster whole of applications and expert services jogging.

Due to the fact of the amount of money of hardware and application you have up and functioning at any offered time, you in all probability need to be documenting how it was deployed, configured, and employed. You may have many checklists and policies that need to have to be produced readily available to personnel, admins, and developers, but how do you do that? You could make use of a straightforward Wiki server. One particular this kind of platform is the open supply DokuWiki, which involves capabilities like:

  • Easy to use interface and syntax

  • HTML embedding

  • Unlimited website page revisions

  • Colored facet-by-side diff assist

  • Graphic uploading/embedding

  • Customizable Interwiki back links

  • Section enhancing

  • Computerized desk of contents era

  • File locking

  • Customizable layout (via templates)

  • LDEP, MySQL, and Postgres assist

I’m likely to wander you through deploying DokuWiki on Ubuntu Server 20.04.

SEE: MSP ideal practices: Server deployment checklist (TechRepublic High quality)

What you’ll want

How to set up Apache and PHP

The initial detail we need to do is install the Apache website server and the essential PHP parts. Log in to your Ubuntu Server and put in Apache with the command:

sudo apt-get install apache2 -y

Now we can put in the needed PHP components with the command:

sudo apt-get set up php php-gd php-xml php-json -y

With all those installations entire, begin and empower Apache with the command:

sudo systemctl allow --now apache2

How to obtain, unpack, and shift DokuWiki

In get to put in DokuWiki, we will need to down load it, unpack it, and relocate it to the Apache document root. 

Download the latest model of DokuWiki with the command:

wget https://download.dokuwiki.org/src/dokuwiki/dokuwiki-steady.tgz

Unpack the compressed tar file with the command:

tar xvzf dokuwiki-stable.tgz

Go and rename the newly-developed listing with the command:

sudo mv dokuwiki-XXX /var/www/html/dokuwiki

Exactly where XXX is the launch quantity.

Copy the sample .htaccess file with the command:

sudo cp /var/www/html/dokuwiki/.htaccess.dist,

Change the possession of the DokuWiki folder with the command:

sudo chown -R www-data:www-knowledge /var/www/html/dokuwiki

How to configure Apache

At the minute, Apache has no way of recognizing about the new set up. To make it aware, we’ll produce a configuration file for DokuWiki. Create the new file with the command:

sudo nano /etc/apache2/websites-readily available/dokuwiki.conf

In that file, paste the following:


        ServerName    dokuwiki.instance.com      
        DocumentRoot  /var/www/html/dokuwiki

        
            
                AllowOverride All
                Require all denied
            
            
                Order allow,deny
                Deny from all
            
        

        ErrorLog   /var/log/apache2/dokuwiki_error.log
        CustomLog  /var/log/apache2/dokuwiki_entry.log blended

If you can expect to be applying a area, make confident to change the ServerName selection you see higher than.

Conserve and near the file.

Enable the new site with the command:

sudo a2ensite dokuwiki

Reload the Apache configuration data files with the command:

sudo systemctl reload apache2

How to end up the set up

Open up up a internet browser and place it to http://SERVER/put in.php (the place SERVER is the IP handle or domain of your web hosting server). You need to see the web-primarily based DokuWiki installer (Determine A).

Figure A

dokuwikia.jpg

The DokuWiki world wide web-centered installer is all set to entire your set up.

Fill out the needed facts and click on Help save. The installation must entire immediately and current you with a link that will choose you to the DokuWiki main website page, which is at http://SERVER/doku.php?id=wiki:welcome (the place SERVER is the IP deal with of the domain of your internet hosting server) (Determine B).

Figure B

dokuwikib.jpg

The DokuWiki world-wide-web-centered installer is completely ready to entire your installation.

That is it. You’re now completely ready to commence making a Wiki web-site to document your hardware, application, containers, and additional. This is a terrific way to keep your developers and admins in the know about what is actually going on with your deployments. You could even use this resource to dwelling things like checklists for admins and builders. Just make positive you retain this Wiki harmless from prying eyes–you should not ever use a software like this as any sort of password manager. Normally continue to keep your passwords locked away in a proper password manager. DokuWiki (and comparable applications) are terrific for documentation, but not so great at trying to keep secrets and techniques secure.

Subscribe to TechRepublic’s How To Make Tech Function on YouTube for all the latest tech guidance for company pros from Jack Wallen.

Also see

Fibo Quantum