Skip to content

Commit c21f55d

Browse files
committed
[doc fix] Document FOREVER_ROOT environment variable. Properly respect -p. Fixes #548. Fixes #541. Fixes #568.
1 parent 0f227e5 commit c21f55d

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

+10
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,16 @@ There are [several examples][1] designed to test the fault tolerance of forever.
9191
$ forever -m 5 examples/error-on-timer.js
9292
```
9393

94+
### Changing where forever writes files
95+
96+
By default `forever` places all of the files it needs into `/$HOME/.forever`. If you would like to change that location just set the `FOREVER_ROOT` environment variable when you are running forever:
97+
98+
```
99+
FOREVER_ROOT=/etc/forever forever start index.js
100+
```
101+
102+
Make sure that the user running the process has the appropriate privileges to read & write to this directory.
103+
94104
## Using forever module from node.js
95105
In addition to using a Forever object, the forever module also exposes some useful methods. Each method returns an instance of an EventEmitter which emits when complete. See the [forever cli commands][2] for sample usage.
96106

0 commit comments

Comments
 (0)