Skip to content

Commit bd92010

Browse files
committed
Remove camel case from imageuploadtype in config
This removes the only camel cased option of the config options **we** added to the config.json. In auth provider's config parts are a lot of camel cased options provided. We shouldn't touch them to keep them as similar as possible to the examples. Fixes #315 Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
1 parent 0138911 commit bd92010

7 files changed

Lines changed: 21 additions & 13 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -246,10 +246,10 @@ There are some configs you need to change in the files below
246246
| documentmaxlength | `100000` | note max length |
247247
| email | `true` or `false` | set to allow email signin |
248248
| allowemailregister | `true` or `false` | set to allow email register (only applied when email is set, default is `true`) |
249-
| imageUploadType | `imgur`(default), `s3`, `minio` or `filesystem` | Where to upload image
250-
| minio | `{ "accessKey": "YOUR_MINIO_ACCESS_KEY", "secretKey": "YOUR_MINIO_SECRET_KEY", "endpoint": "YOUR_MINIO_HOST", port: 9000, secure: true }` | When `imageUploadType` is set to `minio`, you need to set this key. Also checkout our [Minio Image Upload Guide](docs/guides/minio-image-upload.md) |
251-
| s3 | `{ "accessKeyId": "YOUR_S3_ACCESS_KEY_ID", "secretAccessKey": "YOUR_S3_ACCESS_KEY", "region": "YOUR_S3_REGION" }` | When `imageUploadType` be set to `s3`, you would also need to setup this key, check our [S3 Image Upload Guide](docs/guides/s3-image-upload.md) |
252-
| s3bucket | `YOUR_S3_BUCKET_NAME` | bucket name when `imageUploadType` is set to `s3` or `minio` |
249+
| imageuploadtype | `imgur`(default), `s3`, `minio` or `filesystem` | Where to upload image
250+
| minio | `{ "accessKey": "YOUR_MINIO_ACCESS_KEY", "secretKey": "YOUR_MINIO_SECRET_KEY", "endpoint": "YOUR_MINIO_HOST", port: 9000, secure: true }` | When `imageuploadtype` is set to `minio`, you need to set this key. Also checkout our [Minio Image Upload Guide](docs/guides/minio-image-upload.md) |
251+
| s3 | `{ "accessKeyId": "YOUR_S3_ACCESS_KEY_ID", "secretAccessKey": "YOUR_S3_ACCESS_KEY", "region": "YOUR_S3_REGION" }` | When `imageuploadtype` be set to `s3`, you would also need to setup this key, check our [S3 Image Upload Guide](docs/guides/s3-image-upload.md) |
252+
| s3bucket | `YOUR_S3_BUCKET_NAME` | bucket name when `imageuploadtype` is set to `s3` or `minio` |
253253

254254
## Third-party integration api key settings
255255

docs/guides/minio-image-upload.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Minio Guide for HackMD
6262
8. Set upload type.
6363

6464
```JSON
65-
"imageUploadType": "minio"
65+
"imageuploadtype": "minio"
6666
```
6767

6868
9. Review your config.
@@ -78,6 +78,6 @@ Minio Guide for HackMD
7878
"secure": false
7979
},
8080
"s3bucket": "hackmd",
81-
"imageUploadType": "minio"
81+
"imageuploadtype": "minio"
8282
}
8383
```

docs/guides/s3-image-upload.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@
6363
{
6464
"production": {
6565
...
66-
"imageUploadType": "s3",
66+
"imageuploadtype": "s3",
6767
"s3": {
6868
"accessKeyId": "YOUR_S3_ACCESS_KEY_ID",
6969
"secretAccessKey": "YOUR_S3_ACCESS_KEY",

lib/config/default.js

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,9 @@ module.exports = {
5353
// document
5454
documentmaxlength: 100000,
5555
// image upload setting, available options are imgur/s3/filesystem
56-
imageUploadType: 'filesystem',
56+
imageuploadtype: 'filesystem',
57+
// legacy variable name for imageuploadtype
58+
imageUploadType: undefined,
5759
imgur: {
5860
clientID: undefined
5961
},

lib/config/environment.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ module.exports = {
2525
allowfreeurl: toBooleanConfig(process.env.HMD_ALLOW_FREEURL),
2626
defaultpermission: process.env.HMD_DEFAULT_PERMISSION,
2727
dburl: process.env.HMD_DB_URL,
28-
imageUploadType: process.env.HMD_IMAGE_UPLOAD_TYPE,
28+
imageuploadtype: process.env.HMD_IMAGE_UPLOAD_TYPE,
2929
imgur: {
3030
clientID: process.env.HMD_IMGUR_CLIENTID
3131
},

lib/config/index.js

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,15 @@ const debugConfig = {
1313
debug: (env === Environment.development)
1414
}
1515

16+
// Get version string from package.json
1617
const {version} = require(path.join(appRootPath, 'package.json'))
1718

1819
const packageConfig = {
1920
version: version,
2021
minimumCompatibleVersion: '0.5.0'
2122
}
2223

23-
const configFilePath = path.join(__dirname, '../../config.json')
24+
const configFilePath = path.join(appRootPath, 'config.json')
2425
const fileConfig = fs.existsSync(configFilePath) ? require(configFilePath)[env] : undefined
2526

2627
let config = require('./default')
@@ -97,8 +98,13 @@ config.isLDAPEnable = config.ldap.url
9798
config.isSAMLEnable = config.saml.idpSsoUrl
9899
config.isPDFExportEnable = config.allowpdfexport
99100

101+
// merge legacy values
102+
if (config.imageUploadType && !config.imageuploadtype) {
103+
config.imageuploadtype = config.imageUploadType
104+
}
105+
100106
// figure out mime types for image uploads
101-
switch (config.imageUploadType) {
107+
switch (config.imageuploadtype) {
102108
case 'imgur':
103109
config.allowedUploadMimeTypes = [
104110
'image/jpeg',

lib/web/imageRouter.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ imageRouter.post('/uploadimage', function (req, res) {
1919

2020
form.keepExtensions = true
2121

22-
if (config.imageUploadType === 'filesystem') {
22+
if (config.imageuploadtype === 'filesystem') {
2323
form.uploadDir = 'public/uploads'
2424
}
2525

@@ -30,7 +30,7 @@ imageRouter.post('/uploadimage', function (req, res) {
3030
if (config.debug) { logger.info('SERVER received uploadimage: ' + JSON.stringify(files.image)) }
3131

3232
try {
33-
switch (config.imageUploadType) {
33+
switch (config.imageuploadtype) {
3434
case 'filesystem':
3535
res.send({
3636
link: url.resolve(config.serverurl + '/', files.image.path.match(/^public\/(.+$)/)[1])

0 commit comments

Comments
 (0)