A fast and lightweight alternative to kiwix-serve
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Jojii 0263481fa2
Merge pull request #4 from gaetanlhf/patch-2
2 weeks ago
.github/workflows add CI/CD 2 weeks ago
.img Add screenshots 12 months ago
handlers Fix the repository URL 2 weeks ago
html/static fix html preview 11 months ago
zim Add Unique id for wikis 11 months ago
.gitignore Merge branch 'master' into patch-2 2 weeks ago
LICENSE zimserver -> ZimWiki 3 weeks ago
Makefile zimserver -> ZimWiki 3 weeks ago
README.md Update README.md 2 weeks ago
go.mod Merge branch 'master' into patch-2 2 weeks ago
go.sum Start working on the configuration file 3 weeks ago
main.go Improved code readability 2 weeks ago
router.go Fix the repository URL 2 weeks ago
utils.go improve file serving 12 months ago

README.md

ZimWiki

A modern zim fileserver which can handle multiple zim files by serving a beautiful Wiki website. It is a lightweight and performant replacement for kiwix-serve and can handle many big wiki archives (zim files).

Screenshots

Desktop Mobile

Installation

  • Install go and compile it using go build or
  • Download the latest release

Configuration

Example

config.toml:

[Config]
LibraryPath = "./library"
Address = ":8080"

Usage

Your LibraryPath must contain your .zim files inside it, you can also link them using symlinks.
Run the binary and go to https://localhost:Port

Features

  • Read/Handle multiple Zim files
  • Read Wikis
  • Search (inside a wiki or globally)
  • Create wiki index files for faster search
  • Send content gzipped
  • Use symlinks as .zim link
  • Replace absolute links with relative ones
  • Config file