Difference between revisions of "Zimwriterfs instructions"

Jump to navigation Jump to search
Update docker image name to use "new" ghcr.io location
(I added a paragraph about how to archive websites with this tool)
(Update docker image name to use "new" ghcr.io location)
 
(2 intermediate revisions by one other user not shown)
Line 28: Line 28:
- you can now start zimwriterfs with a command like the following one. With this command, the shared folder is at <code>/data</code> in the running Docker image.
- you can now start zimwriterfs with a command like the following one. With this command, the shared folder is at <code>/data</code> in the running Docker image.
<code>
<code>
docker run -it -v $(pwd):/data/dist openzim/zimwriterfs zimwriterfs ...
docker run -it -v $(pwd):/data/dist ghcr.io/openzim/zimwriterfs zimwriterfs ...
</code>
</code>


[https://github.com/openzim/zimit Zimit] uses the Web ARChive standard, which is preferable over wget. However since the implementation is as of 2022 incompatible with Kiwix-desktop, you might want to have a look at [https://github.com/ballerburg9005/wget-2-zim wget-2-zim].
=== Running zimwritefs in a script with wget to archive websites ===
 
[https://github.com/openzim/zimit Zimit] uses the WebARChive standard, which is preferable over wget. However as of 2022 the implementation is incompatible with Kiwix-Desktop. You might want to have a look at [https://github.com/ballerburg9005/wget-2-zim wget-2-zim].


== Examples of using zimwriterfs ==
== Examples of using zimwriterfs ==


<code>
<code>
docker run -it -v $(pwd):/data openzim/zim-tools zimwriterfs -w index.html -I icon.png -l eng -t "Testing Heuristics" -d "Early cut of the testing heuristics material." -c "Julian Harty" -p "Commercetest Ltd." /data/dist /data/th-ln.zim
docker run -it -v $(pwd):/data ghcr.io/openzim/zim-tools zimwriterfs -w index.html -I icon.png -l eng -t "Testing Heuristics" -d "Early cut of the testing heuristics material." -c "Julian Harty" -p "Commercetest Ltd." /data/dist /data/th-ln.zim


docker run -it -v $(pwd):/data openzim/zim-tools zimwriterfs -w index.html -I tess.png -l eng -t "Visions for Teaching and Learning" -d "Sample TESS content: Week 1" -c "Open University" -p "Julian Harty" /data/dist /data/week1.zim
docker run -it -v $(pwd):/data ghcr.io/openzim/zim-tools zimwriterfs -w index.html -I tess.png -l eng -t "Visions for Teaching and Learning" -d "Sample TESS content: Week 1" -c "Open University" -p "Julian Harty" /data/dist /data/week1.zim
</code>
</code>


12

edits

Navigation menu