Skip to content
A lightweight static web server and reverse proxy designed for the modern web.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE Update issue templates May 21, 2018
gui Bug fixes, added support for new logging Aug 11, 2018
html
ssl Changed curve of private key for self-signed cert May 6, 2018
.travis.yml Set Travis-CI to include gui folder Jul 7, 2018
LICENSE Update LICENSE Apr 22, 2018
README.md Update README.md Dec 9, 2018
auth.go Improve docummentation Jun 30, 2018
auth_test.go Minor changes Sep 16, 2018
conf.json Added regex example to default config Aug 18, 2018
http.go Minor changes Sep 16, 2018
http_test.go Bug fixes, added additional unit tests Sep 16, 2018
main.go Changed version Sep 3, 2018
proxy.go Bug fixes, added additional unit tests Sep 15, 2018
proxy_test.go Minor changes, code cleanup Sep 16, 2018
sendfile.go Bug fixes, minor changes Sep 14, 2018
sendfile_test.go Minor changes Sep 16, 2018

README.md

KatWeb - A modern and lightweight webserver designed for the modern web.

Getting KatWeb

To download KatWeb, you can either download a packaged release from the releases page, or compile KatWeb from the source code in the repository (not recommended, code in the repository is not suitable for production use).

Linux Packages

  • Arch Linux users can install the katweb AUR package.
  • Debian/Ubuntu packages are currently in development.
  • CentOS packages are currently in development

Using KatWeb

After you have extracted the compressed release, you can run the right build for your platform. The root folder for serving files is /html/, the configuration is /conf.json. Documentation for KatWeb can be found on the KatWeb Wiki.

Running as root

Running KatWeb as root is not recommended for security reasons. You can allow KatWeb to use to ports below 1024 on Linux by using this command: sudo setcap cap_net_bind_service=+ep ./katweb-linux-*

Modifying KatWeb

If you intend to modify KatWeb, please use the source code from one of the release tags. The latest code in the repository is often unstable and has had very limited testing.

Additional Info

  • Want to discuss KatWeb, or have any questions? Join KatWeb's Discord server.
  • Want to help fund KatWeb's development? Consider donating to the Bitcoin address 1KyggZGHF4BfHoHEXxoGzDmLmcGLaHN2x2.
  • Found a bug in KatWeb? Report it here.

KatWeb 2 / KatWebX

The next major release of KatWeb, named KatWebX, is currently in development. No new features will be added to KatWeb v1 during this time, although KatWeb will still be supported and maintained until June 13, 2019. After KatWebX is released, upgrade support and critical security patches will be available until December 16, 2019.

Features

  • High Peformance TLS 1.2 (v1.0+)
  • Let's Encrypt Integration (v1.9+)
  • High Peformance HTTP/2 (v1.0+)
  • GZIP Compression Support (v1.0+)
  • Brotli Compression Support (v1.9.5+)
  • High Peformance Reverse Proxy (v1.2.7+)
  • Websocket Reverse Proxy (v1.8+)
  • Regex-Based Redirect Support (v1.10.1+)
  • Simple JSON-based configuration (v1.0+)
  • Simple Browser Control Panel (v1.10+)
  • Virtual Hosting Support (v1.0+)
  • Password Protection Support (v1.0+)
  • Multiple Logging Formats (v1.10.1+)
  • Modern Directory Listings (v1.6+)
  • Modern Error Pages (v1.9.1+)
You can’t perform that action at this time.