From 3d158a195a3d6b48508fab1b80b81e8b15e55b85 Mon Sep 17 00:00:00 2001 From: Juan Picado Date: Sun, 25 Dec 2022 18:48:18 +0100 Subject: [PATCH] chore(website): plugin search ui (#3539) * chore: plugin search ui chore: progress chore: format code chore: progress chore: @verdaccio-ui/copy-clipboard chore: search finish * chore: ui-components * Update ToolList.tsx * xss protection * Update static-data.yml * Update AddonCard.tsx --- .github/workflows/static-data.yml | 2 + .prettierignore | 4 +- package.json | 10 + packages/plugins/ui-theme/package.json | 15 +- .../Search/__snapshots__/Search.test.tsx.snap | 10 +- .../src/components/CopyToClipBoard.tsx | 35 +- .../__snapshots__/UpLinks.test.tsx.snap | 4 +- .../Help/__snapshots__/Help.test.tsx.snap | 68 +- packages/plugins/ui-theme/tsconfig.json | 3 + packages/ui-components/.babelrc | 15 + packages/ui-components/package.json | 28 + .../src/CopyClipboard/CopyToClipBoard.tsx | 44 + .../ui-components/src/CopyClipboard/index.ts | 2 + .../ui-components/src/CopyClipboard/utils.ts | 21 + packages/ui-components/src/index.ts | 2 + packages/ui-components/tsconfig.build.json | 10 + packages/ui-components/tsconfig.json | 9 + pnpm-lock.yaml | 484 ++++--- pnpm-workspace.yaml | 1 + scripts/addon-update.ts | 34 + scripts/publish.sh | 13 - website/.eslintrc.js | 20 +- ...-10-05-verdaccio-4-with-ldap-and-docker.md | 36 +- .../2021-04-14-verdaccio-5-migration-guide.md | 5 +- website/community/index.md | 11 +- website/dev/1-plugins-search.md | 12 + website/docs/amazon.md | 26 +- website/docs/ansible.md | 9 +- website/docs/articles.md | 117 +- website/docs/auth.md | 38 +- website/docs/best-practices.md | 23 +- website/docs/caching.md | 22 +- website/docs/chef.md | 8 +- website/docs/ci.md | 2 +- website/docs/cli-registry.md | 8 +- website/docs/cli.md | 17 +- website/docs/config.md | 10 +- website/docs/dev-plugins.md | 23 +- website/docs/docker.md | 71 +- website/docs/e2e.md | 59 +- website/docs/github-actions.md | 2 +- website/docs/how-to-deploy-on-AWS.md | 114 +- website/docs/iis-server.md | 63 +- website/docs/install.md | 4 +- website/docs/kubernetes.md | 13 +- website/docs/linking.md | 11 +- website/docs/logger.md | 16 +- website/docs/logo.md | 21 +- website/docs/node-api.md | 7 +- website/docs/notifications.md | 45 +- website/docs/packages.md | 53 +- website/docs/plugin-auth.md | 71 +- website/docs/plugin-generator.md | 6 +- website/docs/plugin-middleware.md | 17 +- website/docs/plugin-storage.md | 45 +- website/docs/plugins.md | 62 +- website/docs/programmatically.md | 46 +- website/docs/protect-your-dependencies.md | 4 +- website/docs/puppet.md | 12 +- website/docs/repositories.md | 1 - website/docs/reverse-proxy.md | 40 +- website/docs/security-policy.md | 4 +- website/docs/server.md | 5 +- website/docs/setup-npm.md | 7 +- website/docs/setup-pnpm.md | 4 +- website/docs/setup-yarn.md | 2 +- website/docs/ssl.md | 30 +- website/docs/third-party.md | 2 +- website/docs/uplinks.md | 45 +- website/docs/web.md | 59 +- website/docs/what-is-verdaccio.md | 24 +- website/docs/who-is-using.md | 37 +- website/docs/windows.md | 52 +- website/docusaurus.config.js | 176 +-- website/package.json | 18 +- website/sidebars.js | 149 +- website/sidebarsCommunity.js | 4 +- website/sidebarsDev.js | 8 + website/sidebarsTalk.js | 2 +- website/src/components/Contributors.tsx | 56 +- .../components/EcosystemSearch/AddonCard.tsx | 107 ++ .../EcosystemSearch/EcosystemSearch.tsx | 54 + .../EcosystemSearch/FilterControl.tsx | 145 ++ .../src/components/EcosystemSearch/Icon.tsx | 29 + .../components/EcosystemSearch/ToolList.tsx | 101 ++ .../components/EcosystemSearch/addons.json | 1193 +++++++++++++++++ .../src/components/EcosystemSearch/index.ts | 3 + .../src/components/EcosystemSearch/types.ts | 26 + .../src/components/EcosystemSearch/utils.ts | 8 + website/src/components/Features.tsx | 2 +- website/src/components/Header.tsx | 24 +- website/src/components/UsedBy.tsx | 2 +- website/src/components/WhatIsVerdaccio.tsx | 2 +- website/src/pages/index.tsx | 4 +- website/talks/deep-dive-into-verdaccio.md | 2 - website/talks/index.md | 2 - website/versioned_docs/version-5.x/amazon.md | 26 +- website/versioned_docs/version-5.x/ansible.md | 9 +- .../version-5.x/api/node-api/index.md | 2 - .../versioned_docs/version-5.x/articles.md | 117 +- website/versioned_docs/version-5.x/auth.md | 38 +- .../version-5.x/best-practices.md | 23 +- website/versioned_docs/version-5.x/caching.md | 22 +- website/versioned_docs/version-5.x/chef.md | 8 +- website/versioned_docs/version-5.x/ci.md | 2 +- .../version-5.x/cli-registry.md | 8 +- website/versioned_docs/version-5.x/cli.md | 18 +- website/versioned_docs/version-5.x/config.md | 12 +- .../versioned_docs/version-5.x/dev-plugins.md | 23 +- website/versioned_docs/version-5.x/docker.md | 63 +- website/versioned_docs/version-5.x/e2e.md | 59 +- website/versioned_docs/version-5.x/env.md | 17 +- .../version-5.x/github-actions.md | 2 +- .../version-5.x/how-to-deploy-on-AWS.md | 114 +- .../versioned_docs/version-5.x/iis-server.md | 63 +- website/versioned_docs/version-5.x/install.md | 5 +- .../versioned_docs/version-5.x/kubernetes.md | 13 +- website/versioned_docs/version-5.x/linking.md | 11 +- website/versioned_docs/version-5.x/logger.md | 16 +- website/versioned_docs/version-5.x/logo.md | 21 +- .../versioned_docs/version-5.x/node-api.md | 7 +- .../version-5.x/notifications.md | 45 +- .../versioned_docs/version-5.x/packages.md | 53 +- .../versioned_docs/version-5.x/plugin-auth.md | 71 +- .../version-5.x/plugin-generator.md | 6 +- .../version-5.x/plugin-middleware.md | 17 +- .../version-5.x/plugin-storage.md | 45 +- website/versioned_docs/version-5.x/plugins.md | 62 +- .../version-5.x/programmatically.md | 46 +- .../version-5.x/protect-your-dependencies.md | 4 +- website/versioned_docs/version-5.x/puppet.md | 12 +- .../version-5.x/repositories.md | 1 - .../version-5.x/reverse-proxy.md | 40 +- .../version-5.x/security-policy.md | 4 +- website/versioned_docs/version-5.x/server.md | 5 +- .../versioned_docs/version-5.x/setup-npm.md | 7 +- .../versioned_docs/version-5.x/setup-pnpm.md | 4 +- .../versioned_docs/version-5.x/setup-yarn.md | 6 +- website/versioned_docs/version-5.x/ssl.md | 30 +- website/versioned_docs/version-5.x/uplinks.md | 45 +- website/versioned_docs/version-5.x/web.md | 59 +- .../version-5.x/what-is-verdaccio.md | 24 +- .../version-5.x/who-is-using.md | 37 +- website/versioned_docs/version-5.x/windows.md | 52 +- .../version-5.x-sidebars.json | 56 +- website/versions.json | 4 +- 146 files changed, 3808 insertions(+), 1998 deletions(-) create mode 100644 packages/ui-components/.babelrc create mode 100644 packages/ui-components/package.json create mode 100644 packages/ui-components/src/CopyClipboard/CopyToClipBoard.tsx create mode 100644 packages/ui-components/src/CopyClipboard/index.ts create mode 100644 packages/ui-components/src/CopyClipboard/utils.ts create mode 100644 packages/ui-components/src/index.ts create mode 100644 packages/ui-components/tsconfig.build.json create mode 100644 packages/ui-components/tsconfig.json create mode 100644 scripts/addon-update.ts delete mode 100755 scripts/publish.sh create mode 100644 website/dev/1-plugins-search.md create mode 100644 website/sidebarsDev.js create mode 100644 website/src/components/EcosystemSearch/AddonCard.tsx create mode 100644 website/src/components/EcosystemSearch/EcosystemSearch.tsx create mode 100644 website/src/components/EcosystemSearch/FilterControl.tsx create mode 100644 website/src/components/EcosystemSearch/Icon.tsx create mode 100644 website/src/components/EcosystemSearch/ToolList.tsx create mode 100644 website/src/components/EcosystemSearch/addons.json create mode 100644 website/src/components/EcosystemSearch/index.ts create mode 100644 website/src/components/EcosystemSearch/types.ts create mode 100644 website/src/components/EcosystemSearch/utils.ts diff --git a/.github/workflows/static-data.yml b/.github/workflows/static-data.yml index d33ea495e..233e77cca 100644 --- a/.github/workflows/static-data.yml +++ b/.github/workflows/static-data.yml @@ -42,6 +42,8 @@ jobs: run: pnpm run contributors env: TOKEN: ${{ secrets.GITHUB_TOKEN }} + - name: update addson data + run: pnpm script:addson - name: update translations run: pnpm run translations env: diff --git a/.prettierignore b/.prettierignore index f04b443f8..d2872940e 100644 --- a/.prettierignore +++ b/.prettierignore @@ -8,13 +8,15 @@ **/wrong.package.json crowdin.yaml /docs/website -/website/* /website/translated_docs/ CHANGELOG.md CONTRIBUTORS.md node_modules/ **/coverage/** **/static/*.js +**/dist/*.js +website/.docusaurus/**/* +website/i18n/**/* **/build/*.js packages/core/local-storage/_storage/** packages/partials/storage_default_storage/ diff --git a/package.json b/package.json index d05a65767..04426caa3 100644 --- a/package.json +++ b/package.json @@ -43,6 +43,14 @@ "@changesets/cli": "2.24.4", "@changesets/get-dependents-graph": "1.3.4", "@crowdin/cli": "3.9.1", + "@emotion/react": "11.10.5", + "@emotion/styled": "11.10.5", + "@mui/material": "5.11.1", + "react": "18.2.0", + "react-dom": "18.2.0", + "@mui/icons-material": "5.11.0", + "@mui/styles": "5.11.1", + "@mui/system": "5.11.1", "@trivago/prettier-plugin-sort-imports": "3.4.0", "@types/async": "3.2.15", "@types/express": "4.17.14", @@ -93,6 +101,7 @@ "jest-junit": "12.3.0", "kleur": "3.0.3", "lint-staged": "11.2.6", + "got": "11.8.5", "nock": "13.2.9", "nodemon": "2.0.20", "npm-run-all": "4.1.5", @@ -122,6 +131,7 @@ "test:e2e:ui": "pnpm test --filter ...@verdaccio/e2e-ui", "start": "concurrently --kill-others \"pnpm _start:server\" \"pnpm _start:web\"", "contributors": "ts-node ./scripts/contributors-update.ts", + "script:addson": "ts-node ./scripts/addon-update.ts", "start:watch": "concurrently --kill-others \"pnpm _build:watch\" \"pnpm _start:server\" \"pnpm _debug:reload\"", "_build:watch": "pnpm run --parallel watch --filter ./packages", "_start:server": "node --inspect packages/verdaccio/debug/bootstrap.js --listen 8000", diff --git a/packages/plugins/ui-theme/package.json b/packages/plugins/ui-theme/package.json index 682a791d2..ae8e96761 100644 --- a/packages/plugins/ui-theme/package.json +++ b/packages/plugins/ui-theme/package.json @@ -12,15 +12,19 @@ }, "homepage": "https://verdaccio.org", "main": "index.js", + "peerDependencies": { + "@emotion/react": "11.10.5", + "@emotion/styled": "11.10.5", + "@mui/material": "5.11.1", + "react": "18.2.0", + "react-dom": "18.2.0", + "@mui/icons-material": "5.11.0", + "@mui/styles": "5.11.1" + }, "devDependencies": { "@emotion/babel-plugin": "11.10.5", "@emotion/css": "11.10.5", "@emotion/jest": "11.10.5", - "@emotion/react": "11.10.5", - "@emotion/styled": "11.10.5", - "@mui/icons-material": "5.10.14", - "@mui/material": "5.10.14", - "@mui/styles": "5.10.14", "@rematch/core": "2.2.0", "@rematch/loading": "2.1.2", "@rematch/persist": "2.1.2", @@ -33,6 +37,7 @@ "@types/react-virtualized": "9.21.21", "@types/redux": "3.6.0", "@verdaccio/node-api": "workspace:6.0.0-6-next.52", + "@verdaccio/ui-components": "workspace:1.0.0", "@verdaccio/types": "workspace:*", "babel-loader": "8.3.0", "babel-plugin-dynamic-import-node": "2.3.3", diff --git a/packages/plugins/ui-theme/src/App/Header/Search/__snapshots__/Search.test.tsx.snap b/packages/plugins/ui-theme/src/App/Header/Search/__snapshots__/Search.test.tsx.snap index 39d5bda7c..10bb508b5 100644 --- a/packages/plugins/ui-theme/src/App/Header/Search/__snapshots__/Search.test.tsx.snap +++ b/packages/plugins/ui-theme/src/App/Header/Search/__snapshots__/Search.test.tsx.snap @@ -236,8 +236,12 @@ label+.emotion-5 { transform: scaleX(1) translateX(0); } +.emotion-5.Mui-error:before, .emotion-5.Mui-error:after { border-bottom-color: #d32f2f; +} + +.emotion-5.Mui-error:focus-within:after { -webkit-transform: scaleX(1); -moz-transform: scaleX(1); -ms-transform: scaleX(1); @@ -256,12 +260,12 @@ label+.emotion-5 { pointer-events: none; } -.emotion-5:hover:not(.Mui-disabled):before { - border-bottom: 2px solid rgba(0, 0, 0, 0.87); +.emotion-5:hover:not(.Mui-disabled, .Mui-error):before { + border-bottom: 1px solid rgba(0, 0, 0, 0.87); } @media (hover: none) { - .emotion-5:hover:not(.Mui-disabled):before { + .emotion-5:hover:not(.Mui-disabled, .Mui-error):before { border-bottom: 1px solid rgba(0, 0, 0, 0.42); } } diff --git a/packages/plugins/ui-theme/src/components/CopyToClipBoard.tsx b/packages/plugins/ui-theme/src/components/CopyToClipBoard.tsx index d497ba27e..941154b81 100644 --- a/packages/plugins/ui-theme/src/components/CopyToClipBoard.tsx +++ b/packages/plugins/ui-theme/src/components/CopyToClipBoard.tsx @@ -1,43 +1,16 @@ -import styled from '@emotion/styled'; -import FileCopy from '@mui/icons-material/FileCopy'; -import IconButton from '@mui/material/IconButton'; -import Tooltip from '@mui/material/Tooltip'; import React from 'react'; import { useTranslation } from 'react-i18next'; -import { copyToClipBoardUtility } from 'verdaccio-ui/utils/cli-utils'; + +import { CopyClipboard as CopyClipboardOriginal } from '@verdaccio/ui-components'; interface Props { text: string; children?: React.ReactNode; } -function CopyToClipBoard({ text, children, ...props }: Props) { +function CopyToClipBoard(props: Props) { const { t } = useTranslation(); - return ( - - {children ?? text} - - - - - - - ); + return ; } export default CopyToClipBoard; - -const Wrapper = styled('div')({ - display: 'flex', - alignItems: 'center', - justifyContent: 'space-between', -}); - -const Content = styled('span')({ - display: 'inline-block', - overflow: 'hidden', - textOverflow: 'ellipsis', - height: 'auto', - whiteSpace: 'break-spaces', - fontSize: '1rem', -}); diff --git a/packages/plugins/ui-theme/src/pages/Version/DetailContainer/UpLinks/__snapshots__/UpLinks.test.tsx.snap b/packages/plugins/ui-theme/src/pages/Version/DetailContainer/UpLinks/__snapshots__/UpLinks.test.tsx.snap index 0d2fa470c..4ed32f3fa 100644 --- a/packages/plugins/ui-theme/src/pages/Version/DetailContainer/UpLinks/__snapshots__/UpLinks.test.tsx.snap +++ b/packages/plugins/ui-theme/src/pages/Version/DetailContainer/UpLinks/__snapshots__/UpLinks.test.tsx.snap @@ -218,7 +218,7 @@ exports[` component should render the component with uplinks 1`] = ` - 4 years ago + 5 years ago @@ -346,7 +346,7 @@ exports[` component should render the component with uplinks 1`] = ` - 4 years ago + 5 years ago diff --git a/packages/plugins/ui-theme/src/pages/home/PackageList/Help/__snapshots__/Help.test.tsx.snap b/packages/plugins/ui-theme/src/pages/home/PackageList/Help/__snapshots__/Help.test.tsx.snap index bae763bfa..fb29ec9e2 100644 --- a/packages/plugins/ui-theme/src/pages/home/PackageList/Help/__snapshots__/Help.test.tsx.snap +++ b/packages/plugins/ui-theme/src/pages/home/PackageList/Help/__snapshots__/Help.test.tsx.snap @@ -63,7 +63,7 @@ exports[` component should load the component in default state 1`] = ` justify-content: space-between; } -.emotion-9 { +.emotion-8 { display: inline-block; overflow: hidden; text-overflow: ellipsis; @@ -72,7 +72,7 @@ exports[` component should load the component in default state 1`] = ` font-size: 1rem; } -.emotion-11 { +.emotion-9 { display: -webkit-inline-box; display: -webkit-inline-flex; display: -ms-inline-flexbox; @@ -120,38 +120,38 @@ exports[` component should load the component in default state 1`] = ` font-size: 1.75rem; } -.emotion-11::-moz-focus-inner { +.emotion-9::-moz-focus-inner { border-style: none; } -.emotion-11.Mui-disabled { +.emotion-9.Mui-disabled { pointer-events: none; cursor: default; } @media print { - .emotion-11 { + .emotion-9 { -webkit-print-color-adjust: exact; color-adjust: exact; } } -.emotion-11:hover { +.emotion-9:hover { background-color: rgba(0, 0, 0, 0.04); } @media (hover: none) { - .emotion-11:hover { + .emotion-9:hover { background-color: transparent; } } -.emotion-11.Mui-disabled { +.emotion-9.Mui-disabled { background-color: transparent; color: rgba(0, 0, 0, 0.26); } -.emotion-12 { +.emotion-10 { -webkit-user-select: none; -moz-user-select: none; -ms-user-select: none; @@ -168,7 +168,7 @@ exports[` component should load the component in default state 1`] = ` font-size: 1.5rem; } -.emotion-13 { +.emotion-11 { overflow: hidden; pointer-events: none; position: absolute; @@ -180,7 +180,7 @@ exports[` component should load the component in default state 1`] = ` border-radius: inherit; } -.emotion-22 { +.emotion-18 { margin: 0; font-family: -apple-system,BlinkMacSystemFont,"Helvetica Neue",Arial,sans-serif; font-weight: 400; @@ -188,7 +188,7 @@ exports[` component should load the component in default state 1`] = ` line-height: 1.43; } -.emotion-23 { +.emotion-19 { display: -webkit-box; display: -webkit-flex; display: -ms-flexbox; @@ -200,11 +200,11 @@ exports[` component should load the component in default state 1`] = ` padding: 8px; } -.emotion-23>:not(:first-of-type) { +.emotion-19>:not(:first-of-type) { margin-left: 8px; } -.emotion-24 { +.emotion-20 { display: -webkit-inline-box; display: -webkit-inline-flex; display: -ms-inline-flexbox; @@ -250,35 +250,35 @@ exports[` component should load the component in default state 1`] = ` color: #4b5e40; } -.emotion-24::-moz-focus-inner { +.emotion-20::-moz-focus-inner { border-style: none; } -.emotion-24.Mui-disabled { +.emotion-20.Mui-disabled { pointer-events: none; cursor: default; } @media print { - .emotion-24 { + .emotion-20 { -webkit-print-color-adjust: exact; color-adjust: exact; } } -.emotion-24:hover { +.emotion-20:hover { -webkit-text-decoration: none; text-decoration: none; background-color: rgba(75, 94, 64, 0.04); } @media (hover: none) { - .emotion-24:hover { + .emotion-20:hover { background-color: transparent; } } -.emotion-24.Mui-disabled { +.emotion-20.Mui-disabled { color: rgba(0, 0, 0, 0.26); } @@ -307,16 +307,16 @@ exports[` component should load the component in default state 1`] = ` 1. Create user

npm adduser --registry http://localhost:9000/
@@ -344,16 +344,16 @@ exports[` component should load the component in default state 1`] = ` 2. Publish

npm publish --registry http://localhost:9000/

3. Refresh this page

Learn More
diff --git a/packages/plugins/ui-theme/tsconfig.json b/packages/plugins/ui-theme/tsconfig.json index 0dda72f45..46a57dea1 100644 --- a/packages/plugins/ui-theme/tsconfig.json +++ b/packages/plugins/ui-theme/tsconfig.json @@ -20,6 +20,9 @@ "references": [ { "path": "../../node-api" + }, + { + "path": "../../ui-components" } ] } diff --git a/packages/ui-components/.babelrc b/packages/ui-components/.babelrc new file mode 100644 index 000000000..86b0d4bb3 --- /dev/null +++ b/packages/ui-components/.babelrc @@ -0,0 +1,15 @@ +{ + "extends": "../../.babelrc", + "presets": [ + [ + "@babel/preset-env", + { + "targets": ["last 5 versions"], + "bugfixes": true, + "modules": "auto", + "debug": false + } + ], + "@babel/preset-react" + ], +} diff --git a/packages/ui-components/package.json b/packages/ui-components/package.json new file mode 100644 index 000000000..f21979c40 --- /dev/null +++ b/packages/ui-components/package.json @@ -0,0 +1,28 @@ +{ + "name": "@verdaccio/ui-components", + "version": "1.0.0", + "description": "theme ui component", + "author": "Juan Picado ", + "license": "MIT", + "homepage": "https://verdaccio.org", + "main": "./build/index.js", + "types": "build/index.d.ts", + "files": [ + "./build" + ], + "peerDependencies": { + "@emotion/react": "11.10.5", + "@emotion/styled": "11.10.5", + "@mui/material": "5.11.1", + "@mui/icons-material": "5.11.0", + "react": "18.2.0", + "react-dom": "18.2.0" + }, + "scripts": { + "clean": "rimraf ./build", + "type-check": "tsc --noEmit -p tsconfig.build.json", + "build:types": "tsc --emitDeclarationOnly -p tsconfig.build.json", + "build:js": "babel src/ --out-dir build/ --copy-files --extensions \".ts,.tsx\" --source-maps", + "build": "pnpm run build:js && pnpm run build:types" + } +} diff --git a/packages/ui-components/src/CopyClipboard/CopyToClipBoard.tsx b/packages/ui-components/src/CopyClipboard/CopyToClipBoard.tsx new file mode 100644 index 000000000..ca9938e3f --- /dev/null +++ b/packages/ui-components/src/CopyClipboard/CopyToClipBoard.tsx @@ -0,0 +1,44 @@ +import styled from '@emotion/styled'; +import FileCopy from '@mui/icons-material/FileCopy'; +import IconButton from '@mui/material/IconButton'; +import Tooltip from '@mui/material/Tooltip'; +import React from 'react'; + +import { copyToClipBoardUtility } from './utils'; + +interface Props { + text: string; + title: string; + dataTestId: string; + children?: React.ReactNode; +} + +const Wrapper = styled('div')({ + display: 'flex', + alignItems: 'center', + justifyContent: 'space-between', +}); + +const Content = styled('span')({ + display: 'inline-block', + overflow: 'hidden', + textOverflow: 'ellipsis', + height: 'auto', + whiteSpace: 'break-spaces', + fontSize: '1rem', +}); + +function CopyToClipBoard({ text, children, dataTestId, title, ...props }: Props) { + return ( + + {children ?? text} + + + + + + + ); +} + +export default CopyToClipBoard; diff --git a/packages/ui-components/src/CopyClipboard/index.ts b/packages/ui-components/src/CopyClipboard/index.ts new file mode 100644 index 000000000..4fad55d8a --- /dev/null +++ b/packages/ui-components/src/CopyClipboard/index.ts @@ -0,0 +1,2 @@ +export { default } from './CopyToClipBoard'; +export { copyToClipBoardUtility } from './utils'; diff --git a/packages/ui-components/src/CopyClipboard/utils.ts b/packages/ui-components/src/CopyClipboard/utils.ts new file mode 100644 index 000000000..60deb5d74 --- /dev/null +++ b/packages/ui-components/src/CopyClipboard/utils.ts @@ -0,0 +1,21 @@ +import { SyntheticEvent } from 'react'; + +export const copyToClipBoardUtility = + (str: string): ((e: SyntheticEvent) => void) => + (event: SyntheticEvent): void => { + event.preventDefault(); + + const node = document.createElement('div'); + node.innerText = str; + if (document.body) { + document.body.appendChild(node); + + const range = document.createRange(); + const selection = window.getSelection() as Selection; + range.selectNodeContents(node); + selection.removeAllRanges(); + selection.addRange(range); + document.execCommand('copy'); + document.body.removeChild(node); + } + }; diff --git a/packages/ui-components/src/index.ts b/packages/ui-components/src/index.ts new file mode 100644 index 000000000..fde147960 --- /dev/null +++ b/packages/ui-components/src/index.ts @@ -0,0 +1,2 @@ +export { default as CopyClipboard } from './CopyClipboard'; +export * from './CopyClipboard'; diff --git a/packages/ui-components/tsconfig.build.json b/packages/ui-components/tsconfig.build.json new file mode 100644 index 000000000..ca87ff0ae --- /dev/null +++ b/packages/ui-components/tsconfig.build.json @@ -0,0 +1,10 @@ +{ + "extends": "../../tsconfig.base.json", + "compilerOptions": { + "rootDir": "./src", + "outDir": "./build", + "jsx": "react-jsx" + }, + "include": ["src/**/*"], + "exclude": ["node_modules"] +} diff --git a/packages/ui-components/tsconfig.json b/packages/ui-components/tsconfig.json new file mode 100644 index 000000000..27abad49b --- /dev/null +++ b/packages/ui-components/tsconfig.json @@ -0,0 +1,9 @@ +{ + "extends": "../../../tsconfig.reference.json", + "compilerOptions": { + "rootDir": "./src", + "outDir": "./build" + }, + "include": ["src/**/*"], + "exclude": ["node_modules"] +} diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 3fc264925..730d2e31c 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -36,6 +36,12 @@ importers: '@changesets/get-dependents-graph': 1.3.4 '@crowdin/cli': 3.9.1 '@dianmora/contributors': 5.0.0 + '@emotion/react': 11.10.5 + '@emotion/styled': 11.10.5 + '@mui/icons-material': 5.11.0 + '@mui/material': 5.11.1 + '@mui/styles': 5.11.1 + '@mui/system': 5.11.1 '@trivago/prettier-plugin-sort-imports': 3.4.0 '@types/async': 3.2.15 '@types/express': 4.17.14 @@ -76,6 +82,7 @@ importers: detect-secrets: 1.0.6 eslint: 8.26.0 fs-extra: 10.1.0 + got: 11.8.5 husky: 7.0.4 in-publish: 2.0.1 jest: 29.3.1 @@ -90,6 +97,8 @@ importers: nodemon: 2.0.20 npm-run-all: 4.1.5 prettier: 2.7.1 + react: 18.2.0 + react-dom: 18.2.0 rimraf: 3.0.2 selfsigned: 1.10.14 supertest: 6.3.1 @@ -129,6 +138,12 @@ importers: '@changesets/get-dependents-graph': 1.3.4 '@crowdin/cli': 3.9.1 '@dianmora/contributors': 5.0.0 + '@emotion/react': 11.10.5_1532840922ad816597a8a1f20150f016 + '@emotion/styled': 11.10.5_3b133c70b1a482b9a4ebddc7fa0c4cd6 + '@mui/icons-material': 5.11.0_ed487ad508c63ec03dcf89a11d20e33e + '@mui/material': 5.11.1_99dfcb46eee75b85ae928b67cf3103e5 + '@mui/styles': 5.11.1_281bd807203c2775b3a3c90b05c2fd40 + '@mui/system': 5.11.1_afb8d5b1de7aa0563d97313ce9e566ef '@trivago/prettier-plugin-sort-imports': 3.4.0_prettier@2.7.1 '@types/async': 3.2.15 '@types/express': 4.17.14 @@ -169,6 +184,7 @@ importers: detect-secrets: 1.0.6 eslint: 8.26.0 fs-extra: 10.1.0 + got: 11.8.5 husky: 7.0.4 in-publish: 2.0.1 jest: 29.3.1_1b5654bfedeade53353c1a0d6cb7a539 @@ -183,6 +199,8 @@ importers: nodemon: 2.0.20 npm-run-all: 4.1.5 prettier: 2.7.1 + react: 18.2.0 + react-dom: 18.2.0_react@18.2.0 rimraf: 3.0.2 selfsigned: 1.10.14 supertest: 6.3.1 @@ -262,7 +280,7 @@ importers: pnpm: next-7 dependencies: '@verdaccio/test-cli-commons': link:../cli-commons - pnpm: 7.18.2 + pnpm: 7.19.0 e2e/cli/e2e-yarn1: specifiers: @@ -775,11 +793,6 @@ importers: '@emotion/babel-plugin': 11.10.5 '@emotion/css': 11.10.5 '@emotion/jest': 11.10.5 - '@emotion/react': 11.10.5 - '@emotion/styled': 11.10.5 - '@mui/icons-material': 5.10.14 - '@mui/material': 5.10.14 - '@mui/styles': 5.10.14 '@rematch/core': 2.2.0 '@rematch/loading': 2.1.2 '@rematch/persist': 2.1.2 @@ -793,6 +806,7 @@ importers: '@types/redux': 3.6.0 '@verdaccio/node-api': workspace:6.0.0-6-next.52 '@verdaccio/types': workspace:* + '@verdaccio/ui-components': workspace:1.0.0 babel-loader: 8.3.0 babel-plugin-dynamic-import-node: 2.3.3 country-flag-icons: 1.5.5 @@ -857,11 +871,6 @@ importers: '@emotion/babel-plugin': 11.10.5_@babel+core@7.20.2 '@emotion/css': 11.10.5_@babel+core@7.20.2 '@emotion/jest': 11.10.5_@types+jest@27.5.2 - '@emotion/react': 11.10.5_1532840922ad816597a8a1f20150f016 - '@emotion/styled': 11.10.5_3b133c70b1a482b9a4ebddc7fa0c4cd6 - '@mui/icons-material': 5.10.14_20dfc18be76dc71838b4c46297e903fe - '@mui/material': 5.10.14_99dfcb46eee75b85ae928b67cf3103e5 - '@mui/styles': 5.10.14_281bd807203c2775b3a3c90b05c2fd40 '@rematch/core': 2.2.0_redux@4.2.0 '@rematch/loading': 2.1.2_@rematch+core@2.2.0 '@rematch/persist': 2.1.2_e4509283c1984516d02fe029893bd118 @@ -875,6 +884,7 @@ importers: '@types/redux': 3.6.0 '@verdaccio/node-api': link:../../node-api '@verdaccio/types': link:../../core/types + '@verdaccio/ui-components': link:../../ui-components babel-loader: 8.3.0_6bc01c084ca39b676a2aa715dddddb3a babel-plugin-dynamic-import-node: 2.3.3 country-flag-icons: 1.5.5 @@ -1221,6 +1231,9 @@ importers: packages/tools/verdaccio-prefix-fake-plugin: specifiers: {} + packages/ui-components: + specifiers: {} + packages/utils: specifiers: '@verdaccio/core': workspace:6.0.0-6-next.52 @@ -1350,12 +1363,19 @@ importers: '@docusaurus/theme-common': 2.2.0 '@docusaurus/theme-mermaid': 2.2.0 '@docusaurus/theme-search-algolia': 2.2.0 + '@emotion/cache': 11.10.5 + '@emotion/css': 11.10.5 + '@emotion/jest': 11.10.5 + '@emotion/react': 11.10.5 + '@emotion/styled': 11.10.5 + '@lyrasearch/lyra': ^0.3.1 '@mdx-js/react': ^1.6.22 - '@mui/icons-material': 5.10.14 - '@mui/material': 5.10.14 - '@mui/styles': 5.10.14 + '@mui/icons-material': 5.11.0 + '@mui/material': 5.11.1 + '@mui/styles': 5.11.1 '@tsconfig/docusaurus': ^1.0.2 '@verdaccio/crowdin-translations': workspace:* + '@verdaccio/ui-components': workspace:1.0.0 classnames: 2.3.2 clsx: 1.2.1 copy-text-to-clipboard: 3.0.1 @@ -1363,6 +1383,7 @@ importers: docusaurus-plugin-sass: ^0.2.1 docusaurus-plugin-sentry: 1.0.0 docusaurus-plugin-typedoc: latest + dompurify: 2.4.1 esbuild: 0.14.10 esbuild-loader: 2.16.0 p-cancelable: 2.1.1 @@ -1389,16 +1410,24 @@ importers: '@docusaurus/theme-common': 2.2.0_2f57db70698bd2859b2d57df28b32a0e '@docusaurus/theme-mermaid': 2.2.0_2f57db70698bd2859b2d57df28b32a0e '@docusaurus/theme-search-algolia': 2.2.0_eefe0c330866cde741d9800b22175a05 + '@emotion/cache': 11.10.5 + '@emotion/css': 11.10.5_@babel+core@7.20.2 + '@emotion/jest': 11.10.5_@types+jest@27.5.2 + '@emotion/react': 11.10.5_6c1b68e901bb99ed3ea69ae95c71c2fa + '@emotion/styled': 11.10.5_93e827aa9698fc567581cd041bfe54b3 + '@lyrasearch/lyra': 0.3.1 '@mdx-js/react': 1.6.22_react@17.0.2 - '@mui/icons-material': 5.10.14_de1e74c21d7415b69d4d6e8527c4037c - '@mui/material': 5.10.14_fadf603eb922b283b0bc62ba693cb74f - '@mui/styles': 5.10.14_836ee6864c5f6585f34c80db65421cc5 + '@mui/icons-material': 5.11.0_032962c40a50e22b1c046a14205f5ec3 + '@mui/material': 5.11.1_6a27e03dc1b125ccd6f35e7e70fb41ea + '@mui/styles': 5.11.1_836ee6864c5f6585f34c80db65421cc5 + '@verdaccio/ui-components': link:../packages/ui-components classnames: 2.3.2 clsx: 1.2.1 copy-text-to-clipboard: 3.0.1 docusaurus-plugin-contributors: link:../packages/tools/docusaurus-plugin-contributors docusaurus-plugin-sentry: 1.0.0_2f57db70698bd2859b2d57df28b32a0e docusaurus-plugin-typedoc: 0.18.0_adb48f418f538905674ba0692c183df0 + dompurify: 2.4.1 p-cancelable: 2.1.1 react: 17.0.2 react-dom: 17.0.2_react@17.0.2 @@ -2241,7 +2270,7 @@ packages: resolution: {integrity: sha512-0NFvs3VkuSYbFi1x2Vd6tKrywq+z/cLeYC/RJNFrIX/30Bf5aiGYbtvGXolEktzJH8o5E5KJ3tT+nkxuuZFVlA==} engines: {node: '>=6.9.0'} dependencies: - '@babel/types': 7.18.13 + '@babel/types': 7.20.2 /@babel/helper-module-transforms/7.18.9: resolution: {integrity: sha512-KYNqY0ICwfv19b31XzvmI/mfcylOzbLtowkw+mfvGPAQ3kfCnMLYbED3YecL5tPd8nAYFQFAd6JHp2LxZk/J1g==} @@ -3730,7 +3759,7 @@ packages: '@babel/core': ^7.0.0-0 dependencies: '@babel/core': 7.18.10 - '@babel/helper-plugin-utils': 7.18.9 + '@babel/helper-plugin-utils': 7.20.2 dev: false /@babel/plugin-syntax-jsx/7.18.6_@babel+core@7.18.13: @@ -3740,7 +3769,7 @@ packages: '@babel/core': ^7.0.0-0 dependencies: '@babel/core': 7.18.13 - '@babel/helper-plugin-utils': 7.18.9 + '@babel/helper-plugin-utils': 7.20.2 dev: false /@babel/plugin-syntax-jsx/7.18.6_@babel+core@7.19.3: @@ -3750,7 +3779,7 @@ packages: '@babel/core': ^7.0.0-0 dependencies: '@babel/core': 7.19.3 - '@babel/helper-plugin-utils': 7.18.9 + '@babel/helper-plugin-utils': 7.20.2 /@babel/plugin-syntax-jsx/7.18.6_@babel+core@7.20.2: resolution: {integrity: sha512-6mmljtAedFGTWu2p/8WIORGwy+61PLgOMPOdazc7YoJ9ZCWUyFy3A6CpPkRKLKD1ToAesxX8KGEViAiLo9N+7Q==} @@ -3759,7 +3788,7 @@ packages: '@babel/core': ^7.0.0-0 dependencies: '@babel/core': 7.20.2 - '@babel/helper-plugin-utils': 7.18.9 + '@babel/helper-plugin-utils': 7.20.2 /@babel/plugin-syntax-logical-assignment-operators/7.10.4_@babel+core@7.18.10: resolution: {integrity: sha512-d8waShlpFDinQ5MtvGU9xDAOzKH47+FFoney2baFIoMr952hKOLp1HR7VszoZvOsV/4+RRszNY7D17ba0te0ig==} @@ -6311,7 +6340,7 @@ packages: engines: {node: '>=6.9.0'} dependencies: core-js-pure: 3.21.1 - regenerator-runtime: 0.13.9 + regenerator-runtime: 0.13.11 /@babel/runtime/7.14.5: resolution: {integrity: sha512-121rumjddw9c3NCQ55KGkyE1h/nzWhU/owjhw0l4mQrkzz4x9SGS1X8gFLraHwX7td3Yo4QTL+qj0NcIzN87BA==} @@ -6348,13 +6377,20 @@ packages: resolution: {integrity: sha512-EXpLCrk55f+cYqmHsSR+yD/0gAIMxxA9QK9lnQWzhMCvt+YmoBN7Zx94s++Kv0+unHk39vxNO8t+CMA2WSS3wA==} engines: {node: '>=6.9.0'} dependencies: - regenerator-runtime: 0.13.9 + regenerator-runtime: 0.13.11 /@babel/runtime/7.20.1: resolution: {integrity: sha512-mrzLkl6U9YLF8qpqI7TB82PESyEGjm/0Ly91jG575eVxMMlb8fYfOXFZIJ8XfLrJZQbm7dlKry2bJmXBUEkdFg==} engines: {node: '>=6.9.0'} dependencies: regenerator-runtime: 0.13.11 + dev: true + + /@babel/runtime/7.20.6: + resolution: {integrity: sha512-Q+8MqP7TiHMWzSfwiJwXCjyf4GYA4Dgw3emg/7xmwsdLJOZUp+nMqcOwOzzYheuM1rhDu8FSj2l0aoMygEuXuA==} + engines: {node: '>=6.9.0'} + dependencies: + regenerator-runtime: 0.13.11 /@babel/template/7.10.4: resolution: {integrity: sha512-ZCjD27cGJFUB6nmCB1Enki3r+L5kJveX9pq1SvAUKoICy6CZ9yD8xO086YXdYhvNjBdnekm4ZnaP5yC8Cs/1tA==} @@ -6540,6 +6576,7 @@ packages: '@babel/helper-string-parser': 7.19.4 '@babel/helper-validator-identifier': 7.19.1 to-fast-properties: 2.0.0 + dev: false /@babel/types/7.19.0: resolution: {integrity: sha512-YuGopBq3ke25BVSiS6fgF49Ul9gH1x70Bcr6bqRLjWCkcX8Hre1/5+z+IiWOIerRMSSEfGZVB9z9kyq7wVs9YA==} @@ -6583,7 +6620,7 @@ packages: /@changesets/apply-release-plan/6.1.0: resolution: {integrity: sha512-fMNBUAEc013qaA4KUVjdwgYMmKrf5Mlgf6o+f97MJVNzVnikwpWY47Lc3YR1jhC874Fonn5MkjkWK9DAZsdQ5g==} dependencies: - '@babel/runtime': 7.20.1 + '@babel/runtime': 7.20.6 '@changesets/config': 2.1.1 '@changesets/get-version-range-type': 0.3.2 '@changesets/git': 1.4.1 @@ -6601,7 +6638,7 @@ packages: /@changesets/assemble-release-plan/5.2.1: resolution: {integrity: sha512-d6ckasOWlKF9Mzs82jhl6TKSCgVvfLoUK1ERySrTg2TQJdrVUteZue6uEIYUTA7SgMu67UOSwol6R9yj1nTdjw==} dependencies: - '@babel/runtime': 7.20.1 + '@babel/runtime': 7.20.6 '@changesets/errors': 0.1.4 '@changesets/get-dependents-graph': 1.3.4 '@changesets/types': 5.2.0 @@ -6704,7 +6741,7 @@ packages: /@changesets/get-release-plan/3.0.14: resolution: {integrity: sha512-xzSfeyIOvUnbqMuQXVKTYUizreWQfICwoQpvEHoePVbERLocc1tPo5lzR7dmVCFcaA/DcnbP6mxyioeq+JuzSg==} dependencies: - '@babel/runtime': 7.20.1 + '@babel/runtime': 7.20.6 '@changesets/assemble-release-plan': 5.2.1 '@changesets/config': 2.1.1 '@changesets/pre': 1.0.12 @@ -6720,7 +6757,7 @@ packages: /@changesets/git/1.4.1: resolution: {integrity: sha512-GWwRXEqBsQ3nEYcyvY/u2xUK86EKAevSoKV/IhELoZ13caZ1A1TSak/71vyKILtzuLnFPk5mepP5HjBxr7lZ9Q==} dependencies: - '@babel/runtime': 7.20.1 + '@babel/runtime': 7.20.6 '@changesets/errors': 0.1.4 '@changesets/types': 5.2.0 '@manypkg/get-packages': 1.1.3 @@ -6744,7 +6781,7 @@ packages: /@changesets/pre/1.0.12: resolution: {integrity: sha512-RFzWYBZx56MtgMesXjxx7ymyI829/rcIw/41hvz3VJPnY8mDscN7RJyYu7Xm7vts2Fcd+SRcO0T/Ws3I1/6J7g==} dependencies: - '@babel/runtime': 7.20.1 + '@babel/runtime': 7.20.6 '@changesets/errors': 0.1.4 '@changesets/types': 5.2.0 '@manypkg/get-packages': 1.1.3 @@ -6754,7 +6791,7 @@ packages: /@changesets/read/0.5.7: resolution: {integrity: sha512-Iteg0ccTPpkJ+qFzY97k7qqdVE5Kz30TqPo9GibpBk2g8tcLFUqf+Qd0iXPLcyhUZpPL1U6Hia1gINHNKIKx4g==} dependencies: - '@babel/runtime': 7.20.1 + '@babel/runtime': 7.20.6 '@changesets/git': 1.4.1 '@changesets/logger': 0.0.5 '@changesets/parse': 0.3.14 @@ -6779,7 +6816,7 @@ packages: /@changesets/write/0.2.0: resolution: {integrity: sha512-iKHqGYXZvneRzRfvEBpPqKfpGELOEOEP63MKdM/SdSRon40rsUijkTmsGCHT1ueLi3iJPZPmYuZJvjjKrMzumA==} dependencies: - '@babel/runtime': 7.20.1 + '@babel/runtime': 7.20.6 '@changesets/types': 5.2.0 fs-extra: 7.0.1 human-id: 1.0.2 @@ -6914,7 +6951,7 @@ packages: '@babel/preset-env': 7.18.10_@babel+core@7.18.10 '@babel/preset-react': 7.18.6_@babel+core@7.18.10 '@babel/preset-typescript': 7.18.6_@babel+core@7.18.10 - '@babel/runtime': 7.19.4 + '@babel/runtime': 7.20.6 '@babel/runtime-corejs3': 7.18.9 '@babel/traverse': 7.18.11 '@docusaurus/cssnano-preset': 2.0.0-beta.3 @@ -8150,7 +8187,7 @@ packages: '@babel/core': 7.20.2 '@babel/helper-module-imports': 7.18.6 '@babel/plugin-syntax-jsx': 7.18.6_@babel+core@7.20.2 - '@babel/runtime': 7.20.1 + '@babel/runtime': 7.20.6 '@emotion/hash': 0.9.0 '@emotion/memoize': 0.8.0 '@emotion/serialize': 1.1.1 @@ -8160,7 +8197,6 @@ packages: find-root: 1.1.0 source-map: 0.5.7 stylis: 4.1.3 - dev: true /@emotion/cache/11.10.5: resolution: {integrity: sha512-dGYHWyzTdmK+f2+EnIGBpkz1lKc4Zbj2KHd4cX3Wi8/OWr5pKslNjc3yABKH4adRGCvSX4VDC0i04mrrq0aiRA==} @@ -8176,7 +8212,6 @@ packages: dependencies: '@emotion/memoize': 0.8.0 stylis: 4.1.3 - dev: true /@emotion/css/11.10.5_@babel+core@7.20.2: resolution: {integrity: sha512-maJy0wG82hWsiwfJpc3WrYsyVwUbdu+sdIseKUB+/OLjB8zgc3tqkT6eO0Yt0AhIkJwGGnmMY/xmQwEAgQ4JHA==} @@ -8192,7 +8227,6 @@ packages: '@emotion/serialize': 1.1.1 '@emotion/sheet': 1.2.1 '@emotion/utils': 1.2.0 - dev: true /@emotion/hash/0.8.0: resolution: {integrity: sha512-kBJtf7PH6aWwZ6fka3zQ0p6SBYzx4fl1LoZXE2RrnYST9Xljm7WfKJrU4g/Xr3Beg72MLrp1AWNUmuYJTL7Cow==} @@ -8217,13 +8251,12 @@ packages: enzyme-to-json: optional: true dependencies: - '@babel/runtime': 7.20.1 + '@babel/runtime': 7.20.6 '@emotion/css-prettifier': 1.1.1 '@types/jest': 27.5.2 chalk: 4.1.2 specificity: 0.4.1 stylis: 4.1.3 - dev: true /@emotion/memoize/0.7.4: resolution: {integrity: sha512-Ja/Vfqe3HpuzRsG1oBtWTHk2PGZ7GR+2Vz5iYGelAw8dx32K0y7PjVuxK6z1nMpZOqAFsRUPCkK1YjJ56qJlgw==} @@ -8245,7 +8278,7 @@ packages: optional: true dependencies: '@babel/core': 7.20.2 - '@babel/runtime': 7.20.1 + '@babel/runtime': 7.20.6 '@emotion/babel-plugin': 11.10.5_@babel+core@7.20.2 '@emotion/cache': 11.10.5 '@emotion/serialize': 1.1.1 @@ -8257,6 +8290,31 @@ packages: react: 18.2.0 dev: true + /@emotion/react/11.10.5_6c1b68e901bb99ed3ea69ae95c71c2fa: + resolution: {integrity: sha512-TZs6235tCJ/7iF6/rvTaOH4oxQg2gMAcdHemjwLKIjKz4rRuYe1HJ2TQJKnAcRAfOUDdU8XoDadCe1rl72iv8A==} + peerDependencies: + '@babel/core': ^7.0.0 + '@types/react': '*' + react: '>=16.8.0' + peerDependenciesMeta: + '@babel/core': + optional: true + '@types/react': + optional: true + dependencies: + '@babel/core': 7.20.2 + '@babel/runtime': 7.20.6 + '@emotion/babel-plugin': 11.10.5_@babel+core@7.20.2 + '@emotion/cache': 11.10.5 + '@emotion/serialize': 1.1.1 + '@emotion/use-insertion-effect-with-fallbacks': 1.0.0_react@17.0.2 + '@emotion/utils': 1.2.0 + '@emotion/weak-memoize': 0.3.0 + '@types/react': 18.0.25 + hoist-non-react-statics: 3.3.2 + react: 17.0.2 + dev: false + /@emotion/serialize/0.11.16: resolution: {integrity: sha512-G3J4o8by0VRrO+PFeSc3js2myYNOXVJ3Ya+RGVxnshRYgsvErfAOglKAiy1Eo1vhzxqtUvjCyS5gtewzkmvSSg==} dependencies: @@ -8275,7 +8333,6 @@ packages: '@emotion/unitless': 0.8.0 '@emotion/utils': 1.2.0 csstype: 3.1.1 - dev: true /@emotion/sheet/1.2.1: resolution: {integrity: sha512-zxRBwl93sHMsOj4zs+OslQKg/uhF38MB+OMKoCrVuS0nyTkqnau+BM3WGEoOptg9Oz45T/aIGs1qbVAsEFo3nA==} @@ -8294,7 +8351,7 @@ packages: optional: true dependencies: '@babel/core': 7.20.2 - '@babel/runtime': 7.20.1 + '@babel/runtime': 7.20.6 '@emotion/babel-plugin': 11.10.5_@babel+core@7.20.2 '@emotion/is-prop-valid': 1.2.0 '@emotion/react': 11.10.5_1532840922ad816597a8a1f20150f016 @@ -8305,13 +8362,45 @@ packages: react: 18.2.0 dev: true + /@emotion/styled/11.10.5_93e827aa9698fc567581cd041bfe54b3: + resolution: {integrity: sha512-8EP6dD7dMkdku2foLoruPCNkRevzdcBaY6q0l0OsbyJK+x8D9HWjX27ARiSIKNF634hY9Zdoedh8bJCiva8yZw==} + peerDependencies: + '@babel/core': ^7.0.0 + '@emotion/react': ^11.0.0-rc.0 + '@types/react': '*' + react: '>=16.8.0' + peerDependenciesMeta: + '@babel/core': + optional: true + '@types/react': + optional: true + dependencies: + '@babel/core': 7.20.2 + '@babel/runtime': 7.20.6 + '@emotion/babel-plugin': 11.10.5_@babel+core@7.20.2 + '@emotion/is-prop-valid': 1.2.0 + '@emotion/react': 11.10.5_6c1b68e901bb99ed3ea69ae95c71c2fa + '@emotion/serialize': 1.1.1 + '@emotion/use-insertion-effect-with-fallbacks': 1.0.0_react@17.0.2 + '@emotion/utils': 1.2.0 + '@types/react': 18.0.25 + react: 17.0.2 + dev: false + /@emotion/unitless/0.7.5: resolution: {integrity: sha512-OWORNpfjMsSSUBVrRBVGECkhWcULOAJz9ZW8uK9qgxD+87M7jHRcvh/A96XXNhXTLmKcoYSQtBEX7lHMO7YRwg==} dev: true /@emotion/unitless/0.8.0: resolution: {integrity: sha512-VINS5vEYAscRl2ZUDiT3uMPlrFQupiKgHz5AA4bCH1miKBg4qtwkim1qPmJj/4WG6TreYMY111rEFsjupcOKHw==} - dev: true + + /@emotion/use-insertion-effect-with-fallbacks/1.0.0_react@17.0.2: + resolution: {integrity: sha512-1eEgUGmkaljiBnRMTdksDV1W4kUnmwgp7X9G8B++9GYwl1lUdqSndSriIrTJ0N7LQaoauY9JJ2yhiOYK5+NI4A==} + peerDependencies: + react: '>=16.8.0' + dependencies: + react: 17.0.2 + dev: false /@emotion/use-insertion-effect-with-fallbacks/1.0.0_react@18.2.0: resolution: {integrity: sha512-1eEgUGmkaljiBnRMTdksDV1W4kUnmwgp7X9G8B++9GYwl1lUdqSndSriIrTJ0N7LQaoauY9JJ2yhiOYK5+NI4A==} @@ -8684,10 +8773,14 @@ packages: /@leichtgewicht/ip-codec/2.0.3: resolution: {integrity: sha512-nkalE/f1RvRGChwBnEIoBfSEYOXnCRdleKuv6+lePbMDrMZXeDQnqak5XDOeBgrPPyPfAdcCu/B5z+v3VhplGg==} + /@lyrasearch/lyra/0.3.1: + resolution: {integrity: sha512-c0k8R026nfXu/FhA9xgh7jo/+HM4I7XCn5J+us32mQEmqNBmGpD0CEyJ8PiJxmsDapyeYwpMNQgT2lNmnIL86w==} + dev: false + /@manypkg/find-root/1.1.0: resolution: {integrity: sha512-mki5uBvhHzO8kYYix/WRy2WX8S3B5wdVSc9D6KcU5lQNglP2yt58/VfLuAK49glRXChosY8ap2oJ1qgma3GUVA==} dependencies: - '@babel/runtime': 7.20.1 + '@babel/runtime': 7.20.6 '@types/node': 12.19.16 find-up: 4.1.0 fs-extra: 8.1.0 @@ -8696,7 +8789,7 @@ packages: /@manypkg/get-packages/1.1.3: resolution: {integrity: sha512-fo+QhuU3qE/2TQMQmbVMqaQ6EWbMhi4ABWP+O4AM1NqPBuy0OrApV5LO6BrrgnhtAHS2NH6RrVk9OL181tTi8A==} dependencies: - '@babel/runtime': 7.20.1 + '@babel/runtime': 7.20.6 '@changesets/types': 4.0.2 '@manypkg/find-root': 1.1.0 fs-extra: 8.1.0 @@ -8764,8 +8857,8 @@ packages: - supports-color dev: true - /@mui/base/5.0.0-alpha.106_d66faa32af5d287aae1ce541d0cc1a18: - resolution: {integrity: sha512-xJQQtwPCPwr6hGWTBdvDwHYwExn3Bw7nPQkN8Fuz8kHpZqoMVWQvvaFS557AIkkI2AFLV3DxVIMjbCvrIntBWg==} + /@mui/base/5.0.0-alpha.111_d66faa32af5d287aae1ce541d0cc1a18: + resolution: {integrity: sha512-2wfIPpl97S4dPzD0QOM3UIzQ/EuXCYQvHmXxTpfKxev/cfkzOe7Ik/McoYUBbtM1bSOqH3W276R/L2LF9cyXqQ==} engines: {node: '>=12.0.0'} peerDependencies: '@types/react': ^17.0.0 || ^18.0.0 @@ -8775,10 +8868,10 @@ packages: '@types/react': optional: true dependencies: - '@babel/runtime': 7.20.1 + '@babel/runtime': 7.20.6 '@emotion/is-prop-valid': 1.2.0 - '@mui/types': 7.2.1_@types+react@18.0.25 - '@mui/utils': 5.10.14_react@18.2.0 + '@mui/types': 7.2.3_@types+react@18.0.25 + '@mui/utils': 5.11.1_react@18.2.0 '@popperjs/core': 2.11.6 '@types/react': 18.0.25 clsx: 1.2.1 @@ -8788,8 +8881,8 @@ packages: react-is: 18.2.0 dev: true - /@mui/base/5.0.0-alpha.106_fadf603eb922b283b0bc62ba693cb74f: - resolution: {integrity: sha512-xJQQtwPCPwr6hGWTBdvDwHYwExn3Bw7nPQkN8Fuz8kHpZqoMVWQvvaFS557AIkkI2AFLV3DxVIMjbCvrIntBWg==} + /@mui/base/5.0.0-alpha.111_fadf603eb922b283b0bc62ba693cb74f: + resolution: {integrity: sha512-2wfIPpl97S4dPzD0QOM3UIzQ/EuXCYQvHmXxTpfKxev/cfkzOe7Ik/McoYUBbtM1bSOqH3W276R/L2LF9cyXqQ==} engines: {node: '>=12.0.0'} peerDependencies: '@types/react': ^17.0.0 || ^18.0.0 @@ -8799,10 +8892,10 @@ packages: '@types/react': optional: true dependencies: - '@babel/runtime': 7.20.1 + '@babel/runtime': 7.20.6 '@emotion/is-prop-valid': 1.2.0 - '@mui/types': 7.2.1_@types+react@18.0.25 - '@mui/utils': 5.10.14_react@17.0.2 + '@mui/types': 7.2.3_@types+react@18.0.25 + '@mui/utils': 5.11.1_react@17.0.2 '@popperjs/core': 2.11.6 '@types/react': 18.0.25 clsx: 1.2.1 @@ -8812,11 +8905,11 @@ packages: react-is: 18.2.0 dev: false - /@mui/core-downloads-tracker/5.10.14: - resolution: {integrity: sha512-qLgIJNOR9Dre8JiZ/neVzOf4jf88J6YtOkQqugtMrleLjbfRVUSS4LWl9CSOjNq76quYdmYWnSDgfQqOooT2cQ==} + /@mui/core-downloads-tracker/5.11.1: + resolution: {integrity: sha512-QVqVNlZ2K+LqUDE5kFgYd0r4KekR/dv2cNYbAutQWbfOA8VPVUVrDz0ELrEcoe8TjM/CwnsmGvaDh/YSNl/ALA==} - /@mui/icons-material/5.10.14_20dfc18be76dc71838b4c46297e903fe: - resolution: {integrity: sha512-qtH60slQa+7MZRn6kyui8rKuoGDglPqaHX+pzBKNvd8JCOlrnfY5DmGGDdToTXyXl8xJ8nhANZbrbpg7UVKq/Q==} + /@mui/icons-material/5.11.0_032962c40a50e22b1c046a14205f5ec3: + resolution: {integrity: sha512-I2LaOKqO8a0xcLGtIozC9xoXjZAto5G5gh0FYUMAlbsIHNHIjn4Xrw9rvjY20vZonyiGrZNMAlAXYkY6JvhF6A==} engines: {node: '>=12.0.0'} peerDependencies: '@mui/material': ^5.0.0 @@ -8826,67 +8919,31 @@ packages: '@types/react': optional: true dependencies: - '@babel/runtime': 7.20.1 - '@mui/material': 5.10.14_99dfcb46eee75b85ae928b67cf3103e5 - '@types/react': 18.0.25 - react: 18.2.0 - dev: true - - /@mui/icons-material/5.10.14_de1e74c21d7415b69d4d6e8527c4037c: - resolution: {integrity: sha512-qtH60slQa+7MZRn6kyui8rKuoGDglPqaHX+pzBKNvd8JCOlrnfY5DmGGDdToTXyXl8xJ8nhANZbrbpg7UVKq/Q==} - engines: {node: '>=12.0.0'} - peerDependencies: - '@mui/material': ^5.0.0 - '@types/react': ^17.0.0 || ^18.0.0 - react: ^17.0.0 || ^18.0.0 - peerDependenciesMeta: - '@types/react': - optional: true - dependencies: - '@babel/runtime': 7.20.1 - '@mui/material': 5.10.14_fadf603eb922b283b0bc62ba693cb74f + '@babel/runtime': 7.20.6 + '@mui/material': 5.11.1_6a27e03dc1b125ccd6f35e7e70fb41ea '@types/react': 18.0.25 react: 17.0.2 dev: false - /@mui/material/5.10.14_99dfcb46eee75b85ae928b67cf3103e5: - resolution: {integrity: sha512-HWzKVAykePMx54WtxVwZyL1W4k3xlHYIqwMw0CaXAvgB3UE9yjABZuuGr8vG5Z6CSNWamzd+s1x8u7pQPFl9og==} + /@mui/icons-material/5.11.0_ed487ad508c63ec03dcf89a11d20e33e: + resolution: {integrity: sha512-I2LaOKqO8a0xcLGtIozC9xoXjZAto5G5gh0FYUMAlbsIHNHIjn4Xrw9rvjY20vZonyiGrZNMAlAXYkY6JvhF6A==} engines: {node: '>=12.0.0'} peerDependencies: - '@emotion/react': ^11.5.0 - '@emotion/styled': ^11.3.0 + '@mui/material': ^5.0.0 '@types/react': ^17.0.0 || ^18.0.0 react: ^17.0.0 || ^18.0.0 - react-dom: ^17.0.0 || ^18.0.0 peerDependenciesMeta: - '@emotion/react': - optional: true - '@emotion/styled': - optional: true '@types/react': optional: true dependencies: - '@babel/runtime': 7.20.1 - '@emotion/react': 11.10.5_1532840922ad816597a8a1f20150f016 - '@emotion/styled': 11.10.5_3b133c70b1a482b9a4ebddc7fa0c4cd6 - '@mui/base': 5.0.0-alpha.106_d66faa32af5d287aae1ce541d0cc1a18 - '@mui/core-downloads-tracker': 5.10.14 - '@mui/system': 5.10.14_afb8d5b1de7aa0563d97313ce9e566ef - '@mui/types': 7.2.1_@types+react@18.0.25 - '@mui/utils': 5.10.14_react@18.2.0 + '@babel/runtime': 7.20.6 + '@mui/material': 5.11.1_99dfcb46eee75b85ae928b67cf3103e5 '@types/react': 18.0.25 - '@types/react-transition-group': 4.4.5 - clsx: 1.2.1 - csstype: 3.1.1 - prop-types: 15.8.1 react: 18.2.0 - react-dom: 18.2.0_react@18.2.0 - react-is: 18.2.0 - react-transition-group: 4.4.5_react-dom@18.2.0+react@18.2.0 dev: true - /@mui/material/5.10.14_fadf603eb922b283b0bc62ba693cb74f: - resolution: {integrity: sha512-HWzKVAykePMx54WtxVwZyL1W4k3xlHYIqwMw0CaXAvgB3UE9yjABZuuGr8vG5Z6CSNWamzd+s1x8u7pQPFl9og==} + /@mui/material/5.11.1_6a27e03dc1b125ccd6f35e7e70fb41ea: + resolution: {integrity: sha512-yaZiXvcrl2vgUK+VO24780BWRgwdAMmAyuMVZnRTts1Yu0tWd6PjIYq2ZtaOlpj6/LbaSS+Q2kSfxYnDQ20CEQ==} engines: {node: '>=12.0.0'} peerDependencies: '@emotion/react': ^11.5.0 @@ -8902,12 +8959,14 @@ packages: '@types/react': optional: true dependencies: - '@babel/runtime': 7.20.1 - '@mui/base': 5.0.0-alpha.106_fadf603eb922b283b0bc62ba693cb74f - '@mui/core-downloads-tracker': 5.10.14 - '@mui/system': 5.10.14_836ee6864c5f6585f34c80db65421cc5 - '@mui/types': 7.2.1_@types+react@18.0.25 - '@mui/utils': 5.10.14_react@17.0.2 + '@babel/runtime': 7.20.6 + '@emotion/react': 11.10.5_6c1b68e901bb99ed3ea69ae95c71c2fa + '@emotion/styled': 11.10.5_93e827aa9698fc567581cd041bfe54b3 + '@mui/base': 5.0.0-alpha.111_fadf603eb922b283b0bc62ba693cb74f + '@mui/core-downloads-tracker': 5.11.1 + '@mui/system': 5.11.1_8906e7d0f942581a2bbaad45514ff30f + '@mui/types': 7.2.3_@types+react@18.0.25 + '@mui/utils': 5.11.1_react@17.0.2 '@types/react': 18.0.25 '@types/react-transition-group': 4.4.5 clsx: 1.2.1 @@ -8919,8 +8978,44 @@ packages: react-transition-group: 4.4.5_react-dom@17.0.2+react@17.0.2 dev: false - /@mui/private-theming/5.10.14_281bd807203c2775b3a3c90b05c2fd40: - resolution: {integrity: sha512-3aIBe8WK65CwAPDY8nB11hYnzE1CZMymi76UnaFrA/DdGDwl5Y8F6uB+StKrkVmsqF1po7Mp2odqVkHj320gXw==} + /@mui/material/5.11.1_99dfcb46eee75b85ae928b67cf3103e5: + resolution: {integrity: sha512-yaZiXvcrl2vgUK+VO24780BWRgwdAMmAyuMVZnRTts1Yu0tWd6PjIYq2ZtaOlpj6/LbaSS+Q2kSfxYnDQ20CEQ==} + engines: {node: '>=12.0.0'} + peerDependencies: + '@emotion/react': ^11.5.0 + '@emotion/styled': ^11.3.0 + '@types/react': ^17.0.0 || ^18.0.0 + react: ^17.0.0 || ^18.0.0 + react-dom: ^17.0.0 || ^18.0.0 + peerDependenciesMeta: + '@emotion/react': + optional: true + '@emotion/styled': + optional: true + '@types/react': + optional: true + dependencies: + '@babel/runtime': 7.20.6 + '@emotion/react': 11.10.5_1532840922ad816597a8a1f20150f016 + '@emotion/styled': 11.10.5_3b133c70b1a482b9a4ebddc7fa0c4cd6 + '@mui/base': 5.0.0-alpha.111_d66faa32af5d287aae1ce541d0cc1a18 + '@mui/core-downloads-tracker': 5.11.1 + '@mui/system': 5.11.1_afb8d5b1de7aa0563d97313ce9e566ef + '@mui/types': 7.2.3_@types+react@18.0.25 + '@mui/utils': 5.11.1_react@18.2.0 + '@types/react': 18.0.25 + '@types/react-transition-group': 4.4.5 + clsx: 1.2.1 + csstype: 3.1.1 + prop-types: 15.8.1 + react: 18.2.0 + react-dom: 18.2.0_react@18.2.0 + react-is: 18.2.0 + react-transition-group: 4.4.5_react-dom@18.2.0+react@18.2.0 + dev: true + + /@mui/private-theming/5.11.1_281bd807203c2775b3a3c90b05c2fd40: + resolution: {integrity: sha512-nnHg7kA5RwFRhy0wiDYe59sLCVGORpPypL1JcEdhv0+N0Zbmc2E/y4z2zqMRZ62MAEscpro7cQbvv244ThA84A==} engines: {node: '>=12.0.0'} peerDependencies: '@types/react': ^17.0.0 || ^18.0.0 @@ -8929,15 +9024,15 @@ packages: '@types/react': optional: true dependencies: - '@babel/runtime': 7.20.1 - '@mui/utils': 5.10.14_react@18.2.0 + '@babel/runtime': 7.20.6 + '@mui/utils': 5.11.1_react@18.2.0 '@types/react': 18.0.25 prop-types: 15.8.1 react: 18.2.0 dev: true - /@mui/private-theming/5.10.14_836ee6864c5f6585f34c80db65421cc5: - resolution: {integrity: sha512-3aIBe8WK65CwAPDY8nB11hYnzE1CZMymi76UnaFrA/DdGDwl5Y8F6uB+StKrkVmsqF1po7Mp2odqVkHj320gXw==} + /@mui/private-theming/5.11.1_836ee6864c5f6585f34c80db65421cc5: + resolution: {integrity: sha512-nnHg7kA5RwFRhy0wiDYe59sLCVGORpPypL1JcEdhv0+N0Zbmc2E/y4z2zqMRZ62MAEscpro7cQbvv244ThA84A==} engines: {node: '>=12.0.0'} peerDependencies: '@types/react': ^17.0.0 || ^18.0.0 @@ -8946,15 +9041,15 @@ packages: '@types/react': optional: true dependencies: - '@babel/runtime': 7.20.1 - '@mui/utils': 5.10.14_react@17.0.2 + '@babel/runtime': 7.20.6 + '@mui/utils': 5.11.1_react@17.0.2 '@types/react': 18.0.25 prop-types: 15.8.1 react: 17.0.2 dev: false - /@mui/styled-engine/5.10.14_1bab739b53aa95750db0c3a8cf5b22bb: - resolution: {integrity: sha512-bgKdM57ExogWpIfhL/ngSlzF4FhbH00vYF+Y5VALTob4uslFqje0xzoWmbfcCn4cZt2NXxZJIwhsq4vzo5itlw==} + /@mui/styled-engine/5.11.0_1bab739b53aa95750db0c3a8cf5b22bb: + resolution: {integrity: sha512-AF06K60Zc58qf0f7X+Y/QjaHaZq16znliLnGc9iVrV/+s8Ln/FCoeNuFvhlCbZZQ5WQcJvcy59zp0nXrklGGPQ==} engines: {node: '>=12.0.0'} peerDependencies: '@emotion/react': ^11.4.1 @@ -8966,7 +9061,7 @@ packages: '@emotion/styled': optional: true dependencies: - '@babel/runtime': 7.20.1 + '@babel/runtime': 7.20.6 '@emotion/cache': 11.10.5 '@emotion/react': 11.10.5_1532840922ad816597a8a1f20150f016 '@emotion/styled': 11.10.5_3b133c70b1a482b9a4ebddc7fa0c4cd6 @@ -8975,8 +9070,8 @@ packages: react: 18.2.0 dev: true - /@mui/styled-engine/5.10.14_react@17.0.2: - resolution: {integrity: sha512-bgKdM57ExogWpIfhL/ngSlzF4FhbH00vYF+Y5VALTob4uslFqje0xzoWmbfcCn4cZt2NXxZJIwhsq4vzo5itlw==} + /@mui/styled-engine/5.11.0_dae5179fd2272f0a616e3283dc43ce35: + resolution: {integrity: sha512-AF06K60Zc58qf0f7X+Y/QjaHaZq16znliLnGc9iVrV/+s8Ln/FCoeNuFvhlCbZZQ5WQcJvcy59zp0nXrklGGPQ==} engines: {node: '>=12.0.0'} peerDependencies: '@emotion/react': ^11.4.1 @@ -8988,15 +9083,17 @@ packages: '@emotion/styled': optional: true dependencies: - '@babel/runtime': 7.20.1 + '@babel/runtime': 7.20.6 '@emotion/cache': 11.10.5 + '@emotion/react': 11.10.5_6c1b68e901bb99ed3ea69ae95c71c2fa + '@emotion/styled': 11.10.5_93e827aa9698fc567581cd041bfe54b3 csstype: 3.1.1 prop-types: 15.8.1 react: 17.0.2 dev: false - /@mui/styles/5.10.14_281bd807203c2775b3a3c90b05c2fd40: - resolution: {integrity: sha512-efmROE5O+9qV1Wj7Q/Cz3ZplsuqSwqWRFTUWwTuTedoLetAO6ExgV4vGD1bkFsr9+VkAfJV/Zy4KPM0ouok7aA==} + /@mui/styles/5.11.1_281bd807203c2775b3a3c90b05c2fd40: + resolution: {integrity: sha512-iZgKBqaXzVMKn1WYHUV4RNAnrT/AyJ9jrYSBufjGPF9GgWpJYOj+NGrX04Qgx87kFXSzA/vMRK/tdaK/QgoDbQ==} engines: {node: '>=12.0.0'} peerDependencies: '@types/react': ^17.0.0 @@ -9005,11 +9102,11 @@ packages: '@types/react': optional: true dependencies: - '@babel/runtime': 7.20.1 + '@babel/runtime': 7.20.6 '@emotion/hash': 0.9.0 - '@mui/private-theming': 5.10.14_281bd807203c2775b3a3c90b05c2fd40 - '@mui/types': 7.2.1_@types+react@18.0.25 - '@mui/utils': 5.10.14_react@18.2.0 + '@mui/private-theming': 5.11.1_281bd807203c2775b3a3c90b05c2fd40 + '@mui/types': 7.2.3_@types+react@18.0.25 + '@mui/utils': 5.11.1_react@18.2.0 '@types/react': 18.0.25 clsx: 1.2.1 csstype: 3.1.1 @@ -9026,8 +9123,8 @@ packages: react: 18.2.0 dev: true - /@mui/styles/5.10.14_836ee6864c5f6585f34c80db65421cc5: - resolution: {integrity: sha512-efmROE5O+9qV1Wj7Q/Cz3ZplsuqSwqWRFTUWwTuTedoLetAO6ExgV4vGD1bkFsr9+VkAfJV/Zy4KPM0ouok7aA==} + /@mui/styles/5.11.1_836ee6864c5f6585f34c80db65421cc5: + resolution: {integrity: sha512-iZgKBqaXzVMKn1WYHUV4RNAnrT/AyJ9jrYSBufjGPF9GgWpJYOj+NGrX04Qgx87kFXSzA/vMRK/tdaK/QgoDbQ==} engines: {node: '>=12.0.0'} peerDependencies: '@types/react': ^17.0.0 @@ -9036,11 +9133,11 @@ packages: '@types/react': optional: true dependencies: - '@babel/runtime': 7.20.1 + '@babel/runtime': 7.20.6 '@emotion/hash': 0.9.0 - '@mui/private-theming': 5.10.14_836ee6864c5f6585f34c80db65421cc5 - '@mui/types': 7.2.1_@types+react@18.0.25 - '@mui/utils': 5.10.14_react@17.0.2 + '@mui/private-theming': 5.11.1_836ee6864c5f6585f34c80db65421cc5 + '@mui/types': 7.2.3_@types+react@18.0.25 + '@mui/utils': 5.11.1_react@17.0.2 '@types/react': 18.0.25 clsx: 1.2.1 csstype: 3.1.1 @@ -9057,8 +9154,8 @@ packages: react: 17.0.2 dev: false - /@mui/system/5.10.14_836ee6864c5f6585f34c80db65421cc5: - resolution: {integrity: sha512-2de7XCjRb1j8Od0Stmo0LwFMLpOMNT4wzfINuExXI1TVSuyxXIXUxiC5FEgJW3GMvf/a7SUR8VOiMoKlKWzukw==} + /@mui/system/5.11.1_8906e7d0f942581a2bbaad45514ff30f: + resolution: {integrity: sha512-BEA2S0hay8n8CcZftkeAVsi0nsb5ZjdnZRCahv5lX7QJYwDjO4ucJ6lnvxHe2v/9Te1LLjTO7ojxu/qM6CE5Cg==} engines: {node: '>=12.0.0'} peerDependencies: '@emotion/react': ^11.5.0 @@ -9073,11 +9170,13 @@ packages: '@types/react': optional: true dependencies: - '@babel/runtime': 7.20.1 - '@mui/private-theming': 5.10.14_836ee6864c5f6585f34c80db65421cc5 - '@mui/styled-engine': 5.10.14_react@17.0.2 - '@mui/types': 7.2.1_@types+react@18.0.25 - '@mui/utils': 5.10.14_react@17.0.2 + '@babel/runtime': 7.20.6 + '@emotion/react': 11.10.5_6c1b68e901bb99ed3ea69ae95c71c2fa + '@emotion/styled': 11.10.5_93e827aa9698fc567581cd041bfe54b3 + '@mui/private-theming': 5.11.1_836ee6864c5f6585f34c80db65421cc5 + '@mui/styled-engine': 5.11.0_dae5179fd2272f0a616e3283dc43ce35 + '@mui/types': 7.2.3_@types+react@18.0.25 + '@mui/utils': 5.11.1_react@17.0.2 '@types/react': 18.0.25 clsx: 1.2.1 csstype: 3.1.1 @@ -9085,8 +9184,8 @@ packages: react: 17.0.2 dev: false - /@mui/system/5.10.14_afb8d5b1de7aa0563d97313ce9e566ef: - resolution: {integrity: sha512-2de7XCjRb1j8Od0Stmo0LwFMLpOMNT4wzfINuExXI1TVSuyxXIXUxiC5FEgJW3GMvf/a7SUR8VOiMoKlKWzukw==} + /@mui/system/5.11.1_afb8d5b1de7aa0563d97313ce9e566ef: + resolution: {integrity: sha512-BEA2S0hay8n8CcZftkeAVsi0nsb5ZjdnZRCahv5lX7QJYwDjO4ucJ6lnvxHe2v/9Te1LLjTO7ojxu/qM6CE5Cg==} engines: {node: '>=12.0.0'} peerDependencies: '@emotion/react': ^11.5.0 @@ -9101,13 +9200,13 @@ packages: '@types/react': optional: true dependencies: - '@babel/runtime': 7.20.1 + '@babel/runtime': 7.20.6 '@emotion/react': 11.10.5_1532840922ad816597a8a1f20150f016 '@emotion/styled': 11.10.5_3b133c70b1a482b9a4ebddc7fa0c4cd6 - '@mui/private-theming': 5.10.14_281bd807203c2775b3a3c90b05c2fd40 - '@mui/styled-engine': 5.10.14_1bab739b53aa95750db0c3a8cf5b22bb - '@mui/types': 7.2.1_@types+react@18.0.25 - '@mui/utils': 5.10.14_react@18.2.0 + '@mui/private-theming': 5.11.1_281bd807203c2775b3a3c90b05c2fd40 + '@mui/styled-engine': 5.11.0_1bab739b53aa95750db0c3a8cf5b22bb + '@mui/types': 7.2.3_@types+react@18.0.25 + '@mui/utils': 5.11.1_react@18.2.0 '@types/react': 18.0.25 clsx: 1.2.1 csstype: 3.1.1 @@ -9115,8 +9214,8 @@ packages: react: 18.2.0 dev: true - /@mui/types/7.2.1_@types+react@18.0.25: - resolution: {integrity: sha512-c5mSM7ivD8EsqK6HUi9hQPr5V7TJ/IRThUQ9nWNYPdhCGriTSQV4vL6DflT99LkM+wLiIS1rVjphpEWxERep7A==} + /@mui/types/7.2.3_@types+react@18.0.25: + resolution: {integrity: sha512-tZ+CQggbe9Ol7e/Fs5RcKwg/woU+o8DCtOnccX6KmbBc7YrfqMYEYuaIcXHuhpT880QwNkZZ3wQwvtlDFA2yOw==} peerDependencies: '@types/react': '*' peerDependenciesMeta: @@ -9125,13 +9224,13 @@ packages: dependencies: '@types/react': 18.0.25 - /@mui/utils/5.10.14_react@17.0.2: - resolution: {integrity: sha512-12p59+wDZpA++XVJmKwqsZmrA1nmUQ5d0a1yQWtcDjxNyER1EDzozYN/db+FY2i5ceQh2TynPTEwGms2mXDwFg==} + /@mui/utils/5.11.1_react@17.0.2: + resolution: {integrity: sha512-lMAPgIJoil8V9ZxsMbEflMsvZmWcHbRVMc4JDY9jPO9V4welpF43h/O267b1RqlcRnC5MEbVQV605GYkTZY29Q==} engines: {node: '>=12.0.0'} peerDependencies: react: ^17.0.0 || ^18.0.0 dependencies: - '@babel/runtime': 7.20.1 + '@babel/runtime': 7.20.6 '@types/prop-types': 15.7.5 '@types/react-is': 17.0.3 prop-types: 15.8.1 @@ -9139,13 +9238,13 @@ packages: react-is: 18.2.0 dev: false - /@mui/utils/5.10.14_react@18.2.0: - resolution: {integrity: sha512-12p59+wDZpA++XVJmKwqsZmrA1nmUQ5d0a1yQWtcDjxNyER1EDzozYN/db+FY2i5ceQh2TynPTEwGms2mXDwFg==} + /@mui/utils/5.11.1_react@18.2.0: + resolution: {integrity: sha512-lMAPgIJoil8V9ZxsMbEflMsvZmWcHbRVMc4JDY9jPO9V4welpF43h/O267b1RqlcRnC5MEbVQV605GYkTZY29Q==} engines: {node: '>=12.0.0'} peerDependencies: react: ^17.0.0 || ^18.0.0 dependencies: - '@babel/runtime': 7.20.1 + '@babel/runtime': 7.20.6 '@types/prop-types': 15.7.5 '@types/react-is': 17.0.3 prop-types: 15.8.1 @@ -10029,7 +10128,6 @@ packages: dependencies: jest-matcher-utils: 27.4.6 pretty-format: 27.5.1 - dev: true /@types/js-levenshtein/1.1.1: resolution: {integrity: sha512-qC4bCqYGy1y/NP7dDVr7KJarn+PbX1nSpwA7JXdu0HxT3QYjO8MJ+cntENtHFVy2dRAyBV23OZ6MxsW1AM1L8g==} @@ -11482,7 +11580,7 @@ packages: /babel-plugin-macros/2.8.0: resolution: {integrity: sha512-SEP5kJpfGYqYKpBrj5XU3ahw5p5GOHJ0U5ssOSQ/WBVdwkD2Dzlce95exQTs3jOVWPPKLBN2rlEWkCK7dSmLvg==} dependencies: - '@babel/runtime': 7.20.1 + '@babel/runtime': 7.20.6 cosmiconfig: 6.0.0 resolve: 1.22.0 dev: true @@ -11491,10 +11589,9 @@ packages: resolution: {integrity: sha512-Cg7TFGpIr01vOQNODXOOaGz2NpCU5gl8x1qJFbb6hbZxR7XrcE2vtbAsTAbJ7/xwJtUuJEw8K8Zr/AE0LHlesg==} engines: {node: '>=10', npm: '>=6'} dependencies: - '@babel/runtime': 7.20.1 + '@babel/runtime': 7.20.6 cosmiconfig: 7.0.1 resolve: 1.22.0 - dev: true /babel-plugin-polyfill-corejs2/0.3.2_@babel+core@7.18.10: resolution: {integrity: sha512-LPnodUl3lS0/4wN3Rb+m+UK8s7lj2jcLRrjho4gLw+OJs+I4bvGXshINesY5xx/apM+biTnQ9reDI8yj+0M5+Q==} @@ -12359,7 +12456,7 @@ packages: shallow-clone: 3.0.1 /clone-response/1.0.2: - resolution: {integrity: sha1-0dyXOSAxTfZ/vrlCI7TuNQI56Ws=} + resolution: {integrity: sha512-yjLXh88P599UOyPTFX0POsd7WxnbsVsGohcwzHOLspIhhpalPw1BcqED8NblyZLKcGrL8dTgMlcaZxV2jAD41Q==} dependencies: mimic-response: 1.0.1 @@ -12982,7 +13079,7 @@ packages: /css-vendor/2.0.8: resolution: {integrity: sha512-x9Aq0XTInxrkuFeHKbYC7zWY8ai7qJ04Kxd9MnvbC1uO5DagxoHQjm4JvG+vCdXOoFtCjbL2XSZfxmoYa9uQVQ==} dependencies: - '@babel/runtime': 7.20.1 + '@babel/runtime': 7.20.6 is-in-browser: 1.1.3 /css-what/3.4.2: @@ -14192,7 +14289,6 @@ packages: /diff-sequences/27.5.1: resolution: {integrity: sha512-k1gCAXAsNgLwEL+Y8Wvl+M6oEFj5bgazfZULpS5CneoPPXRaCCW7dm+q21Ky2VEE5X+VeRDBVg1Pcvvsr4TtNQ==} engines: {node: ^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0} - dev: true /diff-sequences/29.3.1: resolution: {integrity: sha512-hlM3QR272NXCi4pq+N4Kok4kOp6EsgOM3ZSpJI7Da3UAs+Ttsi8MRmB6trM/lhyzUxGfOgnpkHtgqm5Q/CTcfQ==} @@ -14308,7 +14404,7 @@ packages: /dom-helpers/5.2.1: resolution: {integrity: sha512-nRCa7CK3VTrM2NmGkIy4cbK7IZlgBE/PYMn55rrXefr5xXDP0LdtfPnblFDoVdcAfslJ7or6iqAUnx0CCGIWQA==} dependencies: - '@babel/runtime': 7.20.1 + '@babel/runtime': 7.20.6 csstype: 3.1.1 /dom-serializer/0.1.1: @@ -14370,7 +14466,6 @@ packages: /dompurify/2.4.1: resolution: {integrity: sha512-ewwFzHzrrneRjxzmK6oVz/rZn9VWspGFRDb4/rRtIsM1n36t9AKma/ye8syCpcw+XJ25kOK/hOG7t1j2I2yBqA==} - dev: true /domutils/1.7.0: resolution: {integrity: sha512-Lgd2XcJ/NjEw+7tFvfKxOzCYKZsdct5lczQ2ZaQY8Djz7pfAD3Gbp8ySJWtreII/vDlMVmxwa6pHmdxIYgttDg==} @@ -15894,7 +15989,6 @@ packages: /find-root/1.1.0: resolution: {integrity: sha512-NKfW6bec6GfKc0SGx1e07QZY9PE99u0Bft/0rzSD5k3sO/vwkVUpDUKVm5Gpp5Ue3YfShPFTX2070tDs5kB9Ng==} - dev: true /find-up/2.1.0: resolution: {integrity: sha1-RdG35QbHF93UgndaK3eSCjwMV6c=} @@ -17222,7 +17316,7 @@ packages: engines: {node: '>= 0.4'} /is-arrayish/0.2.1: - resolution: {integrity: sha1-d8mYQFJ6qOyxqLppe4BkWnqSap0=} + resolution: {integrity: sha512-zz06S8t0ozoDXMG+ube26zeCTNXcKIPJZJi8hBrF4idCLms4CG9QtK7qBl1boi5ODzFpjswb5JPmHCbMpjaYzg==} /is-bigint/1.0.2: resolution: {integrity: sha512-0JV5+SOCQkIdzjBK9buARcV804Ddu7A0Qet6sHi3FimE9ne6m4BGQZfRn+NZiXbBk4F4XmHfDZIipLj9pX8dSA==} @@ -17787,7 +17881,6 @@ packages: diff-sequences: 27.5.1 jest-get-type: 27.5.1 pretty-format: 27.5.1 - dev: true /jest-diff/29.3.1: resolution: {integrity: sha512-vU8vyiO7568tmin2lA3r2DP8oRvzhvRcD4DjpXc6uGveQodyk7CKLhQlCSiwgx3g0pFaE88/KLZ0yaTWMc4Uiw==} @@ -17860,7 +17953,6 @@ packages: /jest-get-type/27.5.1: resolution: {integrity: sha512-2KY95ksYSaK7DMBWQn6dQz3kqAf3BB64y2udeG+hv4KfSOb9qwcYQstTJc1KCbsix+wLZWZYN8t7nwX3GOBLRw==} engines: {node: ^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0} - dev: true /jest-get-type/29.2.0: resolution: {integrity: sha512-uXNJlg8hKFEnDgFsrCjznB+sTxdkuqiCL6zMgA75qEbAJjJYTs9XPrvDctrEig2GDow22T/LvHgO57iJhXB/UA==} @@ -17909,7 +18001,6 @@ packages: jest-diff: 27.5.1 jest-get-type: 27.5.1 pretty-format: 27.5.1 - dev: true /jest-matcher-utils/29.3.1: resolution: {integrity: sha512-fkRMZUAScup3txIKfMe3AIZZmPEjWEdsPJFK3AIy5qRohWqQFg1qrmKfYXR9qEkNc7OdAu2N4KPHibEmy4HPeQ==} @@ -18361,53 +18452,53 @@ packages: /jss-plugin-camel-case/10.9.2: resolution: {integrity: sha512-wgBPlL3WS0WDJ1lPJcgjux/SHnDuu7opmgQKSraKs4z8dCCyYMx9IDPFKBXQ8Q5dVYij1FFV0WdxyhuOOAXuTg==} dependencies: - '@babel/runtime': 7.20.1 + '@babel/runtime': 7.20.6 hyphenate-style-name: 1.0.4 jss: 10.9.2 /jss-plugin-default-unit/10.9.2: resolution: {integrity: sha512-pYg0QX3bBEFtTnmeSI3l7ad1vtHU42YEEpgW7pmIh+9pkWNWb5dwS/4onSfAaI0kq+dOZHzz4dWe+8vWnanoSg==} dependencies: - '@babel/runtime': 7.20.1 + '@babel/runtime': 7.20.6 jss: 10.9.2 /jss-plugin-global/10.9.2: resolution: {integrity: sha512-GcX0aE8Ef6AtlasVrafg1DItlL/tWHoC4cGir4r3gegbWwF5ZOBYhx04gurPvWHC8F873aEGqge7C17xpwmp2g==} dependencies: - '@babel/runtime': 7.20.1 + '@babel/runtime': 7.20.6 jss: 10.9.2 /jss-plugin-nested/10.9.2: resolution: {integrity: sha512-VgiOWIC6bvgDaAL97XCxGD0BxOKM0K0zeB/ECyNaVF6FqvdGB9KBBWRdy2STYAss4VVA7i5TbxFZN+WSX1kfQA==} dependencies: - '@babel/runtime': 7.20.1 + '@babel/runtime': 7.20.6 jss: 10.9.2 tiny-warning: 1.0.3 /jss-plugin-props-sort/10.9.2: resolution: {integrity: sha512-AP1AyUTbi2szylgr+O0OB7gkIxEGzySLITZ2GpsaoX72YMCGI2jYAc+WUhPfvUnZYiauF4zTnN4V4TGuvFjJlw==} dependencies: - '@babel/runtime': 7.20.1 + '@babel/runtime': 7.20.6 jss: 10.9.2 /jss-plugin-rule-value-function/10.9.2: resolution: {integrity: sha512-vf5ms8zvLFMub6swbNxvzsurHfUZ5Shy5aJB2gIpY6WNA3uLinEcxYyraQXItRHi5ivXGqYciFDRM2ZoVoRZ4Q==} dependencies: - '@babel/runtime': 7.20.1 + '@babel/runtime': 7.20.6 jss: 10.9.2 tiny-warning: 1.0.3 /jss-plugin-vendor-prefixer/10.9.2: resolution: {integrity: sha512-SxcEoH+Rttf9fEv6KkiPzLdXRmI6waOTcMkbbEFgdZLDYNIP9UKNHFy6thhbRKqv0XMQZdrEsbDyV464zE/dUA==} dependencies: - '@babel/runtime': 7.20.1 + '@babel/runtime': 7.20.6 css-vendor: 2.0.8 jss: 10.9.2 /jss/10.9.2: resolution: {integrity: sha512-b8G6rWpYLR4teTUbGd4I4EsnWjg7MN0Q5bSsjKhVkJVjhQDy2KzkbD2AW3TuT0RYZVmZZHKIrXDn6kjU14qkUg==} dependencies: - '@babel/runtime': 7.20.1 + '@babel/runtime': 7.20.6 csstype: 3.1.1 is-in-browser: 1.1.3 tiny-warning: 1.0.3 @@ -19553,7 +19644,7 @@ packages: prop-types: ^15.0.0 react: ^0.14.0 || ^15.0.0 || ^16.0.0 || ^17.0.0 dependencies: - '@babel/runtime': 7.20.1 + '@babel/runtime': 7.20.6 prop-types: 15.8.1 react: 17.0.2 tiny-warning: 1.0.3 @@ -20398,7 +20489,7 @@ packages: dev: true /object-assign/4.1.1: - resolution: {integrity: sha1-IQmtx5ZYh8/AXLvUQsrIv7s2CGM=} + resolution: {integrity: sha512-rJgTQnkUnH1sFw8yT6VSU3zD3sWmu6sZhIseY8VX+GRu3P6F7Fu+JNDoXfklElbLJSnc3FUQHVe4cU5hj+BcUg==} engines: {node: '>=0.10.0'} /object-copy/0.1.0: @@ -20513,7 +20604,7 @@ packages: engines: {node: '>= 0.8'} /once/1.4.0: - resolution: {integrity: sha1-WDsap3WWHUsROsF9nFC6753Xa9E=} + resolution: {integrity: sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w==} dependencies: wrappy: 1.0.2 @@ -20963,8 +21054,8 @@ packages: hasBin: true dev: false - /pnpm/7.18.2: - resolution: {integrity: sha512-k3LCdsrTPqL4dVgCgjpdWHcwzhEA/YCu2ZFR/+EiFy91azuRQcWgQbYf5rPkYu5x1Dl8+2KtXKTlDcrSx5hnQw==} + /pnpm/7.19.0: + resolution: {integrity: sha512-0ZPqlBY9M5fqKI9Ya0kEB7PQj7Pg7bYEjXbRbg4pNnJIObzXeO+PaK/8FBd8KMgJe5QpLb6rn2nVFHNSNoz+kw==} engines: {node: '>=14.6'} hasBin: true dev: false @@ -22112,7 +22203,6 @@ packages: ansi-regex: 5.0.1 ansi-styles: 5.2.0 react-is: 17.0.2 - dev: true /pretty-format/29.3.1: resolution: {integrity: sha512-FyLnmb1cYJV8biEIiRyzRFvs2lry7PPIvOqKVe1GCUEYg4YGmlx1qG9EJNMxArYm7piII4qb8UV1Pncq5dxmcg==} @@ -22575,7 +22665,6 @@ packages: /react-is/17.0.2: resolution: {integrity: sha512-w2GsyukL62IJnlaff/nRegPQR94C/XXamvMWmSHRJ4y7Ts/4ocGRmTHvOs8PSE6pB3dWOrD/nueuU5sduBsQ4w==} - dev: true /react-is/18.2.0: resolution: {integrity: sha512-xWGDIW6x921xtzPkhiULtthJHoJvBbF3q26fzloPCK0hsvxtPVelvftw3zjbHWSkR2km9Z+4uxbDDK/6Zw9B8w==} @@ -22624,7 +22713,7 @@ packages: react-loadable: '*' webpack: '>=4.41.1 || 5.x' dependencies: - '@babel/runtime': 7.20.1 + '@babel/runtime': 7.20.6 react-loadable: /@docusaurus/react-loadable/5.5.2_react@17.0.2 webpack: 5.74.0_esbuild@0.14.10 @@ -22635,7 +22724,7 @@ packages: react-loadable: '*' webpack: '>=4.41.1 || 5.x' dependencies: - '@babel/runtime': 7.20.1 + '@babel/runtime': 7.20.6 react-loadable: 5.5.0_react@17.0.2 webpack: 5.74.0_esbuild@0.14.10 dev: false @@ -22717,7 +22806,7 @@ packages: react: '>=15' react-router: '>=5' dependencies: - '@babel/runtime': 7.20.1 + '@babel/runtime': 7.20.6 react: 17.0.2 react-router: 5.3.3_react@17.0.2 dev: false @@ -22728,7 +22817,7 @@ packages: react: '>=15' react-router: '>=5' dependencies: - '@babel/runtime': 7.20.1 + '@babel/runtime': 7.20.6 react: 17.0.2 react-router: 5.3.4_react@17.0.2 @@ -22737,7 +22826,7 @@ packages: peerDependencies: react: '>=15' dependencies: - '@babel/runtime': 7.20.1 + '@babel/runtime': 7.20.6 history: 4.10.1 loose-envify: 1.4.0 prop-types: 15.8.1 @@ -22781,7 +22870,7 @@ packages: peerDependencies: react: '>=15' dependencies: - '@babel/runtime': 7.20.1 + '@babel/runtime': 7.20.6 history: 4.10.1 hoist-non-react-statics: 3.3.2 loose-envify: 1.4.0 @@ -22869,7 +22958,7 @@ packages: react: '>=16.6.0' react-dom: '>=16.6.0' dependencies: - '@babel/runtime': 7.20.1 + '@babel/runtime': 7.20.6 dom-helpers: 5.2.1 loose-envify: 1.4.0 prop-types: 15.8.1 @@ -22883,7 +22972,7 @@ packages: react: '>=16.6.0' react-dom: '>=16.6.0' dependencies: - '@babel/runtime': 7.20.1 + '@babel/runtime': 7.20.6 dom-helpers: 5.2.1 loose-envify: 1.4.0 prop-types: 15.8.1 @@ -23089,7 +23178,7 @@ packages: /regenerator-transform/0.15.0: resolution: {integrity: sha512-LsrGtPmbYg19bcPHwdtmXwbW+TqNvtY4riE3P83foeHRroMbH6/2ddFBfab3t7kbzc7v7p4wbkIecHImqt0QNg==} dependencies: - '@babel/runtime': 7.20.1 + '@babel/runtime': 7.20.6 /regex-not/1.0.2: resolution: {integrity: sha512-J6SDjUgDxQj5NusnOtdFxDwN/+HWykR8GELwctJ7mdqhcyy1xEc4SRFHUXvxTp661YaVKAjfRLZ9cCqS6tn32A==} @@ -24148,7 +24237,6 @@ packages: /specificity/0.4.1: resolution: {integrity: sha512-1klA3Gi5PD1Wv9Q0wUoOQN1IWAuPu0D1U03ThXTr0cJ20+/iq2tHSDnK7Kk/0LXJ1ztUB2/1Os0wKmfyNgUQfg==} hasBin: true - dev: true /split-string/3.1.0: resolution: {integrity: sha512-NzNVhJDYpwceVVii8/Hu6DKfD2G+NrQHlS/V/qgv763EYudVwEcMQNxd2lh+0VrUByXN/oJkl5grOhYWvQUYiw==} @@ -24909,7 +24997,7 @@ packages: resolution: {integrity: sha512-3f0uOEAQwIqGuWW2MVzYg8fV/QNnc/IpuJNG837rLuczAaLVHslWHZQj4IGiEl5Hs3kkbhwL9Ab7Hrsmuj+Smw==} /to-fast-properties/2.0.0: - resolution: {integrity: sha1-3F5pjL0HkmW8c+A3doGk5Og/YW4=} + resolution: {integrity: sha512-/OaKK0xYrs3DmxRYqL/yDc+FxFUVYhDlXMhRmv3z915w2HF1tnN1omB354j8VUGO/hbRzyD6Y3sA7v7GS/ceog==} engines: {node: '>=4'} /to-object-path/0.3.0: @@ -26632,7 +26720,7 @@ packages: strip-ansi: 7.0.1 /wrappy/1.0.2: - resolution: {integrity: sha1-tSQ9jz7BqjXxNkYFvA0QNuMKtp8=} + resolution: {integrity: sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==} /write-file-atomic/3.0.3: resolution: {integrity: sha512-AvHcyZ5JnSfq3ioSyjrBkH9yW4m7Ayk8/9My/DD9onKeu/94fwrMocemO2QAJFAlnnDN+ZDS+ZjAR5ua1/PV/Q==} diff --git a/pnpm-workspace.yaml b/pnpm-workspace.yaml index 08ec48a42..53e2a79c7 100644 --- a/pnpm-workspace.yaml +++ b/pnpm-workspace.yaml @@ -2,6 +2,7 @@ packages: - packages/* - packages/core/* - packages/tools/* + - packages/ui/* - packages/server/* - packages/plugins/audit - packages/plugins/auth-memory diff --git a/scripts/addon-update.ts b/scripts/addon-update.ts new file mode 100644 index 000000000..76c3ebf9d --- /dev/null +++ b/scripts/addon-update.ts @@ -0,0 +1,34 @@ +import fs from 'fs/promises'; +import got from 'got'; +import path from 'path'; + +(async () => { + const data = require('../website/src/components/EcosystemSearch/addons.json'); + for (let item of data.addons) { + try { + const d = await got(`https://registry.npmjs.org/${item.name}`).json(); + const apiDownloads = await got( + `https://api.npmjs.org/downloads/point/last-month/${item.name}` + ).json(); + // @ts-ignore + item.description = d.description; + item.url = `https://www.npmjs.org/${item.name}`; + item.registry = `https://registry.npmjs.org/${item.name}`; + item.bundled = typeof item.bundled === 'boolean' ? item.bundled : false; + item.origin = item.origin ? item.origin : 'community'; + item.category = item.category ? item.category : 'authentication'; + // @ts-ignore + item.latest = d['dist-tags'].latest; + // @ts-ignore + item.downloads = apiDownloads.downloads; + // console.log('d', item); + } catch (err) { + // eslint-disable-next-line no-console + console.error('error for %s', item.name, err); + } + } + await fs.writeFile( + path.join(__dirname, '../website/src/components/EcosystemSearch/addons.json'), + JSON.stringify({ ...data }, null, 4) + ); +})(); diff --git a/scripts/publish.sh b/scripts/publish.sh deleted file mode 100755 index bddb4bd7a..000000000 --- a/scripts/publish.sh +++ /dev/null @@ -1,13 +0,0 @@ -#!/bin/bash - -# Get the last tag from GitHub -lastTag=$(git describe --tags $(git rev-list --tags --max-count=1)) - -# Print it to the console for verification -echo "Bumping version to new tag: ${lastTag}" - -# creating .npmrc -echo "//$REGISTRY_URL/:_authToken=$REGISTRY_AUTH_TOKEN" > .npmrc - -# Publish to NPM -npm publish --registry https://$REGISTRY_URL/ diff --git a/website/.eslintrc.js b/website/.eslintrc.js index 32dc89d9b..29e796489 100644 --- a/website/.eslintrc.js +++ b/website/.eslintrc.js @@ -2,21 +2,19 @@ module.exports = { root: true, parser: '@typescript-eslint/parser', parserOptions: { - project: './tsconfig.json' + project: './tsconfig.json', }, - plugins: [ - '@typescript-eslint', - ], + plugins: ['@typescript-eslint'], extends: [ 'eslint:recommended', 'plugin:@typescript-eslint/recommended', - '@verdaccio/eslint-config' + '@verdaccio/eslint-config', ], rules: { - "@typescript-eslint/no-use-before-define": "warn", - "max-len": "off", - "react/jsx-one-expression-per-line": "off", - "react/prop-types": "off", - "react/require-default-props": "off", - } + '@typescript-eslint/no-use-before-define': 'warn', + 'max-len': 'off', + 'react/jsx-one-expression-per-line': 'off', + 'react/prop-types': 'off', + 'react/require-default-props': 'off', + }, }; diff --git a/website/blog/2019-10-05-verdaccio-4-with-ldap-and-docker.md b/website/blog/2019-10-05-verdaccio-4-with-ldap-and-docker.md index 28d1fc84f..b3f3e5270 100644 --- a/website/blog/2019-10-05-verdaccio-4-with-ldap-and-docker.md +++ b/website/blog/2019-10-05-verdaccio-4-with-ldap-and-docker.md @@ -93,18 +93,18 @@ auth: ldap: type: ldap client_options: - url: "ldap://ldap.verdaccio.private.rocks" + url: 'ldap://ldap.verdaccio.private.rocks' # Only required if you need auth to bind - adminDn: "cn=readonly,dc=verdaccio.private,dc=rocks" - adminPassword: "********" + adminDn: 'cn=readonly,dc=verdaccio.private,dc=rocks' + adminPassword: '********' # Search base for users - searchBase: "dc=verdaccio.private,dc=rocks" - searchFilter: "(&(uid={{username}})(memberOf=cn=npm_users,ou=npm,ou=groups,ou=developers,dc=verdaccio.private,dc=rocks))" + searchBase: 'dc=verdaccio.private,dc=rocks' + searchFilter: '(&(uid={{username}})(memberOf=cn=npm_users,ou=npm,ou=groups,ou=developers,dc=verdaccio.private,dc=rocks))' # # If you are using groups, this is also needed - groupDnProperty: "cn" - groupSearchBase: "ou=npm,ou=groups,ou=developers,dc=verdaccio.private,dc=rocks" + groupDnProperty: 'cn' + groupSearchBase: 'ou=npm,ou=groups,ou=developers,dc=verdaccio.private,dc=rocks' # If you have memberOf support on your ldap - searchAttributes: ["*", "memberOf"] + searchAttributes: ['*', 'memberOf'] # Else, if you don't (use one or the other): # groupSearchFilter: '(memberUid={{dn}})' # @@ -120,24 +120,24 @@ uplinks: url: https://registry.npmjs.org/ packages: - "@scope-*/*": + '@scope-*/*': # scoped packages access: npm_access publish: npm_publisher unpublish: npm_publisher - "@scope/*": + '@scope/*': # scoped packages access: npm_access publish: npm_publisher unpublish: npm_publisher - "@*/*": + '@*/*': # scoped packages access: $all publish: $authenticated proxy: npmjs - "**": + '**': # allow all users (including non-authenticated users) to read and # publish all packages # @@ -176,7 +176,7 @@ I use the `memberOf` overlay, and this LDAP query will allow to connect only use If you are not using the `memberOf` overlay, you can allow all users to login as follow: ```yaml -searchFilter: "(&(uid={{username}}))" +searchFilter: '(&(uid={{username}}))' ``` **`groupSearchBase`** @@ -184,7 +184,7 @@ searchFilter: "(&(uid={{username}}))" I use an organization unit to store all my group for verdaccio-ldap security. ```yaml -groupSearchBase: "ou=npm,ou=groups,ou=developers,dc=verdaccio.private,dc=rocks" +groupSearchBase: 'ou=npm,ou=groups,ou=developers,dc=verdaccio.private,dc=rocks' ``` ### Security {#security} @@ -198,12 +198,12 @@ Note that we do not use `proxy: npmjs` because they only exist on our private re I recommend you to create scope for all of your private packages, and reserve the group on npmjs registry so no one will be able to publish publicly in it in the futur. ```yaml -"@scope-*/*": +'@scope-*/*': access: npm_access publish: npm_publisher unpublish: npm_publisher -"@scope/*": +'@scope/*': # scoped packages access: npm_access publish: npm_publisher @@ -215,7 +215,7 @@ They are some public package on npmjs registry which are scoped, this will proxy I recommend not to change this, otherwise you might get issue to download them. ```yaml -"@*/*": +'@*/*': # scoped packages access: $all publish: $authenticated @@ -228,7 +228,7 @@ We also use `proxy: npmjs` so we also serve all the public package on npmjs regi We allow `$all` to download from our registry, because it is public, but if you want to preserve your bandwidth or just forbid unknown user to authenticate, just use `$authenticated` as well. ```yaml -"**": +'**': access: $all publish: $authenticated proxy: npmjs diff --git a/website/blog/2021-04-14-verdaccio-5-migration-guide.md b/website/blog/2021-04-14-verdaccio-5-migration-guide.md index 3ca710a41..69bd0f65e 100644 --- a/website/blog/2021-04-14-verdaccio-5-migration-guide.md +++ b/website/blog/2021-04-14-verdaccio-5-migration-guide.md @@ -210,7 +210,7 @@ web: If you have a custom UI plugin for the them you will need to adapt your build to the new requirements. -The previous version you only need to return a function with a string and the path of the directory. +The previous version you only need to return a function with a string and the path of the directory. ``` const path = require('path'); @@ -245,6 +245,7 @@ Since Verdaccio 5 the module must return an object and the `index.html` is ignor }, manifestFiles: { js: [ 'runtime.js', 'vendors.js', 'main.js' ] } ``` + - `staticPath`: is the same data returned in Verdaccio 4. - `manifest`: A webpack manifest object. - `manifestFiles`: A object with one property `js` and the array (order matters) of the manifest id to be loaded in the template dynamically. @@ -268,7 +269,6 @@ const { WebpackManifestPlugin } = require('webpack-manifest-plugin'); ``` - # Troubleshooting ### After upgrade I don't see packages on the UI {#after-upgrade-i-dont-see-packages-on-the-ui} @@ -280,4 +280,3 @@ storage: ./storage ``` Use an absolute path instead, more info [here](https://github.com/verdaccio/verdaccio/issues/2204). - diff --git a/website/community/index.md b/website/community/index.md index d7fa2987e..b794efa3a 100644 --- a/website/community/index.md +++ b/website/community/index.md @@ -4,7 +4,6 @@ hide_title: true sidebar_label: Help --- - This project is maintained by the Verdaccio community, maintainers and users that provide helps to other users. Independently the source you select for seeking answers **remind to be polite and patience**. ## Questions {#questions} @@ -26,7 +25,7 @@ If you have a question, most probably has already been answer, few ways to disco height="500" frameBorder="0" /> -``` +``` ## Package Managers {#package-managers} @@ -40,7 +39,7 @@ A private registry is mostly used with a package manager, some issues or questio ## News {#news} - - [Twitter](http://twitter.com/verdaccio) - - [Twitter Community](https://twitter.com/i/communities/1502550839499579393) - - [Telegram](https://t.me/verdaccio) - - [Blog](https://verdaccio.org/blog) +- [Twitter](http://twitter.com/verdaccio) +- [Twitter Community](https://twitter.com/i/communities/1502550839499579393) +- [Telegram](https://t.me/verdaccio) +- [Blog](https://verdaccio.org/blog) diff --git a/website/dev/1-plugins-search.md b/website/dev/1-plugins-search.md new file mode 100644 index 000000000..f172f5e8c --- /dev/null +++ b/website/dev/1-plugins-search.md @@ -0,0 +1,12 @@ +--- +title: Plugins Search +hide_title: true +sidebar_label: Plugin Search +--- + +```mdx-code-block +import EcosystemSearch from '@site/src/components/EcosystemSearch'; + + + +``` diff --git a/website/docs/amazon.md b/website/docs/amazon.md index 1e22423d9..556e8ffc2 100644 --- a/website/docs/amazon.md +++ b/website/docs/amazon.md @@ -1,6 +1,6 @@ --- id: amazon -title: "Amazon Web Services" +title: 'Amazon Web Services' --- This document describes several approaches for deploying Verdaccio in the AWS cloud. @@ -29,19 +29,21 @@ Elastic File System ``` Architecture notes: -* Deploy this stack into the region closest to your users for maximum performance. -* We use an auto scaling group primarily for self-healing. The system requirements of Verdaccio are pretty low, so it's unlikely you'll need multiple instances to handle traffic load. -* Because Amazon Linux 2 doesn't include Node, we run Verdaccio as a Docker image rather than natively on the instance. This is faster and more secure than relying on third party package sources for Node. -* Elastic File System is cheap and stateful, and works across AZs. An alternative would be the [third-party S3 storage plugin](https://github.com/remitly/verdaccio-s3-storage). - * For backup, use AWS Backup + +- Deploy this stack into the region closest to your users for maximum performance. +- We use an auto scaling group primarily for self-healing. The system requirements of Verdaccio are pretty low, so it's unlikely you'll need multiple instances to handle traffic load. +- Because Amazon Linux 2 doesn't include Node, we run Verdaccio as a Docker image rather than natively on the instance. This is faster and more secure than relying on third party package sources for Node. +- Elastic File System is cheap and stateful, and works across AZs. An alternative would be the [third-party S3 storage plugin](https://github.com/remitly/verdaccio-s3-storage). + - For backup, use AWS Backup Estimated monthly cost for a small installation (in us-east-1): -* ALB (1 LCU average): $22.265/mo -* EC2 (t3.nano): $3.796/mo -* EBS (8gb): $0.80/mo -* EFS (5gb): $1.5/mo -* Data transfer: (10gb): $0.9/mo -* **TOTAL:** Under $30/mo + +- ALB (1 LCU average): $22.265/mo +- EC2 (t3.nano): $3.796/mo +- EBS (8gb): $0.80/mo +- EFS (5gb): $1.5/mo +- Data transfer: (10gb): $0.9/mo +- **TOTAL:** Under $30/mo ## ECS {#ecs} diff --git a/website/docs/ansible.md b/website/docs/ansible.md index 016360f83..c14b43303 100644 --- a/website/docs/ansible.md +++ b/website/docs/ansible.md @@ -1,6 +1,6 @@ --- id: ansible -title: "Ansible" +title: 'Ansible' --- We have a customised solution for `verdaccio` in our organization. @@ -9,10 +9,9 @@ We have a customised solution for `verdaccio` in our organization. #### Other options {#other-options} -* Ansible role for Gentoo users: [jirutka/ansible-role-sinopia](https://github.com/jirutka/ansible-role-sinopia). -* Ansible role for Ubuntu users: [jagregory/sinopia-ansible](https://github.com/jagregory/sinopia-ansible). -* ansible-verdaccio-role [https://github.com/refinery29/ansible-verdaccio-role](https://github.com/refinery29/ansible-verdaccio-role) - +- Ansible role for Gentoo users: [jirutka/ansible-role-sinopia](https://github.com/jirutka/ansible-role-sinopia). +- Ansible role for Ubuntu users: [jagregory/sinopia-ansible](https://github.com/jagregory/sinopia-ansible). +- ansible-verdaccio-role [https://github.com/refinery29/ansible-verdaccio-role](https://github.com/refinery29/ansible-verdaccio-role) #### Related talks {#related-talks} diff --git a/website/docs/articles.md b/website/docs/articles.md index b4f196020..3b42a6628 100644 --- a/website/docs/articles.md +++ b/website/docs/articles.md @@ -1,6 +1,6 @@ --- id: articles -title: "Articles" +title: 'Articles' --- Below is a list of articles about Verdaccio. If you have written a blog post or tutorial that mentions Verdaccio, feel free to add it here! @@ -9,92 +9,87 @@ Below is a list of articles about Verdaccio. If you have written a blog post or ## Maintainer Articles {#maintainers-articles} -* [An Introduction to Verdaccio](https://medium.com/@jotadeveloper/an-introduction-to-verdaccio-f6c72e865425) -* [Five use cases where a npm private proxy fits in your workflow](https://medium.com/@jotadeveloper/five-use-cases-where-a-npm-private-proxy-fits-in-your-workflow-632a81779c14) -* [An Introduction to Verdaccio](https://medium.com/@jotadeveloper/an-introduction-to-verdaccio-f6c72e865425) -* [NPM Registry for your organisation](https://medium.com/@ayusharma.in/npm-registry-for-your-organisation-aeb8ea76144) -* [Verdaccio 3 released 🎉!!](https://medium.com/verdaccio/verdaccio-3-released-feb06ef38558) -* [The crazy story of Verdaccio](https://medium.com/verdaccio/the-crazy-story-of-verdaccio-d35d924728bc) -* [Verdaccio 4 alpha release 🚀](https://medium.com/verdaccio/verdaccio-4-alpha-release-400c7ed4884d) -* [Verdaccio and deterministic lock files](https://medium.com/verdaccio/verdaccio-and-deterministic-lock-files-5339d82d611e) -* [Setting up Verdaccio on DigitalOcean](https://medium.com/verdaccio/setting-up-verdaccio-on-digitalocean-61b5d08e4f0d) -* [How I learned React Js and how you can…](https://medium.com/verdaccio/how-i-learned-react-js-and-how-you-can-8663f938426c) -* [How did I fall in the open source world…and that was a nice thing!](https://medium.com/@priscilawebdev/how-do-i-fall-in-the-open-source-world-and-that-was-a-nice-thing-b0e85d05490d) - - +- [An Introduction to Verdaccio](https://medium.com/@jotadeveloper/an-introduction-to-verdaccio-f6c72e865425) +- [Five use cases where a npm private proxy fits in your workflow](https://medium.com/@jotadeveloper/five-use-cases-where-a-npm-private-proxy-fits-in-your-workflow-632a81779c14) +- [An Introduction to Verdaccio](https://medium.com/@jotadeveloper/an-introduction-to-verdaccio-f6c72e865425) +- [NPM Registry for your organisation](https://medium.com/@ayusharma.in/npm-registry-for-your-organisation-aeb8ea76144) +- [Verdaccio 3 released 🎉!!](https://medium.com/verdaccio/verdaccio-3-released-feb06ef38558) +- [The crazy story of Verdaccio](https://medium.com/verdaccio/the-crazy-story-of-verdaccio-d35d924728bc) +- [Verdaccio 4 alpha release 🚀](https://medium.com/verdaccio/verdaccio-4-alpha-release-400c7ed4884d) +- [Verdaccio and deterministic lock files](https://medium.com/verdaccio/verdaccio-and-deterministic-lock-files-5339d82d611e) +- [Setting up Verdaccio on DigitalOcean](https://medium.com/verdaccio/setting-up-verdaccio-on-digitalocean-61b5d08e4f0d) +- [How I learned React Js and how you can…](https://medium.com/verdaccio/how-i-learned-react-js-and-how-you-can-8663f938426c) +- [How did I fall in the open source world…and that was a nice thing!](https://medium.com/@priscilawebdev/how-do-i-fall-in-the-open-source-world-and-that-was-a-nice-thing-b0e85d05490d) # Articles / Blogs / Tutorials (by Language) ### Remarkable Articles {#remarkable-articles} -* [Why Private Npm Registries Matter and How Verdaccio Makes It Easy](https://fusebit.io/blog/private-npm-verdaccio/?utm_source=verdaccio.org&utm_medium=referral) -* [Automating package publishing in JavaScript projects](https://blog.codecentric.de/en/2021/02/automating-package-publishing-in-javascript-projects/) -* [10 npm Security Best Practices](https://snyk.io/blog/ten-npm-security-best-practices/) -* [Cover Your Apps While Still Using npm](https://nodesource.com/blog/cover-your-apps-while-still-using-npm/) -* [Containerizing Node.js Applications with Docker](https://nodesource.com/blog/containerizing-node-js-applications-with-docker) -* [Verdaccio - A lightweight npm proxy registry - Interview with Juan Picado](https://survivejs.com/blog/verdaccio-interview/) -* [Host, Publish and Manage Private npm Packages with Verdaccio](https://www.sitepoint.com/private-npm-packages-verdaccio/) -* [Free Private NPM with Verdaccio and AWS](https://medium.com/@odahcam/free-private-npm-with-verdaccio-and-aws-a88e6f0f4beb) -* [Run your own Unity Package Server!](https://medium.com/@markushofer/run-your-own-unity-package-server-b4fe9995704e) -* [Ways to have your private npm registry — and a final DIY solution](https://medium.com/engenharia-noalvo/ways-to-have-your-private-npm-registry-and-a-final-diy-solution-eed001a88e74) -* [How to set up a free private npm registry… for Windows](https://medium.com/@Anderson7301/how-to-set-up-a-free-private-npm-registry-for-windows-f532c6a381ce) -* [Setup a Private NPM Server on Azure in 45 Seconds](https://edi.wang/post/2020/7/7/setup-a-private-npm-server-on-azure-in-45-seconds) +- [Why Private Npm Registries Matter and How Verdaccio Makes It Easy](https://fusebit.io/blog/private-npm-verdaccio/?utm_source=verdaccio.org&utm_medium=referral) +- [Automating package publishing in JavaScript projects](https://blog.codecentric.de/en/2021/02/automating-package-publishing-in-javascript-projects/) +- [10 npm Security Best Practices](https://snyk.io/blog/ten-npm-security-best-practices/) +- [Cover Your Apps While Still Using npm](https://nodesource.com/blog/cover-your-apps-while-still-using-npm/) +- [Containerizing Node.js Applications with Docker](https://nodesource.com/blog/containerizing-node-js-applications-with-docker) +- [Verdaccio - A lightweight npm proxy registry - Interview with Juan Picado](https://survivejs.com/blog/verdaccio-interview/) +- [Host, Publish and Manage Private npm Packages with Verdaccio](https://www.sitepoint.com/private-npm-packages-verdaccio/) +- [Free Private NPM with Verdaccio and AWS](https://medium.com/@odahcam/free-private-npm-with-verdaccio-and-aws-a88e6f0f4beb) +- [Run your own Unity Package Server!](https://medium.com/@markushofer/run-your-own-unity-package-server-b4fe9995704e) +- [Ways to have your private npm registry — and a final DIY solution](https://medium.com/engenharia-noalvo/ways-to-have-your-private-npm-registry-and-a-final-diy-solution-eed001a88e74) +- [How to set up a free private npm registry… for Windows](https://medium.com/@Anderson7301/how-to-set-up-a-free-private-npm-registry-for-windows-f532c6a381ce) +- [Setup a Private NPM Server on Azure in 45 Seconds](https://edi.wang/post/2020/7/7/setup-a-private-npm-server-on-azure-in-45-seconds) ### English {#english} -* [Testing your npm package before releasing it using Verdaccio + ngrok](https://medium.com/strapi/testing-your-npm-package-before-releasing-it-using-verdaccio-ngrok-28e2832c850a) -* [Host your own private NPM repository with Verdaccio](https://medium.com/devopslinks/host-your-own-private-npm-repository-with-verdaccio-e8a3202b97c5) -* [Local npm private registry with zero configuration](https://dev.to/iriskatastic/local-npm-private-registry-with-zero-configuration-njo) -* [It depends. On the registry](https://blog.softwaremill.com/it-depends-on-the-registry-8fa9d9c5a3b) -* [Host, Publish and Manage Private npm Packages with Verdaccio](http://allprowebdesigns.com/2017/01/host-publish-and-manage-private-npm-packages-with-verdaccio/) -* [Setting Up a Private NPM Registry](https://gir.me.uk/posts/private-npm-registry.html) -* [Testing NPM alpha / beta / rc packages](https://medium.com/@the1mills/testing-npm-alpha-beta-rc-packages-108b65eb03d2) -* [Running a local npm repository on Windows Server using Verdaccio](https://robertwray.co.uk/blog/running-a-local-npm-repository-on-windows-server-using-verdaccio) -* [Kubernetes private NPM registry](https://medium.com/@tompape/kubernetes-private-npm-registry-fb5f450fa611) -* [Verdaccio examples for Google Cloud and K8s setups. https://github.com/papezt/verdaccio-examples](https://github.com/papezt/verdaccio-examples) -* [Setting up a private NPM Registry Is Easier Than You Think](https://medium.com/@902Labs/setting-up-a-private-npm-registry-is-easier-than-you-think-455e1bd438f2) +- [Testing your npm package before releasing it using Verdaccio + ngrok](https://medium.com/strapi/testing-your-npm-package-before-releasing-it-using-verdaccio-ngrok-28e2832c850a) +- [Host your own private NPM repository with Verdaccio](https://medium.com/devopslinks/host-your-own-private-npm-repository-with-verdaccio-e8a3202b97c5) +- [Local npm private registry with zero configuration](https://dev.to/iriskatastic/local-npm-private-registry-with-zero-configuration-njo) +- [It depends. On the registry](https://blog.softwaremill.com/it-depends-on-the-registry-8fa9d9c5a3b) +- [Host, Publish and Manage Private npm Packages with Verdaccio](http://allprowebdesigns.com/2017/01/host-publish-and-manage-private-npm-packages-with-verdaccio/) +- [Setting Up a Private NPM Registry](https://gir.me.uk/posts/private-npm-registry.html) +- [Testing NPM alpha / beta / rc packages](https://medium.com/@the1mills/testing-npm-alpha-beta-rc-packages-108b65eb03d2) +- [Running a local npm repository on Windows Server using Verdaccio](https://robertwray.co.uk/blog/running-a-local-npm-repository-on-windows-server-using-verdaccio) +- [Kubernetes private NPM registry](https://medium.com/@tompape/kubernetes-private-npm-registry-fb5f450fa611) +- [Verdaccio examples for Google Cloud and K8s setups. https://github.com/papezt/verdaccio-examples](https://github.com/papezt/verdaccio-examples) +- [Setting up a private NPM Registry Is Easier Than You Think](https://medium.com/@902Labs/setting-up-a-private-npm-registry-is-easier-than-you-think-455e1bd438f2) ### Japanese {#japanese} -* [Verdaccio でプライベート npm リポジトリをサクッと立てる](http://neos21.hatenablog.com/entry/2017/09/08/080000) -* [verdaccioでprivateなnpmリポジトリを作成](https://qiita.com/mtokiwa/items/1bc22a2270e4408d4cdd) -* [Version control of my own UnityPackage with Unity × Verdaccio / Unity×Verdaccioで自作UnityPackageをバージョン管理する](https://synamon.hatenablog.com/entry/2018/08/15/185607) +- [Verdaccio でプライベート npm リポジトリをサクッと立てる](http://neos21.hatenablog.com/entry/2017/09/08/080000) +- [verdaccio で private な npm リポジトリを作成](https://qiita.com/mtokiwa/items/1bc22a2270e4408d4cdd) +- [Version control of my own UnityPackage with Unity × Verdaccio / Unity×Verdaccio で自作 UnityPackage をバージョン管理する](https://synamon.hatenablog.com/entry/2018/08/15/185607) ### Chinese {#chinese} -* [使用 verdaccio 搭建 npm 私有仓储](https://blog.sigoden.com/verdaccio--private-npm-registry/) -* [Verdaccio：一个轻量级的私有npm代理注册表（sinopia fork)](https://www.ctolib.com/verdaccio-verdaccio.html) -* [npm 私服工具verdaccio 安装配置试用](http://www.cnblogs.com/rongfengliang/p/7811838.html) -* [搭建私有npm镜像](http://www.blackcater.win/2018/03/01/%E6%90%AD%E5%BB%BA%E7%A7%81%E6%9C%89npm%E9%95%9C%E5%83%8F/) -* [搭建离线npm私库——verdaccio](https://www.jishux.com/plus/view-765581-1.html) -* [[筆記] 建立自己的 npm, 以npm Orgs跟Verdaccio為例](https://medium.com/@ceall8650/%E7%AD%86%E8%A8%98-%E5%BB%BA%E7%AB%8B%E8%87%AA%E5%B7%B1%E7%9A%84-npm-%E4%BB%A5npm-orgs%E8%B7%9Fverdaccio%E7%82%BA%E4%BE%8B-cfb83b2307e6) - +- [使用 verdaccio 搭建 npm 私有仓储](https://blog.sigoden.com/verdaccio--private-npm-registry/) +- [Verdaccio：一个轻量级的私有 npm 代理注册表（sinopia fork)](https://www.ctolib.com/verdaccio-verdaccio.html) +- [npm 私服工具 verdaccio 安装配置试用](http://www.cnblogs.com/rongfengliang/p/7811838.html) +- [搭建私有 npm 镜像](http://www.blackcater.win/2018/03/01/%E6%90%AD%E5%BB%BA%E7%A7%81%E6%9C%89npm%E9%95%9C%E5%83%8F/) +- [搭建离线 npm 私库——verdaccio](https://www.jishux.com/plus/view-765581-1.html) +- [[筆記] 建立自己的 npm, 以 npm Orgs 跟 Verdaccio 為例](https://medium.com/@ceall8650/%E7%AD%86%E8%A8%98-%E5%BB%BA%E7%AB%8B%E8%87%AA%E5%B7%B1%E7%9A%84-npm-%E4%BB%A5npm-orgs%E8%B7%9Fverdaccio%E7%82%BA%E4%BE%8B-cfb83b2307e6) ### French {#french} -* [Installer un registre NPM](https://allons-y.io/wiki/installer-un-registre-npm) -* [Verdaccio - Un registre de paquets npm](https://blog.yoannfleury.dev/verdaccio-un-registre-de-paquets-npm/) - +- [Installer un registre NPM](https://allons-y.io/wiki/installer-un-registre-npm) +- [Verdaccio - Un registre de paquets npm](https://blog.yoannfleury.dev/verdaccio-un-registre-de-paquets-npm/) ### Spanish {#spanish} -* [NPM privado: instalar y configurar Verdaccio](https://www.todojs.com/npm-privado-con-verdaccio/) -* [NPM privado: 5 razones y 7 recomendaciones para utilizarlo](https://www.todojs.com/npm-privado-5-razones-y-7-recomendaciones/) +- [NPM privado: instalar y configurar Verdaccio](https://www.todojs.com/npm-privado-con-verdaccio/) +- [NPM privado: 5 razones y 7 recomendaciones para utilizarlo](https://www.todojs.com/npm-privado-5-razones-y-7-recomendaciones/) ### Portuguese-BR {#portuguese-BR} -* [Problemas com pacotes do npm? Verdaccio pode ser a solução](https://dev.to/dxwebster/pt-br-problemas-com-pacotes-do-npm-verdaccio-pode-ser-a-solucao-2966) - +- [Problemas com pacotes do npm? Verdaccio pode ser a solução](https://dev.to/dxwebster/pt-br-problemas-com-pacotes-do-npm-verdaccio-pode-ser-a-solucao-2966) ### German {#german} -* [Struktur für große Angular-Anwendungen: Microservices, Module, MonoRepo?](https://jaxenter.de/struktur-angular-anwendungen-67467) -* [Angular in einer Microservices-Welt](https://jaxenter.de/angular-microservices-66445) -* [Privates NPM Repository mit Verdaccio (SSL & Docker)](https://blog.zotorn.de/privates-npm-repository-mit-verdaccio-ssl-docker-1/) +- [Struktur für große Angular-Anwendungen: Microservices, Module, MonoRepo?](https://jaxenter.de/struktur-angular-anwendungen-67467) +- [Angular in einer Microservices-Welt](https://jaxenter.de/angular-microservices-66445) +- [Privates NPM Repository mit Verdaccio (SSL & Docker)](https://blog.zotorn.de/privates-npm-repository-mit-verdaccio-ssl-docker-1/) ## Slides {#slides} -* [Introduction to Verdaccio VueJS Meetup 2018](https://www.slideshare.net/juancarlospicado/introduction-to-verdaccio) -* [Introduction Verdaccio Vienna JS Meetup 2019](https://docs.google.com/presentation/d/1eam_OtXCQh5IVYyia2GHhxVD8tb37B0yIadVa8wxQSk/edit?usp=sharing) -* [Cover Your Apps While Still Using npm](https://www.slideshare.net/TierneyCoren/cover-your-apps-while-still-using-npm) -* [Unity 2018-2019を見据えたDeNAのUnity開発のこれから [DeNA TechCon 2019]](https://www.slideshare.net/dena_tech/unity-20182019denaunity-dena-techcon-2019) +- [Introduction to Verdaccio VueJS Meetup 2018](https://www.slideshare.net/juancarlospicado/introduction-to-verdaccio) +- [Introduction Verdaccio Vienna JS Meetup 2019](https://docs.google.com/presentation/d/1eam_OtXCQh5IVYyia2GHhxVD8tb37B0yIadVa8wxQSk/edit?usp=sharing) +- [Cover Your Apps While Still Using npm](https://www.slideshare.net/TierneyCoren/cover-your-apps-while-still-using-npm) +- [Unity 2018-2019 を見据えた DeNA の Unity 開発のこれから [DeNA TechCon 2019]](https://www.slideshare.net/dena_tech/unity-20182019denaunity-dena-techcon-2019) diff --git a/website/docs/auth.md b/website/docs/auth.md index 3d6e59bc9..0147ed583 100644 --- a/website/docs/auth.md +++ b/website/docs/auth.md @@ -1,6 +1,6 @@ --- id: authentication -title: "Authentication" +title: 'Authentication' --- The authentication is tied to the auth [plugin](plugins.md) you are using. The package restrictions are also handled by the [Package Access](packages.md). @@ -27,10 +27,10 @@ registry=http://localhost:5555/ Eg: ```yaml - 'my-company-*': - access: $anonymous - publish: $anonymous - proxy: npmjs +'my-company-*': + access: $anonymous + publish: $anonymous + proxy: npmjs ``` As is described [on issue #212](https://github.com/verdaccio/verdaccio/issues/212#issuecomment-308578500) until `npm@5.3.0` and all minor releases **won't allow you publish without a token**. @@ -39,11 +39,11 @@ As is described [on issue #212](https://github.com/verdaccio/verdaccio/issues/21 ### The meaning of `$all` and `$anonymous` {#the-meaning-of-all-and-anonymous} -As you know *Verdaccio* uses `htpasswd` by default. That plugin does not implement the methods `allow_access`, `allow_publish` and `allow_unpublish`. -Thus, *Verdaccio* will handle that in the following way: +As you know _Verdaccio_ uses `htpasswd` by default. That plugin does not implement the methods `allow_access`, `allow_publish` and `allow_unpublish`. +Thus, _Verdaccio_ will handle that in the following way: -* If you are not logged in (you are anonymous), `$all` and `$anonymous` means exactly the same. -* If you are logged in, `$anonymous` won't be part of your groups and `$all` will match any logged user. A new group `$authenticated` will be added to your group list. +- If you are not logged in (you are anonymous), `$all` and `$anonymous` means exactly the same. +- If you are logged in, `$anonymous` won't be part of your groups and `$all` will match any logged user. A new group `$authenticated` will be added to your group list. Please note: `$all` **will match all users, whether logged in or not**. @@ -52,8 +52,8 @@ Please note: `$all` **will match all users, whether logged in or not**. Let's recap: -* **logged in**: `$all` and `$authenticated` + groups added by the plugin. -* **logged out (anonymous)**: `$all` and `$anonymous`. +- **logged in**: `$all` and `$authenticated` + groups added by the plugin. +- **logged out (anonymous)**: `$all` and `$anonymous`. ## Default htpasswd {#default-htpasswd} @@ -70,17 +70,17 @@ auth: # Hash algorithm, possible options are: "bcrypt", "md5", "sha1", "crypt". algorithm: bcrypt # by default is crypt, but is recommended use bcrypt for new installations # Rounds number for "bcrypt", will be ignored for other algorithms. - rounds: 10 + rounds: 10 ``` > The default algorithm is `crypt`, considered not secure for production environments, it's recommended for new installations use `bcrypt` instead. Note after verdaccio 6.x -the default will be `bcrypt`. +> the default will be `bcrypt`. -Property | Type | Required | Example | Support | Description ---- | --- | --- | --- | --- | --- -file | string | Yes | ./htpasswd | all | file that host the encrypted credentials -max_users | number | No | 1000 | all | set limit of users -algorithm | string | No | bcrypt/md5/sha1/crypt | >=5.13.0 | set hasing password algorithm -rounds | number | No | 10 | >=5.13.0 | Rounds number for "bcrypt", will be ignored for other algorithms +| Property | Type | Required | Example | Support | Description | +| --------- | ------ | -------- | --------------------- | -------- | ---------------------------------------------------------------- | +| file | string | Yes | ./htpasswd | all | file that host the encrypted credentials | +| max_users | number | No | 1000 | all | set limit of users | +| algorithm | string | No | bcrypt/md5/sha1/crypt | >=5.13.0 | set hasing password algorithm | +| rounds | number | No | 10 | >=5.13.0 | Rounds number for "bcrypt", will be ignored for other algorithms | > In case you decide to prevent users from signing up themselves, you can set `max_users: -1`. diff --git a/website/docs/best-practices.md b/website/docs/best-practices.md index a60068359..a97de86ea 100644 --- a/website/docs/best-practices.md +++ b/website/docs/best-practices.md @@ -1,6 +1,6 @@ --- id: best -title: "Best Practices" +title: 'Best Practices' --- The following guide is a list of the best practices collected and that we usually recommend to all users. Do not take this guide as @@ -52,7 +52,7 @@ There's two options here: ```yaml packages: - "@my-company/*": + '@my-company/*': access: $all publish: $authenticated # comment it out or leave it empty @@ -84,7 +84,7 @@ Additional reading: - **[Avoiding npm substitution attacks](https://github.blog/2021-02-12-avoiding-npm-substitution-attacks/)** - **[Dependency Confusion: When Are Your npm Packages Vulnerable?](https://blog.includesecurity.com/2021/02/dependency-confusion-when-are-your-npm-packages-vulnerable/)** - **[Practical Mitigations For Dependency Confusion Attack](https://www.kernelcrypt.com/posts/depedency-confusion-explained/)** -> Feel free to attach here new useful articles to improve the security. + > Feel free to attach here new useful articles to improve the security. ### Strong package access with `$authenticated` {#strong-package-access-with-authenticated} @@ -92,13 +92,13 @@ By default all packages you publish in Verdaccio are accessible for all users. W ```yaml packages: - "@my-company/*": + '@my-company/*': access: $authenticated publish: $authenticated - "@*/*": + '@*/*': access: $authenticated publish: $authenticated - "**": + '**': access: $authenticated publish: $authenticated ``` @@ -111,11 +111,11 @@ After a clean installation, by default all packages will be resolved to the defa ```yaml packages: - "@*/*": + '@*/*': access: $authenticated publish: $authenticated proxy: npmjs - "**": + '**': access: $authenticated publish: $authenticated proxy: npmjs @@ -125,15 +125,15 @@ This means that even if a private package like `@my-company/auth` is published l ```yaml packages: - "@my-company/*": + '@my-company/*': access: $authenticated publish: $authenticated unpublish: $authenticated - "@*/*": + '@*/*': access: $authenticated publish: $authenticated proxy: npmjs - "**": + '**': access: $authenticated publish: $authenticated proxy: npmjs @@ -180,7 +180,6 @@ Since version `v5.4.0` critical endpoints have enabled by default rate limit. Th The previous list of endpoints are limited to `100` request peer _15 minutes_ which is enough for a basic usage, if you need to increase this levels please check the `userRateLimit` configuration options. - ```yaml userRateLimit: windowMs: 50000 <- (minutes * 60 * 1000) diff --git a/website/docs/caching.md b/website/docs/caching.md index f5aed84a5..0d7e18c6d 100644 --- a/website/docs/caching.md +++ b/website/docs/caching.md @@ -1,6 +1,6 @@ --- id: caching -title: "Caching strategies" +title: 'Caching strategies' --- Verdaccio caches all packages by default into the `/storage` folder. But you can decide whether you want to follow @@ -8,15 +8,14 @@ a different strategy. Using of plugins you might use the cloud or any sort of da ## Caching scenarios {#caching-scenarios} -* Build a Node.js project on **Continuous Integration** (Bamboo, GitLab, Jenkins, etc) servers is a task that might take several times at a day, thus, the server will download tons of tarballs from the registry every time takes place. As usual, the CI tools clear the cache after each build and the process start over and over again. That is a waste of bandwidth and reduces the external traffic. -**You can use Verdaccio for caching tarballs and metadata in our internal network and give a boost in your build time.** -* **Latency and Connectivity**, not all countries enjoy a high-speed connection. For such reason cache packages locally in your network -is really handy. Either if you are traveling, or have a weak connection, roaming or countries with strong Firewalls that might affect the user experience (eg: corrupting tarballs). -* **Offline Mode**, all Node Package Managers nowadays uses their own internal cache, but it common that different projects might use -different tools, which implies lock files and so on. Those tools are unable to share cache, the unique solution is centralized and relies on -a proxy registry, Verdaccio cache all metadata and tarballs are downloaded by demand being able to share them across all your project. -* Avoid that any remote registry suddenly returns *HTTP 404* error for tarballs were previously available a.k.a ([left-pad issue](https://www.theregister.co.uk/2016/03/23/npm_left_pad_chaos/)). - +- Build a Node.js project on **Continuous Integration** (Bamboo, GitLab, Jenkins, etc) servers is a task that might take several times at a day, thus, the server will download tons of tarballs from the registry every time takes place. As usual, the CI tools clear the cache after each build and the process start over and over again. That is a waste of bandwidth and reduces the external traffic. + **You can use Verdaccio for caching tarballs and metadata in our internal network and give a boost in your build time.** +- **Latency and Connectivity**, not all countries enjoy a high-speed connection. For such reason cache packages locally in your network + is really handy. Either if you are traveling, or have a weak connection, roaming or countries with strong Firewalls that might affect the user experience (eg: corrupting tarballs). +- **Offline Mode**, all Node Package Managers nowadays uses their own internal cache, but it common that different projects might use + different tools, which implies lock files and so on. Those tools are unable to share cache, the unique solution is centralized and relies on + a proxy registry, Verdaccio cache all metadata and tarballs are downloaded by demand being able to share them across all your project. +- Avoid that any remote registry suddenly returns _HTTP 404_ error for tarballs were previously available a.k.a ([left-pad issue](https://www.theregister.co.uk/2016/03/23/npm_left_pad_chaos/)). # Strategies for faster builds @@ -36,7 +35,7 @@ uplinks: ## Extending Cache Expiration Time {#extending-cache-expiration-time} - Verdaccio by default waits 2 minutes to invalidate the cache metadata before fetching new information from the remote registry. +Verdaccio by default waits 2 minutes to invalidate the cache metadata before fetching new information from the remote registry. ```yaml uplinks: @@ -48,7 +47,6 @@ uplinks: Increasing the value of `maxage` in each `uplink` remotes will be asked less frequently. This might be a valid strategy if you don't update dependencies so often. - ## Using the memory instead the hardrive {#using-the-memory-instead-the-hardrive} Sometimes caching packages is not a critical step, rather than route packages from different registries and achieving diff --git a/website/docs/chef.md b/website/docs/chef.md index 6fc4da972..7a8aa3ad2 100644 --- a/website/docs/chef.md +++ b/website/docs/chef.md @@ -1,17 +1,15 @@ --- id: chef -title: "Chef Cookbook" +title: 'Chef Cookbook' --- Using Chef Cookbook for Verdaccio For further information: -* [https://github.com/verdaccio/verdaccio-cookbook](https://github.com/verdaccio/verdaccio-cookbook) -* [https://supermarket.chef.io/cookbooks/verdaccio](https://supermarket.chef.io/cookbooks/verdaccio) +- [https://github.com/verdaccio/verdaccio-cookbook](https://github.com/verdaccio/verdaccio-cookbook) +- [https://supermarket.chef.io/cookbooks/verdaccio](https://supermarket.chef.io/cookbooks/verdaccio) > We are looking for contributors for this repository, if you are interested please notify the author via tickets. Author: [Keli Grubb](https://github.com/kgrubb) && Barthelemy Vessemont. - - diff --git a/website/docs/ci.md b/website/docs/ci.md index 4b5770354..9fc362c82 100644 --- a/website/docs/ci.md +++ b/website/docs/ci.md @@ -1,6 +1,6 @@ --- id: ci -title: "Continuous Integration" +title: 'Continuous Integration' --- Verdaccio can be used with continuous integration (CI) platforms to install or publish packages. diff --git a/website/docs/cli-registry.md b/website/docs/cli-registry.md index 44c1fa640..40515582f 100644 --- a/website/docs/cli-registry.md +++ b/website/docs/cli-registry.md @@ -1,10 +1,10 @@ --- id: cli-registry -title: "Using a private registry" +title: 'Using a private registry' --- Setting up a private registry is quite easy on all major Package managers and can be achieved in a few different ways depenging on your goals. The following links details how you can achieve this goal for each major package manager. -* [npm](setup-npm.md) -* [yarn](setup-yarn.md) -* [pnpm](setup-pnpm.md) +- [npm](setup-npm.md) +- [yarn](setup-yarn.md) +- [pnpm](setup-pnpm.md) diff --git a/website/docs/cli.md b/website/docs/cli.md index 4cd1e6fad..4b741d69e 100644 --- a/website/docs/cli.md +++ b/website/docs/cli.md @@ -1,6 +1,6 @@ --- id: cli -title: "Command Line Tool" +title: 'Command Line Tool' --- The Verdaccio CLI is your tool to start and stop the application. @@ -11,12 +11,12 @@ The Verdaccio CLI is your tool to start and stop the application. verdaccio --listen 4000 --config ~./config.yaml ``` -Command | Default | Example | Description ---- | --- | --- | --- ---listen \ **-l** | http:localhost:4873 | 7000 | Define protocol + host + port ([formats](https://github.com/verdaccio/verdaccio/blob/08c36e688e8635733f92080eb3598239d43259cb/packages/node-api/src/cli-utils.ts#L7-L16)) ---config \ **-c** | ~/.local/verdaccio/config.yaml | ~./config.yaml | Set location of the configuration file ---info \ **-i** | | | Print local environment information ---version \ **-v** | | | Show version information +| Command | Default | Example | Description | +| ------------------ | ------------------------------ | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| --listen \ **-l** | http:localhost:4873 | 7000 | Define protocol + host + port ([formats](https://github.com/verdaccio/verdaccio/blob/08c36e688e8635733f92080eb3598239d43259cb/packages/node-api/src/cli-utils.ts#L7-L16)) | +| --config \ **-c** | ~/.local/verdaccio/config.yaml | ~./config.yaml | Set location of the configuration file | +| --info \ **-i** | | | Print local environment information | +| --version \ **-v** | | | Show version information | ## Default config file location {#default-config-file-location} @@ -37,9 +37,8 @@ The default database file location is in the storage location. Starting with version 4.0.0, the database file name will be **.verdaccio-db.json** for a new installation of Verdaccio. When upgrading an existing Verdaccio server, the file name will remain **.sinopia-db.json**. - ## Environment variables {#environment-variables} [Full list of environment variables](https://github.com/verdaccio/verdaccio/blob/master/docs/env.variables.md). -* `VERDACCIO_HANDLE_KILL_SIGNALS` to enable gracefully shutdown (since v4.12.0) +- `VERDACCIO_HANDLE_KILL_SIGNALS` to enable gracefully shutdown (since v4.12.0) diff --git a/website/docs/config.md b/website/docs/config.md index bd33bda2f..2dae299ca 100644 --- a/website/docs/config.md +++ b/website/docs/config.md @@ -1,6 +1,6 @@ --- id: configuration -title: "Configuration File" +title: 'Configuration File' --- This file is the cornerstone of Verdaccio where you can modify the default behaviour, enable plugins and extend features. @@ -20,11 +20,11 @@ uplinks: npmjs: url: https://registry.npmjs.org/ packages: - "@*/*": + '@*/*': access: $all publish: $authenticated proxy: npmjs - "**": + '**': proxy: npmjs log: { type: stdout, format: pretty, level: http } ``` @@ -129,7 +129,7 @@ This section allows you to control how packages are accessed. For more informati ```yaml packages: - "@*/*": + '@*/*': access: $all publish: $authenticated proxy: npmjs @@ -271,7 +271,7 @@ Enabling notifications to third-party tools is fairly easy via webhooks. For mor ```yaml notify: method: POST - headers: [{ "Content-Type": "application/json" }] + headers: [{ 'Content-Type': 'application/json' }] endpoint: https://usagge.hipchat.com/v2/room/3729485/notification?auth_token=mySecretToken content: '{"color":"green","message":"New package published: * {{ name }}*","notify":true,"message_format":"text"}' ``` diff --git a/website/docs/dev-plugins.md b/website/docs/dev-plugins.md index 1fcbf4b6a..1b288cbba 100644 --- a/website/docs/dev-plugins.md +++ b/website/docs/dev-plugins.md @@ -1,15 +1,15 @@ --- id: dev-plugins -title: "Developing Plugins" +title: 'Developing Plugins' --- There are many ways to extend `verdaccio`, the kind of plugins supported are: -* [Authentication](plugin-auth.md) -* [Middleware](plugin-middleware.md) -* [Storage](plugin-storage.md) -* Theme -* Filter plugins +- [Authentication](plugin-auth.md) +- [Middleware](plugin-middleware.md) +- [Storage](plugin-storage.md) +- Theme +- Filter plugins > We recommend developing plugins using our [TypeScript type definitions](https://github.com/verdaccio/monorepo/tree/9.x/core/types). @@ -17,7 +17,6 @@ There are many ways to extend `verdaccio`, the kind of plugins supported are: The following plugins are valid and in process of incubation. - ## Theme Plugin {#theme-plugin} The plugin must return a function that returns a **string**. The string should be the absolute location of the root of your user interface. @@ -36,27 +35,23 @@ It is imporant that the name of the plugin **must start with `verdaccio-theme-` ### Theme Example {#theme-example} -* [@verdaccio/ui-theme](https://github.com/verdaccio/ui): The default Verdaccio theme based in React.js. +- [@verdaccio/ui-theme](https://github.com/verdaccio/ui): The default Verdaccio theme based in React.js. ## Filter Plugin {#filter-plugin} Since [`4.1.0`](https://github.com/verdaccio/verdaccio/pull/1313) - Filter plugins were introduced due a [request](https://github.com/verdaccio/verdaccio/issues/818) in order to be able to filter metadata from uplinks. More [info in the PR](https://github.com/verdaccio/verdaccio/pull/1161). - - ```yaml filters: - storage-filter-blackwhitelist: - filter_file: /path/to/file + storage-filter-blackwhitelist: + filter_file: /path/to/file ``` - ### API {#api-1} The method `filter_metadata` will allow you to filter metadata that comes from any uplink, it is `Promise` based diff --git a/website/docs/docker.md b/website/docs/docker.md index 6ab54b61b..3d7b9044f 100644 --- a/website/docs/docker.md +++ b/website/docs/docker.md @@ -15,7 +15,7 @@ docker pull verdaccio/verdaccio ## Tagged Versions {#tagged-versions} -![alt Docker Pulls Count](https://dockeri.co/image/verdaccio/verdaccio "Docker Pulls Count") +![alt Docker Pulls Count](https://dockeri.co/image/verdaccio/verdaccio 'Docker Pulls Count') Since version `v2.x` you can pull docker images by [tag](https://hub.docker.com/r/verdaccio/verdaccio/tags/), as follows: @@ -24,6 +24,7 @@ For a major version: ```bash docker pull verdaccio/verdaccio:4 ``` + For a minor version: ```bash @@ -51,7 +52,6 @@ The above line will pull the latest prebuilt image from dockerhub, if you haven' If you have [build an image locally](#build-your-own-docker-image) use `verdaccio` as the last argument. - You can use `-v` to bind mount `conf`, `storage` and `plugins` to the hosts filesystem (example below). Note that if you do mount conf like this, that you will first need to supply a copy of config.yaml in that directory; the Docker container will not start properly if this file is missing. You can copy this file initially from https://github.com/verdaccio/verdaccio/blob/5.x/conf/docker.yaml. However, note the security warnings in that file; you will definitely want to lock it down in production. @@ -64,24 +64,23 @@ V_PATH=/path/for/verdaccio; docker run -it --rm --name verdaccio \ -v $V_PATH/plugins:/verdaccio/plugins \ verdaccio/verdaccio ``` + > if you are running in a server, you might want to add -d to run it in the background ->Note: Verdaccio runs as a non-root user (uid=10001) inside the container, if you use bind mount to override default, -you need to make sure the mount directory is assigned to the right user. In above example, you need to run `sudo chown -R 10001:65533 /path/for/verdaccio` otherwise -you will get permission errors at runtime. -[Use docker volume](https://docs.docker.com/storage/volumes/) is recommended over using bind mount. +> Note: Verdaccio runs as a non-root user (uid=10001) inside the container, if you use bind mount to override default, +> you need to make sure the mount directory is assigned to the right user. In above example, you need to run `sudo chown -R 10001:65533 /path/for/verdaccio` otherwise +> you will get permission errors at runtime. +> [Use docker volume](https://docs.docker.com/storage/volumes/) is recommended over using bind mount. Verdaccio 4 provides a new set of environment variables to modify either permissions, port or http protocol. Here the complete list: -Property | default | Description ---- | --- | --- -VERDACCIO_APPDIR | `/opt/verdaccio` | the docker working directory -VERDACCIO_USER_NAME | `verdaccio` | the system user -VERDACCIO_USER_UID | `10001` | the user id being used to apply folder permissions -VERDACCIO_PORT | `4873` | the verdaccio port -VERDACCIO_PROTOCOL | `http` | the default http protocol - - +| Property | default | Description | +| ------------------- | ---------------- | -------------------------------------------------- | +| VERDACCIO_APPDIR | `/opt/verdaccio` | the docker working directory | +| VERDACCIO_USER_NAME | `verdaccio` | the system user | +| VERDACCIO_USER_UID | `10001` | the user id being used to apply folder permissions | +| VERDACCIO_PORT | `4873` | the verdaccio port | +| VERDACCIO_PROTOCOL | `http` | the default http protocol | ### SELinux {#selinux} @@ -117,7 +116,7 @@ RUN mkdir -p /verdaccio/plugins \ && cd /verdaccio/plugins \ && npm install --global-style --no-bin-links --omit=optional verdaccio-auth-memory@latest FROM verdaccio/verdaccio:5 -ADD docker.yaml /verdaccio/conf/config.yaml +ADD docker.yaml /verdaccio/conf/config.yaml COPY --chown=$VERDACCIO_USER_UID:root --from=builder \ /verdaccio/plugins/node_modules/verdaccio-auth-memory \ /verdaccio/plugins/verdaccio-auth-memory @@ -125,7 +124,6 @@ COPY --chown=$VERDACCIO_USER_UID:root --from=builder \ For more information check real plugin examples with Docker in our [source code](https://github.com/verdaccio/verdaccio/tree/master/docker-examples/v5/plugins). - ### Docker and custom port configuration {#docker-and-custom-port-configuration} Any `host:port` configured in `conf/config.yaml` under `listen` **is currently ignored when using docker**. @@ -135,7 +133,7 @@ in your `docker run` command add the environment variable `VERDACCIO_PORT=5000` ```bash V_PATH=/path/for/verdaccio; docker run -it --rm --name verdaccio \ - -e "VERDACCIO_PORT=8080" -p 8080:8080 \ + -e "VERDACCIO_PORT=8080" -p 8080:8080 \ verdaccio/verdaccio ``` @@ -163,24 +161,23 @@ $ docker-compose up --build You can set the port to use (for both container and host) by prefixing the above command with `VERDACCIO_PORT=5000 `. - ```yaml version: '3.1' services: verdaccio: image: verdaccio/verdaccio - container_name: "verdaccio" + container_name: 'verdaccio' networks: - node-network environment: - VERDACCIO_PORT=4873 ports: - - "4873:4873" + - '4873:4873' volumes: - - "./storage:/verdaccio/storage" - - "./config:/verdaccio/conf" - - "./plugins:/verdaccio/plugins" + - './storage:/verdaccio/storage' + - './config:/verdaccio/conf' + - './plugins:/verdaccio/plugins' networks: node-network: driver: bridge @@ -204,7 +201,6 @@ $ docker volume inspect verdaccio_verdaccio ## Build your own Docker image {#build-your-own-docker-image} - ```bash docker build -t verdaccio . ``` @@ -226,20 +222,19 @@ There is a separate repository that hosts multiple configurations to compose Doc [https://github.com/verdaccio/docker-examples](https://github.com/verdaccio/verdaccio/tree/master/docker-examples) - ## Docker Custom Builds {#docker-custom-builds} > If you have made an image based on Verdaccio, feel free to add it to this list. -* [docker-verdaccio-multiarch](https://github.com/hertzg/docker-verdaccio-multiarch) Multiarch image mirrors -* [docker-verdaccio-gitlab](https://github.com/snics/docker-verdaccio-gitlab) -* [docker-verdaccio](https://github.com/deployable/docker-verdaccio) -* [docker-verdaccio-s3](https://github.com/asynchrony/docker-verdaccio-s3) Private NPM container that can backup to s3 -* [docker-verdaccio-ldap](https://github.com/snadn/docker-verdaccio-ldap) -* [verdaccio-ldap](https://github.com/nathantreid/verdaccio-ldap) -* [verdaccio-compose-local-bridge](https://github.com/shingtoli/verdaccio-compose-local-bridge) -* [docker-verdaccio](https://github.com/Global-Solutions/docker-verdaccio) -* [verdaccio-docker](https://github.com/idahobean/verdaccio-docker) -* [verdaccio-server](https://github.com/andru255/verdaccio-server) -* [coldrye-debian-verdaccio](https://github.com/coldrye-docker/coldrye-debian-verdaccio) docker image providing verdaccio from coldrye-debian-nodejs. -* [verdaccio-github-oauth-ui](https://github.com/n4bb12/verdaccio-github-oauth-ui/blob/master/Dockerfile) +- [docker-verdaccio-multiarch](https://github.com/hertzg/docker-verdaccio-multiarch) Multiarch image mirrors +- [docker-verdaccio-gitlab](https://github.com/snics/docker-verdaccio-gitlab) +- [docker-verdaccio](https://github.com/deployable/docker-verdaccio) +- [docker-verdaccio-s3](https://github.com/asynchrony/docker-verdaccio-s3) Private NPM container that can backup to s3 +- [docker-verdaccio-ldap](https://github.com/snadn/docker-verdaccio-ldap) +- [verdaccio-ldap](https://github.com/nathantreid/verdaccio-ldap) +- [verdaccio-compose-local-bridge](https://github.com/shingtoli/verdaccio-compose-local-bridge) +- [docker-verdaccio](https://github.com/Global-Solutions/docker-verdaccio) +- [verdaccio-docker](https://github.com/idahobean/verdaccio-docker) +- [verdaccio-server](https://github.com/andru255/verdaccio-server) +- [coldrye-debian-verdaccio](https://github.com/coldrye-docker/coldrye-debian-verdaccio) docker image providing verdaccio from coldrye-debian-nodejs. +- [verdaccio-github-oauth-ui](https://github.com/n4bb12/verdaccio-github-oauth-ui/blob/master/Dockerfile) diff --git a/website/docs/e2e.md b/website/docs/e2e.md index 0e57fc5d9..73d09b492 100644 --- a/website/docs/e2e.md +++ b/website/docs/e2e.md @@ -1,12 +1,11 @@ --- id: e2e -title: "End to End testing" +title: 'End to End testing' --- ### Testing the integrity of React components by publishing in a private registry -> The final stage of a react component is when it is being published and distributed. How can I ensure my packages won’t crash in production? This talk will help you to test your React components by publishing them to a private registry and running End-to-End tests against them. - +> The final stage of a react component is when it is being published and distributed. How can I ensure my packages won’t crash in production? This talk will help you to test your React components by publishing them to a private registry and running End-to-End tests against them. @@ -19,9 +18,9 @@ Some projects organize packages in multi-packages repositories or [monorepos](ht Such approach has been really hard to achieve considering: -* Populate canary packages on public services seems not to be a good idea -* Some self-hosted OSS registries are too heavy -* Offline environments (private networks) +- Populate canary packages on public services seems not to be a good idea +- Some self-hosted OSS registries are too heavy +- Offline environments (private networks) **Verdaccio** is a lightweight registry with zero-configuration that **fits perfectly in any E2E + CI workflow**. @@ -30,22 +29,21 @@ Such approach has been really hard to achieve considering: There is no a silver bullet yet, each implementation seems to be specific for each project, you can check some of them in the following thread [clicking here](https://stackoverflow.com/a/50222427/308341). - ## Examples in Open Source The following projects have examples using Verdaccio in Open Source ### Bash Examples -* [Babel.js](https://github.com/babel/babel) *(+35k ⭐️)* -* [Docusaurus](https://github.com/facebook/docusaurus) *(+31k ⭐️)* -* [create-react-app](https://github.com/facebook/create-react-app/blob/master/CONTRIBUTING.md#contributing-to-e2e-end-to-end-tests) *(+73.5k ⭐️)* -* [Uppy](https://github.com/transloadit/uppy) *(+21k ⭐️)* -* [ethereum/web3.js](https://github.com/ethereum/web3.js) *(+8k ⭐️)* -* [adobe react-spectrum](https://github.com/adobe/react-spectrum/pull/2432) *(+6k ⭐️)* -* [Mozilla Neutrino](https://github.com/neutrinojs/neutrino) *(+3k ⭐️)* +- [Babel.js](https://github.com/babel/babel) _(+35k ⭐️)_ +- [Docusaurus](https://github.com/facebook/docusaurus) _(+31k ⭐️)_ +- [create-react-app](https://github.com/facebook/create-react-app/blob/master/CONTRIBUTING.md#contributing-to-e2e-end-to-end-tests) _(+73.5k ⭐️)_ +- [Uppy](https://github.com/transloadit/uppy) _(+21k ⭐️)_ +- [ethereum/web3.js](https://github.com/ethereum/web3.js) _(+8k ⭐️)_ +- [adobe react-spectrum](https://github.com/adobe/react-spectrum/pull/2432) _(+6k ⭐️)_ +- [Mozilla Neutrino](https://github.com/neutrinojs/neutrino) _(+3k ⭐️)_ -This is the most simple example using Verdaccio in a bash script (extracted from *create-react-app*). +This is the most simple example using Verdaccio in a bash script (extracted from _create-react-app_). ```bash #!/bin/sh @@ -69,35 +67,32 @@ sh -c "npm --registry $local_registry publish" ### Docker Examples -* [Hyperledger](https://github.com/hyperledger/fabric-chaincode-node) +- [Hyperledger](https://github.com/hyperledger/fabric-chaincode-node) ### Programtically Examples -* [Storybook](https://github.com/storybooks/storybook) *(+44k ⭐️)* -* [Gatsby](https://github.com/gatsbyjs/gatsby) *(+40k ⭐️) +- [Storybook](https://github.com/storybooks/storybook) _(+44k ⭐️)_ +- [Gatsby](https://github.com/gatsbyjs/gatsby) \*(+40k ⭐️) #### Verdaccio module Via CLI: -* [Aurelia Framework](https://github.com/aurelia) *(+12k ⭐️)* -* [Netlify CLI](https://github.com/netlify/cli) *(+1k ⭐️)* -* [Embark](https://embark.status.im/) *(+3k ⭐️)* -* [Microsoft Beachball](https://github.com/microsoft/beachball) +- [Aurelia Framework](https://github.com/aurelia) _(+12k ⭐️)_ +- [Netlify CLI](https://github.com/netlify/cli) _(+1k ⭐️)_ +- [Embark](https://embark.status.im/) _(+3k ⭐️)_ +- [Microsoft Beachball](https://github.com/microsoft/beachball) + #### Node.js `child_process` examples -* [Angular CLI](https://github.com/angular/angular-cli) *(+25k ⭐️)* -* [bit](https://github.com/teambit/bit) *(+6k ⭐️)* -* [pnpm](https://github.com/pnpm/pnpm) *(+6k ⭐️)* -* [aws-sdk cli v3](https://github.com/aws/aws-sdk-js-v3) *(+1k ⭐️)* -* [angular-eslint](https://github.com/angular-eslint/angular-eslint) *(+1k ⭐️)* +- [Angular CLI](https://github.com/angular/angular-cli) _(+25k ⭐️)_ +- [bit](https://github.com/teambit/bit) _(+6k ⭐️)_ +- [pnpm](https://github.com/pnpm/pnpm) _(+6k ⭐️)_ +- [aws-sdk cli v3](https://github.com/aws/aws-sdk-js-v3) _(+1k ⭐️)_ +- [angular-eslint](https://github.com/angular-eslint/angular-eslint) _(+1k ⭐️)_ -## Example repositories +## Example repositories - [e2e-ci-example-gh-actions](https://github.com/juanpicado/e2e-ci-example-gh-actions) - [verdaccio-end-to-end-tests](https://github.com/juanpicado/verdaccio-end-to-end-tests) - [verdaccio-fork](https://github.com/juanpicado/verdaccio-fork) - - - - diff --git a/website/docs/github-actions.md b/website/docs/github-actions.md index 5ed6ed03d..dbe48d216 100644 --- a/website/docs/github-actions.md +++ b/website/docs/github-actions.md @@ -1,6 +1,6 @@ --- id: github-actions -title: "GitHub Actions" +title: 'GitHub Actions' --- With [GitHub Actions](https://github.com/features/actions) you can automate your workflow, each GitHub Action performs a specific step in a process. diff --git a/website/docs/how-to-deploy-on-AWS.md b/website/docs/how-to-deploy-on-AWS.md index 727c9a28b..7c0d2700f 100644 --- a/website/docs/how-to-deploy-on-AWS.md +++ b/website/docs/how-to-deploy-on-AWS.md @@ -1,6 +1,6 @@ --- id: aws -title: "Amazon Web Services" +title: 'Amazon Web Services' --- This document describes simple steps to setup Verdaccio private registry on Amazon Web Services platform using EC2 service. This assumes you have already created an EC2 Amazon Linux instance; if not then please check this tutorial on [AWS EC2 Setup](https://www.howtoinmagento.com/2018/04/aws-cli-commands-for-aws-ec2-amazon.html). @@ -11,123 +11,119 @@ This document describes simple steps to setup Verdaccio private registry on Amaz **Step 2:** Install Node Version Manager (nvm) first, close and re-open the SSH using your EC2 key. - ``` sudo apt update ``` - - ``` wget -qO- https://raw.githubusercontent.com/creationix/nvm/v0.33.11/install.sh | bash ``` - - ``` exit ``` - +`sudo apt update` + +`wget -qO- https://raw.githubusercontent.com/creationix/nvm/v0.33.11/install.sh | bash` + +`exit` + **Step 3:** Install Node using Node Version Manager (nvm) - ``` nvm install node ``` +`nvm install node` **Step 4:** Install Verdaccio & pm2, will require to run Verdaccio service in background - ``` npm i -g verdaccio pm2 ``` +`npm i -g verdaccio pm2` **Step 5:** Set the verdaccio registry as a source. By default original NPM registry set. - - ``` npm set registry http://localhost:4873 ``` - - ``` npm set ca null ``` + +`npm set registry http://localhost:4873` + +`npm set ca null` **Step 6:** Run Verdaccio and stop it (ctrl+c). It will create a config file we will use. - ``` verdaccio ``` - +`verdaccio` + **Step 7:** Now do below configuration for listening to all addresses on that server machine / EC2 instance. [(read more)](https://github.com/verdaccio/verdaccio/blob/master/conf/full.yaml) Open and edit `config.yaml` file: - ``` nano .config/verdaccio/config.yaml ``` or ``` nano ~/verdaccio/config.yaml ``` +` nano .config/verdaccio/config.yaml` or ` nano ~/verdaccio/config.yaml` Add below lines at the end. [(read more)](https://github.com/verdaccio/verdaccio/blob/ff409ab7c05542a152100e3bc39cfadb36a8a080/conf/full.yaml#L113) - ``` - listen: - - 0.0.0.0:4873 +``` +listen: + - 0.0.0.0:4873 ``` Change below line so that only authenticated person can access our registry - ``` Replace "access: $all" with "access: $authenticated" ``` - - (Optional) Change below line according to how many users you wish to grant access to the scoped registry - - ``` Replace "#max_users: 1000" with "max_users: 1" ``` +`Replace "access: $all" with "access: $authenticated"` + +(Optional) Change below line according to how many users you wish to grant access to the scoped registry + +`Replace "#max_users: 1000" with "max_users: 1"` There are some more parameters available to configure it. Like storage, proxy, default port change. [(read more)](https://github.com/verdaccio/verdaccio/blob/ff409ab7c05542a152100e3bc39cfadb36a8a080/conf/full.yaml#L113) **Step 8:** Run Verdaccio in background using PM2: - ``` pm2 start verdaccio ``` +`pm2 start verdaccio` **Step 9:** Now, You can access your Verdaccio web UI. The URL will look like something: - ``` http://ec2-..compute.amazonaws.com:4873 ``` +`http://ec2-..compute.amazonaws.com:4873` {or} - ``` http://your-ec2-public-ip-address:4873 (You can check your EC2 instance public ip from AWS console) ``` +`http://your-ec2-public-ip-address:4873 (You can check your EC2 instance public ip from AWS console)` To confirm Verdaccio's running status, run the command below: - ``` pm2 list ``` - - To make Verdaccio launch on startup, run the commands below: - - ``` pm2 stop verdaccio ``` - - ``` pm2 delete verdaccio ``` - - ``` pm2 startup ``` This will show a command in your terminal. Copy / paste it and execute it to have pm2 make a startup service for you. - - ``` which verdaccio ``` Copy the path shown by this command. - - ``` pm2 start /home/ubuntu/.nvm/versions/node/v17.1.0/bin/verdaccio ``` (put the path you copied from command above). - - ``` pm2 status ``` This should show "online" on the status of verdaccio service. - - ``` pm2 save ``` Now when you reboot the EC2 instance, it should launch verdaccio. +` pm2 list` + +To make Verdaccio launch on startup, run the commands below: + +`pm2 stop verdaccio` + +`pm2 delete verdaccio` + +`pm2 startup` This will show a command in your terminal. Copy / paste it and execute it to have pm2 make a startup service for you. + +`which verdaccio` Copy the path shown by this command. + +`pm2 start /home/ubuntu/.nvm/versions/node/v17.1.0/bin/verdaccio` (put the path you copied from command above). + +`pm2 status` This should show "online" on the status of verdaccio service. + +`pm2 save` Now when you reboot the EC2 instance, it should launch verdaccio. **Step 10:** Registering a user in verdaccio registry - ``` npm set always-auth true ``` - - ``` npm adduser ``` +` npm set always-auth true` + +` npm adduser` It will ask for username, password and valid email id to be entered. Make a note of this details that will use later to login in verdaccio registry to publish our library. - **Step 11:** Now we are ready to use our AWS server instance work as a private registry. Login into verdaccio registry. Enter the same username, password and email id set in above Step. - ``` npm set registry http://your-ec2-public-ip-address:4873 ``` - - ``` npm login ``` +` npm set registry http://your-ec2-public-ip-address:4873` + +` npm login` **Step 12:** Go to your custom library package path. In my case this is my Angular 7 package path -> `/libraries/dist/your-library-name/your-library-name-0.0.1.tgz` If you like to know how to create angular 7 library/package then [(click here)](https://www.howtoinmagento.com/2019/11/how-to-create-your-first-angular-7.html) - ``` cd [custom library package path] ``` +` cd [custom library package path]` **Step 13:** Finally publish our library `your-library-name-0.0.1.tgz` on verdaccio registry - ``` [custom library package path] >> npm publish your-library-name-0.0.1.tgz ``` +` [custom library package path] >> npm publish your-library-name-0.0.1.tgz` {or} - ``` [custom library package path] >> npm publish ``` +` [custom library package path] >> npm publish` {or} - ``` [custom library package path] >> npm publish --registry http://your-ec2-public-ip-address:4873 ``` - -Now browse ``` http://your-ec2-public-ip-address:4873 ``` and you will see new library package there. - - +` [custom library package path] >> npm publish --registry http://your-ec2-public-ip-address:4873` +Now browse ` http://your-ec2-public-ip-address:4873` and you will see new library package there. diff --git a/website/docs/iis-server.md b/website/docs/iis-server.md index 25e142f91..50d22fb21 100644 --- a/website/docs/iis-server.md +++ b/website/docs/iis-server.md @@ -1,34 +1,34 @@ --- id: iss-server -title: "Installing on IIS server" +title: 'Installing on IIS server' --- These instructions were written for Windows Server 2016, IIS 10, [Node.js 10.15.0](https://nodejs.org/), [iisnode 0.2.26](https://github.com/Azure/iisnode) and [verdaccio 3.11.0](https://github.com/verdaccio/verdaccio). -* Install IIS Install [iisnode](https://github.com/Azure/iisnode). -Make sure you install prerequisites (Url Rewrite Module & node) as explained in the instructions for iisnode. -* Create a new folder in Explorer where you want to host verdaccio. -For example `C:\verdaccio`. -Save [package.json](#packagejson), -[start.js](#startjs) -and [web.config](#webconfig) in this folder. -* Create a new site in Internet Information Services Manager. You can name it whatever you want. -I'll call it verdaccio in these [instructions](http://www.iis.net/learn/manage/configuring-security/application-pool-identities). Specify the path to where you saved all files and a port number. -* Go back to Explorer and give the user that runs the application pool modify rights to the folder you just created. If you've named the new site verdaccio and did not change the app pool, it's running under an ApplicationPoolIdentity and you should give the user IIS AppPool\verdaccio modify rights see instructions if you need help. (You can restrict access later if you want so that it only has modify rights on the iisnode and verdaccio\storage) -* Start a command prompt and execute the commands below to download verdaccio: +- Install IIS Install [iisnode](https://github.com/Azure/iisnode). + Make sure you install prerequisites (Url Rewrite Module & node) as explained in the instructions for iisnode. +- Create a new folder in Explorer where you want to host verdaccio. + For example `C:\verdaccio`. + Save [package.json](#packagejson), + [start.js](#startjs) + and [web.config](#webconfig) in this folder. +- Create a new site in Internet Information Services Manager. You can name it whatever you want. + I'll call it verdaccio in these [instructions](http://www.iis.net/learn/manage/configuring-security/application-pool-identities). Specify the path to where you saved all files and a port number. +- Go back to Explorer and give the user that runs the application pool modify rights to the folder you just created. If you've named the new site verdaccio and did not change the app pool, it's running under an ApplicationPoolIdentity and you should give the user IIS AppPool\verdaccio modify rights see instructions if you need help. (You can restrict access later if you want so that it only has modify rights on the iisnode and verdaccio\storage) +- Start a command prompt and execute the commands below to download verdaccio: -```` +``` cd c:\verdaccio npm install -```` +``` -* Make sure you have an inbound rule accepting TCP traffic to the port in Windows Firewall -* Thats it! Now you can navigate to the host and port that you specified +- Make sure you have an inbound rule accepting TCP traffic to the port in Windows Firewall +- Thats it! Now you can navigate to the host and port that you specified I wanted the `verdaccio` site to be the default site in IIS so I did the following: -* I stopped the "Default Web Site" and only start the site "verdaccio" site in IIS -* I set the bindings to "http", ip address "All Unassigned" on port 80, ok any warning or prompts +- I stopped the "Default Web Site" and only start the site "verdaccio" site in IIS +- I set the bindings to "http", ip address "All Unassigned" on port 80, ok any warning or prompts These instructions are based on [Host Sinopia in IIS on Windows](https://gist.github.com/HCanber/4dd8409f79991a09ac75). I had to tweak my web config as per below but you may find the original from the @@ -36,9 +36,9 @@ for mentioned link works better A default configuration file will be created `c:\verdaccio\verdaccio\config.yaml` -### package.json {#packagejson} +### package.json {#packagejson} -````json +```json { "name": "iisnode-verdaccio", "version": "1.0.0", @@ -48,25 +48,25 @@ A default configuration file will be created `c:\verdaccio\verdaccio\config.yaml "verdaccio": "^3.11.0" } } -```` +``` ### start.js {#startjs} -````bash +```bash process.argv.push('-l', 'unix:' + process.env.PORT, '-c', './config.yaml'); require('./node_modules/verdaccio/build/lib/cli.js'); -```` +``` ### Alternate start.js for Verdaccio versions < v3.0 {#alternate-startjs-for-verdaccio-versions--v30} -````bash +```bash process.argv.push('-l', 'unix:' + process.env.PORT); require('./node_modules/verdaccio/src/lib/cli.js'); -```` +``` ### web.config {#webconfig} -````xml +```xml @@ -113,16 +113,17 @@ require('./node_modules/verdaccio/src/lib/cli.js'); -```` +``` ### Troubleshooting {#troubleshooting} + - **The web interface does not load when hosted with https as it tries to download scripts over http.** -Make sure that you have enabled `X-Forwarded-Proto` in IISNode using `enableXFF`. See [the related issue](https://github.com/verdaccio/verdaccio/issues/2003). -```` + Make sure that you have enabled `X-Forwarded-Proto` in IISNode using `enableXFF`. See [the related issue](https://github.com/verdaccio/verdaccio/issues/2003). + +``` -```` - +``` diff --git a/website/docs/install.md b/website/docs/install.md index fc0ce586a..2f97faa0e 100644 --- a/website/docs/install.md +++ b/website/docs/install.md @@ -1,6 +1,6 @@ --- id: installation -title: "Installation" +title: 'Installation' --- Verdaccio is a Node.js private and proxy registry. To install it, you need a few basic prerequisites. @@ -35,7 +35,7 @@ Using `npm` npm install --location=global verdaccio@6-next ``` -or using `yarn@1.x` _classic_, +or using `yarn@1.x` _classic_, ```bash yarn global add verdaccio diff --git a/website/docs/kubernetes.md b/website/docs/kubernetes.md index 1e3fa5910..c77b48644 100644 --- a/website/docs/kubernetes.md +++ b/website/docs/kubernetes.md @@ -1,9 +1,9 @@ --- id: kubernetes -title: "Kubernetes" +title: 'Kubernetes' --- - You can find instructions to deploy Verdaccio on a Kubernetes cluster on the +You can find instructions to deploy Verdaccio on a Kubernetes cluster on the [verdaccio/docker-example](https://github.com/verdaccio/verdaccio/tree/5.x/docker-examples/kubernetes-example) repository. However, the recommended method to install Verdaccio on a Kubernetes cluster is to use [Helm](https://helm.sh). Helm is a @@ -61,10 +61,9 @@ helm uninstall npm **Note:** this command delete all the resources, including packages that you may have previously published to the registry. - ### Custom Verdaccio configuration {#custom-verdaccio-configuration} -You can customize the Verdaccio configuration using a Kubernetes *configMap*. +You can customize the Verdaccio configuration using a Kubernetes _configMap_. #### Prepare {#prepare} @@ -109,6 +108,7 @@ This allows you to inject sensitive values to the container via a [Kubernetes Se 1. Update your Verdaccio config according to the [Uplinks](./uplinks.md#auth-property) documentation 2. Pass the secret environment variable to your values file or via `--set secretEnvVars.FOO_TOKEN=superSecretBarToken` + ```yaml # values.yaml secretEnvVars: @@ -119,6 +119,7 @@ secretEnvVars: The standard k8s NGINX ingress proxy allows for 1MB for body-size which can be increased by modifying the default deployment options according to the [documentation](https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/annotations/#custom-max-body-size): + ```yaml ... @@ -126,7 +127,7 @@ annotations: ... kubernetes.io/proxy-body-size: 20m -.... +.... ... ``` @@ -135,4 +136,4 @@ annotations: [Rancher](http://rancher.com/) is a complete container management platform that makes managing and using containers in production really easy. -* [verdaccio-rancher](https://github.com/lgaticaq/verdaccio-rancher) +- [verdaccio-rancher](https://github.com/lgaticaq/verdaccio-rancher) diff --git a/website/docs/linking.md b/website/docs/linking.md index 230e50ace..b44a56aec 100644 --- a/website/docs/linking.md +++ b/website/docs/linking.md @@ -1,6 +1,6 @@ --- id: linking-remote-registry -title: "Linking a Remote Registry" +title: 'Linking a Remote Registry' --- Verdaccio is a proxy and by default [links](uplinks.md) the public registry. @@ -25,10 +25,10 @@ registry=https://registry.npmjs.org This approach is valid, but comes with several disadvantages: -* It **only works with scopes** -* Scope must match, **no Regular Expressions are allowed** -* One scope **cannot fetch from multiple registries** -* Tokens/passwords **must be defined within** `.npmrc` and checked in into the repo. +- It **only works with scopes** +- Scope must match, **no Regular Expressions are allowed** +- One scope **cannot fetch from multiple registries** +- Tokens/passwords **must be defined within** `.npmrc` and checked in into the repo. See a full example [here](https://stackoverflow.com/questions/54543979/npmrc-multiple-registries-for-the-same-scope/54550940#54550940). @@ -78,7 +78,6 @@ Having a full Offline Registry is completely possible. If you don't want any con can do the following. ```yaml - auth: htpasswd: file: ./htpasswd diff --git a/website/docs/logger.md b/website/docs/logger.md index babcccb70..9546f0d06 100644 --- a/website/docs/logger.md +++ b/website/docs/logger.md @@ -1,6 +1,6 @@ --- id: logger -title: "Logger" +title: 'Logger' --- As with any web application, Verdaccio has a customisable built-in logger. You can define multiple types of outputs. @@ -24,10 +24,10 @@ Note: Rotating log stream is not supported in cluster mode. [See here](https://g ### Configuration {#configuration} -| Property | Type | Required | Example | Support | Description | -| -------- | ------ | -------- | ---------------------------------------------- | ------- | ------------------------------------------------- | -| type | string | No | [stdout, file] | all | define the output | -| path | string | No | verdaccio.log | all | if type is file, define the location of that file | -| format | string | No | [pretty, pretty-timestamped] | all | output format | -| level | string | No | [fatal, error, warn, http, info, debug, trace] | all | verbose level | -| colors | boolean | No | false | v5.7.0 | disable or enable colors | +| Property | Type | Required | Example | Support | Description | +| -------- | ------- | -------- | ---------------------------------------------- | ------- | ------------------------------------------------- | +| type | string | No | [stdout, file] | all | define the output | +| path | string | No | verdaccio.log | all | if type is file, define the location of that file | +| format | string | No | [pretty, pretty-timestamped] | all | output format | +| level | string | No | [fatal, error, warn, http, info, debug, trace] | all | verbose level | +| colors | boolean | No | false | v5.7.0 | disable or enable colors | diff --git a/website/docs/logo.md b/website/docs/logo.md index aadb4ec23..21670016b 100644 --- a/website/docs/logo.md +++ b/website/docs/logo.md @@ -1,20 +1,20 @@ --- id: logo -title: "Logotype" +title: 'Logotype' --- -The logotype was designed by __[Breno Rodrigues](https://github.com/rodriguesbreno)__ which +The logotype was designed by **[Breno Rodrigues](https://github.com/rodriguesbreno)** which won the [contest](https://github.com/verdaccio/verdaccio/issues/237) ([last stage](https://github.com/verdaccio/verdaccio/issues/328)) and donated his work to this project. > All logos are licensed under [Creative Commons](https://github.com/verdaccio/verdaccio/blob/master/LICENSE-docs). -Special thanks to *[@Lisapressmar](https://github.com/Lisapressmar)* for her contribution +Special thanks to _[@Lisapressmar](https://github.com/Lisapressmar)_ for her contribution with multiple image formats and sizes. ## Symbols {#symbols} -__With text__ +**With text** ![symbol tiny with text](/img/logo/symbol/png/logo-small-header-bottom.png) @@ -22,11 +22,11 @@ __With text__ ![symbol big with text](/img/logo/symbol/png/logo-small-header-bottom@3x.png) -__SVG__ +**SVG** ![symbol svg](/img/logo/symbol/svg/logo-small-header-bottom.svg) -__No text__ +**No text** ![symbol tiny](/img/logo/symbol/png/verdaccio-tiny.png) @@ -34,12 +34,10 @@ __No text__ ![symbol big](/img/logo/symbol/png/verdaccio-tiny@3x.png) -__SVG__ +**SVG** ![svg format symbol no text](/img/logo/symbol/svg/verdaccio-tiny.svg) - - ### Black&White {#blackwhite} ![symbol bw small](/img/logo/symbol/png/verdaccio-blackwhite.png) @@ -48,11 +46,10 @@ __SVG__ ![symbol bw big](/img/logo/symbol/png/verdaccio-blackwhite@3x.png) -__SVG__ +**SVG** ![symbol bw svg](/img/logo/symbol/svg/verdaccio-blackwhite.svg) - ## Banner {#banner} ![banner small](/img/logo/banner/png/verdaccio-banner.png) @@ -60,5 +57,3 @@ __SVG__ ![banner medium](/img/logo/banner/png/verdaccio-banner@2x.png) ![banner big](/img/logo/banner/png/verdaccio-banner@3x.png) - - diff --git a/website/docs/node-api.md b/website/docs/node-api.md index a4b581c9a..71a5f26a4 100644 --- a/website/docs/node-api.md +++ b/website/docs/node-api.md @@ -1,6 +1,6 @@ --- id: node-api -title: "Node API" +title: 'Node API' --- Verdaccio can be invoked programmatically. The Node API was introduced after version `verdaccio@3.0.0`. @@ -62,11 +62,12 @@ startServer( ## Other implementations {#other-implementations} -* [verdaccio-server](https://github.com/boringame/verdaccio-server) local npm registry proxy server +- [verdaccio-server](https://github.com/boringame/verdaccio-server) local npm registry proxy server ```js // js -import * as verdaccioServer from "verdaccio-server"; +import * as verdaccioServer from 'verdaccio-server'; + verdaccioServer.start(); verdaccioServer.stop(); verdaccioServer.list(); diff --git a/website/docs/notifications.md b/website/docs/notifications.md index b249a804f..aa5b1b614 100644 --- a/website/docs/notifications.md +++ b/website/docs/notifications.md @@ -1,6 +1,6 @@ --- id: notifications -title: "Notifications" +title: 'Notifications' --- Notify was built primarily to use with Slack's Incoming @@ -19,7 +19,7 @@ An example with a **HipChat**, **Stride** and **Google Hangouts Chat** hook: ```yaml notify: method: POST - headers: [{'Content-Type': 'application/json'}] + headers: [{ 'Content-Type': 'application/json' }] endpoint: https://usagge.hipchat.com/v2/room/3729485/notification?auth_token=mySecretToken content: '{"color":"green","message":"New package published: * {{ name }}*","notify":true,"message_format":"text"}' ``` @@ -30,19 +30,19 @@ notify: notify: 'example-google-chat': method: POST - headers: [{'Content-Type': 'application/json'}] + headers: [{ 'Content-Type': 'application/json' }] endpoint: https://chat.googleapis.com/v1/spaces/AAAAB_TcJYs/messages?key=myKey&token=myToken content: '{"text":"New package published: `{{ name }}{{#each versions}} v{{version}}{{/each}}`"}' 'example-hipchat': - method: POST - headers: [{'Content-Type': 'application/json'}] - endpoint: https://usagge.hipchat.com/v2/room/3729485/notification?auth_token=mySecretToken - content: '{"color":"green","message":"New package published: * {{ name }}*","notify":true,"message_format":"text"}' + method: POST + headers: [{ 'Content-Type': 'application/json' }] + endpoint: https://usagge.hipchat.com/v2/room/3729485/notification?auth_token=mySecretToken + content: '{"color":"green","message":"New package published: * {{ name }}*","notify":true,"message_format":"text"}' 'example-stride': - method: POST - headers: [{'Content-Type': 'application/json'}, {'authorization': 'Bearer secretToken'}] - endpoint: https://api.atlassian.com/site/{cloudId}/conversation/{conversationId}/message - content: '{"body": {"version": 1,"type": "doc","content": [{"type": "paragraph","content": [{"type": "text","text": "New package published: * {{ name }}* Publisher name: * {{ publisher.name }}"}]}]}}' + method: POST + headers: [{ 'Content-Type': 'application/json' }, { 'authorization': 'Bearer secretToken' }] + endpoint: https://api.atlassian.com/site/{cloudId}/conversation/{conversationId}/message + content: '{"body": {"version": 1,"type": "doc","content": [{"type": "paragraph","content": [{"type": "text","text": "New package published: * {{ name }}* Publisher name: * {{ publisher.name }}"}]}]}}' ``` ## Template {#template} @@ -63,9 +63,9 @@ We use [Handlebars](https://handlebarsjs.com/) as main template engine. List of properties accesible via template -* Metadata -* Publisher (who is publishing) -* Package Published (package@1.0.0) +- Metadata +- Publisher (who is publishing) +- Package Published (package@1.0.0) ### Metadata {#metadata} @@ -121,7 +121,6 @@ Package metadata that the template has access } ``` - ### Publisher {#publisher} You can get access to the package publisher information in the `content` of a webhook using the `publisher` object. @@ -158,11 +157,11 @@ You can access to the package is being published with the keyword `{{publishedPa ## Configuration {#configuration} -Property | Type | Required | Support | Default | Description ---- | --- | --- | --- | --- | --- -method| string | No | all | | HTTP verb -packagePattern| string | No | all | | Only run this notification if the package name matches the regular expression -packagePatternFlags| string | No | all | | Any flags to be used with the regular expression -headers| array/object | Yes | all | | If this endpoint requires specific headers, set them here as an array of key: value objects. -endpoint| string | Yes | all | | set the URL endpoint for this call -content| string | Yes | all | | any [Handlebar](https://handlebarsjs.com/) expressions +| Property | Type | Required | Support | Default | Description | +| ------------------- | ------------ | -------- | ------- | ------- | -------------------------------------------------------------------------------------------- | +| method | string | No | all | | HTTP verb | +| packagePattern | string | No | all | | Only run this notification if the package name matches the regular expression | +| packagePatternFlags | string | No | all | | Any flags to be used with the regular expression | +| headers | array/object | Yes | all | | If this endpoint requires specific headers, set them here as an array of key: value objects. | +| endpoint | string | Yes | all | | set the URL endpoint for this call | +| content | string | Yes | all | | any [Handlebar](https://handlebarsjs.com/) expressions | diff --git a/website/docs/packages.md b/website/docs/packages.md index 00f818319..ed7a25ad2 100644 --- a/website/docs/packages.md +++ b/website/docs/packages.md @@ -1,6 +1,6 @@ --- id: packages -title: "Package Access" +title: 'Package Access' --- This is a series of constraints that allow or restrict access to the local storage based on specific criteria. @@ -44,14 +44,14 @@ packages: The list internal groups handled by `verdaccio` are: ```js -'$all', '$anonymous', '@all', '@anonymous', 'all', 'undefined', 'anonymous' +'$all', '$anonymous', '@all', '@anonymous', 'all', 'undefined', 'anonymous'; ``` All users receive all those set of permissions independently of is anonymous or not plus the groups provided by the plugin, in case of `htpasswd` return the username as a group. For instance, if you are logged as `npmUser` the list of groups will be. ```js // groups without '$' are going to be deprecated eventually -'$all', '$anonymous', '@all', '@anonymous', 'all', 'undefined', 'anonymous', 'npmUser' +'$all', '$anonymous', '@all', '@anonymous', 'all', 'undefined', 'anonymous', 'npmUser'; ``` If you want to protect specific set packages under your group, you need to do something like this. Let's use a `Regex` that covers all prefixed `npmuser-` packages. We recommend using a prefix for your packages, in that way it will be easier to protect them. @@ -88,14 +88,14 @@ $ npm config set always-auth=true Defining multiple access groups is fairly easy, just define them with a white space between them. ```yaml - 'company-*': - access: admin internal - publish: admin - proxy: server1 - 'supersecret-*': - access: secret super-secret-area ultra-secret-area - publish: secret ultra-secret-area - proxy: server1 +'company-*': + access: admin internal + publish: admin + proxy: server1 +'supersecret-*': + access: secret super-secret-area ultra-secret-area + publish: secret ultra-secret-area + proxy: server1 ``` #### Blocking access to set of packages {#blocking-access-to-set-of-packages} @@ -112,7 +112,7 @@ packages: #### Blocking proxying a set of specific packages {#blocking-proxying-a-set-of-specific-packages} -You might want to block one or several packages from fetching from remote repositories., but, at the same time, allow others to access different *uplinks*. +You might want to block one or several packages from fetching from remote repositories., but, at the same time, allow others to access different _uplinks_. Let's see the following example: @@ -135,10 +135,10 @@ packages: Let's describe what we want with the above example: -* I want to host my own `jquery` dependency but I need to avoid proxying it. -* I want all dependencies that match with `my-company-*` but I need to avoid proxying them. -* I want all dependencies that are in the `my-local-scope` scope but I need to avoid proxying them. -* I want proxying for all the rest of the dependencies. +- I want to host my own `jquery` dependency but I need to avoid proxying it. +- I want all dependencies that match with `my-company-*` but I need to avoid proxying them. +- I want all dependencies that are in the `my-local-scope` scope but I need to avoid proxying them. +- I want proxying for all the rest of the dependencies. Be **aware that the order of your packages definitions is important and always use double wilcard**. Because if you do not include it `verdaccio` will include it for you and the way that your dependencies are resolved will be affected. @@ -155,7 +155,7 @@ You may assign multiple uplinks for use as a proxy to use in the case of failove #### Unpublishing Packages {#unpublishing-packages} -The property `publish` handle permissions for `npm publish` and `npm unpublish`. But, if you want to be more specific, you can use the property +The property `publish` handle permissions for `npm publish` and `npm unpublish`. But, if you want to be more specific, you can use the property `unpublish` in your package access section, for instance: ```yaml @@ -180,21 +180,20 @@ packages: In the previous example, the behaviour would be described: -* all users can publish the `jquery` package, but only the user `root` would be able to unpublish any version. -* only authenticated users can publish `my-company-*` packages, but **nobody would be allowed to unpublish them**. -* If `unpublish` is commented out, the access will be granted or denied by the `publish` definition. - +- all users can publish the `jquery` package, but only the user `root` would be able to unpublish any version. +- only authenticated users can publish `my-company-*` packages, but **nobody would be allowed to unpublish them**. +- If `unpublish` is commented out, the access will be granted or denied by the `publish` definition. ### Configuration {#configuration} You can define mutiple `packages` and each of them must have an unique `Regex`. The syntax is based on [minimatch glob expressions](https://github.com/isaacs/minimatch). -Property | Type | Required | Example | Support | Description ---- | --- | --- | --- | --- | --- -access | string | No | $all | all | define groups allowed to access the package -publish | string | No | $authenticated | all | define groups allowed to publish -proxy | string | No | npmjs | all | limit look ups for specific uplink -storage | string | No | string | `/some-folder` | it creates a subfolder whithin the storage folder for each package access +| Property | Type | Required | Example | Support | Description | +| -------- | ------ | -------- | -------------- | -------------- | ------------------------------------------------------------------------- | +| access | string | No | $all | all | define groups allowed to access the package | +| publish | string | No | $authenticated | all | define groups allowed to publish | +| proxy | string | No | npmjs | all | limit look ups for specific uplink | +| storage | string | No | string | `/some-folder` | it creates a subfolder whithin the storage folder for each package access | > We higlight that we recommend to not use **allow_access**/**allow_publish** and **proxy_access** anymore, those are deprecated and will soon be removed, please use the short version of each of those (**access**/**publish**/**proxy**). diff --git a/website/docs/plugin-auth.md b/website/docs/plugin-auth.md index ed21cf600..704fd5d81 100644 --- a/website/docs/plugin-auth.md +++ b/website/docs/plugin-auth.md @@ -1,6 +1,6 @@ --- id: plugin-auth -title: "Authentication Plugin" +title: 'Authentication Plugin' --- ## What's an Authentication Plugin? {#whats-an-authentication-plugin} @@ -8,7 +8,7 @@ title: "Authentication Plugin" Is a sort plugin that allows to handle who access or publish to a specific package. By default the `htpasswd` is built-in, but can easily be replaced by your own. - ## Getting Started +## Getting Started The authentication plugins are defined in the `auth:` section, as follows: @@ -43,17 +43,22 @@ On each request, `authenticate` will be triggered and the plugin should return t ### API {#api} ```typescript - interface IPluginAuth extends IPlugin { - authenticate(user: string, password: string, cb: AuthCallback): void; - adduser?(user: string, password: string, cb: AuthCallback): void; - changePassword?(user: string, password: string, newPassword: string, cb: AuthCallback): void; - allow_publish?(user: RemoteUser, pkg: AllowAccess & PackageAccess, cb: AuthAccessCallback): void; - allow_access?(user: RemoteUser, pkg: AllowAccess & PackageAccess, cb: AuthAccessCallback): void; - allow_unpublish?(user: RemoteUser, pkg: AllowAccess & PackageAccess, cb: AuthAccessCallback): void; - apiJWTmiddleware?(helpers: any): Function; - } +interface IPluginAuth extends IPlugin { + authenticate(user: string, password: string, cb: AuthCallback): void; + adduser?(user: string, password: string, cb: AuthCallback): void; + changePassword?(user: string, password: string, newPassword: string, cb: AuthCallback): void; + allow_publish?(user: RemoteUser, pkg: AllowAccess & PackageAccess, cb: AuthAccessCallback): void; + allow_access?(user: RemoteUser, pkg: AllowAccess & PackageAccess, cb: AuthAccessCallback): void; + allow_unpublish?( + user: RemoteUser, + pkg: AllowAccess & PackageAccess, + cb: AuthAccessCallback + ): void; + apiJWTmiddleware?(helpers: any): Function; +} ``` -> Only `adduser`, `allow_access`, `apiJWTmiddleware`, `allow_publish` and `allow_unpublish` are optional, verdaccio provide a fallback in all those cases. + +> Only `adduser`, `allow_access`, `apiJWTmiddleware`, `allow_publish` and `allow_unpublish` are optional, verdaccio provide a fallback in all those cases. #### `apiJWTmiddleware` method {#apijwtmiddleware-method} @@ -61,12 +66,10 @@ Since `v4.0.0` `apiJWTmiddleware` was introduced on [PR#1227](https://github.com/verdaccio/verdaccio/pull/1227) in order to have full control of the token handler, overriding this method will disable `login/adduser` support. We recommend don't implement this method unless is totally necessary. See a full example [here](https://github.com/verdaccio/verdaccio/pull/1227#issuecomment-463235068). - ## What should I return in each of the methods? {#what-should-i-return-in-each-of-the-methods} Verdaccio relies on `callback` functions at time of this writing. Each method should call the method and what you return is important, let's review how to do it. - ### `authentication` callback {#authentication-callback} Once the authentication has been executed there is 2 options to give a response to `verdaccio`. @@ -76,14 +79,13 @@ Once the authentication has been executed there is 2 options to give a response If the auth was unsuccessful, return `false` as the second argument. ```typescript -callback(null, false) +callback(null, false); ``` ##### If the authentication success {#if-the-authentication-success} The auth was successful. - `groups` is an array of strings where the user is part of. ``` @@ -102,7 +104,6 @@ The authentication service might fails, and you might want to reflect that in th > A failure on login is not the same as service error, if you want to notify user the credentials are wrong, just return `false` instead string of groups. The behaviour mostly depends of you. - ### `adduser` callback {#adduser-callback} ##### If adduser success {#if-adduser-success} @@ -110,7 +111,7 @@ The authentication service might fails, and you might want to reflect that in th If the service is able to create an user, return `true` as the second argument. ```typescript -callback(null, true) +callback(null, true); ``` ##### If adduser fails {#if-adduser-fails} @@ -134,7 +135,7 @@ If the service is able to create an user, return `true` as the second argument. ```typescript const user = serviceUpdatePassword(user, password, newPassword); -callback(null, user) +callback(null, user); ``` ##### If the request fails {#if-the-request-fails} @@ -144,7 +145,7 @@ Any other action different than success must return an error. ```typescript import { getNotFound } from '@verdaccio/commons-api'; - const err = getNotFound('user not found'); +const err = getNotFound('user not found'); callback(err); ``` @@ -173,7 +174,7 @@ Any other action different than success must return an error. ```typescript import { getNotFound } from '@verdaccio/commons-api'; - const err = getForbidden('not allowed to access package'); +const err = getForbidden('not allowed to access package'); callback(err); ``` @@ -285,19 +286,19 @@ Where `htpasswd` is the sufix of the plugin name. eg: `verdaccio-htpasswd` and t ### List Community Authentication Plugins {#list-community-authentication-plugins} -* [verdaccio-bitbucket](https://github.com/idangozlan/verdaccio-bitbucket): Bitbucket authentication plugin for verdaccio. -* [verdaccio-bitbucket-server](https://github.com/oeph/verdaccio-bitbucket-server): Bitbucket Server authentication plugin for verdaccio. -* [verdaccio-ldap](https://www.npmjs.com/package/verdaccio-ldap): LDAP auth plugin for verdaccio. -* [verdaccio-active-directory](https://github.com/nowhammies/verdaccio-activedirectory): Active Directory authentication plugin for verdaccio -* [verdaccio-gitlab](https://github.com/bufferoverflow/verdaccio-gitlab): use GitLab Personal Access Token to authenticate -* [verdaccio-gitlab-ci](https://github.com/lab360-ch/verdaccio-gitlab-ci): Enable GitLab CI to authenticate against verdaccio. -* [verdaccio-htpasswd](https://github.com/verdaccio/verdaccio-htpasswd): Auth based on htpasswd file plugin (built-in) for verdaccio -* [verdaccio-github-oauth](https://github.com/aroundus-inc/verdaccio-github-oauth): Github oauth authentication plugin for verdaccio. -* [verdaccio-github-oauth-ui](https://github.com/n4bb12/verdaccio-github-oauth-ui): GitHub OAuth plugin for the verdaccio login button. -* [verdaccio-groupnames](https://github.com/deinstapel/verdaccio-groupnames): Plugin to handle dynamic group associations utilizing `$group` syntax. Works best with the ldap plugin. -* [verdaccio-sqlite](https://github.com/bchanudet/verdaccio-sqlite): SQLite Authentication plugin for Verdaccio -* [verdaccio-okta-auth](https://github.com/hogarthww-labs/verdaccio-okta-auth) Verdaccio Okta Auth -* [verdaccio-azure-ad-login](https://github.com/IhToN/verdaccio-azure-ad-login) Let your users authenticate into Verdaccio via Azure AD OAuth 2.0 API -* [verdaccio-auth-gitlab](https://github.com/pfdgithub/verdaccio-auth-gitlab) Verdaccio authentication plugin by gitlab personal access tokens. +- [verdaccio-bitbucket](https://github.com/idangozlan/verdaccio-bitbucket): Bitbucket authentication plugin for verdaccio. +- [verdaccio-bitbucket-server](https://github.com/oeph/verdaccio-bitbucket-server): Bitbucket Server authentication plugin for verdaccio. +- [verdaccio-ldap](https://www.npmjs.com/package/verdaccio-ldap): LDAP auth plugin for verdaccio. +- [verdaccio-active-directory](https://github.com/nowhammies/verdaccio-activedirectory): Active Directory authentication plugin for verdaccio +- [verdaccio-gitlab](https://github.com/bufferoverflow/verdaccio-gitlab): use GitLab Personal Access Token to authenticate +- [verdaccio-gitlab-ci](https://github.com/lab360-ch/verdaccio-gitlab-ci): Enable GitLab CI to authenticate against verdaccio. +- [verdaccio-htpasswd](https://github.com/verdaccio/verdaccio-htpasswd): Auth based on htpasswd file plugin (built-in) for verdaccio +- [verdaccio-github-oauth](https://github.com/aroundus-inc/verdaccio-github-oauth): Github oauth authentication plugin for verdaccio. +- [verdaccio-github-oauth-ui](https://github.com/n4bb12/verdaccio-github-oauth-ui): GitHub OAuth plugin for the verdaccio login button. +- [verdaccio-groupnames](https://github.com/deinstapel/verdaccio-groupnames): Plugin to handle dynamic group associations utilizing `$group` syntax. Works best with the ldap plugin. +- [verdaccio-sqlite](https://github.com/bchanudet/verdaccio-sqlite): SQLite Authentication plugin for Verdaccio +- [verdaccio-okta-auth](https://github.com/hogarthww-labs/verdaccio-okta-auth) Verdaccio Okta Auth +- [verdaccio-azure-ad-login](https://github.com/IhToN/verdaccio-azure-ad-login) Let your users authenticate into Verdaccio via Azure AD OAuth 2.0 API +- [verdaccio-auth-gitlab](https://github.com/pfdgithub/verdaccio-auth-gitlab) Verdaccio authentication plugin by gitlab personal access tokens. **Have you developed a new plugin? Add it here !** diff --git a/website/docs/plugin-generator.md b/website/docs/plugin-generator.md index 108c213ee..253136669 100644 --- a/website/docs/plugin-generator.md +++ b/website/docs/plugin-generator.md @@ -1,13 +1,13 @@ --- id: plugin-generator -title: "Plugin Generator" +title: 'Plugin Generator' --- ## Installing the Yeoman Generator {#installing-the-yeoman-generator} Verdaccio is a pluggable application, with the objective to help developers to generate new plugins, we have a custom generator based in **[Yeoman](https://yeoman.io/)** for generate all sort of plugins. -To install the generator, as first step you must install the *yeoman* command `yo`. +To install the generator, as first step you must install the _yeoman_ command `yo`. ```bash npm install -g yo @@ -62,13 +62,13 @@ Setting the project root at: /Users/user/verdaccio_yo_generator ``` - Don't hesitate to include meaningful keywords, as `verdaccio`, `plugin` or your plugin type. Good keywords will help us to find you and future improvement in our collect information about all plugins. + ``` ? Key your keywords (comma to split) verdaccio,plugin,storage,minio,verdaccio-plugin ``` - Keep your generator **updated**, don't miss any bug-fixes and performance improvements. - ### Contributing {#contributing} Help us to improve the generator, you can contribute in the following repository. diff --git a/website/docs/plugin-middleware.md b/website/docs/plugin-middleware.md index c1a6bfd12..6b25392ac 100644 --- a/website/docs/plugin-middleware.md +++ b/website/docs/plugin-middleware.md @@ -1,6 +1,6 @@ --- id: plugin-middleware -title: "Middleware Plugin" +title: 'Middleware Plugin' --- ## What's an Middleware Plugin? {#whats-an-middleware-plugin} @@ -40,7 +40,6 @@ public register_middlewares( The `auth` and `storage` are instances and can be extended, but we don't recommend this approach unless is well founded. - > A good example of a middleware plugin is the [verdaccio-audit](https://github.com/verdaccio/monorepo/tree/master/plugins/audit). ## Generate an middleware plugin {#generate-an-middleware-plugin} @@ -109,12 +108,12 @@ The middleware are registrered after built-in endpoints, thus, it is not possibl ### List Community Middleware Plugins {#list-community-middleware-plugins} -* [verdaccio-audit](https://github.com/verdaccio/verdaccio-audit): verdaccio plugin for *npm audit* cli support (built-in) (compatible since 3.x) +- [verdaccio-audit](https://github.com/verdaccio/verdaccio-audit): verdaccio plugin for _npm audit_ cli support (built-in) (compatible since 3.x) -* [verdaccio-profile-api](https://github.com/ahoracek/verdaccio-profile-api): verdaccio plugin for *npm profile* cli support and *npm profile set password* for *verdaccio-htpasswd* based authentificaton +- [verdaccio-profile-api](https://github.com/ahoracek/verdaccio-profile-api): verdaccio plugin for _npm profile_ cli support and _npm profile set password_ for _verdaccio-htpasswd_ based authentificaton -* [verdaccio-https](https://github.com/honzahommer/verdaccio-https) Verdaccio middleware plugin to redirect to https if x-forwarded-proto header is set -* [verdaccio-badges](https://github.com/tavvy/verdaccio-badges) A verdaccio plugin to provide a version badge generator endpoint -* [verdaccio-openmetrics](https://github.com/freight-hub/verdaccio-openmetrics) Verdaccio plugin exposing an OpenMetrics/Prometheus endpoint with health and traffic metrics -* [verdaccio-sentry](https://github.com/juanpicado/verdaccio-sentry) sentry loggin errors -* [verdaccio-pacman](https://github.com/PaddeK/verdaccio-pacman) Verdaccio Middleware Plugin to manage tags and versions of packages +- [verdaccio-https](https://github.com/honzahommer/verdaccio-https) Verdaccio middleware plugin to redirect to https if x-forwarded-proto header is set +- [verdaccio-badges](https://github.com/tavvy/verdaccio-badges) A verdaccio plugin to provide a version badge generator endpoint +- [verdaccio-openmetrics](https://github.com/freight-hub/verdaccio-openmetrics) Verdaccio plugin exposing an OpenMetrics/Prometheus endpoint with health and traffic metrics +- [verdaccio-sentry](https://github.com/juanpicado/verdaccio-sentry) sentry loggin errors +- [verdaccio-pacman](https://github.com/PaddeK/verdaccio-pacman) Verdaccio Middleware Plugin to manage tags and versions of packages diff --git a/website/docs/plugin-storage.md b/website/docs/plugin-storage.md index 4be2a342d..f98320dbe 100644 --- a/website/docs/plugin-storage.md +++ b/website/docs/plugin-storage.md @@ -1,6 +1,6 @@ --- id: plugin-storage -title: "Storage Plugin" +title: 'Storage Plugin' --- ## What's an Storage Plugin? {#whats-an-storage-plugin} @@ -11,22 +11,27 @@ Verdaccio by default uses a file system storage plugin [local-storage](https://g Storage plugins are composed of two objects, the `IPluginStorage` and the `IPackageStorage`. -* The `IPluginStorage` object handle the local database for private packages. +- The `IPluginStorage` object handle the local database for private packages. ```typescript - interface IPluginStorage extends IPlugin, ITokenActions { - logger: Logger; - config: T & Config; - add(name: string, callback: Callback): void; - remove(name: string, callback: Callback): void; - get(callback: Callback): void; - getSecret(): Promise; - setSecret(secret: string): Promise; - getPackageStorage(packageInfo: string): IPackageStorage; - search(onPackage: onSearchPackage, onEnd: onEndSearchPackage, validateName: onValidatePackage): void; - } +interface IPluginStorage extends IPlugin, ITokenActions { + logger: Logger; + config: T & Config; + add(name: string, callback: Callback): void; + remove(name: string, callback: Callback): void; + get(callback: Callback): void; + getSecret(): Promise; + setSecret(secret: string): Promise; + getPackageStorage(packageInfo: string): IPackageStorage; + search( + onPackage: onSearchPackage, + onEnd: onEndSearchPackage, + validateName: onValidatePackage + ): void; +} ``` -* The `IPackageStorage` is an object that is created by each request that handles the I/O actions for the metadata and tarballs. + +- The `IPackageStorage` is an object that is created by each request that handles the I/O actions for the metadata and tarballs. ```typescript interface IPackageStorage { @@ -103,9 +108,9 @@ I'm all done. Running npm install for you to install the required dependencies. The following list of plugins are implementing the Storage API and might be used them as example. -* [verdaccio-memory](https://github.com/verdaccio/verdaccio-memory) Storage plugin to host packages in Memory -* [verdaccio-s3-storage](https://github.com/remitly/verdaccio-s3-storage) Storage plugin to host packages **Amazon S3** -* [verdaccio-aws-s3-storage](https://github.com/verdaccio/monorepo/tree/master/plugins/aws-s3-storage) Storage plugin to host packages **Amazon S3** (maintained by Verdaccio core team) -* [verdaccio-google-cloud](https://github.com/verdaccio/verdaccio-google-cloud) Storage plugin to host packages **Google Cloud Storage** -* [verdaccio-minio](https://github.com/barolab/verdaccio-minio) A verdaccio plugin for storing data in Minio -* [verdaccio-offline-storage](https://github.com/g3ngar/verdaccio-offline-storage) local-storage plugin BUT with locally available packages as first class citizens. +- [verdaccio-memory](https://github.com/verdaccio/verdaccio-memory) Storage plugin to host packages in Memory +- [verdaccio-s3-storage](https://github.com/remitly/verdaccio-s3-storage) Storage plugin to host packages **Amazon S3** +- [verdaccio-aws-s3-storage](https://github.com/verdaccio/monorepo/tree/master/plugins/aws-s3-storage) Storage plugin to host packages **Amazon S3** (maintained by Verdaccio core team) +- [verdaccio-google-cloud](https://github.com/verdaccio/verdaccio-google-cloud) Storage plugin to host packages **Google Cloud Storage** +- [verdaccio-minio](https://github.com/barolab/verdaccio-minio) A verdaccio plugin for storing data in Minio +- [verdaccio-offline-storage](https://github.com/g3ngar/verdaccio-offline-storage) local-storage plugin BUT with locally available packages as first class citizens. diff --git a/website/docs/plugins.md b/website/docs/plugins.md index 265bb6831..d0b7fd7a8 100644 --- a/website/docs/plugins.md +++ b/website/docs/plugins.md @@ -1,16 +1,16 @@ --- id: plugins -title: "Plugins" +title: 'Plugins' --- Verdaccio is a pluggable application. It can be extended in many ways, either new authentication methods, adding endpoints or using a custom storage. There are 5 types of plugins: -* [Authentication](plugin-auth.md) -* [Middleware](plugin-middleware.md) -* [Storage](plugin-storage.md) -* Custom Theme and filters +- [Authentication](plugin-auth.md) +- [Middleware](plugin-middleware.md) +- [Storage](plugin-storage.md) +- Custom Theme and filters > If you are interested to develop your own plugin, read the [development](dev-plugins.md) section. @@ -34,7 +34,7 @@ Open the `config.yaml` file and update the `auth` section as follows: The default configuration looks like this, due we use a build-in `htpasswd` plugin by default that you can disable just commenting out the following lines. -### Naming convention {#naming-convention} +### Naming convention {#naming-convention} Since version `2.0.0` until version plugins must start with the following convention: @@ -51,12 +51,13 @@ auth: store: '@my-org/store-awesome-plugin': foo: some value - bar: another value + bar: another value middleware: '@my-org/middleware-awesome-plugin': foo: some value - bar: another value + bar: another value ``` + ### Authentication Configuration {#authentication-configuration} ```yaml @@ -71,7 +72,7 @@ and replacing them with (in case you decide to use a `ldap` plugin. ```yaml auth: activedirectory: - url: "ldap://10.0.100.1" + url: 'ldap://10.0.100.1' baseDN: 'dc=sample,dc=local' domainSuffix: 'sample.local' ``` @@ -86,7 +87,7 @@ auth: file: ./htpasswd #max_users: 1000 activedirectory: - url: "ldap://10.0.100.1" + url: 'ldap://10.0.100.1' baseDN: 'dc=sample,dc=local' domainSuffix: 'sample.local' ``` @@ -126,7 +127,6 @@ $> npm install --global verdaccio-theme-dark > The plugin name prefix must start with `verdaccio-theme`, otherwise the plugin won't load. - You can load only one theme at a time and pass through options if you need it. ```yaml @@ -142,7 +142,7 @@ theme: If you have a custom UI plugin for the them you will need to adapt your build to the new requirements. -The previous version you only need to return a function with a string and the path of the directory. +The previous version you only need to return a function with a string and the path of the directory. ``` const path = require('path'); @@ -177,6 +177,7 @@ The module must return an object and the `index.html` is ignored since support d }, manifestFiles: { js: [ 'runtime.js', 'vendors.js', 'main.js' ] } ``` + - `staticPath`: is the same data returned in Verdaccio 4. - `manifest`: A webpack manifest object. - `manifestFiles`: A object with one property `js` and the array (order matters) of the manifest id to be loaded in the template dynamically. @@ -206,24 +207,23 @@ const { WebpackManifestPlugin } = require('webpack-manifest-plugin'); > If you are relying on any sinopia plugin, remember are deprecated and might no work in the future. -* [sinopia-npm](https://www.npmjs.com/package/sinopia-npm): auth plugin for sinopia supporting an npm registry. -* [sinopia-memory](https://www.npmjs.com/package/sinopia-memory): auth plugin for sinopia that keeps users in memory. -* [sinopia-github-oauth-cli](https://www.npmjs.com/package/sinopia-github-oauth-cli). -* [sinopia-crowd](https://www.npmjs.com/package/sinopia-crowd): auth plugin for sinopia supporting atlassian crowd. -* [sinopia-activedirectory](https://www.npmjs.com/package/sinopia-activedirectory): Active Directory authentication plugin for sinopia. -* [sinopia-github-oauth](https://www.npmjs.com/package/sinopia-github-oauth): authentication plugin for sinopia2, supporting github oauth web flow. -* [sinopia-delegated-auth](https://www.npmjs.com/package/sinopia-delegated-auth): Sinopia authentication plugin that delegates authentication to another HTTP URL -* [sinopia-altldap](https://www.npmjs.com/package/sinopia-altldap): Alternate LDAP Auth plugin for Sinopia -* [sinopia-request](https://www.npmjs.com/package/sinopia-request): An easy and fully auth-plugin with configuration to use an external API. -* [sinopia-htaccess-gpg-email](https://www.npmjs.com/package/sinopia-htaccess-gpg-email): Generate password in htaccess format, encrypt with GPG and send via MailGun API to users. -* [sinopia-mongodb](https://www.npmjs.com/package/sinopia-mongodb): An easy and fully auth-plugin with configuration to use a mongodb database. -* [sinopia-htpasswd](https://www.npmjs.com/package/sinopia-htpasswd): auth plugin for sinopia supporting htpasswd format. -* [sinopia-leveldb](https://www.npmjs.com/package/sinopia-leveldb): a leveldb backed auth plugin for sinopia private npm. -* [sinopia-gitlabheres](https://www.npmjs.com/package/sinopia-gitlabheres): Gitlab authentication plugin for sinopia. -* [sinopia-gitlab](https://www.npmjs.com/package/sinopia-gitlab): Gitlab authentication plugin for sinopia -* [sinopia-ldap](https://www.npmjs.com/package/sinopia-ldap): LDAP auth plugin for sinopia. -* [sinopia-github-oauth-env](https://www.npmjs.com/package/sinopia-github-oauth-env) Sinopia authentication plugin with github oauth web flow. +- [sinopia-npm](https://www.npmjs.com/package/sinopia-npm): auth plugin for sinopia supporting an npm registry. +- [sinopia-memory](https://www.npmjs.com/package/sinopia-memory): auth plugin for sinopia that keeps users in memory. +- [sinopia-github-oauth-cli](https://www.npmjs.com/package/sinopia-github-oauth-cli). +- [sinopia-crowd](https://www.npmjs.com/package/sinopia-crowd): auth plugin for sinopia supporting atlassian crowd. +- [sinopia-activedirectory](https://www.npmjs.com/package/sinopia-activedirectory): Active Directory authentication plugin for sinopia. +- [sinopia-github-oauth](https://www.npmjs.com/package/sinopia-github-oauth): authentication plugin for sinopia2, supporting github oauth web flow. +- [sinopia-delegated-auth](https://www.npmjs.com/package/sinopia-delegated-auth): Sinopia authentication plugin that delegates authentication to another HTTP URL +- [sinopia-altldap](https://www.npmjs.com/package/sinopia-altldap): Alternate LDAP Auth plugin for Sinopia +- [sinopia-request](https://www.npmjs.com/package/sinopia-request): An easy and fully auth-plugin with configuration to use an external API. +- [sinopia-htaccess-gpg-email](https://www.npmjs.com/package/sinopia-htaccess-gpg-email): Generate password in htaccess format, encrypt with GPG and send via MailGun API to users. +- [sinopia-mongodb](https://www.npmjs.com/package/sinopia-mongodb): An easy and fully auth-plugin with configuration to use a mongodb database. +- [sinopia-htpasswd](https://www.npmjs.com/package/sinopia-htpasswd): auth plugin for sinopia supporting htpasswd format. +- [sinopia-leveldb](https://www.npmjs.com/package/sinopia-leveldb): a leveldb backed auth plugin for sinopia private npm. +- [sinopia-gitlabheres](https://www.npmjs.com/package/sinopia-gitlabheres): Gitlab authentication plugin for sinopia. +- [sinopia-gitlab](https://www.npmjs.com/package/sinopia-gitlab): Gitlab authentication plugin for sinopia +- [sinopia-ldap](https://www.npmjs.com/package/sinopia-ldap): LDAP auth plugin for sinopia. +- [sinopia-github-oauth-env](https://www.npmjs.com/package/sinopia-github-oauth-env) Sinopia authentication plugin with github oauth web flow. > All sinopia plugins should be compatible with all future verdaccio versions. Anyhow, we encourage contributors to migrate them to the -modern verdaccio API and using the prefix as *verdaccio-xx-name*. - +> modern verdaccio API and using the prefix as _verdaccio-xx-name_. diff --git a/website/docs/programmatically.md b/website/docs/programmatically.md index c5520c658..dcd813519 100644 --- a/website/docs/programmatically.md +++ b/website/docs/programmatically.md @@ -1,6 +1,6 @@ --- id: verdaccio-programmatically -title: "Node.js API" +title: 'Node.js API' --- Verdaccio is a binary command which is available in your enviroment when you install globally the package eg `npm i -g verdaccio`, but also can be dependency in your project and use it programmatically. @@ -12,27 +12,23 @@ Using the binary is the faster way to use verdaccio programatically, you need to > If you are using ESM modules the `require` won't be available. ```typescript -export function runRegistry( - args: string[] = [], - childOptions: {} -): Promise { +export function runRegistry(args: string[] = [], childOptions: {}): Promise { return new Promise((resolve, reject) => { - const childFork = fork(require.resolve('verdaccio/bin/verdaccio'), args, childOptions); - childFork.on('message', (msg: {verdaccio_started: boolean}) => { - if(msg.verdaccio_started){ + const childFork = fork(require.resolve('verdaccio/bin/verdaccio'), args, childOptions); + childFork.on('message', (msg: { verdaccio_started: boolean }) => { + if (msg.verdaccio_started) { resolve(childFork); } }); childFork.on('error', (err: any) => reject([err])); - childFork.on('disconnect', (err: any) => reject([err])); + childFork.on('disconnect', (err: any) => reject([err])); }); } ``` You can see the full example on this repository. -[https://github.com/juanpicado/verdaccio-fork](https://github.com/juanpicado/verdaccio-fork -) +[https://github.com/juanpicado/verdaccio-fork](https://github.com/juanpicado/verdaccio-fork) ### Using the module API @@ -59,13 +55,13 @@ There are three ways to use it: With an object you need to add `self_path`, manually (it's not nice but would be a breaking change changing it now) on v6 this is not longer need it. ```js - const {runServer, parseConfigFile} = require('verdaccio'); - const configPath = join(__dirname, './config.yaml'); - const c = parseConfigFile(configPath); - // workaround - // on v5 the `self_path` still exists and will be removed in v6 - c.self_path = 'foo'; - runServer(c).then(() => {}); +const { runServer, parseConfigFile } = require('verdaccio'); +const configPath = join(__dirname, './config.yaml'); +const c = parseConfigFile(configPath); +// workaround +// on v5 the `self_path` still exists and will be removed in v6 +c.self_path = 'foo'; +runServer(c).then(() => {}); ``` Feature available minor than `v5.11.0`. @@ -79,20 +75,20 @@ const verdaccio = require('verdaccio').default; const YAML = require('js-yaml'); const getConfig = () => { - return YAML.safeLoad(fs.readFileSync(path.join(__dirname, 'config.yaml'), 'utf8')); -} + return YAML.safeLoad(fs.readFileSync(path.join(__dirname, 'config.yaml'), 'utf8')); +}; const cache = path.join(__dirname, 'cache'); const config = Object.assign({}, getConfig(), { - self_path: cache + self_path: cache, }); verdaccio(config, 6000, cache, '1.0.0', 'verdaccio', (webServer, addrs, pkgName, pkgVersion) => { try { - webServer.unref(); - webServer.listen(addrs.port || addrs.path, addrs.host, () => { - console.log('verdaccio running'); - }); + webServer.unref(); + webServer.listen(addrs.port || addrs.path, addrs.host, () => { + console.log('verdaccio running'); + }); } catch (error) { console.error(error); } diff --git a/website/docs/protect-your-dependencies.md b/website/docs/protect-your-dependencies.md index faf954b03..e3cb5d556 100644 --- a/website/docs/protect-your-dependencies.md +++ b/website/docs/protect-your-dependencies.md @@ -1,6 +1,6 @@ --- id: protect-your-dependencies -title: "Protecting packages" +title: 'Protecting packages' --- Verdaccio allows you protect publishing to your registry. To achieve that you will need to set up correctly configure your [packages access](packages). @@ -10,7 +10,7 @@ Verdaccio allows you protect publishing to your registry. To achieve that you wi Let's see for instance the following set up. You have a set of dependencies that are prefixed with `my-company-*` and you need to protect them from anonymous or other non-authorized logged-in users. ```yaml -"my-company-*": +'my-company-*': access: admin teamA teamB teamC publish: admin teamA ``` diff --git a/website/docs/puppet.md b/website/docs/puppet.md index edcd6d868..1894bc78b 100644 --- a/website/docs/puppet.md +++ b/website/docs/puppet.md @@ -1,6 +1,6 @@ --- id: puppet -title: "Puppet" +title: 'Puppet' --- Install verdaccio for Debian, Ubuntu, Fedora, and RedHat. @@ -9,8 +9,8 @@ Install verdaccio for Debian, Ubuntu, Fedora, and RedHat. There are two variants to install verdaccio using this Puppet module: -* Apply-mode (with puppet-apply and no puppetmaster setup needed) -* Master-Agent-mode (with puppet-agent accessing your configuration through the puppetmaster). +- Apply-mode (with puppet-apply and no puppetmaster setup needed) +- Master-Agent-mode (with puppet-agent accessing your configuration through the puppetmaster). In both variants you have to explicitly call "class nodejs {}" in your puppet script because the puppet-verdaccio module only defines this as a requirement, so you have all the flexibility you want when installing nodejs. @@ -21,8 +21,4 @@ For further information: [https://github.com/verdaccio/puppet-verdaccio](https://github.com/verdaccio/puppet-verdaccio) > We are looking for active contributors for this integration, if you are interested -[refers to this ticket](https://github.com/verdaccio/puppet-verdaccio/issues/11). - - - - +> [refers to this ticket](https://github.com/verdaccio/puppet-verdaccio/issues/11). diff --git a/website/docs/repositories.md b/website/docs/repositories.md index 19433d9f0..54ad04dc3 100644 --- a/website/docs/repositories.md +++ b/website/docs/repositories.md @@ -6,4 +6,3 @@ title: Source Code `verdaccio` is composed or multiple repositories you might contribute. Look into the **issues** tab whether there is a ticket waiting for you 🤠. To see the complete list of repositories, [click here](https://github.com/verdaccio/verdaccio/wiki/Repositories). - diff --git a/website/docs/reverse-proxy.md b/website/docs/reverse-proxy.md index 7ce6fbd47..1ce559597 100644 --- a/website/docs/reverse-proxy.md +++ b/website/docs/reverse-proxy.md @@ -1,12 +1,11 @@ --- id: reverse-proxy -title: "Reverse Proxy Setup" +title: 'Reverse Proxy Setup' --- Using a reverse proxy is a common practice. The following configurations are the most recommended and used ones. - **Important**, the headers are considered to resolve the public are `X-Forwarded-Proto` for the protocol and `Host` for the domain, please include them in your configuration. # Apache @@ -15,16 +14,17 @@ Apache and `mod_proxy` should **not decode/encode slashes** and leave them as th For installing at relative path, `/npm`, on the server -```` +``` AllowEncodedSlashes NoDecode ProxyPass /npm http://127.0.0.1:4873 nocanon ProxyPassReverse /npm http://127.0.0.1:4873 -```` +``` For installing at root path, `/`, on the server -```` + +``` ServerName your.domain.com ServerAdmin hello@your.domain.com @@ -33,13 +33,13 @@ For installing at root path, `/`, on the server ProxyPass / http://127.0.0.1:4873/ nocanon ProxyPassReverse / http://127.0.0.1:4873/ -```` +``` ### Configuration with SSL {#configuration-with-ssl} Apache virtual server configuration. -````apache +```apache ServerName npm.your.domain.com @@ -55,42 +55,41 @@ Apache virtual server configuration. RequestHeader set X-Forwarded-Proto "https" -```` +``` ## Invalid checksum Sometimes the gzip compression can mess with the request when running `npm install` and result in error messages like this: -```` +``` npm WARN tar TAR_ENTRY_INVALID checksum failure npm WARN tar zlib: incorrect data check -```` +``` A possible fix for this, can be by disabling gzip compression for the virtual host, by adding this to your config: -```` +``` SetEnv no-gzip 1 -```` +``` Resulting in a config like so: -```` +``` AllowEncodedSlashes NoDecode SetEnv no-gzip 1 ProxyPass /npm http://127.0.0.1:4873 nocanon ProxyPassReverse /npm http://127.0.0.1:4873 -```` +``` You should only add it to your virtual host config, if you are experiencing the issue. - # Nginx The following snippet is a full `docker` example can be tested in our [Docker examples repository](https://github.com/verdaccio/verdaccio/tree/5.x/docker-examples/reverse_proxy/nginx). -````nginx +```nginx upstream verdaccio_v4 { server verdaccio_relative_path_v4:4873; keepalive 8; @@ -139,11 +138,11 @@ server { proxy_redirect off; } } -```` +``` ## SSL example {#ssl-example} -````nginx +```nginx server { listen 80; return 302 https://$host$request_uri; @@ -181,7 +180,7 @@ server { proxy_redirect off; } } -```` +``` ## Run behind reverse proxy with different domain and port {#run-behind-reverse-proxy-with-different-domain-and-port} @@ -208,6 +207,7 @@ location / { proxy_set_header X-Forwarded-Proto $scheme; } ``` + For this case, `url_prefix` should **NOT** set in Verdaccio config --- @@ -222,6 +222,7 @@ location ~ ^/verdaccio/(.*)$ { proxy_set_header X-Forwarded-Proto $scheme; } ``` + For this case, `url_prefix` should set to `/verdaccio/` > Note: There is a slash after the install path (`https://your-domain:port/verdaccio/`)! @@ -230,7 +231,6 @@ For this case, `url_prefix` should set to `/verdaccio/` > Since `verdaccio@5.0.0` - The new `VERDACCIO_PUBLIC_URL` is intended to be used behind proxies, this variable will be used for: - Used as base path to serve UI resources as (js, favicon, etc) diff --git a/website/docs/security-policy.md b/website/docs/security-policy.md index cb7636c1a..0f13d3c0b 100644 --- a/website/docs/security-policy.md +++ b/website/docs/security-policy.md @@ -1,6 +1,6 @@ --- id: security-policy -title: "Security Policy" +title: 'Security Policy' --- -Follow our security policy on [GitHub](https://github.com/verdaccio/verdaccio/security/policy) \ No newline at end of file +Follow our security policy on [GitHub](https://github.com/verdaccio/verdaccio/security/policy) diff --git a/website/docs/server.md b/website/docs/server.md index 6902f5d31..4718ba630 100644 --- a/website/docs/server.md +++ b/website/docs/server.md @@ -1,6 +1,6 @@ --- id: server-configuration -title: "Server Configuration" +title: 'Server Configuration' --- This is mostly basic Linux server configuration stuff but I felt it important to document and share the steps I took to get Verdaccio running permanently on my server. You will need root (or sudo) permissions for the following steps. @@ -31,6 +31,7 @@ The `cd` command sends you to the home directory of the Verdaccio user. Make sur ## Listening on all addresses {#listening-on-all-addresses} If you want to listen to every external address set the listen directive in the config to: + ```yaml # you can specify listen address (or simply a port) listen: 0.0.0.0:4873 @@ -85,7 +86,9 @@ $ which verdaccio ## Using systemd {#using-systemd} Instead of `forever` you can use `systemd` for starting Verdaccio and keeping it running. Verdaccio installation has systemd unit, you only need to copy it: + ```bash $ sudo cp /usr/lib/node_modules/verdaccio/systemd/verdaccio.service /lib/systemd/system/ && sudo systemctl daemon-reload ``` + This unit assumes you have configuration in `/etc/verdaccio/config.yaml` and store data in `/var/lib/verdaccio`, so either move your files to those locations or edit the unit. diff --git a/website/docs/setup-npm.md b/website/docs/setup-npm.md index 7a08c01df..a83ab7579 100644 --- a/website/docs/setup-npm.md +++ b/website/docs/setup-npm.md @@ -1,6 +1,6 @@ --- id: setup-npm -title: "npm" +title: 'npm' --- # npm {#npm} @@ -14,14 +14,17 @@ To set the registry for all your local projects in any terminal window run: ```bash npm set registry http://localhost:4873/ ``` + This will set the registry for your operational system user and you can find it on the file `~/.npmrc`. ## Using registry for a specific project {#specific} To set this value for a specific project open its root folder on a terminal window and run: + ```bash npm set registry http://localhost:4873/ --location project ``` + This will set the registry in a `.npmrc` file in your project root directory. or by specific scope eg: `@my-scope/auth`: @@ -64,11 +67,13 @@ npm adduser --registry http://localhost:4873 after version `npm@9` the commands works separately: - `login` does not create users. + ```bash npm login --registry http://localhost:4873 ``` - `adduser` does not login users. + ```bash npm adduser --registry http://localhost:4873 ``` diff --git a/website/docs/setup-pnpm.md b/website/docs/setup-pnpm.md index 0fa36c95b..6f676e635 100644 --- a/website/docs/setup-pnpm.md +++ b/website/docs/setup-pnpm.md @@ -1,11 +1,11 @@ --- id: setup-pnpm -title: "pnpm" +title: 'pnpm' --- ### pnpm {#pnpm} > This includes 4.x and 5.x series. -`pnpm` recognize by default the configuration at `.npmrc` and also the `--registry` value. +`pnpm` recognize by default the configuration at `.npmrc` and also the `--registry` value. This means that you can follow the same commands described in [npm](setup-npm.md) replacing `npm` by `pnpm`. diff --git a/website/docs/setup-yarn.md b/website/docs/setup-yarn.md index e01516c40..64c20a429 100644 --- a/website/docs/setup-yarn.md +++ b/website/docs/setup-yarn.md @@ -1,6 +1,6 @@ --- id: setup-yarn -title: "yarn" +title: 'yarn' --- # yarn {#yarn} diff --git a/website/docs/ssl.md b/website/docs/ssl.md index 862e2aa1f..c7dca027e 100644 --- a/website/docs/ssl.md +++ b/website/docs/ssl.md @@ -1,53 +1,53 @@ --- id: ssl -title: "Set up the SSL Certificates" +title: 'Set up the SSL Certificates' --- Follow these instructions to configure an SSL certificate to serve an npm registry over HTTPS. +- Update the listen property in your `~/.config/verdaccio/config.yaml`: -* Update the listen property in your `~/.config/verdaccio/config.yaml`: - -```` +``` listen: 'https://your.domain.com/' -```` +``` Once you've updated the listen property and try to run verdaccio again, it will ask for certificates. -* Generate your certificates +- Generate your certificates -```` +``` $ openssl genrsa -out /Users/user/.config/verdaccio/verdaccio-key.pem 2048 $ openssl req -new -sha256 -key /Users/user/.config/verdaccio/verdaccio-key.pem -out /Users/user/.config/verdaccio/verdaccio-csr.pem $ openssl x509 -req -in /Users/user/.config/verdaccio/verdaccio-csr.pem -signkey /Users/user/.config/verdaccio/verdaccio-key.pem -out /Users/user/.config/verdaccio/verdaccio-cert.pem - ```` +``` -* Edit your config file `/Users/user/.config/verdaccio/config.yaml` and add the following section: +- Edit your config file `/Users/user/.config/verdaccio/config.yaml` and add the following section: -```` +``` https: key: /Users/user/.config/verdaccio/verdaccio-key.pem cert: /Users/user/.config/verdaccio/verdaccio-cert.pem ca: /Users/user/.config/verdaccio/verdaccio-csr.pem -```` +``` Alternatively, if you have a certificate with the `server.pfx` format, you can add the following configuration section: (The passphrase is optional and only needed if your certificate is encrypted.) -```` +``` https: pfx: /Users/user/.config/verdaccio/server.pfx passphrase: 'secret' -```` +``` You can find more info on the `key`, `cert`, `ca`, `pfx`, and `passphrase` arguments in the [Node documentation](https://nodejs.org/api/tls.html#tls_tls_createsecurecontext_options) -* Run `verdaccio` in your command line. +- Run `verdaccio` in your command line. -* Open the browser and visit `https://your.domain.com:port/` +- Open the browser and visit `https://your.domain.com:port/` These instructions are mostly valid under OSX and Linux; on Windows the paths will vary, but the steps are the same. ## Docker + If you are using the Docker image, you have to set the `VERDACCIO_PROTOCOL` environment variable to `https`, as the `listen` argument is provided in the [Dockerfile](https://github.com/verdaccio/verdaccio/blob/master/Dockerfile#L43) and thus ignored from your config file. You can also set the `VERDACCIO_PORT` environment variable if you are using a port other than `4873`. diff --git a/website/docs/third-party.md b/website/docs/third-party.md index 5204ba6f7..1a27eb788 100644 --- a/website/docs/third-party.md +++ b/website/docs/third-party.md @@ -1,6 +1,6 @@ --- id: third-party -title: "Third-party Integrations" +title: 'Third-party Integrations' --- ## Cloudron {#cloudron} diff --git a/website/docs/uplinks.md b/website/docs/uplinks.md index efe16812b..e354193f5 100644 --- a/website/docs/uplinks.md +++ b/website/docs/uplinks.md @@ -1,9 +1,9 @@ --- id: uplinks -title: "Uplinks" +title: 'Uplinks' --- -An *uplink* is a link with an external registry that provides access to external packages. +An _uplink_ is a link with an external registry that provides access to external packages. ![Uplinks](https://user-images.githubusercontent.com/558752/52976233-fb0e3980-33c8-11e9-8eea-5415e6018144.png) @@ -12,7 +12,7 @@ An *uplink* is a link with an external registry that provides access to external ```yaml uplinks: npmjs: - url: https://registry.npmjs.org/ + url: https://registry.npmjs.org/ server2: url: http://mirror.local.net/ timeout: 100ms @@ -21,23 +21,24 @@ uplinks: baduplink: url: http://localhost:55666/ ``` + ### Configuration {#configuration} You can define mutiple uplinks and each of them must have an unique name (key). They can have the following properties: -Property | Type | Required | Example | Support | Description | Default ---- | --- | --- | --- | --- | --- | --- -url | string | Yes | https://registry.npmjs.org/ | all | The registry url | npmjs -ca | string | No | ~./ssl/client.crt' | all | SSL path certificate | No default -timeout | string | No | 100ms | all | set new timeout for the request | 30s -maxage | string | No |10m | all | the time threshold to the cache is valid | 2m -fail_timeout | string | No |10m | all | defines max time when a request becomes a failure | 5m -max_fails | number | No |2 | all | limit maximun failure request | 2 -cache | boolean | No |[true,false] | >= 2.1 | cache all remote tarballs in storage | true -auth | list | No | [see below](uplinks.md#auth-property) | >= 2.5 | assigns the header 'Authorization' [more info](http://blog.npmjs.org/post/118393368555/deploying-with-npm-private-modules) | disabled -headers | list | No | authorization: "Bearer SecretJWToken==" | all | list of custom headers for the uplink | disabled -strict_ssl | boolean | No | [true,false] | >= 3.0 | If true, requires SSL certificates be valid. | true -agent_options | object | No | maxSockets: 10 | >= 4.0.2 | options for the HTTP or HTTPS Agent responsible for managing uplink connection persistence and reuse [more info](https://nodejs.org/api/http.html#http_class_http_agent) | No default +| Property | Type | Required | Example | Support | Description | Default | +| ------------- | ------- | -------- | --------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------- | +| url | string | Yes | https://registry.npmjs.org/ | all | The registry url | npmjs | +| ca | string | No | ~./ssl/client.crt' | all | SSL path certificate | No default | +| timeout | string | No | 100ms | all | set new timeout for the request | 30s | +| maxage | string | No | 10m | all | the time threshold to the cache is valid | 2m | +| fail_timeout | string | No | 10m | all | defines max time when a request becomes a failure | 5m | +| max_fails | number | No | 2 | all | limit maximun failure request | 2 | +| cache | boolean | No | [true,false] | >= 2.1 | cache all remote tarballs in storage | true | +| auth | list | No | [see below](uplinks.md#auth-property) | >= 2.5 | assigns the header 'Authorization' [more info](http://blog.npmjs.org/post/118393368555/deploying-with-npm-private-modules) | disabled | +| headers | list | No | authorization: "Bearer SecretJWToken==" | all | list of custom headers for the uplink | disabled | +| strict_ssl | boolean | No | [true,false] | >= 3.0 | If true, requires SSL certificates be valid. | true | +| agent_options | object | No | maxSockets: 10 | >= 4.0.2 | options for the HTTP or HTTPS Agent responsible for managing uplink connection persistence and reuse [more info](https://nodejs.org/api/http.html#http_class_http_agent) | No default | #### Auth property {#auth-property} @@ -73,15 +74,15 @@ uplinks: url: https://private-registry.domain.com/registry auth: type: bearer - token: "token" + token: 'token' ``` > Note: `token` has priority over `token_env` ### You Must know {#you-must-know} -* Uplinks must be registries compatible with the `npm` endpoints. Eg: *verdaccio*, `sinopia@1.4.0`, *npmjs registry*, *yarn registry*, *JFrog*, *Nexus* and more. -* Setting `cache` to false will help to save space in your hard drive. This will avoid store `tarballs` but [it will keep metadata in folders](https://github.com/verdaccio/verdaccio/issues/391). -* Multiple uplinks might slow down the lookup of your packages. For each request an npm client makes, verdaccio makes 1 call to each configured uplink. -* The (timeout, maxage and fail_timeout) format follow the [NGINX measurement units](http://nginx.org/en/docs/syntax.html) -* When using the [Helm Chart](https://github.com/verdaccio/charts), you can use `secretEnvVars` to inject sensitive environment variables, which can be used to configure private uplink auth. +- Uplinks must be registries compatible with the `npm` endpoints. Eg: _verdaccio_, `sinopia@1.4.0`, _npmjs registry_, _yarn registry_, _JFrog_, _Nexus_ and more. +- Setting `cache` to false will help to save space in your hard drive. This will avoid store `tarballs` but [it will keep metadata in folders](https://github.com/verdaccio/verdaccio/issues/391). +- Multiple uplinks might slow down the lookup of your packages. For each request an npm client makes, verdaccio makes 1 call to each configured uplink. +- The (timeout, maxage and fail_timeout) format follow the [NGINX measurement units](http://nginx.org/en/docs/syntax.html) +- When using the [Helm Chart](https://github.com/verdaccio/charts), you can use `secretEnvVars` to inject sensitive environment variables, which can be used to configure private uplink auth. diff --git a/website/docs/web.md b/website/docs/web.md index 262241fc0..b2f57ced7 100644 --- a/website/docs/web.md +++ b/website/docs/web.md @@ -1,6 +1,6 @@ --- id: webui -title: "Web User Interface" +title: 'Web User Interface' --- ![Uplinks](https://user-images.githubusercontent.com/558752/52916111-fa4ba980-32db-11e9-8a64-f4e06eb920b3.png) @@ -12,9 +12,9 @@ web: enable: true title: Verdaccio logo: http://somedomain/somelogo.png - primary_color: "#4b5e40" + primary_color: '#4b5e40' gravatar: true | false - scope: "@scope" + scope: '@scope' sort_packages: asc | desc darkMode: false favicon: http://somedomain/favicon.ico | /path/favicon.ico @@ -65,33 +65,32 @@ i18n: ### Configuration {#configuration} -| Property | Type | Required | Example | Support | Description | -| ------------- | ---------- | -------- | ------------------------------------------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------ | -| enable | boolean | No | true/false | all | allow to display the web interface | -| title | string | No | Verdaccio | all | HTML head title description (if is not define set "Verdaccio" by default). | -| gravatar | boolean | No | true | `>v4` | Gravatars will be generated under the hood if this property is enabled | -| sort_packages | [asc,desc] | No | asc | `>v4` | By default private packages are sorted by ascending | -| logo | string | No | `/local/path/to/my/logo.png` `http://my.logo.domain/logo.png` | all | a URI where logo is located (header logo) | -| primary_color | string | No | "#4b5e40" | `>4` | The primary color to use throughout the UI (header, etc) | -| scope | string | No | @myscope | `>v3.x` | If you're using this registry for a specific module scope, specify that scope to set it in the webui instructions header | -| darkMode | boolean | No | false | `>=v4.6.0` | This mode is an special theme for those want to live in the dark side | -| favicon | string | No | false | `>=v5.0.1` | Display a custom favicon, can be local resource or valid url | -| rateLimit | object | No | use `userRateLimit` configuration | `>=v5.4.0` | Increase or decrease rate limit, by default is 5k request every 2 minutes, only limit web api endpoints, the CSS, JS, etcc are ingnored | -| pkgManagers | npm, pnpm or yarn | No | npm | `>=v5.5.0` | Allow customise which package managers on the side bar and registry information dialog are visible | -| login | boolean | No | true or false | `>=v5.5.0` | Allow disable login on the UI (also include web endpoints). | -| scriptsBodyAfter | string[] | No | any list of strings | `>=5.0.0` | inject scripts after the tag | -| metaScripts | string[] | No | any list of strings | `>=5.0.0` | inject scripts inside | -| scriptsbodyBefore | string[] | No | any list of strings | `>=5.0.0` | inject scripts before the | -| html_cache | boolean | No | true | `>=v5.9.0` | whether the html cache is enabled, default true | -| showInfo | boolean | No | true | `>=v5.10.0` | display the info button on the header | -| showSettings | boolean | No | true | `>=v5.10.0` | display the settings button on the header | -| showThemeSwitch | boolean | No | true | `>=v5.10.0` | display the theme switch button on the header | -| showFooter | boolean | No | true | `>=v5.10.0` | allow hide footer | -| showSearch | boolean | No | true | `>=v5.10.0` | allow hide search component | -| showDownloadTarball | boolean | No | true | `>=v5.10.0` | allow hide download button on the sidebar | -| showRaw | boolean | No | true | `>=v5.10.0` | allow hide manifest button on the sidebar (experimental feature) | - +| Property | Type | Required | Example | Support | Description | +| ------------------- | ----------------- | -------- | ------------------------------------------------------------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------------- | +| enable | boolean | No | true/false | all | allow to display the web interface | +| title | string | No | Verdaccio | all | HTML head title description (if is not define set "Verdaccio" by default). | +| gravatar | boolean | No | true | `>v4` | Gravatars will be generated under the hood if this property is enabled | +| sort_packages | [asc,desc] | No | asc | `>v4` | By default private packages are sorted by ascending | +| logo | string | No | `/local/path/to/my/logo.png` `http://my.logo.domain/logo.png` | all | a URI where logo is located (header logo) | +| primary_color | string | No | "#4b5e40" | `>4` | The primary color to use throughout the UI (header, etc) | +| scope | string | No | @myscope | `>v3.x` | If you're using this registry for a specific module scope, specify that scope to set it in the webui instructions header | +| darkMode | boolean | No | false | `>=v4.6.0` | This mode is an special theme for those want to live in the dark side | +| favicon | string | No | false | `>=v5.0.1` | Display a custom favicon, can be local resource or valid url | +| rateLimit | object | No | use `userRateLimit` configuration | `>=v5.4.0` | Increase or decrease rate limit, by default is 5k request every 2 minutes, only limit web api endpoints, the CSS, JS, etcc are ingnored | +| pkgManagers | npm, pnpm or yarn | No | npm | `>=v5.5.0` | Allow customise which package managers on the side bar and registry information dialog are visible | +| login | boolean | No | true or false | `>=v5.5.0` | Allow disable login on the UI (also include web endpoints). | +| scriptsBodyAfter | string[] | No | any list of strings | `>=5.0.0` | inject scripts after the tag | +| metaScripts | string[] | No | any list of strings | `>=5.0.0` | inject scripts inside | +| scriptsbodyBefore | string[] | No | any list of strings | `>=5.0.0` | inject scripts before the | +| html_cache | boolean | No | true | `>=v5.9.0` | whether the html cache is enabled, default true | +| showInfo | boolean | No | true | `>=v5.10.0` | display the info button on the header | +| showSettings | boolean | No | true | `>=v5.10.0` | display the settings button on the header | +| showThemeSwitch | boolean | No | true | `>=v5.10.0` | display the theme switch button on the header | +| showFooter | boolean | No | true | `>=v5.10.0` | allow hide footer | +| showSearch | boolean | No | true | `>=v5.10.0` | allow hide search component | +| showDownloadTarball | boolean | No | true | `>=v5.10.0` | allow hide download button on the sidebar | +| showRaw | boolean | No | true | `>=v5.10.0` | allow hide manifest button on the sidebar (experimental feature) | > The recommended logo size is `40x40` pixels. -> The `darkMode` can be enabled via UI and is persisted in the browser local storage. If you combine `showThemeSwitch: false` with `darkMode` users will be forced to use an specific theme. Furthermore, also void `primary_color` and dark cannot be customized. +> The `darkMode` can be enabled via UI and is persisted in the browser local storage. If you combine `showThemeSwitch: false` with `darkMode` users will be forced to use an specific theme. Furthermore, also void `primary_color` and dark cannot be customized. diff --git a/website/docs/what-is-verdaccio.md b/website/docs/what-is-verdaccio.md index 8d51cb1e1..221b41e21 100644 --- a/website/docs/what-is-verdaccio.md +++ b/website/docs/what-is-verdaccio.md @@ -1,6 +1,6 @@ --- id: what-is-verdaccio -title: "What is Verdaccio?" +title: 'What is Verdaccio?' --- Verdaccio is a **lightweight private npm proxy registry** built in **Node.js** @@ -12,9 +12,9 @@ recommended by the Open Web Application Security Project ([OWASP](https://owasp. ## What's a registry? {#whats-a-registry} -* A registry is a repository for packages, that implements the **CommonJS Compliant Package Registry specification** for reading package's information. -* Provide a compatible API with npm clients **(yarn/npm/pnpm)**. -* Semantic Versioning compatible **(semver)**. +- A registry is a repository for packages, that implements the **CommonJS Compliant Package Registry specification** for reading package's information. +- Provide a compatible API with npm clients **(yarn/npm/pnpm)**. +- Semantic Versioning compatible **(semver)**. ```bash $> verdaccio @@ -58,11 +58,11 @@ Verdaccio cache all dependencies on demand and speed up installations in local o ## In a Nutshell {#in-a-nutshell} -* It's a web app based on Node.js -* It's a private npm registry -* It's a local network proxy -* It's a Pluggable application -* It's fairly easy to install and to use -* We offer Docker and Kubernetes support -* It is 100% compatible with yarn, npm and pnpm -* Verdaccio means **A green color popular in late medieval Italy for fresco painting**. +- It's a web app based on Node.js +- It's a private npm registry +- It's a local network proxy +- It's a Pluggable application +- It's fairly easy to install and to use +- We offer Docker and Kubernetes support +- It is 100% compatible with yarn, npm and pnpm +- Verdaccio means **A green color popular in late medieval Italy for fresco painting**. diff --git a/website/docs/who-is-using.md b/website/docs/who-is-using.md index 781585f37..de76f75ec 100644 --- a/website/docs/who-is-using.md +++ b/website/docs/who-is-using.md @@ -1,35 +1,32 @@ --- id: who-is-using -title: "Who is using Verdaccio?" +title: 'Who is using Verdaccio?' --- ### As a Business {#as-a-business} -*If you are using Verdaccio in your business and want to share your experience, let us know. We will be happy to listen to you.* - -* [SheetJS](https://sheetjs.com/) -* [Satispay](https://www.satispay.com/) +_If you are using Verdaccio in your business and want to share your experience, let us know. We will be happy to listen to you._ +- [SheetJS](https://sheetjs.com/) +- [Satispay](https://www.satispay.com/) ### Open Source Projects {#open-source-projects} > **Feel free to suggest other OSS are using Verdaccio.** -* [pnpm](https://pnpm.js.org/) -* [Storybook](https://storybook.js.org/) -* [Mozilla Neutrino](https://neutrinojs.org/) -* [create-react-app](https://github.com/facebook/create-react-app/blob/master/CONTRIBUTING.md#contributing-to-e2e-end-to-end-tests) -* [Gatsby](https://github.com/gatsbyjs/gatsby) -* [Apollo GraphQL](https://github.com/apollographql) -* [Uppy](https://github.com/transloadit/uppy) -* [Aurelia Framework](https://github.com/aurelia/framework) -* [bit](https://github.com/teambit/bit) -* [Wix Yoshi](https://github.com/wix/yoshi) -* [The AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) -* [Hyperledger Caliper](https://github.com/hyperledger/caliper) +- [pnpm](https://pnpm.js.org/) +- [Storybook](https://storybook.js.org/) +- [Mozilla Neutrino](https://neutrinojs.org/) +- [create-react-app](https://github.com/facebook/create-react-app/blob/master/CONTRIBUTING.md#contributing-to-e2e-end-to-end-tests) +- [Gatsby](https://github.com/gatsbyjs/gatsby) +- [Apollo GraphQL](https://github.com/apollographql) +- [Uppy](https://github.com/transloadit/uppy) +- [Aurelia Framework](https://github.com/aurelia/framework) +- [bit](https://github.com/teambit/bit) +- [Wix Yoshi](https://github.com/wix/yoshi) +- [The AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) +- [Hyperledger Caliper](https://github.com/hyperledger/caliper) #### Readme Recommendations {#readme-recommendations} -* [react-native-cli](https://github.com/react-native-community/react-native-cli/blob/master/CONTRIBUTING.md) - - +- [react-native-cli](https://github.com/react-native-community/react-native-cli/blob/master/CONTRIBUTING.md) diff --git a/website/docs/windows.md b/website/docs/windows.md index 42b259400..0bd9f9339 100644 --- a/website/docs/windows.md +++ b/website/docs/windows.md @@ -1,15 +1,15 @@ --- id: windows -title: "Installing As a Windows Service" +title: 'Installing As a Windows Service' --- Loosely based upon the instructions found [here](http://asysadmin.tumblr.com/post/32941224574/running-nginx-on-windows-as-a-service). I crafted the following and it provided me with a fully working verdaccio service installation: 1. Create a directory for verdaccio - * mkdir `c:\verdaccio` - * cd `c:\verdaccio` + - mkdir `c:\verdaccio` + - cd `c:\verdaccio` 2. Install verdaccio locally (I ran into npm issues with global installs) - * npm install verdaccio + - npm install verdaccio 3. Create your `config.yaml` file in this location `(c:\verdaccio\config.yaml)` 4. Windows Service Setup @@ -17,41 +17,39 @@ Loosely based upon the instructions found [here](http://asysadmin.tumblr.com/pos ALTERNATIVE METHOD: (WinSW package was missing when I tried to download it) -* Download [NSSM](https://www.nssm.cc/download/) and extract +- Download [NSSM](https://www.nssm.cc/download/) and extract -* Add the path that contains nssm.exe to the PATH +- Add the path that contains nssm.exe to the PATH -* Open an administrative command +- Open an administrative command -* Run nssm install verdaccio At a minimum you must fill in the Application tab Path, -Startup directory and Arguments fields. Assuming an install with node in the system path and a -location of c:\verdaccio the below values will work: - * Path: `node` - * Startup directory: `c:\verdaccio` - * Arguments: `c:\verdaccio\node_modules\verdaccio\build\lib\cli.js -c c:\verdaccio\config.yaml` +- Run nssm install verdaccio At a minimum you must fill in the Application tab Path, + Startup directory and Arguments fields. Assuming an install with node in the system path and a + location of c:\verdaccio the below values will work: + _ Path: `node` + _ Startup directory: `c:\verdaccio` \* Arguments: `c:\verdaccio\node_modules\verdaccio\build\lib\cli.js -c c:\verdaccio\config.yaml` - You can adjust other service settings under other tabs as desired. When you are done, click Install service button + You can adjust other service settings under other tabs as desired. When you are done, click Install service button - * Start the service sc start verdaccio +- Start the service sc start verdaccio ## Using WinSW {#using-winsw} -* As of 2015-10-27, WinSW is no longer available at the below location. Please follow the Using NSSM instructions above. -* Download [WinSW](http://repo.jenkins-ci.org/releases/com/sun/winsw/winsw/) - * Place the executable (e.g. `winsw-1.9-bin.exe`) into this folder (`c:\verdaccio`) and rename it to `verdaccio-winsw.exe` -* Create a configuration file in `c:\verdaccio`, named `verdaccio-winsw.xml` -with the following configuration `xml verdaccio verdaccio verdaccio node c:\verdaccio\node_modules\verdaccio\src\lib\cli.js -c c:\verdaccio\config.yaml roll c:\verdaccio\ `. -* Install your service - * `cd c:\verdaccio` - * `verdaccio-winsw.exe install` -* Start your service - * `verdaccio-winsw.exe start` +- As of 2015-10-27, WinSW is no longer available at the below location. Please follow the Using NSSM instructions above. +- Download [WinSW](http://repo.jenkins-ci.org/releases/com/sun/winsw/winsw/) + - Place the executable (e.g. `winsw-1.9-bin.exe`) into this folder (`c:\verdaccio`) and rename it to `verdaccio-winsw.exe` +- Create a configuration file in `c:\verdaccio`, named `verdaccio-winsw.xml` + with the following configuration `xml verdaccio verdaccio verdaccio node c:\verdaccio\node_modules\verdaccio\src\lib\cli.js -c c:\verdaccio\config.yaml roll c:\verdaccio\ `. +- Install your service + - `cd c:\verdaccio` + - `verdaccio-winsw.exe install` +- Start your service + - `verdaccio-winsw.exe start` Some of the above config is more verbose than I had expected, it appears as though 'workingdirectory' is ignored, but other than that, this works for me and allows my verdaccio instance to persist between restarts of the server, and also restart itself should there be any crashes of the verdaccio process. - ## Repositories {#repositories} -* [verdaccio-deamon-windows](https://github.com/davidenke/verdaccio-deamon-windows) +- [verdaccio-deamon-windows](https://github.com/davidenke/verdaccio-deamon-windows) diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index a0e873a63..3a6198d68 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -7,7 +7,7 @@ const lgnMapping = { 'pl-PL': 'pl', 'cs-CZ': 'cs', 'fr-FR': 'fr', - 'it-IT': 'it' , + 'it-IT': 'it', 'ru-RU': 'ru', 'vi-VN': 'vi', 'yo-NG': 'yo', @@ -16,67 +16,73 @@ const lgnMapping = { // @ts-ignore const progress = translations; const limitLngIncluded = 19; -console.log('limit translation is on %s%', limitLngIncluded) -const isDeployPreview = process.env.CONTEXT === "deploy-preview"; -const isProductionDeployment = process.env.CONTEXT === "production"; +console.log('limit translation is on %s%', limitLngIncluded); +const isDeployPreview = process.env.CONTEXT === 'deploy-preview'; +const isProductionDeployment = process.env.CONTEXT === 'production'; const filterByProgress = (items) => { const originLng = Object.keys(translations); - return items.filter((lgn => { - if(lgn === 'en') { + return items.filter((lgn) => { + if (lgn === 'en') { return true; } const _lgn = lgnMapping[lgn] ? lgnMapping[lgn] : lgn; - if(!originLng.includes(_lgn)) { + if (!originLng.includes(_lgn)) { console.log(`language ${_lgn} excluded, does not exist in origin`); return false; } - + if (translations[_lgn].approvalProgress <= limitLngIncluded) { - console.log('language %s is being excluded due does not met limit of translation, current: %s%', _lgn, translations[_lgn].approvalProgress); + console.log( + 'language %s is being excluded due does not met limit of translation, current: %s%', + _lgn, + translations[_lgn].approvalProgress + ); return false; } return true; - })) -} + }); +}; const i18nConfig = { defaultLocale: 'en', - locales: isDeployPreview ? ['en'] : filterByProgress([ - "en", - "cs-CZ", - "de-DE", - "es-ES", - "fr-FR", - "it-IT", - "pl-PL", - "pt-BR", - "ru-RU", - "sr-CS", - "vi-VN", - "yo-NG", - "zh-TW", - "zh-CN" - ]), + locales: isDeployPreview + ? ['en'] + : filterByProgress([ + 'en', + 'cs-CZ', + 'de-DE', + 'es-ES', + 'fr-FR', + 'it-IT', + 'pl-PL', + 'pt-BR', + 'ru-RU', + 'sr-CS', + 'vi-VN', + 'yo-NG', + 'zh-TW', + 'zh-CN', + ]), localeConfigs: { - en: { label: "English" }, - 'it-IT': { label: `Italiano (${progress["it"].translationProgress}%)` }, - 'es-ES': { label: `Español (${progress["es-ES"].translationProgress}%)` }, - 'de-DE': { label: `Deutsch (${progress["de"].translationProgress}%)` }, - 'cs-CZ': { label: `Čeština (Česko) (${progress["cs"].translationProgress}%)` }, - 'fr-FR': { label: `Français (${progress["fr"].translationProgress}%)` }, - 'pl-PL': { label: `Polski (Polska) (${progress["pl"].translationProgress}%)` }, - 'pt-BR': { label: `Português (Brasil) (${progress["pt-BR"].translationProgress}%)` }, - 'ru-RU': { label: `Русский (Россия) (${progress["ru"].translationProgress}%)` }, - 'zh-CN': { label: `中文（中国）(${progress["zh-CN"].translationProgress}%)` }, - 'zh-TW': { label: `中文（台灣）(${progress["zh-TW"].translationProgress}%)` }, - 'yo-NG': { label: `Èdè Yorùbá (Nàìjíríà) (${progress["yo"].translationProgress}%)` }, - 'sr-CS': { label: `Српски (Србија) (${progress["sr-CS"].translationProgress}%)` }, - 'vi-VN': { label: `Tiếng Việt (Việt Nam) (${progress["vi"].translationProgress}%)` }, - } -} + en: { label: 'English' }, + 'it-IT': { label: `Italiano (${progress['it'].translationProgress}%)` }, + 'es-ES': { label: `Español (${progress['es-ES'].translationProgress}%)` }, + 'de-DE': { label: `Deutsch (${progress['de'].translationProgress}%)` }, + 'cs-CZ': { label: `Čeština (Česko) (${progress['cs'].translationProgress}%)` }, + 'fr-FR': { label: `Français (${progress['fr'].translationProgress}%)` }, + 'pl-PL': { label: `Polski (Polska) (${progress['pl'].translationProgress}%)` }, + 'pt-BR': { label: `Português (Brasil) (${progress['pt-BR'].translationProgress}%)` }, + 'ru-RU': { label: `Русский (Россия) (${progress['ru'].translationProgress}%)` }, + 'zh-CN': { label: `中文（中国）(${progress['zh-CN'].translationProgress}%)` }, + 'zh-TW': { label: `中文（台灣）(${progress['zh-TW'].translationProgress}%)` }, + 'yo-NG': { label: `Èdè Yorùbá (Nàìjíríà) (${progress['yo'].translationProgress}%)` }, + 'sr-CS': { label: `Српски (Србија) (${progress['sr-CS'].translationProgress}%)` }, + 'vi-VN': { label: `Tiếng Việt (Việt Nam) (${progress['vi'].translationProgress}%)` }, + }, +}; -const pkgJson = require('./package.json') +const pkgJson = require('./package.json'); /** @type {import('@docusaurus/types').DocusaurusConfig} */ module.exports = { @@ -88,15 +94,17 @@ module.exports = { baseUrl: '/', onBrokenLinks: 'throw', onBrokenMarkdownLinks: 'warn', - favicon: "img/logo/uk/verdaccio-tiny-uk-no-bg.svg", + favicon: 'img/logo/uk/verdaccio-tiny-uk-no-bg.svg', i18n: i18nConfig, - scripts: [ - "https://buttons.github.io/buttons.js", - ], + scripts: ['https://buttons.github.io/buttons.js'], plugins: [ 'docusaurus-plugin-sass', 'docusaurus-plugin-contributors', - isProductionDeployment && typeof process.env.SENTRY_KEY === 'string' && ['docusaurus-plugin-sentry', { DSN: process.env.SENTRY_KEY }], + isProductionDeployment && + typeof process.env.SENTRY_KEY === 'string' && [ + 'docusaurus-plugin-sentry', + { DSN: process.env.SENTRY_KEY }, + ], [ 'docusaurus-plugin-typedoc', { @@ -112,29 +120,39 @@ module.exports = { sidebar: { categoryLabel: '@verdaccio/node-api', // position: 1, - fullNames: true + fullNames: true, }, }, ], [ 'content-docs', - ({ + { id: 'community', path: 'community', routeBasePath: 'community', sidebarPath: require.resolve('./sidebarsCommunity.js'), showLastUpdateTime: true, - }), + }, ], [ 'content-docs', - ({ + { + id: 'dev', + path: 'dev', + routeBasePath: 'dev', + sidebarPath: require.resolve('./sidebarsDev.js'), + showLastUpdateTime: true, + }, + ], + [ + 'content-docs', + { id: 'talks', path: 'talks', routeBasePath: 'talks', sidebarPath: require.resolve('./sidebarsTalk.js'), showLastUpdateTime: true, - }), + }, ], [ 'docusaurus-plugin-typedoc', @@ -145,7 +163,7 @@ module.exports = { out: 'api/config', sidebar: { categoryLabel: '@verdaccio/config', - fullNames: true + fullNames: true, }, }, ], @@ -158,7 +176,7 @@ module.exports = { out: 'api/core', sidebar: { categoryLabel: '@verdaccio/core', - fullNames: true + fullNames: true, }, }, ], @@ -173,11 +191,11 @@ module.exports = { includeVersion: true, sidebar: { categoryLabel: '@verdaccio/types', - fullNames: true + fullNames: true, }, }, ], - ], + ], markdown: { mermaid: true, }, @@ -193,25 +211,25 @@ module.exports = { }), }, customFields: { - description: 'A lightweight Node.js private proxy registry' + description: 'A lightweight Node.js private proxy registry', }, themeConfig: { mermaid: { - theme: {light: 'neutral', dark: 'forest'}, + theme: { light: 'neutral', dark: 'forest' }, }, announcementBar: { id: 'announcementBar', content: 'Help provide humanitarian support to Ukraine refugees!', - isCloseable: false, - backgroundColor: '#1595de', - textColor: '#ffffff', + isCloseable: false, + backgroundColor: '#1595de', + textColor: '#ffffff', }, algolia: { appId: 'B3TG5CBF5H', apiKey: 'ed054733cb03418e9af25b7beb82c924', indexName: 'verdaccio', - contextualSearch: true + contextualSearch: true, }, docs: { sidebar: { @@ -223,7 +241,7 @@ module.exports = { title: `Verdaccio - v${pkgJson.version}`, logo: { alt: 'Verdaccio Logo', - src: "img/logo/uk/verdaccio-tiny-uk-no-bg.svg", + src: 'img/logo/uk/verdaccio-tiny-uk-no-bg.svg', }, items: [ { @@ -236,13 +254,13 @@ module.exports = { type: 'doc', docId: 'api/node-api/index', position: 'left', - label: 'API' + label: 'API', }, { to: '/blog', label: 'Blog', position: 'left' }, { type: 'docsVersionDropdown', - "position": "right", - }, + position: 'right', + }, { href: 'https://opencollective.com/verdaccio', label: 'Sponsor us', @@ -281,7 +299,7 @@ module.exports = { 'aria-label': 'Follow us at Fosstodon', }, ], - }, + }, footer: { style: 'dark', links: [ @@ -352,7 +370,7 @@ module.exports = { }, ], copyright: `Copyright © ${new Date().getFullYear()} Verdaccio community. Built with Docusaurus.`, - }, + }, colorMode: { defaultMode: 'light', disableSwitch: false, @@ -372,32 +390,30 @@ module.exports = { showLastUpdateAuthor: true, showLastUpdateTime: true, sidebarCollapsible: true, - remarkPlugins: [ - [require('@docusaurus/remark-plugin-npm2yarn'), {sync: true}], - ], + remarkPlugins: [[require('@docusaurus/remark-plugin-npm2yarn'), { sync: true }]], editUrl: ({ locale, docPath }) => { if (locale !== 'en') { return `https://crowdin.com/project/verdaccio/${locale}`; } return `https://github.com/verdaccio/verdaccio/edit/master/website/docs/${docPath}`; }, - lastVersion : '5.x', + lastVersion: '5.x', versions: { current: { - label: `6.x`, + label: `6.x`, }, '5.x': { - label: `5.x (Latest)`, + label: `5.x (Latest)`, }, }, }, googleAnalytics: { // trackingID: 'UA-2527438-21' - trackingID: 'G-PCYM9FYJZT' + trackingID: 'G-PCYM9FYJZT', }, gtag: { - trackingID: 'G-PCYM9FYJZT' - }, + trackingID: 'G-PCYM9FYJZT', + }, blog: { blogTitle: 'Verdaccio Official Blog', blogDescription: 'The official Verdaccio Node.js proxy registry blog', @@ -417,7 +433,7 @@ module.exports = { }, theme: { customCss: require.resolve('./src/css/custom.scss'), - }, + }, }, ], ], diff --git a/website/package.json b/website/package.json index f7ad9ea96..c7bd064c1 100644 --- a/website/package.json +++ b/website/package.json @@ -29,21 +29,29 @@ "@docusaurus/theme-common": "2.2.0", "@docusaurus/theme-mermaid": "2.2.0", "@docusaurus/theme-search-algolia": "2.2.0", + "@emotion/cache": "11.10.5", + "@emotion/css": "11.10.5", + "@emotion/jest": "11.10.5", + "@emotion/react": "11.10.5", + "@emotion/styled": "11.10.5", "@mdx-js/react": "^1.6.22", - "@mui/icons-material": "5.10.14", - "@mui/material": "5.10.14", - "@mui/styles": "5.10.14", + "@mui/icons-material": "5.11.0", + "@mui/material": "5.11.1", + "@mui/styles": "5.11.1", + "@lyrasearch/lyra": "^0.3.1", + "@verdaccio/ui-components": "workspace:1.0.0", + "dompurify": "2.4.1", "classnames": "2.3.2", "clsx": "1.2.1", "copy-text-to-clipboard": "3.0.1", "docusaurus-plugin-contributors": "workspace:1.0.1-6-next.0", "docusaurus-plugin-sentry": "1.0.0", "docusaurus-plugin-typedoc": "latest", - "react": "17.0.2", "p-cancelable": "2.1.1", + "react": "17.0.2", "react-dom": "17.0.2", - "react-player": "2.11.0", "react-iframe": "1.8.5", + "react-player": "2.11.0", "react-twitter-widgets": "^1.10.0", "typedoc": "0.23.21", "typedoc-plugin-markdown": "3.13.6", diff --git a/website/sidebars.js b/website/sidebars.js index c08f051d5..8908d373e 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -3,95 +3,94 @@ module.exports = { // By default, Docusaurus generates a sidebar from the docs folder structure docs: [ { - type: "category", - label: "Introduction", + type: 'category', + label: 'Introduction', items: [ - "installation", - "what-is-verdaccio", - "cli", + 'installation', + 'what-is-verdaccio', + 'cli', { - type: "category", - label: "Setting up Verdaccio", - items: ["cli-registry", "setup-npm", "setup-yarn", "setup-pnpm"] + type: 'category', + label: 'Setting up Verdaccio', + items: ['cli-registry', 'setup-npm', 'setup-yarn', 'setup-pnpm'], }, - "who-is-using", - "best", - "docker", - "protect-your-dependencies", - "e2e", - "verdaccio-programmatically", - "security-policy", - "logo", - "third-party", + 'who-is-using', + 'best', + 'docker', + 'protect-your-dependencies', + 'e2e', + 'verdaccio-programmatically', + 'security-policy', + 'logo', + 'third-party', { - type: "category", - label: "Uses Cases", - items: ["caching", "linking-remote-registry"] + type: 'category', + label: 'Uses Cases', + items: ['caching', 'linking-remote-registry'], }, - "articles" - ] + 'articles', + ], }, { - type: "category", - label: "Features", + type: 'category', + label: 'Features', items: [ - "configuration", - "uplinks", - "packages", - "authentication", - "notifications", - "logger", - "webui" - ] + 'configuration', + 'uplinks', + 'packages', + 'authentication', + 'notifications', + 'logger', + 'webui', + ], }, { - type: "category", - label: "Server", + type: 'category', + label: 'Server', + items: ['server-configuration', 'reverse-proxy', 'ssl', 'windows', 'iss-server'], + }, + { + type: 'category', + label: 'Development', items: [ - "server-configuration", - "reverse-proxy", - "ssl", - "windows", - "iss-server" - ] + 'plugins', + 'dev-plugins', + { + type: 'link', + label: 'Search Plugins', + href: '/dev/plugins-search', + }, + { + type: 'category', + label: 'Dev Guides', + items: ['plugin-generator', 'plugin-auth', 'plugin-middleware', 'plugin-storage'], + }, + 'node-api', + ], }, { - type: "category", - label: "Development", + type: 'category', + label: 'DevOps', items: [ - "plugins", - "dev-plugins", + 'kubernetes', + 'ci', { - type: "category", - label: "Dev Guides", - items: ["plugin-generator", "plugin-auth", "plugin-middleware", "plugin-storage"] + type: 'category', + label: 'Cloud', + items: ['amazon'], }, - "node-api" - ] + { + type: 'category', + label: 'Tools', + items: ['ansible', 'puppet', 'chef'], + }, + ], }, { - type: "category", - label: "DevOps", - items: [ - "kubernetes", - "ci", - { - type: "category", - label: "Cloud", - items: ["amazon"] - }, - { - type: "category", - label: "Tools", - items: ["ansible", "puppet", "chef"] - }, - ] + type: 'category', + label: 'Guides', + items: ['aws'], }, - { - type: "category", - label: "Guides", - items: ["aws"] - } ], api: [ { @@ -100,9 +99,9 @@ module.exports = { items: [ { type: 'autogenerated', - dirName: 'api' - } - ] - } - ] + dirName: 'api', + }, + ], + }, + ], }; diff --git a/website/sidebarsCommunity.js b/website/sidebarsCommunity.js index 937e547ca..8f0bc4ff4 100644 --- a/website/sidebarsCommunity.js +++ b/website/sidebarsCommunity.js @@ -18,7 +18,7 @@ module.exports = { type: 'link', label: 'Watch us on YouTube', href: 'https://www.youtube.com/channel/UC5i20v6o7lSjXzAHOvatt0w', - }, + }, { type: 'link', label: 'Chat on Discord', @@ -38,6 +38,6 @@ module.exports = { type: 'link', label: 'LICENSE', href: 'https://github.com/verdaccio/verdaccio/blob/master/LICENSE', - }, + }, ], }; diff --git a/website/sidebarsDev.js b/website/sidebarsDev.js new file mode 100644 index 000000000..8adb230cc --- /dev/null +++ b/website/sidebarsDev.js @@ -0,0 +1,8 @@ +module.exports = { + community: [ + { + type: 'autogenerated', + dirName: '.', + }, + ], +}; diff --git a/website/sidebarsTalk.js b/website/sidebarsTalk.js index d72814968..fa524c1cd 100644 --- a/website/sidebarsTalk.js +++ b/website/sidebarsTalk.js @@ -8,6 +8,6 @@ module.exports = { type: 'link', label: 'Follow us on YouTube', href: 'https://www.youtube.com/channel/UC5i20v6o7lSjXzAHOvatt0w', - } + }, ], }; diff --git a/website/src/components/Contributors.tsx b/website/src/components/Contributors.tsx index 68886c5b7..edaab882c 100644 --- a/website/src/components/Contributors.tsx +++ b/website/src/components/Contributors.tsx @@ -1,6 +1,7 @@ import Translate from '@docusaurus/Translate'; -import Tooltip from '@mui/material/Tooltip'; -import ListItemSecondaryAction from '@mui/material/ListItemSecondaryAction'; +import EmojiEventsIcon from '@mui/icons-material/EmojiEvents'; +import MergeTypeIcon from '@mui/icons-material/MergeType'; +import StarIcon from '@mui/icons-material/Star'; import Badge from '@mui/material/Badge'; import Chip from '@mui/material/Chip'; import Dialog from '@mui/material/Dialog'; @@ -11,13 +12,12 @@ import IconButton from '@mui/material/IconButton'; import List from '@mui/material/List'; import ListItem from '@mui/material/ListItem'; import ListItemIcon from '@mui/material/ListItemIcon'; +import ListItemSecondaryAction from '@mui/material/ListItemSecondaryAction'; import ListItemText from '@mui/material/ListItemText'; +import Tooltip from '@mui/material/Tooltip'; import Typography from '@mui/material/Typography'; -import { makeStyles, withStyles } from '@mui/styles'; import { ThemeProvider, createTheme } from '@mui/material/styles'; -import EmojiEventsIcon from '@mui/icons-material/EmojiEvents'; -import MergeTypeIcon from '@mui/icons-material/MergeType'; -import StarIcon from '@mui/icons-material/Star'; +import { makeStyles, withStyles } from '@mui/styles'; import Layout from '@theme/Layout'; import React from 'react'; @@ -34,38 +34,8 @@ const theme = createTheme({ }, }); -const useStyles = makeStyles(({ theme }: { theme: any }) =>({ - '@global': { - // small: { - // width: theme.spacing(3), - // height: theme.spacing(3), - // }, - // medium: { - // width: theme.spacing(6), - // height: theme.spacing(6), - // }, - // large: { - // width: theme.spacing(12), - // height: theme.spacing(12), - // }, - // root: { - // width: '100%', - // maxWidth: 360, - // backgroundColor: theme.palette.background.paper, - // }, - // inline: { - // display: 'inline', - // }, - // starColor: { - // color: yellow[500], - // }, - // archived: { - // opacity: `0.4`, - // }, - // emojiEvent: { - // color: green[800], - // }, - }, +const useStyles = makeStyles(({ theme }: { theme: any }) => ({ + '@global': {}, })); const StyledBadge = withStyles(() => ({ @@ -100,7 +70,7 @@ const Contributors: React.FC = ({ data }): React.ReactElement const [user, setUser] = React.useState(null); const [open, setOpen] = React.useState(false); const classes = useStyles(); - const {contributors, repositories} = data; + const { contributors, repositories } = data; const handleClickOpen = (item) => { setUser(item); @@ -160,7 +130,7 @@ const Contributors: React.FC = ({ data }): React.ReactElement src={generateImage(userItem.node.userId)} alt={userItem.node.url} width="40px" - style={{borderRadius: '10px'}} + style={{ borderRadius: '10px' }} /> ); @@ -181,7 +151,7 @@ const Contributors: React.FC = ({ data }): React.ReactElement alt={user.node.url} className={classes.medium} width="40px" - style={{borderRadius: '10px'}} + style={{ borderRadius: '10px' }} /> @@ -201,7 +171,7 @@ const Contributors: React.FC = ({ data }): React.ReactElement
- {user.node.repositories.map(({name, contributions}) => { + {user.node.repositories.map(({ name, contributions }) => { const repo = repositories.find((repo) => repo.name === name); if (!repo) { return null; @@ -221,7 +191,7 @@ const Contributors: React.FC = ({ data }): React.ReactElement = ({ + url, + name, + category, + description, + downloads, + latest, + origin, +}): React.ReactElement => { + const theme = useTheme(); + const matches = useMediaQuery('(min-width:600px)'); + return ( +
+ + + + + } + /> + + + + + + {description} + + + + + + + + + + + + } + variant="outlined" + /> + + + + + + + + + + +
+ ); +}; + +export default AddonCard; diff --git a/website/src/components/EcosystemSearch/EcosystemSearch.tsx b/website/src/components/EcosystemSearch/EcosystemSearch.tsx new file mode 100644 index 000000000..f2475a472 --- /dev/null +++ b/website/src/components/EcosystemSearch/EcosystemSearch.tsx @@ -0,0 +1,54 @@ +import { ThemeProvider, createTheme } from '@mui/material/styles'; +import React from 'react'; +import { useState } from 'react'; + +import FilterControl from './FilterControl'; +import ToolList from './ToolList'; +import data from './addons.json'; +import { Filters } from './types'; + +const theme = createTheme({ + breakpoints: { + values: { + xs: 0, + sm: 450, + md: 996, + lg: 1600, + xl: 1800, + }, + }, + palette: { + primary: { + main: '#4B5E40', + }, + secondary: { + main: '#808a79', + }, + }, +}); + +const EcosystemSearch = (): React.ReactElement => { + const { addons, categories, origin } = data as any; + + const [filters, setFilters] = useState({ + bundled: true, + core: true, + community: true, + middleware: true, + storage: true, + tool: true, + ui: true, + authentication: true, + filter: true, + keyword: '', + }); + + return ( + + + + + ); +}; + +export default EcosystemSearch; diff --git a/website/src/components/EcosystemSearch/FilterControl.tsx b/website/src/components/EcosystemSearch/FilterControl.tsx new file mode 100644 index 000000000..dda191744 --- /dev/null +++ b/website/src/components/EcosystemSearch/FilterControl.tsx @@ -0,0 +1,145 @@ +import Translate, { translate } from '@docusaurus/Translate'; +import Alert from '@mui/material/Alert'; +import Card from '@mui/material/Card'; +import Checkbox from '@mui/material/Checkbox'; +import FormControlLabel from '@mui/material/FormControlLabel'; +import FormGroup from '@mui/material/FormGroup'; +import Switch from '@mui/material/Switch'; +import TextField from '@mui/material/TextField'; +import Typography from '@mui/material/Typography'; +import Grid from '@mui/material/Unstable_Grid2'; +import { useTheme } from '@mui/material/styles'; +import React, { ReactElement, useState } from 'react'; +import { FC } from 'react'; + +import { Category, Filters, Origin } from './types'; + +type Props = { + categories: Category[]; + origins: Origin[]; + onChange: (filters) => void; +}; + +const FilterControl: FC = ({ categories, origins, onChange }): ReactElement => { + const theme = useTheme(); + const [filters, setFilters] = useState({ + bundled: true, + core: true, + community: true, + middleware: true, + storage: true, + tool: true, + ui: true, + authentication: true, + filter: true, + keyword: '', + }); + + const handleOnChange = (event) => { + const { name } = event.target; + let _filters = { ...filters }; + const validation = [...origins, ...categories, 'bundled', 'keyword']; + if (!validation.includes(name)) { + return; + } + if (name !== 'keyword') { + _filters = { ..._filters, [name]: event.target.checked }; + } else { + _filters = { ..._filters, keyword: event.target.value }; + } + + onChange(_filters); + setFilters(_filters); + }; + + return ( + + + Search Plugins / Tools + + + Items qualified as core are maintained actively by the verdaccio team + + + + + + + + Origin + + + {Object.values(origins).map((name) => ( + + } + label={name} + /> + ))} + + + + + Categories + + + {Object.values(categories).map((name) => ( + + } + label={name} + /> + ))} + + + + + Options + + + + } + label="Bundled" + /> + + + + + ); +}; + +export default FilterControl; diff --git a/website/src/components/EcosystemSearch/Icon.tsx b/website/src/components/EcosystemSearch/Icon.tsx new file mode 100644 index 000000000..61db87aa2 --- /dev/null +++ b/website/src/components/EcosystemSearch/Icon.tsx @@ -0,0 +1,29 @@ +import AltRouteIcon from '@mui/icons-material/AltRoute'; +import ColorLensIcon from '@mui/icons-material/ColorLens'; +import FilterAltIcon from '@mui/icons-material/FilterAlt'; +import HandymanIcon from '@mui/icons-material/Handyman'; +import HubIcon from '@mui/icons-material/Hub'; +import SecurityIcon from '@mui/icons-material/Security'; +import StorageIcon from '@mui/icons-material/Storage'; +import * as React from 'react'; +import { FC } from 'react'; + +const Icon: FC<{ category: string }> = ({ category }): React.ReactElement => { + if (category === 'middleware') { + return ; + } else if (category === 'storage') { + return ; + } else if (category === 'tool') { + return ; + } else if (category === 'filter') { + return ; + } else if (category === 'authentication') { + return ; + } else if (category === 'ui') { + return ; + } + + return ; +}; + +export default Icon; diff --git a/website/src/components/EcosystemSearch/ToolList.tsx b/website/src/components/EcosystemSearch/ToolList.tsx new file mode 100644 index 000000000..9d99d68ea --- /dev/null +++ b/website/src/components/EcosystemSearch/ToolList.tsx @@ -0,0 +1,101 @@ +import Translate, { translate } from '@docusaurus/Translate'; +import { create, insertBatch, search } from '@lyrasearch/lyra'; +import Typography from '@mui/material/Typography'; +import Grid from '@mui/material/Unstable_Grid2'; +import { useTheme } from '@mui/material/styles'; +import * as React from 'react'; +import { useState } from 'react'; +import { useEffect } from 'react'; +import { FC } from 'react'; + +import AddonCard from './AddonCard'; +import { Addon, Filters } from './types'; + +type Props = { + addons: Addon[]; + filters: Filters; +}; + +const db = create({ + schema: { + name: 'string', + url: 'string', + category: 'string', + bundled: 'boolean', + origin: 'string', + latest: 'string', + downloads: 'number', + description: 'string', + }, +}); + +const normalizeResults = (hits) => { + return hits.reduce((acc, item) => { + acc.push(item.document); + return acc; + }, []); +}; + +const filterByProperty = (addsOns: Addon[], filters: Filters) => { + console.log('filters', filters); + const filtered = addsOns.filter((item) => { + console.log('item', item.name); + + return ( + (item.origin === 'core' && filters.core) || + (item.origin === 'community' && filters.community) || + (item.category === 'authentication' && filters.authentication) || + (item.category === 'filter' && filters.filter) || + (item.category === 'ui' && filters.ui) || + (item.category === 'middleware' && filters.middleware) || + (item.category === 'tool' && filters.tool) || + (item.category === 'storage' && filters.storage) || + (item.bundled && filters.bundled) + ); + }); + return filtered; +}; + +const ToolList: FC = ({ addons = [], filters }): React.ReactElement => { + const theme = useTheme(); + const [filteredAddsOn, setFilteredAddsOn] = useState(addons); + useEffect(() => { + insertBatch(db, addons); + }, []); + + useEffect(() => { + let results: Addon[] = addons; + if (filters.keyword !== '') { + const dbResults = search(db, { + term: filters.keyword, + }); + results = [...normalizeResults(dbResults.hits)]; + } + // TODO: apply advanced filters later + // setFilteredAddsOn(filterByProperty(results, filters)); + setFilteredAddsOn(results); + }, [filters, addons]); + + return ( +
+ + Total results: {filteredAddsOn.length} + + + {filteredAddsOn.map((item) => { + return ( + + + + ); + })} + +
+ ); +}; + +export default ToolList; diff --git a/website/src/components/EcosystemSearch/addons.json b/website/src/components/EcosystemSearch/addons.json new file mode 100644 index 000000000..8887c109d --- /dev/null +++ b/website/src/components/EcosystemSearch/addons.json @@ -0,0 +1,1193 @@ +{ + "categories": ["middleware", "authentication", "filter", "storage", "ui", "tool"], + "origin": ["core", "community"], + "addons": [ + { + "name": "verdaccio-audit", + "url": "https://www.npmjs.org/verdaccio-audit", + "category": "middleware", + "origin": "core", + "bundled": true, + "description": "Verdaccio Middleware plugin to bypass npmjs audit", + "latest": "10.2.3", + "downloads": 443259, + "registry": "https://registry.npmjs.org/verdaccio-audit" + }, + { + "name": "@verdaccio/local-storage", + "url": "https://www.npmjs.org/@verdaccio/local-storage", + "category": "storage", + "origin": "core", + "bundled": true, + "description": "Local storage implementation", + "latest": "10.3.1", + "downloads": 438524, + "registry": "https://registry.npmjs.org/@verdaccio/local-storage" + }, + { + "name": "@verdaccio/ui-theme", + "url": "https://www.npmjs.org/@verdaccio/ui-theme", + "category": "ui", + "origin": "core", + "bundled": true, + "description": "Verdaccio User Interface", + "latest": "3.4.1", + "downloads": 431799, + "registry": "https://registry.npmjs.org/@verdaccio/ui-theme" + }, + { + "name": "verdaccio-memory", + "url": "https://www.npmjs.org/verdaccio-memory", + "category": "authentication", + "origin": "core", + "bundled": false, + "description": "Storage implementation in memory", + "latest": "10.3.0", + "downloads": 17780, + "registry": "https://registry.npmjs.org/verdaccio-memory" + }, + { + "name": "verdaccio-aws-s3-storage", + "url": "https://www.npmjs.org/verdaccio-aws-s3-storage", + "category": "authentication", + "origin": "core", + "bundled": false, + "description": "AWS S3 storage implementation for Verdaccio", + "latest": "10.3.0", + "downloads": 6324, + "registry": "https://registry.npmjs.org/verdaccio-aws-s3-storage" + }, + { + "name": "verdaccio-google-cloud", + "url": "https://www.npmjs.org/verdaccio-google-cloud", + "category": "storage", + "origin": "core", + "bundled": false, + "description": "Google Cloud storage implementation for Verdaccio", + "latest": "10.2.0", + "downloads": 133, + "registry": "https://registry.npmjs.org/verdaccio-google-cloud" + }, + { + "name": "verdaccio-auth-memory", + "url": "https://www.npmjs.org/verdaccio-auth-memory", + "category": "authentication", + "origin": "core", + "bundled": false, + "description": "Auth plugin for Verdaccio that keeps users in memory", + "latest": "10.2.0", + "downloads": 65636, + "registry": "https://registry.npmjs.org/verdaccio-auth-memory" + }, + { + "name": "verdaccio-htpasswd", + "url": "https://www.npmjs.org/verdaccio-htpasswd", + "category": "authentication", + "origin": "core", + "bundled": true, + "description": "htpasswd auth plugin for Verdaccio", + "latest": "10.5.1", + "downloads": 448211, + "registry": "https://registry.npmjs.org/verdaccio-htpasswd" + }, + { + "name": "verdaccio-plugin-secfilter", + "url": "https://www.npmjs.org/verdaccio-plugin-secfilter", + "category": "filter", + "origin": "community", + "bundled": false, + "description": "plugin for filtering packages with security purposes", + "latest": "1.0.1", + "downloads": 14, + "registry": "https://registry.npmjs.org/verdaccio-plugin-secfilter" + }, + { + "name": "verdaccio-ldap-port", + "url": "https://www.npmjs.org/verdaccio-ldap-port", + "category": "filter", + "origin": "community", + "bundled": false, + "description": "a port of the verdaccio-ldap to version 5", + "latest": "1.0.1", + "downloads": 15, + "registry": "https://registry.npmjs.org/verdaccio-ldap-port" + }, + { + "name": "@playerdata/verdaccio-storage-expiry", + "description": "A plugin to automatically remove packages not used recently", + "url": "https://www.npmjs.org/@playerdata/verdaccio-storage-expiry", + "bundled": false, + "origin": "community", + "category": "authentication", + "latest": "1.2.2", + "downloads": 26, + "registry": "https://registry.npmjs.org/@playerdata/verdaccio-storage-expiry" + }, + { + "name": "verdaccio-ldap-memcached", + "description": "LDAP auth plugin for verdaccio", + "url": "https://www.npmjs.org/verdaccio-ldap-memcached", + "bundled": false, + "origin": "community", + "category": "authentication", + "latest": "1.4.1", + "downloads": 8, + "registry": "https://registry.npmjs.org/verdaccio-ldap-memcached" + }, + { + "name": "verdaccio-bitbucket", + "description": "Verdaccio module to authenticate users via Bitbucket", + "url": "https://www.npmjs.org/verdaccio-bitbucket", + "bundled": false, + "origin": "community", + "category": "authentication", + "latest": "3.0.1", + "downloads": 17, + "registry": "https://registry.npmjs.org/verdaccio-bitbucket" + }, + { + "name": "verdaccio-redis-search-patch", + "description": "The middleware overrides v1/search endpoint with a redis search based backend for verdaccio@5 and verdaccio-redis-storage", + "url": "https://www.npmjs.org/verdaccio-redis-search-patch", + "bundled": false, + "origin": "community", + "category": "authentication", + "latest": "1.0.0", + "downloads": 8, + "registry": "https://registry.npmjs.org/verdaccio-redis-search-patch" + }, + { + "name": "verdaccio-auther-memory", + "description": "Verdaccio Auth Plugin with 2FA", + "url": "https://www.npmjs.org/verdaccio-auther-memory", + "bundled": false, + "origin": "community", + "category": "authentication", + "latest": "2.0.6", + "downloads": 10, + "registry": "https://registry.npmjs.org/verdaccio-auther-memory" + }, + { + "name": "verdaccio-git", + "description": "Publish packages to git repositories.", + "url": "https://www.npmjs.org/verdaccio-git", + "bundled": false, + "origin": "community", + "category": "authentication", + "latest": "0.1.68", + "downloads": 25, + "registry": "https://registry.npmjs.org/verdaccio-git" + }, + { + "name": "verdaccio-ldap", + "description": "LDAP auth plugin for verdaccio", + "url": "https://www.npmjs.org/verdaccio-ldap", + "bundled": false, + "origin": "community", + "category": "authentication", + "latest": "6.0.0", + "downloads": 935, + "registry": "https://registry.npmjs.org/verdaccio-ldap" + }, + { + "name": "verdaccio-ldap-node", + "description": "LDAP plugin for Verdaccio with ldapjs", + "url": "https://www.npmjs.org/verdaccio-ldap-node", + "bundled": false, + "origin": "community", + "category": "authentication", + "latest": "1.0.6", + "downloads": 11, + "registry": "https://registry.npmjs.org/verdaccio-ldap-node" + }, + { + "name": "verdaccio-badger", + "description": "verdaccio middleware plugin to serve svg badges", + "url": "https://www.npmjs.org/verdaccio-badger", + "bundled": false, + "origin": "community", + "category": "authentication", + "latest": "1.0.0", + "downloads": 4, + "registry": "https://registry.npmjs.org/verdaccio-badger" + }, + { + "name": "@hamstudy/verdaccio-aws-s3-storage-sse", + "description": "AWS S3 storage implementation for Verdaccio - fork that adds support for SSE-C, SSE-S3, and AWS:KMS", + "url": "https://www.npmjs.org/@hamstudy/verdaccio-aws-s3-storage-sse", + "bundled": false, + "origin": "community", + "category": "authentication", + "latest": "10.3.2", + "downloads": 2, + "registry": "https://registry.npmjs.org/@hamstudy/verdaccio-aws-s3-storage-sse" + }, + { + "name": "@xlts.dev/verdaccio-prometheus-middleware", + "description": "Verdaccio middleware plugin used to collect prometheus compatible metrics", + "url": "https://www.npmjs.org/@xlts.dev/verdaccio-prometheus-middleware", + "bundled": false, + "origin": "community", + "category": "authentication", + "latest": "2.0.2", + "downloads": 11, + "registry": "https://registry.npmjs.org/@xlts.dev/verdaccio-prometheus-middleware" + }, + { + "name": "verdaccio-github-auth", + "description": "Verdaccio Github Authentication Plugin", + "url": "https://www.npmjs.org/verdaccio-github-auth", + "bundled": false, + "origin": "community", + "category": "authentication", + "latest": "1.0.5", + "downloads": 13, + "registry": "https://registry.npmjs.org/verdaccio-github-auth" + }, + { + "name": "verdaccio-gitlab", + "description": "private npm registry (Verdaccio) using gitlab-ce as authentication and authorization provider", + "url": "https://www.npmjs.org/verdaccio-gitlab", + "bundled": false, + "origin": "community", + "category": "authentication", + "latest": "3.0.1", + "downloads": 23, + "registry": "https://registry.npmjs.org/verdaccio-gitlab" + }, + { + "name": "verdaccio-bitbucket-server", + "description": "Verdaccio Authentication Plugin via Bitbucket Server", + "url": "https://www.npmjs.org/verdaccio-bitbucket-server", + "bundled": false, + "origin": "community", + "category": "authentication", + "latest": "1.3.4", + "downloads": 20, + "registry": "https://registry.npmjs.org/verdaccio-bitbucket-server" + }, + { + "name": "verdaccio-package-count", + "description": "An amazing verdaccio plugin", + "url": "https://www.npmjs.org/verdaccio-package-count", + "bundled": false, + "origin": "community", + "category": "authentication", + "latest": "1.0.1", + "downloads": 232, + "registry": "https://registry.npmjs.org/verdaccio-package-count" + }, + { + "name": "verdaccio-activedirectory", + "description": "Active Directory authentication plugin for verdaccio", + "url": "https://www.npmjs.org/verdaccio-activedirectory", + "bundled": false, + "origin": "community", + "category": "authentication", + "latest": "1.0.2", + "downloads": 87, + "registry": "https://registry.npmjs.org/verdaccio-activedirectory" + }, + { + "name": "verdaccio-profile-api", + "description": "npm profile API implementaion for Verdaccio 2.x", + "url": "https://www.npmjs.org/verdaccio-profile-api", + "bundled": false, + "origin": "community", + "category": "authentication", + "latest": "0.2.7", + "downloads": 4, + "registry": "https://registry.npmjs.org/verdaccio-profile-api" + }, + { + "name": "verdaccio-dynamodb", + "description": "Verdaccio DynamoDB Auth Plugin", + "url": "https://www.npmjs.org/verdaccio-dynamodb", + "bundled": false, + "origin": "community", + "category": "authentication", + "latest": "1.1.8", + "downloads": 2, + "registry": "https://registry.npmjs.org/verdaccio-dynamodb" + }, + { + "name": "verdaccio-minio", + "description": "A verdaccio plugin for storing data in Minio", + "url": "https://www.npmjs.org/verdaccio-minio", + "bundled": false, + "origin": "community", + "category": "authentication", + "latest": "0.2.5", + "downloads": 126, + "registry": "https://registry.npmjs.org/verdaccio-minio" + }, + { + "name": "verdaccio-redis-storage", + "description": "A Redis based storage plugin for Verdaccio.", + "url": "https://www.npmjs.org/verdaccio-redis-storage", + "bundled": false, + "origin": "community", + "category": "authentication", + "latest": "1.2.3", + "downloads": 59, + "registry": "https://registry.npmjs.org/verdaccio-redis-storage" + }, + { + "name": "verdaccio-mongodb", + "description": "MongoDB Authentication plugin for Verdaccio", + "url": "https://www.npmjs.org/verdaccio-mongodb", + "bundled": false, + "origin": "community", + "category": "authentication", + "latest": "1.2.0", + "downloads": 8, + "registry": "https://registry.npmjs.org/verdaccio-mongodb" + }, + { + "name": "verdaccio-ldap5", + "description": "a port of the verdaccio-ldap to version 5", + "url": "https://www.npmjs.org/verdaccio-ldap5", + "bundled": false, + "origin": "community", + "category": "authentication", + "latest": "1.0.0", + "downloads": 2, + "registry": "https://registry.npmjs.org/verdaccio-ldap5" + }, + { + "name": "@m03geek/verdaccio-google-cloud", + "bundled": false, + "origin": "community", + "category": "storage", + "description": "verdaccio storage plugin implementation for google cloud", + "url": "https://www.npmjs.org/@m03geek/verdaccio-google-cloud", + "registry": "https://registry.npmjs.org/@m03geek/verdaccio-google-cloud", + "latest": "0.1.0", + "downloads": 3 + }, + { + "name": "verdaccio-storage-proxy", + "bundled": false, + "origin": "community", + "category": "storage", + "description": "A verdaccio storage proxy to decouple database, search, packument, and tarball accesses.", + "url": "https://www.npmjs.org/verdaccio-storage-proxy", + "registry": "https://registry.npmjs.org/verdaccio-storage-proxy", + "latest": "0.0.11", + "downloads": 13 + }, + { + "name": "verdaccio-local-storage-advance", + "bundled": false, + "origin": "community", + "category": "storage", + "description": "An amazing verdaccio plugin", + "url": "https://www.npmjs.org/verdaccio-local-storage-advance", + "registry": "https://registry.npmjs.org/verdaccio-local-storage-advance", + "latest": "0.0.10", + "downloads": 3 + }, + { + "name": "verdaccio-kuzzle", + "bundled": false, + "origin": "authentication", + "category": "storage", + "description": "Authenticate on verdaccio using kuzzle credentials", + "url": "https://www.npmjs.org/verdaccio-kuzzle", + "registry": "https://registry.npmjs.org/verdaccio-kuzzle", + "latest": "1.0.9", + "downloads": 13 + }, + { + "name": "verdaccio-dist-tag-control", + "bundled": false, + "origin": "community", + "category": "middleware", + "description": "Verdaccio plugin to control permission of publish dist-tag", + "url": "https://www.npmjs.org/verdaccio-dist-tag-control", + "registry": "https://registry.npmjs.org/verdaccio-dist-tag-control", + "latest": "1.0.2", + "downloads": 5 + }, + { + "name": "verdaccio-doreamon-oauth2", + "bundled": false, + "origin": "community", + "category": "authentication", + "description": "A GitLab OAuth Plugin for [Verdaccio](https://www.verdaccio.org)", + "url": "https://www.npmjs.org/verdaccio-doreamon-oauth2", + "registry": "https://registry.npmjs.org/verdaccio-doreamon-oauth2", + "latest": "1.2.0", + "downloads": 11 + }, + { + "name": "@outcome-co/verdaccio-google-cloud", + "bundled": false, + "origin": "community", + "category": "storage", + "description": "Enhancements to the Verdaccio Google Cloud storage plugin", + "url": "https://www.npmjs.org/@outcome-co/verdaccio-google-cloud", + "registry": "https://registry.npmjs.org/@outcome-co/verdaccio-google-cloud", + "latest": "1.1.8", + "downloads": 13 + }, + { + "name": "verdaccio-pg-storage", + "bundled": false, + "origin": "community", + "category": "storage", + "description": "Storage plugin to host packages PostgreSQL", + "url": "https://www.npmjs.org/verdaccio-pg-storage", + "registry": "https://registry.npmjs.org/verdaccio-pg-storage", + "latest": "1.0.3", + "downloads": 2 + }, + { + "name": "verdaccio-local-storage-with-cache-db", + "bundled": false, + "origin": "community", + "category": "storage", + "description": "Local storage implementation", + "url": "https://www.npmjs.org/verdaccio-local-storage-with-cache-db", + "registry": "https://registry.npmjs.org/verdaccio-local-storage-with-cache-db", + "latest": "9.7.7", + "downloads": 3 + }, + { + "name": "verdaccio-offline-storage", + "bundled": false, + "origin": "community", + "category": "storage", + "description": "Local package cache as first class citizen.", + "url": "https://www.npmjs.org/verdaccio-offline-storage", + "registry": "https://registry.npmjs.org/verdaccio-offline-storage", + "latest": "2.0.0", + "downloads": 116 + }, + { + "name": "verdaccio-aliyunoss-storage", + "bundled": false, + "origin": "community", + "category": "storage", + "description": "Aliyun OSS storage implementation for Verdaccio", + "url": "https://www.npmjs.org/verdaccio-aliyunoss-storage", + "registry": "https://registry.npmjs.org/verdaccio-aliyunoss-storage", + "latest": "1.0.10", + "downloads": 4 + }, + { + "name": "verdaccio-openid-connect", + "bundled": false, + "origin": "community", + "category": "authentication", + "description": "Verdaccio authentication plugin for OpenID Connect. When installed, `npm login --registry ...` command will open the browser to start login flow.", + "url": "https://www.npmjs.org/verdaccio-openid-connect", + "registry": "https://registry.npmjs.org/verdaccio-openid-connect", + "latest": "1.4.0", + "downloads": 45 + }, + { + "name": "verdaccio-github-oauth-ui", + "bundled": false, + "origin": "community", + "category": "authentication", + "description": "

📦🔐 Verdaccio GitHub OAuth

", + "url": "https://www.npmjs.org/verdaccio-github-oauth-ui", + "registry": "https://registry.npmjs.org/verdaccio-github-oauth-ui", + "latest": "5.0.4", + "downloads": 471 + }, + { + "name": "verdaccio-github-oauth", + "bundled": false, + "origin": "community", + "category": "authentication", + "description": "authentication plugin for verdaccio, supporting github oauth web flow", + "url": "https://www.npmjs.org/verdaccio-github-oauth", + "registry": "https://registry.npmjs.org/verdaccio-github-oauth", + "latest": "1.1.0", + "downloads": 98 + }, + { + "name": "verdaccio-auth-gitlab", + "bundled": false, + "origin": "community", + "category": "authentication", + "description": "Verdaccio authentication plugin by gitlab personal access token or oauth token or ci job token.", + "url": "https://www.npmjs.org/verdaccio-auth-gitlab", + "registry": "https://registry.npmjs.org/verdaccio-auth-gitlab", + "latest": "2.0.0-beta.11", + "downloads": 298 + }, + { + "name": "verdaccio-auth0-ui", + "bundled": false, + "origin": "community", + "category": "authentication", + "description": "

📦🔐 Verdaccio Auth0 Connect - With UI Support

", + "url": "https://www.npmjs.org/verdaccio-auth0-ui", + "registry": "https://registry.npmjs.org/verdaccio-auth0-ui", + "latest": "3.0.0", + "downloads": 25 + }, + { + "name": "verdaccio-tagauth", + "bundled": false, + "origin": "community", + "category": "authentication", + "description": "Additional permission settings based on dist-tags", + "url": "https://www.npmjs.org/verdaccio-tagauth", + "registry": "https://registry.npmjs.org/verdaccio-tagauth", + "latest": "0.0.1", + "downloads": 7 + }, + { + "name": "verdaccio-gitea-auth", + "bundled": false, + "origin": "community", + "category": "authentication", + "description": "It's an [authentication plugin for Verdaccio](https://verdaccio.org/docs/en/plugins) private node module registry that checks your [Gitea](https://gitea.io) private git server for user authentication.", + "url": "https://www.npmjs.org/verdaccio-gitea-auth", + "registry": "https://registry.npmjs.org/verdaccio-gitea-auth", + "latest": "0.1.4", + "downloads": 4 + }, + { + "name": "verdaccio-platformatic-auth", + "bundled": false, + "origin": "community", + "category": "authentication", + "description": "Invite only authorisation", + "url": "https://www.npmjs.org/verdaccio-platformatic-auth", + "registry": "https://registry.npmjs.org/verdaccio-platformatic-auth", + "latest": "0.0.4", + "downloads": 11 + }, + { + "name": "verdaccio-google-oauth", + "bundled": false, + "origin": "community", + "category": "authentication", + "description": "

📦🔐 Verdaccio Google OAuth - With UI Support

", + "url": "https://www.npmjs.org/verdaccio-google-oauth", + "registry": "https://registry.npmjs.org/verdaccio-google-oauth", + "latest": "1.0.1", + "downloads": 31 + }, + { + "name": "verdaccio-passport-google-oauth-ui", + "bundled": false, + "origin": "community", + "category": "authentication", + "description": "

📦🔐 Verdaccio GitHub OAuth

", + "url": "https://www.npmjs.org/verdaccio-passport-google-oauth-ui", + "registry": "https://registry.npmjs.org/verdaccio-passport-google-oauth-ui", + "latest": "0.0.9", + "downloads": 18 + }, + { + "name": "verdaccio-aukilabs-npm-auth", + "bundled": false, + "origin": "community", + "category": "authentication", + "description": "verify authentication to aukilabs npm registry", + "url": "https://www.npmjs.org/verdaccio-aukilabs-npm-auth", + "registry": "https://registry.npmjs.org/verdaccio-aukilabs-npm-auth", + "latest": "0.0.2", + "downloads": 5 + }, + { + "name": "verdaccio-gitlab-hilio", + "bundled": false, + "origin": "community", + "category": "authentication", + "description": "private npm registry (Verdaccio) using gitlab-ce as authentication and authorization provider", + "url": "https://www.npmjs.org/verdaccio-gitlab-hilio", + "registry": "https://registry.npmjs.org/verdaccio-gitlab-hilio", + "latest": "1.1.17", + "downloads": 22 + }, + { + "name": "verdaccio-auth-knex", + "bundled": false, + "origin": "community", + "category": "authentication", + "description": "a verdaccio authentication plugin support databases like mysql, postgresql, sqlite3, mssql", + "url": "https://www.npmjs.org/verdaccio-auth-knex", + "registry": "https://registry.npmjs.org/verdaccio-auth-knex", + "latest": "1.0.3", + "downloads": 2 + }, + { + "name": "verdaccio-qnapldap", + "bundled": false, + "origin": "community", + "category": "authentication", + "description": "verdaccio authentication using the built-in LDAP server on a QNAP NAS machine, via ldapjs - a purejs implementation of LDAP", + "url": "https://www.npmjs.org/verdaccio-qnapldap", + "registry": "https://registry.npmjs.org/verdaccio-qnapldap", + "latest": "0.0.6", + "downloads": 3 + }, + { + "name": "verdaccio-fast-ldap", + "bundled": false, + "origin": "community", + "category": "authentication", + "description": "LDAP auth plugin for verdaccio fixed bcrypt", + "url": "https://www.npmjs.org/verdaccio-fast-ldap", + "registry": "https://registry.npmjs.org/verdaccio-fast-ldap", + "latest": "4.2.1", + "downloads": 5 + }, + { + "name": "verdaccio-gitlab-oauth", + "bundled": false, + "origin": "community", + "category": "authentication", + "description": "A GitLab OAuth Plugin for [Verdaccio](https://www.verdaccio.org)", + "url": "https://www.npmjs.org/verdaccio-gitlab-oauth", + "registry": "https://registry.npmjs.org/verdaccio-gitlab-oauth", + "latest": "1.0.4", + "downloads": 22 + }, + { + "name": "verdaccio-group-htpasswd", + "bundled": false, + "origin": "community", + "category": "authentication", + "description": "Custom auth plugin", + "url": "https://www.npmjs.org/verdaccio-group-htpasswd", + "registry": "https://registry.npmjs.org/verdaccio-group-htpasswd", + "latest": "1.0.0", + "downloads": 3 + }, + { + "name": "verdaccio-groups", + "bundled": false, + "origin": "community", + "category": "authentication", + "description": "Verdaccio Plugin to grant access to group names provided in the file", + "url": "https://www.npmjs.org/verdaccio-groups", + "registry": "https://registry.npmjs.org/verdaccio-groups", + "latest": "1.2.0", + "downloads": 48 + }, + { + "name": "verdaccio-github-token", + "bundled": false, + "origin": "community", + "category": "authentication", + "description": "Verdaccio authentication plugin over github personal access tokens", + "url": "https://www.npmjs.org/verdaccio-github-token", + "registry": "https://registry.npmjs.org/verdaccio-github-token", + "latest": "1.0.0", + "downloads": 2 + }, + { + "name": "verdaccio-mysql", + "bundled": false, + "origin": "community", + "category": "authentication", + "description": "Verdaccio MySQL authentication plugin", + "url": "https://www.npmjs.org/verdaccio-mysql", + "registry": "https://registry.npmjs.org/verdaccio-mysql", + "latest": "1.0.1", + "downloads": 4 + }, + { + "name": "verdaccio-qlchatauth", + "bundled": false, + "origin": "community", + "category": "authentication", + "description": "An amazing verdaccio plugin", + "url": "https://www.npmjs.org/verdaccio-qlchatauth", + "registry": "https://registry.npmjs.org/verdaccio-qlchatauth", + "latest": "0.0.9", + "downloads": 7 + }, + { + "name": "verdaccio-azure-ad-login", + "bundled": false, + "origin": "community", + "category": "authentication", + "description": "Let your users authenticate into Verdaccio using Azure AD OAuth", + "url": "https://www.npmjs.org/verdaccio-azure-ad-login", + "registry": "https://registry.npmjs.org/verdaccio-azure-ad-login", + "latest": "1.1.1", + "downloads": 26 + }, + { + "name": "verdaccio-oidc", + "bundled": false, + "origin": "community", + "category": "authentication", + "description": "OpenID Connect authentication plugin for Verdaccio", + "url": "https://www.npmjs.org/verdaccio-oidc", + "registry": "https://registry.npmjs.org/verdaccio-oidc", + "latest": "0.0.0-namesquat", + "downloads": 2 + }, + { + "name": "verdaccio-regman", + "bundled": false, + "origin": "community", + "category": "authentication", + "description": "An amazing verdaccio auth plugin", + "url": "https://www.npmjs.org/verdaccio-regman", + "registry": "https://registry.npmjs.org/verdaccio-regman", + "latest": "1.0.5", + "downloads": 15 + }, + { + "name": "verdaccio-level-auth", + "bundled": false, + "origin": "community", + "category": "authentication", + "description": "A verdaccio plugin that uses level(a LevelDB wrapper) to store and authenticate user credentials", + "url": "https://www.npmjs.org/verdaccio-level-auth", + "registry": "https://registry.npmjs.org/verdaccio-level-auth", + "latest": "1.0.12", + "downloads": 9 + }, + { + "name": "verdaccio-activedirectory-extended", + "bundled": false, + "origin": "community", + "category": "authentication", + "description": "Extended Active Directory authentication plugin for verdaccio", + "url": "https://www.npmjs.org/verdaccio-activedirectory-extended", + "registry": "https://registry.npmjs.org/verdaccio-activedirectory-extended", + "latest": "1.4.3", + "downloads": 6 + }, + { + "name": "verdaccio-acl-plugin", + "bundled": false, + "origin": "community", + "category": "authentication", + "description": "Plugin to simplify group permissions management", + "url": "https://www.npmjs.org/verdaccio-acl-plugin", + "registry": "https://registry.npmjs.org/verdaccio-acl-plugin", + "latest": "1.0.1", + "downloads": 2 + }, + { + "name": "verdaccio-auth-bearer", + "bundled": false, + "origin": "community", + "category": "authentication", + "description": "A fork from sinopia-request", + "url": "https://www.npmjs.org/verdaccio-auth-bearer", + "registry": "https://registry.npmjs.org/verdaccio-auth-bearer", + "latest": "2.5.0", + "downloads": 5 + }, + { + "name": "verdaccio-steedos", + "bundled": false, + "origin": "community", + "category": "authentication", + "description": "An amazing verdaccio plugin", + "url": "https://www.npmjs.org/verdaccio-steedos", + "registry": "https://registry.npmjs.org/verdaccio-steedos", + "latest": "1.0.0", + "downloads": 2 + }, + { + "name": "verdaccio-sqlite", + "bundled": false, + "origin": "community", + "category": "authentication", + "description": "Verdaccio SQLite authentication plugin", + "url": "https://www.npmjs.org/verdaccio-sqlite", + "registry": "https://registry.npmjs.org/verdaccio-sqlite", + "latest": "1.0.2", + "downloads": 5 + }, + { + "name": "verdaccio-sqlite", + "bundled": false, + "origin": "community", + "category": "authentication", + "description": "Verdaccio SQLite authentication plugin", + "url": "https://www.npmjs.org/verdaccio-sqlite", + "registry": "https://registry.npmjs.org/verdaccio-sqlite", + "latest": "1.0.2", + "downloads": 5 + }, + { + "name": "verdaccio-simplegroup", + "bundled": false, + "origin": "community", + "category": "authentication", + "description": "verdaccio plugin authority", + "url": "https://www.npmjs.org/verdaccio-simplegroup", + "registry": "https://registry.npmjs.org/verdaccio-simplegroup", + "latest": "1.0.2", + "downloads": 8 + }, + { + "name": "verdaccio-betaversion", + "bundled": false, + "origin": "community", + "category": "authentication", + "description": "Verdaccio Plugin to allow access/publish npm modules based on a package version", + "url": "https://www.npmjs.org/verdaccio-betaversion", + "registry": "https://registry.npmjs.org/verdaccio-betaversion", + "latest": "1.0.3", + "downloads": 2 + }, + { + "name": "verdaccio-auth-username", + "bundled": false, + "origin": "community", + "category": "authentication", + "description": "verdaccio auth plugin for user list authentication", + "url": "https://www.npmjs.org/verdaccio-auth-username", + "registry": "https://registry.npmjs.org/verdaccio-auth-username", + "latest": "1.1.2", + "downloads": 14 + }, + { + "name": "verdaccio-apm-login", + "bundled": false, + "origin": "community", + "category": "authentication", + "description": "authentication plugin for verdaccio, supporting github oauth web flow", + "url": "https://www.npmjs.org/verdaccio-apm-login", + "registry": "https://registry.npmjs.org/verdaccio-apm-login", + "latest": "1.0.6", + "downloads": 2 + }, + { + "name": "verdaccio-auth-stack", + "bundled": false, + "origin": "community", + "category": "authentication", + "description": "A Verdaccio Auth Plugin configured for TeamStack", + "url": "https://www.npmjs.org/verdaccio-auth-stack", + "registry": "https://registry.npmjs.org/verdaccio-auth-stack", + "latest": "1.0.3", + "downloads": 5 + }, + { + "name": "verdaccio-auth-capi", + "bundled": false, + "origin": "community", + "category": "authentication", + "description": "A Verdaccio Auth Plugin configured for CAPI", + "url": "https://www.npmjs.org/verdaccio-auth-capi", + "registry": "https://registry.npmjs.org/verdaccio-auth-capi", + "latest": "1.0.2", + "downloads": 3 + }, + { + "name": "verdaccio-groupnames", + "bundled": false, + "origin": "community", + "category": "authentication", + "description": "Verdaccio Plugins to grant access to group names based on the groups calculated in the authentication", + "url": "https://www.npmjs.org/verdaccio-groupnames", + "registry": "https://registry.npmjs.org/verdaccio-groupnames", + "latest": "1.1.0", + "downloads": 4 + }, + { + "name": "verdaccio-auth-mongo", + "bundled": false, + "origin": "community", + "category": "authentication", + "description": "A Verdaccio Auth Plugin configured to use a MongoDB Database", + "url": "https://www.npmjs.org/verdaccio-auth-mongo", + "registry": "https://registry.npmjs.org/verdaccio-auth-mongo", + "latest": "1.0.2", + "downloads": 2 + }, + { + "name": "verdaccio-coauth", + "bundled": false, + "origin": "community", + "category": "authentication", + "description": "Verdaccio authentication plugin that use CO authentication", + "url": "https://www.npmjs.org/verdaccio-coauth", + "registry": "https://registry.npmjs.org/verdaccio-coauth", + "latest": "0.0.2", + "downloads": 3 + }, + { + "name": "verdaccio-simpleldap", + "bundled": false, + "origin": "community", + "category": "authentication", + "description": "Verdaccio plugin for simple ldap auth", + "url": "https://www.npmjs.org/verdaccio-simpleldap", + "registry": "https://registry.npmjs.org/verdaccio-simpleldap", + "latest": "0.1.1", + "downloads": 2 + }, + { + "name": "verdaccio-github-team", + "bundled": false, + "origin": "community", + "category": "authentication", + "description": "Verdaccio authentication plugin with github team access", + "url": "https://www.npmjs.org/verdaccio-github-team", + "registry": "https://registry.npmjs.org/verdaccio-github-team", + "latest": "0.1.2", + "downloads": 6 + }, + { + "name": "verdaccio-api-auth", + "bundled": false, + "origin": "community", + "category": "authentication", + "description": "Verdaccio auth via external api", + "url": "https://www.npmjs.org/verdaccio-api-auth", + "registry": "https://registry.npmjs.org/verdaccio-api-auth", + "latest": "0.0.9", + "downloads": 11 + }, + { + "name": "verdaccio-delegated-auth", + "bundled": false, + "origin": "community", + "category": "authentication", + "description": "verdaccio(sinopia) authentication plugin that delegates authentication to another HTTP URL", + "url": "https://www.npmjs.org/verdaccio-delegated-auth", + "registry": "https://registry.npmjs.org/verdaccio-delegated-auth", + "latest": "0.1.1", + "downloads": 15 + }, + { + "name": "verdaccio-delegated-basic-auth", + "bundled": false, + "origin": "community", + "category": "authentication", + "description": "verdaccio authentication plugin that delegates basic authentication to another HTTP URL", + "url": "https://www.npmjs.org/verdaccio-delegated-basic-auth", + "registry": "https://registry.npmjs.org/verdaccio-delegated-basic-auth", + "latest": "0.0.2", + "downloads": 4 + }, + { + "name": "verdaccio-fixed-token", + "bundled": false, + "origin": "community", + "category": "middleware", + "description": "verdaccio middleware plugin", + "url": "https://www.npmjs.org/verdaccio-fixed-token", + "registry": "https://registry.npmjs.org/verdaccio-fixed-token", + "latest": "0.0.1", + "downloads": 5 + }, + { + "name": "@wunderwerk/verdaccio-static-access-token-middleware-plugin", + "bundled": false, + "origin": "community", + "category": "middleware", + "url": "https://www.npmjs.org/@wunderwerk/verdaccio-static-access-token-middleware-plugin", + "registry": "https://registry.npmjs.org/@wunderwerk/verdaccio-static-access-token-middleware-plugin", + "latest": "1.0.2", + "downloads": 15 + }, + { + "name": "verdaccio-sentryrich", + "bundled": false, + "origin": "community", + "category": "middleware", + "description": "sentry loggin errors", + "url": "https://www.npmjs.org/verdaccio-sentryrich", + "registry": "https://registry.npmjs.org/verdaccio-sentryrich", + "latest": "0.1.3", + "downloads": 3 + }, + { + "name": "verdaccio-sentry", + "bundled": false, + "origin": "community", + "category": "middleware", + "description": "sentry loggin errors", + "url": "https://www.npmjs.org/verdaccio-sentry", + "registry": "https://registry.npmjs.org/verdaccio-sentry", + "latest": "0.0.2-beta", + "downloads": 3 + }, + { + "name": "verdaccio-openmetrics", + "bundled": false, + "origin": "community", + "category": "middleware", + "description": "Verdaccio plugin exposing an OpenMetrics/Prometheus endpoint with health and traffic metrics", + "url": "https://www.npmjs.org/verdaccio-openmetrics", + "registry": "https://registry.npmjs.org/verdaccio-openmetrics", + "latest": "1.2.0", + "downloads": 30 + }, + { + "name": "verdaccio-https", + "bundled": false, + "origin": "community", + "category": "middleware", + "description": "verdaccio middleware plugin to redirect to https", + "url": "https://www.npmjs.org/verdaccio-https", + "registry": "https://registry.npmjs.org/verdaccio-https", + "latest": "1.0.11", + "downloads": 37 + }, + { + "name": "verdaccio-badges", + "bundled": false, + "origin": "community", + "category": "middleware", + "description": "A verdaccio plugin to provide a version badge generator endpoint", + "url": "https://www.npmjs.org/verdaccio-badges", + "registry": "https://registry.npmjs.org/verdaccio-badges", + "latest": "1.1.2", + "downloads": 18 + }, + { + "name": "verdaccio-npm-urls", + "bundled": false, + "origin": "community", + "category": "middleware", + "description": "

📦⚓ URL Plugin for Verdaccio

", + "url": "https://www.npmjs.org/verdaccio-npm-urls", + "registry": "https://registry.npmjs.org/verdaccio-npm-urls", + "latest": "1.0.1", + "downloads": 20 + }, + { + "name": "verdaccio-static-token", + "bundled": false, + "origin": "community", + "category": "middleware", + "description": "Quick and dirty plugin for Verdaccio npm registry to use auth tokens, without run the token command", + "url": "https://www.npmjs.org/verdaccio-static-token", + "registry": "https://registry.npmjs.org/verdaccio-static-token", + "latest": "1.0.1", + "downloads": 262 + }, + { + "name": "verdaccio-apm-server", + "bundled": false, + "origin": "community", + "category": "middleware", + "description": "An amazing verdaccio plugin", + "url": "https://www.npmjs.org/verdaccio-apm-server", + "registry": "https://registry.npmjs.org/verdaccio-apm-server", + "latest": "1.0.14", + "downloads": 18 + }, + { + "name": "verdaccio-gae-ah", + "bundled": false, + "origin": "community", + "category": "middleware", + "description": "A Verdaccio middleware plugin that handles Google App Engine /_ah/* requests like /_ah/warmup", + "url": "https://www.npmjs.org/verdaccio-gae-ah", + "registry": "https://registry.npmjs.org/verdaccio-gae-ah", + "latest": "0.0.3", + "downloads": 10 + }, + { + "name": "verdaccio-oidc-ui", + "bundled": false, + "origin": "community", + "category": "ui", + "description": "

📦🔐 Verdaccio OpenID Connect - With UI Support

", + "url": "https://www.npmjs.org/verdaccio-oidc-ui", + "registry": "https://registry.npmjs.org/verdaccio-oidc-ui", + "latest": "2.2.7", + "downloads": 24 + }, + { + "name": "verdaccio-github-oauth-ui-without-groups", + "bundled": false, + "origin": "community", + "category": "ui", + "description": "

📦🔐 Verdaccio GitHub OAuth - With UI Support

", + "url": "https://www.npmjs.org/verdaccio-github-oauth-ui-without-groups", + "registry": "https://registry.npmjs.org/verdaccio-github-oauth-ui-without-groups", + "latest": "1.0.1", + "downloads": 6 + }, + { + "name": "verdaccio-zip", + "bundled": false, + "origin": "community", + "category": "tool", + "description": "根据package-lock.json的依赖配置，将verdaccio下载的npm包(tgz)打包压缩成zip", + "url": "https://www.npmjs.org/verdaccio-zip", + "registry": "https://registry.npmjs.org/verdaccio-zip", + "latest": "1.0.14", + "downloads": 848 + }, + { + "name": "verdaccio-utilities", + "bundled": false, + "origin": "community", + "category": "tool", + "description": "A small utility for working with Verdaccio hosts.", + "url": "https://www.npmjs.org/verdaccio-utilities", + "registry": "https://registry.npmjs.org/verdaccio-utilities", + "latest": "1.3.5", + "downloads": 21 + }, + { + "name": "mlc-verdaccio-s3-archiver", + "bundled": false, + "origin": "community", + "category": "tool", + "description": "Builds an archive of your verdaccio instance, then backup it to AWS S3.", + "url": "https://www.npmjs.org/mlc-verdaccio-s3-archiver", + "registry": "https://registry.npmjs.org/mlc-verdaccio-s3-archiver", + "latest": "1.0.3", + "downloads": 2 + }, + { + "name": "bulk-npm-publish", + "bundled": false, + "origin": "community", + "category": "tool", + "description": "Publish Multiple NPM packages from verdaccio storage", + "url": "https://www.npmjs.org/bulk-npm-publish", + "registry": "https://registry.npmjs.org/bulk-npm-publish", + "latest": "3.0.2", + "downloads": 21 + }, + { + "name": "tgz-checker", + "bundled": false, + "origin": "community", + "category": "tool", + "description": "* 检查待导入verdaccio/storage目录的各npm包内是否含有.tgz文件。 * 更改verdaccio/storage目录各包内package.json标记的最新版本号。 ``` npm i -g tgz-checker ```", + "url": "https://www.npmjs.org/tgz-checker", + "registry": "https://registry.npmjs.org/tgz-checker", + "latest": "0.1.7", + "downloads": 2 + }, + { + "name": "npm-offline-packer", + "bundled": false, + "origin": "community", + "category": "tool", + "description": "Fetch and publish npm packages for private npm registry", + "url": "https://www.npmjs.org/npm-offline-packer", + "registry": "https://registry.npmjs.org/npm-offline-packer", + "latest": "1.0.1", + "downloads": 8 + }, + { + "name": "npm-offline-packer", + "bundled": false, + "origin": "community", + "category": "tool", + "description": "Fetch and publish npm packages for private npm registry", + "url": "https://www.npmjs.org/npm-offline-packer", + "registry": "https://registry.npmjs.org/npm-offline-packer", + "latest": "1.0.1", + "downloads": 8 + } + ] +} diff --git a/website/src/components/EcosystemSearch/index.ts b/website/src/components/EcosystemSearch/index.ts new file mode 100644 index 000000000..c1a37ec28 --- /dev/null +++ b/website/src/components/EcosystemSearch/index.ts @@ -0,0 +1,3 @@ +import EcosystemSearch from './EcosystemSearch'; + +export { EcosystemSearch as default }; diff --git a/website/src/components/EcosystemSearch/types.ts b/website/src/components/EcosystemSearch/types.ts new file mode 100644 index 000000000..07938094f --- /dev/null +++ b/website/src/components/EcosystemSearch/types.ts @@ -0,0 +1,26 @@ +export type Origin = 'core' | 'community'; +export type Category = 'middleware' | 'authentication' | 'filter' | 'storage' | 'ui' | 'tool'; + +export type Addon = { + name: string; + url: string; + category: Category; + bundled: boolean; + origin: Origin; + latest: string; + downloads: number; + description: string; +}; + +export type Filters = { + bundled: boolean; + core: boolean; + community: boolean; + middleware: boolean; + storage: boolean; + tool: boolean; + ui: boolean; + authentication: boolean; + filter: boolean; + keyword: string; +}; diff --git a/website/src/components/EcosystemSearch/utils.ts b/website/src/components/EcosystemSearch/utils.ts new file mode 100644 index 000000000..ca67268b2 --- /dev/null +++ b/website/src/components/EcosystemSearch/utils.ts @@ -0,0 +1,8 @@ +import * as DOMPurify from 'dompurify'; + +export function parseDescription(description: string): string | void { + if (typeof description === 'string') { + return DOMPurify.sanitize(description); + } + return ''; +} diff --git a/website/src/components/Features.tsx b/website/src/components/Features.tsx index 3e290e159..fa82e5d98 100644 --- a/website/src/components/Features.tsx +++ b/website/src/components/Features.tsx @@ -1,5 +1,5 @@ -import Translate, { translate } from '@docusaurus/Translate'; import Link from '@docusaurus/Link'; +import Translate, { translate } from '@docusaurus/Translate'; import { useBaseUrlUtils } from '@docusaurus/useBaseUrl'; import React from 'react'; diff --git a/website/src/components/Header.tsx b/website/src/components/Header.tsx index 091d5073f..5842f265e 100644 --- a/website/src/components/Header.tsx +++ b/website/src/components/Header.tsx @@ -1,8 +1,8 @@ -import Translate, { translate } from '@docusaurus/Translate'; import Link from '@docusaurus/Link'; +import Translate, { translate } from '@docusaurus/Translate'; import useBaseUrl from '@docusaurus/useBaseUrl'; -import React from 'react'; import cx from 'classnames'; +import React from 'react'; import Command from './Command'; import styles from './Header.module.scss'; @@ -22,13 +22,15 @@ const Header = (): React.ReactElement => { A lightweight Node.js private proxy registry

@@ -19,9 +18,9 @@ Some projects organize packages in multi-packages repositories or [monorepos](ht Such approach has been really hard to achieve considering: -* Populate canary packages on public services seems not to be a good idea -* Some self-hosted OSS registries are too heavy -* Offline environments (private networks) +- Populate canary packages on public services seems not to be a good idea +- Some self-hosted OSS registries are too heavy +- Offline environments (private networks) **Verdaccio** is a lightweight registry with zero-configuration that **fits perfectly in any E2E + CI workflow**. @@ -30,22 +29,21 @@ Such approach has been really hard to achieve considering: There is no a silver bullet yet, each implementation seems to be specific for each project, you can check some of them in the following thread [clicking here](https://stackoverflow.com/a/50222427/308341). - ## Examples in Open Source The following projects have examples using Verdaccio in Open Source ### Bash Examples -* [Babel.js](https://github.com/babel/babel) *(+35k ⭐️)* -* [Docusaurus](https://github.com/facebook/docusaurus) *(+31k ⭐️)* -* [create-react-app](https://github.com/facebook/create-react-app/blob/master/CONTRIBUTING.md#contributing-to-e2e-end-to-end-tests) *(+73.5k ⭐️)* -* [Uppy](https://github.com/transloadit/uppy) *(+21k ⭐️)* -* [ethereum/web3.js](https://github.com/ethereum/web3.js) *(+8k ⭐️)* -* [adobe react-spectrum](https://github.com/adobe/react-spectrum/pull/2432) *(+6k ⭐️)* -* [Mozilla Neutrino](https://github.com/neutrinojs/neutrino) *(+3k ⭐️)* +- [Babel.js](https://github.com/babel/babel) _(+35k ⭐️)_ +- [Docusaurus](https://github.com/facebook/docusaurus) _(+31k ⭐️)_ +- [create-react-app](https://github.com/facebook/create-react-app/blob/master/CONTRIBUTING.md#contributing-to-e2e-end-to-end-tests) _(+73.5k ⭐️)_ +- [Uppy](https://github.com/transloadit/uppy) _(+21k ⭐️)_ +- [ethereum/web3.js](https://github.com/ethereum/web3.js) _(+8k ⭐️)_ +- [adobe react-spectrum](https://github.com/adobe/react-spectrum/pull/2432) _(+6k ⭐️)_ +- [Mozilla Neutrino](https://github.com/neutrinojs/neutrino) _(+3k ⭐️)_ -This is the most simple example using Verdaccio in a bash script (extracted from *create-react-app*). +This is the most simple example using Verdaccio in a bash script (extracted from _create-react-app_). ```bash #!/bin/sh @@ -69,35 +67,32 @@ sh -c "npm --registry $local_registry publish" ### Docker Examples -* [Hyperledger](https://github.com/hyperledger/fabric-chaincode-node) +- [Hyperledger](https://github.com/hyperledger/fabric-chaincode-node) ### Programtically Examples -* [Storybook](https://github.com/storybooks/storybook) *(+44k ⭐️)* -* [Gatsby](https://github.com/gatsbyjs/gatsby) *(+40k ⭐️) +- [Storybook](https://github.com/storybooks/storybook) _(+44k ⭐️)_ +- [Gatsby](https://github.com/gatsbyjs/gatsby) \*(+40k ⭐️) #### Verdaccio module Via CLI: -* [Aurelia Framework](https://github.com/aurelia) *(+12k ⭐️)* -* [Netlify CLI](https://github.com/netlify/cli) *(+1k ⭐️)* -* [Embark](https://embark.status.im/) *(+3k ⭐️)* -* [Microsoft Beachball](https://github.com/microsoft/beachball) +- [Aurelia Framework](https://github.com/aurelia) _(+12k ⭐️)_ +- [Netlify CLI](https://github.com/netlify/cli) _(+1k ⭐️)_ +- [Embark](https://embark.status.im/) _(+3k ⭐️)_ +- [Microsoft Beachball](https://github.com/microsoft/beachball) + #### Node.js `child_process` examples -* [Angular CLI](https://github.com/angular/angular-cli) *(+25k ⭐️)* -* [bit](https://github.com/teambit/bit) *(+6k ⭐️)* -* [pnpm](https://github.com/pnpm/pnpm) *(+6k ⭐️)* -* [aws-sdk cli v3](https://github.com/aws/aws-sdk-js-v3) *(+1k ⭐️)* -* [angular-eslint](https://github.com/angular-eslint/angular-eslint) *(+1k ⭐️)* +- [Angular CLI](https://github.com/angular/angular-cli) _(+25k ⭐️)_ +- [bit](https://github.com/teambit/bit) _(+6k ⭐️)_ +- [pnpm](https://github.com/pnpm/pnpm) _(+6k ⭐️)_ +- [aws-sdk cli v3](https://github.com/aws/aws-sdk-js-v3) _(+1k ⭐️)_ +- [angular-eslint](https://github.com/angular-eslint/angular-eslint) _(+1k ⭐️)_ -## Example repositories +## Example repositories - [e2e-ci-example-gh-actions](https://github.com/juanpicado/e2e-ci-example-gh-actions) - [verdaccio-end-to-end-tests](https://github.com/juanpicado/verdaccio-end-to-end-tests) - [verdaccio-fork](https://github.com/juanpicado/verdaccio-fork) - - - - diff --git a/website/versioned_docs/version-5.x/env.md b/website/versioned_docs/version-5.x/env.md index 2d6cd407f..1dfc9f2a9 100644 --- a/website/versioned_docs/version-5.x/env.md +++ b/website/versioned_docs/version-5.x/env.md @@ -9,20 +9,19 @@ Verdaccio provides a set of environment variables to modify either permissions, To change the behavior on runtime on running the image, these are the list of available variables. -Variable | Default | Description ---- | --- | --- -VERDACCIO_APPDIR | `/opt/verdaccio` | the docker working directory -VERDACCIO_USER_NAME | `verdaccio` | the system user -VERDACCIO_USER_UID | `10001` | the user id being used to apply folder permissions -VERDACCIO_PORT | `4873` | the verdaccio port -VERDACCIO_PROTOCOL | `http` | the default http protocol - +| Variable | Default | Description | +| ------------------- | ---------------- | -------------------------------------------------- | +| VERDACCIO_APPDIR | `/opt/verdaccio` | the docker working directory | +| VERDACCIO_USER_NAME | `verdaccio` | the system user | +| VERDACCIO_USER_UID | `10001` | the user id being used to apply folder permissions | +| VERDACCIO_PORT | `4873` | the verdaccio port | +| VERDACCIO_PROTOCOL | `http` | the default http protocol | ### VERDACCIO_HANDLE_KILL_SIGNALS {#handle-kill-signals} Enables gracefully shutdown, more info at the [pull request #2121](https://github.com/verdaccio/verdaccio/pull/2121). -> +> ### VERDACCIO_PUBLIC_URL {#public-url} diff --git a/website/versioned_docs/version-5.x/github-actions.md b/website/versioned_docs/version-5.x/github-actions.md index 5ed6ed03d..dbe48d216 100644 --- a/website/versioned_docs/version-5.x/github-actions.md +++ b/website/versioned_docs/version-5.x/github-actions.md @@ -1,6 +1,6 @@ --- id: github-actions -title: "GitHub Actions" +title: 'GitHub Actions' --- With [GitHub Actions](https://github.com/features/actions) you can automate your workflow, each GitHub Action performs a specific step in a process. diff --git a/website/versioned_docs/version-5.x/how-to-deploy-on-AWS.md b/website/versioned_docs/version-5.x/how-to-deploy-on-AWS.md index 727c9a28b..7c0d2700f 100644 --- a/website/versioned_docs/version-5.x/how-to-deploy-on-AWS.md +++ b/website/versioned_docs/version-5.x/how-to-deploy-on-AWS.md @@ -1,6 +1,6 @@ --- id: aws -title: "Amazon Web Services" +title: 'Amazon Web Services' --- This document describes simple steps to setup Verdaccio private registry on Amazon Web Services platform using EC2 service. This assumes you have already created an EC2 Amazon Linux instance; if not then please check this tutorial on [AWS EC2 Setup](https://www.howtoinmagento.com/2018/04/aws-cli-commands-for-aws-ec2-amazon.html). @@ -11,123 +11,119 @@ This document describes simple steps to setup Verdaccio private registry on Amaz **Step 2:** Install Node Version Manager (nvm) first, close and re-open the SSH using your EC2 key. - ``` sudo apt update ``` - - ``` wget -qO- https://raw.githubusercontent.com/creationix/nvm/v0.33.11/install.sh | bash ``` - - ``` exit ``` - +`sudo apt update` + +`wget -qO- https://raw.githubusercontent.com/creationix/nvm/v0.33.11/install.sh | bash` + +`exit` + **Step 3:** Install Node using Node Version Manager (nvm) - ``` nvm install node ``` +`nvm install node` **Step 4:** Install Verdaccio & pm2, will require to run Verdaccio service in background - ``` npm i -g verdaccio pm2 ``` +`npm i -g verdaccio pm2` **Step 5:** Set the verdaccio registry as a source. By default original NPM registry set. - - ``` npm set registry http://localhost:4873 ``` - - ``` npm set ca null ``` + +`npm set registry http://localhost:4873` + +`npm set ca null` **Step 6:** Run Verdaccio and stop it (ctrl+c). It will create a config file we will use. - ``` verdaccio ``` - +`verdaccio` + **Step 7:** Now do below configuration for listening to all addresses on that server machine / EC2 instance. [(read more)](https://github.com/verdaccio/verdaccio/blob/master/conf/full.yaml) Open and edit `config.yaml` file: - ``` nano .config/verdaccio/config.yaml ``` or ``` nano ~/verdaccio/config.yaml ``` +` nano .config/verdaccio/config.yaml` or ` nano ~/verdaccio/config.yaml` Add below lines at the end. [(read more)](https://github.com/verdaccio/verdaccio/blob/ff409ab7c05542a152100e3bc39cfadb36a8a080/conf/full.yaml#L113) - ``` - listen: - - 0.0.0.0:4873 +``` +listen: + - 0.0.0.0:4873 ``` Change below line so that only authenticated person can access our registry - ``` Replace "access: $all" with "access: $authenticated" ``` - - (Optional) Change below line according to how many users you wish to grant access to the scoped registry - - ``` Replace "#max_users: 1000" with "max_users: 1" ``` +`Replace "access: $all" with "access: $authenticated"` + +(Optional) Change below line according to how many users you wish to grant access to the scoped registry + +`Replace "#max_users: 1000" with "max_users: 1"` There are some more parameters available to configure it. Like storage, proxy, default port change. [(read more)](https://github.com/verdaccio/verdaccio/blob/ff409ab7c05542a152100e3bc39cfadb36a8a080/conf/full.yaml#L113) **Step 8:** Run Verdaccio in background using PM2: - ``` pm2 start verdaccio ``` +`pm2 start verdaccio` **Step 9:** Now, You can access your Verdaccio web UI. The URL will look like something: - ``` http://ec2-..compute.amazonaws.com:4873 ``` +`http://ec2-..compute.amazonaws.com:4873` {or} - ``` http://your-ec2-public-ip-address:4873 (You can check your EC2 instance public ip from AWS console) ``` +`http://your-ec2-public-ip-address:4873 (You can check your EC2 instance public ip from AWS console)` To confirm Verdaccio's running status, run the command below: - ``` pm2 list ``` - - To make Verdaccio launch on startup, run the commands below: - - ``` pm2 stop verdaccio ``` - - ``` pm2 delete verdaccio ``` - - ``` pm2 startup ``` This will show a command in your terminal. Copy / paste it and execute it to have pm2 make a startup service for you. - - ``` which verdaccio ``` Copy the path shown by this command. - - ``` pm2 start /home/ubuntu/.nvm/versions/node/v17.1.0/bin/verdaccio ``` (put the path you copied from command above). - - ``` pm2 status ``` This should show "online" on the status of verdaccio service. - - ``` pm2 save ``` Now when you reboot the EC2 instance, it should launch verdaccio. +` pm2 list` + +To make Verdaccio launch on startup, run the commands below: + +`pm2 stop verdaccio` + +`pm2 delete verdaccio` + +`pm2 startup` This will show a command in your terminal. Copy / paste it and execute it to have pm2 make a startup service for you. + +`which verdaccio` Copy the path shown by this command. + +`pm2 start /home/ubuntu/.nvm/versions/node/v17.1.0/bin/verdaccio` (put the path you copied from command above). + +`pm2 status` This should show "online" on the status of verdaccio service. + +`pm2 save` Now when you reboot the EC2 instance, it should launch verdaccio. **Step 10:** Registering a user in verdaccio registry - ``` npm set always-auth true ``` - - ``` npm adduser ``` +` npm set always-auth true` + +` npm adduser` It will ask for username, password and valid email id to be entered. Make a note of this details that will use later to login in verdaccio registry to publish our library. - **Step 11:** Now we are ready to use our AWS server instance work as a private registry. Login into verdaccio registry. Enter the same username, password and email id set in above Step. - ``` npm set registry http://your-ec2-public-ip-address:4873 ``` - - ``` npm login ``` +` npm set registry http://your-ec2-public-ip-address:4873` + +` npm login` **Step 12:** Go to your custom library package path. In my case this is my Angular 7 package path -> `/libraries/dist/your-library-name/your-library-name-0.0.1.tgz` If you like to know how to create angular 7 library/package then [(click here)](https://www.howtoinmagento.com/2019/11/how-to-create-your-first-angular-7.html) - ``` cd [custom library package path] ``` +` cd [custom library package path]` **Step 13:** Finally publish our library `your-library-name-0.0.1.tgz` on verdaccio registry - ``` [custom library package path] >> npm publish your-library-name-0.0.1.tgz ``` +` [custom library package path] >> npm publish your-library-name-0.0.1.tgz` {or} - ``` [custom library package path] >> npm publish ``` +` [custom library package path] >> npm publish` {or} - ``` [custom library package path] >> npm publish --registry http://your-ec2-public-ip-address:4873 ``` - -Now browse ``` http://your-ec2-public-ip-address:4873 ``` and you will see new library package there. - - +` [custom library package path] >> npm publish --registry http://your-ec2-public-ip-address:4873` +Now browse ` http://your-ec2-public-ip-address:4873` and you will see new library package there. diff --git a/website/versioned_docs/version-5.x/iis-server.md b/website/versioned_docs/version-5.x/iis-server.md index 25e142f91..50d22fb21 100644 --- a/website/versioned_docs/version-5.x/iis-server.md +++ b/website/versioned_docs/version-5.x/iis-server.md @@ -1,34 +1,34 @@ --- id: iss-server -title: "Installing on IIS server" +title: 'Installing on IIS server' --- These instructions were written for Windows Server 2016, IIS 10, [Node.js 10.15.0](https://nodejs.org/), [iisnode 0.2.26](https://github.com/Azure/iisnode) and [verdaccio 3.11.0](https://github.com/verdaccio/verdaccio). -* Install IIS Install [iisnode](https://github.com/Azure/iisnode). -Make sure you install prerequisites (Url Rewrite Module & node) as explained in the instructions for iisnode. -* Create a new folder in Explorer where you want to host verdaccio. -For example `C:\verdaccio`. -Save [package.json](#packagejson), -[start.js](#startjs) -and [web.config](#webconfig) in this folder. -* Create a new site in Internet Information Services Manager. You can name it whatever you want. -I'll call it verdaccio in these [instructions](http://www.iis.net/learn/manage/configuring-security/application-pool-identities). Specify the path to where you saved all files and a port number. -* Go back to Explorer and give the user that runs the application pool modify rights to the folder you just created. If you've named the new site verdaccio and did not change the app pool, it's running under an ApplicationPoolIdentity and you should give the user IIS AppPool\verdaccio modify rights see instructions if you need help. (You can restrict access later if you want so that it only has modify rights on the iisnode and verdaccio\storage) -* Start a command prompt and execute the commands below to download verdaccio: +- Install IIS Install [iisnode](https://github.com/Azure/iisnode). + Make sure you install prerequisites (Url Rewrite Module & node) as explained in the instructions for iisnode. +- Create a new folder in Explorer where you want to host verdaccio. + For example `C:\verdaccio`. + Save [package.json](#packagejson), + [start.js](#startjs) + and [web.config](#webconfig) in this folder. +- Create a new site in Internet Information Services Manager. You can name it whatever you want. + I'll call it verdaccio in these [instructions](http://www.iis.net/learn/manage/configuring-security/application-pool-identities). Specify the path to where you saved all files and a port number. +- Go back to Explorer and give the user that runs the application pool modify rights to the folder you just created. If you've named the new site verdaccio and did not change the app pool, it's running under an ApplicationPoolIdentity and you should give the user IIS AppPool\verdaccio modify rights see instructions if you need help. (You can restrict access later if you want so that it only has modify rights on the iisnode and verdaccio\storage) +- Start a command prompt and execute the commands below to download verdaccio: -```` +``` cd c:\verdaccio npm install -```` +``` -* Make sure you have an inbound rule accepting TCP traffic to the port in Windows Firewall -* Thats it! Now you can navigate to the host and port that you specified +- Make sure you have an inbound rule accepting TCP traffic to the port in Windows Firewall +- Thats it! Now you can navigate to the host and port that you specified I wanted the `verdaccio` site to be the default site in IIS so I did the following: -* I stopped the "Default Web Site" and only start the site "verdaccio" site in IIS -* I set the bindings to "http", ip address "All Unassigned" on port 80, ok any warning or prompts +- I stopped the "Default Web Site" and only start the site "verdaccio" site in IIS +- I set the bindings to "http", ip address "All Unassigned" on port 80, ok any warning or prompts These instructions are based on [Host Sinopia in IIS on Windows](https://gist.github.com/HCanber/4dd8409f79991a09ac75). I had to tweak my web config as per below but you may find the original from the @@ -36,9 +36,9 @@ for mentioned link works better A default configuration file will be created `c:\verdaccio\verdaccio\config.yaml` -### package.json {#packagejson} +### package.json {#packagejson} -````json +```json { "name": "iisnode-verdaccio", "version": "1.0.0", @@ -48,25 +48,25 @@ A default configuration file will be created `c:\verdaccio\verdaccio\config.yaml "verdaccio": "^3.11.0" } } -```` +``` ### start.js {#startjs} -````bash +```bash process.argv.push('-l', 'unix:' + process.env.PORT, '-c', './config.yaml'); require('./node_modules/verdaccio/build/lib/cli.js'); -```` +``` ### Alternate start.js for Verdaccio versions < v3.0 {#alternate-startjs-for-verdaccio-versions--v30} -````bash +```bash process.argv.push('-l', 'unix:' + process.env.PORT); require('./node_modules/verdaccio/src/lib/cli.js'); -```` +``` ### web.config {#webconfig} -````xml +```xml @@ -113,16 +113,17 @@ require('./node_modules/verdaccio/src/lib/cli.js'); -```` +``` ### Troubleshooting {#troubleshooting} + - **The web interface does not load when hosted with https as it tries to download scripts over http.** -Make sure that you have enabled `X-Forwarded-Proto` in IISNode using `enableXFF`. See [the related issue](https://github.com/verdaccio/verdaccio/issues/2003). -```` + Make sure that you have enabled `X-Forwarded-Proto` in IISNode using `enableXFF`. See [the related issue](https://github.com/verdaccio/verdaccio/issues/2003). + +``` -```` - +``` diff --git a/website/versioned_docs/version-5.x/install.md b/website/versioned_docs/version-5.x/install.md index 8ed57cb9d..ca02762f7 100644 --- a/website/versioned_docs/version-5.x/install.md +++ b/website/versioned_docs/version-5.x/install.md @@ -1,6 +1,6 @@ --- id: installation -title: "Installation" +title: 'Installation' --- Verdaccio is a Node.js private and proxy registry. To install it, you need a few basic prerequisites. @@ -65,7 +65,7 @@ or with the docker image docker pull verdaccio/verdaccio:nightly-master ``` -> The docker image `verdaccio/verdaccio:nightly-master` is alinged with the latest commits in master branch, while the npmjs version has a longer release cycle. **It is highly recommended don't use alpha versions for production**. +> The docker image `verdaccio/verdaccio:nightly-master` is alinged with the latest commits in master branch, while the npmjs version has a longer release cycle. **It is highly recommended don't use alpha versions for production**. ## Basic Usage {#basic-usage} @@ -106,6 +106,7 @@ Or a `publishConfig` in your `package.json` } } ``` + For alternative configurations, please read the [Using a private registry](cli-registry.md) section. ## Create Your Own Private NPM Package Tutorial {#create-your-own-private-npm-package-tutorial} diff --git a/website/versioned_docs/version-5.x/kubernetes.md b/website/versioned_docs/version-5.x/kubernetes.md index 1e3fa5910..c77b48644 100644 --- a/website/versioned_docs/version-5.x/kubernetes.md +++ b/website/versioned_docs/version-5.x/kubernetes.md @@ -1,9 +1,9 @@ --- id: kubernetes -title: "Kubernetes" +title: 'Kubernetes' --- - You can find instructions to deploy Verdaccio on a Kubernetes cluster on the +You can find instructions to deploy Verdaccio on a Kubernetes cluster on the [verdaccio/docker-example](https://github.com/verdaccio/verdaccio/tree/5.x/docker-examples/kubernetes-example) repository. However, the recommended method to install Verdaccio on a Kubernetes cluster is to use [Helm](https://helm.sh). Helm is a @@ -61,10 +61,9 @@ helm uninstall npm **Note:** this command delete all the resources, including packages that you may have previously published to the registry. - ### Custom Verdaccio configuration {#custom-verdaccio-configuration} -You can customize the Verdaccio configuration using a Kubernetes *configMap*. +You can customize the Verdaccio configuration using a Kubernetes _configMap_. #### Prepare {#prepare} @@ -109,6 +108,7 @@ This allows you to inject sensitive values to the container via a [Kubernetes Se 1. Update your Verdaccio config according to the [Uplinks](./uplinks.md#auth-property) documentation 2. Pass the secret environment variable to your values file or via `--set secretEnvVars.FOO_TOKEN=superSecretBarToken` + ```yaml # values.yaml secretEnvVars: @@ -119,6 +119,7 @@ secretEnvVars: The standard k8s NGINX ingress proxy allows for 1MB for body-size which can be increased by modifying the default deployment options according to the [documentation](https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/annotations/#custom-max-body-size): + ```yaml ... @@ -126,7 +127,7 @@ annotations: ... kubernetes.io/proxy-body-size: 20m -.... +.... ... ``` @@ -135,4 +136,4 @@ annotations: [Rancher](http://rancher.com/) is a complete container management platform that makes managing and using containers in production really easy. -* [verdaccio-rancher](https://github.com/lgaticaq/verdaccio-rancher) +- [verdaccio-rancher](https://github.com/lgaticaq/verdaccio-rancher) diff --git a/website/versioned_docs/version-5.x/linking.md b/website/versioned_docs/version-5.x/linking.md index 230e50ace..b44a56aec 100644 --- a/website/versioned_docs/version-5.x/linking.md +++ b/website/versioned_docs/version-5.x/linking.md @@ -1,6 +1,6 @@ --- id: linking-remote-registry -title: "Linking a Remote Registry" +title: 'Linking a Remote Registry' --- Verdaccio is a proxy and by default [links](uplinks.md) the public registry. @@ -25,10 +25,10 @@ registry=https://registry.npmjs.org This approach is valid, but comes with several disadvantages: -* It **only works with scopes** -* Scope must match, **no Regular Expressions are allowed** -* One scope **cannot fetch from multiple registries** -* Tokens/passwords **must be defined within** `.npmrc` and checked in into the repo. +- It **only works with scopes** +- Scope must match, **no Regular Expressions are allowed** +- One scope **cannot fetch from multiple registries** +- Tokens/passwords **must be defined within** `.npmrc` and checked in into the repo. See a full example [here](https://stackoverflow.com/questions/54543979/npmrc-multiple-registries-for-the-same-scope/54550940#54550940). @@ -78,7 +78,6 @@ Having a full Offline Registry is completely possible. If you don't want any con can do the following. ```yaml - auth: htpasswd: file: ./htpasswd diff --git a/website/versioned_docs/version-5.x/logger.md b/website/versioned_docs/version-5.x/logger.md index babcccb70..9546f0d06 100644 --- a/website/versioned_docs/version-5.x/logger.md +++ b/website/versioned_docs/version-5.x/logger.md @@ -1,6 +1,6 @@ --- id: logger -title: "Logger" +title: 'Logger' --- As with any web application, Verdaccio has a customisable built-in logger. You can define multiple types of outputs. @@ -24,10 +24,10 @@ Note: Rotating log stream is not supported in cluster mode. [See here](https://g ### Configuration {#configuration} -| Property | Type | Required | Example | Support | Description | -| -------- | ------ | -------- | ---------------------------------------------- | ------- | ------------------------------------------------- | -| type | string | No | [stdout, file] | all | define the output | -| path | string | No | verdaccio.log | all | if type is file, define the location of that file | -| format | string | No | [pretty, pretty-timestamped] | all | output format | -| level | string | No | [fatal, error, warn, http, info, debug, trace] | all | verbose level | -| colors | boolean | No | false | v5.7.0 | disable or enable colors | +| Property | Type | Required | Example | Support | Description | +| -------- | ------- | -------- | ---------------------------------------------- | ------- | ------------------------------------------------- | +| type | string | No | [stdout, file] | all | define the output | +| path | string | No | verdaccio.log | all | if type is file, define the location of that file | +| format | string | No | [pretty, pretty-timestamped] | all | output format | +| level | string | No | [fatal, error, warn, http, info, debug, trace] | all | verbose level | +| colors | boolean | No | false | v5.7.0 | disable or enable colors | diff --git a/website/versioned_docs/version-5.x/logo.md b/website/versioned_docs/version-5.x/logo.md index aadb4ec23..21670016b 100644 --- a/website/versioned_docs/version-5.x/logo.md +++ b/website/versioned_docs/version-5.x/logo.md @@ -1,20 +1,20 @@ --- id: logo -title: "Logotype" +title: 'Logotype' --- -The logotype was designed by __[Breno Rodrigues](https://github.com/rodriguesbreno)__ which +The logotype was designed by **[Breno Rodrigues](https://github.com/rodriguesbreno)** which won the [contest](https://github.com/verdaccio/verdaccio/issues/237) ([last stage](https://github.com/verdaccio/verdaccio/issues/328)) and donated his work to this project. > All logos are licensed under [Creative Commons](https://github.com/verdaccio/verdaccio/blob/master/LICENSE-docs). -Special thanks to *[@Lisapressmar](https://github.com/Lisapressmar)* for her contribution +Special thanks to _[@Lisapressmar](https://github.com/Lisapressmar)_ for her contribution with multiple image formats and sizes. ## Symbols {#symbols} -__With text__ +**With text** ![symbol tiny with text](/img/logo/symbol/png/logo-small-header-bottom.png) @@ -22,11 +22,11 @@ __With text__ ![symbol big with text](/img/logo/symbol/png/logo-small-header-bottom@3x.png) -__SVG__ +**SVG** ![symbol svg](/img/logo/symbol/svg/logo-small-header-bottom.svg) -__No text__ +**No text** ![symbol tiny](/img/logo/symbol/png/verdaccio-tiny.png) @@ -34,12 +34,10 @@ __No text__ ![symbol big](/img/logo/symbol/png/verdaccio-tiny@3x.png) -__SVG__ +**SVG** ![svg format symbol no text](/img/logo/symbol/svg/verdaccio-tiny.svg) - - ### Black&White {#blackwhite} ![symbol bw small](/img/logo/symbol/png/verdaccio-blackwhite.png) @@ -48,11 +46,10 @@ __SVG__ ![symbol bw big](/img/logo/symbol/png/verdaccio-blackwhite@3x.png) -__SVG__ +**SVG** ![symbol bw svg](/img/logo/symbol/svg/verdaccio-blackwhite.svg) - ## Banner {#banner} ![banner small](/img/logo/banner/png/verdaccio-banner.png) @@ -60,5 +57,3 @@ __SVG__ ![banner medium](/img/logo/banner/png/verdaccio-banner@2x.png) ![banner big](/img/logo/banner/png/verdaccio-banner@3x.png) - - diff --git a/website/versioned_docs/version-5.x/node-api.md b/website/versioned_docs/version-5.x/node-api.md index a4b581c9a..71a5f26a4 100644 --- a/website/versioned_docs/version-5.x/node-api.md +++ b/website/versioned_docs/version-5.x/node-api.md @@ -1,6 +1,6 @@ --- id: node-api -title: "Node API" +title: 'Node API' --- Verdaccio can be invoked programmatically. The Node API was introduced after version `verdaccio@3.0.0`. @@ -62,11 +62,12 @@ startServer( ## Other implementations {#other-implementations} -* [verdaccio-server](https://github.com/boringame/verdaccio-server) local npm registry proxy server +- [verdaccio-server](https://github.com/boringame/verdaccio-server) local npm registry proxy server ```js // js -import * as verdaccioServer from "verdaccio-server"; +import * as verdaccioServer from 'verdaccio-server'; + verdaccioServer.start(); verdaccioServer.stop(); verdaccioServer.list(); diff --git a/website/versioned_docs/version-5.x/notifications.md b/website/versioned_docs/version-5.x/notifications.md index b249a804f..aa5b1b614 100644 --- a/website/versioned_docs/version-5.x/notifications.md +++ b/website/versioned_docs/version-5.x/notifications.md @@ -1,6 +1,6 @@ --- id: notifications -title: "Notifications" +title: 'Notifications' --- Notify was built primarily to use with Slack's Incoming @@ -19,7 +19,7 @@ An example with a **HipChat**, **Stride** and **Google Hangouts Chat** hook: ```yaml notify: method: POST - headers: [{'Content-Type': 'application/json'}] + headers: [{ 'Content-Type': 'application/json' }] endpoint: https://usagge.hipchat.com/v2/room/3729485/notification?auth_token=mySecretToken content: '{"color":"green","message":"New package published: * {{ name }}*","notify":true,"message_format":"text"}' ``` @@ -30,19 +30,19 @@ notify: notify: 'example-google-chat': method: POST - headers: [{'Content-Type': 'application/json'}] + headers: [{ 'Content-Type': 'application/json' }] endpoint: https://chat.googleapis.com/v1/spaces/AAAAB_TcJYs/messages?key=myKey&token=myToken content: '{"text":"New package published: `{{ name }}{{#each versions}} v{{version}}{{/each}}`"}' 'example-hipchat': - method: POST - headers: [{'Content-Type': 'application/json'}] - endpoint: https://usagge.hipchat.com/v2/room/3729485/notification?auth_token=mySecretToken - content: '{"color":"green","message":"New package published: * {{ name }}*","notify":true,"message_format":"text"}' + method: POST + headers: [{ 'Content-Type': 'application/json' }] + endpoint: https://usagge.hipchat.com/v2/room/3729485/notification?auth_token=mySecretToken + content: '{"color":"green","message":"New package published: * {{ name }}*","notify":true,"message_format":"text"}' 'example-stride': - method: POST - headers: [{'Content-Type': 'application/json'}, {'authorization': 'Bearer secretToken'}] - endpoint: https://api.atlassian.com/site/{cloudId}/conversation/{conversationId}/message - content: '{"body": {"version": 1,"type": "doc","content": [{"type": "paragraph","content": [{"type": "text","text": "New package published: * {{ name }}* Publisher name: * {{ publisher.name }}"}]}]}}' + method: POST + headers: [{ 'Content-Type': 'application/json' }, { 'authorization': 'Bearer secretToken' }] + endpoint: https://api.atlassian.com/site/{cloudId}/conversation/{conversationId}/message + content: '{"body": {"version": 1,"type": "doc","content": [{"type": "paragraph","content": [{"type": "text","text": "New package published: * {{ name }}* Publisher name: * {{ publisher.name }}"}]}]}}' ``` ## Template {#template} @@ -63,9 +63,9 @@ We use [Handlebars](https://handlebarsjs.com/) as main template engine. List of properties accesible via template -* Metadata -* Publisher (who is publishing) -* Package Published (package@1.0.0) +- Metadata +- Publisher (who is publishing) +- Package Published (package@1.0.0) ### Metadata {#metadata} @@ -121,7 +121,6 @@ Package metadata that the template has access } ``` - ### Publisher {#publisher} You can get access to the package publisher information in the `content` of a webhook using the `publisher` object. @@ -158,11 +157,11 @@ You can access to the package is being published with the keyword `{{publishedPa ## Configuration {#configuration} -Property | Type | Required | Support | Default | Description ---- | --- | --- | --- | --- | --- -method| string | No | all | | HTTP verb -packagePattern| string | No | all | | Only run this notification if the package name matches the regular expression -packagePatternFlags| string | No | all | | Any flags to be used with the regular expression -headers| array/object | Yes | all | | If this endpoint requires specific headers, set them here as an array of key: value objects. -endpoint| string | Yes | all | | set the URL endpoint for this call -content| string | Yes | all | | any [Handlebar](https://handlebarsjs.com/) expressions +| Property | Type | Required | Support | Default | Description | +| ------------------- | ------------ | -------- | ------- | ------- | -------------------------------------------------------------------------------------------- | +| method | string | No | all | | HTTP verb | +| packagePattern | string | No | all | | Only run this notification if the package name matches the regular expression | +| packagePatternFlags | string | No | all | | Any flags to be used with the regular expression | +| headers | array/object | Yes | all | | If this endpoint requires specific headers, set them here as an array of key: value objects. | +| endpoint | string | Yes | all | | set the URL endpoint for this call | +| content | string | Yes | all | | any [Handlebar](https://handlebarsjs.com/) expressions | diff --git a/website/versioned_docs/version-5.x/packages.md b/website/versioned_docs/version-5.x/packages.md index 00f818319..ed7a25ad2 100644 --- a/website/versioned_docs/version-5.x/packages.md +++ b/website/versioned_docs/version-5.x/packages.md @@ -1,6 +1,6 @@ --- id: packages -title: "Package Access" +title: 'Package Access' --- This is a series of constraints that allow or restrict access to the local storage based on specific criteria. @@ -44,14 +44,14 @@ packages: The list internal groups handled by `verdaccio` are: ```js -'$all', '$anonymous', '@all', '@anonymous', 'all', 'undefined', 'anonymous' +'$all', '$anonymous', '@all', '@anonymous', 'all', 'undefined', 'anonymous'; ``` All users receive all those set of permissions independently of is anonymous or not plus the groups provided by the plugin, in case of `htpasswd` return the username as a group. For instance, if you are logged as `npmUser` the list of groups will be. ```js // groups without '$' are going to be deprecated eventually -'$all', '$anonymous', '@all', '@anonymous', 'all', 'undefined', 'anonymous', 'npmUser' +'$all', '$anonymous', '@all', '@anonymous', 'all', 'undefined', 'anonymous', 'npmUser'; ``` If you want to protect specific set packages under your group, you need to do something like this. Let's use a `Regex` that covers all prefixed `npmuser-` packages. We recommend using a prefix for your packages, in that way it will be easier to protect them. @@ -88,14 +88,14 @@ $ npm config set always-auth=true Defining multiple access groups is fairly easy, just define them with a white space between them. ```yaml - 'company-*': - access: admin internal - publish: admin - proxy: server1 - 'supersecret-*': - access: secret super-secret-area ultra-secret-area - publish: secret ultra-secret-area - proxy: server1 +'company-*': + access: admin internal + publish: admin + proxy: server1 +'supersecret-*': + access: secret super-secret-area ultra-secret-area + publish: secret ultra-secret-area + proxy: server1 ``` #### Blocking access to set of packages {#blocking-access-to-set-of-packages} @@ -112,7 +112,7 @@ packages: #### Blocking proxying a set of specific packages {#blocking-proxying-a-set-of-specific-packages} -You might want to block one or several packages from fetching from remote repositories., but, at the same time, allow others to access different *uplinks*. +You might want to block one or several packages from fetching from remote repositories., but, at the same time, allow others to access different _uplinks_. Let's see the following example: @@ -135,10 +135,10 @@ packages: Let's describe what we want with the above example: -* I want to host my own `jquery` dependency but I need to avoid proxying it. -* I want all dependencies that match with `my-company-*` but I need to avoid proxying them. -* I want all dependencies that are in the `my-local-scope` scope but I need to avoid proxying them. -* I want proxying for all the rest of the dependencies. +- I want to host my own `jquery` dependency but I need to avoid proxying it. +- I want all dependencies that match with `my-company-*` but I need to avoid proxying them. +- I want all dependencies that are in the `my-local-scope` scope but I need to avoid proxying them. +- I want proxying for all the rest of the dependencies. Be **aware that the order of your packages definitions is important and always use double wilcard**. Because if you do not include it `verdaccio` will include it for you and the way that your dependencies are resolved will be affected. @@ -155,7 +155,7 @@ You may assign multiple uplinks for use as a proxy to use in the case of failove #### Unpublishing Packages {#unpublishing-packages} -The property `publish` handle permissions for `npm publish` and `npm unpublish`. But, if you want to be more specific, you can use the property +The property `publish` handle permissions for `npm publish` and `npm unpublish`. But, if you want to be more specific, you can use the property `unpublish` in your package access section, for instance: ```yaml @@ -180,21 +180,20 @@ packages: In the previous example, the behaviour would be described: -* all users can publish the `jquery` package, but only the user `root` would be able to unpublish any version. -* only authenticated users can publish `my-company-*` packages, but **nobody would be allowed to unpublish them**. -* If `unpublish` is commented out, the access will be granted or denied by the `publish` definition. - +- all users can publish the `jquery` package, but only the user `root` would be able to unpublish any version. +- only authenticated users can publish `my-company-*` packages, but **nobody would be allowed to unpublish them**. +- If `unpublish` is commented out, the access will be granted or denied by the `publish` definition. ### Configuration {#configuration} You can define mutiple `packages` and each of them must have an unique `Regex`. The syntax is based on [minimatch glob expressions](https://github.com/isaacs/minimatch). -Property | Type | Required | Example | Support | Description ---- | --- | --- | --- | --- | --- -access | string | No | $all | all | define groups allowed to access the package -publish | string | No | $authenticated | all | define groups allowed to publish -proxy | string | No | npmjs | all | limit look ups for specific uplink -storage | string | No | string | `/some-folder` | it creates a subfolder whithin the storage folder for each package access +| Property | Type | Required | Example | Support | Description | +| -------- | ------ | -------- | -------------- | -------------- | ------------------------------------------------------------------------- | +| access | string | No | $all | all | define groups allowed to access the package | +| publish | string | No | $authenticated | all | define groups allowed to publish | +| proxy | string | No | npmjs | all | limit look ups for specific uplink | +| storage | string | No | string | `/some-folder` | it creates a subfolder whithin the storage folder for each package access | > We higlight that we recommend to not use **allow_access**/**allow_publish** and **proxy_access** anymore, those are deprecated and will soon be removed, please use the short version of each of those (**access**/**publish**/**proxy**). diff --git a/website/versioned_docs/version-5.x/plugin-auth.md b/website/versioned_docs/version-5.x/plugin-auth.md index ed21cf600..704fd5d81 100644 --- a/website/versioned_docs/version-5.x/plugin-auth.md +++ b/website/versioned_docs/version-5.x/plugin-auth.md @@ -1,6 +1,6 @@ --- id: plugin-auth -title: "Authentication Plugin" +title: 'Authentication Plugin' --- ## What's an Authentication Plugin? {#whats-an-authentication-plugin} @@ -8,7 +8,7 @@ title: "Authentication Plugin" Is a sort plugin that allows to handle who access or publish to a specific package. By default the `htpasswd` is built-in, but can easily be replaced by your own. - ## Getting Started +## Getting Started The authentication plugins are defined in the `auth:` section, as follows: @@ -43,17 +43,22 @@ On each request, `authenticate` will be triggered and the plugin should return t ### API {#api} ```typescript - interface IPluginAuth extends IPlugin { - authenticate(user: string, password: string, cb: AuthCallback): void; - adduser?(user: string, password: string, cb: AuthCallback): void; - changePassword?(user: string, password: string, newPassword: string, cb: AuthCallback): void; - allow_publish?(user: RemoteUser, pkg: AllowAccess & PackageAccess, cb: AuthAccessCallback): void; - allow_access?(user: RemoteUser, pkg: AllowAccess & PackageAccess, cb: AuthAccessCallback): void; - allow_unpublish?(user: RemoteUser, pkg: AllowAccess & PackageAccess, cb: AuthAccessCallback): void; - apiJWTmiddleware?(helpers: any): Function; - } +interface IPluginAuth extends IPlugin { + authenticate(user: string, password: string, cb: AuthCallback): void; + adduser?(user: string, password: string, cb: AuthCallback): void; + changePassword?(user: string, password: string, newPassword: string, cb: AuthCallback): void; + allow_publish?(user: RemoteUser, pkg: AllowAccess & PackageAccess, cb: AuthAccessCallback): void; + allow_access?(user: RemoteUser, pkg: AllowAccess & PackageAccess, cb: AuthAccessCallback): void; + allow_unpublish?( + user: RemoteUser, + pkg: AllowAccess & PackageAccess, + cb: AuthAccessCallback + ): void; + apiJWTmiddleware?(helpers: any): Function; +} ``` -> Only `adduser`, `allow_access`, `apiJWTmiddleware`, `allow_publish` and `allow_unpublish` are optional, verdaccio provide a fallback in all those cases. + +> Only `adduser`, `allow_access`, `apiJWTmiddleware`, `allow_publish` and `allow_unpublish` are optional, verdaccio provide a fallback in all those cases. #### `apiJWTmiddleware` method {#apijwtmiddleware-method} @@ -61,12 +66,10 @@ Since `v4.0.0` `apiJWTmiddleware` was introduced on [PR#1227](https://github.com/verdaccio/verdaccio/pull/1227) in order to have full control of the token handler, overriding this method will disable `login/adduser` support. We recommend don't implement this method unless is totally necessary. See a full example [here](https://github.com/verdaccio/verdaccio/pull/1227#issuecomment-463235068). - ## What should I return in each of the methods? {#what-should-i-return-in-each-of-the-methods} Verdaccio relies on `callback` functions at time of this writing. Each method should call the method and what you return is important, let's review how to do it. - ### `authentication` callback {#authentication-callback} Once the authentication has been executed there is 2 options to give a response to `verdaccio`. @@ -76,14 +79,13 @@ Once the authentication has been executed there is 2 options to give a response If the auth was unsuccessful, return `false` as the second argument. ```typescript -callback(null, false) +callback(null, false); ``` ##### If the authentication success {#if-the-authentication-success} The auth was successful. - `groups` is an array of strings where the user is part of. ``` @@ -102,7 +104,6 @@ The authentication service might fails, and you might want to reflect that in th > A failure on login is not the same as service error, if you want to notify user the credentials are wrong, just return `false` instead string of groups. The behaviour mostly depends of you. - ### `adduser` callback {#adduser-callback} ##### If adduser success {#if-adduser-success} @@ -110,7 +111,7 @@ The authentication service might fails, and you might want to reflect that in th If the service is able to create an user, return `true` as the second argument. ```typescript -callback(null, true) +callback(null, true); ``` ##### If adduser fails {#if-adduser-fails} @@ -134,7 +135,7 @@ If the service is able to create an user, return `true` as the second argument. ```typescript const user = serviceUpdatePassword(user, password, newPassword); -callback(null, user) +callback(null, user); ``` ##### If the request fails {#if-the-request-fails} @@ -144,7 +145,7 @@ Any other action different than success must return an error. ```typescript import { getNotFound } from '@verdaccio/commons-api'; - const err = getNotFound('user not found'); +const err = getNotFound('user not found'); callback(err); ``` @@ -173,7 +174,7 @@ Any other action different than success must return an error. ```typescript import { getNotFound } from '@verdaccio/commons-api'; - const err = getForbidden('not allowed to access package'); +const err = getForbidden('not allowed to access package'); callback(err); ``` @@ -285,19 +286,19 @@ Where `htpasswd` is the sufix of the plugin name. eg: `verdaccio-htpasswd` and t ### List Community Authentication Plugins {#list-community-authentication-plugins} -* [verdaccio-bitbucket](https://github.com/idangozlan/verdaccio-bitbucket): Bitbucket authentication plugin for verdaccio. -* [verdaccio-bitbucket-server](https://github.com/oeph/verdaccio-bitbucket-server): Bitbucket Server authentication plugin for verdaccio. -* [verdaccio-ldap](https://www.npmjs.com/package/verdaccio-ldap): LDAP auth plugin for verdaccio. -* [verdaccio-active-directory](https://github.com/nowhammies/verdaccio-activedirectory): Active Directory authentication plugin for verdaccio -* [verdaccio-gitlab](https://github.com/bufferoverflow/verdaccio-gitlab): use GitLab Personal Access Token to authenticate -* [verdaccio-gitlab-ci](https://github.com/lab360-ch/verdaccio-gitlab-ci): Enable GitLab CI to authenticate against verdaccio. -* [verdaccio-htpasswd](https://github.com/verdaccio/verdaccio-htpasswd): Auth based on htpasswd file plugin (built-in) for verdaccio -* [verdaccio-github-oauth](https://github.com/aroundus-inc/verdaccio-github-oauth): Github oauth authentication plugin for verdaccio. -* [verdaccio-github-oauth-ui](https://github.com/n4bb12/verdaccio-github-oauth-ui): GitHub OAuth plugin for the verdaccio login button. -* [verdaccio-groupnames](https://github.com/deinstapel/verdaccio-groupnames): Plugin to handle dynamic group associations utilizing `$group` syntax. Works best with the ldap plugin. -* [verdaccio-sqlite](https://github.com/bchanudet/verdaccio-sqlite): SQLite Authentication plugin for Verdaccio -* [verdaccio-okta-auth](https://github.com/hogarthww-labs/verdaccio-okta-auth) Verdaccio Okta Auth -* [verdaccio-azure-ad-login](https://github.com/IhToN/verdaccio-azure-ad-login) Let your users authenticate into Verdaccio via Azure AD OAuth 2.0 API -* [verdaccio-auth-gitlab](https://github.com/pfdgithub/verdaccio-auth-gitlab) Verdaccio authentication plugin by gitlab personal access tokens. +- [verdaccio-bitbucket](https://github.com/idangozlan/verdaccio-bitbucket): Bitbucket authentication plugin for verdaccio. +- [verdaccio-bitbucket-server](https://github.com/oeph/verdaccio-bitbucket-server): Bitbucket Server authentication plugin for verdaccio. +- [verdaccio-ldap](https://www.npmjs.com/package/verdaccio-ldap): LDAP auth plugin for verdaccio. +- [verdaccio-active-directory](https://github.com/nowhammies/verdaccio-activedirectory): Active Directory authentication plugin for verdaccio +- [verdaccio-gitlab](https://github.com/bufferoverflow/verdaccio-gitlab): use GitLab Personal Access Token to authenticate +- [verdaccio-gitlab-ci](https://github.com/lab360-ch/verdaccio-gitlab-ci): Enable GitLab CI to authenticate against verdaccio. +- [verdaccio-htpasswd](https://github.com/verdaccio/verdaccio-htpasswd): Auth based on htpasswd file plugin (built-in) for verdaccio +- [verdaccio-github-oauth](https://github.com/aroundus-inc/verdaccio-github-oauth): Github oauth authentication plugin for verdaccio. +- [verdaccio-github-oauth-ui](https://github.com/n4bb12/verdaccio-github-oauth-ui): GitHub OAuth plugin for the verdaccio login button. +- [verdaccio-groupnames](https://github.com/deinstapel/verdaccio-groupnames): Plugin to handle dynamic group associations utilizing `$group` syntax. Works best with the ldap plugin. +- [verdaccio-sqlite](https://github.com/bchanudet/verdaccio-sqlite): SQLite Authentication plugin for Verdaccio +- [verdaccio-okta-auth](https://github.com/hogarthww-labs/verdaccio-okta-auth) Verdaccio Okta Auth +- [verdaccio-azure-ad-login](https://github.com/IhToN/verdaccio-azure-ad-login) Let your users authenticate into Verdaccio via Azure AD OAuth 2.0 API +- [verdaccio-auth-gitlab](https://github.com/pfdgithub/verdaccio-auth-gitlab) Verdaccio authentication plugin by gitlab personal access tokens. **Have you developed a new plugin? Add it here !** diff --git a/website/versioned_docs/version-5.x/plugin-generator.md b/website/versioned_docs/version-5.x/plugin-generator.md index 108c213ee..253136669 100644 --- a/website/versioned_docs/version-5.x/plugin-generator.md +++ b/website/versioned_docs/version-5.x/plugin-generator.md @@ -1,13 +1,13 @@ --- id: plugin-generator -title: "Plugin Generator" +title: 'Plugin Generator' --- ## Installing the Yeoman Generator {#installing-the-yeoman-generator} Verdaccio is a pluggable application, with the objective to help developers to generate new plugins, we have a custom generator based in **[Yeoman](https://yeoman.io/)** for generate all sort of plugins. -To install the generator, as first step you must install the *yeoman* command `yo`. +To install the generator, as first step you must install the _yeoman_ command `yo`. ```bash npm install -g yo @@ -62,13 +62,13 @@ Setting the project root at: /Users/user/verdaccio_yo_generator ``` - Don't hesitate to include meaningful keywords, as `verdaccio`, `plugin` or your plugin type. Good keywords will help us to find you and future improvement in our collect information about all plugins. + ``` ? Key your keywords (comma to split) verdaccio,plugin,storage,minio,verdaccio-plugin ``` - Keep your generator **updated**, don't miss any bug-fixes and performance improvements. - ### Contributing {#contributing} Help us to improve the generator, you can contribute in the following repository. diff --git a/website/versioned_docs/version-5.x/plugin-middleware.md b/website/versioned_docs/version-5.x/plugin-middleware.md index c1a6bfd12..6b25392ac 100644 --- a/website/versioned_docs/version-5.x/plugin-middleware.md +++ b/website/versioned_docs/version-5.x/plugin-middleware.md @@ -1,6 +1,6 @@ --- id: plugin-middleware -title: "Middleware Plugin" +title: 'Middleware Plugin' --- ## What's an Middleware Plugin? {#whats-an-middleware-plugin} @@ -40,7 +40,6 @@ public register_middlewares( The `auth` and `storage` are instances and can be extended, but we don't recommend this approach unless is well founded. - > A good example of a middleware plugin is the [verdaccio-audit](https://github.com/verdaccio/monorepo/tree/master/plugins/audit). ## Generate an middleware plugin {#generate-an-middleware-plugin} @@ -109,12 +108,12 @@ The middleware are registrered after built-in endpoints, thus, it is not possibl ### List Community Middleware Plugins {#list-community-middleware-plugins} -* [verdaccio-audit](https://github.com/verdaccio/verdaccio-audit): verdaccio plugin for *npm audit* cli support (built-in) (compatible since 3.x) +- [verdaccio-audit](https://github.com/verdaccio/verdaccio-audit): verdaccio plugin for _npm audit_ cli support (built-in) (compatible since 3.x) -* [verdaccio-profile-api](https://github.com/ahoracek/verdaccio-profile-api): verdaccio plugin for *npm profile* cli support and *npm profile set password* for *verdaccio-htpasswd* based authentificaton +- [verdaccio-profile-api](https://github.com/ahoracek/verdaccio-profile-api): verdaccio plugin for _npm profile_ cli support and _npm profile set password_ for _verdaccio-htpasswd_ based authentificaton -* [verdaccio-https](https://github.com/honzahommer/verdaccio-https) Verdaccio middleware plugin to redirect to https if x-forwarded-proto header is set -* [verdaccio-badges](https://github.com/tavvy/verdaccio-badges) A verdaccio plugin to provide a version badge generator endpoint -* [verdaccio-openmetrics](https://github.com/freight-hub/verdaccio-openmetrics) Verdaccio plugin exposing an OpenMetrics/Prometheus endpoint with health and traffic metrics -* [verdaccio-sentry](https://github.com/juanpicado/verdaccio-sentry) sentry loggin errors -* [verdaccio-pacman](https://github.com/PaddeK/verdaccio-pacman) Verdaccio Middleware Plugin to manage tags and versions of packages +- [verdaccio-https](https://github.com/honzahommer/verdaccio-https) Verdaccio middleware plugin to redirect to https if x-forwarded-proto header is set +- [verdaccio-badges](https://github.com/tavvy/verdaccio-badges) A verdaccio plugin to provide a version badge generator endpoint +- [verdaccio-openmetrics](https://github.com/freight-hub/verdaccio-openmetrics) Verdaccio plugin exposing an OpenMetrics/Prometheus endpoint with health and traffic metrics +- [verdaccio-sentry](https://github.com/juanpicado/verdaccio-sentry) sentry loggin errors +- [verdaccio-pacman](https://github.com/PaddeK/verdaccio-pacman) Verdaccio Middleware Plugin to manage tags and versions of packages diff --git a/website/versioned_docs/version-5.x/plugin-storage.md b/website/versioned_docs/version-5.x/plugin-storage.md index 4be2a342d..f98320dbe 100644 --- a/website/versioned_docs/version-5.x/plugin-storage.md +++ b/website/versioned_docs/version-5.x/plugin-storage.md @@ -1,6 +1,6 @@ --- id: plugin-storage -title: "Storage Plugin" +title: 'Storage Plugin' --- ## What's an Storage Plugin? {#whats-an-storage-plugin} @@ -11,22 +11,27 @@ Verdaccio by default uses a file system storage plugin [local-storage](https://g Storage plugins are composed of two objects, the `IPluginStorage` and the `IPackageStorage`. -* The `IPluginStorage` object handle the local database for private packages. +- The `IPluginStorage` object handle the local database for private packages. ```typescript - interface IPluginStorage extends IPlugin, ITokenActions { - logger: Logger; - config: T & Config; - add(name: string, callback: Callback): void; - remove(name: string, callback: Callback): void; - get(callback: Callback): void; - getSecret(): Promise; - setSecret(secret: string): Promise; - getPackageStorage(packageInfo: string): IPackageStorage; - search(onPackage: onSearchPackage, onEnd: onEndSearchPackage, validateName: onValidatePackage): void; - } +interface IPluginStorage extends IPlugin, ITokenActions { + logger: Logger; + config: T & Config; + add(name: string, callback: Callback): void; + remove(name: string, callback: Callback): void; + get(callback: Callback): void; + getSecret(): Promise; + setSecret(secret: string): Promise; + getPackageStorage(packageInfo: string): IPackageStorage; + search( + onPackage: onSearchPackage, + onEnd: onEndSearchPackage, + validateName: onValidatePackage + ): void; +} ``` -* The `IPackageStorage` is an object that is created by each request that handles the I/O actions for the metadata and tarballs. + +- The `IPackageStorage` is an object that is created by each request that handles the I/O actions for the metadata and tarballs. ```typescript interface IPackageStorage { @@ -103,9 +108,9 @@ I'm all done. Running npm install for you to install the required dependencies. The following list of plugins are implementing the Storage API and might be used them as example. -* [verdaccio-memory](https://github.com/verdaccio/verdaccio-memory) Storage plugin to host packages in Memory -* [verdaccio-s3-storage](https://github.com/remitly/verdaccio-s3-storage) Storage plugin to host packages **Amazon S3** -* [verdaccio-aws-s3-storage](https://github.com/verdaccio/monorepo/tree/master/plugins/aws-s3-storage) Storage plugin to host packages **Amazon S3** (maintained by Verdaccio core team) -* [verdaccio-google-cloud](https://github.com/verdaccio/verdaccio-google-cloud) Storage plugin to host packages **Google Cloud Storage** -* [verdaccio-minio](https://github.com/barolab/verdaccio-minio) A verdaccio plugin for storing data in Minio -* [verdaccio-offline-storage](https://github.com/g3ngar/verdaccio-offline-storage) local-storage plugin BUT with locally available packages as first class citizens. +- [verdaccio-memory](https://github.com/verdaccio/verdaccio-memory) Storage plugin to host packages in Memory +- [verdaccio-s3-storage](https://github.com/remitly/verdaccio-s3-storage) Storage plugin to host packages **Amazon S3** +- [verdaccio-aws-s3-storage](https://github.com/verdaccio/monorepo/tree/master/plugins/aws-s3-storage) Storage plugin to host packages **Amazon S3** (maintained by Verdaccio core team) +- [verdaccio-google-cloud](https://github.com/verdaccio/verdaccio-google-cloud) Storage plugin to host packages **Google Cloud Storage** +- [verdaccio-minio](https://github.com/barolab/verdaccio-minio) A verdaccio plugin for storing data in Minio +- [verdaccio-offline-storage](https://github.com/g3ngar/verdaccio-offline-storage) local-storage plugin BUT with locally available packages as first class citizens. diff --git a/website/versioned_docs/version-5.x/plugins.md b/website/versioned_docs/version-5.x/plugins.md index 265bb6831..d0b7fd7a8 100644 --- a/website/versioned_docs/version-5.x/plugins.md +++ b/website/versioned_docs/version-5.x/plugins.md @@ -1,16 +1,16 @@ --- id: plugins -title: "Plugins" +title: 'Plugins' --- Verdaccio is a pluggable application. It can be extended in many ways, either new authentication methods, adding endpoints or using a custom storage. There are 5 types of plugins: -* [Authentication](plugin-auth.md) -* [Middleware](plugin-middleware.md) -* [Storage](plugin-storage.md) -* Custom Theme and filters +- [Authentication](plugin-auth.md) +- [Middleware](plugin-middleware.md) +- [Storage](plugin-storage.md) +- Custom Theme and filters > If you are interested to develop your own plugin, read the [development](dev-plugins.md) section. @@ -34,7 +34,7 @@ Open the `config.yaml` file and update the `auth` section as follows: The default configuration looks like this, due we use a build-in `htpasswd` plugin by default that you can disable just commenting out the following lines. -### Naming convention {#naming-convention} +### Naming convention {#naming-convention} Since version `2.0.0` until version plugins must start with the following convention: @@ -51,12 +51,13 @@ auth: store: '@my-org/store-awesome-plugin': foo: some value - bar: another value + bar: another value middleware: '@my-org/middleware-awesome-plugin': foo: some value - bar: another value + bar: another value ``` + ### Authentication Configuration {#authentication-configuration} ```yaml @@ -71,7 +72,7 @@ and replacing them with (in case you decide to use a `ldap` plugin. ```yaml auth: activedirectory: - url: "ldap://10.0.100.1" + url: 'ldap://10.0.100.1' baseDN: 'dc=sample,dc=local' domainSuffix: 'sample.local' ``` @@ -86,7 +87,7 @@ auth: file: ./htpasswd #max_users: 1000 activedirectory: - url: "ldap://10.0.100.1" + url: 'ldap://10.0.100.1' baseDN: 'dc=sample,dc=local' domainSuffix: 'sample.local' ``` @@ -126,7 +127,6 @@ $> npm install --global verdaccio-theme-dark > The plugin name prefix must start with `verdaccio-theme`, otherwise the plugin won't load. - You can load only one theme at a time and pass through options if you need it. ```yaml @@ -142,7 +142,7 @@ theme: If you have a custom UI plugin for the them you will need to adapt your build to the new requirements. -The previous version you only need to return a function with a string and the path of the directory. +The previous version you only need to return a function with a string and the path of the directory. ``` const path = require('path'); @@ -177,6 +177,7 @@ The module must return an object and the `index.html` is ignored since support d }, manifestFiles: { js: [ 'runtime.js', 'vendors.js', 'main.js' ] } ``` + - `staticPath`: is the same data returned in Verdaccio 4. - `manifest`: A webpack manifest object. - `manifestFiles`: A object with one property `js` and the array (order matters) of the manifest id to be loaded in the template dynamically. @@ -206,24 +207,23 @@ const { WebpackManifestPlugin } = require('webpack-manifest-plugin'); > If you are relying on any sinopia plugin, remember are deprecated and might no work in the future. -* [sinopia-npm](https://www.npmjs.com/package/sinopia-npm): auth plugin for sinopia supporting an npm registry. -* [sinopia-memory](https://www.npmjs.com/package/sinopia-memory): auth plugin for sinopia that keeps users in memory. -* [sinopia-github-oauth-cli](https://www.npmjs.com/package/sinopia-github-oauth-cli). -* [sinopia-crowd](https://www.npmjs.com/package/sinopia-crowd): auth plugin for sinopia supporting atlassian crowd. -* [sinopia-activedirectory](https://www.npmjs.com/package/sinopia-activedirectory): Active Directory authentication plugin for sinopia. -* [sinopia-github-oauth](https://www.npmjs.com/package/sinopia-github-oauth): authentication plugin for sinopia2, supporting github oauth web flow. -* [sinopia-delegated-auth](https://www.npmjs.com/package/sinopia-delegated-auth): Sinopia authentication plugin that delegates authentication to another HTTP URL -* [sinopia-altldap](https://www.npmjs.com/package/sinopia-altldap): Alternate LDAP Auth plugin for Sinopia -* [sinopia-request](https://www.npmjs.com/package/sinopia-request): An easy and fully auth-plugin with configuration to use an external API. -* [sinopia-htaccess-gpg-email](https://www.npmjs.com/package/sinopia-htaccess-gpg-email): Generate password in htaccess format, encrypt with GPG and send via MailGun API to users. -* [sinopia-mongodb](https://www.npmjs.com/package/sinopia-mongodb): An easy and fully auth-plugin with configuration to use a mongodb database. -* [sinopia-htpasswd](https://www.npmjs.com/package/sinopia-htpasswd): auth plugin for sinopia supporting htpasswd format. -* [sinopia-leveldb](https://www.npmjs.com/package/sinopia-leveldb): a leveldb backed auth plugin for sinopia private npm. -* [sinopia-gitlabheres](https://www.npmjs.com/package/sinopia-gitlabheres): Gitlab authentication plugin for sinopia. -* [sinopia-gitlab](https://www.npmjs.com/package/sinopia-gitlab): Gitlab authentication plugin for sinopia -* [sinopia-ldap](https://www.npmjs.com/package/sinopia-ldap): LDAP auth plugin for sinopia. -* [sinopia-github-oauth-env](https://www.npmjs.com/package/sinopia-github-oauth-env) Sinopia authentication plugin with github oauth web flow. +- [sinopia-npm](https://www.npmjs.com/package/sinopia-npm): auth plugin for sinopia supporting an npm registry. +- [sinopia-memory](https://www.npmjs.com/package/sinopia-memory): auth plugin for sinopia that keeps users in memory. +- [sinopia-github-oauth-cli](https://www.npmjs.com/package/sinopia-github-oauth-cli). +- [sinopia-crowd](https://www.npmjs.com/package/sinopia-crowd): auth plugin for sinopia supporting atlassian crowd. +- [sinopia-activedirectory](https://www.npmjs.com/package/sinopia-activedirectory): Active Directory authentication plugin for sinopia. +- [sinopia-github-oauth](https://www.npmjs.com/package/sinopia-github-oauth): authentication plugin for sinopia2, supporting github oauth web flow. +- [sinopia-delegated-auth](https://www.npmjs.com/package/sinopia-delegated-auth): Sinopia authentication plugin that delegates authentication to another HTTP URL +- [sinopia-altldap](https://www.npmjs.com/package/sinopia-altldap): Alternate LDAP Auth plugin for Sinopia +- [sinopia-request](https://www.npmjs.com/package/sinopia-request): An easy and fully auth-plugin with configuration to use an external API. +- [sinopia-htaccess-gpg-email](https://www.npmjs.com/package/sinopia-htaccess-gpg-email): Generate password in htaccess format, encrypt with GPG and send via MailGun API to users. +- [sinopia-mongodb](https://www.npmjs.com/package/sinopia-mongodb): An easy and fully auth-plugin with configuration to use a mongodb database. +- [sinopia-htpasswd](https://www.npmjs.com/package/sinopia-htpasswd): auth plugin for sinopia supporting htpasswd format. +- [sinopia-leveldb](https://www.npmjs.com/package/sinopia-leveldb): a leveldb backed auth plugin for sinopia private npm. +- [sinopia-gitlabheres](https://www.npmjs.com/package/sinopia-gitlabheres): Gitlab authentication plugin for sinopia. +- [sinopia-gitlab](https://www.npmjs.com/package/sinopia-gitlab): Gitlab authentication plugin for sinopia +- [sinopia-ldap](https://www.npmjs.com/package/sinopia-ldap): LDAP auth plugin for sinopia. +- [sinopia-github-oauth-env](https://www.npmjs.com/package/sinopia-github-oauth-env) Sinopia authentication plugin with github oauth web flow. > All sinopia plugins should be compatible with all future verdaccio versions. Anyhow, we encourage contributors to migrate them to the -modern verdaccio API and using the prefix as *verdaccio-xx-name*. - +> modern verdaccio API and using the prefix as _verdaccio-xx-name_. diff --git a/website/versioned_docs/version-5.x/programmatically.md b/website/versioned_docs/version-5.x/programmatically.md index c5520c658..dcd813519 100644 --- a/website/versioned_docs/version-5.x/programmatically.md +++ b/website/versioned_docs/version-5.x/programmatically.md @@ -1,6 +1,6 @@ --- id: verdaccio-programmatically -title: "Node.js API" +title: 'Node.js API' --- Verdaccio is a binary command which is available in your enviroment when you install globally the package eg `npm i -g verdaccio`, but also can be dependency in your project and use it programmatically. @@ -12,27 +12,23 @@ Using the binary is the faster way to use verdaccio programatically, you need to > If you are using ESM modules the `require` won't be available. ```typescript -export function runRegistry( - args: string[] = [], - childOptions: {} -): Promise { +export function runRegistry(args: string[] = [], childOptions: {}): Promise { return new Promise((resolve, reject) => { - const childFork = fork(require.resolve('verdaccio/bin/verdaccio'), args, childOptions); - childFork.on('message', (msg: {verdaccio_started: boolean}) => { - if(msg.verdaccio_started){ + const childFork = fork(require.resolve('verdaccio/bin/verdaccio'), args, childOptions); + childFork.on('message', (msg: { verdaccio_started: boolean }) => { + if (msg.verdaccio_started) { resolve(childFork); } }); childFork.on('error', (err: any) => reject([err])); - childFork.on('disconnect', (err: any) => reject([err])); + childFork.on('disconnect', (err: any) => reject([err])); }); } ``` You can see the full example on this repository. -[https://github.com/juanpicado/verdaccio-fork](https://github.com/juanpicado/verdaccio-fork -) +[https://github.com/juanpicado/verdaccio-fork](https://github.com/juanpicado/verdaccio-fork) ### Using the module API @@ -59,13 +55,13 @@ There are three ways to use it: With an object you need to add `self_path`, manually (it's not nice but would be a breaking change changing it now) on v6 this is not longer need it. ```js - const {runServer, parseConfigFile} = require('verdaccio'); - const configPath = join(__dirname, './config.yaml'); - const c = parseConfigFile(configPath); - // workaround - // on v5 the `self_path` still exists and will be removed in v6 - c.self_path = 'foo'; - runServer(c).then(() => {}); +const { runServer, parseConfigFile } = require('verdaccio'); +const configPath = join(__dirname, './config.yaml'); +const c = parseConfigFile(configPath); +// workaround +// on v5 the `self_path` still exists and will be removed in v6 +c.self_path = 'foo'; +runServer(c).then(() => {}); ``` Feature available minor than `v5.11.0`. @@ -79,20 +75,20 @@ const verdaccio = require('verdaccio').default; const YAML = require('js-yaml'); const getConfig = () => { - return YAML.safeLoad(fs.readFileSync(path.join(__dirname, 'config.yaml'), 'utf8')); -} + return YAML.safeLoad(fs.readFileSync(path.join(__dirname, 'config.yaml'), 'utf8')); +}; const cache = path.join(__dirname, 'cache'); const config = Object.assign({}, getConfig(), { - self_path: cache + self_path: cache, }); verdaccio(config, 6000, cache, '1.0.0', 'verdaccio', (webServer, addrs, pkgName, pkgVersion) => { try { - webServer.unref(); - webServer.listen(addrs.port || addrs.path, addrs.host, () => { - console.log('verdaccio running'); - }); + webServer.unref(); + webServer.listen(addrs.port || addrs.path, addrs.host, () => { + console.log('verdaccio running'); + }); } catch (error) { console.error(error); } diff --git a/website/versioned_docs/version-5.x/protect-your-dependencies.md b/website/versioned_docs/version-5.x/protect-your-dependencies.md index faf954b03..e3cb5d556 100644 --- a/website/versioned_docs/version-5.x/protect-your-dependencies.md +++ b/website/versioned_docs/version-5.x/protect-your-dependencies.md @@ -1,6 +1,6 @@ --- id: protect-your-dependencies -title: "Protecting packages" +title: 'Protecting packages' --- Verdaccio allows you protect publishing to your registry. To achieve that you will need to set up correctly configure your [packages access](packages). @@ -10,7 +10,7 @@ Verdaccio allows you protect publishing to your registry. To achieve that you wi Let's see for instance the following set up. You have a set of dependencies that are prefixed with `my-company-*` and you need to protect them from anonymous or other non-authorized logged-in users. ```yaml -"my-company-*": +'my-company-*': access: admin teamA teamB teamC publish: admin teamA ``` diff --git a/website/versioned_docs/version-5.x/puppet.md b/website/versioned_docs/version-5.x/puppet.md index edcd6d868..1894bc78b 100644 --- a/website/versioned_docs/version-5.x/puppet.md +++ b/website/versioned_docs/version-5.x/puppet.md @@ -1,6 +1,6 @@ --- id: puppet -title: "Puppet" +title: 'Puppet' --- Install verdaccio for Debian, Ubuntu, Fedora, and RedHat. @@ -9,8 +9,8 @@ Install verdaccio for Debian, Ubuntu, Fedora, and RedHat. There are two variants to install verdaccio using this Puppet module: -* Apply-mode (with puppet-apply and no puppetmaster setup needed) -* Master-Agent-mode (with puppet-agent accessing your configuration through the puppetmaster). +- Apply-mode (with puppet-apply and no puppetmaster setup needed) +- Master-Agent-mode (with puppet-agent accessing your configuration through the puppetmaster). In both variants you have to explicitly call "class nodejs {}" in your puppet script because the puppet-verdaccio module only defines this as a requirement, so you have all the flexibility you want when installing nodejs. @@ -21,8 +21,4 @@ For further information: [https://github.com/verdaccio/puppet-verdaccio](https://github.com/verdaccio/puppet-verdaccio) > We are looking for active contributors for this integration, if you are interested -[refers to this ticket](https://github.com/verdaccio/puppet-verdaccio/issues/11). - - - - +> [refers to this ticket](https://github.com/verdaccio/puppet-verdaccio/issues/11). diff --git a/website/versioned_docs/version-5.x/repositories.md b/website/versioned_docs/version-5.x/repositories.md index 19433d9f0..54ad04dc3 100644 --- a/website/versioned_docs/version-5.x/repositories.md +++ b/website/versioned_docs/version-5.x/repositories.md @@ -6,4 +6,3 @@ title: Source Code `verdaccio` is composed or multiple repositories you might contribute. Look into the **issues** tab whether there is a ticket waiting for you 🤠. To see the complete list of repositories, [click here](https://github.com/verdaccio/verdaccio/wiki/Repositories). - diff --git a/website/versioned_docs/version-5.x/reverse-proxy.md b/website/versioned_docs/version-5.x/reverse-proxy.md index 7ce6fbd47..1ce559597 100644 --- a/website/versioned_docs/version-5.x/reverse-proxy.md +++ b/website/versioned_docs/version-5.x/reverse-proxy.md @@ -1,12 +1,11 @@ --- id: reverse-proxy -title: "Reverse Proxy Setup" +title: 'Reverse Proxy Setup' --- Using a reverse proxy is a common practice. The following configurations are the most recommended and used ones. - **Important**, the headers are considered to resolve the public are `X-Forwarded-Proto` for the protocol and `Host` for the domain, please include them in your configuration. # Apache @@ -15,16 +14,17 @@ Apache and `mod_proxy` should **not decode/encode slashes** and leave them as th For installing at relative path, `/npm`, on the server -```` +``` AllowEncodedSlashes NoDecode ProxyPass /npm http://127.0.0.1:4873 nocanon ProxyPassReverse /npm http://127.0.0.1:4873 -```` +``` For installing at root path, `/`, on the server -```` + +``` ServerName your.domain.com ServerAdmin hello@your.domain.com @@ -33,13 +33,13 @@ For installing at root path, `/`, on the server ProxyPass / http://127.0.0.1:4873/ nocanon ProxyPassReverse / http://127.0.0.1:4873/ -```` +``` ### Configuration with SSL {#configuration-with-ssl} Apache virtual server configuration. -````apache +```apache ServerName npm.your.domain.com @@ -55,42 +55,41 @@ Apache virtual server configuration. RequestHeader set X-Forwarded-Proto "https" -```` +``` ## Invalid checksum Sometimes the gzip compression can mess with the request when running `npm install` and result in error messages like this: -```` +``` npm WARN tar TAR_ENTRY_INVALID checksum failure npm WARN tar zlib: incorrect data check -```` +``` A possible fix for this, can be by disabling gzip compression for the virtual host, by adding this to your config: -```` +``` SetEnv no-gzip 1 -```` +``` Resulting in a config like so: -```` +``` AllowEncodedSlashes NoDecode SetEnv no-gzip 1 ProxyPass /npm http://127.0.0.1:4873 nocanon ProxyPassReverse /npm http://127.0.0.1:4873 -```` +``` You should only add it to your virtual host config, if you are experiencing the issue. - # Nginx The following snippet is a full `docker` example can be tested in our [Docker examples repository](https://github.com/verdaccio/verdaccio/tree/5.x/docker-examples/reverse_proxy/nginx). -````nginx +```nginx upstream verdaccio_v4 { server verdaccio_relative_path_v4:4873; keepalive 8; @@ -139,11 +138,11 @@ server { proxy_redirect off; } } -```` +``` ## SSL example {#ssl-example} -````nginx +```nginx server { listen 80; return 302 https://$host$request_uri; @@ -181,7 +180,7 @@ server { proxy_redirect off; } } -```` +``` ## Run behind reverse proxy with different domain and port {#run-behind-reverse-proxy-with-different-domain-and-port} @@ -208,6 +207,7 @@ location / { proxy_set_header X-Forwarded-Proto $scheme; } ``` + For this case, `url_prefix` should **NOT** set in Verdaccio config --- @@ -222,6 +222,7 @@ location ~ ^/verdaccio/(.*)$ { proxy_set_header X-Forwarded-Proto $scheme; } ``` + For this case, `url_prefix` should set to `/verdaccio/` > Note: There is a slash after the install path (`https://your-domain:port/verdaccio/`)! @@ -230,7 +231,6 @@ For this case, `url_prefix` should set to `/verdaccio/` > Since `verdaccio@5.0.0` - The new `VERDACCIO_PUBLIC_URL` is intended to be used behind proxies, this variable will be used for: - Used as base path to serve UI resources as (js, favicon, etc) diff --git a/website/versioned_docs/version-5.x/security-policy.md b/website/versioned_docs/version-5.x/security-policy.md index cb7636c1a..0f13d3c0b 100644 --- a/website/versioned_docs/version-5.x/security-policy.md +++ b/website/versioned_docs/version-5.x/security-policy.md @@ -1,6 +1,6 @@ --- id: security-policy -title: "Security Policy" +title: 'Security Policy' --- -Follow our security policy on [GitHub](https://github.com/verdaccio/verdaccio/security/policy) \ No newline at end of file +Follow our security policy on [GitHub](https://github.com/verdaccio/verdaccio/security/policy) diff --git a/website/versioned_docs/version-5.x/server.md b/website/versioned_docs/version-5.x/server.md index 6902f5d31..4718ba630 100644 --- a/website/versioned_docs/version-5.x/server.md +++ b/website/versioned_docs/version-5.x/server.md @@ -1,6 +1,6 @@ --- id: server-configuration -title: "Server Configuration" +title: 'Server Configuration' --- This is mostly basic Linux server configuration stuff but I felt it important to document and share the steps I took to get Verdaccio running permanently on my server. You will need root (or sudo) permissions for the following steps. @@ -31,6 +31,7 @@ The `cd` command sends you to the home directory of the Verdaccio user. Make sur ## Listening on all addresses {#listening-on-all-addresses} If you want to listen to every external address set the listen directive in the config to: + ```yaml # you can specify listen address (or simply a port) listen: 0.0.0.0:4873 @@ -85,7 +86,9 @@ $ which verdaccio ## Using systemd {#using-systemd} Instead of `forever` you can use `systemd` for starting Verdaccio and keeping it running. Verdaccio installation has systemd unit, you only need to copy it: + ```bash $ sudo cp /usr/lib/node_modules/verdaccio/systemd/verdaccio.service /lib/systemd/system/ && sudo systemctl daemon-reload ``` + This unit assumes you have configuration in `/etc/verdaccio/config.yaml` and store data in `/var/lib/verdaccio`, so either move your files to those locations or edit the unit. diff --git a/website/versioned_docs/version-5.x/setup-npm.md b/website/versioned_docs/version-5.x/setup-npm.md index 7a08c01df..a83ab7579 100644 --- a/website/versioned_docs/version-5.x/setup-npm.md +++ b/website/versioned_docs/version-5.x/setup-npm.md @@ -1,6 +1,6 @@ --- id: setup-npm -title: "npm" +title: 'npm' --- # npm {#npm} @@ -14,14 +14,17 @@ To set the registry for all your local projects in any terminal window run: ```bash npm set registry http://localhost:4873/ ``` + This will set the registry for your operational system user and you can find it on the file `~/.npmrc`. ## Using registry for a specific project {#specific} To set this value for a specific project open its root folder on a terminal window and run: + ```bash npm set registry http://localhost:4873/ --location project ``` + This will set the registry in a `.npmrc` file in your project root directory. or by specific scope eg: `@my-scope/auth`: @@ -64,11 +67,13 @@ npm adduser --registry http://localhost:4873 after version `npm@9` the commands works separately: - `login` does not create users. + ```bash npm login --registry http://localhost:4873 ``` - `adduser` does not login users. + ```bash npm adduser --registry http://localhost:4873 ``` diff --git a/website/versioned_docs/version-5.x/setup-pnpm.md b/website/versioned_docs/version-5.x/setup-pnpm.md index 16aefba02..8233bd4d1 100644 --- a/website/versioned_docs/version-5.x/setup-pnpm.md +++ b/website/versioned_docs/version-5.x/setup-pnpm.md @@ -1,13 +1,13 @@ --- id: setup-pnpm -title: "pnpm" +title: 'pnpm' --- ### pnpm {#pnpm} > This includes 6.x or higher series. -`pnpm` recognize by default the configuration at `.npmrc` and also the `--registry` value. +`pnpm` recognize by default the configuration at `.npmrc` and also the `--registry` value. This means that you can follow the same commands described in [npm](setup-npm.md) replacing `npm` by `pnpm`. ## Troubleshooting diff --git a/website/versioned_docs/version-5.x/setup-yarn.md b/website/versioned_docs/version-5.x/setup-yarn.md index 8e8c62d2b..848c4bbab 100644 --- a/website/versioned_docs/version-5.x/setup-yarn.md +++ b/website/versioned_docs/version-5.x/setup-yarn.md @@ -1,6 +1,6 @@ --- id: setup-yarn -title: "yarn" +title: 'yarn' --- # yarn {#yarn} @@ -18,7 +18,7 @@ To set up a registry, create a file and define a registry. registry "http://localhost:4873" ``` -`yarn@1.x` by default does not send the token on every request unless is being opt-in manually, this might causes `403 error` if you have protected the access of your packages. +`yarn@1.x` by default does not send the token on every request unless is being opt-in manually, this might causes `403 error` if you have protected the access of your packages. To change this behaviour enable `always-auth` in your configuration : @@ -26,7 +26,7 @@ To change this behaviour enable `always-auth` in your configuration : always-auth=true ``` -or running +or running ``` npm config set always-auth true diff --git a/website/versioned_docs/version-5.x/ssl.md b/website/versioned_docs/version-5.x/ssl.md index 862e2aa1f..c7dca027e 100644 --- a/website/versioned_docs/version-5.x/ssl.md +++ b/website/versioned_docs/version-5.x/ssl.md @@ -1,53 +1,53 @@ --- id: ssl -title: "Set up the SSL Certificates" +title: 'Set up the SSL Certificates' --- Follow these instructions to configure an SSL certificate to serve an npm registry over HTTPS. +- Update the listen property in your `~/.config/verdaccio/config.yaml`: -* Update the listen property in your `~/.config/verdaccio/config.yaml`: - -```` +``` listen: 'https://your.domain.com/' -```` +``` Once you've updated the listen property and try to run verdaccio again, it will ask for certificates. -* Generate your certificates +- Generate your certificates -```` +``` $ openssl genrsa -out /Users/user/.config/verdaccio/verdaccio-key.pem 2048 $ openssl req -new -sha256 -key /Users/user/.config/verdaccio/verdaccio-key.pem -out /Users/user/.config/verdaccio/verdaccio-csr.pem $ openssl x509 -req -in /Users/user/.config/verdaccio/verdaccio-csr.pem -signkey /Users/user/.config/verdaccio/verdaccio-key.pem -out /Users/user/.config/verdaccio/verdaccio-cert.pem - ```` +``` -* Edit your config file `/Users/user/.config/verdaccio/config.yaml` and add the following section: +- Edit your config file `/Users/user/.config/verdaccio/config.yaml` and add the following section: -```` +``` https: key: /Users/user/.config/verdaccio/verdaccio-key.pem cert: /Users/user/.config/verdaccio/verdaccio-cert.pem ca: /Users/user/.config/verdaccio/verdaccio-csr.pem -```` +``` Alternatively, if you have a certificate with the `server.pfx` format, you can add the following configuration section: (The passphrase is optional and only needed if your certificate is encrypted.) -```` +``` https: pfx: /Users/user/.config/verdaccio/server.pfx passphrase: 'secret' -```` +``` You can find more info on the `key`, `cert`, `ca`, `pfx`, and `passphrase` arguments in the [Node documentation](https://nodejs.org/api/tls.html#tls_tls_createsecurecontext_options) -* Run `verdaccio` in your command line. +- Run `verdaccio` in your command line. -* Open the browser and visit `https://your.domain.com:port/` +- Open the browser and visit `https://your.domain.com:port/` These instructions are mostly valid under OSX and Linux; on Windows the paths will vary, but the steps are the same. ## Docker + If you are using the Docker image, you have to set the `VERDACCIO_PROTOCOL` environment variable to `https`, as the `listen` argument is provided in the [Dockerfile](https://github.com/verdaccio/verdaccio/blob/master/Dockerfile#L43) and thus ignored from your config file. You can also set the `VERDACCIO_PORT` environment variable if you are using a port other than `4873`. diff --git a/website/versioned_docs/version-5.x/uplinks.md b/website/versioned_docs/version-5.x/uplinks.md index efe16812b..e354193f5 100644 --- a/website/versioned_docs/version-5.x/uplinks.md +++ b/website/versioned_docs/version-5.x/uplinks.md @@ -1,9 +1,9 @@ --- id: uplinks -title: "Uplinks" +title: 'Uplinks' --- -An *uplink* is a link with an external registry that provides access to external packages. +An _uplink_ is a link with an external registry that provides access to external packages. ![Uplinks](https://user-images.githubusercontent.com/558752/52976233-fb0e3980-33c8-11e9-8eea-5415e6018144.png) @@ -12,7 +12,7 @@ An *uplink* is a link with an external registry that provides access to external ```yaml uplinks: npmjs: - url: https://registry.npmjs.org/ + url: https://registry.npmjs.org/ server2: url: http://mirror.local.net/ timeout: 100ms @@ -21,23 +21,24 @@ uplinks: baduplink: url: http://localhost:55666/ ``` + ### Configuration {#configuration} You can define mutiple uplinks and each of them must have an unique name (key). They can have the following properties: -Property | Type | Required | Example | Support | Description | Default ---- | --- | --- | --- | --- | --- | --- -url | string | Yes | https://registry.npmjs.org/ | all | The registry url | npmjs -ca | string | No | ~./ssl/client.crt' | all | SSL path certificate | No default -timeout | string | No | 100ms | all | set new timeout for the request | 30s -maxage | string | No |10m | all | the time threshold to the cache is valid | 2m -fail_timeout | string | No |10m | all | defines max time when a request becomes a failure | 5m -max_fails | number | No |2 | all | limit maximun failure request | 2 -cache | boolean | No |[true,false] | >= 2.1 | cache all remote tarballs in storage | true -auth | list | No | [see below](uplinks.md#auth-property) | >= 2.5 | assigns the header 'Authorization' [more info](http://blog.npmjs.org/post/118393368555/deploying-with-npm-private-modules) | disabled -headers | list | No | authorization: "Bearer SecretJWToken==" | all | list of custom headers for the uplink | disabled -strict_ssl | boolean | No | [true,false] | >= 3.0 | If true, requires SSL certificates be valid. | true -agent_options | object | No | maxSockets: 10 | >= 4.0.2 | options for the HTTP or HTTPS Agent responsible for managing uplink connection persistence and reuse [more info](https://nodejs.org/api/http.html#http_class_http_agent) | No default +| Property | Type | Required | Example | Support | Description | Default | +| ------------- | ------- | -------- | --------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------- | +| url | string | Yes | https://registry.npmjs.org/ | all | The registry url | npmjs | +| ca | string | No | ~./ssl/client.crt' | all | SSL path certificate | No default | +| timeout | string | No | 100ms | all | set new timeout for the request | 30s | +| maxage | string | No | 10m | all | the time threshold to the cache is valid | 2m | +| fail_timeout | string | No | 10m | all | defines max time when a request becomes a failure | 5m | +| max_fails | number | No | 2 | all | limit maximun failure request | 2 | +| cache | boolean | No | [true,false] | >= 2.1 | cache all remote tarballs in storage | true | +| auth | list | No | [see below](uplinks.md#auth-property) | >= 2.5 | assigns the header 'Authorization' [more info](http://blog.npmjs.org/post/118393368555/deploying-with-npm-private-modules) | disabled | +| headers | list | No | authorization: "Bearer SecretJWToken==" | all | list of custom headers for the uplink | disabled | +| strict_ssl | boolean | No | [true,false] | >= 3.0 | If true, requires SSL certificates be valid. | true | +| agent_options | object | No | maxSockets: 10 | >= 4.0.2 | options for the HTTP or HTTPS Agent responsible for managing uplink connection persistence and reuse [more info](https://nodejs.org/api/http.html#http_class_http_agent) | No default | #### Auth property {#auth-property} @@ -73,15 +74,15 @@ uplinks: url: https://private-registry.domain.com/registry auth: type: bearer - token: "token" + token: 'token' ``` > Note: `token` has priority over `token_env` ### You Must know {#you-must-know} -* Uplinks must be registries compatible with the `npm` endpoints. Eg: *verdaccio*, `sinopia@1.4.0`, *npmjs registry*, *yarn registry*, *JFrog*, *Nexus* and more. -* Setting `cache` to false will help to save space in your hard drive. This will avoid store `tarballs` but [it will keep metadata in folders](https://github.com/verdaccio/verdaccio/issues/391). -* Multiple uplinks might slow down the lookup of your packages. For each request an npm client makes, verdaccio makes 1 call to each configured uplink. -* The (timeout, maxage and fail_timeout) format follow the [NGINX measurement units](http://nginx.org/en/docs/syntax.html) -* When using the [Helm Chart](https://github.com/verdaccio/charts), you can use `secretEnvVars` to inject sensitive environment variables, which can be used to configure private uplink auth. +- Uplinks must be registries compatible with the `npm` endpoints. Eg: _verdaccio_, `sinopia@1.4.0`, _npmjs registry_, _yarn registry_, _JFrog_, _Nexus_ and more. +- Setting `cache` to false will help to save space in your hard drive. This will avoid store `tarballs` but [it will keep metadata in folders](https://github.com/verdaccio/verdaccio/issues/391). +- Multiple uplinks might slow down the lookup of your packages. For each request an npm client makes, verdaccio makes 1 call to each configured uplink. +- The (timeout, maxage and fail_timeout) format follow the [NGINX measurement units](http://nginx.org/en/docs/syntax.html) +- When using the [Helm Chart](https://github.com/verdaccio/charts), you can use `secretEnvVars` to inject sensitive environment variables, which can be used to configure private uplink auth. diff --git a/website/versioned_docs/version-5.x/web.md b/website/versioned_docs/version-5.x/web.md index 262241fc0..b2f57ced7 100644 --- a/website/versioned_docs/version-5.x/web.md +++ b/website/versioned_docs/version-5.x/web.md @@ -1,6 +1,6 @@ --- id: webui -title: "Web User Interface" +title: 'Web User Interface' --- ![Uplinks](https://user-images.githubusercontent.com/558752/52916111-fa4ba980-32db-11e9-8a64-f4e06eb920b3.png) @@ -12,9 +12,9 @@ web: enable: true title: Verdaccio logo: http://somedomain/somelogo.png - primary_color: "#4b5e40" + primary_color: '#4b5e40' gravatar: true | false - scope: "@scope" + scope: '@scope' sort_packages: asc | desc darkMode: false favicon: http://somedomain/favicon.ico | /path/favicon.ico @@ -65,33 +65,32 @@ i18n: ### Configuration {#configuration} -| Property | Type | Required | Example | Support | Description | -| ------------- | ---------- | -------- | ------------------------------------------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------ | -| enable | boolean | No | true/false | all | allow to display the web interface | -| title | string | No | Verdaccio | all | HTML head title description (if is not define set "Verdaccio" by default). | -| gravatar | boolean | No | true | `>v4` | Gravatars will be generated under the hood if this property is enabled | -| sort_packages | [asc,desc] | No | asc | `>v4` | By default private packages are sorted by ascending | -| logo | string | No | `/local/path/to/my/logo.png` `http://my.logo.domain/logo.png` | all | a URI where logo is located (header logo) | -| primary_color | string | No | "#4b5e40" | `>4` | The primary color to use throughout the UI (header, etc) | -| scope | string | No | @myscope | `>v3.x` | If you're using this registry for a specific module scope, specify that scope to set it in the webui instructions header | -| darkMode | boolean | No | false | `>=v4.6.0` | This mode is an special theme for those want to live in the dark side | -| favicon | string | No | false | `>=v5.0.1` | Display a custom favicon, can be local resource or valid url | -| rateLimit | object | No | use `userRateLimit` configuration | `>=v5.4.0` | Increase or decrease rate limit, by default is 5k request every 2 minutes, only limit web api endpoints, the CSS, JS, etcc are ingnored | -| pkgManagers | npm, pnpm or yarn | No | npm | `>=v5.5.0` | Allow customise which package managers on the side bar and registry information dialog are visible | -| login | boolean | No | true or false | `>=v5.5.0` | Allow disable login on the UI (also include web endpoints). | -| scriptsBodyAfter | string[] | No | any list of strings | `>=5.0.0` | inject scripts after the tag | -| metaScripts | string[] | No | any list of strings | `>=5.0.0` | inject scripts inside | -| scriptsbodyBefore | string[] | No | any list of strings | `>=5.0.0` | inject scripts before the | -| html_cache | boolean | No | true | `>=v5.9.0` | whether the html cache is enabled, default true | -| showInfo | boolean | No | true | `>=v5.10.0` | display the info button on the header | -| showSettings | boolean | No | true | `>=v5.10.0` | display the settings button on the header | -| showThemeSwitch | boolean | No | true | `>=v5.10.0` | display the theme switch button on the header | -| showFooter | boolean | No | true | `>=v5.10.0` | allow hide footer | -| showSearch | boolean | No | true | `>=v5.10.0` | allow hide search component | -| showDownloadTarball | boolean | No | true | `>=v5.10.0` | allow hide download button on the sidebar | -| showRaw | boolean | No | true | `>=v5.10.0` | allow hide manifest button on the sidebar (experimental feature) | - +| Property | Type | Required | Example | Support | Description | +| ------------------- | ----------------- | -------- | ------------------------------------------------------------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------------- | +| enable | boolean | No | true/false | all | allow to display the web interface | +| title | string | No | Verdaccio | all | HTML head title description (if is not define set "Verdaccio" by default). | +| gravatar | boolean | No | true | `>v4` | Gravatars will be generated under the hood if this property is enabled | +| sort_packages | [asc,desc] | No | asc | `>v4` | By default private packages are sorted by ascending | +| logo | string | No | `/local/path/to/my/logo.png` `http://my.logo.domain/logo.png` | all | a URI where logo is located (header logo) | +| primary_color | string | No | "#4b5e40" | `>4` | The primary color to use throughout the UI (header, etc) | +| scope | string | No | @myscope | `>v3.x` | If you're using this registry for a specific module scope, specify that scope to set it in the webui instructions header | +| darkMode | boolean | No | false | `>=v4.6.0` | This mode is an special theme for those want to live in the dark side | +| favicon | string | No | false | `>=v5.0.1` | Display a custom favicon, can be local resource or valid url | +| rateLimit | object | No | use `userRateLimit` configuration | `>=v5.4.0` | Increase or decrease rate limit, by default is 5k request every 2 minutes, only limit web api endpoints, the CSS, JS, etcc are ingnored | +| pkgManagers | npm, pnpm or yarn | No | npm | `>=v5.5.0` | Allow customise which package managers on the side bar and registry information dialog are visible | +| login | boolean | No | true or false | `>=v5.5.0` | Allow disable login on the UI (also include web endpoints). | +| scriptsBodyAfter | string[] | No | any list of strings | `>=5.0.0` | inject scripts after the tag | +| metaScripts | string[] | No | any list of strings | `>=5.0.0` | inject scripts inside | +| scriptsbodyBefore | string[] | No | any list of strings | `>=5.0.0` | inject scripts before the | +| html_cache | boolean | No | true | `>=v5.9.0` | whether the html cache is enabled, default true | +| showInfo | boolean | No | true | `>=v5.10.0` | display the info button on the header | +| showSettings | boolean | No | true | `>=v5.10.0` | display the settings button on the header | +| showThemeSwitch | boolean | No | true | `>=v5.10.0` | display the theme switch button on the header | +| showFooter | boolean | No | true | `>=v5.10.0` | allow hide footer | +| showSearch | boolean | No | true | `>=v5.10.0` | allow hide search component | +| showDownloadTarball | boolean | No | true | `>=v5.10.0` | allow hide download button on the sidebar | +| showRaw | boolean | No | true | `>=v5.10.0` | allow hide manifest button on the sidebar (experimental feature) | > The recommended logo size is `40x40` pixels. -> The `darkMode` can be enabled via UI and is persisted in the browser local storage. If you combine `showThemeSwitch: false` with `darkMode` users will be forced to use an specific theme. Furthermore, also void `primary_color` and dark cannot be customized. +> The `darkMode` can be enabled via UI and is persisted in the browser local storage. If you combine `showThemeSwitch: false` with `darkMode` users will be forced to use an specific theme. Furthermore, also void `primary_color` and dark cannot be customized. diff --git a/website/versioned_docs/version-5.x/what-is-verdaccio.md b/website/versioned_docs/version-5.x/what-is-verdaccio.md index 8d51cb1e1..221b41e21 100644 --- a/website/versioned_docs/version-5.x/what-is-verdaccio.md +++ b/website/versioned_docs/version-5.x/what-is-verdaccio.md @@ -1,6 +1,6 @@ --- id: what-is-verdaccio -title: "What is Verdaccio?" +title: 'What is Verdaccio?' --- Verdaccio is a **lightweight private npm proxy registry** built in **Node.js** @@ -12,9 +12,9 @@ recommended by the Open Web Application Security Project ([OWASP](https://owasp. ## What's a registry? {#whats-a-registry} -* A registry is a repository for packages, that implements the **CommonJS Compliant Package Registry specification** for reading package's information. -* Provide a compatible API with npm clients **(yarn/npm/pnpm)**. -* Semantic Versioning compatible **(semver)**. +- A registry is a repository for packages, that implements the **CommonJS Compliant Package Registry specification** for reading package's information. +- Provide a compatible API with npm clients **(yarn/npm/pnpm)**. +- Semantic Versioning compatible **(semver)**. ```bash $> verdaccio @@ -58,11 +58,11 @@ Verdaccio cache all dependencies on demand and speed up installations in local o ## In a Nutshell {#in-a-nutshell} -* It's a web app based on Node.js -* It's a private npm registry -* It's a local network proxy -* It's a Pluggable application -* It's fairly easy to install and to use -* We offer Docker and Kubernetes support -* It is 100% compatible with yarn, npm and pnpm -* Verdaccio means **A green color popular in late medieval Italy for fresco painting**. +- It's a web app based on Node.js +- It's a private npm registry +- It's a local network proxy +- It's a Pluggable application +- It's fairly easy to install and to use +- We offer Docker and Kubernetes support +- It is 100% compatible with yarn, npm and pnpm +- Verdaccio means **A green color popular in late medieval Italy for fresco painting**. diff --git a/website/versioned_docs/version-5.x/who-is-using.md b/website/versioned_docs/version-5.x/who-is-using.md index 781585f37..de76f75ec 100644 --- a/website/versioned_docs/version-5.x/who-is-using.md +++ b/website/versioned_docs/version-5.x/who-is-using.md @@ -1,35 +1,32 @@ --- id: who-is-using -title: "Who is using Verdaccio?" +title: 'Who is using Verdaccio?' --- ### As a Business {#as-a-business} -*If you are using Verdaccio in your business and want to share your experience, let us know. We will be happy to listen to you.* - -* [SheetJS](https://sheetjs.com/) -* [Satispay](https://www.satispay.com/) +_If you are using Verdaccio in your business and want to share your experience, let us know. We will be happy to listen to you._ +- [SheetJS](https://sheetjs.com/) +- [Satispay](https://www.satispay.com/) ### Open Source Projects {#open-source-projects} > **Feel free to suggest other OSS are using Verdaccio.** -* [pnpm](https://pnpm.js.org/) -* [Storybook](https://storybook.js.org/) -* [Mozilla Neutrino](https://neutrinojs.org/) -* [create-react-app](https://github.com/facebook/create-react-app/blob/master/CONTRIBUTING.md#contributing-to-e2e-end-to-end-tests) -* [Gatsby](https://github.com/gatsbyjs/gatsby) -* [Apollo GraphQL](https://github.com/apollographql) -* [Uppy](https://github.com/transloadit/uppy) -* [Aurelia Framework](https://github.com/aurelia/framework) -* [bit](https://github.com/teambit/bit) -* [Wix Yoshi](https://github.com/wix/yoshi) -* [The AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) -* [Hyperledger Caliper](https://github.com/hyperledger/caliper) +- [pnpm](https://pnpm.js.org/) +- [Storybook](https://storybook.js.org/) +- [Mozilla Neutrino](https://neutrinojs.org/) +- [create-react-app](https://github.com/facebook/create-react-app/blob/master/CONTRIBUTING.md#contributing-to-e2e-end-to-end-tests) +- [Gatsby](https://github.com/gatsbyjs/gatsby) +- [Apollo GraphQL](https://github.com/apollographql) +- [Uppy](https://github.com/transloadit/uppy) +- [Aurelia Framework](https://github.com/aurelia/framework) +- [bit](https://github.com/teambit/bit) +- [Wix Yoshi](https://github.com/wix/yoshi) +- [The AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) +- [Hyperledger Caliper](https://github.com/hyperledger/caliper) #### Readme Recommendations {#readme-recommendations} -* [react-native-cli](https://github.com/react-native-community/react-native-cli/blob/master/CONTRIBUTING.md) - - +- [react-native-cli](https://github.com/react-native-community/react-native-cli/blob/master/CONTRIBUTING.md) diff --git a/website/versioned_docs/version-5.x/windows.md b/website/versioned_docs/version-5.x/windows.md index 42b259400..0bd9f9339 100644 --- a/website/versioned_docs/version-5.x/windows.md +++ b/website/versioned_docs/version-5.x/windows.md @@ -1,15 +1,15 @@ --- id: windows -title: "Installing As a Windows Service" +title: 'Installing As a Windows Service' --- Loosely based upon the instructions found [here](http://asysadmin.tumblr.com/post/32941224574/running-nginx-on-windows-as-a-service). I crafted the following and it provided me with a fully working verdaccio service installation: 1. Create a directory for verdaccio - * mkdir `c:\verdaccio` - * cd `c:\verdaccio` + - mkdir `c:\verdaccio` + - cd `c:\verdaccio` 2. Install verdaccio locally (I ran into npm issues with global installs) - * npm install verdaccio + - npm install verdaccio 3. Create your `config.yaml` file in this location `(c:\verdaccio\config.yaml)` 4. Windows Service Setup @@ -17,41 +17,39 @@ Loosely based upon the instructions found [here](http://asysadmin.tumblr.com/pos ALTERNATIVE METHOD: (WinSW package was missing when I tried to download it) -* Download [NSSM](https://www.nssm.cc/download/) and extract +- Download [NSSM](https://www.nssm.cc/download/) and extract -* Add the path that contains nssm.exe to the PATH +- Add the path that contains nssm.exe to the PATH -* Open an administrative command +- Open an administrative command -* Run nssm install verdaccio At a minimum you must fill in the Application tab Path, -Startup directory and Arguments fields. Assuming an install with node in the system path and a -location of c:\verdaccio the below values will work: - * Path: `node` - * Startup directory: `c:\verdaccio` - * Arguments: `c:\verdaccio\node_modules\verdaccio\build\lib\cli.js -c c:\verdaccio\config.yaml` +- Run nssm install verdaccio At a minimum you must fill in the Application tab Path, + Startup directory and Arguments fields. Assuming an install with node in the system path and a + location of c:\verdaccio the below values will work: + _ Path: `node` + _ Startup directory: `c:\verdaccio` \* Arguments: `c:\verdaccio\node_modules\verdaccio\build\lib\cli.js -c c:\verdaccio\config.yaml` - You can adjust other service settings under other tabs as desired. When you are done, click Install service button + You can adjust other service settings under other tabs as desired. When you are done, click Install service button - * Start the service sc start verdaccio +- Start the service sc start verdaccio ## Using WinSW {#using-winsw} -* As of 2015-10-27, WinSW is no longer available at the below location. Please follow the Using NSSM instructions above. -* Download [WinSW](http://repo.jenkins-ci.org/releases/com/sun/winsw/winsw/) - * Place the executable (e.g. `winsw-1.9-bin.exe`) into this folder (`c:\verdaccio`) and rename it to `verdaccio-winsw.exe` -* Create a configuration file in `c:\verdaccio`, named `verdaccio-winsw.xml` -with the following configuration `xml verdaccio verdaccio verdaccio node c:\verdaccio\node_modules\verdaccio\src\lib\cli.js -c c:\verdaccio\config.yaml roll c:\verdaccio\ `. -* Install your service - * `cd c:\verdaccio` - * `verdaccio-winsw.exe install` -* Start your service - * `verdaccio-winsw.exe start` +- As of 2015-10-27, WinSW is no longer available at the below location. Please follow the Using NSSM instructions above. +- Download [WinSW](http://repo.jenkins-ci.org/releases/com/sun/winsw/winsw/) + - Place the executable (e.g. `winsw-1.9-bin.exe`) into this folder (`c:\verdaccio`) and rename it to `verdaccio-winsw.exe` +- Create a configuration file in `c:\verdaccio`, named `verdaccio-winsw.xml` + with the following configuration `xml verdaccio verdaccio verdaccio node c:\verdaccio\node_modules\verdaccio\src\lib\cli.js -c c:\verdaccio\config.yaml roll c:\verdaccio\ `. +- Install your service + - `cd c:\verdaccio` + - `verdaccio-winsw.exe install` +- Start your service + - `verdaccio-winsw.exe start` Some of the above config is more verbose than I had expected, it appears as though 'workingdirectory' is ignored, but other than that, this works for me and allows my verdaccio instance to persist between restarts of the server, and also restart itself should there be any crashes of the verdaccio process. - ## Repositories {#repositories} -* [verdaccio-deamon-windows](https://github.com/davidenke/verdaccio-deamon-windows) +- [verdaccio-deamon-windows](https://github.com/davidenke/verdaccio-deamon-windows) diff --git a/website/versioned_sidebars/version-5.x-sidebars.json b/website/versioned_sidebars/version-5.x-sidebars.json index f3cc27bca..16a97d096 100644 --- a/website/versioned_sidebars/version-5.x-sidebars.json +++ b/website/versioned_sidebars/version-5.x-sidebars.json @@ -10,12 +10,7 @@ { "type": "category", "label": "Setting up Verdaccio", - "items": [ - "cli-registry", - "setup-npm", - "setup-yarn", - "setup-pnpm" - ] + "items": ["cli-registry", "setup-npm", "setup-yarn", "setup-pnpm"] }, "configuration", "who-is-using", @@ -30,11 +25,7 @@ { "type": "category", "label": "Uses Cases", - "items": [ - "caching", - "github-actions", - "linking-remote-registry" - ] + "items": ["caching", "github-actions", "linking-remote-registry"] }, "articles" ] @@ -42,25 +33,12 @@ { "type": "category", "label": "Features", - "items": [ - "uplinks", - "packages", - "authentication", - "notifications", - "logger", - "webui" - ] + "items": ["uplinks", "packages", "authentication", "notifications", "logger", "webui"] }, { "type": "category", "label": "Server", - "items": [ - "server-configuration", - "reverse-proxy", - "ssl", - "windows", - "iss-server" - ] + "items": ["server-configuration", "reverse-proxy", "ssl", "windows", "iss-server"] }, { "type": "category", @@ -68,15 +46,15 @@ "items": [ "plugins", "dev-plugins", + { + "type": "link", + "label": "Search Plugins", + "href": "/dev/plugins-search" + }, { "type": "category", "label": "Dev Guides", - "items": [ - "plugin-generator", - "plugin-auth", - "plugin-middleware", - "plugin-storage" - ] + "items": ["plugin-generator", "plugin-auth", "plugin-middleware", "plugin-storage"] }, "node-api" ] @@ -90,27 +68,19 @@ { "type": "category", "label": "Cloud", - "items": [ - "amazon" - ] + "items": ["amazon"] }, { "type": "category", "label": "Tools", - "items": [ - "ansible", - "puppet", - "chef" - ] + "items": ["ansible", "puppet", "chef"] } ] }, { "type": "category", "label": "Guides", - "items": [ - "aws" - ] + "items": ["aws"] } ] } diff --git a/website/versions.json b/website/versions.json index b2e70a688..e49e09acc 100644 --- a/website/versions.json +++ b/website/versions.json @@ -1,3 +1 @@ -[ - "5.x" -] +["5.x"]