Skip to content

Commit c2eb61d

Browse files
strickvlclaude
andcommitted
docs: simplify migration guide to only cover released flags
Remove migration examples for flags that were never released. Only --app-name and --welcome-text were in the original codebase and might be used by existing users. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
1 parent 2553f45 commit c2eb61d

File tree

1 file changed

+7
-22
lines changed

1 file changed

+7
-22
lines changed

docs/customization.md

Lines changed: 7 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ docker run -it --name code-server -p 127.0.0.1:8080:8080 \
9797

9898
## Legacy Support (Deprecated)
9999

100-
The following individual flags are still supported but deprecated. Use `--custom-strings` for new deployments:
100+
The following flags are still supported but deprecated. Use `--custom-strings` for new deployments:
101101

102102
```bash
103103
# Deprecated - use --custom-strings instead
@@ -110,40 +110,25 @@ These legacy flags will show deprecation warnings and may be removed in future v
110110

111111
## Migration Guide
112112

113-
### From Individual Flags to Custom Strings
113+
### From Legacy Flags to Custom Strings
114114

115115
**Old approach:**
116116
```bash
117117
code-server \
118118
--app-name "Dev Portal" \
119-
--welcome-text "Welcome to development" \
120-
--login-title "Portal Access"
119+
--welcome-text "Welcome to development"
121120
```
122121

123122
**New approach:**
124123
```bash
125124
code-server --custom-strings '{
126-
"WELCOME": "Welcome to development",
127-
"LOGIN_TITLE": "Portal Access"
125+
"WELCOME": "Welcome to development"
128126
}'
129127
```
130128

131-
**Note:** The `--app-name` flag controls the `{{app}}` placeholder in templates. Use it alongside `--custom-strings` or customize the full text without placeholders.
132-
133-
### From Environment Variables
134-
135-
**Old approach:**
136-
```bash
137-
export CS_LOGIN_TITLE="Portal Access"
138-
export CS_WELCOME_TEXT="Welcome message"
139-
code-server
140-
```
141-
142-
**New approach:**
143-
```bash
144-
echo '{"LOGIN_TITLE": "Portal Access", "WELCOME": "Welcome message"}' > strings.json
145-
code-server --custom-strings strings.json
146-
```
129+
**Note:** The `--app-name` flag controls the `{{app}}` placeholder in templates. You can either:
130+
1. Keep using `--app-name` alongside `--custom-strings`
131+
2. Customize the full text without placeholders in your JSON
147132

148133
## Benefits of Custom Strings
149134

0 commit comments

Comments
 (0)