From eb8628ad075907e61cd255fe76c0d0452f05c1f6 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Mon, 25 Mar 2024 11:42:50 +0000 Subject: [PATCH] feat: Change default to services being listed on the statistics page (#129) bagetter/BaGetter@4851f9e606b643da73291ea1b918bbb9c84ce4fc --- 404.html | 2 +- assets/js/9ed00105.0ef34a81.js | 1 + assets/js/9ed00105.3e27619b.js | 1 - ...ntime~main.05b0267d.js => runtime~main.8a8dc0ff.js} | 2 +- docs.html | 2 +- docs/Advanced/debugging.html | 2 +- docs/Advanced/sdk.html | 2 +- docs/Import/local-feeds.html | 2 +- docs/Import/nugetorg.html | 2 +- docs/Import/nugetserver.html | 2 +- docs/Installation/aliyun.html | 2 +- docs/Installation/aws.html | 2 +- docs/Installation/azure.html | 2 +- docs/Installation/docker.html | 2 +- docs/Installation/gcp.html | 2 +- docs/Installation/iis-proxy.html | 2 +- docs/Installation/local.html | 2 +- docs/configuration.html | 10 +++++----- docs/vs/artifactory.html | 2 +- docs/vs/azure-artifacts.html | 2 +- docs/vs/liget.html | 2 +- docs/vs/local-feeds.html | 2 +- docs/vs/myget.html | 2 +- docs/vs/nexus.html | 2 +- docs/vs/nugetorg.html | 2 +- docs/vs/nugetserver.html | 2 +- docs/vs/teamcity.html | 2 +- index.html | 2 +- 28 files changed, 31 insertions(+), 31 deletions(-) create mode 100644 assets/js/9ed00105.0ef34a81.js delete mode 100644 assets/js/9ed00105.3e27619b.js rename assets/js/{runtime~main.05b0267d.js => runtime~main.8a8dc0ff.js} (98%) diff --git a/404.html b/404.html index fd5088a..0d3ad77 100644 --- a/404.html +++ b/404.html @@ -4,7 +4,7 @@ Page Not Found | BaGetter - + diff --git a/assets/js/9ed00105.0ef34a81.js b/assets/js/9ed00105.0ef34a81.js new file mode 100644 index 0000000..1c90256 --- /dev/null +++ b/assets/js/9ed00105.0ef34a81.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkba_getter=self.webpackChunkba_getter||[]).push([[4],{8373:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>t,metadata:()=>o,toc:()=>l});var i=s(5893),a=s(1151);const t={},r="Configuration",o={id:"configuration",title:"Configuration",description:"You can modify BaGetter's configurations by editing the appsettings.json file.",source:"@site/docs/configuration.md",sourceDirName:".",slug:"/configuration",permalink:"/docs/configuration",draft:!1,unlisted:!1,editUrl:"https://github.com/bagetter/BaGetter/tree/main/docs/docs/configuration.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Run BaGetter on your Computer",permalink:"/docs/Installation/local"},next:{title:"Artifactory",permalink:"/docs/vs/artifactory"}},c={},l=[{value:"Require an API key",id:"require-an-api-key",level:2},{value:"Enable read-through caching",id:"enable-read-through-caching",level:2},{value:"Enable package hard deletions",id:"enable-package-hard-deletions",level:2},{value:"Enable package overwrites",id:"enable-package-overwrites",level:2},{value:"Private feeds",id:"private-feeds",level:2},{value:"Database configuration",id:"database-configuration",level:2},{value:"Environment Variables",id:"environment-variables",level:3},{value:"appsettings.json",id:"appsettingsjson",level:3},{value:"IIS server options",id:"iis-server-options",level:2},{value:"Health Endpoint",id:"health-endpoint",level:2},{value:"Maximum package size",id:"maximum-package-size",level:2},{value:"Statistics",id:"statistics",level:2},{value:"Load secrets from files",id:"load-secrets-from-files",level:2},{value:"Docker Compose example",id:"docker-compose-example",level:3}];function d(e){const n={a:"a",admonition:"admonition",br:"br",code:"code",h1:"h1",h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"configuration",children:"Configuration"}),"\n",(0,i.jsxs)(n.p,{children:["You can modify BaGetter's configurations by editing the ",(0,i.jsx)(n.code,{children:"appsettings.json"})," file."]}),"\n",(0,i.jsx)(n.h2,{id:"require-an-api-key",children:"Require an API key"}),"\n",(0,i.jsxs)(n.p,{children:["You can require that users provide a password, called an API key, to publish packages.\nTo do so, you can insert the desired API key in the ",(0,i.jsx)(n.code,{children:"ApiKey"})," field."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-json",children:'{\n "ApiKey": "NUGET-SERVER-API-KEY",\n ...\n}\n'})}),"\n",(0,i.jsx)(n.p,{children:"Users will now have to provide the API key to push packages:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-shell",children:"dotnet nuget push -s http://localhost:5000/v3/index.json -k NUGET-SERVER-API-KEY package.1.0.0.nupkg\n"})}),"\n",(0,i.jsx)(n.h2,{id:"enable-read-through-caching",children:"Enable read-through caching"}),"\n",(0,i.jsx)(n.p,{children:"Read-through caching lets you index packages from an upstream source. You can use read-through\ncaching to:"}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsxs)(n.li,{children:["Speed up your builds if restores from ",(0,i.jsx)(n.a,{href:"https://nuget.org",children:"nuget.org"})," are slow"]}),"\n",(0,i.jsx)(n.li,{children:"Enable package restores in offline scenarios"}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The following ",(0,i.jsx)(n.code,{children:"Mirror"})," setting configures BaGetter to index packages from ",(0,i.jsx)(n.a,{href:"https://nuget.org",children:"nuget.org"}),":"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-json",children:'{\n ...\n\n "Mirror": {\n "Enabled": true,\n "PackageSource": "https://api.nuget.org/v3/index.json"\n },\n\n ...\n}\n'})}),"\n",(0,i.jsx)(n.admonition,{type:"info",children:(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"PackageSource"})," is the value of the ",(0,i.jsx)(n.a,{href:"https://docs.microsoft.com/nuget/api/service-index",children:"NuGet service index"}),"."]})}),"\n",(0,i.jsx)(n.h2,{id:"enable-package-hard-deletions",children:"Enable package hard deletions"}),"\n",(0,i.jsxs)(n.p,{children:["To prevent the ",(0,i.jsx)(n.a,{href:"https://blog.npmjs.org/post/141577284765/kik-left-pad-and-npm",children:'"left pad" problem'}),",\nBaGetter's default configuration doesn't allow package deletions. Whenever BaGetter receives a package deletion\nrequest, it will instead \"unlist\" the package. An unlisted package is undiscoverable but can still be\ndownloaded if you know the package's id and version. You can override this behavior by setting the\n",(0,i.jsx)(n.code,{children:"PackageDeletionBehavior"}),":"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-json",children:'{\n ...\n\n "PackageDeletionBehavior": "HardDelete",\n\n ...\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"enable-package-overwrites",children:"Enable package overwrites"}),"\n",(0,i.jsxs)(n.p,{children:["Normally, BaGetter will reject a package upload if the id and version are already taken. This is to maintain the ",(0,i.jsx)(n.a,{href:"https://learn.microsoft.com/azure/devops/artifacts/artifacts-key-concepts?view=azure-devops#immutability",children:"immutability of semantically versioned packages"}),"."]}),"\n",(0,i.jsx)(n.admonition,{type:"warning",children:(0,i.jsx)(n.p,{children:"NuGet clients cache packages on multiple levels, so overwriting a package can lead to unexpected behavior.\nA client may have a cached version of the package that is different from the one on the server.\nMake sure that everyone involved is aware of the implications of overwriting packages."})}),"\n",(0,i.jsxs)(n.p,{children:["You can configure BaGetter to overwrite the already existing package by setting ",(0,i.jsx)(n.code,{children:"AllowPackageOverwrites"}),":"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-json",children:'{\n ...\n\n "AllowPackageOverwrites": "true",\n\n ...\n}\n'})}),"\n",(0,i.jsxs)(n.p,{children:["To allow pre-release versions to be overwritten but not stable releases, set ",(0,i.jsx)(n.code,{children:"AllowPackageOverwrites"})," to ",(0,i.jsx)(n.code,{children:"PrereleaseOnly"}),"."]}),"\n",(0,i.jsx)(n.p,{children:'Pushing a package with a pre-release version like "3.1.0-SNAPSHOT" will overwrite the existing "3.1.0-SNAPSHOT" package, but pushing a "3.1.0" package will fail if a "3.1.0" package already exists.'}),"\n",(0,i.jsx)(n.h2,{id:"private-feeds",children:"Private feeds"}),"\n",(0,i.jsx)(n.p,{children:"A private feed requires users to authenticate before accessing packages."}),"\n",(0,i.jsx)(n.admonition,{type:"warning",children:(0,i.jsxs)(n.p,{children:["Private feeds are not supported at this time! See ",(0,i.jsx)(n.a,{href:"https://github.com/loic-sharma/BaGet/pull/69",children:"this pull request"})," for more information."]})}),"\n",(0,i.jsx)(n.h2,{id:"database-configuration",children:"Database configuration"}),"\n",(0,i.jsx)(n.p,{children:"BaGetter supports multiple database engines for storing package information:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["MySQL: ",(0,i.jsx)(n.code,{children:"MySql"})]}),"\n",(0,i.jsxs)(n.li,{children:["SQLite: ",(0,i.jsx)(n.code,{children:"Sqlite"})]}),"\n",(0,i.jsxs)(n.li,{children:["SQL Server: ",(0,i.jsx)(n.code,{children:"SqlServer"})]}),"\n",(0,i.jsxs)(n.li,{children:["PostgreSQL: ",(0,i.jsx)(n.code,{children:"PostgreSql"})]}),"\n",(0,i.jsxs)(n.li,{children:["Azure Table Storage: ",(0,i.jsx)(n.code,{children:"AzureTable"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Each database engine requires a connection string to configure the connection. Please refer to ",(0,i.jsx)(n.a,{href:"https://www.connectionstrings.com/",children:"ConnectionStrings.com"})," to learn how to create the proper connection string for each database engine."]}),"\n",(0,i.jsxs)(n.p,{children:["You may configure the chosen database engine either using environment variables or by editing the ",(0,i.jsx)(n.code,{children:"appsettings.json"})," file."]}),"\n",(0,i.jsx)(n.h3,{id:"environment-variables",children:"Environment Variables"}),"\n",(0,i.jsx)(n.p,{children:"There are two environment variables related to database configuration. These are:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Database__Type"}),": The database engine to use, this should be one of the strings from the above list such as ",(0,i.jsx)(n.code,{children:"PostgreSql"})," or ",(0,i.jsx)(n.code,{children:"Sqlite"}),"."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Database__ConnectionString"}),": The connection string for your database engine."]}),"\n"]}),"\n",(0,i.jsx)(n.h3,{id:"appsettingsjson",children:(0,i.jsx)(n.code,{children:"appsettings.json"})}),"\n",(0,i.jsxs)(n.p,{children:["The database settings are located under the ",(0,i.jsx)(n.code,{children:"Database"})," key in the ",(0,i.jsx)(n.code,{children:"appsettings.json"})," configuration file:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-json",children:'{\n ...\n\n "Database": {\n "Type": "Sqlite",\n "ConnectionString": "Data Source=bagetter.db"\n },\n\n ...\n}\n'})}),"\n",(0,i.jsx)(n.p,{children:"There are two settings related to the database configuration:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Type"}),": The database engine to use, this should be one of the strings from the above list such as ",(0,i.jsx)(n.code,{children:"PostgreSql"})," or ",(0,i.jsx)(n.code,{children:"Sqlite"}),"."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"ConnectionString"}),": The connection string for your database engine."]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"iis-server-options",children:"IIS server options"}),"\n",(0,i.jsxs)(n.p,{children:["IIS Server options can be configured under the ",(0,i.jsx)(n.code,{children:"IISServerOptions"})," key. The available options are detailed at ",(0,i.jsx)(n.a,{href:"https://docs.microsoft.com/dotnet/api/microsoft.aspnetcore.builder.iisserveroptions",children:"docs.microsoft.com"})]}),"\n",(0,i.jsx)(n.admonition,{type:"note",children:(0,i.jsxs)(n.p,{children:["If not specified, the ",(0,i.jsx)(n.code,{children:"MaxRequestBodySize"})," in BaGetter defaults to 250MB (262144000 bytes), rather than the ASP.NET Core default of 30MB."]})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-json",children:'{\n ...\n\n "IISServerOptions": {\n "MaxRequestBodySize": 262144000\n },\n\n ...\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"health-endpoint",children:"Health Endpoint"}),"\n",(0,i.jsxs)(n.p,{children:["A health endpoint is exposed at ",(0,i.jsx)(n.code,{children:"/health"})," that returns 200 OK or 503 Service Unavailable and always includes a json object listing the current status of the application:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-json",children:'{\n "Status": "Healthy",\n "Sqlite": "Healthy",\n ...\n}\n'})}),"\n",(0,i.jsxs)(n.p,{children:["The services can be omitted by setting the ",(0,i.jsx)(n.code,{children:"Statistics:ListConfiguredServices"})," to false, in which case only the ",(0,i.jsx)(n.code,{children:"Status"})," property is returned in the json object."]}),"\n",(0,i.jsx)(n.p,{children:'This path and the name of the "Status" property are configurable if needed:'}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-json",children:'{\n ...\n\n "HealthCheck": {\n "Path": "/healthz",\n "StatusPropertyName": "Status"\n },\n\n ...\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"maximum-package-size",children:"Maximum package size"}),"\n",(0,i.jsxs)(n.p,{children:["The max package size default to 8GiB and can be configured using the ",(0,i.jsx)(n.code,{children:"MaxPackageSizeGiB"})," setting. The NuGet gallery currently has a 250MB limit, which is enough for most packages.\nThis can be useful if you are hosting a private feed and need to host large packages that include chocolatey installers, machine learning models, etc."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-json",children:'{\n ...\n\n "MaxPackageSizeGiB": 8,\n\n ...\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"statistics",children:"Statistics"}),"\n",(0,i.jsxs)(n.p,{children:["On the application's statistics page the currently used services and overall package and version counts are listed.\nYou can hide or show this page by modifying the ",(0,i.jsx)(n.code,{children:"EnableStatisticsPage"})," configuration.",(0,i.jsx)(n.br,{}),"\n","If you set ",(0,i.jsx)(n.code,{children:"ListConfiguredServices"})," to ",(0,i.jsx)(n.code,{children:"false"})," the currently used services for database and storage (such as ",(0,i.jsx)(n.code,{children:"Sqlite"}),") are omitted on the stats page:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-json",children:'{\n ...\n\n "Statistics": {\n "EnableStatisticsPage": true,\n "ListConfiguredServices": false\n },\n\n ...\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"load-secrets-from-files",children:"Load secrets from files"}),"\n",(0,i.jsxs)(n.p,{children:["Mostly useful when running containerised (e.g. using Docker, Podman, Kubernetes, etc), the application will look for files named in the same pattern as environment variables under ",(0,i.jsx)(n.code,{children:"/run/secrets"}),"."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-shell",children:"/run/secrets/Database__ConnectionString\n"})}),"\n",(0,i.jsx)(n.p,{children:"This allows for sensitive values to be provided individually to the application, typically by bind-mounting files."}),"\n",(0,i.jsx)(n.h3,{id:"docker-compose-example",children:"Docker Compose example"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-yaml",children:"version: '2'\n\nservices:\n bagetter:\n image: bagetter/bagetter:latest\n volumes:\n # Single file mounted for API key\n - ./secrets/api-key.txt:/run/secrets/ApiKey:ro\n - ./data:/srv/baget\n environment:\n - Database__ConnectionString=Data Source=/srv/baget/bagetter.db\n - Database__Type=Sqlite\n - Mirror__Enabled=false\n - Storage__Type=FileSystem\n - Storage__Path=/srv/baget/packages\n"})}),"\n",(0,i.jsx)(n.p,{children:"Aditional documentation for secrets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"https://docs.docker.com/compose/use-secrets",children:"How to use secrets in Docker Compose"})}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"https://docs.docker.com/engine/swarm/secrets",children:"Docker Swarm secrets"})}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"https://kubernetes.io/docs/concepts/configuration/secret",children:"Kubernetes secrets"})}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"https://docs.microsoft.com/aspnet/core/fundamentals/configuration/#key-per-file-configuration-provider",children:"ASP.NET Core Documentation"})}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},1151:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>r});var i=s(7294);const a={},t=i.createContext(a);function r(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:r(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9ed00105.3e27619b.js b/assets/js/9ed00105.3e27619b.js deleted file mode 100644 index d96b4d2..0000000 --- a/assets/js/9ed00105.3e27619b.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkba_getter=self.webpackChunkba_getter||[]).push([[4],{8373:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>a,metadata:()=>o,toc:()=>l});var i=s(5893),t=s(1151);const a={},r="Configuration",o={id:"configuration",title:"Configuration",description:"You can modify BaGetter's configurations by editing the appsettings.json file.",source:"@site/docs/configuration.md",sourceDirName:".",slug:"/configuration",permalink:"/docs/configuration",draft:!1,unlisted:!1,editUrl:"https://github.com/bagetter/BaGetter/tree/main/docs/docs/configuration.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Run BaGetter on your Computer",permalink:"/docs/Installation/local"},next:{title:"Artifactory",permalink:"/docs/vs/artifactory"}},c={},l=[{value:"Require an API key",id:"require-an-api-key",level:2},{value:"Enable read-through caching",id:"enable-read-through-caching",level:2},{value:"Enable package hard deletions",id:"enable-package-hard-deletions",level:2},{value:"Enable package overwrites",id:"enable-package-overwrites",level:2},{value:"Private feeds",id:"private-feeds",level:2},{value:"Database configuration",id:"database-configuration",level:2},{value:"Environment Variables",id:"environment-variables",level:3},{value:"appsettings.json",id:"appsettingsjson",level:3},{value:"IIS server options",id:"iis-server-options",level:2},{value:"Health Endpoint",id:"health-endpoint",level:2},{value:"Maximum package size",id:"maximum-package-size",level:2},{value:"Statistics",id:"statistics",level:2},{value:"Load secrets from files",id:"load-secrets-from-files",level:2},{value:"Docker Compose example",id:"docker-compose-example",level:3}];function d(e){const n={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"configuration",children:"Configuration"}),"\n",(0,i.jsxs)(n.p,{children:["You can modify BaGetter's configurations by editing the ",(0,i.jsx)(n.code,{children:"appsettings.json"})," file."]}),"\n",(0,i.jsx)(n.h2,{id:"require-an-api-key",children:"Require an API key"}),"\n",(0,i.jsxs)(n.p,{children:["You can require that users provide a password, called an API key, to publish packages.\nTo do so, you can insert the desired API key in the ",(0,i.jsx)(n.code,{children:"ApiKey"})," field."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-json",children:'{\n "ApiKey": "NUGET-SERVER-API-KEY",\n ...\n}\n'})}),"\n",(0,i.jsx)(n.p,{children:"Users will now have to provide the API key to push packages:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-shell",children:"dotnet nuget push -s http://localhost:5000/v3/index.json -k NUGET-SERVER-API-KEY package.1.0.0.nupkg\n"})}),"\n",(0,i.jsx)(n.h2,{id:"enable-read-through-caching",children:"Enable read-through caching"}),"\n",(0,i.jsx)(n.p,{children:"Read-through caching lets you index packages from an upstream source. You can use read-through\ncaching to:"}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsxs)(n.li,{children:["Speed up your builds if restores from ",(0,i.jsx)(n.a,{href:"https://nuget.org",children:"nuget.org"})," are slow"]}),"\n",(0,i.jsx)(n.li,{children:"Enable package restores in offline scenarios"}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The following ",(0,i.jsx)(n.code,{children:"Mirror"})," setting configures BaGetter to index packages from ",(0,i.jsx)(n.a,{href:"https://nuget.org",children:"nuget.org"}),":"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-json",children:'{\n ...\n\n "Mirror": {\n "Enabled": true,\n "PackageSource": "https://api.nuget.org/v3/index.json"\n },\n\n ...\n}\n'})}),"\n",(0,i.jsx)(n.admonition,{type:"info",children:(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"PackageSource"})," is the value of the ",(0,i.jsx)(n.a,{href:"https://docs.microsoft.com/nuget/api/service-index",children:"NuGet service index"}),"."]})}),"\n",(0,i.jsx)(n.h2,{id:"enable-package-hard-deletions",children:"Enable package hard deletions"}),"\n",(0,i.jsxs)(n.p,{children:["To prevent the ",(0,i.jsx)(n.a,{href:"https://blog.npmjs.org/post/141577284765/kik-left-pad-and-npm",children:'"left pad" problem'}),",\nBaGetter's default configuration doesn't allow package deletions. Whenever BaGetter receives a package deletion\nrequest, it will instead \"unlist\" the package. An unlisted package is undiscoverable but can still be\ndownloaded if you know the package's id and version. You can override this behavior by setting the\n",(0,i.jsx)(n.code,{children:"PackageDeletionBehavior"}),":"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-json",children:'{\n ...\n\n "PackageDeletionBehavior": "HardDelete",\n\n ...\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"enable-package-overwrites",children:"Enable package overwrites"}),"\n",(0,i.jsxs)(n.p,{children:["Normally, BaGetter will reject a package upload if the id and version are already taken. This is to maintain the ",(0,i.jsx)(n.a,{href:"https://learn.microsoft.com/azure/devops/artifacts/artifacts-key-concepts?view=azure-devops#immutability",children:"immutability of semantically versioned packages"}),"."]}),"\n",(0,i.jsx)(n.admonition,{type:"warning",children:(0,i.jsx)(n.p,{children:"NuGet clients cache packages on multiple levels, so overwriting a package can lead to unexpected behavior.\nA client may have a cached version of the package that is different from the one on the server.\nMake sure that everyone involved is aware of the implications of overwriting packages."})}),"\n",(0,i.jsxs)(n.p,{children:["You can configure BaGetter to overwrite the already existing package by setting ",(0,i.jsx)(n.code,{children:"AllowPackageOverwrites"}),":"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-json",children:'{\n ...\n\n "AllowPackageOverwrites": "true",\n\n ...\n}\n'})}),"\n",(0,i.jsxs)(n.p,{children:["To allow pre-release versions to be overwritten but not stable releases, set ",(0,i.jsx)(n.code,{children:"AllowPackageOverwrites"})," to ",(0,i.jsx)(n.code,{children:"PrereleaseOnly"}),"."]}),"\n",(0,i.jsx)(n.p,{children:'Pushing a package with a pre-release version like "3.1.0-SNAPSHOT" will overwrite the existing "3.1.0-SNAPSHOT" package, but pushing a "3.1.0" package will fail if a "3.1.0" package already exists.'}),"\n",(0,i.jsx)(n.h2,{id:"private-feeds",children:"Private feeds"}),"\n",(0,i.jsx)(n.p,{children:"A private feed requires users to authenticate before accessing packages."}),"\n",(0,i.jsx)(n.admonition,{type:"warning",children:(0,i.jsxs)(n.p,{children:["Private feeds are not supported at this time! See ",(0,i.jsx)(n.a,{href:"https://github.com/loic-sharma/BaGet/pull/69",children:"this pull request"})," for more information."]})}),"\n",(0,i.jsx)(n.h2,{id:"database-configuration",children:"Database configuration"}),"\n",(0,i.jsx)(n.p,{children:"BaGetter supports multiple database engines for storing package information:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["MySQL: ",(0,i.jsx)(n.code,{children:"MySql"})]}),"\n",(0,i.jsxs)(n.li,{children:["SQLite: ",(0,i.jsx)(n.code,{children:"Sqlite"})]}),"\n",(0,i.jsxs)(n.li,{children:["SQL Server: ",(0,i.jsx)(n.code,{children:"SqlServer"})]}),"\n",(0,i.jsxs)(n.li,{children:["PostgreSQL: ",(0,i.jsx)(n.code,{children:"PostgreSql"})]}),"\n",(0,i.jsxs)(n.li,{children:["Azure Table Storage: ",(0,i.jsx)(n.code,{children:"AzureTable"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Each database engine requires a connection string to configure the connection. Please refer to ",(0,i.jsx)(n.a,{href:"https://www.connectionstrings.com/",children:"ConnectionStrings.com"})," to learn how to create the proper connection string for each database engine."]}),"\n",(0,i.jsxs)(n.p,{children:["You may configure the chosen database engine either using environment variables or by editing the ",(0,i.jsx)(n.code,{children:"appsettings.json"})," file."]}),"\n",(0,i.jsx)(n.h3,{id:"environment-variables",children:"Environment Variables"}),"\n",(0,i.jsx)(n.p,{children:"There are two environment variables related to database configuration. These are:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Database__Type"}),": The database engine to use, this should be one of the strings from the above list such as ",(0,i.jsx)(n.code,{children:"PostgreSql"})," or ",(0,i.jsx)(n.code,{children:"Sqlite"}),"."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Database__ConnectionString"}),": The connection string for your database engine."]}),"\n"]}),"\n",(0,i.jsx)(n.h3,{id:"appsettingsjson",children:(0,i.jsx)(n.code,{children:"appsettings.json"})}),"\n",(0,i.jsxs)(n.p,{children:["The database settings are located under the ",(0,i.jsx)(n.code,{children:"Database"})," key in the ",(0,i.jsx)(n.code,{children:"appsettings.json"})," configuration file:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-json",children:'{\n ...\n\n "Database": {\n "Type": "Sqlite",\n "ConnectionString": "Data Source=bagetter.db"\n },\n\n ...\n}\n'})}),"\n",(0,i.jsx)(n.p,{children:"There are two settings related to the database configuration:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Type"}),": The database engine to use, this should be one of the strings from the above list such as ",(0,i.jsx)(n.code,{children:"PostgreSql"})," or ",(0,i.jsx)(n.code,{children:"Sqlite"}),"."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"ConnectionString"}),": The connection string for your database engine."]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"iis-server-options",children:"IIS server options"}),"\n",(0,i.jsxs)(n.p,{children:["IIS Server options can be configured under the ",(0,i.jsx)(n.code,{children:"IISServerOptions"})," key. The available options are detailed at ",(0,i.jsx)(n.a,{href:"https://docs.microsoft.com/dotnet/api/microsoft.aspnetcore.builder.iisserveroptions",children:"docs.microsoft.com"})]}),"\n",(0,i.jsx)(n.admonition,{type:"note",children:(0,i.jsxs)(n.p,{children:["If not specified, the ",(0,i.jsx)(n.code,{children:"MaxRequestBodySize"})," in BaGetter defaults to 250MB (262144000 bytes), rather than the ASP.NET Core default of 30MB."]})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-json",children:'{\n ...\n\n "IISServerOptions": {\n "MaxRequestBodySize": 262144000\n },\n\n ...\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"health-endpoint",children:"Health Endpoint"}),"\n",(0,i.jsxs)(n.p,{children:["A health endpoint is exposed at ",(0,i.jsx)(n.code,{children:"/health"})," that returns 200 OK or 503 Service Unavailable and always includes a json object listing the current status of the application:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-json",children:'{\n "Status": "Healthy",\n "Sqlite": "Healthy",\n ...\n}\n'})}),"\n",(0,i.jsxs)(n.p,{children:["The services can be omitted by setting the ",(0,i.jsx)(n.code,{children:"Statistics:ListConfiguredServices"})," to false, in which case only the ",(0,i.jsx)(n.code,{children:"Status"})," property is returned in the json object."]}),"\n",(0,i.jsx)(n.p,{children:'This path and the name of the "Status" property are configurable if needed:'}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-json",children:'{\n ...\n\n "HealthCheck": {\n "Path": "/healthz",\n "StatusPropertyName": "Status"\n },\n\n ...\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"maximum-package-size",children:"Maximum package size"}),"\n",(0,i.jsxs)(n.p,{children:["The max package size default to 8GiB and can be configured using the ",(0,i.jsx)(n.code,{children:"MaxPackageSizeGiB"})," setting. The NuGet gallery currently has a 250MB limit, which is enough for most packages.\nThis can be useful if you are hosting a private feed and need to host large packages that include chocolatey installers, machine learning models, etc."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-json",children:'{\n ...\n\n "MaxPackageSizeGiB": 8,\n\n ...\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"statistics",children:"Statistics"}),"\n",(0,i.jsxs)(n.p,{children:["On the application's statistics page the currently used services are listed.\nYou can hide or show this part by modifying the ",(0,i.jsx)(n.code,{children:"EnableStatisticsPage"})," configuration:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-json",children:'{\n ...\n\n "Statistics": {\n "EnableStatisticsPage": false,\n "ListConfiguredServices": false\n },\n\n ...\n}\n'})}),"\n",(0,i.jsxs)(n.p,{children:["If you set ",(0,i.jsx)(n.code,{children:"ListConfiguredServices"})," to ",(0,i.jsx)(n.code,{children:"true"})," the currently used services for database and storage are shown on the stats page."]}),"\n",(0,i.jsx)(n.h2,{id:"load-secrets-from-files",children:"Load secrets from files"}),"\n",(0,i.jsxs)(n.p,{children:["Mostly useful when running containerised (e.g. using Docker, Podman, Kubernetes, etc), the application will look for files named in the same pattern as environment variables under ",(0,i.jsx)(n.code,{children:"/run/secrets"}),"."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-shell",children:"/run/secrets/Database__ConnectionString\n"})}),"\n",(0,i.jsx)(n.p,{children:"This allows for sensitive values to be provided individually to the application, typically by bind-mounting files."}),"\n",(0,i.jsx)(n.h3,{id:"docker-compose-example",children:"Docker Compose example"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-yaml",children:"version: '2'\n\nservices:\n bagetter:\n image: bagetter/bagetter:latest\n volumes:\n # Single file mounted for API key\n - ./secrets/api-key.txt:/run/secrets/ApiKey:ro\n - ./data:/srv/baget\n environment:\n - Database__ConnectionString=Data Source=/srv/baget/bagetter.db\n - Database__Type=Sqlite\n - Mirror__Enabled=false\n - Storage__Type=FileSystem\n - Storage__Path=/srv/baget/packages\n"})}),"\n",(0,i.jsx)(n.p,{children:"Aditional documentation for secrets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"https://docs.docker.com/compose/use-secrets",children:"How to use secrets in Docker Compose"})}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"https://docs.docker.com/engine/swarm/secrets",children:"Docker Swarm secrets"})}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"https://kubernetes.io/docs/concepts/configuration/secret",children:"Kubernetes secrets"})}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"https://docs.microsoft.com/aspnet/core/fundamentals/configuration/#key-per-file-configuration-provider",children:"ASP.NET Core Documentation"})}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},1151:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>r});var i=s(7294);const t={},a=i.createContext(t);function r(e){const n=i.useContext(a);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),i.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.05b0267d.js b/assets/js/runtime~main.8a8dc0ff.js similarity index 98% rename from assets/js/runtime~main.05b0267d.js rename to assets/js/runtime~main.8a8dc0ff.js index f514f14..1877054 100644 --- a/assets/js/runtime~main.05b0267d.js +++ b/assets/js/runtime~main.8a8dc0ff.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,t,r,f,d={},o={};function c(e){var a=o[e];if(void 0!==a)return a.exports;var t=o[e]={exports:{}};return d[e].call(t.exports,t,t.exports,c),t.exports}c.m=d,e=[],c.O=(a,t,r,f)=>{if(!t){var d=1/0;for(i=0;i=f)&&Object.keys(c.O).every((e=>c.O[e](t[n])))?t.splice(n--,1):(o=!1,f0&&e[i-1][2]>f;i--)e[i]=e[i-1];e[i]=[t,r,f]},c.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return c.d(a,{a:a}),a},t=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,c.t=function(e,r){if(1&r&&(e=this(e)),8&r)return e;if("object"==typeof e&&e){if(4&r&&e.__esModule)return e;if(16&r&&"function"==typeof e.then)return e}var f=Object.create(null);c.r(f);var d={};a=a||[null,t({}),t([]),t(t)];for(var o=2&r&&e;"object"==typeof o&&!~a.indexOf(o);o=t(o))Object.getOwnPropertyNames(o).forEach((a=>d[a]=()=>e[a]));return d.default=()=>e,c.d(f,d),f},c.d=(e,a)=>{for(var t in a)c.o(a,t)&&!c.o(e,t)&&Object.defineProperty(e,t,{enumerable:!0,get:a[t]})},c.f={},c.e=e=>Promise.all(Object.keys(c.f).reduce(((a,t)=>(c.f[t](e,a),a)),[])),c.u=e=>"assets/js/"+({4:"9ed00105",14:"b1e7123d",41:"28e51da9",48:"41d97e2f",52:"6633a546",53:"935f2afb",185:"2f22ae25",220:"1ca79a61",237:"1df93b7f",313:"f38735a0",328:"bf03d4ec",368:"a94703ab",381:"defcddab",506:"b7ad560a",518:"a7bd4aaa",621:"d99a49c2",661:"5e95c892",681:"7d952fa5",708:"07fefcf6",711:"df3a1ecd",762:"6c57e7b8",796:"3b941570",810:"4db0b455",859:"c89f3e57",864:"0458b440",889:"1d45c4fa",903:"38105561",918:"17896441",939:"48f00fa9",950:"5c37fac9",974:"af21e6ba"}[e]||e)+"."+{4:"3e27619b",14:"71d6eafb",41:"6dd36e7c",48:"5b98b94b",52:"4a2756ab",53:"5daf56a2",185:"03ea899d",220:"9f42ab10",237:"8d301146",313:"663c5462",328:"3a21f460",368:"8e3c8afc",381:"8c77c7a2",506:"f66437cf",518:"21a4007a",621:"8df79e12",661:"0552f2ec",681:"74f3f14f",708:"c1b79619",711:"5eea72c1",762:"2283a575",772:"f54cdf26",796:"3cca96b7",810:"88fcf116",859:"40f5f1c2",864:"18292e68",889:"4adea908",903:"7ab42c39",918:"90d7fcce",939:"db202b51",950:"a669993e",974:"ae0a2561"}[e]+".js",c.miniCssF=e=>{},c.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),c.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),r={},f="ba-getter:",c.l=(e,a,t,d)=>{if(r[e])r[e].push(a);else{var o,n;if(void 0!==t)for(var b=document.getElementsByTagName("script"),i=0;i{o.onerror=o.onload=null,clearTimeout(s);var f=r[e];if(delete r[e],o.parentNode&&o.parentNode.removeChild(o),f&&f.forEach((e=>e(t))),a)return a(t)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:o}),12e4);o.onerror=l.bind(null,o.onerror),o.onload=l.bind(null,o.onload),n&&document.head.appendChild(o)}},c.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},c.p="/",c.gca=function(e){return e={17896441:"918",38105561:"903","9ed00105":"4",b1e7123d:"14","28e51da9":"41","41d97e2f":"48","6633a546":"52","935f2afb":"53","2f22ae25":"185","1ca79a61":"220","1df93b7f":"237",f38735a0:"313",bf03d4ec:"328",a94703ab:"368",defcddab:"381",b7ad560a:"506",a7bd4aaa:"518",d99a49c2:"621","5e95c892":"661","7d952fa5":"681","07fefcf6":"708",df3a1ecd:"711","6c57e7b8":"762","3b941570":"796","4db0b455":"810",c89f3e57:"859","0458b440":"864","1d45c4fa":"889","48f00fa9":"939","5c37fac9":"950",af21e6ba:"974"}[e]||e,c.p+c.u(e)},(()=>{var e={303:0,532:0};c.f.j=(a,t)=>{var r=c.o(e,a)?e[a]:void 0;if(0!==r)if(r)t.push(r[2]);else if(/^(303|532)$/.test(a))e[a]=0;else{var f=new Promise(((t,f)=>r=e[a]=[t,f]));t.push(r[2]=f);var d=c.p+c.u(a),o=new Error;c.l(d,(t=>{if(c.o(e,a)&&(0!==(r=e[a])&&(e[a]=void 0),r)){var f=t&&("load"===t.type?"missing":t.type),d=t&&t.target&&t.target.src;o.message="Loading chunk "+a+" failed.\n("+f+": "+d+")",o.name="ChunkLoadError",o.type=f,o.request=d,r[1](o)}}),"chunk-"+a,a)}},c.O.j=a=>0===e[a];var a=(a,t)=>{var r,f,d=t[0],o=t[1],n=t[2],b=0;if(d.some((a=>0!==e[a]))){for(r in o)c.o(o,r)&&(c.m[r]=o[r]);if(n)var i=n(c)}for(a&&a(t);b{"use strict";var e,a,t,r,f,d={},o={};function c(e){var a=o[e];if(void 0!==a)return a.exports;var t=o[e]={exports:{}};return d[e].call(t.exports,t,t.exports,c),t.exports}c.m=d,e=[],c.O=(a,t,r,f)=>{if(!t){var d=1/0;for(i=0;i=f)&&Object.keys(c.O).every((e=>c.O[e](t[n])))?t.splice(n--,1):(o=!1,f0&&e[i-1][2]>f;i--)e[i]=e[i-1];e[i]=[t,r,f]},c.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return c.d(a,{a:a}),a},t=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,c.t=function(e,r){if(1&r&&(e=this(e)),8&r)return e;if("object"==typeof e&&e){if(4&r&&e.__esModule)return e;if(16&r&&"function"==typeof e.then)return e}var f=Object.create(null);c.r(f);var d={};a=a||[null,t({}),t([]),t(t)];for(var o=2&r&&e;"object"==typeof o&&!~a.indexOf(o);o=t(o))Object.getOwnPropertyNames(o).forEach((a=>d[a]=()=>e[a]));return d.default=()=>e,c.d(f,d),f},c.d=(e,a)=>{for(var t in a)c.o(a,t)&&!c.o(e,t)&&Object.defineProperty(e,t,{enumerable:!0,get:a[t]})},c.f={},c.e=e=>Promise.all(Object.keys(c.f).reduce(((a,t)=>(c.f[t](e,a),a)),[])),c.u=e=>"assets/js/"+({4:"9ed00105",14:"b1e7123d",41:"28e51da9",48:"41d97e2f",52:"6633a546",53:"935f2afb",185:"2f22ae25",220:"1ca79a61",237:"1df93b7f",313:"f38735a0",328:"bf03d4ec",368:"a94703ab",381:"defcddab",506:"b7ad560a",518:"a7bd4aaa",621:"d99a49c2",661:"5e95c892",681:"7d952fa5",708:"07fefcf6",711:"df3a1ecd",762:"6c57e7b8",796:"3b941570",810:"4db0b455",859:"c89f3e57",864:"0458b440",889:"1d45c4fa",903:"38105561",918:"17896441",939:"48f00fa9",950:"5c37fac9",974:"af21e6ba"}[e]||e)+"."+{4:"0ef34a81",14:"71d6eafb",41:"6dd36e7c",48:"5b98b94b",52:"4a2756ab",53:"5daf56a2",185:"03ea899d",220:"9f42ab10",237:"8d301146",313:"663c5462",328:"3a21f460",368:"8e3c8afc",381:"8c77c7a2",506:"f66437cf",518:"21a4007a",621:"8df79e12",661:"0552f2ec",681:"74f3f14f",708:"c1b79619",711:"5eea72c1",762:"2283a575",772:"f54cdf26",796:"3cca96b7",810:"88fcf116",859:"40f5f1c2",864:"18292e68",889:"4adea908",903:"7ab42c39",918:"90d7fcce",939:"db202b51",950:"a669993e",974:"ae0a2561"}[e]+".js",c.miniCssF=e=>{},c.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),c.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),r={},f="ba-getter:",c.l=(e,a,t,d)=>{if(r[e])r[e].push(a);else{var o,n;if(void 0!==t)for(var b=document.getElementsByTagName("script"),i=0;i{o.onerror=o.onload=null,clearTimeout(s);var f=r[e];if(delete r[e],o.parentNode&&o.parentNode.removeChild(o),f&&f.forEach((e=>e(t))),a)return a(t)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:o}),12e4);o.onerror=l.bind(null,o.onerror),o.onload=l.bind(null,o.onload),n&&document.head.appendChild(o)}},c.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},c.p="/",c.gca=function(e){return e={17896441:"918",38105561:"903","9ed00105":"4",b1e7123d:"14","28e51da9":"41","41d97e2f":"48","6633a546":"52","935f2afb":"53","2f22ae25":"185","1ca79a61":"220","1df93b7f":"237",f38735a0:"313",bf03d4ec:"328",a94703ab:"368",defcddab:"381",b7ad560a:"506",a7bd4aaa:"518",d99a49c2:"621","5e95c892":"661","7d952fa5":"681","07fefcf6":"708",df3a1ecd:"711","6c57e7b8":"762","3b941570":"796","4db0b455":"810",c89f3e57:"859","0458b440":"864","1d45c4fa":"889","48f00fa9":"939","5c37fac9":"950",af21e6ba:"974"}[e]||e,c.p+c.u(e)},(()=>{var e={303:0,532:0};c.f.j=(a,t)=>{var r=c.o(e,a)?e[a]:void 0;if(0!==r)if(r)t.push(r[2]);else if(/^(303|532)$/.test(a))e[a]=0;else{var f=new Promise(((t,f)=>r=e[a]=[t,f]));t.push(r[2]=f);var d=c.p+c.u(a),o=new Error;c.l(d,(t=>{if(c.o(e,a)&&(0!==(r=e[a])&&(e[a]=void 0),r)){var f=t&&("load"===t.type?"missing":t.type),d=t&&t.target&&t.target.src;o.message="Loading chunk "+a+" failed.\n("+f+": "+d+")",o.name="ChunkLoadError",o.type=f,o.request=d,r[1](o)}}),"chunk-"+a,a)}},c.O.j=a=>0===e[a];var a=(a,t)=>{var r,f,d=t[0],o=t[1],n=t[2],b=0;if(d.some((a=>0!==e[a]))){for(r in o)c.o(o,r)&&(c.m[r]=o[r]);if(n)var i=n(c)}for(a&&a(t);b Index | BaGetter - + diff --git a/docs/Advanced/debugging.html b/docs/Advanced/debugging.html index 25225e6..f9ef485 100644 --- a/docs/Advanced/debugging.html +++ b/docs/Advanced/debugging.html @@ -4,7 +4,7 @@ Debugging BaGetter | BaGetter - + diff --git a/docs/Advanced/sdk.html b/docs/Advanced/sdk.html index e49771e..11825c8 100644 --- a/docs/Advanced/sdk.html +++ b/docs/Advanced/sdk.html @@ -4,7 +4,7 @@ BaGetter SDK | BaGetter - + diff --git a/docs/Import/local-feeds.html b/docs/Import/local-feeds.html index 7d1d623..8b12034 100644 --- a/docs/Import/local-feeds.html +++ b/docs/Import/local-feeds.html @@ -4,7 +4,7 @@ Import packages from a local feed | BaGetter - + diff --git a/docs/Import/nugetorg.html b/docs/Import/nugetorg.html index 082840c..aa3bf57 100644 --- a/docs/Import/nugetorg.html +++ b/docs/Import/nugetorg.html @@ -4,7 +4,7 @@ Import nuget.org packages | BaGetter - + diff --git a/docs/Import/nugetserver.html b/docs/Import/nugetserver.html index 7610595..9f0b794 100644 --- a/docs/Import/nugetserver.html +++ b/docs/Import/nugetserver.html @@ -4,7 +4,7 @@ Import NuGet.Server packages | BaGetter - + diff --git a/docs/Installation/aliyun.html b/docs/Installation/aliyun.html index 2756307..c4e4270 100644 --- a/docs/Installation/aliyun.html +++ b/docs/Installation/aliyun.html @@ -4,7 +4,7 @@ Use Alibaba Cloud (Aliyun) OSS | BaGetter - + diff --git a/docs/Installation/aws.html b/docs/Installation/aws.html index 1e760ac..8c4f63f 100644 --- a/docs/Installation/aws.html +++ b/docs/Installation/aws.html @@ -4,7 +4,7 @@ Run BaGetter on AWS | BaGetter - + diff --git a/docs/Installation/azure.html b/docs/Installation/azure.html index c047da2..e243061 100644 --- a/docs/Installation/azure.html +++ b/docs/Installation/azure.html @@ -4,7 +4,7 @@ Run BaGetter on Azure | BaGetter - + diff --git a/docs/Installation/docker.html b/docs/Installation/docker.html index e5f3ea5..9c34413 100644 --- a/docs/Installation/docker.html +++ b/docs/Installation/docker.html @@ -4,7 +4,7 @@ Run BaGetter on Docker | BaGetter - + diff --git a/docs/Installation/gcp.html b/docs/Installation/gcp.html index ca0cfff..c89e068 100644 --- a/docs/Installation/gcp.html +++ b/docs/Installation/gcp.html @@ -4,7 +4,7 @@ Run BaGetter on Google Cloud Platform | BaGetter - + diff --git a/docs/Installation/iis-proxy.html b/docs/Installation/iis-proxy.html index 0e3059e..b6fa825 100644 --- a/docs/Installation/iis-proxy.html +++ b/docs/Installation/iis-proxy.html @@ -4,7 +4,7 @@ Windows IIS Proxy | BaGetter - + diff --git a/docs/Installation/local.html b/docs/Installation/local.html index d3e3e5a..5724f4a 100644 --- a/docs/Installation/local.html +++ b/docs/Installation/local.html @@ -4,7 +4,7 @@ Run BaGetter on your Computer | BaGetter - + diff --git a/docs/configuration.html b/docs/configuration.html index 9cf6464..17ad136 100644 --- a/docs/configuration.html +++ b/docs/configuration.html @@ -4,7 +4,7 @@ Configuration | BaGetter - + @@ -85,10 +85,10 @@

Maximum This can be useful if you are hosting a private feed and need to host large packages that include chocolatey installers, machine learning models, etc.

{
    ...

    "MaxPackageSizeGiB": 8,

    ...
}

Statistics​

-

On the application's statistics page the currently used services are listed. -You can hide or show this part by modifying the EnableStatisticsPage configuration:

-
{
    ...

    "Statistics": {
        "EnableStatisticsPage": false,
        "ListConfiguredServices": false
    },

    ...
}
-

If you set ListConfiguredServices to true the currently used services for database and storage are shown on the stats page.

+

On the application's statistics page the currently used services and overall package and version counts are listed. +You can hide or show this page by modifying the EnableStatisticsPage configuration.
+If you set ListConfiguredServices to false the currently used services for database and storage (such as Sqlite) are omitted on the stats page:

+
{
    ...

    "Statistics": {
        "EnableStatisticsPage": true,
        "ListConfiguredServices": false
    },

    ...
}

Load secrets from files​

Mostly useful when running containerised (e.g. using Docker, Podman, Kubernetes, etc), the application will look for files named in the same pattern as environment variables under /run/secrets.

/run/secrets/Database__ConnectionString
diff --git a/docs/vs/artifactory.html b/docs/vs/artifactory.html index 747807b..a48b1ef 100644 --- a/docs/vs/artifactory.html +++ b/docs/vs/artifactory.html @@ -4,7 +4,7 @@ Artifactory | BaGetter - + diff --git a/docs/vs/azure-artifacts.html b/docs/vs/azure-artifacts.html index 9c5e1fb..39b9459 100644 --- a/docs/vs/azure-artifacts.html +++ b/docs/vs/azure-artifacts.html @@ -4,7 +4,7 @@ Azure Artifacts | BaGetter - + diff --git a/docs/vs/liget.html b/docs/vs/liget.html index 497234a..f201552 100644 --- a/docs/vs/liget.html +++ b/docs/vs/liget.html @@ -4,7 +4,7 @@ LiGet | BaGetter - + diff --git a/docs/vs/local-feeds.html b/docs/vs/local-feeds.html index 07ba2f4..c12f854 100644 --- a/docs/vs/local-feeds.html +++ b/docs/vs/local-feeds.html @@ -4,7 +4,7 @@ Local Feeds | BaGetter - + diff --git a/docs/vs/myget.html b/docs/vs/myget.html index 9614062..a5abc03 100644 --- a/docs/vs/myget.html +++ b/docs/vs/myget.html @@ -4,7 +4,7 @@ MyGet | BaGetter - + diff --git a/docs/vs/nexus.html b/docs/vs/nexus.html index a4963c5..0980ccb 100644 --- a/docs/vs/nexus.html +++ b/docs/vs/nexus.html @@ -4,7 +4,7 @@ Nexus | BaGetter - + diff --git a/docs/vs/nugetorg.html b/docs/vs/nugetorg.html index 6d4b863..6abf28d 100644 --- a/docs/vs/nugetorg.html +++ b/docs/vs/nugetorg.html @@ -4,7 +4,7 @@ nuget.org | BaGetter - + diff --git a/docs/vs/nugetserver.html b/docs/vs/nugetserver.html index 29fa76f..a9f0b21 100644 --- a/docs/vs/nugetserver.html +++ b/docs/vs/nugetserver.html @@ -4,7 +4,7 @@ NuGet.Server | BaGetter - + diff --git a/docs/vs/teamcity.html b/docs/vs/teamcity.html index d30be77..cfa50db 100644 --- a/docs/vs/teamcity.html +++ b/docs/vs/teamcity.html @@ -4,7 +4,7 @@ TeamCity | BaGetter - + diff --git a/index.html b/index.html index 64f9ba3..d9bbee5 100644 --- a/index.html +++ b/index.html @@ -4,7 +4,7 @@ 🥖🛒 BaGetter | BaGetter - +