docs: fix PM2 start command syntax

[bibi0019]

Description

• The use of the "--node-args" causes pm2 can't start the application (node: bad option: --NODE_ENV=production), see screenshots. This pull request is made to the docs to pass the environment variable to pm2 rather than passing the environment variable via "--node-args"

How Has This Been Tested?

• The application successfully started on pm2 v6.0.14 with node v22.22.1 using ubuntu Server 24.04.1 LTS Operating system

Screenshots / Logs (if applicable)

Using --node-args:

Passing ENV to the command:

Checklist:

• I have read and followed the contribution guidelines.
• Disclosed any use of AI (see our policy)
• I have updated the documentation accordingly.
• All new and existing tests passed.
• Successful build pnpm build
• Translation keys pnpm i18n:extract
• Database migration (if required)

Summary by CodeRabbit

• Documentation
  • Clarified PM2 startup examples to set NODE_ENV as an environment variable prior to invoking PM2 on Unix and Windows, simplifying startup commands.
  • Fixed Windows dependency-install example to use PowerShell-style environment assignment for the Cypress install-variable, improving Windows setup instructions.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: b00af1c7-e2ef-4c1a-8515-abf97dc42f02

📥 Commits

Reviewing files that changed from the base of the PR and between 35033f3 and fe9657d.

📒 Files selected for processing (1)

• docs/getting-started/buildfromsource.mdx

✅ Files skipped from review due to trivial changes (1)

• docs/getting-started/buildfromsource.mdx

---

📝 Walkthrough

Walkthrough

Updated the PM2 startup and Windows command examples in the build-from-source docs to set environment variables via shell/PowerShell syntax (e.g., NODE_ENV=production pm2 start ... on Unix, $env:NODE_ENV = "production"; pm2 start ... on Windows) and corrected the Windows Cypress install example to PowerShell ($env:CYPRESS_INSTALL_BINARY = 0; pnpm ...).

Changes

Cohort / File(s)	Summary
Documentation docs/getting-started/buildfromsource.mdx	Replaced PM2 invocation that used --node-args="--NODE_ENV=production" with shell/PowerShell environment-variable syntax for Unix and Windows examples (NODE_ENV=production pm2 start ..., $env:NODE_ENV = "production"; pm2 start ...). Also corrected the Windows dependency-install example from set CYPRESS_INSTALL_BINARY=0 && pnpm ... to PowerShell: $env:CYPRESS_INSTALL_BINARY = 0; pnpm ....

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐇 I hop through docs with careful paws,
Switched env lines and fixed the flaws.
PM2 now greets the shell with cheer,
PowerShell whispers, Cypress hears.
A little nibble — the path is clear. 🥕

🚥 Pre-merge checks | ✅ 2

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'docs: Fix PM2 start command syntax' directly and accurately describes the main change in the pull request - correcting how environment variables are passed to PM2 in the documentation.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

Tip

You can validate your CodeRabbit configuration file in your editor.

If your editor has YAML language server, you can enable auto-completion and validation by adding # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json at the top of your CodeRabbit configuration file.

[Copilot]

Pull request overview

Updates the PM2 start command in the “Build from source” documentation to set NODE_ENV via the environment instead of incorrectly passing it as a Node argument, preventing PM2 startup failures.

Changes:

• Replace --node-args="--NODE_ENV=production" with NODE_ENV=production ... in the PM2 start command example.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[coderabbitai]

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

docs/getting-started/buildfromsource.mdx (1)

277-279: ⚠️ Potential issue | 🟠 Major

Use PM2 ecosystem file for NODE_ENV configuration instead of --node-args.

The --node-args="--NODE_ENV=production" pattern on line 278 is not recommended in PM2 v6. Per PM2 best practices, define environment variables in an ecosystem file and start with the --env flag:

Suggested doc fix

Create or reference an ecosystem.config.js:

module.exports = {
  apps: [{
    name: "seerr",
    script: "dist/index.js",
    env_production: {
      NODE_ENV: "production"
    }
  }]
}

Then start with:

pm2 start ecosystem.config.js --env production

Alternatively, set the env variable in PowerShell before starting:

$env:NODE_ENV="production"
pm2 start dist/index.js --name seerr

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@docs/getting-started/buildfromsource.mdx` around lines 277 - 279, Replace the
discouraged "--node-args=\"--NODE_ENV=production\"" usage in the PM2 start
example (the line containing "pm2 start dist/index.js --name seerr --node-args")
with guidance to use an ecosystem file and the "--env" flag, or to set NODE_ENV
in PowerShell before starting; update the snippet to instruct creating an
ecosystem.config.js with env_production:{ NODE_ENV: "production" } and running
"pm2 start ecosystem.config.js --env production", and mention the alternative
PowerShell approach of setting $env:NODE_ENV="production" then "pm2 start
dist/index.js --name seerr".

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Outside diff comments:
In `@docs/getting-started/buildfromsource.mdx`:
- Around line 277-279: Replace the discouraged
"--node-args=\"--NODE_ENV=production\"" usage in the PM2 start example (the line
containing "pm2 start dist/index.js --name seerr --node-args") with guidance to
use an ecosystem file and the "--env" flag, or to set NODE_ENV in PowerShell
before starting; update the snippet to instruct creating an ecosystem.config.js
with env_production:{ NODE_ENV: "production" } and running "pm2 start
ecosystem.config.js --env production", and mention the alternative PowerShell
approach of setting $env:NODE_ENV="production" then "pm2 start dist/index.js
--name seerr".

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 1f854bd8-6594-4efb-8085-1c73ae0cd834

📥 Commits

Reviewing files that changed from the base of the PR and between 7920970 and e4bd356.

📒 Files selected for processing (1)

• docs/getting-started/buildfromsource.mdx

[fallenbagel]

#2713 (comment)

Please update the windows part too

[Copilot]

Pull request overview

Updates the “Build from source” documentation to correct the PM2 startup command so NODE_ENV is set via environment variables instead of being passed as a Node argument, preventing PM2 startup failures.

Changes:

• Replace --node-args="--NODE_ENV=production" with a shell environment variable approach for PM2 startup.
• Update both Unix-like and Windows PM2 examples accordingly.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.