Skip to content

docs: add documentation for gcs storage backend #64

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
secana merged 2 commits into from
Aug 29, 2026
Merged

docs: add documentation for gcs storage backend #64

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9c9a4a7
docs: document the GCS storage backend
secana Aug 29, 2026
60474ce
chore: update flake.nix
secana Aug 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions flake.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

45 changes: 43 additions & 2 deletions src/views/DocumentationV6View.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -635,6 +635,7 @@ const mobileNavOpen = ref(false);
<router-link to="#config-documentation">Documentation</router-link>
<router-link to="#config-postgresql">PostgreSQL</router-link>
<router-link to="#config-s3">S3 Storage</router-link>
<router-link to="#config-gcs">GCS Storage</router-link>
<router-link to="#config-oauth2-values">OAuth2/OIDC</router-link>
<router-link to="#config-toolchain-values">Toolchain Server</router-link>
</nav>
Expand Down Expand Up @@ -823,6 +824,40 @@ const mobileNavOpen = ref(false);
description="S3 request timeout in seconds." />
</ConfigGrid>

<MinorHeader id="config-gcs">GCS Storage</MinorHeader>
<TextBlock>
Google Cloud Storage is an alternative to <router-link to="#config-s3">S3</router-link>. Only one
remote storage backend can be enabled at a time; Kellnr exits on startup if both
<code>s3.enabled</code> and <code>gcs.enabled</code> are set. Credentials are taken from
Application Default Credentials, so Kellnr picks up
<code>GOOGLE_APPLICATION_CREDENTIALS</code>, the <code>gcloud</code> ADC file, workload identity,
or the metadata server without any credential settings of its own.
</TextBlock>
<ConfigGrid>
<ConfigCard title="GCS Enabled" toml="[gcs] enabled" env-var="KELLNR_GCS__ENABLED" default-value="false"
description="Enable Google Cloud Storage instead of local file system. Cannot be combined with S3." />
<ConfigCard title="Endpoint" toml="[gcs] endpoint" env-var="KELLNR_GCS__ENDPOINT" default-value="None"
description="Custom base URL for a self-hosted or emulator endpoint. When omitted, the public Google Cloud Storage API is used." />
<ConfigCard title="Allow HTTP" toml="[gcs] allow_http" env-var="KELLNR_GCS__ALLOW_HTTP"
default-value="true" description="Allow unsecure GCS connection with HTTP. Needed when the endpoint uses HTTP." />
<ConfigCard title="Skip Signature" toml="[gcs] skip_signature" env-var="KELLNR_GCS__SKIP_SIGNATURE"
default-value="false"
description="Skip credential lookup and request signing. Only for unauthenticated endpoints such as emulators." />
<ConfigCard title="Crates Bucket" toml="[gcs] crates_bucket" env-var="KELLNR_GCS__CRATES_BUCKET"
default-value="kellnr-crates" description="Bucket where Kellnr stores uploaded crates." />
<ConfigCard title="Crates.io Bucket" toml="[gcs] cratesio_bucket" env-var="KELLNR_GCS__CRATESIO_BUCKET"
default-value="kellnr-cratesio" description="Bucket for crates.io crates if the proxy is enabled." />
<ConfigCard title="Toolchain Bucket" toml="[gcs] toolchain_bucket" env-var="KELLNR_GCS__TOOLCHAIN_BUCKET"
default-value="kellnr-toolchains"
description="Bucket for toolchain archives if the toolchain server is enabled." />
<ConfigCard title="Connect Timeout" toml="[gcs] connect_timeout_seconds"
env-var="KELLNR_GCS__CONNECT_TIMEOUT_SECONDS" default-value="5"
description="GCS connect timeout in seconds." />
<ConfigCard title="Request Timeout" toml="[gcs] request_timeout_seconds"
env-var="KELLNR_GCS__REQUEST_TIMEOUT_SECONDS" default-value="30"
description="GCS request timeout in seconds." />
</ConfigGrid>

<MinorHeader id="config-oauth2-values">OAuth2/OIDC</MinorHeader>
<ConfigGrid>
<ConfigCard title="OAuth2 Enabled" toml="[oauth2] enabled" env-var="KELLNR_OAUTH2__ENABLED"
Expand Down Expand Up @@ -1406,6 +1441,11 @@ const mobileNavOpen = ref(false);
<td>Use S3 storage instead of local filesystem</td>
<td>false</td>
</tr>
<tr>
<td><code>--gcs-enabled</code></td>
<td>Use Google Cloud Storage instead of local filesystem</td>
<td>false</td>
</tr>
<tr>
<td><code>--oauth2-enabled</code></td>
<td>Enable OAuth2/OIDC authentication</td>
Expand Down Expand Up @@ -1664,8 +1704,9 @@ const mobileNavOpen = ref(false);
backup the data folder. The data folder contains all data needed to restore Kellnr. It is recommended to
backup the data folder regularly, as it contains all uploaded crates and the SQLite database. If you use
PostgreSQL instead, do not forget to backup the database separately. Likewise, if you enable
<router-link to="#config-s3">S3 storage</router-link>, your uploaded crates are stored in the configured
S3 buckets rather than the data folder — back those up separately as well.
<router-link to="#config-s3">S3</router-link> or
<router-link to="#config-gcs">GCS storage</router-link>, your uploaded crates are stored in the
configured buckets rather than the data folder — back those up separately as well.
</TextBlock>
</div>
</div>
Expand Down
1 change: 1 addition & 0 deletions src/views/FeaturesView.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -379,6 +379,7 @@
<ul class="deployment-list">
<li><i class="mdi mdi-folder"></i> Local filesystem (default)</li>
<li><i class="mdi mdi-aws"></i> AWS S3</li>
<li><i class="mdi mdi-google-cloud"></i> Google Cloud Storage</li>
<li><i class="mdi mdi-database"></i> MinIO</li>
<li><i class="mdi mdi-cloud"></i> S3-compatible services</li>
</ul>
Expand Down
Loading