From 4db0babbdd053169cad2537edca3de52f054e585 Mon Sep 17 00:00:00 2001 From: Zakary Timson Date: Sat, 27 Sep 2025 10:31:59 -0400 Subject: [PATCH 1/3] Update README.md --- README.md | 204 ++++++++++++++++++++++++++---------------------------- 1 file changed, 100 insertions(+), 104 deletions(-) diff --git a/README.md b/README.md index d401ba2..1150f5e 100644 --- a/README.md +++ b/README.md @@ -1,104 +1,100 @@ - -
-
- - - Logo - - -### Kiwix Manager - - -A web-based Kiwix management tool to create & upload zims as well as manage non zim files - - -[![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) -[![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) -[![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) - - - - --- -
- Documentation - • Release Notes - • Report a Bug - • Request a Feature -
- - --- -
- -## Table of Contents -- [Kiwix Manager](#top) - - [About](#about) - - [Features](#features) - - [Built With](#built-with) - - [Setup](#setup) - - [Production](#production) - - [Development](#development) - - [License](#license) - -## 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. - -### 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 -- **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 -- **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 - -### Built With -[![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/) -[![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/) -[![TailwindCSS](https://img.shields.io/badge/Tailwind_CSS-38B2AC?style=for-the-badge&logo=tailwind-css&logoColor=white)](https://tailwindcss.com/) - -## Setup - -
- -

- Production -

- - -#### Prerequisites -- [Docker](https://docs.docker.com/install/) - -#### 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` -2. Open [http://localhost:3000](http://localhost:3000) -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) -
- -
- -

- Development -

- - -#### Prerequisites -- [Node.js](https://nodejs.org/en/download) -- [Kiwix Tools](https://kiwix.org/en/downloads/kiwix-tools/) (for ZIM file management) - -#### Instructions -1. Clone the repository: `git clone https://git.zakscode.com/ztimson/kiwixm.git` -2. Navigate to the project directory: `cd kiwixm` -3. Install the dependencies: `npm install` -4. Create the required directories: `mkdir -p data/zim data/archive` -5. Start the server: `npm run start` -6. Open [http://localhost:3000](http://localhost:3000) - -
- -## License -Copyright © 2023 Zakary Timson | All Rights Reserved | Available under MIT Licensing - -See the [license](./LICENSE) for more information. + +
+
+ + + Logo + + +### Kiwix Manager + + +A web-based Kiwix management tool to create & upload zims as well as manage non zim files + + + [![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%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%3Ftoken%3D35a3bf73a216782a7435f86117412bcb9784b716&query=open_issues_count)](https://git.zakscode.com/ztimson/kiwixm/issues) + + + + --- +
+ Documentation + • Release Notes + • Report a Bug + • Request a Feature +
+ + --- +
+ +## Table of Contents +- [Kiwix Manager](#top) + - [About](#about) + - [Features](#features) + - [Built With](#built-with) + - [Setup](#setup) + - [Production](#production) + - [Development](#development) + - [License](#license) + +## 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. + +### 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 +- **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 +- **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 + +### Built With +[![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/) +[![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/) +[![TailwindCSS](https://img.shields.io/badge/Tailwind_CSS-38B2AC?style=for-the-badge&logo=tailwind-css&logoColor=white)](https://tailwindcss.com/) + +## Setup + +
+ +

+ Production +

+ + +#### Prerequisites +- [Docker](https://docs.docker.com/install/) + +#### Instructions +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) +3. Access the admin panel at [http://localhost:3000/admin](http://localhost:3000/admin) +
+ +
+ +

+ Development +

+ + +#### Prerequisites +- [Node.js](https://nodejs.org/en/download) +- [Kiwix Tools](https://kiwix.org/en/downloads/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](http://localhost:3000) + +
+ +## License +Copyright © 2023 Zakary Timson | All Rights Reserved | Available under MIT Licensing + +See the [license](./LICENSE) for more information. From bad17a928db577164df92621f26e60691c66a206 Mon Sep 17 00:00:00 2001 From: Zakary Timson Date: Sat, 27 Sep 2025 10:33:01 -0400 Subject: [PATCH 2/3] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1150f5e..20505a9 100644 --- a/README.md +++ b/README.md @@ -95,6 +95,6 @@ Kiwix Manager is a comprehensive web-based management interface for Kiwix server ## License -Copyright © 2023 Zakary Timson | All Rights Reserved | Available under MIT Licensing +Copyright © 2023 Zakary Timson | Available under MIT Licensing See the [license](./LICENSE) for more information. From 72fc307c09ff12b51820b6f96c352b29a73708b0 Mon Sep 17 00:00:00 2001 From: Zakary Timson Date: Sat, 27 Sep 2025 10:33:40 -0400 Subject: [PATCH 3/3] Add LICENSE --- LICENSE | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..e734a49 --- /dev/null +++ b/LICENSE @@ -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.