docs: add config docs

README.md

@@ -1,11 +1,26 @@
 # Candy
 
+<img src="./assets/candy-transparent.png" width="200px">
+
 A tiny web server built with rust.
 
 [![dependency status](https://deps.rs/repo/github/DefectingCat/candy/status.svg)](https://deps.rs/repo/github/DefectingCat/candy)
 ![](https://git.rua.plus/xfy/candy/badges/main/pipeline.svg)
 ![](https://git.rua.plus/xfy/candy/-/badges/release.svg)
 
+## Features
+
+- Simple and easy to use
+- Single binary
+- Supports SSL
+- HTTP 2 support
+- Supports lua script
+- List directory
+
 ## TODO
 
 [TODO.md](./TODO.md)
+
+## Changelog
+
+[CHANGELOG.md](./CHANGELOG.md)

docs/docs/config/config-file.md

@@ -6,4 +6,78 @@ title: 配置文件
 
 ## 配置文件
 
-Candy 遵循配置文件进行配置。
+Candy 遵循配置文件进行配置。配置文件的格式为 TOML。
+
+### 虚拟主机
+
+顶层配置为虚拟主机 `host`，可以配置多个虚拟主机。
+
+```toml
+[[host]]
+ip = "0.0.0.0"
+port = 80
+# Connection timeout
+timeout = 15
+# 只用当 ssl = true 时，才会读取证书和密钥，并开启 SSL 支持
+# ssl = true
+# Self sign a certificate
+# sudo openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout ./html/selfsigned.key -out ./html/selfsigned.crt
+certificate = "./html/selfsigned.crt"
+certificate_key = "./html/selfsigned.key"
+```
+
+#### 自定义 HTTP 相应头
+
+每个虚拟主机都可以配置自定义相应头
+
+TODO
+
+### 路由
+
+每个虚拟主机下都可以配置多个路由。配置字段为 `route`。
+
+每个路由支持三种配置：
+
+- 静态文件托管
+- 反向代理
+- Lua 脚本
+
+#### 静态文件托管
+
+```toml
+[[host.route]]
+# 路由地址
+location = "/"
+# 静态文件根目录
+root = "html"
+# 当使用静态文件根目录时，使用下面的字段作为主页
+index = ["index.html"]
+# 列出目录
+auto_index = true
+```
+
+#### 反向代理
+
+```toml
+[[host]]
+ip = "0.0.0.0"
+port = 8080
+[[host.route]]
+location = "/"
+proxy_pass = "http://localhost:3000/"
+# Timeout for connect to upstream
+proxy_timeout = 10
+# Client request max body size (bytes)
+max_body_size = 2048
+```
+
+#### Lua 脚本
+
+```toml
+[[host]]
+ip = "0.0.0.0"
+port = 8081
+[[host.route]]
+location = "/"
+lua_script = "html/index.lua"
+```

docs/docs/intro.md

@@ -23,3 +23,11 @@ Options:
   -h, --help           Print help
   -V, --version        Print version
 ```
+
+只需要一个可执行文件和一个配置文件，就可以快速部署一个 HTTP 服务器。
+
+```bash
+❯ ./target/release/candy -c config.toml
+```
+
+`-c` 可以省略，当省略时，默认使用当前目录下的 `config.toml` 文件。

docs/docusaurus.config.ts

@@ -5,9 +5,10 @@ import { themes as prismThemes } from 'prism-react-renderer';
 const config: Config = {
   title: 'Candy',
   tagline: 'Tiny http web server',
-  favicon: 'img/favicon.ico',
+  favicon: 'img/candy-transparent.png',
 
   future: {
+    v4: true,
     experimental_faster: true,
   },
 
@@ -66,8 +67,8 @@ const config: Config = {
     navbar: {
       title: 'RUA',
       logo: {
-        alt: 'My Site Logo',
-        src: 'img/logo.svg',
+        alt: 'Candy Logo',
+        src: 'img/candy-transparent.png',
       },
       items: [
         {

docs/i18n/en/code.json

@@ -45,7 +45,7 @@
   },
   "theme.colorToggle.ariaLabel": {
     "message": "Switch between dark and light mode (currently {mode})",
-    "description": "The ARIA label for the navbar color mode toggle"
+    "description": "The ARIA label for the color mode toggle"
   },
   "theme.colorToggle.ariaLabel.mode.dark": {
     "message": "dark mode",
@@ -309,5 +309,17 @@
   "theme.tags.tagsPageTitle": {
     "message": "Tags",
     "description": "The title of the tag list page"
+  },
+  "theme.colorToggle.ariaLabel.mode.system": {
+    "message": "system mode",
+    "description": "The name for the system color mode"
+  },
+  "theme.navbar.mobileDropdown.collapseButton.expandAriaLabel": {
+    "message": "Expand the dropdown",
+    "description": "The ARIA label of the button to expand the mobile dropdown navbar item"
+  },
+  "theme.navbar.mobileDropdown.collapseButton.collapseAriaLabel": {
+    "message": "Collapse the dropdown",
+    "description": "The ARIA label of the button to collapse the mobile dropdown navbar item"
   }
 }

docs/i18n/en/docusaurus-plugin-content-docs/current/config/config-file.md

@@ -7,3 +7,79 @@ title: Config File
 ## Config File
 
 Candy follows the config file to configure.
+
+### Virtual Host
+
+The top level configuration is the virtual host `host`, and can configure multiple virtual hosts.
+
+```toml
+[[host]]
+ip = "0.0.0.0"
+port = 80
+# Connection timeout
+timeout = 15
+# Only read certificate and key when ssl = true, and enable SSL support
+# ssl = true
+# Self sign a certificate
+# sudo openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout ./html/selfsigned.key -out ./html/selfsigned.crt
+certificate = "./html/selfsigned.crt"
+certificate_key = "./html/selfsigned.key"
+```
+
+#### Custom HTTP Response Header
+
+Each virtual host can configure custom response header.
+
+TODO
+
+### Route
+
+Each virtual host can configure multiple routes. The configuration field is `route`.
+
+Each route supports three configurations:
+
+- Static file hosting
+- Reverse proxy
+- Lua script
+
+#### Static File Hosting
+
+```toml
+[[host.route]]
+# Route location
+location = "/"
+# Static file root
+# or proxy_pass
+# or redirect
+root = "html"
+# Only use for root field
+index = ["index.html"]
+# List directory
+auto_index = true
+```
+
+#### Reverse Proxy
+
+```toml
+[[host]]
+ip = "0.0.0.0"
+port = 8080
+[[host.route]]
+location = "/"
+proxy_pass = "http://localhost:3000/"
+# Timeout for connect to upstream
+proxy_timeout = 10
+# Client request max body size (bytes)
+max_body_size = 2048
+```
+
+#### Lua Script
+
+```toml
+[[host]]
+ip = "0.0.0.0"
+port = 8081
+[[host.route]]
+location = "/"
+lua_script = "html/index.lua"
+```

docs/i18n/en/docusaurus-plugin-content-docs/current/intro.md

@@ -23,3 +23,11 @@ Options:
   -h, --help           Print help
   -V, --version        Print version
 ```
+
+Only one config file is supported, the default config file is `./config.toml`.
+
+```bash
+❯ ./target/release/candy -c config.toml
+```
+
+`-c` can be omitted, and when omitted, the default config file is `./config.toml` in the current directory.

docs/i18n/zh-Hans/code.json

@@ -45,7 +45,7 @@
   },
   "theme.colorToggle.ariaLabel": {
     "message": "切换浅色/暗黑模式（当前为{mode}）",
-    "description": "The ARIA label for the navbar color mode toggle"
+    "description": "The ARIA label for the color mode toggle"
   },
   "theme.colorToggle.ariaLabel.mode.dark": {
     "message": "暗黑模式",
@@ -309,5 +309,17 @@
   "theme.tags.tagsPageTitle": {
     "message": "标签",
     "description": "The title of the tag list page"
+  },
+  "theme.colorToggle.ariaLabel.mode.system": {
+    "message": "system mode",
+    "description": "The name for the system color mode"
+  },
+  "theme.navbar.mobileDropdown.collapseButton.expandAriaLabel": {
+    "message": "Expand the dropdown",
+    "description": "The ARIA label of the button to expand the mobile dropdown navbar item"
+  },
+  "theme.navbar.mobileDropdown.collapseButton.collapseAriaLabel": {
+    "message": "Collapse the dropdown",
+    "description": "The ARIA label of the button to collapse the mobile dropdown navbar item"
   }
 }

docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/config/config-file.md

@@ -6,4 +6,78 @@ title: 配置文件
 
 ## 配置文件
 
-Candy 遵循配置文件进行配置。
+Candy 遵循配置文件进行配置。配置文件的格式为 TOML。
+
+### 虚拟主机
+
+顶层配置为虚拟主机 `host`，可以配置多个虚拟主机。
+
+```toml
+[[host]]
+ip = "0.0.0.0"
+port = 80
+# Connection timeout
+timeout = 15
+# 只用当 ssl = true 时，才会读取证书和密钥，并开启 SSL 支持
+# ssl = true
+# Self sign a certificate
+# sudo openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout ./html/selfsigned.key -out ./html/selfsigned.crt
+certificate = "./html/selfsigned.crt"
+certificate_key = "./html/selfsigned.key"
+```
+
+#### 自定义 HTTP 相应头
+
+每个虚拟主机都可以配置自定义相应头
+
+TODO
+
+### 路由
+
+每个虚拟主机下都可以配置多个路由。配置字段为 `route`。
+
+每个路由支持三种配置：
+
+- 静态文件托管
+- 反向代理
+- Lua 脚本
+
+#### 静态文件托管
+
+```toml
+[[host.route]]
+# 路由地址
+location = "/"
+# 静态文件根目录
+root = "html"
+# 当使用静态文件根目录时，使用下面的字段作为主页
+index = ["index.html"]
+# 列出目录
+auto_index = true
+```
+
+#### 反向代理
+
+```toml
+[[host]]
+ip = "0.0.0.0"
+port = 8080
+[[host.route]]
+location = "/"
+proxy_pass = "http://localhost:3000/"
+# Timeout for connect to upstream
+proxy_timeout = 10
+# Client request max body size (bytes)
+max_body_size = 2048
+```
+
+#### Lua 脚本
+
+```toml
+[[host]]
+ip = "0.0.0.0"
+port = 8081
+[[host.route]]
+location = "/"
+lua_script = "html/index.lua"
+```

docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/intro.md

@@ -23,3 +23,11 @@ Options:
   -h, --help           Print help
   -V, --version        Print version
 ```
+
+只需要一个可执行文件和一个配置文件，就可以快速部署一个 HTTP 服务器。
+
+```bash
+❯ ./target/release/candy -c config.toml
+```
+
+`-c` 可以省略，当省略时，默认使用当前目录下的 `config.toml` 文件。

docs/package.json

@@ -19,22 +19,22 @@
     "tsc": "tsc"
   },
   "dependencies": {
-    "@docusaurus/core": "3.6.3",
-    "@docusaurus/faster": "^3.6.3",
-    "@docusaurus/preset-classic": "3.6.3",
+    "@docusaurus/core": "3.8.1",
+    "@docusaurus/faster": "^3.8.1",
+    "@docusaurus/preset-classic": "3.8.1",
     "@mdx-js/react": "^3.1.0",
     "clsx": "^2.1.1",
-    "prism-react-renderer": "^2.4.0",
-    "react": "^18.3.1",
-    "react-dom": "^18.3.1"
+    "prism-react-renderer": "^2.4.1",
+    "react": "^19.1.0",
+    "react-dom": "^19.1.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "3.6.3",
-    "@docusaurus/tsconfig": "3.6.3",
-    "@docusaurus/types": "3.6.3",
-    "prettier": "^3.4.2",
+    "@docusaurus/module-type-aliases": "3.8.1",
+    "@docusaurus/tsconfig": "3.8.1",
+    "@docusaurus/types": "3.8.1",
+    "prettier": "^3.6.2",
     "prettier-plugin-organize-imports": "^4.1.0",
-    "typescript": "~5.7.2"
+    "typescript": "~5.8.3"
   },
   "browserslist": {
     "production": [
@@ -51,5 +51,5 @@
   "engines": {
     "node": ">=18.0"
   },
-  "packageManager": "pnpm@9.15.2"
+  "packageManager": "pnpm@10.12.4"
 }

docs/src/components/HomepageFeatures/index.tsx

@@ -14,30 +14,22 @@ const FeatureList: FeatureItem[] = [
     Svg: require('@site/static/img/undraw_docusaurus_mountain.svg').default,
     description: (
       <>
-        Docusaurus was designed from the ground up to be easily installed and
-        used to get your website up and running quickly.
+        Single executable binary, with a TOML config file, quick to deploy a
+        http server.
       </>
     ),
   },
   {
-    title: 'Focus on What Matters',
+    title: 'Performance',
     Svg: require('@site/static/img/undraw_docusaurus_tree.svg').default,
     description: (
-      <>
-        Docusaurus lets you focus on your docs, and we&apos;ll do the chores. Go
-        ahead and move your docs into the <code>docs</code> directory.
-      </>
+      <>Multiple threads, asynchronous I/O, and multi-platform support.</>
     ),
   },
   {
-    title: 'Powered by React',
+    title: 'Powered by Rust',
     Svg: require('@site/static/img/undraw_docusaurus_react.svg').default,
-    description: (
-      <>
-        Extend or customize your website layout by reusing React. Docusaurus can
-        be extended while reusing the same header and footer.
-      </>
-    ),
+    description: <>Built with Rust, axum and tokio.</>,
   },
 ];
 

docs/src/pages/index.tsx

@@ -21,7 +21,7 @@ function HomepageHeader() {
             className="button button--secondary button--lg"
             to="/docs/intro"
           >
-            Docusaurus Tutorial - 5min ⏱️
+            Quick start - 5min ⏱️
           </Link>
         </div>
       </div>
@@ -32,10 +32,7 @@ function HomepageHeader() {
 export default function Home(): JSX.Element {
   const { siteConfig } = useDocusaurusContext();
   return (
-    <Layout
-      title={`Hello from ${siteConfig.title}`}
-      description="Description will go into a meta tag in <head />"
-    >
+    <Layout title={`${siteConfig.title}`} description="Candy, http web server">
       <HomepageHeader />
       <main>
         <HomepageFeatures />