Skip to content
hgy59 edited this page Dec 8, 2022 · 4 revisions

Quick Start for Kiwix package

  1. Installation with the default settings
    This will create a shared folder /volume1/kiwix-share and create an empty library file /volume1/kiwix-share/library.xml. After sucessful installation, the state of kiwix is Running.

  2. Open the kiwix page on your diskstation in the web browser with the url http://<ip-of-your-diskstation>:8092. It will show an empty kiwix page.

  3. Download a zim file to the shared folder
    Download content from kiwix wiki page with Content in all languages in your prefered language.
    For example download the gutenberg project in german and save the file gutenberg_de_all_2021-10.zim in the kiwix-share folder.
    You can use the direct download or download with bittorrent protocol.

  4. Add the ZIM File to the library
    login into your diskstation with ssh and execute the following command:

    $ kiwix-manage /volume1/kiwix-share/library.xml add /volume1/kiwix-share/gutenberg_de_all_2021-10.zim
    
  5. Open the Content on your kiwix page - refresh page of pos. 2 and navigate into Project Gutenberg.

Hints

If you don't want to use ssh to login into the diskstation, you can use an alternate approach.

Create a script file with the command(s) you want to execute and make sure the file has unix line endings. To make the (error) output visible, redirect output to a text file.

job.sh

#!/bin/bash

kiwix-manage /volume1/kiwix-share/library.xml add /volume1/kiwix-share/gutenberg_de_all_2021-10.zim &> /volume1/kiwix-share/job.out.txt

To execute the script, open the Control Panel in your DiskStation and select Task Scheduler. Create a Scheduled Task with a user defined script. For manual execution select a Schedule running on a date in the past. In Task Settings under Run command define the user-defined script: bash /volume1/kiwix-share/job.sh. To execute your script just run the Task. Under Action - View Result you can see the Current status. Normal (0) stands for success. Otherwise you can find the error in job.out.txt.

You can adjust the script and execute it as you want.

To show the details of the library use the command:

kiwix-manage /volume1/kiwix-share/library.xml show &> /volume1/kiwix-share/job.out.txt

Clone this wiki locally