MCSM-Daemon/README.md

55 lines
1.9 KiB
Markdown
Raw Permalink Normal View History

2022-08-05 10:54:13 +08:00
<img src="https://public-link.oss-cn-shenzhen.aliyuncs.com/mcsm_picture/logo.png" alt="MCSManager icon.png" width="500px" />
2022-02-02 19:43:28 +08:00
2022-09-01 16:40:01 +08:00
2022-02-02 19:43:28 +08:00
[![Status](https://img.shields.io/badge/npm-v6.14.15-blue.svg)](https://www.npmjs.com/)
[![Status](https://img.shields.io/badge/node-v14.17.6-blue.svg)](https://nodejs.org/en/download/)
2022-09-01 16:39:43 +08:00
[![Status](https://img.shields.io/badge/License-Apache%202.0-red.svg)](https://github.com/MCSManager)
2022-09-01 16:39:43 +08:00
[Official Website](http://mcsmanager.com/) | [Team Homepage](https://github.com/MCSManager) | [Panel Project](https://github.com/MCSManager/MCSManager) | [UI Project](https://github.com/MCSManager/UI) | [Daemon project](https://github.com/MCSManager/Daemon)
2022-08-05 10:54:13 +08:00
Please go to the main project repository: [https://github.com/MCSManager/MCSManager](https://github.com/MCSManager/MCSManager)
2021-12-05 15:53:25 +08:00
<br />
2022-08-05 10:54:13 +08:00
## Manual installation
2022-01-25 15:16:12 +08:00
2022-08-05 10:54:13 +08:00
Prerequisite: [Web-side program](https://github.com/MCSManager/MCSManager-Web-Production) needs to be installed to use this software normally.
2022-01-25 15:16:12 +08:00
2022-08-05 10:54:13 +08:00
Install `Node 14+` and `npm` tools and clone the [Daemon code for deployment](https://gitee.com/mcsmanager/MCSManager-Daemon-Production), then use the following commands to initialize and start the Daemon side.
2022-01-25 15:16:12 +08:00
2022-01-25 12:04:03 +08:00
```bash
2022-09-01 16:39:43 +08:00
# Download the Daemon program
git clone https://github.com/MCSManager/MCSManager-Daemon-Production.git
# rename the folder and enter
mv MCSManager-Daemon-Production daemon
2022-01-25 12:04:03 +08:00
npm install
node app.js
2022-08-05 10:54:13 +08:00
````
2022-01-25 15:16:12 +08:00
2022-08-05 10:54:13 +08:00
The program will output the following
2022-01-25 15:16:12 +08:00
2022-08-05 10:54:13 +08:00
````log
Access address localhost:24444
access key [your key, a string of hexadecimal numbers]
The key is the only means of authentication for the daemon
````
2022-01-25 15:16:12 +08:00
2022-08-05 10:54:13 +08:00
Just add an instance on the web side using the key.
To stop direct input:
2022-01-25 15:16:12 +08:00
2022-01-25 12:47:11 +08:00
```bash
2022-08-05 10:54:13 +08:00
Ctrl+C
````
2022-01-25 15:16:12 +08:00
2022-08-05 10:54:13 +08:00
If you need to run in the background for a long time, please use the `Screen` software in conjunction with it, or manually write to the system service.
2022-01-25 15:16:12 +08:00
2021-12-05 15:53:25 +08:00
<br />
2022-02-06 15:57:10 +08:00
2022-11-27 12:51:21 +08:00
## License
2023-02-28 10:47:55 +08:00
Copyright 2023 [MCSManager Dev](https://github.com/mcsmanager), Apache-2.0 license.
2022-11-27 12:51:21 +08:00
2022-02-02 23:41:18 +08:00