Skip to content

Latest commit

 

History

History
72 lines (57 loc) · 3.36 KB

README_CN.md

File metadata and controls

72 lines (57 loc) · 3.36 KB
Raw

SPA-SERVER

GitHub Release Build status License: MIT Maintenance PRs Welcome

专为静态页面提供全链路优化的托管服务。

ENGLISH README

特性

  • 基于 Hyper 和 warp 构建。
  • SSL 基于 Rustls。
  • 服务器端缓存、客户端缓存（Cache-Content）、Gzip压缩。
  • SPA 版本管理， 仅需要一个 http 请求就能实现版本回滚和更新。
  • 支持热更新(Mac and Linux)。
  • 支持 CORS 跨域
  • http/https 同时服务（http 也可返回 redirect https）。
  • 支持 Docker 镜像(压缩后大小:~26M)
  • 提供 命令行/npm包 客户端，一行命令部署
  • 每个域名可拥有独立的配置
  • 支持 Let's Encrypt
  • 支持 OpenTelemetry
  • 提供JS SDK、命令行客户端与服务器进行交互。

文档

中文 README 目前仅提供一些简易快速使用指引，更多内容可参考英文文档， 中文版会在后续有精力的时候做，其网站托管在 GitHub Pages，

服务跑起来

配置文件说明: config.release.conf.

可以通过修改环境变量 SPA_CONFIG=${config_path}， 来更改配置文件地址。

通过源码

git clone [email protected]:fornetcode/spa-server.git
cd spa-server
git submodule init && git submodule update
cp config.release.conf config.conf # please remember to change `file_dir` in config.conf
cargo run --bin spa-server

通过镜像

docker run -d -p 80  -v $HOST_VOLUME:/data -v $CONFIG:/config.conf ghcr.io/fornetcode/spa-server:latest

如何部署静态文件

如果你想集成到JS项目中，请参阅：example/js-aapp-example。

spa-server 使用场景

单独使用

根据自己的需求配置好 cache, 可获得极大的性能提升。 若需要热加载功能（ssl证书更替）/文件版本管理/客户端交互，请开启 admin server 配置。

搭配 Nginx 使用

请在默认配置的基础上，请对 cache.compression, cache.client_cache, cors 保持默认/禁用，相关配置所带来的功能可设定在Nginx端，预防本服务和Nginx出现冲突。

高可用

目前项目没有做高可用的适配，需要注意以下几点：

  1. 文件最好放在 S3/NFS 等可以共享到所有spa-server实例的文件系统中，否则 Last-Modified 不一致会对客户端缓存有一定影响。
  2. 所有控制请求，需要对每个实例都发起一遍。

项目规划

请参阅 项目规划.

为何自行维护 warp 版本

#171 Add reply::file(path) helper

本项目用了很多 warp/src/filters/fs.rs 的私有API。

项目起源

请跳转至 SPA 发布辅助工具 浏览。