kiwixm/README.md

Kiwix Manager

A web-based Kiwix management tool to create & upload zims as well as manage non zim files

---

Documentation • Release Notes • Report a Bug • Request a Feature

---

Table of Contents

• Kiwix Manager
  • About
    • Features
    • Built With
  • Setup
    • Production
    • Development
  • License

About

Kiwix Manager (KiwixM) is a comprehensive web-based management interface for Kiwix servers that extends beyond traditional ZIM file management. It provides both a powerful Kiwix library management system and an integrated file browser for non-ZIM content, making it a complete solution for offline content libraries.

Features

• Non-ZIM library browser + uploader integrated into Kiwix - Open the "Archive" book in Kiwix to browse and upload any file alongside your Kiwix content
• Kiwix management interface for updating library content - Full administrative control over your Kiwix server and ZIM library
• Upload ZIMs or download them from URLs - Flexible ZIM file management with local uploads and remote downloads
• Create ZIMs from URLs (zimmit) - Convert websites directly to ZIM files with customizable scraping options
• Create ZIMs from zips / files - Generate ZIM archives from your existing file collections
• Automatic ZIM indexing - We will automatically update your library.xml everytime Kiwix reboots

Built With

Setup

Production

Prerequisites

• Docker

Instructions

1. Run the docker image: docker run -d --name kiwix --restart unless-stopped -p 3000:3000 -v /media/library:/data ztimson/kiwixm:latest
2. Open http://localhost:3000
3. Access the admin panel at http://localhost:3000/admin

Development

Prerequisites

• Node.js
• Kiwix Tools (for ZIM file management)

Instructions

1. Install the dependencies: npm install
2. Start the server: npm run start
3. Open http://localhost:3000

License

Copyright © 2023 Zakary Timson | Available under MIT Licensing

See the license for more information.