Deploying Mix Space

Intro

Use a system with at least 1 core and 1 GB of RAM. 1 GB of memory may cause issues when compiling the frontend.

We recommend a modern Linux distribution such as Ubuntu. Systems like CentOS 7 may fail to deploy because they cannot install a recent enough version of Node.js.

Backend Deployment

See: https://mx-space.js.org/docs/docker

Installing Docker

If your server is in China, we recommend using Alibaba Cloud's mirror accelerator. The installation command is:

curl -fsSL https://get.docker.com | bash -s docker --mirror Aliyun

If your server is overseas, you can install it directly with the official script:

curl -fsSL https://get.docker.com | bash -s docker

If Docker and Docker Compose were installed successfully, you can check their versions with:

docker -v
docker compose version

Deployment

1. Pull the config file

cd && mkdir -p $HOME/mx-space/core && cd $_ # 拉取 docker-compose.yml 文件
wget https://fastly.jsdelivr.net/gh/mx-space/core@master/docker-compose.yml

2. Create the environment variables

vi .env

3. After filling in the following, press ESC, type :wq, then save and exit

JWT_SECRET= #JWT 密钥：需要填写长度不小于 16 个字符，不大于 32 个字符的字符串，用于加密用户的 JWT，务必保存好自己的密钥，不要泄露给他人。
ALLOWED_ORIGINS= #被允许的域名：需要填写被允许的域名，通常是前端的域名，如果允许多个域名访问，用英文逗号，分隔。
ENCRYPT_ENABLE= #如果你确定要开启加密，将 false 改为 true，开启加密后，你需要在下方填写加密密钥。
ENCRYPT_KEY= #如果你不知道这是什么，那么不建议开启此功能，具体内容可参考 https://mx-space.js.org/usage/security.html

4. Start the backend

   BASHCopy

   docker compose up -d
   

Frontend Deployment

See: https://mx-space.js.org/themes/shiro

Prerequisites

1. Deploy and start the backend
2. Sign up for a Clerk account and get your public and private keys: see
3. Install Node.js and pnpm

Deployment

1. Clone the repository (using Shiro as an example)

git clone https://github.com/Innei/Shiro $HOME/mx-space/Shiro && cd $HOME/mx-space/Shiro

2. Set up the environment variables

vi .env

After filling in the following, press ESC, type :wq, then save and exit:

NEXT_PUBLIC_API_URL=https://yourdomain/api/v2 
NEXT_PUBLIC_GATEWAY_URL=https://yourdomain
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=pk_test_XXXX
CLERK_SECRET_KEY=sk_test_XXXX

3. Install dependencies and start the frontend

sudo pnpm i
sudo pnpm build
npx next start -p 2323

4. If the frontend starts successfully with the steps above, you can deploy it with pm2

npm install -g pm2
pm2 start #
pm2 restart 0 #重新编译后用此命令重新部署，其中 0 为任务号

Nginx Reverse Proxy

1. Point your domain to the server.

2. Apply for a certificate as described in this article.

3. Set up the reverse proxy:

   BASHCopy

   vi /etc/nginx/nginx.conf
   

   Edit the domain and certificate paths in the example below, then add it to the configuration file:

Updating

Backend update (Docker deployment)

Enter the core folder, then

cd $HOME/mx-space/core
docker compose pull && docker compose up -d

Frontend update

cd $HOME/mx-space/Shiro
git pull
sudo pnpm i
sudo pnpm build
pm2 restart 0

Troubleshooting

Fixing comment user conflicts

See: Clerk Login and Mix Space Backend Binding

1. Get the PEM: https://clerk.com/docs/backend-requests/handling/manual-jwt
2. Get the ID: after logging in with Clerk in Shiro, capture the request from the console.

Adding Search

See: https://mx-space.js.org/usage/search

1. Sign up: https://dashboard.algolia.com/users/sign_up
2. New Application -> Create Application -> Create Index. Remember the index you created.
3. API Keys -> Application ID & Admin API Key
4. Enter the Index, Application ID, and Admin API Key in the admin dashboard.