⚠️ docs: Default Value Warnings & Docker Docs Update (#2343)

* feat(AppService): default secret value warnings

* docs: update docker/ubuntu related guides
This commit is contained in:
Danny Avila 2024-04-06 18:20:48 -04:00 committed by GitHub
parent 0b165260f7
commit caabab4489
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 118 additions and 13 deletions

View file

@ -17,6 +17,13 @@ const { loadAndFormatTools } = require('./ToolService');
const paths = require('~/config/paths');
const { logger } = require('~/config');
const secretDefaults = {
CREDS_KEY: 'f34be427ebb29de8d88c107a71546019685ed8b241d8f2ed00c3df97ad2566f0',
CREDS_IV: 'e2341419ec3dd3d19b13a1a87fafcbfb',
JWT_SECRET: '16f8c0ef4a5d391b26034086c628469d3f9f497f08163ab9b40137092f2909ef',
JWT_REFRESH_SECRET: 'eaa5191f2914e30b9387fd84e254e4ba6fc51b4654968a9b0803b456a54b8418',
};
/**
*
* Loads custom config and initializes app-wide variables.
@ -176,6 +183,26 @@ const AppService = async (app) => {
paths,
...endpointLocals,
};
let hasDefaultSecrets = false;
for (const [key, value] of Object.entries(secretDefaults)) {
if (process.env[key] === value) {
logger.warn(`Default value for ${key} is being used.`);
!hasDefaultSecrets && (hasDefaultSecrets = true);
}
}
if (hasDefaultSecrets) {
logger.info(
`Please replace any default secret values.
For your conveninence, fork & run this replit to generate your own secret values:
https://replit.com/@daavila/crypto#index.js
`,
);
}
};
module.exports = AppService;