10
edits
Difference between revisions of "Zimwriterfs instructions"
Jump to navigation
Jump to search
→Configuring and Running Docker: Added heading for the examples
Julianharty (talk | contribs) (→zimwriterfs instructions: Added link to Docker image.) |
Julianharty (talk | contribs) (→Configuring and Running Docker: Added heading for the examples) |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 12: | Line 12: | ||
[1] I added a shared folder so I could easily share data between the running Docker image and my macbook. This had to be configured using the command line. See https://github.com/rocker-org/rocker/wiki/Sharing-files-with-host-machine for tips on how to do this. | [1] I added a shared folder so I could easily share data between the running Docker image and my macbook. This had to be configured using the command line. See https://github.com/rocker-org/rocker/wiki/Sharing-files-with-host-machine for tips on how to do this. | ||
=== Configuring and Running Docker === | |||
Again some qualifications: | |||
* I've limited experience in using Docker. | |||
* This worked for me but might need tweaking for others. | |||
* I use Kitematic (available in Docker) to obtain a shell in the running Docker image. | |||
Here's how to share the current folder with the Docker image. The shared folder is at <code>/Volumes/shared</code> in the running Docker image. | |||
<code> | |||
docker run -it -v $(pwd):/Volumes/shared -p 8888:8888 openzim/zimwriterfs | |||
</code> | |||
== Examples of using zimwriterfs == | |||
<code> | <code> | ||
zimwriterfs --uniqueNamespace -w index.html -f icon.png -l EN -t "Testing Heuristics" -d "Early cut of the testing heuristics material." -c "Julian Harty" -p "Commercetest Ltd." /Volumes/shared/dist/ /Volumes/shared/th-ln.zim | zimwriterfs --uniqueNamespace -w index.html -f icon.png -l EN -t "Testing Heuristics" -d "Early cut of the testing heuristics material." -c "Julian Harty" -p "Commercetest Ltd." /Volumes/shared/dist/ /Volumes/shared/th-ln.zim | ||
zimwriterfs -w index.html -f tess.png -l EN -t "Visions for Teaching and Learning", -d "Sample TESS content: Week 1" -c "Open University" -p "Julian Harty" /Volumes/shared/week_1__visions_for_teaching_and_learning.html/ /Volumes/shared/week1.zim | |||
</code> | </code> | ||
== Test the ZIM locally == | == Test the ZIM locally == | ||
Use at least one reader e.g. a Kiwix app or server to test the ZIM file contains the expected contents. The Welcome page is displayed, CSS is applied, Images appear, etc. | |||
== Known issues == | |||
Symlinks to content cause zimwriterfs to abort https://github.com/openzim/libzim/issues/16 | |||