Skip to content
Draft
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
15 changes: 6 additions & 9 deletions docs/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,16 @@
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
# Contributor Covenant Code of Conduct

- [Contributor Covenant Code of Conduct](#contributor-covenant-code-of-conduct)
- [Our Pledge](#our-pledge)
- [Our Standards](#our-standards)
- [Our Responsibilities](#our-responsibilities)
- [Scope](#scope)
- [Enforcement](#enforcement)
- [Attribution](#attribution)
- [Our Pledge](#our-pledge)
- [Our Standards](#our-standards)
- [Our Responsibilities](#our-responsibilities)
- [Scope](#scope)
- [Enforcement](#enforcement)
- [Attribution](#attribution)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->
<!-- prettier-ignore-end -->

# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
Expand Down
4 changes: 4 additions & 0 deletions docs/FAQ.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
description: "Answers to all your FAQs: Learn how to expose code-server, use it on an iPad, install extensions, debug issues and more."
---

<!-- prettier-ignore-start -->
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
Expand Down
4 changes: 4 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
description: "Learn how to install and run code-server using VS Code. Start here and access all documentation for code-server today!"
---

# code-server

[!["GitHub Discussions"](https://img.shields.io/badge/%20GitHub-%20Discussions-gray.svg?longCache=true&logo=github&colorB=purple)](https://github.com/coder/code-server/discussions) [!["Join us on Slack"](https://img.shields.io/badge/join-us%20on%20slack-gray.svg?longCache=true&logo=slack&colorB=brightgreen)](https://coder.com/community) [![Twitter Follow](https://img.shields.io/twitter/follow/CoderHQ?label=%40CoderHQ&style=social)](https://twitter.com/coderhq) [![Discord](https://img.shields.io/discord/747933592273027093)](https://discord.com/invite/coder) [![See latest](https://img.shields.io/static/v1?label=Docs&message=see%20latest&color=blue)](https://coder.com/docs/code-server/latest)
Expand Down
6 changes: 4 additions & 2 deletions docs/android.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Running code-server using UserLAnd
# Running code-server on Android

## Using UserLAnd

1. Install UserLAnd from [Google Play](https://play.google.com/store/apps/details?id=tech.ula&hl=en_US&gl=US)
2. Install an Ubuntu VM
Expand All @@ -22,7 +24,7 @@ nvm use 24
9. Run code-server with `code-server`
10. Access on localhost:8080 in your browser

# Running code-server using Nix-on-Droid
## Using Nix-on-Droid

1. Install Nix-on-Droid from [F-Droid](https://f-droid.org/packages/com.termux.nix/)
2. Start app
Expand Down
8 changes: 6 additions & 2 deletions docs/guide.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
description: "A comprehensive guide for developers to securely access and expose code-server. Learn about SSH port forwarding, Let's Encrypt, HTTPS and more."
---

<!-- prettier-ignore-start -->
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
Expand Down Expand Up @@ -64,7 +68,7 @@ doesn't require any additional setup at all.

The downside to SSH forwarding, however, is that you can't access code-server
when using machines without SSH clients (such as iPads). If this applies to you,
we recommend using another method, such as [Let's Encrypt](#let-encrypt) instead.
we recommend using another method, such as [Let's Encrypt](#using-lets-encrypt-with-caddy) instead.

> To work properly, your environment should have WebSockets enabled, which
> code-server uses to communicate between the browser and server.
Expand Down Expand Up @@ -460,7 +464,7 @@ const config = {
}
```

3. Access app at `<code-server-root>/absproxy/5173/` e.g. `http://localhost:8080/absproxy/5173/
3. Access app at `<code-server-root>/absproxy/5173/` e.g. `http://localhost:8080/absproxy/5173/`

For additional context, see [this Github Issue](https://github.com/sveltejs/kit/issues/2958)

Expand Down
2 changes: 1 addition & 1 deletion docs/helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ $ helm upgrade --install code-server ci/helm-chart -f values.yaml

> **Tip**: You can use the default [values.yaml](../ci/helm-chart/values.yaml)

# Extra Containers
## Extra Containers

There are two parameters which allow to add more containers to pod.
Use `extraContainers` to add regular containers
Expand Down
6 changes: 5 additions & 1 deletion docs/install.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
description: "Easily install code-server on any platform with our straightforward instructions, offering multiple methods for different OS and distributions."
---

<!-- prettier-ignore-start -->
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
Expand Down Expand Up @@ -304,7 +308,7 @@ If you see an error related to `node-gyp` during installation, See [#5174](https

## Termux

Please see code-server's [Termux docs](./termux.md#installation) for more
Please see code-server's [Termux docs](./termux.md#install) for more
information.

## Uninstall
Expand Down
2 changes: 1 addition & 1 deletion docs/ipad.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ and tricks helpful:
- `ctrl+c` does not stop a long-running process in the browser
- Tracking upstream issue here:
[#114009](https://github.com/microsoft/vscode/issues/114009)
- See [workaround](#ctrl-c-workaround)
- See [workaround](#workaround-for-issue-with-ctrlc-not-stopping-a-running-process-in-the-terminal)

Additionally, see [issues in the code-server repo that are tagged with the `os-ios`
label](https://github.com/coder/code-server/issues?q=is%3Aopen+is%3Aissue+label%3Aos-ios)
Expand Down
2 changes: 1 addition & 1 deletion docs/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@
},
{
"title": "Android",
"description": "How to run code-server on an Android device using UserLAnd.",
"description": "How to run code-server on an Android device using UserLAnd or Nix-on-Droid.",
"path": "./android.md"
}
]
Expand Down