# PortNote

**Repository Path**: firfe/PortNote

## Basic Information

- **Project Name**: PortNote
- **Description**: 端口笔记
- **Primary Language**: TypeScript
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-05-22
- **Last Updated**: 2026-08-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 端口笔记

使用过多个端口笔记软件，但是都不满足我的需求，所以自己开发一个。

- 功能
  - 支持扫描功能
  - 设备自动按照 IP 排序
  - 端口自动从小到大排列
  - 对连续的端口有特别标注
  - 增加端口分组功能，分组通过标签展示
  - 点击端口后自动写入剪切板
  - 支持设置宿主机，无层次限制
- 仓库
  - GitHub仓库 https://github.com/Firfr/PortNote
  - Gitee仓库 https://gitee.com/firfe/PortNote
  - DockerHub https://hub.docker.com/r/firfe/port_note
- B 站视频教程 [Nas上使用Docker部署本人开发的端口记录软件](https://www.bilibili.com/video/BV1r7Gt6mE6u/?share_source=copy_web&vd_source=556dcac19ae55e9c3e695dabb00fe591)

有问题请提 issue 或在我的B站对应的视频下留言。

欢迎关注我B站账号 [秦曱凧](https://space.bilibili.com/17547201) (读作 qín yuē zhēng)  

有需要帮忙部署这个项目的朋友,一杯奶茶,即可程远程帮你部署，需要可联系。  
微信号 `E-0_0-`  
闲鱼搜索用户 `明月人间`  
或者邮箱 `firfe163@163.com`  
如果这个项目有帮到你。欢迎start。也厚颜期待您的打赏。

## [更新日志](更新日志.md)

## 支持我

有购买服务区需求的朋友可以通过下面的通过连接来购买服务器支持我

- [腾讯云](https://curl.qcloud.com/RJz7oNIa)
- [阿里云](https://www.aliyun.com/minisite/goods?userCode=napc1zre)
- [雨云](https://www.rainyun.com/MTA0OTAwMw==_)

## 镜像

从阿里云或华为云镜像仓库拉取镜像，注意填写镜像标签，镜像仓库中没有`latest`标签

容器内部端口`5190`。

- 国内仓库
  - AMD64镜像
    ```bash
    swr.cn-north-4.myhuaweicloud.com/firfe/port_note:1.1
    ```
  - ARM64镜像
    ```bash
    swr.cn-north-4.myhuaweicloud.com/firfe/port_note:1.1-arm64
    ```
- DockerHub仓库
  - AMD64镜像
    ```bash
    firfe/port_note:1.1
    ```
  - ARM64镜像
    ```bash
    firfe/port_note:1.1-arm64
    ```

## 部署

> 注意 把下面内容中的汉字 `用户名` `密码` 改成实际的值

### docker run 命令部署

```bash
docker run -d \
--name port_note \
--network bridge \
--restart always \
--log-opt max-size=1m \
--log-opt max-file=1 \
-p 5190:5190 \
-e USER=用户名 \
-e PASS=密码 \
-v ./data:/data \
swr.cn-north-4.myhuaweicloud.com/firfe/port_note:1.1
```

### compose 文件部署 👍推荐

```yaml
#version: '3'
name: port_note
services:
  port_note:
    container_name: port_note
    image: swr.cn-north-4.myhuaweicloud.com/firfe/port_note:1.1
    network_mode: bridge
    restart: always
    logging:
      options:
        max-size: 1m
        max-file: '1'
    ports:
      - 5190:5190
    environment:
      USER: 用户名
      PASS: 密码
    volumes:
      - ./data:/data
```

## 效果截图

![效果图](图片/效果图.jpg)

## 开发运行

- 下载端口扫描软件 havn 到当前目录
  - 地址 https://github.com/mrjackwills/havn/releases/latest
  - havn_linux_aarch64.tar.gz 解压后重命名为 havn_arm64
  - havn_linux_x86_64.tar.gz  解压后重命名为 havn_amd64
- 修改文件 ./bun
  - 更换依赖加速地址和镜像地址换成自己可以访问到的，
  - 里面的地址是我局域网中专用的，外面访问不到
- 使用 Docker 方式进入开发环境
  ```bash
  bash bun
  ```
- 运行后端
  ```bash
  cd /app/server && bun dev
  ```
- 新的终端中再次进入容器
  ```bash
  bash exec
  ```
- 运行前端
  ```bash
  cd /app/web && bun dev
  ```

## 本地镜像调试

```bash
docker run --rm -it \
--name port_note \
--network bridge \
--restart no \
-p 1235:5190 \
-e USER=123 \
-e PASS=123 \
-v ./data:/data \
firfe/port_note:1.1-arm64
```