github.com/verdaccio
1
0
Fork 0
mirror of https://github.com/verdaccio/verdaccio.git synced 2024-11-13 03:35:52 +01:00
Code Releases Wiki Activity
2d0fb9ee93
verdaccio/packages/plugins/google-cloud-storage
History
Juan Picado e93d6a30a4
chore: vitest migration part 5 (#4914) 
* migrate web package to vitest

* migrate node-api to vitest

* migrate file-locking vitest

* migrate cli

* remove jest from npm packages

* Create weak-cherries-serve.md

* update ci
2024-10-20 19:26:36 +02:00
..
src feat!: replace deprecated request dependency by got (#3100) 2022-07-29 20:51:45 +02:00
.babelrc refactor: relocate verdaccio-google-cloud-storage plugin (#1978) 2021-04-09 17:54:23 +02:00
CHANGELOG.md chore: update versions (6-next) (#3079) 2022-04-04 12:55:13 +02:00
LICENSE refactor: relocate verdaccio-google-cloud-storage plugin (#1978) 2021-04-09 17:54:23 +02:00
package.json chore: vitest migration part 5 (#4914) 2024-10-20 19:26:36 +02:00
README.md refactor: relocate verdaccio-google-cloud-storage plugin (#1978) 2021-04-09 17:54:23 +02:00
tsconfig.build.json refactor: relocate verdaccio-google-cloud-storage plugin (#1978) 2021-04-09 17:54:23 +02:00
tsconfig.json chore(website): add api section (#3424) 2022-10-10 08:00:09 +02:00

README.md

verdaccio-google-cloud

npm CircleCI codecov FOSSA Status backers discord MIT

☁️📦 Google Cloud storage plugin for verdaccio

⚠️⚠️ This plugin is experimental and might be unstable. It requires further testing. ⚠️⚠️

npm i -g verdaccio-google-cloud
yarn global add verdaccio-google-cloud
pnpm i -g verdaccio-google-cloud

Requirements

  • Google Cloud Account
  • Service account with 'Cloud Datastore Owner' role and read/write access to the bucket
  • Verdaccio server (see below)
npm install -g verdaccio@latest
yarn global add verdaccio@latest
pnpm -g verdaccio@latest

Configuration

Complete configuration example:

store:
  google-cloud:
    ## google project id
    projectId: project-01 || env (GOOGLE_CLOUD_VERDACCIO_PROJECT_ID)

    ## namespace for metadata database
    kind: someRandonMetadataDatabaseKey

    ## this pluging do not create the bucket, it has to exist
    bucket: my-bucket-name

    ## google cloud recommend this file only for development
    ## this field is not mandatory
    keyFilename: /path/project-01.json || env (GOOGLE_CLOUD_VERDACCIO_KEY)

    ## default validation is, it can be overrided by
    ## https://cloud.google.com/nodejs/docs/reference/storage/1.6.x/File.html#createWriteStream
    # validation: crc32c

    ## Enable/disable resumable uploads to GC Storage
    ## By default it's enabled in `@google-cloud/storage`
    ## May cause failures for small package uploads so it is recommended to set it to `false`
    ## @see https://stackoverflow.com/questions/53172050/google-cloud-storage-invalid-upload-request-error-bad-request
    resumable: true

Define env whether you want load the value from environment variables.

If you are willing to use some of env just do not define properties on config.yaml or let them emtpy. Properties have preceden over env variables.

Disclaimer

⚠️⚠️ This plugin is experimental and might be unstable. It requires further testing. ⚠️⚠️

License

MIT Licensed

FOSSA Status