![\"Staffbase](\"docs/assets/images/staffbase.png\")
\n Staffbase is an internal communications platform built to revolutionize the way you work and unite your company. Staffbase is hiring: https://staffbase.com/jobs\n
GitHub | Website | Jobs\n
","directories":{},"_nodeVersion":"24.12.0","dependencies":{"yargs":"^18.0.0","colors":"^1.4.0","prompt":"^1.0.0","filepath":"^1.1.0","fs-extra":"^9.0.0","is-relative":"^1.0.0","is-valid-path":"^0.1.1","validate-npm-package-name":"^7.0.1"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^29.7.0","husky":"^9.1.7","eslint":"^9.39.2","marked":"^4.0.10","typescript":"^5.9.3","@babel/core":"^7.28.5","markdown-it":"^12.3.2","highlight.js":"^11.11.1","eslint-plugin-react":"^7.37.5","@babel/eslint-parser":"^7.28.5","eslint-config-google":"^0.14.0","eslint-config-prettier":"^9.1.0","@typescript-eslint/parser":"^8.51.0","eslint-plugin-react-hooks":"^5.1.0","@typescript-eslint/eslint-plugin":"^8.51.0","eslint-plugin-simple-import-sort":"^12.1.1"},"_npmOperationalInternal":{"tmp":"tmp/create-staffbase-plugin_1.0.14_1767357174046_0.15597235356748507","host":"s3://npm-registry-packages-npm-production"}},"1.0.15":{"name":"@staffbase/create-staffbase-plugin","version":"1.0.15","license":"MIT","_id":"@staffbase/create-staffbase-plugin@1.0.15","maintainers":[{"name":"staffbase.com","email":"npm@staffbase.com"},{"name":"scthi","email":"thilo@staffbase.com"}],"homepage":"https://github.com/Staffbase/create-staffbase-plugin-nodejs#readme","bugs":{"url":"https://github.com/Staffbase/create-staffbase-plugin-nodejs/issues"},"bin":{"create-staffbase-plugin":"csss.js"},"dist":{"shasum":"81697ee0c7270a41021d81ec73b6ad0ee104ea66","tarball":"https://registry.npmjs.org/@staffbase/create-staffbase-plugin/-/create-staffbase-plugin-1.0.15.tgz","fileCount":26,"integrity":"sha512-5keVpx69zUcaS4ElpKe8KkEE6Kkez+vYhAHsT7nDNCGfZffbGdMty2qlqQ3OX4KbAIwA19kvpRAobb2RDUC1HQ==","signatures":[{"sig":"MEUCIGNZ9VDniFOJ/U1bbmY6TUBNIfh0wPfj/DLHgLTNyGtmAiEA5wkTsvK/F+d7QwUY2XJmfWdttSuG78bVRDCGuQgztqk=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@staffbase%2fcreate-staffbase-plugin@1.0.15","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":55102},"yargs":{"dot-notation":false,"parse-numbers":true,"boolean-negation":true},"gitHead":"59c525095d2ad14c5ea9a58ef1787583ac3646ef","scripts":{"test":"jest","buildDoc":"node scripts/genDoc","precommit":"npm run buildDoc && git add scaffoldTpl/views/index.html"},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"oidc:5f3dbe63-e2b4-431c-94fd-c8dffd6668e5"}},"repository":{"url":"git+https://github.com/Staffbase/create-staffbase-plugin-nodejs.git","type":"git"},"_npmVersion":"11.11.0","description":"","directories":{},"resolutions":{"lodash":"4.18.1","minimatch":"3.1.5","picomatch":"4.0.4","glob/minimatch":"9.0.9","@typescript-eslint/typescript-estree/minimatch":"10.2.4"},"_nodeVersion":"24.14.1","dependencies":{"yargs":"^18.0.0","colors":"^1.4.0","prompt":"^1.0.0","filepath":"^1.1.0","fs-extra":"^11.3.5","is-relative":"^1.0.0","is-valid-path":"^0.1.1","validate-npm-package-name":"^7.0.2"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^30.3.0","husky":"^9.1.7","eslint":"^9.39.2","marked":"^18.0.3","typescript":"^6.0.3","@babel/core":"^7.29.0","markdown-it":"^14.1.1","highlight.js":"^11.11.1","eslint-plugin-react":"^7.37.5","@babel/eslint-parser":"^7.28.6","eslint-config-google":"^0.14.0","eslint-config-prettier":"^10.1.8","@typescript-eslint/parser":"^8.59.2","eslint-plugin-react-hooks":"^7.1.1","@typescript-eslint/eslint-plugin":"^8.59.2","eslint-plugin-simple-import-sort":"^13.0.0"},"_npmOperationalInternal":{"tmp":"tmp/create-staffbase-plugin_1.0.15_1778771786277_0.6527897341468385","host":"s3://npm-registry-packages-npm-production"}},"1.0.17":{"name":"@staffbase/create-staffbase-plugin","version":"1.0.17","license":"MIT","bin":{"create-staffbase-plugin":"csss.js"},"repository":{"type":"git","url":"git+https://github.com/Staffbase/create-staffbase-plugin-nodejs.git"},"scripts":{"test":"jest","buildDoc":"node scripts/genDoc","precommit":"npm run buildDoc && git add scaffoldTpl/views/index.html"},"yargs":{"dot-notation":false,"parse-numbers":true,"boolean-negation":true},"resolutions":{"lodash":"4.18.1","minimatch":"3.1.5","glob/minimatch":"9.0.9","@typescript-eslint/typescript-estree/minimatch":"10.2.4","picomatch":"4.0.4","js-yaml":"4.2.0","ajv":"6.15.0"},"dependencies":{"colors":"^1.4.0","filepath":"^1.1.0","fs-extra":"^11.3.5","is-relative":"^1.0.0","is-valid-path":"^0.1.1","prompt":"^1.0.0","validate-npm-package-name":"^8.0.0","yargs":"^18.0.0"},"devDependencies":{"@babel/core":"^7.29.7","@babel/eslint-parser":"^7.29.7","@typescript-eslint/eslint-plugin":"^8.61.1","@typescript-eslint/parser":"^8.61.1","eslint":"^9.39.2","eslint-config-google":"^0.14.0","eslint-config-prettier":"^10.1.8","eslint-plugin-react":"^7.37.5","eslint-plugin-react-hooks":"^7.1.1","eslint-plugin-simple-import-sort":"^13.0.0","highlight.js":"^11.11.1","husky":"^9.1.7","jest":"^30.4.2","markdown-it":"^14.2.0","marked":"^18.0.5","typescript":"^6.0.3"},"gitHead":"91709966d82a090b9c5db0cf3f5fb103cc9d7c2e","_id":"@staffbase/create-staffbase-plugin@1.0.17","description":"","bugs":{"url":"https://github.com/Staffbase/create-staffbase-plugin-nodejs/issues"},"homepage":"https://github.com/Staffbase/create-staffbase-plugin-nodejs#readme","_nodeVersion":"24.16.0","_npmVersion":"11.13.0","dist":{"integrity":"sha512-60BQbisJ1TSlIAdNfiKvHeJOY3afMkCiM7Z8PZDrbYih3haRssJ3CJPaoRDeIDVYkiM04Rl5di0iDLzqWnpaDg==","shasum":"3ed604a3e72b7f1069856aa69c7acc8b8c30ec2e","tarball":"https://registry.npmjs.org/@staffbase/create-staffbase-plugin/-/create-staffbase-plugin-1.0.17.tgz","fileCount":27,"unpackedSize":55197,"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@staffbase%2fcreate-staffbase-plugin@1.0.17","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQCmkJCQoP+S+emHByWz7L8HgDfx5MOumd0k8FJUwzNxuQIgZZ8itvL0iRpELLyXBdzAaxx/uFpzDEvCYtp+WzgoWfk="}]},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"oidc:5f3dbe63-e2b4-431c-94fd-c8dffd6668e5"}},"directories":{},"maintainers":[{"name":"staffbase.com","email":"npm@staffbase.com"},{"name":"scthi","email":"thilo@staffbase.com"},{"name":"alizehstaffbase","email":"alizeh.khan@staffbase.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/create-staffbase-plugin_1.0.17_1782208022219_0.43572632396994404"},"_hasShrinkwrap":false}},"time":{"created":"2017-06-07T08:33:08.859Z","modified":"2026-06-23T09:47:02.668Z","1.0.0":"2017-06-07T08:33:08.859Z","1.0.1":"2020-07-10T08:08:23.982Z","1.0.2":"2021-11-19T09:40:41.389Z","1.0.6":"2024-01-29T14:31:07.059Z","1.0.8":"2025-03-10T13:33:33.483Z","1.0.14":"2026-01-02T12:32:54.214Z","1.0.15":"2026-05-14T15:16:26.438Z","1.0.17":"2026-06-23T09:47:02.368Z"},"bugs":{"url":"https://github.com/Staffbase/create-staffbase-plugin-nodejs/issues"},"license":"MIT","homepage":"https://github.com/Staffbase/create-staffbase-plugin-nodejs#readme","repository":{"type":"git","url":"git+https://github.com/Staffbase/create-staffbase-plugin-nodejs.git"},"description":"","maintainers":[{"name":"staffbase.com","email":"npm@staffbase.com"},{"name":"scthi","email":"thilo@staffbase.com"},{"name":"alizehstaffbase","email":"alizeh.khan@staffbase.com"}],"readme":"# Create-Staffbase-SSO-CLI Documentation\n\n\n## Getting started\nInstall the package in your global namespace and then run the command.\n\n```bash\n$ npm install -g @staffbase/create-staffbase-plugin\n$ create-staffbase-plugin /home/user1/work/staffbase-server/ --name staffbase-sso-server\n```\n\nYou can use `yarn create` to directly run the command. The syntax of `yarn create staffbase-plugin` is:\n> yarn create @staffbase/staffbase-plugin [Destination folder] --name [Plugin Name]\n\nExample:\n```bash\n$ yarn create @staffbase/staffbase-plugin /home/user1/work/staffbase-server/ --name staffbase-sso-server\n```\n\n## Interactive Mode\nYou can also run the command without passing any arguments to get into interactive\nmode which would ask you the name of your app and the path where it need to be installed.\n```\n$ create-staffbase-plugin\n\nPlease enter npm compatible name: (my-staffbase-backend)\nPlease enter the folder path for the App: (/private/tmp/staffbase/my-staffbase-backend)\nThe directory you specified already exists. It will be overridden!\nDo you wish to proceed (y)es|(n)o?: (no)\n\nSetting up your project in: /private/tmp/staffbase/server\nInstalling dependencies...se/server\n```\n\nOn entering the path, you can either specify an absolute path or a relative path. The relative path is resolved against the current working directory (`process.cwd()`).\n\n## Configuration\nAfter the scaffolding is complete, you need to provide some values for configuring your\nplugin server. The following values need to be configured.\n\n- Plugin Secret\n- Plugin Audience\n\nYou can either specify these values in environment variables or directly passing\nthe values in the `app.js` file where the middleware is initialized.\n\nTo configure values in `app.js` file, change the following lines:\n\napp.js\n```javascript\n12 ...\n13 ...\n14 const key = null;\n15 const pluginID = null;\n16 ...\n```\n\nYou can also specify these values using environment variables.\nRefer to the table to see which environment variables can be used.\n\n| *Value* | *Environment Variable* | *Default if not set* |\n|:--------------|:--------------------------: |:----------------------------------------:|\n|Secret |STAFFBASE_SSO_SECRET | *(empty)* |\n|Audience |STAFFBASE_SSO_AUDIENCE | *(empty)* |\n|Server Port |PORT | 3000 |\n|Server Address |ADDRESS | *(empty, listening on all IP addresses)* |\n\n## Running the server\n_create-staffbase-plugin_ installs the project dependencies for you.\nAfter configurations is done, the only thing you need to do is navigate to the\nfolder where your app was generated and start the express server.\n```bash\n$ cd [path of generated app]\n$ npm start\n```\n\n## License\n\nCopyright 2017-2025 Staffbase SE.\n\nLicensed under the Apache License, Version 2.0: https://www.apache.org/licenses/LICENSE-2.0\n\n| \n \n | \n \n Staffbase SE\n Staffbase is an internal communications platform built to revolutionize the way you work and unite your company. Staffbase is hiring: https://staffbase.com/jobs\n GitHub | Website | Jobs\n | \n