A lightweight static web server and reverse proxy designed for the modern web.
Getting KatWeb
You can download a packaged release of KatWeb from the releases page. WARNING: KatWeb has reached the end of it's lifespan, and will no longer receive updates of any kind. It should not be used in development or production environments. Consider using KatWebX instead.
Linux Packages
- Arch Linux users can install the katweb AUR package.
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-*
Additional Info
- Want to help fund KatWeb's development? Consider donating to the Bitcoin address
1KyggZGHF4BfHoHEXxoGzDmLmcGLaHN2x2. - Found a bug in KatWeb? Report it here.
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+)
An extremely fast static web server and reverse proxy for the modern web.
KatWebX 
An extremely fast static web-server and reverse proxy for the modern web. More info is available on KatWebX.kittyhacker101.tk.
Important Info
KatWebX is still a work in progress, and you may encounter issues. KatWebX is not well tested, production use is not recommended! Some releases are more stable than others, anything from the releases page is likely to be far more stable than the current code in the git repository.
Interested in the project? You can help fund KatWebX's development by donating to the Bitcoin address 1KyggZGHF4BfHoHEXxoGzDmLmcGLaHN2x2.
Release Schedule
Approximate dates for the release of KatWebX are listed below.
- October - Evaluation releases, containing all features being fully implemented, and a somewhat performant and readable codebase. No functionality changes will be made between now and the release, only performance optimizations, code cleanup, and bug fixes will be implemented at this time. Evaluation releases are intended for testing how well KatWebX functions in a production environment, but they are not intended for use in large-scale deployments or critical systems.
- November - A fully-functional, production-ready, 1.0 release will be finished and packaged. Additional updates will only add minor functionality changes, focusing mostly on performance improvments and bug fixes.
Known issues (as of this document's writing)
- Evaluation release 2 can't reverse proxy URLs with special characters in them. This has been fixed in the latest git version, and will be patched in the next release.
- Evaluation release 2's file listing doesn't properly escape URLs with special characters. This has been fixed in the latest git version, and will be patched in the next release.
- Evaluation release 2 doesn't implement HTTP to HTTPS redirects properly for all clients. This has been fixed in the latest git version, and will be patched in the next release.
Current Features
- Easy to read TOML configuration
- Flexible configuration parsing
- Regex-based redirects
- Compressed regex-based reverse proxy
- HTTP basic authentication
- Extremely fast file serving
- Brotli file compression
- Systemd/systemfd socket listening
- On-the-fly config reloading
- HSTS support
- SNI and OCSP response stapling
- High performance HTTP/2 and TLS 1.3
- Multiple logging formats
- Material design server-generated pages
Possible Features (probably won't be implemented soon, but a possibility in the future)
- Let's Encrypt integration (Difficult but practical to implement, possible in the future)
- Caching proxy (Currently very difficult to implement, unlikely to be implemented in the near future)
- Advanced load balancer (May be implemented in the future)
- Websocket reverse proxying (May be implemented in the future)
- Support for more architectures (Likely to be implemented eventually, requires dependencies to be updated)
Unlikely features (will not be implemented soon or at all)
- QUIC support (The underlying HTTP library (actix-web) doesn't support it, and only 1 browser supports it out of the box. Until it gets more adoption, I'm not going to put effort into adding it myself.)
- CGI/FastCGI support (There are no existing client libraries for Rust, and there's no real reason to implement it anyways. HTTP/2 can do everything that FastCGI does, and KatWebX has an HTTP/2 capable reverse proxy built-in.)
- SPDY support (SPDY is dying, as it's being replaced by HTTP/2. KatWebX has full support for HTTP/2.)
- TLS 1.1 or older (All recent browsers support TLS 1.2 or higher, and these older TLS protocols are very insecure.)
- Documentation in other languages (I don't know any other languages, and I don't have the resources to hire a translator.)
No comments:
Post a Comment