How to configure with a file instead of environment variables

manning-ncsa · August 30, 2023, 6:38pm

My version of HedgeDoc is: 1.9.9

I want to configure my server via a config file instead of environment variables, but I cannot figure out how to do this. I read the docs here and mounted (a Helm template rendered) config.json file at /files/config.json in my container. I get error messages like this that I’m not sure how to debug:

Error: EISDIR: illegal operation on a directory, read '/hedgedoc'
    at readFileSyncUtf8 (node:internal/fs/read/utf8:20:3)
    at Object.readFileSync (node:fs:467:12)
    at Object.<anonymous> (/hedgedoc/app.js:47:13)
    at Module._compile (node:internal/modules/cjs/loader:1233:14)
    at Module._extensions..js (node:internal/modules/cjs/loader:1287:10)
    at Module.load (node:internal/modules/cjs/loader:1091:32)
    at Module._load (node:internal/modules/cjs/loader:938:12)
    at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:83:12)
    at node:internal/main/run_main_module:23:47

A few questions:

Is this the correct approach? It is unclear whether I should only include the parameters I am overriding in the config.json file or if I have to include the entire thing (copying the default values).
Do I have to fall back to using environment variables to inject the secrets (e.g. OAuth2 client ID and secret values)? Or is there a way to include another config file (which I would mount from a Kubernetes Secret)?

sheogorath · August 30, 2023, 11:20pm

This sounds more like a general config issue. The error point to a if branch that os only used if you set useSSL. Is that intended?

github.com

hedgedoc/hedgedoc/blob/b683058f8ec7c36fb85ca6ff40556528e7c4b09f/app.js#L47


      
          if (config.useSSL) {
            const ca = (function () {
              let i, len
              const results = []
              for (i = 0, len = config.sslCAPath.length; i < len; i++) {
                results.push(fs.readFileSync(config.sslCAPath[i], 'utf8'))
              }
              return results
            })()
            const options = {
              key: fs.readFileSync(config.sslKeyPath, 'utf8'),
              cert: fs.readFileSync(config.sslCertPath, 'utf8'),
              ca,
              dhparam: fs.readFileSync(config.dhParamPath, 'utf8'),
              requestCert: false,
              rejectUnauthorized: false
            }
            server = require('https').createServer(options, app)
          } else {
            server = require('http').createServer(app)
          }

manning-ncsa · August 31, 2023, 2:06pm

That was it! I had confused the “protocol SSL” setting with the “use SSL” setting. Thanks for the help.

manning-ncsa · December 5, 2024, 8:39pm

Is the config.json configuration option still supported in HedgeDoc 2? I do not see it referenced in the v2 docs, but perhaps that is just because it has not yet been written?

ErikMichelson · December 6, 2024, 1:07pm

We don’t intend to add another variant of configuration except environment variables in HedgeDoc 2. This is mainly because having two ways of configuration makes docs and also implementation possibly inconsistent.
However, an .env-file can be used to store the configuration in a file. HedgeDoc 2 does automatically read variables from a .env file.