dshap/wiki

By dshap

•Updated 12 days ago

Docker image for wiki web server

Image

Web servers

Content management system

331

Overview Tags

dshap/wiki repository overview

⁠Wiki web server

Docker image for wiki web server.

Container runs as non-root user. This user owns wiki process and owns wiki files.

To run container next volumes should be mapped:

folder for SQL database
folder for wiki images
logs folder
backups folder

⁠Installation

⁠Installation from docker image

Pull docker image
Create user and group to own wiki files and to run docker container:
```
sudo groupadd -g 1192 wiki
```
```
useradd -u 1192 -g 1192 -M wiki
```
Proceed to configuration

⁠Installation from source

Pull project sources from version control system
Create user and group to own wiki files and to run docker container:
```
sudo useradd -r wiki
```
```
sudo groupmod -g 1192 wiki
```
```
sudo usermod -u 1192 wiki
```
Make build executable:
```
sudo chmod u+x ./build
```
Execute build:
```
sudo ./build wiki
```
Proceed to configuration

⁠Configuration

Obtain configuration files and scripts from the container:

cd ~

mkdir conf

sudo chown wiki:wiki ~/conf

sudo docker run \
    --rm \
    -v ~/conf:/export \
    dshap/wiki:1.43.9 export-assets

Create folders for wiki files:

sudo mkdir /wiki

sudo mkdir /wiki/db

sudo mkdir /wiki/images

sudo chown -R wiki:wiki /wiki

Create a folder for logs:

sudo mkdir /var/log/wiki

sudo chown -R wiki:wiki /var/log/wiki

Create a folder for backups:

sudo mkdir /var/backups/wiki

sudo chown -R wiki:wiki /var/backups/wiki

Copy service configuration file:

sudo cp ~/conf/etc/init.d/wiki /etc/init.d

sudo chmod a+x /etc/init.d/wiki

Copy docker run script:

sudo cp ~/conf/usr/sbin/wiki /usr/sbin

sudo chmod a+x /usr/sbin/wiki

Copy util script:

sudo cp ~/conf/usr/bin/wkutil /usr/bin

sudo chmod a+x /usr/bin/wkutil

Remove temporary config folder:
```
sudo rm -rf ~/conf
```
Register service:
```
sudo update-rc.d wiki defaults
```

Specify database root password in /usr/sbin/wiki file:

docker run ... -e DB_ROOT_PASSWORD="<some_password>" ...

Specify wiki database user password in /usr/sbin/wiki file:
```
docker run ... -e DB_USER_PASSWORD="<some_password>" ...
```
Specify wiki server URL in /usr/sbin/wiki file:
```
docker run ... -e SERVER="<some_server>" ...
```

Specify wiki language code in /usr/sbin/wiki file:

docker run ... -e LANGUAGE_CODE="<some_language_code>" ...

Start wiki service:
```
sudo service wiki start
```
Initialize wiki database:
```
sudo wkutil initialize
```
Obtain the generated secret key and upgrade key from the output
Specify wiki secret key in /usr/sbin/wiki file:
```
docker run ... -e SECRET_KEY="<some_key>" ...
```
Specify wiki upgrade key in /usr/sbin/wiki file:
```
docker run ... -e UPGRADE_KEY="<some_key>" ...
```
Restart wiki service:
```
sudo service wiki restart
```
Log in to the interface and change the admin password, default login/password is admin/password1%

⁠Management

⁠Service management

sudo service wiki (start|stop|status|restart)

⁠Create backup

sudo wkutil backup <filename>

Backup file /var/backups/wiki/<filename>.tar.gz will be created.

⁠Restore backup

sudo wkutil restore <filename>

⁠Command line (bash)

sudo wkutil bash

⁠Apache mod_proxy configuration

Wiki web server can be located with another web applications. For example, mercurial, bugzilla, wiki etc can be run as docker containers on the same host. In this case apache server can be used to redirect requests to different docker containers.

Enable apache mod_proxy:

sudo a2enmod deflate headers proxy proxy_ajp proxy_balancer proxy_connect proxy_html proxy_http rewrite

Configure proxy:

<VirtualHost *:80>
    ...
    ProxyPreserveHost On
    <Proxy *>
        Order allow,deny
        Allow from all
    </Proxy>
    ...
</VirtualHost>

Copy site configuration file:

sudo cp ~/conf/etc/apache2/sites-available/wiki.conf /etc/apache2/sites-available

Enable apache sites:
```
sudo a2ensite wiki
```
Restart apache service:
```
sudo service apache2 restart
```

⁠HOW TO

⁠How to change database root password

Stop wiki service:
```
sudo service wiki stop
```
Specify new database root password in /usr/sbin/wiki file:
```
docker run ... -e DB_ROOT_PASSWORD="<new_password>" ...
```
Start wiki service:
```
sudo service wiki start
```

Run the following command:

sudo wkutil change-root-password "<old_password>"

⁠How to change database user password

Stop wiki service:
```
sudo service wiki stop
```
Specify new wiki database user password in /usr/sbin/wiki file:
```
docker run ... -e DB_USER_PASSWORD="<new_password>" ...
```
Start wiki service:
```
sudo service wiki start
```
Run the following command
```
sudo wkutil change-user-password
```

⁠How to specify special characters in password

Special characters should be escaped:

docker run ... -e DB_ROOT_PASSWORD="pa\$\$word" ...

docker run ... -e DB_USER_PASSWORD="pas\$11" ...

⁠How to change skin

Stop wiki service:
```
sudo service wiki stop
```

Specify skin name in /usr/sbin/wiki file:

docker run ... -e DEFAULT_SKIN="<skin>" ...

Start wiki service:
```
sudo service wiki start
```

⁠How to perform maintenance operations

Connect to container:
```
sudo wkutil bash
```
Go to wiki root folder:
```
cd /var/www/html/wiki
```
Perform PHP scripts, for example:
```
php maintenance/update.php
```

⁠How to stop MariaDB correctly (in case of upgrades from an old version)

In one terminal run MariaDB:

sudo docker run --rm \
    --name mariadb104 \
    -v /wiki/db:/wiki/db \
    mariadb:10.4 mysqld --user=root --datadir=/bugzilla/db

Wait until log appears that MariaDB is ready to accept connections
In another terminal stop MariaDB:
```
sudo docker stop mariadb104
```

⁠How to create cron job for backups

sudo crontab -l | { cat; echo "minute hour * * * /usr/bin/wkutil backup <filename>"; echo ""; } | sudo crontab -

Tag summary

Recent tags

Content type

Image

Digest

Size

491.6 MB

Last updated

about 5 years ago

docker pull dshap/wiki