yinxin630--fiora/packages/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/INSTALL.md

id, title, sidebar_label

id	title	sidebar_label
install	安装	安装

环境准备

要运行 Fiora, 你需要 Node.js(推荐 v14 LTS 版本), MongoDB 和 redis

• 安装 Node.js
  • 官网 http://nodejs.cn/download/
  • 更推荐使用 nvm 安装 Node.js
    • 安装 nvm https://github.com/nvm-sh/nvm#install--update-script
    • 通过 nvm 安装 Node.js https://github.com/nvm-sh/nvm#usage
• 安装 MongoDB
  • 官网 https://docs.mongodb.com/manual/installation/#install-mongodb
• 安装 redis
  • 官网 https://redis.io/topics/quickstart

推荐在 Linux 或者 MacOS 系统上运行

如何运行

1. 克隆项目到本地 git clone https://github.com/yinxin630/fiora.git -b master
2. 确保安装了 yarn, 如果没有安装请执行 npm install -g yarn
3. 安装项目依赖 yarn install
4. 构建客户端代码 yarn build:web
5. 配置 JwtSecret echo "JwtSecret=<string>" > .env2. 要将 <string> 替换为一个秘密文本
6. 启动服务端 yarn start
7. 使用浏览器打开 http://[ip地址]:[端口](比如 http://127.0.0.1:9200)

在后台运行

使用 yarn start 运行服务端会在断开 ssh 连接后停止运行, 推荐使用 pm2 来运行

# 安装 pm2
npm install -g pm2

# 使用 pm2 运行 fiora
pm2 start yarn --name fiora -- start

# 查看 pm2 应用状态
pm2 ls

# 查看 pm2 fiora 日志
pm2 logs fiora

运行开发模式

1. 启动服务端 yarn dev:server
2. 启动客户端 yarn dev:web
3. 使用浏览器打开 http://localhost:8080

docker 运行

首先安装 docker https://docs.docker.com/install/

直接从 DockerHub 镜像运行

# 拉取 mongo
docker pull mongo

# 拉取 redis
docker pull redis

# 拉取 fiora
docker pull suisuijiang/fiora

# 创建虚拟网络
docker network create fiora-network

# 启动 mongodB
docker run --name fioradb -p 27017:27017 --network fiora-network mongo

# 启动 redis
docker run --name fioraredis -p 6379:6379 --network fiora-network redis

# 启动 fiora
docker run --name fiora -p 9200:9200 --network fiora-network -e Database=mongodb://fioradb:27017/fiora -e RedisHost=fioraredis suisuijiang/fiora

本地构建镜像运行

1. 克隆项目到本地 git clone https://github.com/yinxin630/fiora.git -b master
2. 构建镜像 docker-compose build --no-cache --force-rm
3. 运行 docker-compose up