RoadSign/README.md

94 lines
3.6 KiB
Markdown
Raw Normal View History

2023-11-17 16:23:40 +00:00
# 🚦 RoadSign
A blazing fast reverse proxy with a lot of shining features.
## Features
1. Reverse proxy
2. Static file hosting
2023-11-17 17:42:04 +00:00
3. ~~Analytics and Metrics~~
2023-11-17 16:23:40 +00:00
4. Integrate with CI/CD
2023-11-18 06:30:35 +00:00
5. Webhook integration
2023-11-17 17:42:04 +00:00
6. ~~Web management panel~~
2023-12-12 12:49:03 +00:00
7. One-liner CLI
8. **Blazing fast ⚡**
2023-11-17 16:23:40 +00:00
2023-11-17 17:42:04 +00:00
> Deleted item means under construction, check out our roadmap!
2023-11-17 17:50:16 +00:00
### How fast is it?
2023-12-12 12:49:03 +00:00
We use roadsign and nginx to host a same static file, and test them with [go-wrk](https://github.com/tsliwowicz/go-wrk).
2023-11-24 17:27:37 +00:00
Here's the result:
2023-12-12 12:49:03 +00:00
| **Software** | Total Requests | Requests per Seconds | Transfer per Seconds | Avg Time | Fastest Time | Slowest Time | Errors Count |
2023-11-30 14:35:46 +00:00
|:---------------------:|:--------------:|:--------------------:|:--------------------:|:-----------:|:------------:|:------------:|:------------:|
2023-12-12 12:49:03 +00:00
| _Nginx_ | 515749 | 4299.58 | 2.05MB | 13.954846ms | 0s (Cached) | 410.6972ms | 0 |
| _RoadSign_ | 8905230 | 76626.70 | 30.98MB | 783.016µs | 28.542µs | 46.773083ms | 0 |
| _RoadSign w/ Prefork_ | 4784308 | 40170.41 | 16.24MB | 1.493636ms | 34.291µs | 8.727666ms | 0 |
2023-11-24 17:27:37 +00:00
As result, roadsign undoubtedly is the fastest one.
2023-12-12 12:49:03 +00:00
It can be found that the prefork feature makes RoadSign more stable in concurrency. We can see this from the **Slowest
Time**. At the same time, the **Fastest Time** is affected because reusing ports requires some extra steps to handle
load balancing. Enable this feature at your own discretion depending on your use case.
2023-11-30 14:35:46 +00:00
2023-12-12 12:49:03 +00:00
More details can be found at benchmark's [README.md](./test/README.md)
## Installation
We strongly recommend you install RoadSign via docker compose.
```yaml
version: "3"
services:
roadsign:
image: code.smartsheep.studio/goatworks/roadsign:nightly
restart: always
volumes:
- "./certs:/certs" # Optional, use for storage certificates
- "./config:/config"
- "./wwwroot:/wwwroot" # Optional, use for storage web apps
- "./settings.yml:/settings.yml"
ports:
- "80:80"
- "443:443"
- "81:81"
```
After that, you can manage your roadsign instance with RoadSign CLI aka. RDS CLI.
To install it, run this command. (Make sure you have golang toolchain on your computer)
```shell
2023-12-13 12:00:05 +00:00
go install -buildvcs code.smartsheep.studio/goatworks/roadsign/pkg/cmd/rds@latest
# Tips: Add `buildvsc` flag to provide more detail compatibility check.
2023-12-12 12:49:03 +00:00
```
## Usage
To use roadsign, you need to add a configuration for it. Create a file locally.
2023-12-14 13:17:45 +00:00
Name whatever you like. And follow our [documentation](https://wiki.smartsheep.studio/roadsign/configuration/index.html) to
2023-12-12 12:49:03 +00:00
write it.
After configure, you need sync your config to remote server. Before that, add a connection between roadsign server and
rds cli with this command.
```shell
rds connect <id> <url> <password>
2024-02-14 05:53:43 +00:00
# ID will allow you find this server.py.rs in after commands.
# URL is to your roadsign server.py.rs sideload api.
# Password is your roadsign server.py.rs credential.
2023-12-12 12:49:03 +00:00
# ======================================================================
# !WARNING! All these things will storage in your $HOME/.roadsignrc.yaml
# ======================================================================
```
Then, sync your local config to remote.
```shell
2024-02-14 05:53:43 +00:00
rds sync <server.py.rs id> <site id> <config file>
# Server ID is your server.py.rs added by last command.
2023-12-12 12:49:03 +00:00
# Site ID is your new site id or old site id if you need update it.
# Config File is your local config file path.
```
After a few seconds, your website is ready!