混合盘文档

Appearance

从零开始完整安装 ReMan ​

我尝试在这篇文章里面，从零开始，完整的安装 ReMan，将需要注意的地方都写出来，希望能帮助到你。

视频教程：https://www.bilibili.com/video/BV1iR2NYeE51/

准备工作 ​

下载组件包 ​

下载组件包：https://wwhb.lanzn.com/iLyLF2qj0adg

下载后解压，里面包含了以下文件：

  • docker-compose.yml
  • redis.conf
  • elasticsearch.yml
  • plugins/

通过 docker-compose.yml 我们可以一键运行 mysql, redis, elasticsearch。

通过 redis.conf 和 elasticsearch.yml 我们可以配置 redis 和 elasticsearch。 但是这两个文件可以保持默认，不需要修改。

需要修改的是，docker-compose.yml 文件中的 MYSQL_ROOT_PASSWORD 和 MYSQL_PASS 和 MYSQL_USER，这两 3 个参数，分别是 mysql 的 root 密码、普通用户密码和用户名。

yml
services:
  mysql:
    network_mode: 'bridge'
    environment:
      MYSQL_ROOT_PASSWORD: '123456'
      MYSQL_USER: 'tim'
      MYSQL_PASS: '123456'

普通用户其实没用，但也需要修改，待会我们会通过 root 用户专门来新建 reman 的数据库和用户。

安装 docker ​

请参考 /reman/docker 安装 docker。

安装成功后，可以通过以下 2 个命令查看版本：

sh
docker -v

docker compose version

这两个命令都能查看版本，如果有输出，说明安装成功。

输出参考

docker version

运行组件 ​

docker 安装完成后，将组件包解压到一个目录，然后进入该目录，运行以下命令：

为了统一文档，建议是解压到/root/env

sh
sudo docker compose up -d
输出参考

docker 正在拉取镜像:

docker正在拉取镜像

拉取完毕，启动了： 拉取完毕，启动了

创建数据库和用户：

首先找到 mysql 的容器 id：

sh
sudo docker ps
输出参考

这就是容器 ID:

这就是容器ID

然后进入 mysql 容器：

sh
sudo docker exec -it 3b19cc6bab5a bash
# 这里的 3b19cc6bab5a 是你的容器ID

进入容器后，登录 mysql：

sh
mysql -u root -p

输入 ROOT 密码（密码是你之前修改了docker-compose.yml文件里面，自己设置的），然后创建数据库和用户：

sql
CREATE DATABASE `reman` CHARACTER SET 'utf8mb4' COLLATE 'utf8mb4_general_ci';

CREATE USER `reman`@`%` IDENTIFIED BY '[password]';

GRANT Alter, Alter Routine, Create, Create Routine, Create Temporary Tables, Create View, Delete, Drop, Event, Execute, Grant Option, Index, Insert, Lock Tables, References, Select, Show View, Trigger, Update ON `reman`.* TO `reman`@`%`;

这里的 [password] 是你自己设置的密码，记得替换。

上面会创建一个名为 reman 的数据库，和一个名为 reman 的用户，密码是你自己设置的。

输出参考

进入 mysql 容器，并输入 root 密码:

进入mysql容器，并输入root密码

执行 sql 语句:

执行sql语句

至此，数据库和用户创建完成。

安装 ReMan ​

ReMan 我会给你发一个压缩包，解压后里面有一个 reman、一个 config.yml 文件，将这个文件夹放到你的服务器上，然后进入该文件夹。

如果你解压后，发现是 reman-xxxxx，请将 reman-xxxxx 改名为 reman即可。

为了统一文档，建议是解压到/root/app

修改配置文件 ​

修改 config.yml 文件，将里面的 mysql、redis、elasticsearch 的配置修改为你的配置。

app 项：

yml
app:
  mode: release
  port: 4677
  license: your license code

修改, license 为你的授权码。

cors 项：

yml
cors:
  allowCredentials: true
  allowOrigin:
    - http://localhost:*
    - http://127.0.0.1:*
    - https://example.com
    - https://www.example.com
    - http://example.com
    - http://www.example.com
  maxAge: 24h

在 allowOrigin 中，添加你的域名，如：https://example.com、https://www.example.com、http://example.com、http://www.example.com。

一般建议，把含https，不含www的域名，和含http，含www的域名都添加上。

mysql 项：

yml
db:
  database: go-re-man
  dialect: mysql
  host: 192.168.1.21
  username: root
  password: 123456
  port: 3306
  autoMigrate: true

修改 host、username、password 为你的 mysql 配置。

一般为：

yml
db:
  database: reman
  dialect: mysql
  host: 127.0.0.1
  username: reman
  password: 这里填写你的密码，在上面创建用户时设置的密码，不是root密码
  port: 3306
  autoMigrate: true

Es 项：

yml
es:
  enable: true
  address: http://127.0.0.1:9200
  diskIndex: reman-disk-v1

修改 address 为你的 elasticsearch 配置，一般修改地址为 http://127.0.0.1:9200即可，因为我们是在同一台服务器上。

