Skip to content

Latest commit

 

History

History
110 lines (80 loc) · 2.77 KB

README.md

File metadata and controls

110 lines (80 loc) · 2.77 KB

An Ambitious NginxUI for Stream.

Discord Link license

Introduction

Features

  • Friendly UI
  • Easier Setup
  • Docker Support
  • Nginx Cluster Support
  • Rich Configuration Tips
  • Flexible Choice of Scenarios
  • Make Set the Stream Module More Easy
  • Local Web Terminal
  • Visual Log

Table of Contents

Getting Started

Installation

TODO

How to Develop

Prerequisites

  • Docker (latest version preferred)

    or

  • Node.js (>= 12.10 required, >= 14.17 preferred)

  • npm (>= 6.x) or yarn (>= 1.22)

  • Git (>= 2.0)

  1. Build dependencies pnpm install
  2. Run project pnpm start

Snapshot

Module

module

Terminal

local terminal

Stream

stream-list stream-modify batch-action

Upstream

upstream upstream-modify

Roadmap

The following are the features I want to achieve or are under development:

  • use pnpm workspace to manage multiple projects
  • build service use PKG for docker
  • unit test
  • support cluster
  • batch operation, such as add, start, stop, restart, delete
  • config export and import
  • tcp delay on rule card
  • x-forward-cli, install uninstall update
  • client manage page
  • user system
  • control traffic
  • log dashboard
  • ssh for client
  • better UI

Release Notes

SEE CHANGELOG

Others

packages/vue

  • New UI base daisyui
  • New JavaScript Framework build with Vue3、Pinia、Vue-Router、Vite
  • 100% component library build by myself (may become component library in future)