1
0
mirror of https://github.com/tiyn/wiki.git synced 2025-12-31 20:19:46 +01:00

added kiwix

This commit is contained in:
2025-12-23 02:11:35 +01:00
parent db0822bb6c
commit eb2011ac30
2 changed files with 63 additions and 0 deletions

View File

@@ -0,0 +1,41 @@
# /maintainer/ - /name/
This is a [Docker](/wiki/docker.md) container for a [Kiwix](/wiki/kiwix.md) server.
The official container and documentation was made by
[kiwix](https://github.com/kiwix/kiwix-tools/pkgs/container/kiwix-serve).
## Set-up
Create the file `rebuild.sh`.
Make sure to place the `.zim` files inside the volume.
Change the settings according to your needs and run `./rebuild.sh` afterwards.
## Ports
Set the following ports in the `ports:` section.
| Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | --------- | ------------- |
| `80` | `80` | TCP | WebUI |
## Volumes
Set the following volumes with the -v tag.
| Outside mount/volume name | Container mount | Description |
| ------------------------- | --------------- | -------------- |
| `kiwix_data` | `/data` | Data directory |
## rebuild.sh
```sh
docker stop kiwix-serve
docker rm kiwix-serve
docker pull ghcr.io/kiwix/kiwix-serve
docker run --name kiwix-serve \
--restart unless-stopped \
-v kiwix_data:/data \
-p 80:80 \
-d ghcr.io/kiwix/kiwix-serve \
*.zim
```

22
wiki/kiwix.md Normal file
View File

@@ -0,0 +1,22 @@
# Kiwix
[Kiwix](https://kiwix.org) is a open-source software that allows to save web content like Wikipedia
or Stack Overflow locally and for offline usage.
## Setup
The software can be setup via [Docker](/wiki/docker.md) with the
[kiwix image](/wiki/docker/kiwix_-_kiwix-serve.md).
## Usage
This section addresses the usage of kiwix.
### Download content
The content to display using Kiwix has to be acquired as a `.zim` file.
The official collection of these files can be found on the
[official website](https://library.kiwix.org/).
For [Docker](/wiki/docker.md) the `.zim` files need to be placed accordingly to the
[corresponding article](/wiki/docker/kiwix_-_kiwix-serve.md).
After the downloading the files, Kiwix may have to be restarted.