https://github.com/rustin170506/tokio-console-web
A Web Interface for the Tokio Console.
https://github.com/rustin170506/tokio-console-web
Last synced: about 1 year ago
JSON representation
A Web Interface for the Tokio Console.
- Host: GitHub
- URL: https://github.com/rustin170506/tokio-console-web
- Owner: Rustin170506
- License: mit
- Archived: true
- Created: 2023-11-28T14:08:58.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-04T18:51:44.000Z (over 1 year ago)
- Last Synced: 2025-04-16T07:26:42.144Z (about 1 year ago)
- Language: TypeScript
- Homepage: https://console.rustin.me
- Size: 1.88 MB
- Stars: 18
- Watchers: 2
- Forks: 1
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
---
[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 gRPC-Web:**
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();
```
2. **Using Docker (Recommended):**
You can quickly get started by pulling the Docker image:
```sh
docker pull ghcr.io/rustin170506/tokio-console-web:latest
docker run -p 3000:3000 ghcr.io/rustin170506/tokio-console-web:latest
```
3. **Manual Setup:**
If you prefer to set up manually, follow these steps:
1. Clone this repository and run `pnpm install` to install the dependencies.
```sh
git clone https://github.com/Rustin170506/tokio-console-web.git
cd tokio-console-web
pnpm install
```
2. Install Rust toolchain.
```sh
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```
3. Run `pnpm dev` to start the development server.
```sh
pnpm dev
```
4. Access the web console at `http://127.0.0.1:3000` in your browser.
## 🛠️ 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