a
/
code-server-2
mirror of https://git.tuxpa.in/a/code-server.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Cleanup FAQ and mention GPG/SSH forwarding

This commit is contained in:
Anmol Sethi 2020-02-20 17:29:08 -05:00
parent 288e794c99
commit 25288b1afd
No known key found for this signature in database
GPG Key ID: 8CEF1878FF10ADEB
2 changed files with 14 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

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

15
doc/FAQ.md
View File

@ -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 [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. 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 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. 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? ## 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 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 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. 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 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` 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 ## Collaboration
At the moment we have no plans for multi user collaboration on code-server but we understand this At the moment we have no plans for multi user collaboration on code-server but we understand there is strong
is a heavily requested feature and will work on it when the time is right. demand and will work on it when the time is right.
## How can I disable telemetry? ## How can I disable telemetry?