Skip to content

Commit

Permalink
docs: improve instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
picoHz committed Jan 25, 2024
1 parent dd42dc1 commit 557c7bc
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 36 deletions.
6 changes: 3 additions & 3 deletions docs/content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ sort_by = "weight"

# Key Features

- Built with Rust for optimal performance and safety, powered by tokio and hyper
- Built with Rust for optimal performance and safety, powered by [tokio](https://tokio.rs/) and [hyper](https://hyper.rs/)
- Supports TCP, TLS, HTTP1, and HTTP2, including HTTP upgrading and WebSocket functionality
- Easily deployable single binary with a built-in WebUI
- Allows live configuration updates via a REST API without restarting the service
Expand Down Expand Up @@ -121,9 +121,9 @@ $ taxy start

Once the server is running, you can access the admin panel at [http://localhost:46492/](http://localhost:46492/).

> If you run the server on a remote machine, it is strongly recommended to use SSH port forwarding to access the admin panel instead of exposing the port to the public, as the connection is plain HTTP and not encrypted.
> To ensure the security of your server's admin panel, it is highly recommended to employ SSH port forwarding when running the server on a remote machine. This practice prevents exposing the admin panel's port to the public, as the connection is in plain HTTP and lacks encryption. However, you have the option to serve the admin panel via HTTPS using Taxy later on.
>
> You can serve the admin panel via HTTPS by using Taxy itself later on.
> Please note that the WebUI relies on the Secure cookie attribute to store the session token. Consequently, the WebUI will only function over HTTPS unless it's being served on localhost. It's worth mentioning that some browsers, such as Safari, may still block it even on localhost. If you intend to use the WebUI over HTTP, you can utilize the `--insecure-webui` command-line option.
# Tutorial

Expand Down
53 changes: 20 additions & 33 deletions docs/content/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,46 +16,33 @@ Before getting started, make sure to install the following prerequisites:

# Development Setup

To set up the development environment, follow these steps:
```bash
# Clone the repository
git clone https://github.com/picoHz/taxy

1. Clone the repository: `git clone https://github.com/picoHz/taxy`
2. Start the server:
# Start the server
cd taxy
cargo run

```bash
cd taxy
cargo run
```

3. In a separate terminal, start `trunk serve` for the WebUI:

```bash
cd taxy-webui
trunk serve
```
# In a separate terminal, start `trunk serve` for the WebUI
cd taxy-webui
trunk serve
```

# Building for Release

To build the project for a release, execute the following steps:

1. Build the WebUI:

```bash
cd taxy/taxy-webui
trunk build --release
```

2. In a separate terminal, build the project:

```bash
cd ..
cargo build --release
```
```bash
# Build the WebUI
cd taxy/taxy-webui
trunk build --release

3. Start the server:
# Build the Server
cd ..
cargo build --release

```bash
target/release/taxy start
```
# Start the server
target/release/taxy start
```

# Gitpod

Expand Down

0 comments on commit 557c7bc

Please sign in to comment.