/nextus-bst

Primary LanguageShellMIT LicenseMIT

Notice(注意)

This repo is used to host the Docker configuration of Nextus.

This configuration helps Nextus users quickly build a Nextus backend, including convenient schema updates and flexible and configurable deployment solutions.

本仓库用于托管Nextus的docker配置。

此配置帮助Nextus用户快速搭建Nextus后端,包含了便捷的Schema更新,以及灵活、可配置的部署方案。

Requirements(要求)

Here are some pre requirements.

如下是一些前置要求。

  • git
  • docker compose version 2.20 and later
  • docker desktop version 4.22 and later

Getting started(快速上手)

# clone or this repo and download to your computer.
# 克隆或者folk一份此仓库,并下载到你的本地电脑
git clone https://github.com/luochuanyuewu/nextus-docker.git nextus_backend && cd nextus_backend

# make sure startup.sh executable. 让startup.sh可执行
chmod +x startup.sh

# copy .env.sample to .env, and eiting relevant configuration. 复制.env.sample为.env,并编辑相关的配置。
cp .env.sample .env

# starting nextus backend 启动nextus后端
docker compose up -d

# stoping nextus backend 关闭nextus后端
docker compose down

Updating(更新)

To avoid conflict, backup first!

# updating repo to get latest schema.yml 更新仓库以获取最新的schema
git pull origin main

# restart your nextus_backend 重启你的nextus后端
docker compose restart

# or recreate your backend 或者重建你的nextus后端
docker compose down
docker compose up -d

Take snapshot(schema备份)

In case you modified your schema in production envrionments.

如果你在产品环境下修改了schema。

docker compose exec directus node cli.js schema snapshot /directus/snapshots/schema.yml --yes

Backup(备份)

# make sure scripts executable. 确保脚本有执行权限
chmod +x backup.sh

# run this
./backup.sh

# now your extensions, uploads and data are saved and located in backup folder.

Restore(还原)

# make sure scripts executable. 确保脚本有执行权限
chmod +x restore.sh

# run this
./restore.sh

# now your extensions, uploads and data are restored from backup folder.

Custom(自定义)

Sometimes, you want adding more package to directus instance, all you have to do is making changes to Dockerfile and use docker-build.yml as your primary compose.

有时候,你想要给directus实例安装更多的包,你只需要编辑修改提供的Dockerfile,并使用docker-build.yml作为你的编排文件即可。

# starting nextus backend 启动nextus后端
docker compose -f docker-build.yml up -d

# stoping nextus backend 关闭nextus后端
docker compose -f docker-build.yml down

For more detailed guides, follow this link.

更多细节请查看这个链接 link.

Troubleshooting(权限问题)

Permission issuse(权限问题)

chmod +x startup.sh backup.sh restore.sh
chmod -R 777 snapshots extensions uploads