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 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中使用指紋，也許始終在每個部署上包含當前和以前的版本；）