Skip to content

Commit 0ae1183

Browse files
Document PM2R_HOME and multi-instance support
Adds documentation for the `PM2R_HOME` environment variable, allowing users to specify a custom configuration directory. Also documents better support for running multiple isolated PMDaemon instances. This allows for running multiple instances without conflicts, improving isolation and reliability. Corrects links in the documentation.
1 parent a6337f8 commit 0ae1183

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

docs/changelog/2025-05-27-v0.1.2.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ This release represents two major milestones: **ecosystem configuration support*
2626
- **Comprehensive Field Support** - All process options configurable via files
2727
- **Environment-Specific Configs** - Separate config files for different environments
2828
- **Validation & Error Handling** - Detailed error messages for configuration issues
29+
- **Custom Configuration Directory** - `PM2R_HOME` environment variable support for configuration directory override
30+
- **Multi-Instance Support** - Better support for running multiple isolated PMDaemon instances
2931

3032
### 🌍 Cross-Platform Support
3133
- **Native Windows Support** - Full functionality on Windows 10/11 with optimized process management
@@ -65,6 +67,19 @@ pmdaemon --config ecosystem.json start
6567
pmdaemon --config ecosystem.json start --name web-server
6668
```
6769

70+
### Environment Variable Configuration
71+
72+
**Custom Configuration Directory:**
73+
```bash
74+
# Use custom config directory
75+
export PM2R_HOME="/path/to/custom/config"
76+
pmdaemon start "node server.js" --name web-app
77+
78+
# Multiple isolated instances
79+
PM2R_HOME="/tmp/instance1" pmdaemon start app1.js --name app1
80+
PM2R_HOME="/tmp/instance2" pmdaemon start app2.js --name app2
81+
```
82+
6883
### Cross-Platform Installation
6984

7085
**Pre-built Binaries:**
@@ -102,6 +117,8 @@ PMDaemon v0.1.2 now matches and exceeds PM2's capabilities across all platforms:
102117
| Auto port assignment |||
103118
| Built-in health checks |||
104119
| Configuration validation|||
120+
| Custom config directory | ✅ (PM2R_HOME) ||
121+
| Multi-instance isolation|||
105122

106123
## 📚 Migration from PM2
107124

@@ -133,8 +150,8 @@ module.exports = {
133150
## 🔗 Resources
134151

135152
- **[Configuration Guide](/docs/configuration/ecosystem-files)** - Complete ecosystem config documentation
136-
- **[Examples](/docs/examples/use-cases)** - Real-world configuration examples
137-
- **[Migration Guide](/docs/getting-started/migration-from-pm2)** - Step-by-step PM2 migration
153+
- **[Examples](/docs/examples/ecosystem-configs)** - Real-world configuration examples
154+
- **[Migration Guide](/docs/comparison/migration-from-pm2)** - Step-by-step PM2 migration
138155

139156
---
140157

0 commit comments

Comments
 (0)