From 73a4dfec438c86114f5f4d5a3e37017c424de80c Mon Sep 17 00:00:00 2001 From: Turdalin Nurassyl <78026760+trdln@users.noreply.github.com> Date: Wed, 27 Mar 2024 06:39:09 +0500 Subject: [PATCH 1/3] docs(layers): tip about env variables of github and gitlab instance urls --- docs/2.guide/3.going-further/7.layers.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/2.guide/3.going-further/7.layers.md b/docs/2.guide/3.going-further/7.layers.md index 4533abfe49e5..8caa147f55ab 100644 --- a/docs/2.guide/3.going-further/7.layers.md +++ b/docs/2.guide/3.going-further/7.layers.md @@ -100,6 +100,10 @@ export default defineNuxtConfig({ If you want to extend a private remote source, you need to add the environment variable `GIGET_AUTH=` to provide a token. :: +::tip +If you want to extend a remote source from GitHub or GitLab instances, you need to add the environment variable `GIGET_GITHUB_URL=` or `GIGET_GITLAB_URL=` to provide a url. +:: + ::note When using git remote sources, if a layer has npm dependencies and you wish to install them, you can do so by specifying `install: true` in your layer options. From 37ab483e8a8dbb65c420b5ca01a7effdcb14d929 Mon Sep 17 00:00:00 2001 From: Daniel Roe Date: Wed, 27 Mar 2024 09:31:10 +0000 Subject: [PATCH 2/3] docs: mention it is self-hosted --- docs/2.guide/3.going-further/7.layers.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/2.guide/3.going-further/7.layers.md b/docs/2.guide/3.going-further/7.layers.md index 8caa147f55ab..5fd44722eaad 100644 --- a/docs/2.guide/3.going-further/7.layers.md +++ b/docs/2.guide/3.going-further/7.layers.md @@ -101,7 +101,7 @@ If you want to extend a private remote source, you need to add the environment v :: ::tip -If you want to extend a remote source from GitHub or GitLab instances, you need to add the environment variable `GIGET_GITHUB_URL=` or `GIGET_GITLAB_URL=` to provide a url. +If you want to extend a remote source from a self-hosted GitHub or GitLab instance, you will need to supply its URL with an environment variable: `GIGET_GITHUB_URL=` or `GIGET_GITLAB_URL=`. :: ::note From 2a5f48551e75662f99da4ae71f7ec031fdd92537 Mon Sep 17 00:00:00 2001 From: Daniel Roe Date: Fri, 19 Apr 2024 11:40:53 +0300 Subject: [PATCH 3/3] chore: update wording and mention `auth` option MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Damian Głowala --- docs/2.guide/3.going-further/7.layers.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/2.guide/3.going-further/7.layers.md b/docs/2.guide/3.going-further/7.layers.md index 5fd44722eaad..3285135cfdf4 100644 --- a/docs/2.guide/3.going-further/7.layers.md +++ b/docs/2.guide/3.going-further/7.layers.md @@ -101,7 +101,7 @@ If you want to extend a private remote source, you need to add the environment v :: ::tip -If you want to extend a remote source from a self-hosted GitHub or GitLab instance, you will need to supply its URL with an environment variable: `GIGET_GITHUB_URL=` or `GIGET_GITLAB_URL=`. +If you want to extend a remote source from a self-hosted GitHub or GitLab instance, you need to supply its URL with the `GIGET_GITHUB_URL=` or `GIGET_GITLAB_URL=` environment variable - or directly configure it with [the `auth` option](https://github.com/unjs/c12#extending-config-layer-from-remote-sources) in your `nuxt.config`. :: ::note