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

Update README.md
All checks were successful
Build Website / Tag Version (push) Successful in 6s
Details
Build Website / Build Dockerfile (push) Successful in 15s
Details

Browse Source
This commit is contained in:
Zakary Timson
2025-09-27 10:31:59 -04:00
parent 6604769a87
commit 4db0babbdd
1 changed files with 100 additions and 104 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@@ -12,9 +12,9 @@
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 -->
@@ -71,10 +71,9 @@ Kiwix Manager is a comprehensive web-based management interface for Kiwix server
- [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>
@@ -89,12 +88,9 @@ Kiwix Manager is a comprehensive web-based management interface for Kiwix server
- [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. Clone the repository: `git clone https://git.zakscode.com/ztimson/kiwixm.git` 1. Install the dependencies: `npm install`
2. Navigate to the project directory: `cd kiwixm` 2. Start the server: `npm run start`
3. Install the dependencies: `npm install` 3. Open [http://localhost:3000](http://localhost:3000)
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)
</details> </details>