Skip to content

Commit c0189ed

Browse files
strickvlclaude
andcommitted
docs: update Docker customization examples to use --custom-strings
Replace outdated CS_* environment variable examples with the new --custom-strings flag approach. Include both inline JSON and mounted file examples for Docker users. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
1 parent c2eb61d commit c0189ed

File tree

1 file changed

+19
-15
lines changed

1 file changed

+19
-15
lines changed

docs/install.md

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -289,27 +289,31 @@ docker run -it --name code-server -p 127.0.0.1:8080:8080 \
289289

290290
### Customizing the login page
291291

292-
You can customize the login page by setting environment variables:
292+
You can customize the login page using the `--custom-strings` flag:
293293

294294
```bash
295-
# Example with login customization
295+
# Example with inline JSON customization
296296
docker run -it --name code-server -p 127.0.0.1:8080:8080 \
297297
-v "$PWD:/home/coder/project" \
298-
-e "CS_LOGIN_TITLE=My Development Environment" \
299-
-e "CS_LOGIN_ENV_PASSWORD_MSG=Password configured via environment variable" \
300-
-e "CS_PASSWORD_PLACEHOLDER=Enter your secure password" \
301-
-e "CS_SUBMIT_TEXT=ACCESS" \
302-
codercom/code-server:latest
298+
codercom/code-server:latest --custom-strings '{
299+
"LOGIN_TITLE": "My Development Environment",
300+
"WELCOME": "Welcome to your coding workspace",
301+
"PASSWORD_PLACEHOLDER": "Enter your secure password",
302+
"SUBMIT": "ACCESS"
303+
}'
304+
```
305+
306+
Or mount a JSON file:
307+
308+
```bash
309+
# Example with JSON file
310+
docker run -it --name code-server -p 127.0.0.1:8080:8080 \
311+
-v "$PWD:/home/coder/project" \
312+
-v "$PWD/custom-strings.json:/config/strings.json" \
313+
codercom/code-server:latest --custom-strings /config/strings.json
303314
```
304315

305-
Available customization environment variables:
306-
- `CS_LOGIN_TITLE` - Custom login page title
307-
- `CS_LOGIN_BELOW` - Custom text below the login title
308-
- `CS_PASSWORD_PLACEHOLDER` - Custom password field placeholder
309-
- `CS_SUBMIT_TEXT` - Custom submit button text
310-
- `CS_LOGIN_PASSWORD_MSG` - Custom message for config file password
311-
- `CS_LOGIN_ENV_PASSWORD_MSG` - Custom message when using `$PASSWORD` env var
312-
- `CS_LOGIN_HASHED_PASSWORD_MSG` - Custom message when using `$HASHED_PASSWORD` env var
316+
For detailed customization options, see the [customization guide](./customization.md).
313317

314318
Our official image supports `amd64` and `arm64`. For `arm32` support, you can
315319
use a [community-maintained code-server

0 commit comments

Comments
 (0)