Add docker-compose for kiwix-server

kiwix / kiwix-tools

Command line Kiwix tools: kiwix-serve, kiwix-manage, ...

https://download.kiwix.org/release/kiwix-tools/

GNU General Public License v3.0

433 stars 85 forks source link

Add docker-compose for kiwix-server #504

Closed fazlerabbi37 closed 2 years ago

fazlerabbi37 commented 2 years ago

Add docker-compose for kiwix-server

run docker-compose with local file.
run docker-compose with remote file.

kelson42 commented 2 years ago

@fazlerabbi37 Which problem does it solve? Which value does in bring in comparison to a simple docker run?

fazlerabbi37 commented 2 years ago

@fazlerabbi37 Which problem does it solve? Which value does in bring in comparison to a simple docker run?

while it's true that docker-compose is used for managing multiple containers, but it can be useful for single container too. for example:

quick and easier to define and manage services, networks, volumes etc
get an app running in one command by just running docker-compose up
fast and simple
run the app and its related resources isolated network and environment

but for me, it's just easy to manage. I can cd into the kiwix-server and do docker-compose up -d.

kelson42 commented 2 years ago

@rgaudin I don't know what you think about this, but the value seems really too limited to me to justify we complexify the README.md. If you think differently, can you please handle the review process?

fazlerabbi37 commented 2 years ago

but the value seems really too limited to me to justify we complexify the README.md

@kelson42 sorry if I made a mess :sweat_smile:

what I can do is, separate the docker cli and docker-compose command. this would reinstate the README.me to the previous state and people who are interested in docker-compose can follow to compose part. would that be ok?

in any case, I am open to suggestions on ways to improve things. :smile:

rgaudin commented 2 years ago

@rgaudin I don't know what you think about this, but the value seems really too limited to me to justify we complexify the README.md. If you think differently, can you please handle the review process?

To me, the value of this is in documenting the various features of the image. I'd suggest we either keep the docker-compose.yml in the repo as an example or we keep its content into the README.

Or it could even achieve same result by just adding a couple descriptive lines in the Usage section of the README…

fazlerabbi37 commented 2 years ago

@rgaudin can you please check now?

fazlerabbi37 commented 2 years ago

@rgaudin just to be sure, docker-compose.yml goes back to this state with an empty line at the end? then rebase, right?

rgaudin commented 2 years ago

@rgaudin just to be sure, docker-compose.yml goes back to this state with an empty line at the end? then rebase, right?

Yes

Teraskull commented 2 years ago

I would suggest adding this example to commands:

command:
  - "*.zim"

Might be useful if there is a lot of ZIMs, instead of adding each filename manually.

rgaudin commented 2 years ago

I would suggest adding this example to commands:
command:
  - "*.zim"
Might be useful if there is a lot of ZIMs, instead of adding each filename manually.

Please do

fazlerabbi37 commented 2 years ago

Please do

@rgaudin done!

Teraskull commented 2 years ago

@fazlerabbi37 Can you also provide a docker compose link like this?

Since docker-compose is v1 and deprecated, and v2 is used as a docker plugin.

fazlerabbi37 commented 2 years ago

@fazlerabbi37 Can you also provide a docker compose link like this?

Since docker-compose is v1 and deprecated, and v2 is used as a docker plugin.

you mean in the README.md?

Teraskull commented 2 years ago

@fazlerabbi37 Yes

fazlerabbi37 commented 2 years ago

@fazlerabbi37 Yes

done! check now. :smile: