Skip to content

Rustin170506/tokio-console-web

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

crates.io logo

🦀 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:

      [dependencies]
      console-subscriber = { version = "0.4.0", features = ["grpc-web"] }
    2. Configure your application to use the ConsoleLayer with gRPC-Web enabled:

      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:

    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.

      git clone https://github.com/Rustin170506/tokio-console-web.git
      cd tokio-console-web
      pnpm install
    2. Install Rust toolchain.

      curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
    3. Run pnpm dev to start the development server.

      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 server.

⚖️ License

Licensed under either of these: