Repository navigation
add licensing section to enterprise configuration - #2368
Conversation
✅ Deploy Preview for pomerium-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
 |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
| | <a className="entRef-anchor" id="grpc-addr">#</a><a href='#grpc-addr'>GRPC_ADDR</a> | The address to listen for gRPC on. | `:8702` | | ||
| | <a className="entRef-anchor" id="help">#</a><a href='#help'>HELP</a> | help for serve | `false` | | ||
| | <a className="entRef-anchor" id="license-key">#</a><a href='#license-key'>LICENSE_KEY</a> | Provide the license key issued by your account team. | none | | ||
| | <a className="entRef-anchor" id="license-key-validate-offline">#</a><a href='#license-key-validate-offline'>LICENSE_KEY_VALIDATE_OFFLINE</a> | Disable online validation of the license key. | `false` |
There was a problem hiding this comment.
This page says its keys can be set in config.yaml or as environment variables, but LICENSE_KEY_VALIDATE_OFFLINE appears only in the environment-variable tab. Someone configuring an offline deployment from the config-file tab cannot find the YAML key. Add the corresponding entry there, or clarify that this option is environment-only.
Red test: the assertion fails because the config-file tab has no matching entry.
const {readFileSync} = require('node:fs');
const doc = readFileSync('content/docs/deploy/enterprise/configure.mdx', 'utf8');
const configTab = doc.split('<TabItem label="Config file keys"')[1];
console.assert(configTab.includes('license_key_validate_offline'));
| | <a className="entRef-anchor" id="disable-validation">#</a><a href='#disable-validation'>DISABLE_VALIDATION</a> | (deprecated, please update your configuration to set `VALIDATION_MODE=none` instead) Disable config validation. | `false` | | ||
| | <a className="entRef-anchor" id="grpc-addr">#</a><a href='#grpc-addr'>GRPC_ADDR</a> | The address to listen for gRPC on. | `:8702` | | ||
| | <a className="entRef-anchor" id="help">#</a><a href='#help'>HELP</a> | help for serve | `false` | | ||
| | <a className="entRef-anchor" id="license-key">#</a><a href='#license-key'>LICENSE_KEY</a> | Provide the license key issued by your account team. | none | |
There was a problem hiding this comment.
The environment-variable entry no longer says the license key is required, while the corresponding config-file entry still says “Required.” Readers of the two tabs get conflicting provisioning instructions. Make the descriptions agree.
Red test: the assertion fails because only one entry contains “Required.”
const {readFileSync} = require('node:fs');
const doc = readFileSync('content/docs/deploy/enterprise/configure.mdx', 'utf8');
const rows = doc.split('\n').filter(line => />(?:LICENSE_KEY|license_key)<\/a>/.test(line));
console.assert(rows.length === 2 && rows.every(line => line.includes('Required:')));
Summary
Add a licensing section to the enterprise configuration page.
Related
AI disclosure
n/a
Checklist