Skip to content

Commit

Permalink
[doc fix] Document FOREVER_ROOT environment variable. Properly respec…
Browse files Browse the repository at this point in the history
…t -p. Fixes #548. Fixes #541. Fixes #568.
  • Loading branch information
indexzero committed Aug 29, 2014
1 parent 0f227e5 commit c21f55d
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,16 @@ There are [several examples][1] designed to test the fault tolerance of forever.
$ forever -m 5 examples/error-on-timer.js
```

### Changing where forever writes files

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:

```
FOREVER_ROOT=/etc/forever forever start index.js
```

Make sure that the user running the process has the appropriate privileges to read & write to this directory.

## Using forever module from node.js
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.

Expand Down

0 comments on commit c21f55d

Please sign in to comment.