入门安装
本文档提供了从头开始安装 node-hiprint-transit 服务器的详细说明。Node-hiprint-transit 是一个中继服务器,它促进了 Web 客户端 (vue-plugin-hiprint) 和 electron-hiprint 客户端之间的通信,以实现无缝打印操作。有关安装后配置服务器的信息,请参阅"配置"部分。
先决条件
在安装 node-hiprint-transit 之前,请确保您的系统满足以下要求:
- Node.js (版本 14.x 或更高)
- npm (通常随 Node.js 一起提供)
- Git (用于克隆代码仓库)
- 足够的权限来安装软件包和运行脚本
安装方法
安装 node-hiprint-transit 主要有两种方法:使用一键安装脚本(推荐给大多数用户)或手动安装(适用于需要更精细控制安装过程的用户)。
一键安装脚本 (推荐)
一键安装脚本是启动和运行 node-hiprint-transit 的最快方法。它通过一个命令处理下载代码仓库、安装依赖项和初始设置。
- 下载安装脚本:
- 使脚本可执行:
- 运行脚本:
该脚本将引导您完成整个安装过程,包括设置初始配置。
手动安装
如果您倾向于手动安装服务器,请按照以下步骤操作:
- 克隆代码仓库:
- 导航到克隆的目录:
- 安装依赖项:
- 运行初始化脚本:
- 按照初始化提示配置服务器。
初始化过程
在初始化过程中,系统会提示您配置几个设置:
初始化脚本将提示您配置:
- 语言(Language):选择英语或简体中文。
- 端口(Port):指定通信端口(默认为 17521)。
- 令牌(Token):设置用于身份验证的安全令牌(至少 6 个字符,可以包含
*作为通配符)。 - SSL:启用或禁用 SSL 以进行安全连接(默认为否)。
如果您以后需要更改这些设置,只需再次运行初始化脚本即可。
安装后的目录结构
安装后,您的 node-hiprint-transit 目录将包含以下关键组件:
| 目录/文件 | 描述 |
|---|---|
dist/ | 包含编译后的服务器文件 |
src/ | 服务器的源代码 |
logs/ | 服务器日志 (首次运行后创建) |
config.json | 服务器配置 (初始化期间创建) |
package.json | 项目依赖项和脚本 |
src/ssl.key | SSL 私钥 (如果启用了 SSL) |
src/ssl.pem | SSL 证书 (如果启用了 SSL) |
启动服务器
安装和初始化后,您可以使用以下命令启动服务器:
如果服务器成功启动,您应该会看到类似以下的输出:
Server is running at
https://your-server-address:17521
Make sure your security group or firewall has allowed the port.
Token: yourtokenhere*验证
要验证安装是否成功以及服务器是否正常运行:
- 检查服务器是否正在运行并在配置的端口上监听。
- 确保控制台输出中没有出现错误。
- 验证日志是否已写入
logs目录。 - 使用 Web 客户端 (
vue-plugin-hiprint) 或electron-hiprint客户端测试连接性。
使用 vue-plugin-hiprint 测试连接
使用 electron-hiprint 测试连接
打开 electron-hiprint,右键单击托盘图标以访问设置,然后输入您的服务器地址、端口和令牌。单击"测试"按钮以验证连接。
常见安装问题故障排除
SSL 相关问题
如果您启用了 SSL 但遇到连接问题:
- 确保您已将默认的 SSL 证书和密钥文件(
src/ssl.key和src/ssl.pem)替换为您自己的有效证书。 - 验证您的证书格式是否正确且未过期。
端口冲突
如果服务器因端口冲突而无法启动:
- 在初始化期间选择一个不同的端口。
- 确保没有其他服务正在使用您选择的端口。
- 检查防火墙设置以确保端口已打开。
依赖项问题
如果您遇到与缺少依赖项相关的错误:
- 尝试删除
node_modules目录并再次运行npm install。 - 确保您使用的是兼容的 Node.js 版本。
- 检查 npm 安装输出中的错误消息。
后续步骤
成功安装 node-hiprint-transit 后,您应该:
- 了解如何根据您的特定需求配置服务器 - 请参阅"配置"。
- 学习如何设置 SSL/TLS 以实现安全连接 - 请参阅"SSL/TLS 设置"。
- 探索 Web 客户端和
electron-hiprint客户端之间的通信流程 - 请参阅"客户端通信"。