diff --git a/README.md b/README.md index 2977457..4f77f37 100644 --- a/README.md +++ b/README.md @@ -76,7 +76,7 @@ ```bash mkdir ./nexus-terminal && cd ./nexus-terminal ``` -下载仓库的 [**docker-compose.yml**](https://raw.githubusercontent.com/Heavrnl/nexus-terminal/refs/heads/main/docker-compose.yml) 和 [**.env**](https://raw.githubusercontent.com/Heavrnl/nexus-terminal/refs/heads/main/.env) 到目录下 +下载仓库的 [**docker-compose.yml**](https://raw.githubusercontent.com/Heavrnl/nexus-terminal/refs/heads/main/docker-compose.yml) 和 [**.env**](https://raw.githubusercontent.com/Heavrnl/nexus-terminal/refs/heads/main/.env) 到目录下(arm64 用户请查看下方的注意事项) ```bash wget https://raw.githubusercontent.com/Heavrnl/nexus-terminal/refs/heads/main/docker-compose.yml -O docker-compose.yml && wget https://raw.githubusercontent.com/Heavrnl/nexus-terminal/refs/heads/main/.env -O .env @@ -157,11 +157,15 @@ docker-compose up -d ### 通用操作 1. **缩放**:在终端、文件管理器和文本编辑器组件中,可以使用 `Ctrl + 鼠标滚轮` 进行缩放。 +2. **侧栏**:展开的侧栏可以通过拖拽调节宽度。 ## ⚠️ 注意事项 1. **双文件管理器**:可以在布局中添加两个文件管理器组件(实验性功能,可能存在不稳定情况)。 2. **多文本编辑器**:在同一布局中添加多个文本编辑器的功能尚未实现。 +3. ARM64 用户请使用此处的 [docker-compose.yml](https://github.com/Heavrnl/nexus-terminal/blob/main/doc/arm/docker-compose.yml)。由于 Apache Guacamole 未提供 guacd 的 ARM 架构镜像,所以禁用 RDP 功能,相关镜像暂时不再拉取。 + + ## ☕ 捐赠 diff --git a/doc/README_EN.md b/doc/README_EN.md index 4797a3b..d6e52ef 100644 --- a/doc/README_EN.md +++ b/doc/README_EN.md @@ -88,7 +88,9 @@ location / { } ``` -To configure IPv6 for Docker, add the following content to `/etc/docker/daemon.json`: +Configure IPv6 for Docker (optional — you can skip this if you don't use IPv6 to connect to the server). + +Add the following content to `/etc/docker/daemon.json`: ```json { "ipv6": true, @@ -143,11 +145,13 @@ Here are some implicit practical features. ### General Operations 1. **Zoom**: In the terminal, file manager, and text editor components, you can use `Ctrl + Mouse Wheel` to zoom. +2. **Sidebar**: The expanded sidebar can have its width adjusted by dragging. ## ⚠️ Notes 1. **Dual File Managers**: You can add two file manager components in the layout (experimental feature, may be unstable). 2. **Multiple Text Editors**: The functionality to add multiple text editors in the same layout has not yet been implemented. +3. ARM64 users, please use the [docker-compose.yml](https://github.com/Heavrnl/nexus-terminal/blob/main/doc/arm/docker-compose.yml) provided here. Since Apache Guacamole does not provide an ARM architecture image for `guacd`, the RDP feature has been disabled, and the related image will no longer be pulled for the time being. ## ☕ Donate @@ -159,4 +163,4 @@ If you find this project helpful, feel free to buy me a coffee through the follo ## 📄 License -This project is licensed under the [GPL-3.0](LICENSE) license. See the [LICENSE](LICENSE) file for details. \ No newline at end of file +This project is licensed under the [GPL-3.0](LICENSE) license. See the [LICENSE](LICENSE) file for details. diff --git a/doc/arm/docker-compose.yml b/doc/arm/docker-compose.yml new file mode 100644 index 0000000..4fa0681 --- /dev/null +++ b/doc/arm/docker-compose.yml @@ -0,0 +1,59 @@ +services: + frontend: + image: heavrnl/nexus-terminal-frontend + container_name: nexus-terminal-frontend + ports: + - "18111:80" + depends_on: + - backend +# - rdp + networks: + - nexus-terminal-network + + backend: + image: heavrnl/nexus-terminal-backend + container_name: nexus-terminal-backend + env_file: + - .env + environment: + NODE_ENV: production + PORT: 3001 + RDP_BACKEND_API_BASE: http://rdp:9090 + volumes: + - ./data:/app/data + networks: + - nexus-terminal-network + +# rdp: +# image: heavrnl/nexus-terminal-rdp +# container_name: nexus-terminal-rdp +# environment: +# GUACD_HOST: guacd +# GUACD_PORT: 4822 +# API_PORT: 9090 +# GUAC_WS_PORT: 8081 +# FRONTEND_URL: http://frontend +# MAIN_BACKEND_URL: http://backend:3001 +# NODE_ENV: production +# networks: +# - nexus-terminal-network +# depends_on: +# - guacd +# - backend + +# guacd: +# image: guacamole/guacd:latest +# container_name: nexus-terminal-guacd +# networks: +# - nexus-terminal-network +# restart: unless-stopped + +networks: + nexus-terminal-network: + driver: bridge + name: nexus-terminal-network + enable_ipv6: true + ipam: + config: + - subnet: fd01::/80 + gateway: fd01::1