Skip to content
This repository was archived by the owner on Feb 22, 2020. It is now read-only.

Commit 1c40644

Browse files
committed
add section about secure deployment
1 parent 5e80d80 commit 1c40644

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

README.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,16 @@ This extension is configured to talk to a language server over WebSockets. If yo
1010
private Sourcegraph instance, you should run your own language server. The server is available as a
1111
Docker image `sourcegraph/lang-go` from Docker Hub.
1212

13+
### 🚨 Secure deployment 🚨
14+
15+
Anyone that connects to the language server can access resources such as private
16+
code that the language server has access to.
17+
18+
We recommend deploying the language server behind an auth proxy or firewall and
19+
treating it like an authenticated user. Make sure you set `go.sourcegraphUrl` to
20+
the URL that the language server should use to reach Sourcegraph, which is
21+
likely different from the URL that end users use.
22+
1323
### Using Docker
1424

1525
1. Run the Go language server:
@@ -44,15 +54,6 @@ Docker image `sourcegraph/lang-go` from Docker Hub.
4454

4555
Now visit a Go file and you should see code intelligence!
4656

47-
### Authentication proxies and firewalls
48-
49-
Some customers deploy Sourcegraph behind an authentication proxy or firewall. If you do this, we
50-
recommend deploying the language server behind the proxy so that it can issue requests directly to
51-
Sourcegraph without going through the proxy. (Otherwise, you will need to configure the language
52-
server to authenticate through your proxy.) Make sure you set `go.sourcegraphUrl` to the URL
53-
that the language server should use to reach Sourcegraph, which is likely different from the URL
54-
that end users use.
55-
5657
### Using Kubernetes
5758

5859
Here's a sample Kubernetes configuration:
@@ -169,6 +170,8 @@ spec:
169170
170171
## Private dependencies
171172
173+
🚨 Before mounting your credentials into the language server, make sure the language server is hidden behind an auth proxy or firewall. 🚨
174+
172175
### Private dependencies via `.netrc`
173176
174177
Make sure your `$HOME/.netrc` contains:

0 commit comments

Comments
 (0)