kawipiko下载kawipiko源代码下载

kawipiko

其他类别

1.0.0

下载

./documentation/assets/github-banner.png

kawipiko-快速快速静态HTTP服务器

目录：
手册和示例
安装和常见问题解答
功能和基准
关于版权和许可，SBOM和参考
在Discord上聊天，在GitHub上讨论或电子邮件作者

关于

kawipiko是用GO编写的轻量级静态HTTP服务器；专注于以最低的延迟和最低的资源消耗（CPU，RAM，IO）尽可能快，高效地提供静态内容；支持HTTP/1（带有或不带有TLS），HTTP/2和HTTP/3（超过QUIC） ；可作为单个静态链接的可执行文件可用，而无需任何其他依赖项。

想看到kawipiko在行动中吗？

kawipiko-examples.volution.ro-以下是一些最适合kawipiko的演示； /documentation表示静态站点可以很好地压缩，同时/carina-nebula ， /openstreetmap和/fontawesome代表产生许多小请求的静态站点；（请注意，此实例是在CloudFlare后面的，但是已指示它不要缓存边缘上的任何内容；）（目前，服务器是通过住宅光纤连接托管的；）
Notes.Volution.RO-我的个人笔记 /博客网站，以前曾在Netlify主持；（当前，该服务器是通过住宅光纤连接托管的；）

但是，简单并不意味着愚蠢或有限，而是通过删除多余的特征，这意味着有效，因此与Unix的旧哲学有关“做一件事情并做得很好”。因此，它仅支持GET请求，并且不提供诸如动态内容生成，身份验证，反向代理等的功能；同时，仍然提供压缩（ gzip ， zopfli或brotli ），以及HTML-CSS-JS缩放（TODO），而不会影响其性能（由于其独特的架构如下所述）。

kawipiko提供的功能是非常独特的，没有其他HTTP服务器提供的东西：静态内容是从几乎没有延迟的CDB文件中提供的（与仍然必须通过open-read-close仍然必须通过OS的经典静态服务器相比open-read-close syscalls）。此外，如前所述，静态含量仍然可以提前压缩或缩小，从而不仅可以减少CPU，还可以减少带宽和延迟。

CDB文件是二进制数据库文件，可提供有效的只读键值查找表，最初用于某些DNS和SMTP服务器，主要用于其低开销查找操作，在多线程 /多个过程中零锁定，以及“ Atomicic” “多记录更新。这也使它们适合于HTTP上使用的低延迟静态含量，这是该项目提供的。

对于那些熟悉Netlify（或Cloudflare页面，GitHub页面等竞争对手）的人， kawipiko是一个主持自己的替代方案：

具有简单配置的独立部署；（即只需获取可执行文件并使用适当的标志;）
低和恒定的资源消耗（在CPU和RAM方面）；（即负载时您不会感到惊讶;）
（希望）非常安全；（即它不会启动流程，它不连接到其他服务或数据库，也不会打开任何文件等；基本上您可以轻松地将其chroot或像如今的时尚中像在时尚中进行容器；）
高度便携，至少支持Linux（主要开发，测试和部署平台），FreeBSD，OpenBSD和OSX；

有关功能的完整列表，请咨询“功能”部分。不幸的是，如限制部分所述，也存在一些权衡（尽管没有一个至关重要）。

关于性能，如“基准”部分所述， kawipiko至少与NGINX相比，即使在我6岁的笔记本电脑上，也有99％的请求的持续时间超过100K /秒，延迟了0.25ms。但是，与NGINX相比，主要优势不是原始性能，而是部署和配置简单性，以及许多小文件的大量集合的管理和存储。

关于kawipiko我还在我自己的网站上发表了一些文章：

