Skip to content

Commit 5a28c25

Browse files
committed
docs(config-options): add tables for each config option for names
This should reduce confusion
1 parent 7f1a89c commit 5a28c25

File tree

1 file changed

+64
-0
lines changed

1 file changed

+64
-0
lines changed

docs/api/config-options.md

+64
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ List of all Config Options
99

1010
### DOWNLOAD_DIR
1111

12+
| Environment Variable | PackageJson |
13+
| :--------------------: | :-----------: |
14+
| `MONGOMS_DOWNLOAD_DIR` | `downloadDir` |
15+
1216
Option `DOWNLOAD_DIR` is used to set where the binaries will be located in, this will overwrite all other directories
1317

1418
Directory Priority:
@@ -25,12 +29,20 @@ Format:
2529

2630
### PLATFORM
2731

32+
| Environment Variable | PackageJson |
33+
| :------------------: | :---------: |
34+
| `MONGOMS_PLATFORM` | `platform` |
35+
2836
Option `PLATFORM` is used to overwrite which platform should be downloaded
2937

3038
Valid Options are `win32`, `darwin`, `linux`, ~~`sunos`~~(never actually supported, [will be removed in 9.0](../guides/error-warning-details.md#mms002))
3139

3240
### ARCH
3341

42+
| Environment Variable | PackageJson |
43+
| :------------------: | :---------: |
44+
| `MONGOMS_ARCH` | `arch` |
45+
3446
Option `ARCH` is used to overwrite the Architecture to download for
3547

3648
Valid Options are `x64`, `arm64`, ~~`ia32`~~([will be removed in 9.0](../guides/error-warning-details.md#mms001))
@@ -39,6 +51,10 @@ Valid Options are `x64`, `arm64`, ~~`ia32`~~([will be removed in 9.0](../guides/
3951

4052
### VERSION
4153

54+
| Environment Variable | PackageJson |
55+
| :------------------: | :---------: |
56+
| `MONGOMS_VERSION` | `version` |
57+
4258
Option `VERSION` is used to set what mongodb version should be downloaded
4359

4460
Default: `5.0.8`
@@ -61,10 +77,18 @@ That is, a system binary version of `4.2.19-11-ge2f2736a` will match a mongodb r
6177

6278
### DEBUG
6379

80+
| Environment Variable | PackageJson |
81+
| :------------------: | :---------: |
82+
| `MONGOMS_DEBUG` | `debug` |
83+
6484
Option `DEBUG` is used to enable Debug Output
6585

6686
### DOWNLOAD_MIRROR
6787

88+
| Environment Variable | PackageJson |
89+
| :-----------------------: | :--------------: |
90+
| `MONGOMS_DOWNLOAD_MIRROR` | `downloadMirror` |
91+
6892
Option `DOWNLOAD_MIRROR` is used to set which mirror to use
6993

7094
Default / Format: `https://fastdl.mongodb.org` (protocol needs to be included)
@@ -77,20 +101,36 @@ It is discouraged to use query parameters, they may work, but not officially sup
77101

78102
### DOWNLOAD_URL
79103

104+
| Environment Variable | PackageJson |
105+
| :--------------------: | :-----------: |
106+
| `MONGOMS_DOWNLOAD_URL` | `downloadUrl` |
107+
80108
Option `DOWNLOAD_URL` is used to overwrite the ***complete*** URL (including [`DOWNLOAD_MIRROR`](#DOWNLOAD_MIRROR))
81109

82110
Format: `https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-ubuntu1604-4.0.20.tgz`
83111

84112
### PREFER_GLOBAL_PATH
85113

114+
| Environment Variable | PackageJson |
115+
| :--------------------------: | :----------------: |
116+
| `MONGOMS_PREFER_GLOBAL_PATH` | `preferGlobalPath` |
117+
86118
Option `PREFER_GLOBAL_PATH` is used to force download into `~/.cache/mongodb-binaries` instead of local folder
87119

88120
### DISABLE_POSTINSTALL
89121

122+
| Environment Variable | PackageJson |
123+
| :---------------------------: | :------------------: |
124+
| `MONGOMS_DISABLE_POSTINSTALL` | `disablePostinstall` |
125+
90126
Option `DISABLE_POSTINSTALL` is used to skip all `postinstall` scripts
91127

92128
### SYSTEM_BINARY
93129

130+
| Environment Variable | PackageJson |
131+
| :---------------------: | :------------: |
132+
| `MONGOMS_SYSTEM_BINARY` | `systemBinary` |
133+
94134
Option `SYSTEM_BINARY` is used to set the path to an system binary already existing on the system
95135

96136
Format:
@@ -100,18 +140,30 @@ Format:
100140

101141
### SYSTEM_BINARY_VERSION_CHECK
102142

143+
| Environment Variable | PackageJson |
144+
| :-----------------------------------: | :------------------------: |
145+
| `MONGOMS_SYSTEM_BINARY_VERSION_CHECK` | `systemBinaryVersionCheck` |
146+
103147
Option `SYSTEM_BINARY_VERSION_CHECK` is used to disable the version conflict check if [`SYSTEM_BINARY`](#system_binary) is set and version returned from `mongod_system_binary --version` does not match [`VERSION`](#version)
104148

105149
Default: `true`
106150

107151
### MD5_CHECK
108152

153+
| Environment Variable | PackageJson |
154+
| :------------------: | :---------: |
155+
| `MONGOMS_MD5_CHECK` | `md5Check` |
156+
109157
Option `MD5_CHECK` is used to enable an md5 check after download
110158

111159
Default: `false`
112160

113161
### ARCHIVE_NAME
114162

163+
| Environment Variable | PackageJson |
164+
| :--------------------: | :-----------: |
165+
| `MONGOMS_ARCHIVE_NAME` | `archiveName` |
166+
115167
Option `ARCHIVE_NAME` is used to overwrite the complete archive name
116168

117169
Format: `mongodb-linux-x86_64-ubuntu1604-4.0.20.tgz`
@@ -122,18 +174,30 @@ This Option does not have a effect when [`DOWNLOAD_URL`](#download_url) is defin
122174

123175
### RUNTIME_DOWNLOAD
124176

177+
| Environment Variable | PackageJson |
178+
| :------------------------: | :---------------: |
179+
| `MONGOMS_RUNTIME_DOWNLOAD` | `runtimeDownload` |
180+
125181
Option `RUNTIME_DOWNLOAD` is used to disable downloading while being in something like `.start`
126182

127183
Default: `true`
128184

129185
### USE_HTTP
130186

187+
| Environment Variable | PackageJson |
188+
| :------------------: | :---------: |
189+
| `MONGOMS_USE_HTTP` | `useHttp` |
190+
131191
Option `USE_HTTP` is used to use `http` over `https`
132192

133193
Default: `false`
134194

135195
### USE_ARCHIVE_NAME_FOR_BINARY_NAME
136196

197+
| Environment Variable | PackageJson |
198+
| :----------------------------------------: | :---------------------------: |
199+
| `MONGOMS_USE_ARCHIVE_NAME_FOR_BINARY_NAME` | `useArchiveNameForBinaryName` |
200+
137201
Option `USE_ARCHIVE_NAME_FOR_BINARY_NAME` is used to use the archive name as binary name
138202

139203
Default: `false`

0 commit comments

Comments
 (0)