Skip to content

Commit 5371de2

Browse files
committed
🐛 Fix CI url issue
1 parent bcb5700 commit 5371de2

File tree

18 files changed

+114
-75
lines changed

18 files changed

+114
-75
lines changed

.github/workflows/ci.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,17 +51,17 @@ jobs:
5151
run: |
5252
base="https://api.github.com/repos/kloudkit/workspace/contents"
5353
54-
curl -sSL \
54+
curl -sSfL \
5555
-H "Authorization: Bearer ${{ secrets.KLOUDKIT_ORG_PAT }}" \
5656
-H "Accept: application/vnd.github.v3.raw" \
5757
-o "scripts/dependencies.yaml" \
58-
"${api_url}/src/build/dependencies/dependencies.yaml?ref=main"
58+
"${base}/src/build/dependencies/dependencies.yaml?ref=main"
5959
60-
curl -sSL \
60+
curl -sSfL \
6161
-H "Authorization: Bearer ${{ secrets.KLOUDKIT_ORG_PAT }}" \
6262
-H "Accept: application/vnd.github.v3.raw" \
6363
-o "scripts/env.reference.yaml" \
64-
"${api_url}/src/env.reference.yaml?ref=main"
64+
"${base}/src/rootfs/etc/workspace/env.reference.yaml?ref=main"
6565
6666
npm run docs:generate-dynamic
6767

