fix servers starting

more docs
shell nix remove openssl
This commit is contained in:
MeexReay 2025-04-07 00:56:27 +03:00
parent 013ddd4944
commit 631025efdb
4 changed files with 23 additions and 18 deletions

8
BUILD.md Executable file
View File

@ -0,0 +1,8 @@
## How to build
```sh
cargo build --release
mv target/release/flowgate anywhere/you/need
```
todo: more details

View File

@ -3,7 +3,7 @@ HTTP requests redirection system
Features:
- Request redirection
- SSL/TLS support
- TLS support
- Keep-alive connections
- Sending IP in header (X-Real-IP)
@ -12,8 +12,16 @@ TODO:
- Creating trees of flowgate
- Filter by headers
- Modify response headers
- HTTP/3 full support
## IP forwarding types
## How to use
Firstly, download it from releases. or build from sources (read BUILD.md) \
Just run it and configure in `conf.yml` file.
## Configuration
### IP forwarding methods
- None (`none`):\
Do nothing
@ -23,16 +31,3 @@ TODO:
Appends `ip:port\n` to the beginning of the request
- Header (`header[:HEADER_NAME]`):\
Adds header `HEADER_NAME: ip:port` to the request
## How to run
You need [Rust](https://www.rust-lang.org/) installed with cargo!
```sh
cargo run # --------------------------------- # Run
cargo run --release # ----------------------- # Run release
cargo build && sudo ./target/release/flowgate # Run with root
cargo build # ------------------------------------------------ # Build
cargo build --release # -------------------------------------- # Build release
cargo build --release --no-default-features --features FEATURE # Build with feature
```

View File

@ -2,7 +2,7 @@ with import <nixpkgs> { };
mkShell {
nativeBuildInputs = [
openssl
pkg-config
cargo
rustc
];
}

View File

@ -16,4 +16,6 @@ async fn main() {
let server = FlowgateServer::new(config.clone());
server.start().await;
loop {}
}