Yuebing requires nodejs version 16 LTS, please ensure you have the correct version:
node --version // should echo something like "v16.17.0"
Once you've installed node, you'll also need yarn:
sudo npm install -g yarn
Now that you've got node and yarn, you can install all the project dependencies:
yarn install
To run Yuebing, it requires some "bootstrap" environment variables.
Copy the env.example to .env and edit it.
You will at least need to set the email/password for the admin user, and the cloud bucket configuration for where configuration and assets will be stored. The rest can be configured from Yuebing at runtime.
yarn build // builds everything and puts it in `dist`
yarn start
yarn dev
Is your .env file in good order? Let's run Yuebing!
yarn docker-run
The first time you run this, it will build the docker image. To build the image without launching:
yarn docker-build
The development docker image is lightweight and quick to build.
It mounts the Yuebing source directory inside the container, so we don't have to copy everything.
The dev container runs yarn dev instead of yarn start, so we're also able to skip the long yarn build step.
yarn docker-run-dev
The first time you run this, it will build the docker image. To build the image without launching:
yarn docker-build-dev
When running the docker dev container, you may run up against some resource limits. A common one that causes
problems is the "max filesystem watches" setting. Increase it using sysctl:
sysctl -w fs.inotify.max_user_watches=500000