diff --git a/.vitepress/theme/components/DockerIcon.vue b/.vitepress/theme/components/DockerIcon.vue index 5365adf..5e9b40c 100644 --- a/.vitepress/theme/components/DockerIcon.vue +++ b/.vitepress/theme/components/DockerIcon.vue @@ -1,7 +1,7 @@ diff --git a/.vitepress/theme/components/Home.vue b/.vitepress/theme/components/Home.vue index 32a0f26..5a61243 100644 --- a/.vitepress/theme/components/Home.vue +++ b/.vitepress/theme/components/Home.vue @@ -5,7 +5,7 @@ sh
# TL-DR; ⚡ Power your batteries now!
-docker pull ghcr.io/kloudkit/workspace:v0.2.1
+docker pull ghcr.io/kloudkit/workspace:v0.3.0
diff --git a/README.md b/README.md
index 558dab3..e5336fa 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,7 @@
> 📚 Dedicated documentation for the **Kloud Workspace**
[](https://github.com/kloudkit/ws-meta/stargazers)
-[](https://github.com/orgs/kloudkit/packages/container/package/workspace)
+[](https://github.com/orgs/kloudkit/packages/container/package/workspace)
[](https://ws.kloudkit.com)
[](https://github.com/kloudkit/ws-docs/blob/main/LICENSE)
@@ -11,7 +11,7 @@
```sh
# TL-DR; ⚡ Power your batteries now!
-docker run -p 8080:8080 ghcr.io/kloudkit/workspace:v0.2.1
+docker run -p 8080:8080 ghcr.io/kloudkit/workspace:v0.3.0
```
## Documentation
diff --git a/docs/editor/authentication.md b/docs/editor/authentication.md
index 4c359d2..51d1d2f 100644
--- a/docs/editor/authentication.md
+++ b/docs/editor/authentication.md
@@ -40,7 +40,7 @@ application running inside the workspace.
```sh{2}
docker run \
-e WS_AUTH_PASSWORD=super_duper_secret \
- ghcr.io/kloudkit/workspace:v0.2.1
+ ghcr.io/kloudkit/workspace:v0.3.0
```
### Creating a Hashed Password
@@ -69,7 +69,7 @@ Then deploy the workspace:
```sh{2}
docker run \
-e WS_AUTH_PASSWORD_HASHED="$argon2id$v=19$m=4096,t=3,p=1$z4DjJlJgI6S7fAdQC35ZQw$Rpu8CLMWedxJaH0eiFCetyoRbg+S8ow/RRyVCZzM6QE" \
- ghcr.io/kloudkit/workspace:v0.2.1
+ ghcr.io/kloudkit/workspace:v0.3.0
```
### File-Based Passwords
@@ -83,7 +83,7 @@ convention path and leave the variable unset.
docker run \
-e WS_AUTH_PASSWORD_HASHED=file:/run/secrets/workspace/auth/password_hashed \
-v ./password_hashed.txt:/run/secrets/workspace/auth/password_hashed:ro \
- ghcr.io/kloudkit/workspace:v0.2.1
+ ghcr.io/kloudkit/workspace:v0.3.0
```
See [Resolving Secret Values](/settings/configuration#resolving-secret-values)
diff --git a/docs/editor/extensions.md b/docs/editor/extensions.md
index 6a9e4dd..ccccd82 100644
--- a/docs/editor/extensions.md
+++ b/docs/editor/extensions.md
@@ -42,7 +42,7 @@ You can also install additional extensions by marketplace ID:
```sh{2}
docker run \
-e WS_EDITOR_ADDITIONAL_VS_EXTENSIONS="dbaeumer.vscode-eslint esbenp.prettier-vscode" \
- ghcr.io/kloudkit/workspace:v0.2.1
+ ghcr.io/kloudkit/workspace:v0.3.0
```
### Persistent Extensions
@@ -65,7 +65,7 @@ docker volume create my-extensions
docker run \
-v my-extensions:/extensions \
- ghcr.io/kloudkit/workspace:v0.2.1
+ ghcr.io/kloudkit/workspace:v0.3.0
```
## Privately Hosted Gallery
@@ -78,7 +78,7 @@ For example:
```sh{2}
docker run \
-e EXTENSIONS_GALLERY='{"serviceUrl": "https://my-extensions/api"}' \
- ghcr.io/kloudkit/workspace:v0.2.1
+ ghcr.io/kloudkit/workspace:v0.3.0
```
::: warning
diff --git a/docs/editor/features.md b/docs/editor/features.md
index fa15200..81fd57b 100644
--- a/docs/editor/features.md
+++ b/docs/editor/features.md
@@ -29,7 +29,7 @@ startup to determine which *features* to install automatically.
```sh{2}
docker run \
-e WS_FEATURES_ADDITIONAL_FEATURES="dotnet jupyter" \
- ghcr.io/kloudkit/workspace:v0.2.1
+ ghcr.io/kloudkit/workspace:v0.3.0
```
### Manual Installation
@@ -144,7 +144,7 @@ docker run \
-e WS_APT_DISABLE_REPOS="*" \
-e WS_FEATURES_STORE_URL="http://feature-store.local" \
-e WS_FEATURES_ADDITIONAL_FEATURES="gh terraform" \
- ghcr.io/kloudkit/workspace:v0.2.1
+ ghcr.io/kloudkit/workspace:v0.3.0
```
The feature store image is available at `ghcr.io/kloudkit/ws-feature-store`.
diff --git a/docs/editor/metrics.md b/docs/editor/metrics.md
index ed7b15a..0cce4c2 100644
--- a/docs/editor/metrics.md
+++ b/docs/editor/metrics.md
@@ -21,7 +21,7 @@ Set `WS_METRICS_ENABLE` to `true` when launching the container:
```sh{2}
docker run \
-e WS_METRICS_ENABLE=true \
- ghcr.io/kloudkit/workspace:v0.2.1
+ ghcr.io/kloudkit/workspace:v0.3.0
```
Once enabled, the exporter serves metrics at `/` on port **9100** *(default)*.
@@ -41,7 +41,7 @@ docker run \
-e WS_METRICS_ENABLE=true \
-e WS_METRICS_PORT=9200 \
-e WS_METRICS_COLLECTORS="container.cpu,container.memory" \
- ghcr.io/kloudkit/workspace:v0.2.1
+ ghcr.io/kloudkit/workspace:v0.3.0
```
## Collectors
diff --git a/docs/editor/port-forwarding.md b/docs/editor/port-forwarding.md
index 38de2e7..f45befb 100644
--- a/docs/editor/port-forwarding.md
+++ b/docs/editor/port-forwarding.md
@@ -57,7 +57,7 @@ environment variable:
```sh{2}
docker run \
-e WS_SERVER_PROXY_DOMAIN=ws.dev \
- ghcr.io/kloudkit/workspace:v0.2.1
+ ghcr.io/kloudkit/workspace:v0.3.0
```
In the configuration above, if your Kloud Workspace is hosted at `ws.dev` and you run the
@@ -71,7 +71,7 @@ You can provide multiple proxy domains by passing a space-delimited list:
```sh{2}
docker run \
-e WS_SERVER_PROXY_DOMAIN="ws.dev local.ws.dev" \
- ghcr.io/kloudkit/workspace:v0.2.1
+ ghcr.io/kloudkit/workspace:v0.3.0
```
With the configuration above, services will be available on both domains: `*.ws.dev` and
diff --git a/docs/editor/settings.md b/docs/editor/settings.md
index 817f888..9030634 100644
--- a/docs/editor/settings.md
+++ b/docs/editor/settings.md
@@ -85,14 +85,14 @@ preserving any defaults not explicitly specified:
```sh{2} [inline]
docker run \
-e WS_EDITOR_SETTINGS_MERGE='{"editor.fontSize": 16, "[python]": {"editor.tabSize": 4}}' \
- ghcr.io/kloudkit/workspace:v0.2.1
+ ghcr.io/kloudkit/workspace:v0.3.0
```
```sh{2,3} [file]
docker run \
-e WS_EDITOR_SETTINGS_MERGE_FILE=/workspace/.settings-merge.json \
-v /path/to/my-settings.json:/workspace/.settings-merge.json \
- ghcr.io/kloudkit/workspace:v0.2.1
+ ghcr.io/kloudkit/workspace:v0.3.0
```
:::
@@ -110,14 +110,14 @@ Using override removes all default workspace settings.
```sh{2} [inline]
docker run \
-e WS_EDITOR_SETTINGS_OVERRIDE='{"editor.fontSize": 16}' \
- ghcr.io/kloudkit/workspace:v0.2.1
+ ghcr.io/kloudkit/workspace:v0.3.0
```
```sh{2,3} [file]
docker run \
-e WS_EDITOR_SETTINGS_OVERRIDE_FILE=/workspace/.settings.json \
-v /path/to/my-settings.json:/workspace/.settings.json \
- ghcr.io/kloudkit/workspace:v0.2.1
+ ghcr.io/kloudkit/workspace:v0.3.0
```
:::
diff --git a/docs/editor/storage.md b/docs/editor/storage.md
index 0178dbf..0443ccb 100644
--- a/docs/editor/storage.md
+++ b/docs/editor/storage.md
@@ -39,7 +39,7 @@ To persist data in Kloud Workspace, mount a volume to the `/workspace` directory
```sh{2}
docker run \
-v workspace:/workspace \
- ghcr.io/kloudkit/workspace:v0.2.1
+ ghcr.io/kloudkit/workspace:v0.3.0
```
In the command above:
@@ -74,7 +74,7 @@ you persist it separately:
docker run \
-v ws:/home/kloud/.ws \
-v workspace:/workspace \
- ghcr.io/kloudkit/workspace:v0.2.1
+ ghcr.io/kloudkit/workspace:v0.3.0
```
## Named Volumes vs. Bind Mounts
diff --git a/docs/editor/terminal.md b/docs/editor/terminal.md
index a00b763..b0d7607 100644
--- a/docs/editor/terminal.md
+++ b/docs/editor/terminal.md
@@ -41,7 +41,7 @@ to your deployment:
docker run \
-e WS_TERMINAL_PROMPT_HIDE_DOCKER_CONTEXT=1 \
-e WS_TERMINAL_PROMPT_HIDE_PYTHON_VERSION=1 \
- ghcr.io/kloudkit/workspace:v0.2.1
+ ghcr.io/kloudkit/workspace:v0.3.0
```
### Colorful Output
@@ -110,13 +110,13 @@ To modify the default set of plugins, adjust the `env` variables listed below:
```sh{2} [Override]
docker run \
-e WS_ZSH_PLUGINS="kubectl npm python pip" \
- ghcr.io/kloudkit/workspace:v0.2.1
+ ghcr.io/kloudkit/workspace:v0.3.0
```
```sh{2} [Append]
docker run \
-e WS_ZSH_ADDITIONAL_PLUGINS="php" \
- ghcr.io/kloudkit/workspace:v0.2.1
+ ghcr.io/kloudkit/workspace:v0.3.0
```
:::
diff --git a/docs/editor/theme-and-fonts.md b/docs/editor/theme-and-fonts.md
index 3323162..5a6d9bc 100644
--- a/docs/editor/theme-and-fonts.md
+++ b/docs/editor/theme-and-fonts.md
@@ -60,7 +60,7 @@ environment variable to either `1` or `true`:
```sh{2}
docker run \
-e WS_EDITOR_COMMENTS_DISABLE_FONT=1 \
- ghcr.io/kloudkit/workspace:v0.2.1
+ ghcr.io/kloudkit/workspace:v0.3.0
```
The animation below shows comments in the default font and how they appear when the font
diff --git a/docs/pages/getting-started.md b/docs/pages/getting-started.md
index 7ced579..07c8858 100644
--- a/docs/pages/getting-started.md
+++ b/docs/pages/getting-started.md
@@ -46,14 +46,14 @@ port `8080`.
::: code-group
```sh [docker]
-docker run -p 8080:8080 ghcr.io/kloudkit/workspace:v0.2.1
+docker run -p 8080:8080 ghcr.io/kloudkit/workspace:v0.3.0
```
```yaml [compose]
version: '3.8'
services:
workspace:
- image: ghcr.io/kloudkit/workspace:v0.2.1
+ image: ghcr.io/kloudkit/workspace:v0.3.0
ports:
- 8080:8080
```
@@ -93,7 +93,7 @@ spec:
spec:
containers:
- name: workspace
- image: ghcr.io/kloudkit/workspace:v0.2.1
+ image: ghcr.io/kloudkit/workspace:v0.3.0
ports:
- containerPort: 8080
```
diff --git a/docs/settings/configuration.md b/docs/settings/configuration.md
index 41cb9fc..464dbd6 100644
--- a/docs/settings/configuration.md
+++ b/docs/settings/configuration.md
@@ -61,14 +61,14 @@ The resolver returns the first match:
```sh [Env literal]
docker run \
-e WS_AUTH_PASSWORD=super_duper_secret \
- ghcr.io/kloudkit/workspace:v0.2.1
+ ghcr.io/kloudkit/workspace:v0.3.0
```
```sh [file: prefix]
docker run \
-e WS_AUTH_PASSWORD=file:/run/secrets/workspace/auth/password \
-v ./password.txt:/run/secrets/workspace/auth/password:ro \
- ghcr.io/kloudkit/workspace:v0.2.1
+ ghcr.io/kloudkit/workspace:v0.3.0
```
```yaml [Kubernetes]
diff --git a/docs/settings/secrets.md b/docs/settings/secrets.md
index 64bc256..8705c53 100644
--- a/docs/settings/secrets.md
+++ b/docs/settings/secrets.md
@@ -95,7 +95,7 @@ Use in Docker deployments:
```sh
docker run \
-e WS_AUTH_PASSWORD_HASHED=$PASSWORD \
- ghcr.io/kloudkit/workspace:v0.2.1
+ ghcr.io/kloudkit/workspace:v0.3.0
```
See [authentication documentation](/editor/authentication) for details.
diff --git a/docs/settings/tls.md b/docs/settings/tls.md
index 954401a..9f3ba54 100644
--- a/docs/settings/tls.md
+++ b/docs/settings/tls.md
@@ -70,7 +70,7 @@ docker run -d \
-e WS_SERVER_SSL_KEY=/certs/tls.key \
-e WS_SERVER_SSL_CERT="-----BEGIN CERTIFICATE-----..." \
-e WS_SERVER_PROXY_DOMAIN=ws.dev \
- ghcr.io/kloudkit/workspace:v0.2.1
+ ghcr.io/kloudkit/workspace:v0.3.0
```
## Enterprise CA *(Custom Certificates)*
@@ -94,13 +94,13 @@ To add your company's root CA, all you need to do is mount the certificate
```sh{2} [Single]
docker run \
-v /path/on-host/ca.crt:/usr/local/share/ca-certificates/workspace/ca.crt \
- ghcr.io/kloudkit/workspace:v0.2.1
+ ghcr.io/kloudkit/workspace:v0.3.0
```
```sh{2} [Multiple]
docker run \
-v /folder/on-host:/usr/local/share/ca-certificates/workspace \
- ghcr.io/kloudkit/workspace:v0.2.1
+ ghcr.io/kloudkit/workspace:v0.3.0
```
:::
@@ -119,7 +119,7 @@ up `.crt`; `.pem` and other extensions are silently skipped.
```sh
docker run \
-v $(pwd)/corp-ca.crt:/home/kloud/.ws/ca.d/corp-ca.crt \
- ghcr.io/kloudkit/workspace:v0.2.1
+ ghcr.io/kloudkit/workspace:v0.3.0
```
This is the recommended path for ad-hoc certificate injection on a
@@ -138,13 +138,13 @@ Use the `WS_CA_ADDITIONAL_CERT_ENDPOINTS` environment variable to define one or
```sh{2} [Single]
docker run \
-e WS_CA_ADDITIONAL_CERT_ENDPOINTS="https://corp.com/ca.pem" \
- ghcr.io/kloudkit/workspace:v0.2.1
+ ghcr.io/kloudkit/workspace:v0.3.0
```
```sh{2} [Multiple]
docker run \
-e WS_CA_ADDITIONAL_CERT_ENDPOINTS="https://corp.com/ca.pem https://alt.com/root.crt" \
- ghcr.io/kloudkit/workspace:v0.2.1
+ ghcr.io/kloudkit/workspace:v0.3.0
```
:::
@@ -167,13 +167,13 @@ validation is bypassed using insecure connections.
```sh{2} [Single]
docker run \
-e WS_CA_ADDITIONAL_CERT_INSECURE_ENDPOINTS="http://corp.com/ca.pem" \
- ghcr.io/kloudkit/workspace:v0.2.1
+ ghcr.io/kloudkit/workspace:v0.3.0
```
```sh{2} [Multiple]
docker run \
-e WS_CA_ADDITIONAL_CERT_INSECURE_ENDPOINTS="http://corp.com/ca.pem https://untrusted.com/root.crt" \
- ghcr.io/kloudkit/workspace:v0.2.1
+ ghcr.io/kloudkit/workspace:v0.3.0
```
:::
diff --git a/docs/settings/vault.md b/docs/settings/vault.md
index 0825060..a35a45a 100644
--- a/docs/settings/vault.md
+++ b/docs/settings/vault.md
@@ -114,7 +114,7 @@ path:
```sh
docker run \
-v /host/path/secrets.yaml:/home/kloud/.ws/vault/secrets.yaml \
- ghcr.io/kloudkit/workspace:v0.2.1
+ ghcr.io/kloudkit/workspace:v0.3.0
```
## Vault Flags
diff --git a/docs/tools/apt.md b/docs/tools/apt.md
index 25177d6..fc7bccc 100644
--- a/docs/tools/apt.md
+++ b/docs/tools/apt.md
@@ -36,7 +36,7 @@ Supply one or more entries separated by semicolons *(`;`)*.
```sh{2}
docker run \
-e WS_APT_ADDITIONAL_REPOS="deb [signed-by=/custom.gpg] https://custom.package bookworm main" \
- ghcr.io/kloudkit/workspace:v0.2.1
+ ghcr.io/kloudkit/workspace:v0.3.0
```
### Update Repository Cache
@@ -86,7 +86,7 @@ mail and printing blocked:
docker run \
-e WS_APT_DISABLE_RESTRICTIONS="x11" \
-e WS_APT_ADDITIONAL_PACKAGES="libx11-6" \
- ghcr.io/kloudkit/workspace:v0.2.1
+ ghcr.io/kloudkit/workspace:v0.3.0
```
Lift every restriction at once with `true` *(or `*`)*:
@@ -94,7 +94,7 @@ Lift every restriction at once with `true` *(or `*`)*:
```sh{2}
docker run \
-e WS_APT_DISABLE_RESTRICTIONS=true \
- ghcr.io/kloudkit/workspace:v0.2.1
+ ghcr.io/kloudkit/workspace:v0.3.0
```
## Additional Packages
@@ -108,7 +108,7 @@ demonstrated below:
```sh{2}
docker run \
-e WS_APT_ADDITIONAL_PACKAGES="cmake nano" \
- ghcr.io/kloudkit/workspace:v0.2.1
+ ghcr.io/kloudkit/workspace:v0.3.0
```
::: tip
@@ -156,5 +156,5 @@ Each key is downloaded at startup and stored in `/etc/apt/keyrings/