Skip to content

Commit 2f9f8fe

Browse files
Add environment variables section to README.md
1 parent 255404e commit 2f9f8fe

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -154,6 +154,23 @@ And here's an example to get you started:
154154
}
155155
```
156156

157+
### Environment Variables
158+
159+
The following environment variables can be used to customize the behavior of Contentstack DataSync Manager:
160+
161+
| Variable | Description | Default |
162+
|--------------|-----------------------------------------------------------------------------|------------------------|
163+
| `TOKEN_PATH` | Path to the directory where token/checkpoint/ledger files are stored. | Project root directory |
164+
| `PLUGIN_PATH`| Path to the directory where plugins are loaded from. | Project root directory |
165+
| `NODE_ENV` | Node.js environment (affects config/environment selection). | `development` |
166+
| `SYNC_ENV` | Overrides the environment used for sync operations. | Value of `NODE_ENV` |
167+
| `KILLDURATION`| Time (in ms) before the process is forcefully killed (overrides config). | Value from config |
168+
169+
**Note:**
170+
- `TOKEN_PATH` is especially useful for storing token data in a custom directory (e.g., for selective re-syncing based on timestamps).
171+
- If a relative path is provided, it is resolved from the project root.
172+
- These variables can be set in your shell or in your process manager configuration.
173+
157174
### Further Reading
158175

159176
- [Getting started with Contentstack DataSync](https://www.contentstack.com/docs/guide/synchronization/contentstack-datasync)

0 commit comments

Comments
 (0)