Modify documentation to reflect PORT variable and default to 8080

This commit is contained in:
Neyder Achahuanco Apaza 2022-10-23 09:54:46 -05:00
parent 847d1e9e76
commit 70c390c7d1
2 changed files with 12 additions and 3 deletions

View File

@ -9,14 +9,23 @@ With local ZIM file(s)
* Given `wikipedia.zim` and `wiktionary.zim` reside in `/tmp/zim/`, execute the following: * Given `wikipedia.zim` and `wiktionary.zim` reside in `/tmp/zim/`, execute the following:
```bash ```bash
docker run -v /tmp/zim:/data -p 8080:80 kiwix/kiwix-serve wikipedia.zim wiktionary.zim docker run -v /tmp/zim:/data -p 8080:8080 kiwix/kiwix-serve wikipedia.zim wiktionary.zim
``` ```
With remote ZIM file With remote ZIM file
-------------------- --------------------
```bash ```bash
docker run -e "DOWNLOAD=https://download.kiwix.org/zim/wikipedia_bm_all.zim" -p 8080:80 kiwix/kiwix-serve docker run -e "DOWNLOAD=https://download.kiwix.org/zim/wikipedia_bm_all.zim" -p 8080:8080 kiwix/kiwix-serve
```
Change default port
-------------------
You can change port to expose with environment PORT, useful if running on Podman, K8s or OpenShift
```bash
podman run -e "DOWNLOAD=https://download.kiwix.org/zim/wikipedia_bm_all.zim" -e PORT=8888 -p 8080:8888 kiwix/kiwix-serve
``` ```
ARM ARM

View File

@ -2,7 +2,7 @@ version: '3.3'
services: services:
kiwix-serve: kiwix-serve:
ports: ports:
- 8080:80 - 8080:8080
image: kiwix/kiwix-serve image: kiwix/kiwix-serve
# uncomment next 4 lines to use it with local zim file in /tmp/zim # uncomment next 4 lines to use it with local zim file in /tmp/zim
# volumes: # volumes: