nautilus turns a collection of documents into a browsable ZIM file.
It downloads the video (webm or mp4 format – optionally recompress it in lower-quality, smaller size), the thumbnails, the subtitles and the authors' profile pictures ; then, it creates a static HTML files folder of it before creating a ZIM off of it.
To be used with nautilus, your archive should be a ZIP file.
- it doesn't need to be structured, but it can.
- it doesn't need to be compressed. It's usually recommended not to.
- it should contain a
collection.jsonfile, but it can also be provided separately (see below). - it should only contain to-be-included files. No filtering is done.
- Audio and video files should be in ogg format with an
.ogg/.ogvextension to be supported on all platforms (mp3/mp4would work only on platforms with native support).
cd content/path
zip -r -0 -T ../content_name.zip *
Either inside the archive ZIP as /collection.json or elsewhere,
specified via --collection mycollection.json, you must supply a JSON file describing your content.
The user-interface only gives access to files referenced properly in the collection.
At the moment, the JSON file needs to provide the following fields for each item in an array:
[
{
"title": "...",
"description": "...",
"authors": "...",
"files": ["relative/path/to/file"]
}
]Either inside the archive ZIP as /about.html or elsewhere, specified via --about myabout.html,
- You may supply an about page in HTML format. It will be displayed in a modal popup and will be included.
- At its bottom your secondary-logo if provided.
- Use only content tags (no
<html />nor<head />nor<script />etc) - Use inline styling if required, but no styling is recommended.
- Include one logo inline if required.
wgetandunzipto install JS dependencies. Seeget_js_deps.shif you want to do it manually.wgetis used to download archive files as well.handlebarsis used to compile JS templates
nautilus is a python program. if you are not using the docker image, you are advised to use it in a virtual-environment. See requirements.txt for the list of python dependencies.
docker run -v my_dir:/output ghcr.io/openzim/nautilus nautiluszim --help
pip install nautiluszim
nautiluszim --help
nautiluszim --archive my-content.zip
- On macOS, the locale setting is buggy. You need to launch it with the
LANGUAGEenvironment variable (as ISO-639-1) for the translations to work.
LANGUAGE=fr nautiluszim --language fra
See CONTRIBUTING.md