mirror of
https://github.com/kiwix/kiwix-tools.git
synced 2025-09-22 11:22:38 -04:00
Merge pull request #608 from kiwix/ghcr
removed references to docker.io
This commit is contained in:
commit
4e992a18e8
18
.github/workflows/docker.yml
vendored
18
.github/workflows/docker.yml
vendored
@ -11,16 +11,15 @@ on:
|
|||||||
jobs:
|
jobs:
|
||||||
build-and-push-kiwix-tools:
|
build-and-push-kiwix-tools:
|
||||||
name: Deploy kiwix-tools Docker Image
|
name: Deploy kiwix-tools Docker Image
|
||||||
runs-on: ubuntu-20.04
|
runs-on: ubuntu-22.04
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v3
|
- uses: actions/checkout@v3.4.0
|
||||||
- name: build and publish kiwix-tools
|
- name: build and publish kiwix-tools
|
||||||
uses: openzim/docker-publish-action@v9
|
uses: openzim/docker-publish-action@v10
|
||||||
with:
|
with:
|
||||||
image-name: kiwix/kiwix-tools
|
image-name: kiwix/kiwix-tools
|
||||||
|
registries: ghcr.io
|
||||||
credentials: |
|
credentials: |
|
||||||
DOCKERIO_USERNAME=${{ secrets.DOCKERHUB_USERNAME }}
|
|
||||||
DOCKERIO_TOKEN=${{ secrets.DOCKERHUB_PASSWORD }}
|
|
||||||
GHCRIO_USERNAME=${{ secrets.GHCR_USERNAME }}
|
GHCRIO_USERNAME=${{ secrets.GHCR_USERNAME }}
|
||||||
GHCRIO_TOKEN=${{ secrets.GHCR_TOKEN }}
|
GHCRIO_TOKEN=${{ secrets.GHCR_TOKEN }}
|
||||||
context: docker
|
context: docker
|
||||||
@ -38,17 +37,16 @@ jobs:
|
|||||||
|
|
||||||
build-and-push-kiwix-serve:
|
build-and-push-kiwix-serve:
|
||||||
name: Deploy kiwix-serve Docker Image
|
name: Deploy kiwix-serve Docker Image
|
||||||
runs-on: ubuntu-20.04
|
runs-on: ubuntu-22.04
|
||||||
needs: build-and-push-kiwix-tools
|
needs: build-and-push-kiwix-tools
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v3
|
- uses: actions/checkout@v3.4.0
|
||||||
- name: build and publish kiwix-serve
|
- name: build and publish kiwix-serve
|
||||||
uses: openzim/docker-publish-action@v9
|
uses: openzim/docker-publish-action@v10
|
||||||
with:
|
with:
|
||||||
image-name: kiwix/kiwix-serve
|
image-name: kiwix/kiwix-serve
|
||||||
|
registries: ghcr.io
|
||||||
credentials: |
|
credentials: |
|
||||||
DOCKERIO_USERNAME=${{ secrets.DOCKERHUB_USERNAME }}
|
|
||||||
DOCKERIO_TOKEN=${{ secrets.DOCKERHUB_PASSWORD }}
|
|
||||||
GHCRIO_USERNAME=${{ secrets.GHCR_USERNAME }}
|
GHCRIO_USERNAME=${{ secrets.GHCR_USERNAME }}
|
||||||
GHCRIO_TOKEN=${{ secrets.GHCR_TOKEN }}
|
GHCRIO_TOKEN=${{ secrets.GHCR_TOKEN }}
|
||||||
context: docker/server
|
context: docker/server
|
||||||
|
10
README.md
10
README.md
@ -9,8 +9,8 @@ command line tools:
|
|||||||
|
|
||||||
[](https://download.kiwix.org/release/kiwix-tools/)
|
[](https://download.kiwix.org/release/kiwix-tools/)
|
||||||
[](https://github.com/kiwix/kiwix-tools/wiki/Repology)
|
[](https://github.com/kiwix/kiwix-tools/wiki/Repology)
|
||||||
[](https://hub.docker.com/r/kiwix/kiwix-tools)
|
[](https://ghcr.io/kiwix/kiwix-tools)
|
||||||
[&sort=date)](https://hub.docker.com/r/kiwix/kiwix-serve)
|
[)](https://ghcr.io/kiwix/kiwix-tools)
|
||||||
[](https://apps.sandstorm.io/app/5uh349d0kky2zp5whrh2znahn27gwha876xze3864n0fu9e5220h)
|
[](https://apps.sandstorm.io/app/5uh349d0kky2zp5whrh2znahn27gwha876xze3864n0fu9e5220h)
|
||||||
[](https://github.com/kiwix/kiwix-tools/actions?query=branch%3Amain)
|
[](https://github.com/kiwix/kiwix-tools/actions?query=branch%3Amain)
|
||||||
[](https://kiwix-tools.readthedocs.org/en/latest/?badge=latest)
|
[](https://kiwix-tools.readthedocs.org/en/latest/?badge=latest)
|
||||||
@ -113,10 +113,10 @@ Like for the installation, you might need to run the command as `root`
|
|||||||
Docker
|
Docker
|
||||||
------
|
------
|
||||||
|
|
||||||
An official Docker image of the Kiwix tools can be found in the
|
An official Docker image of the Kiwix tools can be found on
|
||||||
[Docker Hub](https://hub.docker.com/r/kiwix/kiwix-tools). A
|
[GHCR](https://ghcr.io/kiwix/kiwix-tools). A
|
||||||
`kiwix-serve` dedicated Docker image [exists
|
`kiwix-serve` dedicated Docker image [exists
|
||||||
too](https://hub.docker.com/r/kiwix/kiwix-serve).
|
too](https://ghcr.io/kiwix/kiwix-serve).
|
||||||
|
|
||||||
Troubleshooting
|
Troubleshooting
|
||||||
---------------
|
---------------
|
||||||
|
@ -1,14 +1,14 @@
|
|||||||
Kiwix-tools Docker image
|
Kiwix-tools Docker image
|
||||||
===
|
===
|
||||||
|
|
||||||
- Available on [docker.io](https://hub.docker.com/r/kiwix/kiwix-tools) and [ghcr.io](https://ghcr.io/kiwix/kiwix-tools).
|
- Available on [ghcr.io](https://ghcr.io/kiwix/kiwix-tools).
|
||||||
- multi-arch (`linux/amd64`, `linux/arm64`, `linux/arm/v7`)
|
- multi-arch (`linux/amd64`, `linux/arm64`, `linux/arm/v7`)
|
||||||
- based on official `kiwix-tools` binaries.
|
- based on official `kiwix-tools` binaries.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
``` sh
|
``` sh
|
||||||
$ docker run -it kiwix/kiwix-tools:3.1.2
|
$ docker run -it ghcr.io/kiwix/kiwix-tools:3.1.2
|
||||||
|
|
||||||
Welcome to kiwix-tools! The following binaries are available:
|
Welcome to kiwix-tools! The following binaries are available:
|
||||||
kiwix-manage kiwix-search kiwix-serve
|
kiwix-manage kiwix-search kiwix-serve
|
||||||
@ -17,7 +17,7 @@ kiwix-manage kiwix-search kiwix-serve
|
|||||||
`kiwix-tools` operates on zim files. You shall mount a volume to access the files.
|
`kiwix-tools` operates on zim files. You shall mount a volume to access the files.
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
docker run -v $(pwd):/data -it kiwix/kiwix-tools kiwix-search /data/wikipedia_fr_test.zim "Mali"
|
docker run -v $(pwd):/data -it ghcr.io/kiwix/kiwix-tools kiwix-search /data/wikipedia_fr_test.zim "Mali"
|
||||||
```
|
```
|
||||||
|
|
||||||
## Building and reusing
|
## Building and reusing
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
ARG VERSION=latest
|
ARG VERSION=latest
|
||||||
|
|
||||||
# kiwix-tools is multi-arch
|
# kiwix-tools is multi-arch
|
||||||
FROM kiwix/kiwix-tools:$VERSION
|
FROM ghcr.io/kiwix/kiwix-tools:$VERSION
|
||||||
LABEL org.opencontainers.image.source https://github.com/openzim/kiwix-tools
|
LABEL org.opencontainers.image.source https://github.com/openzim/kiwix-tools
|
||||||
|
|
||||||
# expose kiwix-serve default port and workdir
|
# expose kiwix-serve default port and workdir
|
||||||
|
@ -9,14 +9,14 @@ 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:8080 kiwix/kiwix-serve wikipedia.zim wiktionary.zim
|
docker run -v /tmp/zim:/data -p 8080:8080 ghcr.io/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:8080 kiwix/kiwix-serve
|
docker run -e "DOWNLOAD=https://download.kiwix.org/zim/wikipedia_bm_all.zim" -p 8080:8080 ghcr.io/kiwix/kiwix-serve
|
||||||
```
|
```
|
||||||
|
|
||||||
Change default port
|
Change default port
|
||||||
@ -25,7 +25,7 @@ Change default port
|
|||||||
You can change port to expose with environment variable PORT, useful if running on Podman, K8s or OpenShift
|
You can change port to expose with environment variable PORT, useful if running on Podman, K8s or OpenShift
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
podman run -e "DOWNLOAD=https://download.kiwix.org/zim/wikipedia_bm_all.zim" -e PORT=8888 -p 8080:8888 kiwix/kiwix-serve
|
podman run -e "DOWNLOAD=https://download.kiwix.org/zim/wikipedia_bm_all.zim" -e PORT=8888 -p 8080:8888 ghcr.io/kiwix/kiwix-serve
|
||||||
```
|
```
|
||||||
|
|
||||||
ARM
|
ARM
|
||||||
@ -33,7 +33,7 @@ ARM
|
|||||||
|
|
||||||
Build an image for an ARM based GNU/Linux:
|
Build an image for an ARM based GNU/Linux:
|
||||||
```bash
|
```bash
|
||||||
docker build . -t kiwix/kiwix-serve:latest --build-arg ARCH="arm32v7/"
|
docker build . -t ghcr.io/kiwix/kiwix-serve:latest --build-arg ARCH="arm32v7/"
|
||||||
```
|
```
|
||||||
|
|
||||||
You can also deploy kiwix with [`docker-compose`](https://docs.docker.com/compose/). Check out a sample at [docker-compose.yml.example](docker-compose.yml.example)
|
You can also deploy kiwix with [`docker-compose`](https://docs.docker.com/compose/). Check out a sample at [docker-compose.yml.example](docker-compose.yml.example)
|
||||||
|
Loading…
x
Reference in New Issue
Block a user