Infrastructure/verdaccio
0
Fork 0
mirror of https://github.com/verdaccio/verdaccio.git synced 2024-12-30 22:34:10 -05:00
Code Issues Activity

improve storage documentation

Browse source
This commit is contained in:
Juan Picado 2023-02-09 20:48:01 +01:00
parent ee5e5d55e6
commit 1b38fb2d30
4 changed files with 46 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
website/docs/cli.md
View file

@ -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}

22
website/docs/config.md
View file

@ -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.

2
website/versioned_docs/version-5.x/cli.md
View file

@ -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}

22
website/versioned_docs/version-5.x/config.md
View file

@ -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.