Skip to content

Commit 25288b1

Browse files
committed
Cleanup FAQ and mention GPG/SSH forwarding
1 parent 288e794 commit 25288b1

2 files changed

Lines changed: 14 additions & 7 deletions

File tree

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ Try it out:
99
docker run -it -p 127.0.0.1:8080:8080 -v "$PWD:/home/coder/project" codercom/code-server
1010
```
1111

12-
- **Consistent environment:** Code on your Chromebook, tablet, and laptop with a
13-
consistent dev environment. Develop more easily for Linux if you have a
14-
Windows or Mac and pick up where you left off when switching workstations.
12+
- **Code anywhere:** Code on your Chromebook, tablet, and laptop with a
13+
consistent dev environment. Develop on a Linux machine and pick up from any
14+
device with a web browser.
1515
- **Server-powered:** Take advantage of large cloud servers to speed up tests,
1616
compilations, downloads, and more. Preserve battery life when you're on the go
1717
since all intensive computation runs on your server.

doc/FAQ.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,12 @@ By far the most secure method of using code-server is via
3838
[sshcode](https://github.com/codercom/sshcode) as it runs code-server and then forwards
3939
its port over SSH and requires no setup on your part other than having a working SSH server.
4040

41+
You can also forward your SSH key and GPG agent to the remote machine to securely access GitHub
42+
and securely sign commits without duplicating your keys onto the the remote machine.
43+
44+
1. https://developer.github.com/v3/guides/using-ssh-agent-forwarding/
45+
1. https://wiki.gnupg.org/AgentForwarding
46+
4147
If you cannot use sshcode, then you will need to ensure there is some sort of authorization in
4248
front of code-server and that you are using HTTPS to secure all connections.
4349

@@ -76,8 +82,9 @@ privileged containers which are a security risk in a multi tenant infrastructure
7682
## Docker in code-server docker container?
7783

7884
If you'd like to access docker inside of code-server, we'd recommend running a docker:dind container
79-
and mounting in a /var/run directory to share between that and the code-server container. Install
80-
the docker CLI in the code-server container and you should be able to access the daemon.
85+
and mounting in a directory to share between dind and the code-server container at /var/run. After, install
86+
the docker CLI in the code-server container and you should be able to access the daemon as the socket
87+
will be shared at /var/run/docker.sock.
8188

8289
In order to make volume mounts work, mount the home directory in the code-server container and the
8390
dind container at the same path. i.e you'd volume mount a directory from the host to `/home/coder`
@@ -86,8 +93,8 @@ to make volume mounts in any other directory work.
8693

8794
## Collaboration
8895

89-
At the moment we have no plans for multi user collaboration on code-server but we understand this
90-
is a heavily requested feature and will work on it when the time is right.
96+
At the moment we have no plans for multi user collaboration on code-server but we understand there is strong
97+
demand and will work on it when the time is right.
9198

9299
## How can I disable telemetry?
93100

0 commit comments

Comments
 (0)