diff --git a/website/docs/cli.md b/website/docs/cli.md index 4b741d69e..a58c48f22 100644 --- a/website/docs/cli.md +++ b/website/docs/cli.md @@ -20,7 +20,7 @@ verdaccio --listen 4000 --config ~./config.yaml ## Default config file location {#default-config-file-location} -To locate the home directory, we rely on **$XDG_DATA_HOME** as a first choice and for Windows environments we look for the [APPDATA environment variable](https://www.howtogeek.com/318177/what-is-the-appdata-folder-in-windows/). +To locate the home directory, verdaccio relies on **$XDG_DATA_HOME** as a first choice and for Windows environments we look for the [APPDATA environment variable](https://www.howtogeek.com/318177/what-is-the-appdata-folder-in-windows/). ## Config file format {#config-file-format} diff --git a/website/docs/config.md b/website/docs/config.md index 2dae299ca..ebb266a4b 100644 --- a/website/docs/config.md +++ b/website/docs/config.md @@ -43,6 +43,28 @@ storage: ./storage > Released at v5.6.0: The environment variable `VERDACCIO_STORAGE_PATH` could be used to replace the location of the storage (only for the default storage, does not apply to plugins unless it is implemented independently). +### The `.verdaccio-db` database {#.verdaccio-db} + +:::info +Only available if user does not use a custom storage +::: + +By default verdaccio uses a little database to store private packages the `storage` property is defined in the `config.yaml` file. + +The location might change based in your operative system, see [here](cli.md) more details about location of files. + +The structure of the database is based in JSON file, for instance: + +```json +{ + "list": ["package1", "@scope/pkg2"], + "secret": "secret_token" +} +``` + +- `list`: Is an array with the list of the private packages published, any item on this list is considered being published by the user. +- `secret`: The secret field is used for verify the token signature, either for _JWT_ or legacy token signature. + ### Plugins {#plugins} Is the location of the plugin directory. Useful for Docker/Kubernetes-based deployments. diff --git a/website/versioned_docs/version-5.x/cli.md b/website/versioned_docs/version-5.x/cli.md index e71056e00..a02c3c8ea 100644 --- a/website/versioned_docs/version-5.x/cli.md +++ b/website/versioned_docs/version-5.x/cli.md @@ -20,7 +20,7 @@ verdaccio --listen 4000 --config ~./config.yaml ## Default config file location {#default-config-file-location} -To locate the home directory, we rely on **$XDG_DATA_HOME** as a first choice and for Windows environments we look for the [APPDATA environment variable](https://www.howtogeek.com/318177/what-is-the-appdata-folder-in-windows/). +To locate the home directory, verdaccio relies on **$XDG_DATA_HOME** as a first choice and for Windows environments we look for the [APPDATA environment variable](https://www.howtogeek.com/318177/what-is-the-appdata-folder-in-windows/). ## Config file format {#config-file-format} diff --git a/website/versioned_docs/version-5.x/config.md b/website/versioned_docs/version-5.x/config.md index 4757a2705..6a02c55e7 100644 --- a/website/versioned_docs/version-5.x/config.md +++ b/website/versioned_docs/version-5.x/config.md @@ -43,6 +43,28 @@ storage: ./storage > Released at v5.6.0: The environment variable `VERDACCIO_STORAGE_PATH` could be used to replace the location of the storage (only for the default storage, does not apply to plugins unless it is implemented independently). +### The `.verdaccio-db` database {#.verdaccio-db} + +:::info +Only available if user does not use a custom storage +::: + +By default verdaccio uses a little database to store private packages the `storage` property is defined in the `config.yaml` file. + +The location might change based in your operative system, see [here](cli.md) more details about location of files. + +The structure of the database is based in JSON file, for instance: + +```json +{ + "list": ["package1", "@scope/pkg2"], + "secret": "secret_token" +} +``` + +- `list`: Is an array with the list of the private packages published, any item on this list is considered being published by the user. +- `secret`: The secret field is used for verify the token signature, either for _JWT_ or legacy token signature. + ### Plugins {#plugins} Is the location of the plugin directory. Useful for Docker/Kubernetes-based deployments.