# blinksocks-gui > A web based GUI wrapper for blinksocks Latest version **0.3.1** (published 2018-11-24) · Apache-2.0 license · 0 weekly downloads ## Install ```sh npm install blinksocks-gui pnpm add blinksocks-gui yarn add blinksocks-gui bun add blinksocks-gui ``` Provides the command `blinksocks-gui`. ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.3.1 | | Published | 2018-11-24 | | First published | 2018-04-04 | | Weekly downloads | 0 | | License | Apache-2.0 | | TypeScript types | none | | Module format | CommonJS | | Node | 8 | | Dependencies | 18 | | Unpacked size | 3.3 MB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 38 | | Author | Micooz | | Maintainers | micooz | ## Links - npm: https://www.npmjs.com/package/blinksocks-gui - Repository: https://github.com/blinksocks/blinksocks-gui - Homepage: https://github.com/blinksocks/blinksocks-gui#readme - Issues: https://github.com/blinksocks/blinksocks-gui/issues - npm.io page: https://npm.io/package/blinksocks-gui ## Dependencies (18) - [koa](https://npm.io/package/koa.md) ^2.5.1 - [chalk](https://npm.io/package/chalk.md) ^2.4.1 - [jssha](https://npm.io/package/jssha.md) ^2.3.1 - [lowdb](https://npm.io/package/lowdb.md) ^1.0.0 - [lodash](https://npm.io/package/lodash.md) ^4.17.10 - [prompts](https://npm.io/package/prompts.md) ^0.1.8 - [winston](https://npm.io/package/winston.md) ^3.0.0-rc4 - [date-fns](https://npm.io/package/date-fns.md) ^1.29.0 - [fs-extra](https://npm.io/package/fs-extra.md) ^6.0.1 - [pidusage](https://npm.io/package/pidusage.md) ^2.0.6 - [lodash-id](https://npm.io/package/lodash-id.md) ^0.14.0 - [socket.io](https://npm.io/package/socket.io.md) ^2.1.1 - [koa-router](https://npm.io/package/koa-router.md) ^7.4.0 - [koa-favicon](https://npm.io/package/koa-favicon.md) ^2.0.1 - [sudo-prompt](https://npm.io/package/sudo-prompt.md) ^8.2.0 - [node-ipc-call](https://npm.io/package/node-ipc-call.md) 0.0.3 - [koa-bodyparser](https://npm.io/package/koa-bodyparser.md) ^4.2.1 - [koa-static-cache](https://npm.io/package/koa-static-cache.md) ^5.1.2 ## Recent versions - 0.3.1 (latest) — 2018-11-24 - 0.3.0 — 2018-05-14 - 0.2.1 — 2018-04-11 - 0.2.0 — 2018-04-11 - 0.1.0 — 2018-04-04 ## README # blinksocks-gui [![version](https://img.shields.io/npm/v/blinksocks-gui.svg)](https://www.npmjs.com/package/blinksocks-gui) [![downloads](https://img.shields.io/npm/dt/blinksocks-gui.svg)](https://www.npmjs.com/package/blinksocks-gui) [![license](https://img.shields.io/npm/l/blinksocks-gui.svg)](https://github.com/blinksocks/blinksocks-gui/blob/master/LICENSE) [![%e2%9d%a4](https://img.shields.io/badge/made%20with-%e2%9d%a4-ff69b4.svg)](https://github.com/blinksocks/blinksocks-gui) > 为 [blinksocks](https://github.com/blinksocks/blinksocks) 封装的 WEB 图形化界面。 ![](screenshot-0.png) ![](screenshot-1.png) ## 特性 - 三大平台支持（Windows、Linux、macOS） - 双端图形化界面 - 单机服务多开 - 远程服务配置、启动/停止 - 实时监控图表（CPU、内存、上下行速度、网络连接数、网络流量） - 日志查看和搜索 ## 安装 ### 使用 npm 安装或升级（推荐） 在此之前，请先安装 [Node.js](https://nodejs.org/en/)，Node.js 自带 npm 包管理器。 > Tips: 如果你是在服务端（一般是 Linux）上使用，可以使用官方提供的安装脚本： > https://nodejs.org/en/download/package-manager/#installing-node-js-via-package-manager 然后执行下面的命令安装 blinksocks 和 blinksocks-gui： ``` $ npm install -g blinksocks blinksocks-gui ``` 需要升级时重新执行上面的命令即可。 ## 启动 ### 交互式启动 ``` $ NODE_ENV=production blinksocks-gui ``` 根据提示选择启动类型（客户端或者服务端）： ``` ? Please choose run type › - Use arrow-keys. Return to submit. ❯ Client Server ``` 选择一个端口号用于远程访问图形界面： ``` ✔ Please choose run type › Client ? Please choose a port(1 ~ 65535) for web ui: › 3000 ``` 完成后在**浏览器**中打开提示链接即可： ``` ✔ Please choose run type › Client ✔ Please choose a port(1 ~ 65535) for web ui: … 3000 info: blinksocks gui client is running at 3000. info: You can now open blinksocks-gui in browser: http://localhost:3000/ ``` ### 一行命令启动 ``` $ blinksocks-gui --client --port 3000 ``` > Tips: 第一次启动时，程序会自动创建一个 `root` 用户，初始密码为 `root`，在 `/landing` 页面输入初始密码后登录系统。 ## 修改初始登录密码 转到 `/settings` 页面或点击左侧 `Settings` 菜单进入系统配置面板修改相关配置并保存。 ## 开发指引 ### 拉取仓库并初始化 ``` $ git clone https://github.com/blinksocks/blinksocks-gui $ cd blinksocks-gui $ git submodule update --init ``` ### 安装依赖 **core 模块安装** ``` $ cd core $ npm install $ npm install --no-save blinksocks ``` **ui 模块安装** ``` $ cd ui $ npm install ``` ### 启动调试 启动本地 HTTP/WebSocket 服务： ``` $ cd core && npm run start:client ``` 启动前端开发服务器： ``` $ cd ui && npm start ``` 根据提示打开链接开始调试。 ### 编译和打包 只需要编译打包前端代码，完成后会自动替换 `core/public` 里的内容： ``` $ cd ui && npm run build ``` ### 发布 只需发布 `core/` 里的内容到 npm registry 即可： ``` $ cd core $ npm publish ``` ## 更新日志 [CHANGELOG.md](CHANGELOG.md) ## License Apache License 2.0 --- _Source: https://npm.io/package/blinksocks-gui · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._