mirror of https://git.tuxpa.in/a/code-server.git
chore: add deprecation notice for --link (#4562)
Co-authored-by: Joe Previte <jjprevite@gmail.com>
This commit is contained in:
parent
3d4660491a
commit
6a2740f57e
|
@ -56,10 +56,6 @@ code-server.
|
||||||
We also have an in-depth [setup and
|
We also have an in-depth [setup and
|
||||||
configuration](https://coder.com/docs/code-server/latest/guide) guide.
|
configuration](https://coder.com/docs/code-server/latest/guide) guide.
|
||||||
|
|
||||||
## TLS and authentication (beta)
|
|
||||||
|
|
||||||
To add TLS and authentication out of the box, use [code-server --link](https://coder.com/docs/code-server/latest/link).
|
|
||||||
|
|
||||||
## Questions?
|
## Questions?
|
||||||
|
|
||||||
See answers to [frequently asked
|
See answers to [frequently asked
|
||||||
|
|
|
@ -1,6 +1,8 @@
|
||||||
# code-server --link
|
# code-server --link
|
||||||
|
|
||||||
Run code-server with the beta flag `--link` and you'll get TLS, authentication, and a dedicated URL
|
> Note: This feature is no longer recommended due to instability. Stay tuned for a revised version.
|
||||||
|
|
||||||
|
Run code-server with the flag `--link` and you'll get TLS, authentication, and a dedicated URL
|
||||||
for accessing your IDE out of the box.
|
for accessing your IDE out of the box.
|
||||||
|
|
||||||
```console
|
```console
|
||||||
|
|
|
@ -104,9 +104,9 @@ interface Option<T> {
|
||||||
description?: string
|
description?: string
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* If marked as beta, the option is marked as beta in help.
|
* If marked as deprecated, the option is marked as deprecated in help.
|
||||||
*/
|
*/
|
||||||
beta?: boolean
|
deprecated?: boolean
|
||||||
}
|
}
|
||||||
|
|
||||||
type OptionType<T> = T extends boolean
|
type OptionType<T> = T extends boolean
|
||||||
|
@ -230,7 +230,7 @@ const options: Options<Required<UserProvidedArgs>> = {
|
||||||
https://hostname-username.cdr.co at which you can easily access your code-server instance.
|
https://hostname-username.cdr.co at which you can easily access your code-server instance.
|
||||||
Authorization is done via GitHub.
|
Authorization is done via GitHub.
|
||||||
`,
|
`,
|
||||||
beta: true,
|
deprecated: true,
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -253,7 +253,7 @@ export const optionDescriptions = (): string[] => {
|
||||||
.map((line, i) => {
|
.map((line, i) => {
|
||||||
line = line.trim()
|
line = line.trim()
|
||||||
if (i === 0) {
|
if (i === 0) {
|
||||||
return " ".repeat(widths.long - k.length) + (v.beta ? "(beta) " : "") + line
|
return " ".repeat(widths.long - k.length) + (v.deprecated ? "(deprecated) " : "") + line
|
||||||
}
|
}
|
||||||
return " ".repeat(widths.long + widths.short + 6) + line
|
return " ".repeat(widths.long + widths.short + 6) + line
|
||||||
})
|
})
|
||||||
|
|
Loading…
Reference in New Issue