使用Seccomp确保我的静态站点服务器 - 描述我如何使用Linux的seccomp Syscall过滤来通过减少攻击表面来提高安全性；
静态站点托管Hurdres-描述实现此简单HTTP服务器的推理；
HTTP/1.1和HTTP/2之间的视觉比较 - 关于Firefox和Chromium如何处理HTTP/1.1与HTTP/2的大量资源负载的一些实验；（用于体验的服务器是kawipiko ;）

手动的

工作流程
kawipiko-server
kawipiko-Arariver

工作流程

该项目提供以下可执行文件（静态链接，没有任何其他依赖关系）：

kawipiko-server通过HTTP（有或没有TLS），HTTP/2或HTTP/3（通过QUIC）提供CDB存档中静态含量；
kawipiko-archiver从固定静态内容的源文件夹中创建CDB存档，可选地压缩和缩小文件；
kawipiko一个多合一的可执行文件，将所有功能捆绑在一个可执行文件中；（即kawipiko server ...或kawipiko archiver ... ）;

与大多数（如果不是全部）其他服务器不同的是，您只需将Web服务器指向持有静态网站内容root的文件夹， kawipiko采用了一种截然不同的方法：为了提供静态内容，必须首先将内容通过kawipiko-archiver归档到CDB存档中，然后可以通过kawipiko-server从CDB存档中提供它。

这个两个步骤阶段也带来了一些机会：

通过使用与其他软件项目相似的CI/CD管道，可以将静态网站的“构建”，“测试”和“发布”阶段解散；
如果新公布的问题有问题，则可以立即回滚前一个版本。
可以在部署期间与在部署期间进行CPU进行极端压缩（例如zopfli或brotli ）进行运行时交易CPU。

kawipiko-server

查看专用手册。

该文档也可以用纯文本或人页面提供。

kawipiko-Arariver

查看专用手册。

该文档也可以用纯文本或人页面提供。

例子

获取并提取Python 3.10文档HTML存档：

卷发
        -s -s -f 
        -o ./python-3.10.1-docs-html.tar.bz2 
        https://docs.python.org/3/archives/python-3.10.1-docs-html.tar.bz2 
＃

焦油
        -x -j -v 
        -f ./python-3.10.1-docs-html.tar.bz2 
＃

创建CDB存档（无需任何压缩）：

 kawipiko-arkiver 
        -archive./python-3.10.1-docs-html-nocomp.cdb 
        -sources ./python-3.10.1-docs-html 
         - 调试 
＃

创建CDB存档（带有gzip压缩）：

 kawipiko-arkiver 
        -archive./python-3.10.1-docs-html-gzip.cdb 
        -sources ./python-3.10.1-docs-html 
         - 压缩gzip 
         - 调试 
＃

创建CDB存档（带有zopfli压缩）：

 kawipiko-arkiver 
        -archive./python-3.10.1-docs-html-zopfli.cdb 
        -sources ./python-3.10.1-docs-html 
         - 压缩zopfli 
         - 调试 
＃

创建CDB存档（带有brotli压缩）：

 kawipiko-arkiver 
        -archive./python-3.10.1-docs-html-brotli.cdb 
        -sources ./python-3.10.1-docs-html 
         - 压缩brotli 
         - 调试 
＃

服务CDB存档（带有gzip压缩）：

 kawipiko-server 
        -bind 127.0.0.1：8080 
        -archive./python-3.10.1-docs-html-gzip.cdb 
        -archive-mmap 
         -  Archive Proud 
         - 调试 
＃

比较来源和档案尺寸：

 du 
        -h -s 
         
        ./python-3.10.1-docs-html-nocomp.cdb 
        ./python-3.10.1-docs-html-gzip.cdb 
        ./python-3.10.1-docs-html-zopfli.cdb 
        ./python-3.10.1-docs-html-brotli.cdb 
         
        ./python-3.10.1-docs-html 
        ./python-3.10.1-docs-html.tar.bz2 
＃

45m ./python-3.10.1-docs-html-nocomp.cdb
9.7m ./python-3.10.1-docs-html-gzip.cdb
??? ./python-3.10.1-docs-html-zopfli.cdb
79m ./python-3.10.1-docs-html-brotli.cdb

