Skip to content

Latest commit

 

History

History
152 lines (97 loc) · 5.59 KB

INSTALL.md

File metadata and controls

152 lines (97 loc) · 5.59 KB
Raw

安装指南

注意：如果你想使用 CafeMaker 的 API，请参考 项目 wiki 并离开此页。

警告：除非你需要自己部署 CafeMaker 实例，否则你并不需要关心这里的内容。这里列出来的内容仅限希望向 CafeMaker 或 xivapi 贡献代码的开发者使用。

提醒：这篇指南将花掉你六个小时的宝贵生命，并且需要准备一台有 16G 以上内存的服务器。

初始化

安装 docker

apt-get update
apt-get install --no-install-recommends docker.io
docker network create --subnet=172.16.54.0/24 cafemaker

起服务

手动

docker pull quay.io/ffcafe/cafemaker

mkdir -p /srv/cafemaker/data/redis /srv/cafemaker/data/mysql /srv/cafemaker/data/elasticsearch /srv/cafemaker/data/web
chown 1000:1000 /srv/cafemaker/data/elasticsearch/

wget -O /srv/cafemaker/dotenv https://raw.githubusercontent.com/thewakingsands/cafemaker-web/cn/.env.dist

docker run -d --name=cafemaker__redis --restart=always --network=cafemaker -v /srv/cafemaker/data/redis:/data redis
docker run -d --name=cafemaker__mysql --restart=always --network=cafemaker -v /srv/cafemaker/data/mysql:/var/lib/mysql -e MYSQL_ROOT_PASSWORD=root mysql:5.7
docker run -d --name=cafemaker__elasticsearch --restart=always --network=cafemaker -e "discovery.type=single-node" -e "ES_JAVA_OPTS=-Xms4G -Xmx4G" -v /srv/cafemaker/data/elasticsearch:/usr/share/elasticsearch/data elasticsearch:6.8.1

docker exec -it cafemaker__elasticsearch elasticsearch-plugin install analysis-smartcn

docker run -d --name=cafemaker__web --restart=always --network=cafemaker -p 8081:80 -v /srv/cafemaker/data/web:/vagrant/data -v /srv/cafemaker/dotenv:/vagrant/.env quay.io/ffcafe/cafemaker

使用 docker-compose

docker pull quay.io/ffcafe/cafemaker
docker-compose up --no-build
docker exec -it cafemaker_elasticsearch_1 elasticsearch-plugin install analysis-smartcn

导入数据库

curl https://raw.githubusercontent.com/thewakingsands/cafemaker-web/cn/vm/Database.sql | docker exec -i cafemaker__mysql mysql -uroot -proot

到这里你应该可以访问服务器的 8081 端口，看到 xivapi 的界面了。

Discord 登录

去 https://discordapp.com/developers/applications/ 申请一个 app，设置回调 url 为 hxxp://yourdomain.example/account/login/discord/success 。

编辑服务器上的 /srv/cafemaker/dotenv 文件，设置 DISCORD_CLIENT_ID, DISCORD_CLIENT_SECRET, DISCORD_BOT_USAGE_KEY 即可。

导入游戏数据

每次游戏更新，或者第一次初始化，都需要重新导入游戏数据。导入游戏数据的时候，准备一个 Windows 机器，需要安装 .NET Framework 4.5 以上版本，并且安装了 FF14 客户端。

回到服务器，在服务器上执行：

docker exec -it cafemaker__web bash

进入 cafemaker__web 的容器 shell。以下操作均在 cafemaker web 容器的 shell 中完成。

下载 SaintCoinach 和定义文件

bash /cafemaker/bin/sc-download.sh

这里会从 GitHub 上拖文件。如果国内服务器，可能拖不回来，可以尝试用一些 GitHub Proxy。

# 首先：
export SC_DOWNLOAD_PREFIX=https://download.fastgit.org
# 或者……
# export SC_DOWNLOAD_PREFIX=https://gh.api.99988866.xyz/https://github.com
# export SC_DOWNLOAD_PREFIX=https://ghproxy.com/https://github.com
# export SC_DOWNLOAD_PREFIX=https://mirror.ghproxy.com/https://github.com
# export SC_DOWNLOAD_PREFIX=https://github.techoc.workers.dev/https://github.com

# 然后
bash /cafemaker/bin/sc-download.sh

脚本除了下载定义文件，还会将 json 拼合到一起，给 xivapi 使用。

解包游戏数据

到服务器上，下载 /srv/cafemaker/data/web/SaintCoinach.Cmd 整个文件夹到 Windows 电脑中。

编辑 extract-allrawexd.bat 文件，将其中游戏路径改为你自己安装的游戏路径。保存后，双击运行该文件。

下载 https://github.com/xivapi/ffxiv-datamining/raw/master/csv/ENpcResident.csv 文件，并将它放到 游戏版本号/raw-exd-all/ 文件夹下，改名为 ENpcResident.en.csv 。如果你有和国服对应版本的这个文件，用对应版本的更佳。

然后把生成的以游戏版本号命名的文件夹传回服务器上。

下载补丁数据

这部分数据包含每个物品是在哪个补丁被添加到游戏的，由 xivapi 维护。

bash /cafemaker/bin/sc-gamepatch.sh

如果国内服务器下载太慢的话，可以尝试加速：

export SC_CLONE_PREFIX=https://hub.fastgit.org

# 或者……
# export SC_CLONE_PREFIX=https://gh.api.99988866.xyz/https://github.com
# export SC_CLONE_PREFIX=https://ghproxy.com/https://github.com
# export SC_CLONE_PREFIX=https://mirror.ghproxy.com/https://github.com
# export SC_CLONE_PREFIX=https://github.techoc.workers.dev/https://github.com

导入游戏数据到 Redis

这部分比较吃内存，还吃单核性能，需要有一个大点内存的服务器。至少有 8G，推荐 16G。

如果内存不够，可以用 swap 补，保证 swap+剩余内存 >= 6G 即可。开 swap 强行撑内存跑会导致跑得很慢。

继续在容器 shell 中操作：

bash /cafemaker/bin/sc-import-redis.sh
bash /cafemaker/bin/sc-custom-redis.sh

执行两个脚本大概需要……呃，一小时左右吧。

导入游戏数据到 ElasticSearch

导入 ES 需要跑 ES 的机器有大内存，给 ES 分 4~8G 内存最好。

继续去 bash 里执行：

bash /cafemaker/bin/sc-import-es.sh

等跑完即可。跑这个比前两个还慢，可能需要一两个小时。