Skip to content

Commit

Permalink
Add documentation for bun and deno using private registry (#4661)
Browse files Browse the repository at this point in the history
* Add documentation for bun and deno using private registry

* Update setup-bun.md

* update docs
  • Loading branch information
juanpicado committed Jun 4, 2024
1 parent b06b2e7 commit 441c226
Show file tree
Hide file tree
Showing 9 changed files with 294 additions and 3 deletions.
46 changes: 46 additions & 0 deletions website/docs/setup-bun.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
id: setup-bun
title: 'bun'
---

# bun {#bun}

- [Example repository](https://github.com/juanpicado/verdaccio-with-bun)

## Using registry for a specific project {#specific}

Create a `bunfig.toml` file at the root of the project and set

```toml
[install]
registry = "http://localhost:4873"

```

On run `bun install` command the installation will be done from the local registry.

To enable authenticated access to the registry, you can set the token in the `bunfig.toml` file.

```toml
[install.scopes]

# as an object with token
"@scope" = { token = "$npm_token", url = "https://localhost:4873/" }
```

Bun provides other ways to configure the registry, you can find more information in the official documentation.

- [Override the default npm registry for bun install](https://bun.sh/guides/install/custom-registry)
- [Configure a private registry for an organization scope with bun install](https://bun.sh/guides/install/registry-scope)

## Troubleshooting {#troubleshooting}

### Clear cache with `bun`

To remove the cache, seems that you need to remove the `bun.lock` file, this file is created when you run `bun install` and it's located in the root of the project.

> It may be a better way to do this, please share new solutions.
```bash
rm bun.lockb
```
44 changes: 44 additions & 0 deletions website/docs/setup-deno.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
id: setup-deno
title: 'deno'
---

- [Example repository](https://github.com/juanpicado/verdaccio-with-deno)

# deno {#deno}

The minimum supported [deno](https://deno.com/blog/v1.44) version is >1.44.0

## Using registry for a specific project {#specific}

Create a `.npmrc` file and set

```bash
registry=http://localhost:4873
```

On run `deno` command the installation will be done from the local registry.

## Troubleshooting {#troubleshooting}

### Clear cache with `deno`

```bash
> deno info

DENO_DIR location: /Users/user/Library/Caches/deno
Remote modules cache: /Users/user/Library/Caches/deno/deps
npm modules cache: /Users/user/Library/Caches/deno/npm
Emitted modules cache: /Users/user/Library/Caches/deno/gen
Language server registries cache: /Users/user/Library/Caches/deno/registries
Origin storage: /Users/user/Library/Caches/deno/location_data
```

And remove the local cache for th specific registry you have set (by default is `localhost_4873`)

```bash
// for MAC OS users (other OS may vary)
rm -Rf /Users/user/Library/Caches/deno/npm/localhost_4873
```

> It's not clear if there is a better way to do this, please refer to the [following discussion](https://github.com/denoland/deno/discussions/9419) for more information.
9 changes: 8 additions & 1 deletion website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,14 @@ module.exports = {
{
type: 'category',
label: 'Setting up Verdaccio',
items: ['cli-registry', 'setup-npm', 'setup-yarn', 'setup-pnpm'],
items: [
'cli-registry',
'setup-npm',
'setup-yarn',
'setup-pnpm',
'setup-deno',
'setup-bun',
],
},
'who-is-using',
'best',
Expand Down
46 changes: 46 additions & 0 deletions website/versioned_docs/version-5.x/setup-bun.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
id: setup-bun
title: 'bun'
---

# bun {#bun}

- [Example repository](https://github.com/juanpicado/verdaccio-with-bun)

## Using registry for a specific project {#specific}

Create a `bunfig.toml` file at the root of the project and set

```toml
[install]
registry = "http://localhost:4873"

```

On run `bun install` command the installation will be done from the local registry.

To enable authenticated access to the registry, you can set the token in the `bunfig.toml` file.

```toml
[install.scopes]

# as an object with token
"@scope" = { token = "$npm_token", url = "https://localhost:4873/" }
```

Bun provides other ways to configure the registry, you can find more information in the official documentation.

- [Override the default npm registry for bun install](https://bun.sh/guides/install/custom-registry)
- [Configure a private registry for an organization scope with bun install](https://bun.sh/guides/install/registry-scope)

## Troubleshooting {#troubleshooting}

### Clear cache with `bun`

To remove the cache, seems that you need to remove the `bun.lock` file, this file is created when you run `bun install` and it's located in the root of the project.

> It may be a better way to do this, please share new solutions.
```bash
rm bun.lockb
```
44 changes: 44 additions & 0 deletions website/versioned_docs/version-5.x/setup-deno.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
id: setup-deno
title: 'deno'
---

- [Example repository](https://github.com/juanpicado/verdaccio-with-deno)

# deno {#deno}

The minimum supported [deno](https://deno.com/blog/v1.44) version is >1.44.0

## Using registry for a specific project {#specific}

Create a `.npmrc` file and set

```bash
registry=http://localhost:4873
```

On run `deno` command the installation will be done from the local registry.

## Troubleshooting {#troubleshooting}

### Clear cache with `deno`

```bash
> deno info

DENO_DIR location: /Users/user/Library/Caches/deno
Remote modules cache: /Users/user/Library/Caches/deno/deps
npm modules cache: /Users/user/Library/Caches/deno/npm
Emitted modules cache: /Users/user/Library/Caches/deno/gen
Language server registries cache: /Users/user/Library/Caches/deno/registries
Origin storage: /Users/user/Library/Caches/deno/location_data
```

And remove the local cache for th specific registry you have set (by default is `localhost_4873`)

```bash
// for MAC OS users (other OS may vary)
rm -Rf /Users/user/Library/Caches/deno/npm/localhost_4873
```

> It's not clear if there is a better way to do this, please refer to the [following discussion](https://github.com/denoland/deno/discussions/9419) for more information.
46 changes: 46 additions & 0 deletions website/versioned_docs/version-6.x/setup-bun.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
id: setup-bun
title: 'bun'
---

# bun {#bun}

- [Example repository](https://github.com/juanpicado/verdaccio-with-bun)

## Using registry for a specific project {#specific}

Create a `bunfig.toml` file at the root of the project and set

```toml
[install]
registry = "http://localhost:4873"

```

On run `bun install` command the installation will be done from the local registry.

To enable authenticated access to the registry, you can set the token in the `bunfig.toml` file.

```toml
[install.scopes]

# as an object with token
"@scope" = { token = "$npm_token", url = "https://localhost:4873/" }
```

Bun provides other ways to configure the registry, you can find more information in the official documentation.

- [Override the default npm registry for bun install](https://bun.sh/guides/install/custom-registry)
- [Configure a private registry for an organization scope with bun install](https://bun.sh/guides/install/registry-scope)

## Troubleshooting {#troubleshooting}

### Clear cache with `bun`

To remove the cache, seems that you need to remove the `bun.lock` file, this file is created when you run `bun install` and it's located in the root of the project.

> It may be a better way to do this, please share new solutions.
```bash
rm bun.lockb
```
44 changes: 44 additions & 0 deletions website/versioned_docs/version-6.x/setup-deno.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
id: setup-deno
title: 'deno'
---

- [Example repository](https://github.com/juanpicado/verdaccio-with-deno)

# deno {#deno}

The minimum supported [deno](https://deno.com/blog/v1.44) version is >1.44.0

## Using registry for a specific project {#specific}

Create a `.npmrc` file and set

```bash
registry=http://localhost:4873
```

On run `deno` command the installation will be done from the local registry.

## Troubleshooting {#troubleshooting}

### Clear cache with `deno`

```bash
> deno info

DENO_DIR location: /Users/user/Library/Caches/deno
Remote modules cache: /Users/user/Library/Caches/deno/deps
npm modules cache: /Users/user/Library/Caches/deno/npm
Emitted modules cache: /Users/user/Library/Caches/deno/gen
Language server registries cache: /Users/user/Library/Caches/deno/registries
Origin storage: /Users/user/Library/Caches/deno/location_data
```

And remove the local cache for th specific registry you have set (by default is `localhost_4873`)

```bash
// for MAC OS users (other OS may vary)
rm -Rf /Users/user/Library/Caches/deno/npm/localhost_4873
```

> It's not clear if there is a better way to do this, please refer to the [following discussion](https://github.com/denoland/deno/discussions/9419) for more information.
9 changes: 8 additions & 1 deletion website/versioned_sidebars/version-5.x-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,14 @@
{
"type": "category",
"label": "Setting up Verdaccio",
"items": ["cli-registry", "setup-npm", "setup-yarn", "setup-pnpm"]
"items": [
"cli-registry",
"setup-npm",
"setup-yarn",
"setup-pnpm",
"setup-deno",
"setup-bun"
]
},
"configuration",
"who-is-using",
Expand Down
9 changes: 8 additions & 1 deletion website/versioned_sidebars/version-6.x-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,14 @@
{
"type": "category",
"label": "Setting up Verdaccio",
"items": ["cli-registry", "setup-npm", "setup-yarn", "setup-pnpm"]
"items": [
"cli-registry",
"setup-npm",
"setup-yarn",
"setup-pnpm",
"setup-deno",
"setup-bun"
]
},
"who-is-using",
"best",
Expand Down

0 comments on commit 441c226

Please sign in to comment.