jwt 项：

yml
jwt:
  secret: secret
  expire: 24h
  issuer: reman

修改 secret 为你的 jwt 密钥，expire 为过期时间，issuer 为签发者。

你需要将 secret 和修改为不少于 32 位的随机字符串。

不然你将得到如下错误：panic: jwt.secret must be configured and the length is greater than 10

expire: 登录过期时间，单位是小时，默认 24 小时，过期后需要重新登录。

redis 项：

yml
redis:
  addr: 127.0.0.1:6379
  db: 0
  password: ''

因为我们是在同一台服务器上，所以只需要将 addr 改为 127.0.0.1:6379即可。

第一次运行 ​

以下命令需要在 reman 目录下运行，即：/root/app/

运行：

sh
chmod +x reman
./reman

这只是暂时运行，后面我们会使用 pm2 来管理。

输出参考

首次成功运行参考：

首次成功运行参考

你需要找到类似这个输出：

Admin user created, username: admin, password: r1a8O8H7

这个是你的管理员账号和密码，后面在 ReMan 后台我们会使用这个账号登录。

然后，按 Ctrl + C 退出。

使用 pm2 管理 ​

安装 pm2 参考：/reman/pm2

安装成功后，运行：

以下命令需要在 reman 目录下运行，即：/root/app/

sh
pm2 start reman

然后运行：

sh
pm2 save # 保存当前进程
pm2 startup # 开机自启

这样，ReMan 就会在后台运行了。

查询状态：

sh
pm2 ls
输出参考

pm2 ls

Caddy/Nginx ​

经过上面的步骤，ReMan 已经可以正常运行了，但是它是运行在本地的 4677 端口，所以我们还需要一个反向代理，比如 Caddy 或者 Nginx。

对于小白，我推荐使用 Caddy，因为它配置简单，而且自带 HTTPS。

请参考：/reman/caddy 安装 Caddy

简单步骤与命令参考如下（汇总）：

使用systemd管理caddy
sh
sudo groupadd --system caddy

sudo useradd --system \
    --gid caddy \
    --create-home \
    --home-dir /var/lib/caddy \
    --shell /usr/sbin/nologin \
    --comment "Caddy web server" \
    caddy


# 假设在当前目录下，有一个叫 caddy_linux_amd64 的文件
mv caddy_linux_amd64 /usr/local/sbin/caddy
chmod +x /usr/local/sbin/caddy
mkdir /etc/caddy
touch /etc/caddy/Caddyfile


cd /etc/systemd/system
vim caddy.service
caddy.service
txt
# caddy.service
#
# For using Caddy with a config file.
#
# Make sure the ExecStart and ExecReload commands are correct
# for your installation.
#
# See https://caddyserver.com/docs/install for instructions.
#
# WARNING: This service does not use the --resume flag, so if you
# use the API to make changes, they will be overwritten by the
# Caddyfile next time the service is restarted. If you intend to
# use Caddy's API to configure it, add the --resume flag to the
# `caddy run` command or use the caddy-api.service file instead.

[Unit]
Description=Caddy
Documentation=https://caddyserver.com/docs/
After=network.target network-online.target
Requires=network-online.target

[Service]
Type=notify
User=caddy
Group=caddy
ExecStart=/usr/local/sbin/caddy run --environ --config /etc/caddy/Caddyfile
ExecReload=/usr/local/sbin/caddy reload --config /etc/caddy/Caddyfile --force
TimeoutStopSec=5s
LimitNOFILE=1048576
LimitNPROC=512
PrivateTmp=true
ProtectSystem=full
AmbientCapabilities=CAP_NET_ADMIN CAP_NET_BIND_SERVICE

[Install]
WantedBy=multi-user.target
Caddyfile

以下内容保存在：/etc/caddy/Caddyfile

txt
{
    email test@example.com
}

example.com www.example.com {
    reverse_proxy http://127.0.0.1:4677
}

启动并开机自启：

sh
sudo systemctl daemon-reload
sudo systemctl enable --now caddy

程序更新 ​

请参考：/reman/help-install

关闭防火墙 ​

建议服务器仅开放：22，80，443端口，其他端口都关闭。

ReMan 目前依赖的服务涉及的端口如下 ：3306、6379、9200、4677、9300、80、443。

其中，特别是 3306、6379、9200、9300 这几个端口，是必须关闭的，这涉及到数据安全问题，不然容易被别人连接。

特别强调： 不要信任宝塔的防火墙功能，请务必在服务器商提供的后台进行防火墙设置，宝塔的功能基于系统，但是某些厂商的提供的系统有问题。

特别强调： 不要信任宝塔的防火墙功能，请务必在服务器商提供的后台进行防火墙设置，宝塔的功能基于系统，但是某些厂商的提供的系统有问题。

特别强调： 不要信任宝塔的防火墙功能，请务必在服务器商提供的后台进行防火墙设置，宝塔的功能基于系统，但是某些厂商的提供的系统有问题。

雨云防火墙参考：

宝塔防火墙