46m ./python-3.10.1-docs-html
6.0m ./python-3.10.1-docs-html.tar.bz2

安装

请参阅专用安装文档。

特征

实施的
待办的
限制

实施的

以下是最重要的功能的列表：

（选择）创建CDB存档时，静态内容会被压缩或缩小，因此在服务请求时未使用CPU周期；
（选择）可以用gzip ， zopfli或brotli压缩静态内容；
（选择）为了进一步减少服务潜伏期，可以在内存中预紧整个CDB存档，或者在内存中映射它（使用mmap ）；这将存储器的内存交换为CPU；
（选择）缓存静态内容的指纹和压缩，从而大大减少CDB档案重建时间，并大大减少源文件系统的IO；
原子静态网站内容更改；因为整个内容都保存在一个CDB存档中，并且由于文件更换是通过rename SYSCALL（或mv工具）实现的，因此观察到所有服务的资源都同时更改；
_wildcard.* .html （ .txt .* （这些文件尊重层次树结构，即“更深”的文件覆盖了层次结构，将其覆盖靠近“ root”;）
通过利用github.com/valyala/fasthttp来支持HTTP/1（带有或不带TLS）；
支持HTTP/2的支持，通过利用GO的net/http ；
支持http/3（超过Quic），通过利用github.com/lucas-clemente/quic-go ；

待办的

以下是当前缺少并计划实施的最重要功能的列表：

（TODO）支持自定义HTTP响应标头（针对特定文件，特定文件夹等）；（当前仅包括Content-Type ， Content-Length ， Content-Encoding ；此外， Cache-Control: public, immutable, max-age=3600 ，可选的是ETag ，并且还可以包括一些TLS或安全相关的标头；）
（TODO）支持将虚拟主机映射到钥匙前缀；（目前，虚拟主机，即Host标头，由服务器支持，部分由Archiver支持；）
（TODO）支持将虚拟主机映射到多个CDB档案；（即，能够为多个域提供服务的能力，每个域都有自己的CDB存档;）
（TODO）自动重新加载CDB档案；
（todo）通过利用https://github.com/tdewolff/minify来缩小HTML，CSS和JavaScript；
（todo）自定义错误页面（嵌入在CDB存档中）；（目前仅支持404通配符；）

限制

如“关于”部分中所述，没有什么免费的，为了提供所有这些功能，必须剪切一些角落：

（TODO）当前，如果CDB存档更改，则需要重新启动服务器才能拾取更改的文件；
（不会修复）CDB档案最大尺寸为4 GIB （压缩和缩小后），并且资源不能超过1600万；（但是，如果您的静态网站如此之大，那么您可能会做一些非常错误的事情，因为大文件应被卸载到AWS S3之类的东西，并通过Cloudflare或AWS Cloudfront之类的CDN服务；）
（不会修复）服务器不支持每次要求解压缩 /重新压缩；这意味着，如果内容保存在CDB档案中，则用压缩（例如brotli ）将服务器服务于所有压缩资源（即Content-Encoding: brotli ），而不管浏览器接受的内容（IE Accept-Encoding: gzip ）；同样的内容也适用于未压缩的内容；（但是，始终使用gzip压缩是足够安全的，因为它实际上是在所有浏览器和HTTP客户端中实现的;）
（不会修复）有关“原子”静态网站的变化，有一个很小的时间窗口，其中一个客户获取了资源的“旧版本”（例如HTML页面），但尚未获取所需的资源（例如CSS或JS文件），以及在获取HTML和CSS/JS之间更改了CDB存档，因此客户将获取这些必需资源的新版本；但是，由于延迟的服务低，这个时间窗口非常小。（这不是该HTTP服务器的限制，而是网站构建方式的限制；始终在您的资源URL中使用指纹，也许始终在每个部署上包含当前和以前的版本；）