Skip to content

docs: Improve PM2 installation doc #89

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tdgroot merged 1 commit into from
Jan 23, 2023
Merged

docs: Improve PM2 installation doc #89

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 29 additions & 29 deletions docs/hypernode-platform/tools/installation-and-configuration-of-pm2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
myst:
html_meta:
description: PM2 is a porcess manager which keeps your application running as
a deamon. In this article we’ll cover the installation and configuration process
description: PM2 is a process manager which keeps your application running as
a daemon. In this article we’ll cover the installation and configuration process
of PM2.
title: How to install and configure PM2 on Hypernode?
redirect_from:
Expand All @@ -21,25 +21,25 @@ We will run PM2 in combination with a program called supervisord to make sure th

PM2 can be installed in various ways. In this article we'll install the process manager globally for the app user. We'll also create an alias for PM2, so that the program will not spawn the PM2 daemon on the fly. We don't want that to happen, because we want PM2 to run in the foreground so that it can be managed by supervisord.

```
app@abbt5w-tdgroot-magweb-cmbl:~$ # Set NPM prefix to ~/.npm
app@abbt5w-tdgroot-magweb-cmbl:~$ npm config set prefix ~/.npm
app@abbt5w-tdgroot-magweb-cmbl:~$ # Install PM2 in NPM prefix
app@abbt5w-tdgroot-magweb-cmbl:~$ npm install --quiet -g pm2
```console
app@abbt5w-example-magweb-cmbl:~$ # Set NPM prefix to ~/.npm
app@abbt5w-example-magweb-cmbl:~$ npm config set prefix ~/.npm
app@abbt5w-example-magweb-cmbl:~$ # Install PM2 in NPM prefix
app@abbt5w-example-magweb-cmbl:~$ npm install --quiet -g pm2
/data/web/.npm/bin/pm2-dev -> /data/web/.npm/lib/node_modules/pm2/bin/pm2-dev
/data/web/.npm/bin/pm2 -> /data/web/.npm/lib/node_modules/pm2/bin/pm2
/data/web/.npm/bin/pm2-docker -> /data/web/.npm/lib/node_modules/pm2/bin/pm2-docker
/data/web/.npm/bin/pm2-runtime -> /data/web/.npm/lib/node_modules/pm2/bin/pm2-runtime
+ pm2@5.1.2
added 181 packages from 200 contributors in 7.411s
app@abbt5w-tdgroot-magweb-cmbl:~$ # Add user NPM prefix bin directory to PATH
app@abbt5w-tdgroot-magweb-cmbl:~$ echo 'export PATH="$PATH:$HOME/.npm/bin"' >> ~/.bashrc
app@abbt5w-tdgroot-magweb-cmbl:~$ # Create pm2 alias to skip creation of PM2 daemon on the fly
app@abbt5w-tdgroot-magweb-cmbl:~$ echo 'alias pm2="pm2 --no-daemon"' >> ~/.bashrc
app@abbt5w-tdgroot-magweb-cmbl:~$ # Reload bash config
app@abbt5w-tdgroot-magweb-cmbl:~$ source ~/.bashrc
app@abbt5w-tdgroot-magweb-cmbl:~$ # Check if pm2 program can be found
app@abbt5w-tdgroot-magweb-cmbl:~$ which pm2
app@abbt5w-example-magweb-cmbl:~$ # Add user NPM prefix bin directory to PATH
app@abbt5w-example-magweb-cmbl:~$ echo 'export PATH="$PATH:$HOME/.npm/bin"' >> ~/.bashrc
app@abbt5w-example-magweb-cmbl:~$ # Create pm2 alias to skip creation of PM2 daemon on the fly
app@abbt5w-example-magweb-cmbl:~$ echo 'alias pm2="pm2 --no-daemon"' >> ~/.bashrc
app@abbt5w-example-magweb-cmbl:~$ # Reload bash config
app@abbt5w-example-magweb-cmbl:~$ source ~/.bashrc
app@abbt5w-example-magweb-cmbl:~$ # Check if pm2 program can be found
app@abbt5w-example-magweb-cmbl:~$ which pm2
/data/web/.npm/bin/pm2
```

Expand All @@ -51,7 +51,7 @@ To make use of supervisord, we first have to make sure it is enabled and running

For this article we'll use a simple web server application written in Python. Feel free to use your own application!

```
```python
#!/usr/bin/env python3

from http.server import BaseHTTPRequestHandler, HTTPServer
Expand Down Expand Up @@ -87,7 +87,7 @@ The application only handles `GET` requests and responds with the text "Hello, V

Now that we have PM2 installed, supervisor available and an application to run, we can combine all the things together. Create a file at /data/web/supervisor/my_application.conf with the following contents.

```
```ini
[program:pm2_my_application]
command=/data/web/.npm/bin/pm2 --no-daemon --interpreter=python3 start /data/web/my_application/main.py
autostart=true
Expand All @@ -101,27 +101,27 @@ For more information about options and configuration of PM2 and supervisor, plea

Now we're almost done, we only need to execute a few commands to load the supervisord configuration and start the PM2 process manager.

```
app@abbt5w-tdgroot-magweb-cmbl:~$ # Make sure no pm2 background daemon is running
app@abbt5w-tdgroot-magweb-cmbl:~$ pm2 kill
```console
app@abbt5w-example-magweb-cmbl:~$ # Make sure no pm2 background daemon is running
app@abbt5w-example-magweb-cmbl:~$ pm2 kill
pm2 launched in no-daemon mode (you can add DEBUG="*" env variable to get more messages)
2022-02-04T11:58:30: PM2 log: Launching in no daemon mode
2022-02-04T11:58:30: PM2 error: [PM2][WARN] No process found
2022-02-04T11:58:30: PM2 log: [PM2] [v] All Applications Stopped
2022-02-04T11:58:30: PM2 log: PM2 successfully stopped
2022-02-04T11:58:30: PM2 log: [PM2] [v] PM2 Daemon Stopped
app@abbt5w-tdgroot-magweb-cmbl:~$ # Reload supervisor config files
app@abbt5w-tdgroot-magweb-cmbl:~$ supervisorctl reread
app@abbt5w-example-magweb-cmbl:~$ # Reload supervisor config files
app@abbt5w-example-magweb-cmbl:~$ supervisorctl reread
pm2_my_application: available
app@abbt5w-tdgroot-magweb-cmbl:~$ # Check which processes are available
app@abbt5w-tdgroot-magweb-cmbl:~$ supervisorctl avail
app@abbt5w-example-magweb-cmbl:~$ # Check which processes are available
app@abbt5w-example-magweb-cmbl:~$ supervisorctl avail
pm2_my_application avail auto 999:999
app@abbt5w-tdgroot-magweb-cmbl:~$ # Add our process to be managed by supervisor
app@abbt5w-tdgroot-magweb-cmbl:~$ supervisorctl add pm2_my_application
app@abbt5w-example-magweb-cmbl:~$ # Add our process to be managed by supervisor
app@abbt5w-example-magweb-cmbl:~$ supervisorctl add pm2_my_application
pm2_my_application: added process group
app@abbt5w-tdgroot-magweb-cmbl:~$ # Check status of running processes
app@abbt5w-tdgroot-magweb-cmbl:~$ supervisorctl status
app@abbt5w-example-magweb-cmbl:~$ # Check status of running processes
app@abbt5w-example-magweb-cmbl:~$ supervisorctl status
pm2_my_application RUNNING pid 25139, uptime 0:00:04
app@abbt5w-tdgroot-magweb-cmbl:~$ curl http://localhost:8000/
app@abbt5w-example-magweb-cmbl:~$ curl http://localhost:8000/
Hello, Visitor!
```