How to deploy MCSManager Panel? - JHL-HK

522 words

3 minutes

How to deploy MCSManager Panel?

2024-02-21

dev

/

mcsm

/

en

Official Website & Official Docs

What is MCSManager Panel?#

MCSManager Panel（abbr: MCSM Panel）is a multilingual, lightweight, out-of-the-box, and multi-instance Minecraft server control panel with Docker support.

MCSManager Panel is a modern and a panel that support any excutable files. Includes: Steamapps, Minecraft, Terraria, Python files, Java files, etc.

Installation:#

Installation with one command (Recommand)#

x86 Ubuntu/CentOS/Debian/Archlinux ONLY!

1
wget -qO- https://gitee.com/mcsmanager/script/raw/master/setup_cn.sh | bash # Root User
2
wget -qO- https://gitee.com/mcsmanager/script/raw/master/setup_cn.sh | sudo bash # non-Root User

You are able to use systemctl start mcsm-{web,daemon} or sudo systemctl start mcsm-{web,daemon} for non-Root user to start the panel.
The default installation directory is /opt/mcsmanager
After you finished this step, you are able to visit your Panel at http://yourdomain:23333 or http://yourip:23333.

Manual installation#

1
# Switch to the installation directory. If not existed, create with 'mkdir /opt/'
2
cd /opt/
3

4
# If not done already, install Node.js runtime (14+ required).
5
# Download node-v14.17.6, you can also use another version. The minimum requirement is v14.
6
wget https://nodejs.org/dist/v14.17.6/node-v14.17.6-linux-x64.tar.gz
7

8
# Extract required files.
9
tar -zxvf node-v14.17.6-linux-x64.tar.gz
10

11
# Add Node.js to system PATH
12
ln -s /opt/node-v14.17.6-linux-x64/bin/node /usr/bin/node
13
ln -s /opt/node-v14.17.6-linux-x64/bin/npm /usr/bin/npm
14

15
# Create and switch to installation directory
16
mkdir /opt/mcsmanager/
17
cd /opt/mcsmanager/
18

19
# Download the web project. (Skip this if you do not plan to run web panel on this machine)
20
git clone https://github.com/MCSManager/MCSManager-Web-Production.git web
21
cd web
22
# Install dependencies
23
npm install --production
24
cd /opt/mcsmanager/
25

26
# Download the Daemon (Skip this if you do not plan to run daemon service on this machine.)
27
git clone https://github.com/MCSManager/MCSManager-Daemon-Production.git daemon
28
cd daemon
29
# Install dependencies
30
npm install --production
31

32
# You need two terinals or Screens for the following step.
33
# Run the daemon first (Skip this if you do not plan to run daemon service on this machine.)
34
cd /opt/mcsmanager/daemon
35
# Start the daemon
36
node app.js
37

38
# Run the web project (in another screen) (Skip this if you do not plan to run web panel on this machine)
39
cd /opt/mcsmanager/web
40
# start the application
41
node app.js
42

43
# Access http://localhost:23333/ for web interface

Confirgure Proxy (Recommand)#

Nginx is required

This step is required for those who wish to make the panel public. It is recommand to proxy both web and daemon.

1
http {
2

3
    # limit upload size
4
    client_max_body_size 100g;
5

6
    server {
7
        # Web to public
8
        listen 80;
9
        listen 443 ssl;
10
        ssl_certificate /path/to/file;
11
        ssl_certificate_key /path/to/file;
12

13
        location / {
14
            # Web
15
            proxy_pass http://localhost:23333/;
16
            root   html;
17
            index  index.html index.htm;
18
            proxy_set_header Host localhost;
19
            proxy_set_header X-Real-IP $remote_addr;
20
            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
21
            proxy_set_header REMOTE-HOST $remote_addr;
22
            # Websocket
23
            proxy_set_header Upgrade $http_upgrade;
24
            proxy_set_header Connection "upgrade";
25
            add_header X-Cache $upstream_cache_status;
26
            add_header Cache-Control no-cache;
27
            expires -1;
28
        }
29
    }
30

31
    server {
32
        # Daemon to public
33
        listen 8443 ssl;
34
        ssl_certificate /path/to/file;
35
        ssl_certificate_key /path/to/file;
36

37
        location / {
38
            # daemon
39
            proxy_pass http://localhost:24444/;
40
            root   html;
41
            index  index.html index.htm;
42
            proxy_set_header Host localhost;
43
            proxy_set_header X-Real-IP $remote_addr;
44
            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
45
            proxy_set_header REMOTE-HOST $remote_addr;
46
            # websocket
47
            proxy_set_header Upgrade $http_upgrade;
48
            proxy_set_header Connection "upgrade";
49
            add_header X-Cache $upstream_cache_status;
50
            add_header Cache-Control no-cache;
51
            expires -1;
52
        }
53
    }
54
}

Replace /path/to/file to your SSL certificate and Key file.
After you finished confirgure proxy, you are able to visit your Panel at https://yourdomain.com.

p.s. You have to change daemons connections address to proxied by using this format wss://yourdomain or wss://yourip, also change port to proxied port.

If you have a question or problem, please join the Official Discord community to ask for help.

How to deploy MCSManager Panel?

https://article.jhl.idv.hk/posts/how_to_deploy_mcsmanager/

Author

Jianyue Hugo Liang

Published at

2024-02-21

License

Licence at bottom

Airway Simulation Network: Building a High-Quality Aviation Simulation Community

一个 Minecraft 服务器

What is MCSManager Panel?

Installation with one command (Recommand)

Manual installation

Confirgure Proxy (Recommand)