ToolMatter
Your Apps in Action
Risersoft
Buy
Try
Explore
Documentation
Public
Use this form to visualize pm2 ecosystem config file.
{{repoTitle.MainEntity}}
apps The apps property is an array of object where each object contains the configuration for each process.
#
script
name
cwd
args
interpreter
node_args
output
error
log
disable_logs
Actions
{{$index+1}}.
{{row.script}}
{{row.name}}
{{row.cwd}}
{{row.args}}
{{row.interpreter}}
{{row.node_args}}
{{row.output}}
{{row.error}}
{{row.log}}
{{row.disable_logsSelected.DisplayText}}
.deploy
_
.deploy.production
_
deploy.production.key - SSH key path. Defaults to $HOME/.ssh
deploy.production.user - SSH user
deploy.production.host - SSH host
deploy.production.ssh_options - SSH options with no command-line flag, see ‘man ssh’
deploy.production.ref - GIT remote/branch
deploy.production.repo - GIT remote
deploy.production.path - path in the server
deploy.production.pre-setup - Pre-setup command or path to a script on your local machine
deploy.production.post-setup - Post-setup commands or path to a script on the host machine
deploy.production.pre-deploy-local - pre-deploy action
deploy.production.post-deploy - post-deploy action
.deploy.staging
_
deploy.staging.key - SSH key path. Defaults to $HOME/.ssh
deploy.staging.user - SSH user
deploy.staging.host - SSH host
deploy.staging.ssh_options - SSH options with no command-line flag, see ‘man ssh’
deploy.staging.ref - GIT remote/branch
deploy.staging.repo - GIT remote
deploy.staging.path - path in the server
deploy.staging.pre-setup - Pre-setup command or path to a script on your local machine
deploy.staging.post-setup - Post-setup commands or path to a script on the host machine
deploy.staging.pre-deploy-local - pre-deploy action
deploy.staging.post-deploy - post-deploy action
.deploy.development
_
deploy.development.key - SSH key path. Defaults to $HOME/.ssh
deploy.development.user - SSH user
deploy.development.host - SSH host
deploy.development.ssh_options - SSH options with no command-line flag, see ‘man ssh’
deploy.development.ref - GIT remote/branch
deploy.development.repo - GIT remote
deploy.development.path - path in the server
deploy.development.pre-setup - Pre-setup command or path to a script on your local machine
deploy.development.post-setup - Post-setup commands or path to a script on the host machine
deploy.development.pre-deploy-local - pre-deploy action
deploy.development.post-deploy - post-deploy action
{{repoTitle.MainEntity}}
script - Path of the script to launch
name - Process name in the process list. Defaults to script filename without the extension (app for app.js)
cwd - Current working directory to start the process with. Defaults to CWD of the current environment (from your shell)
args - Arguments to pass to the script
interpreter - Interpreter absolute path. Defaults to node
node_args - Arguments to pass to the interpreter
output - File path for stdout (each line is appended to this file)
error - File path for stderr (each line is appended to this file)
log - File path for combined stdout and stderr (each line is appended to this file)
disable_logs - Disable all logs storage
log_type - Define a specific log output type
log_date_format - Format for log timestamps in moment.js format (eg YYYY-MM-DD HH:mm Z)
env - Specify environment variables to be injected
max_memory_restart - Restart the app if an amount of memory is exceeded (format: /0-9?/ K for KB, ‘M’ for MB, ‘G’ for GB, default to B)
pid_file - File path where the pid of the started process is written by pm2. Defaults to ~/.pm2/pids/app_name-id.pid
restart_delay - Time in ms to wait before restarting a crashing app
source_map_support - Enable or disable the source map support
disable_source_map_support - Enable or disable the source map support
wait_ready - Make the process wait for a process.send(‘ready’)
instances - Number of instances to be started in cluster mode
kill_timeout - Time in ms before sending the final SIGKILL signal after SIGINT
listen_timeout - Time in ms before forcing a reload if app is still not listening/has still not sent ready
cron_restart - A cron pattern to restart your app
merge_logs - In cluster mode, merge each type of logs into a single file (instead of having one for each cluster)
vizion - Enable or disable the versioning metadatas (vizion library)
autorestart - Enable or disable auto restart after process failure
watch - Enable or disable the watch mode
ignore_watch - List of paths to ignore (regex)
.watch_options
_apps
min_uptime - Minimum uptime of the app to be considered started (format is /[0-9]+(h|m|s)?/, for hours, minutes, seconds, default to ms)
max_restarts - Number of times a script is restarted when it exits in less than min_uptime
exec_mode - Set the execution mode
force - Start a script even if it is already running (only the script path is considered)
append_env_to_name - Append the environment name to the app name
trace - Enable or disable the transaction tracing
disable_trace - Enable or disable the transaction tracing
increment_var - Specify the name of an environment variable to inject which increments for each cluster
instance_var - Rename the NODE_APP_INSTANCE environment variable. Defaults to NODE_APP_INSTANCE
pmx - Enable or disable apm wrapping
automation - Enable or disable apm wrapping
treekill - Only kill the main process, not detached children
port - Shortcut to inject a PORT environment variable
uid - Set user id. Defaults to current user uid
gid - Set group id. Defaults to current user gid
post_update List of commands executed after a pull/upgrade operation performed from Keymetrics dashboard
#
Values
Actions
{{$index+1}}.
Download Json
{{message}}
ToolMatter