Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .vitepress/theme/components/DockerIcon.vue
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<script setup lang="ts">
import { computed } from 'vue'

const image = "ghcr.io/kloudkit/workspace:v0.0.22"
const image = "ghcr.io/kloudkit/workspace:v0.1.0"

const tag = computed(() => image.split(":")[1])
</script>
Expand Down
2 changes: 1 addition & 1 deletion .vitepress/theme/components/Home.vue
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<span class="lang">sh</span>
<pre
class="shiki catppuccin-frappe vp-code"><code><span class="line"><span style="color:#737994;font-style:italic;"># TL-DR; âš¡ Power your batteries now!</span></span>
<span class="line"></span><span class="line"><span style="color:#8CAAEE;font-style:italic;">docker</span><span style="color:#A6D189;"> pull</span><span style="color:#A6D189;"> ghcr.io/kloudkit/workspace:v0.0.22</span></span></code></pre>
<span class="line"></span><span class="line"><span style="color:#8CAAEE;font-style:italic;">docker</span><span style="color:#A6D189;"> pull</span><span style="color:#A6D189;"> ghcr.io/kloudkit/workspace:v0.1.0</span></span></code></pre>
</div>
</div>

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
> 📚 Dedicated documentation for the **Kloud Workspace**

[![Stars](https://img.shields.io/github/stars/kloudkit?style=for-the-badge&logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNTYgMjU2Ij4KPHBhdGggZD0iTTIzNS4yNCw4NC4zOGwtMjguMDYsMjMuNjgsOC41NiwzNS4zOWExMy4zNCwxMy4zNCwwLDAsMS01LjA5LDEzLjkxLDEzLjU0LDEzLjU0LDAsMCwxLTE1LC42OUwxNjQsMTM5bC0zMS42NSwxOS4wNmExMy41MSwxMy41MSwwLDAsMS0xNS0uNjksMTMuMzIsMTMuMzIsMCwwLDEtNS4xLTEzLjkxbDguNTYtMzUuMzlMOTIuNzYsODQuMzhhMTMuMzksMTMuMzksMCwwLDEsNy42Ni0yMy41OGwzNi45NC0yLjkyLDE0LjIxLTMzLjY2YTEzLjUxLDEzLjUxLDAsMCwxLDI0Ljg2LDBsMTQuMjEsMzMuNjYsMzYuOTQsMi45MmExMy4zOSwxMy4zOSwwLDAsMSw3LjY2LDIzLjU4Wk04OC4xMSwxMTEuODlhOCw4LDAsMCwwLTExLjMyLDBMMTguMzQsMTcwLjM0YTgsOCwwLDAsMCwxMS4zMiwxMS4zMmw1OC40NS01OC40NUE4LDgsMCwwLDAsODguMTEsMTExLjg5Wm0tLjUsNjEuMTlMMzQuMzQsMjI2LjM0YTgsOCwwLDAsMCwxMS4zMiwxMS4zMmw1My4yNi01My4yN2E4LDgsMCwwLDAtMTEuMzEtMTEuMzFabTczLTEtNTQuMjksNTQuMjhhOCw4LDAsMCwwLDExLjMyLDExLjMybDU0LjI4LTU0LjI4YTgsOCwwLDAsMC0xMS4zMS0xMS4zMloiIHN0eWxlPSJmaWxsOiAjQ0FEM0Y1OyIvPgo8L3N2Zz4%3D&logoColor=c6d0f5&labelColor=414559&color=yellow)](https://github.com/kloudkit/ws-meta/stargazers)
[![Docker](https://img.shields.io/badge/v0.0.22-dockertag?style=for-the-badge&logo=docker&logoColor=c6d0f5&label=docker&labelColor=414559&color=ef9f76)](https://github.com/orgs/kloudkit/packages/container/package/workspace)
[![Docker](https://img.shields.io/badge/v0.1.0-dockertag?style=for-the-badge&logo=docker&logoColor=c6d0f5&label=docker&labelColor=414559&color=ef9f76)](https://github.com/orgs/kloudkit/packages/container/package/workspace)
[![Documentation](https://img.shields.io/badge/Browse-a?style=for-the-badge&logo=readthedocs&logoColor=c6d0f5&label=Documentation&labelColor=414559&color=85c1dc)](https://ws.kloudkit.com)
[![License](https://img.shields.io/github/license/kloudkit/ws-docs?style=for-the-badge&logo=opensourceinitiative&logoColor=c6d0f5&labelColor=414559&color=8caaee)](https://github.com/kloudkit/ws-docs/blob/main/LICENSE)

---

```sh
# TL-DR; âš¡ Power your batteries now!
docker run -p 8080:8080 ghcr.io/kloudkit/workspace:v0.0.22
docker run -p 8080:8080 ghcr.io/kloudkit/workspace:v0.1.0
```

## Documentation
Expand Down
4 changes: 2 additions & 2 deletions docs/editor/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ that your password is absent from future shell sessions.
```sh{2}
docker run \
-e WS_AUTH_PASSWORD=super_duper_secret \
ghcr.io/kloudkit/workspace:v0.0.22
ghcr.io/kloudkit/workspace:v0.1.0
```

### Creating a Hashed Password
Expand All @@ -48,7 +48,7 @@ Then deploy the workspace:
```sh{2}
docker run \
-e WS_AUTH_PASSWORD_HASHED="$argon2i$v=19$m=4096,t=3,p=1$z4DjJlJgI6S7fAdQC35ZQw$Rpu8CLMWedxJaH0eiFCetyoRbg+S8ow/RRyVCZzM6QE" \
ghcr.io/kloudkit/workspace:v0.0.22
ghcr.io/kloudkit/workspace:v0.1.0
```

### Rate Limiting
Expand Down
8 changes: 4 additions & 4 deletions docs/editor/extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,14 +44,14 @@ Both options below can be used in unison:
```sh{2} [list]
docker run \
-e WS_EDITOR_ADDITIONAL_VS_EXTENSIONS="dbaeumer.vscode-eslint esbenp.prettier-vscode" \
ghcr.io/kloudkit/workspace:v0.0.22
ghcr.io/kloudkit/workspace:v0.1.0
```

```sh{2,3} [directory]
docker run \
-e WS_EDITOR_ADDITIONAL_VS_EXTENSIONS_DIR=/additional-extensions \
-v /path/to/my-additional-extensions:/additional-extensions \
ghcr.io/kloudkit/workspace:v0.0.22
ghcr.io/kloudkit/workspace:v0.1.0
```

:::
Expand All @@ -76,7 +76,7 @@ docker volume create my-extensions

docker run \
-v my-extensions:/extensions \
ghcr.io/kloudkit/workspace:v0.0.22
ghcr.io/kloudkit/workspace:v0.1.0
```

## Privately Hosted Gallery
Expand All @@ -88,7 +88,7 @@ For example:
```sh{2}
docker run \
-e EXTENSIONS_GALLERY='{"serviceUrl": "https://my-extensions/api"}' \
ghcr.io/kloudkit/workspace:v0.0.22
ghcr.io/kloudkit/workspace:v0.1.0
```

::: warning
Expand Down
2 changes: 1 addition & 1 deletion docs/editor/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.0.22
ghcr.io/kloudkit/workspace:v0.1.0
```

### Manual Installation
Expand Down
4 changes: 2 additions & 2 deletions docs/editor/port-forwarding.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ environment variable:
```sh{2}
docker run \
-e WS_SERVER_PROXY_DOMAIN=ws.dev \
ghcr.io/kloudkit/workspace:v0.0.22
ghcr.io/kloudkit/workspace:v0.1.0
```

In the configuration above, if your Kloud Workspace is hosted at `ws.dev` and you run the
Expand All @@ -65,7 +65,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.0.22
ghcr.io/kloudkit/workspace:v0.1.0
```

With the configuration above, services will be available on both domains: `*.ws.dev` and
Expand Down
2 changes: 1 addition & 1 deletion docs/editor/storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,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.0.22
ghcr.io/kloudkit/workspace:v0.1.0
```

In the command above:
Expand Down
6 changes: 3 additions & 3 deletions docs/editor/terminal.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,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.0.22
ghcr.io/kloudkit/workspace:v0.1.0
```

### Colorful Output
Expand Down Expand Up @@ -78,13 +78,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.0.22
ghcr.io/kloudkit/workspace:v0.1.0
```

```sh{2} [Append]
docker run \
-e WS_ZSH_ADDITIONAL_PLUGINS="php" \
ghcr.io/kloudkit/workspace:v0.0.22
ghcr.io/kloudkit/workspace:v0.1.0
```

:::
Expand Down
2 changes: 1 addition & 1 deletion docs/editor/theme-and-fonts.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.0.22
ghcr.io/kloudkit/workspace:v0.1.0
```

The animation below shows comments in the default font and how they appear when the font
Expand Down
8 changes: 4 additions & 4 deletions docs/pages/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,14 +48,14 @@ port `8080`.
::: code-group

```sh [docker]
docker run -p 8080:8080 ghcr.io/kloudkit/workspace:v0.0.22
docker run -p 8080:8080 ghcr.io/kloudkit/workspace:v0.1.0
```

```yaml [compose]
version: '3.8'
services:
workspace:
image: ghcr.io/kloudkit/workspace:v0.0.22
image: ghcr.io/kloudkit/workspace:v0.1.0
ports:
- 8080:8080
```
Expand All @@ -76,7 +76,7 @@ spec:
spec:
containers:
- name: workspace
image: ghcr.io/kloudkit/workspace:v0.0.22
image: ghcr.io/kloudkit/workspace:v0.1.0
ports:
- containerPort: 8080
```
Expand All @@ -95,7 +95,7 @@ docker run -it --rm \
-v ./custom/ca:/usr/local/share/ca-certificates/workspace \
-v /var/run/docker.sock:/var/run/docker.sock:ro \
-v data:/workspace \
ghcr.io/kloudkit/workspace:v0.0.22
ghcr.io/kloudkit/workspace:v0.1.0
```

## Installing in Chrome - SPA
Expand Down
2 changes: 1 addition & 1 deletion docs/settings/autoload-scripts.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ These scripts are executed as follows:
```sh{2}
docker run \
-v /my-entrypoint-scripts:/entrypoint \
ghcr.io/kloudkit/workspace:v0.0.22
ghcr.io/kloudkit/workspace:v0.1.0
```

### Available Languages
Expand Down
12 changes: 6 additions & 6 deletions docs/settings/enterprise-ca.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,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.0.22
ghcr.io/kloudkit/workspace:v0.1.0
```

```sh{2} [Multiple]
docker run \
-v /folder/on-host:/usr/local/share/ca-certificates/workspace \
ghcr.io/kloudkit/workspace:v0.0.22
ghcr.io/kloudkit/workspace:v0.1.0
```

:::
Expand All @@ -47,13 +47,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.0.22
ghcr.io/kloudkit/workspace:v0.1.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.0.22
ghcr.io/kloudkit/workspace:v0.1.0
```

:::
Expand All @@ -76,13 +76,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.0.22
ghcr.io/kloudkit/workspace:v0.1.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.0.22
ghcr.io/kloudkit/workspace:v0.1.0
```

:::
Expand Down
2 changes: 1 addition & 1 deletion docs/settings/https.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,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.0.22
ghcr.io/kloudkit/workspace:v0.1.0
```

[moz]: https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts/features_restricted_to_secure_contexts
6 changes: 3 additions & 3 deletions docs/tools/apt.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.0.22
ghcr.io/kloudkit/workspace:v0.1.0
```

### Update Repository Cache
Expand Down Expand Up @@ -72,7 +72,7 @@ demonstrated below:
```sh{2}
docker run \
-e WS_APT_ADDITIONAL_PACKAGES="cmake nano" \
ghcr.io/kloudkit/workspace:v0.0.22
ghcr.io/kloudkit/workspace:v0.1.0
```

::: tip
Expand All @@ -93,5 +93,5 @@ Each key is downloaded at startup and stored in `/etc/apt/keyrings/<name>.gpg`.
```sh{2}
docker run \
-e WS_APT_ADDITIONAL_GPG_KEYS="mycorp:https://mycorp.com/pubkey.asc extras:http://extras.test/key2.asc" \
ghcr.io/kloudkit/workspace:v0.0.22
ghcr.io/kloudkit/workspace:v0.1.0
```
16 changes: 8 additions & 8 deletions docs/tools/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Once `sysbox` is installed, run the workspace using the `sysbox-runc` runtime:
docker run \
--runtime=sysbox-runc \
-e WS_DOCKER_ENABLE_CLIENT=1 \
ghcr.io/kloudkit/workspace:v0.0.22
ghcr.io/kloudkit/workspace:v0.1.0
```

### 2. Run `dockerd` in the Container
Expand All @@ -79,7 +79,7 @@ However, this requires the container to run in **privileged** mode:
docker run \
--privileged \
-e WS_DOCKER_ENABLE_CLIENT=1 \
ghcr.io/kloudkit/workspace:v0.0.22
ghcr.io/kloudkit/workspace:v0.1.0
```

### 3. Mounting the Docker Socket From the Host
Expand All @@ -90,7 +90,7 @@ docker run \
docker run \
-v /var/run/docker.sock:/var/run/docker.sock:ro \
-e WS_DOCKER_ENABLE_CLIENT=1 \
ghcr.io/kloudkit/workspace:v0.0.22
ghcr.io/kloudkit/workspace:v0.1.0
```

### 4. Connect to a Remote Host *(TCP)*
Expand All @@ -103,7 +103,7 @@ Assuming you have access to a remote host running docker, you can set the value
```sh{2}
docker run \
-e DOCKER_HOST=tcp://<remote>:2375 \
ghcr.io/kloudkit/workspace:v0.0.22
ghcr.io/kloudkit/workspace:v0.1.0
```

Alternately, you can run the command above [securely][protect-tls] using port `2376` and
Expand All @@ -120,7 +120,7 @@ the value of `DOCKER_HOST` as follows
```sh{2}
docker run \
-e DOCKER_HOST=ssh://<user>@<remote> \
ghcr.io/kloudkit/workspace:v0.0.22
ghcr.io/kloudkit/workspace:v0.1.0
```

This method is optimized by the workspace as we internally configure a persistent
Expand Down Expand Up @@ -159,7 +159,7 @@ This process is split into 3 steps:
-e DOCKER_HOST=tcp://dind:2375 \
-v workspace:/workspace \
--net dind \
ghcr.io/kloudkit/workspace:v0.0.22
ghcr.io/kloudkit/workspace:v0.1.0
```

::: info NOTE
Expand All @@ -180,7 +180,7 @@ environment variable to effortlessly initiate the daemon *(if necessary)*:
```sh{2}
docker run \
-e WS_DOCKER_ENABLE_CLIENT=1 \
ghcr.io/kloudkit/workspace:v0.0.22
ghcr.io/kloudkit/workspace:v0.1.0
```

### Docker Group
Expand All @@ -199,7 +199,7 @@ docker run \
--group-add=8888
-v /var/run/docker.sock:/var/run/docker.sock:ro \
-e WS_DOCKER_ENABLE_CLIENT=1 \
ghcr.io/kloudkit/workspace:v0.0.22
ghcr.io/kloudkit/workspace:v0.1.0
```

Make sure to replace `8888` with the appropriate group ID from your host system.
Expand Down
2 changes: 1 addition & 1 deletion docs/tools/helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,5 +37,5 @@ To retain these configurations across workspace restarts or updates:
docker run \
-e WS_HELM_PRELOAD_CACHE=1 \
-v helm:/home/kloud/.config/helm \
ghcr.io/kloudkit/workspace:v0.0.22
ghcr.io/kloudkit/workspace:v0.1.0
```