taxy 0.1.1

A TCP reverse proxy with a user-friendly WebUI
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69

# Taxy

A TCP reverse proxy with a user-friendly WebUI.

[![Crates.io](https://img.shields.io/crates/v/taxy.svg)](https://crates.io/crates/taxy)
[![GitHub license](https://img.shields.io/github/license/picoHz/taxy.svg)](https://github.com/picoHz/taxy/blob/main/LICENSE)

## Overview

- Written in Rust for performance and safety
- Intuitive and user-friendly WebUI for easy configuration
- Live configuration updates without restarting the service
- Import TLS certificates from GUI or generate a self-signed certificate

## Installation

To build the Taxy binary, ensure that you have the Rust toolchain installed.

Once you have successfully built and started taxy, you can access the admin panel at http://localhost:46492/.

### From crates.io

The package on crates.io contains the WebUI as a static asset, so you don't need to build it yourself.

Install "Taxy" using Cargo:

```bash
cargo install taxy
```

### From git

To build the Web UI, make sure you have Node.js installed on your system.

Clone the repository and install the package:

```bash
git clone https://github.com/picoHz/taxy
cd taxy/webui
npm install
npm run build
cd ..
cargo install --path .
```

## Development

To contribute or develop Taxy, follow these steps:

```bash
# Clone the repository
git clone https://github.com/picoHz/taxy

# Start the server
cd taxy
cargo run

# In a separate terminal, start Vite for the WebUI
cd webui
npm install
npm run dev
```

## FAQ

### Why don't changes to the configuration take effect immediately?

Updating the configuration solely impacts new connections. 
When browsers maintain active TCP streams, subsequent requests will continue to follow the prior configuration.