.vitepress/_sidebar.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@ export default [
1515
{
1616
text: 'Editor',
1717
items: [
18+
{ text: 'Additional Features', link: '/editor/features'},
1819
{ text: 'Authentication', link: '/editor/authentication'},
1920
{ text: 'Aliases', link: '/editor/aliases'},
2021
{ text: 'Extensions', link: '/editor/extensions'},
21-
{ text: 'Extra Features', link: '/editor/features'},
2222
{ text: 'Port Forwarding', link: '/editor/port-forwarding'},
2323
{ text: 'Settings', link: '/editor/settings'},
2424
{ text: 'Storage', link: '/editor/storage'},
@@ -30,7 +30,7 @@ export default [
3030
text: 'Settings',
3131
items: [
3232
{ text: 'Autoload Scripts', link: '/settings/autoload-scripts' },
33-
{ text: 'Environment Variables', link: '/settings/environment-variables' },
33+
{ text: 'Configuration', link: '/settings/configuration' },
3434
{ text: 'Enterprise CA', link: '/settings/enterprise-ca' },
3535
{ text: 'Secret Injection', link: '/settings/secrets' },
3636
]

docs/editor/authentication.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ Passed authentication can be easily configured by setting an environment variabl
1717
deploying the *workspace*.
1818
Setting your password is as simple as defining an `env` variable:
1919

20-
- **`WS_PASSWORD`:** plaintext password.
21-
- **`WS_PASSWORD_HASHED`:** hashed passwords *(will take precedence over plaintext)*.
20+
- **`WS_AUTH_PASSWORD`:** plaintext password.
21+
- **`WS_AUTH_PASSWORD_HASHED`:** hashed passwords *(will take precedence over plaintext)*.
2222

2323
::: info NOTE
2424
All sensitive environment variables are purged before deploying Kloud Workspace, ensuring
@@ -27,7 +27,7 @@ that your password is absent from future shell sessions.
2727

2828
```sh{2}
2929
docker run \
30-
-e WS_PASSWORD=super_duper_secret \
30+
-e WS_AUTH_PASSWORD=super_duper_secret \
3131
ghcr.io/kloudkit/workspace:latest
3232
```
3333

@@ -45,7 +45,7 @@ Then deploy the workspace:
4545

4646
```sh{2}
4747
docker run \
48-
-e WS_PASSWORD_HASHED="$argon2i$v=19$m=4096,t=3,p=1$z4DjJlJgI6S7fAdQC35ZQw$Rpu8CLMWedxJaH0eiFCetyoRbg+S8ow/RRyVCZzM6QE" \
48+
-e WS_AUTH_PASSWORD_HASHED="$argon2i$v=19$m=4096,t=3,p=1$z4DjJlJgI6S7fAdQC35ZQw$Rpu8CLMWedxJaH0eiFCetyoRbg+S8ow/RRyVCZzM6QE" \
4949
ghcr.io/kloudkit/workspace:latest
5050
```
5151

docs/editor/extensions.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,21 +36,21 @@ Upon startup, Kloud Workspace evaluates several environment variables to automat
3636
installation of additional *user-defined* VSCode extensions.
3737
Both options below can be used in unison:
3838

39-
- **`WS_EXTRA_VS_EXTENSIONS`:** One or more space delimited extension names.
40-
- **`WS_EXTRA_VS_EXTENSIONS_DIR`:** Directory of extensions with as `*.vsix`.
39+
- **`WS_EDITOR_ADDITIONAL_VS_EXTENSIONS`:** One or more space delimited extension names.
40+
- **`WS_EDITOR_ADDITIONAL_VS_EXTENSIONS_DIR`:** Directory of extensions with as `*.vsix`.
4141

4242
::: code-group
4343

4444
```sh{2} [list]
4545
docker run \
46-
-e WS_EXTRA_VS_EXTENSIONS="dbaeumer.vscode-eslint esbenp.prettier-vscode" \
46+
-e WS_EDITOR_ADDITIONAL_VS_EXTENSIONS="dbaeumer.vscode-eslint esbenp.prettier-vscode" \
4747
ghcr.io/kloudkit/workspace:latest
4848
```
4949

5050
```sh{2,3} [directory]
5151
docker run \
52-
-e WS_EXTRA_VS_EXTENSIONS_DIR=/extra-extensions \
53-
-v /path/to/my-extra-extensions:/extra-extensions \
52+
-e WS_EDITOR_ADDITIONAL_VS_EXTENSIONS_DIR=/additional-extensions \
53+
-v /path/to/my-additional-extensions:/additional-extensions \
5454
ghcr.io/kloudkit/workspace:latest
5555
```
5656

docs/editor/features.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ see:
66
link: /tools/apt
77
---
88

9-
# Extra Features
9+
# Additional Features
1010

1111
Pre-installing and configuring every possible package would compromise a flexible
1212
*workspace* footprint.
@@ -23,12 +23,12 @@ You can choose the method that best fits your needs.
2323

2424
### Install at Boot
2525

26-
Kloud Workspace evaluates the `WS_EXTRA_FEATURES` environment variable at startup to
27-
determine which *features* to install automatically.
26+
Kloud Workspace evaluates the `WS_FEATURES_ADDITIONAL_FEATURES` environment variable at
27+
startup to determine which *features* to install automatically.
2828

2929
```sh{2}
3030
docker run \
31-
-e WS_EXTRA_FEATURES="dotnet jupyter" \
31+
-e WS_FEATURES_ADDITIONAL_FEATURES="dotnet jupyter" \
3232
ghcr.io/kloudkit/workspace:latest
3333
```
3434

docs/editor/port-forwarding.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,12 +45,12 @@ If adding DNS entries is not possible, refer to the [documentation below](#local
4545
a workaround you can implement on local systems.
4646
:::
4747

48-
You can define the domain *(and subdomain)* structure using the `WS_PROXY_DOMAIN`
48+
You can define the domain *(and subdomain)* structure using the `WS_SERVER_PROXY_DOMAIN`
4949
environment variable:
5050

5151
```sh{2}
5252
docker run \
53-
-e WS_PROXY_DOMAIN=ws.dev \
53+
-e WS_SERVER_PROXY_DOMAIN=ws.dev \
5454
ghcr.io/kloudkit/workspace:latest
5555
```
5656

docs/editor/terminal.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -31,20 +31,20 @@ Some users find the descriptive prompt to be too noisy.
3131
To *opt-out* of some of the prompt modules, you can set any of the following environment
3232
`env` variables to a *truthy* value *(either `1` or `true`)*:
3333

34-
- **`WS_PROMPT_DISABLE_DOCKER`:** Disable the `docker` module of the terminal prompt.
35-
- **`WS_PROMPT_DISABLE_HOSTNAME`:** Disable the `hostname` module of the terminal prompt.
36-
- **`WS_PROMPT_DISABLE_KUBERNETES`:** Disable the `kubernetes` module of the terminal prompt.
37-
- **`WS_PROMPT_DISABLE_NODEJS`:** Disable the `nodejs` module of the terminal prompt.
38-
- **`WS_PROMPT_DISABLE_PYTHON`:** Disable the `python` module of the terminal prompt.
39-
- **`WS_PROMPT_DISABLE_USER`:** Disable the user module of the terminal prompt.
34+
- **`WS_TERMINAL_PROMPT_HIDE_DOCKER_CONTEXT`:** Disable the `docker` module of the terminal prompt.
35+
- **`WS_TERMINAL_PROMPT_HIDE_HOSTNAME`:** Disable the `hostname` module of the terminal prompt.
36+
- **`WS_TERMINAL_PROMPT_HIDE_KUBERNETES_CONTEXT`:** Disable the `kubernetes` module of the terminal prompt.
37+
- **`WS_TERMINAL_PROMPT_HIDE_NODEJS_VERSION`:** Disable the `nodejs` module of the terminal prompt.
38+
- **`WS_TERMINAL_PROMPT_HIDE_PYTHON_VERSION`:** Disable the `python` module of the terminal prompt.
39+
- **`WS_TERMINAL_PROMPT_HIDE_USER`:** Disable the user module of the terminal prompt.
4040

4141
For example, to disable the Docker and Python modules, you could add the following lines
4242
to your deployment:
4343

4444
```sh{2,3}
4545
docker run \
46-
-e WS_PROMPT_DISABLE_DOCKER=1 \
47-
-e WS_PROMPT_DISABLE_PYTHON=1 \
46+
-e WS_TERMINAL_PROMPT_HIDE_DOCKER_CONTEXT=1 \
47+
-e WS_TERMINAL_PROMPT_HIDE_PYTHON_VERSION=1 \
4848
ghcr.io/kloudkit/workspace:latest
4949
```
5050

@@ -71,7 +71,7 @@ Tools and programming languages within the *workspace* that have corresponding
7171
To modify the default set of plugins, adjust the `env` variables listed below:
7272

7373
- **`WS_ZSH_PLUGINS`:** Specifies the `zsh` plugins to be enabled in each session.
74-
- **`WS_ZSH_EXTRA_PLUGINS`:** Adds additional `zsh` plugins to the existing defaults.
74+
- **`WS_ZSH_ADDITIONAL_PLUGINS`:** Adds additional `zsh` plugins to the existing defaults.
7575

7676
::: code-group
7777

@@ -83,7 +83,7 @@ docker run \
8383

8484
```sh{2} [Append]
8585
docker run \
86-
-e WS_ZSH_EXTRA_PLUGINS="php" \
86+
-e WS_ZSH_ADDITIONAL_PLUGINS="php" \
8787
ghcr.io/kloudkit/workspace:latest
8888
```
8989

docs/editor/theme-and-fonts.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,12 +54,12 @@ The *Victor Mono* font is not available as a *TrueType* font.
5454
#### Opt-out
5555

5656
Some users may not favor this stylistic choice.
57-
To disable the custom comments font, set the `WS_COMMENTS_DISABLE_FONT` environment
58-
variable to a *truthy* value *(either `1` or `true`)*:
57+
To disable the custom comments font, set the `WS_EDITOR_COMMENTS_DISABLE_FONT`
58+
environment variable to a *truthy* value *(either `1` or `true`)*:
5959

6060
```sh{2}
6161
docker run \
62-
-e WS_COMMENTS_DISABLE_FONT=1 \
62+
-e WS_EDITOR_COMMENTS_DISABLE_FONT=1 \
6363
ghcr.io/kloudkit/workspace:latest
6464
```
6565

docs/settings/autoload-scripts.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ Therefore, in addition to the predefined entrypoint scripts, we offer the abilit
1515
users defined entrypoint scripts to tailor the workspace experience.
1616

1717
::: info TIP
18-
Before creating extra entrypoint scripts, ensure that the objective you intend to achieve
19-
is not already addressed by built-in **[extendable configuration][]**.
18+
Before creating additional entrypoint scripts, ensure that the objective you intend to
19+
achieve is not already addressed by built-in **[extendable configuration][]**.
2020
:::
2121

2222
Startup scripts are defined at two levels:

docs/settings/environment-variables.md renamed to docs/settings/configuration.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Environment Variables
1+
# Configuration
22

33
![Dotenv logo](/icons/dotenv.svg){.doc-image}
44

@@ -8,18 +8,21 @@ sensible defaults.
88
Nearly every setting can be overridden with environment variables, giving you maximum
99
flexibility.
1010

11-
## `WS_<GROUP>` Prefix Convention
11+
All configuration is supplied **exclusively** through environment variables.
12+
No JSON, YAML, or CLI flags required. This makes the workspace fully *stateless* and
13+
cloud-friendly.
14+
15+
Nearly every individual setting can still be overridden, giving you maximum flexibility.
16+
17+
::: tip `WS_<GROUP>` Prefix Convention
1218

13-
::: tip
1419
Variables that are consumed **solely** by Kloud Workspace start with `WS_<GROUP>_`
1520
followed by the name *(example: `WS_TERMINAL_ZSH_PLUGINS`)*.
1621

17-
When a variable is also consumed by underlying tool, we keep its original name.
18-
Such variables can be reviewed in he [global variables](#global-variables) section.
22+
When a variable is also consumed by an underlying tool, we keep its original name.
23+
Such variables can be reviewed in the [global variables](#global-variables) section.
1924
:::
2025

21-
## Variables
22-
2326
<!--@include: ../partials/environment-variables.md -->
2427

2528
## Global Variables

0 commit comments

Comments
 (0)