From 25288b1afd3d2463425f22e839579982a23beb7d Mon Sep 17 00:00:00 2001 From: Anmol Sethi Date: Thu, 20 Feb 2020 17:29:08 -0500 Subject: [PATCH] Cleanup FAQ and mention GPG/SSH forwarding --- README.md | 6 +++--- doc/FAQ.md | 15 +++++++++++---- 2 files changed, 14 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index d56251e3..9c780993 100644 --- a/README.md +++ b/README.md @@ -9,9 +9,9 @@ Try it out: docker run -it -p 127.0.0.1:8080:8080 -v "$PWD:/home/coder/project" codercom/code-server ``` -- **Consistent environment:** Code on your Chromebook, tablet, and laptop with a - consistent dev environment. Develop more easily for Linux if you have a - Windows or Mac and pick up where you left off when switching workstations. +- **Code anywhere:** Code on your Chromebook, tablet, and laptop with a + consistent dev environment. Develop on a Linux machine and pick up from any + device with a web browser. - **Server-powered:** Take advantage of large cloud servers to speed up tests, compilations, downloads, and more. Preserve battery life when you're on the go since all intensive computation runs on your server. diff --git a/doc/FAQ.md b/doc/FAQ.md index 96bf7316..060c79e0 100644 --- a/doc/FAQ.md +++ b/doc/FAQ.md @@ -38,6 +38,12 @@ By far the most secure method of using code-server is via [sshcode](https://github.com/codercom/sshcode) as it runs code-server and then forwards its port over SSH and requires no setup on your part other than having a working SSH server. +You can also forward your SSH key and GPG agent to the remote machine to securely access GitHub +and securely sign commits without duplicating your keys onto the the remote machine. + +1. https://developer.github.com/v3/guides/using-ssh-agent-forwarding/ +1. https://wiki.gnupg.org/AgentForwarding + If you cannot use sshcode, then you will need to ensure there is some sort of authorization in front of code-server and that you are using HTTPS to secure all connections. @@ -76,8 +82,9 @@ privileged containers which are a security risk in a multi tenant infrastructure ## Docker in code-server docker container? If you'd like to access docker inside of code-server, we'd recommend running a docker:dind container -and mounting in a /var/run directory to share between that and the code-server container. Install -the docker CLI in the code-server container and you should be able to access the daemon. +and mounting in a directory to share between dind and the code-server container at /var/run. After, install +the docker CLI in the code-server container and you should be able to access the daemon as the socket +will be shared at /var/run/docker.sock. In order to make volume mounts work, mount the home directory in the code-server container and the 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. ## Collaboration -At the moment we have no plans for multi user collaboration on code-server but we understand this -is a heavily requested feature and will work on it when the time is right. +At the moment we have no plans for multi user collaboration on code-server but we understand there is strong +demand and will work on it when the time is right. ## How can I disable telemetry?