ztimson/kiwixm
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge branch 'master' of https://git.zakscode.com/ztimson/kiwixm
Some checks failed
Build Website / Tag Version (push) Successful in 6s
Details
Build Website / Build Dockerfile (push) Failing after 36s
Details

Browse Source
This commit is contained in:
Zakary Timson
2025-09-27 10:38:06 -04:00
parent 8e0c70365f 72fc307c09
commit 5ef08f3d1c
2 changed files with 107 additions and 104 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
LICENSE Normal file
View File

@@ -0,0 +1,7 @@
Copyright (c) 2023 Zakary Timson
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

204
README.md
View File

@@ -1,104 +1,100 @@
<!-- Header --> <!-- Header -->
<div id="top" align="center"> <div id="top" align="center">
<br /> <br />
<!-- Logo --> <!-- Logo -->
<img src="favicon.png" alt="Logo" width="200" height="200"> <img src="favicon.png" alt="Logo" width="200" height="200">
<!-- Title --> <!-- Title -->
### Kiwix Manager ### Kiwix Manager
<!-- Description --> <!-- Description -->
A web-based Kiwix management tool to create & upload zims as well as manage non zim files A web-based Kiwix management tool to create & upload zims as well as manage non zim files
<!-- Repo badges --> <!-- Repo badges -->
[![Version](https://img.shields.io/badge/dynamic/json.svg?label=Version&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/kiwixm/tags&query=$[0].name)](https://git.zakscode.com/ztimson/kiwixm/tags) [![Version](https://img.shields.io/badge/dynamic/json.svg?label=Version&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/kiwixm/tags%3Ftoken%3D35a3bf73a216782a7435f86117412bcb9784b716&query=$[0].name)](https://git.zakscode.com/ztimson/kiwixm/tags)
[![Pull Requests](https://img.shields.io/badge/dynamic/json.svg?label=Pull%20Requests&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/kiwixm&query=open_pr_counter)](https://git.zakscode.com/ztimson/kiwixm/pulls) [![Pull Requests](https://img.shields.io/badge/dynamic/json.svg?label=Pull%20Requests&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/kiwixm%3Ftoken%3D35a3bf73a216782a7435f86117412bcb9784b716&query=open_pr_counter)](https://git.zakscode.com/ztimson/kiwixm/pulls)
[![Issues](https://img.shields.io/badge/dynamic/json.svg?label=Issues&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/kiwixm&query=open_issues_count)](https://git.zakscode.com/ztimson/kiwixm/issues) [![Issues](https://img.shields.io/badge/dynamic/json.svg?label=Issues&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/kiwixm%3Ftoken%3D35a3bf73a216782a7435f86117412bcb9784b716&query=open_issues_count)](https://git.zakscode.com/ztimson/kiwixm/issues)
<!-- Links --> <!-- Links -->
--- ---
<div> <div>
<a href="https://git.zakscode.com/ztimson/kiwixm/wiki" target="_blank">Documentation</a> <a href="https://git.zakscode.com/ztimson/kiwixm/wiki" target="_blank">Documentation</a>
• <a href="https://git.zakscode.com/ztimson/kiwixm/releases" target="_blank">Release Notes</a> • <a href="https://git.zakscode.com/ztimson/kiwixm/releases" target="_blank">Release Notes</a>
• <a href="https://git.zakscode.com/ztimson/kiwixm/issues/new?template=.github%2fissue_template%2fbug.md" target="_blank">Report a Bug</a> • <a href="https://git.zakscode.com/ztimson/kiwixm/issues/new?template=.github%2fissue_template%2fbug.md" target="_blank">Report a Bug</a>
• <a href="https://git.zakscode.com/ztimson/kiwixm/issues/new?template=.github%2fissue_template%2fenhancement.md" target="_blank">Request a Feature</a> • <a href="https://git.zakscode.com/ztimson/kiwixm/issues/new?template=.github%2fissue_template%2fenhancement.md" target="_blank">Request a Feature</a>
</div> </div>
--- ---
</div> </div>
## Table of Contents ## Table of Contents
- [Kiwix Manager](#top) - [Kiwix Manager](#top)
- [About](#about) - [About](#about)
- [Features](#features) - [Features](#features)
- [Built With](#built-with) - [Built With](#built-with)
- [Setup](#setup) - [Setup](#setup)
- [Production](#production) - [Production](#production)
- [Development](#development) - [Development](#development)
- [License](#license) - [License](#license)
## About ## About
Kiwix Manager 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. Kiwix Manager 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 ### Features
- **Non-ZIM library browser + uploader integrated into Kiwix** - Browse and upload any file type through a custom file browser that works alongside your Kiwix content - **Non-ZIM library browser + uploader integrated into Kiwix** - Browse and upload any file type through a custom file browser that works alongside your Kiwix content
- **Kiwix management interface for updating library content** - Full administrative control over your Kiwix server and ZIM library - **Kiwix management interface for updating library content** - Full administrative control over your Kiwix server and ZIM library
- **Upload ZIMs from computer or download them directly from Kiwix library** - Flexible ZIM file management with local uploads and remote downloads - **Upload ZIMs from computer or download them directly from Kiwix library** - 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 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 - **Create ZIMs from zips / files** - Generate ZIM archives from your existing file collections
### Built With ### Built With
[![Docker](https://img.shields.io/badge/Docker-384d54?style=for-the-badge&logo=docker)](https://docker.com/) [![Docker](https://img.shields.io/badge/Docker-384d54?style=for-the-badge&logo=docker)](https://docker.com/)
[![Express](https://img.shields.io/badge/Express-000000?style=for-the-badge&logo=express)](https://expressjs.com/) [![Express](https://img.shields.io/badge/Express-000000?style=for-the-badge&logo=express)](https://expressjs.com/)
[![JavaScript](https://img.shields.io/badge/JavaScript-000000?style=for-the-badge&logo=javascript)](https://javascript.com/) [![JavaScript](https://img.shields.io/badge/JavaScript-000000?style=for-the-badge&logo=javascript)](https://javascript.com/)
[![Node](https://img.shields.io/badge/Node.js-000000?style=for-the-badge&logo=nodedotjs)](https://nodejs.org/) [![Node](https://img.shields.io/badge/Node.js-000000?style=for-the-badge&logo=nodedotjs)](https://nodejs.org/)
[![TailwindCSS](https://img.shields.io/badge/Tailwind_CSS-38B2AC?style=for-the-badge&logo=tailwind-css&logoColor=white)](https://tailwindcss.com/) [![TailwindCSS](https://img.shields.io/badge/Tailwind_CSS-38B2AC?style=for-the-badge&logo=tailwind-css&logoColor=white)](https://tailwindcss.com/)
## Setup ## Setup
<details> <details>
<summary> <summary>
<h3 id="production" style="display: inline"> <h3 id="production" style="display: inline">
Production Production
</h3> </h3>
</summary> </summary>
#### Prerequisites #### Prerequisites
- [Docker](https://docs.docker.com/install/) - [Docker](https://docs.docker.com/install/)
#### Instructions #### Instructions
1. Run the docker image: `docker run -p 3000:3000 -v /path/to/zim/files:/data/zim -v /path/to/archive/files:/data/archive git.zakscode.com/ztimson/kiwixm:latest` 1. Run the docker image: `docker run --name kiwix --restart unless-stopped -p 4000:3000 -v /media/library:/data ztimson/kiwixm:latest`
2. Open [http://localhost:3000](http://localhost:3000) 2. Open [http://localhost:3000](http://localhost:3000)
3. Access the admin panel at [http://localhost:3000/admin](http://localhost:3000/admin) 3. Access the admin panel at [http://localhost:3000/admin](http://localhost:3000/admin)
4. Browse non-ZIM files at [http://localhost:3000/archive](http://localhost:3000/archive) </details>
</details>
<details>
<details> <summary>
<summary> <h3 id="development" style="display: inline">
<h3 id="development" style="display: inline"> Development
Development </h3>
</h3> </summary>
</summary>
#### Prerequisites
#### Prerequisites - [Node.js](https://nodejs.org/en/download)
- [Node.js](https://nodejs.org/en/download) - [Kiwix Tools](https://kiwix.org/en/downloads/kiwix-tools/) (for ZIM file management)
- [Kiwix Tools](https://kiwix.org/en/downloads/kiwix-tools/) (for ZIM file management)
#### Instructions
#### Instructions 1. Install the dependencies: `npm install`
1. Clone the repository: `git clone https://git.zakscode.com/ztimson/kiwixm.git` 2. Start the server: `npm run start`
2. Navigate to the project directory: `cd kiwixm` 3. Open [http://localhost:3000](http://localhost:3000)
3. Install the dependencies: `npm install`
4. Create the required directories: `mkdir -p data/zim data/archive` </details>
5. Start the server: `npm run start`
6. Open [http://localhost:3000](http://localhost:3000) ## License
Copyright © 2023 Zakary Timson | Available under MIT Licensing
</details>
See the [license](./LICENSE) for more information.
## License
Copyright © 2023 Zakary Timson | All Rights Reserved | Available under MIT Licensing
See the [license](./LICENSE) for more information.