安装指南

本指南将帮助您安装和配置我们的产品。请按照以下步骤操作。

系统要求

操作系统：Windows 10/11、macOS 10.15+、Linux (Ubuntu 20.04+)
内存：最低 4GB RAM，推荐 8GB 或更多
存储空间：至少 2GB 可用空间
浏览器：Chrome 90+、Firefox 88+、Safari 14+、Edge 90+

安装方式

方式一：使用 NPM 安装

# 安装核心包
npm install @product/core
 
# 安装插件（可选）
npm install @product/plugins-basic

方式二：使用 Docker

# 拉取最新镜像
docker pull product/knowledge-base:latest
 
# 运行容器
docker run -p 3000:3000 product/knowledge-base:latest

方式三：直接下载

访问我们的下载页面
选择适合您系统的安装包
下载并运行安装程序
按照安装向导的提示完成安装

配置

安装完成后，您需要进行一些基本配置：

1. 创建配置文件

在项目根目录创建 config.json 文件：

{
  "appName": "我的知识库",
  "theme": "light",
  "database": {
    "type": "sqlite",
    "path": "./data.db"
  },
  "server": {
    "port": 3000,
    "host": "localhost"
  }
}

2. 设置环境变量

创建 .env 文件：

SECRET_KEY=your_secret_key_here
ADMIN_PASSWORD=your_admin_password
DEBUG=false

3. 初始化数据库

运行以下命令初始化数据库：

npx product-cli init-db

启动应用

配置完成后，您可以使用以下命令启动应用：

npx product-cli start

应用将在 http://localhost:3000 上运行。

验证安装

访问 http://localhost:3000/admin 并使用您设置的管理员密码登录，确认系统正常运行。

常见问题

安装失败

如果安装过程中遇到问题，请检查：

系统是否满足最低要求
网络连接是否正常
是否有足够的权限

无法启动服务

如果服务无法启动，请检查：

端口 3000 是否被占用
配置文件是否正确
日志文件中是否有错误信息

下一步

基本使用 - 学习如何使用系统的基本功能
高级配置 - 了解更多高级配置选项

安装指南

On this page