---
[Homepage](https://github.com/Rustin170506/tokio-console-web)
| [Discord](https://discord.gg/EeF3cQw)
| [Contributing](#️-contributing)
## 🦀 Overview
Welcome to the `tokio-console-web` project! This project is a web-based console for the [console-subscriber] crate. It is designed to be a simple, easy-to-use, and powerful tool for monitoring and debugging your `tokio` applications.
## 🚀 Getting Started
To use `tokio-console-web`, follow these steps:
1. Enable the `grpc_web` feature in your `console-subscriber` dependency:
```toml
[dependencies]
console-subscriber = { version = "0.4.0", features = ["grpc-web"] }
```
2. Configure your application to use the `ConsoleLayer` with gRPC-Web enabled:
```rust
use std::net::Ipv4Addr;
console_subscriber::ConsoleLayer::builder()
.enable_grpc_web(true)
.server_addr((Ipv4Addr::UNSPECIFIED, 9999))
.init();
```
3. Install `tokio-console-web` using Cargo:
```sh
cargo install tokio-console-web
```
Additional installation methods can be found on the [release page](https://github.com/Rustin170506/tokio-console-web/releases).
4. Start the `tokio-console-web` server:
```sh
tokio-console-web
```
Access the web console at `http://127.0.0.1:3333` in your browser.
For more options:
```console
$ tokio-console-web --help
A web console for tokio
Usage: tokio-console-web[EXE] [OPTIONS]
Options:
--host The address to listen on [default: 127.0.0.1]
--port The port to listen on [default: 3333]
-h, --help Print help
-V, --version Print version
```
## 🛠️ Contributing
Contributions are welcome! Please feel free to submit a Pull Request. If you have any questions, please feel free to ask in the [Discord](https://discord.gg/EeF3cQw) server.
## ⚖️ License
Licensed under either of these:
- Apache License, Version 2.0, ([LICENSE-APACHE](./LICENSE-APACHE) or https://www.apache.org/licenses/LICENSE-2.0)
- MIT license ([LICENSE-MIT](./LICENSE-MIT) or https://opensource.org/licenses/MIT)
[console-subscriber]: https://crates.io/crates/console-subscriber
