Skip to content

Commit d3e5a08

Browse files
committed
add section about secure deployment
1 parent 7148830 commit d3e5a08

1 file changed

Lines changed: 11 additions & 9 deletions

File tree

‎README.md‎

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,17 @@ This extension is configured to talk to a language server over WebSockets. If yo
1717
private Sourcegraph instance, you should run your own language server. The server is available as a
1818
Docker image `sourcegraph/lang-python` from Docker Hub.
1919

20+
### 🚨 Secure deployment 🚨
21+
22+
We recommend deploying the language server behind an auth proxy or firewall and
23+
treating it like an authenticated user because anyone that connects to the
24+
language server can access resources such as private code that the language
25+
server has access to.
26+
27+
Make sure you set `python.sourcegraphUrl` to the URL that the language
28+
server should use to reach Sourcegraph, which is likely different from the URL
29+
that end users use.
30+
2031
### Using Docker
2132

2233
1. Run the Python language server Docker container:
@@ -41,15 +52,6 @@ Docker image `sourcegraph/lang-python` from Docker Hub.
4152
ip addr show docker0 | grep -Po 'inet \K[\d.]+'
4253
```
4354
44-
### Authentication proxies and firewalls
45-
46-
Some customers deploy Sourcegraph behind an authentication proxy or firewall. If you do this, we
47-
recommend deploying the language server behind the proxy so that it can issue requests directly to
48-
Sourcegraph without going through the proxy. (Otherwise, you will need to configure the language
49-
server to authenticate through your proxy.) Make sure you set `python.sourcegraphUrl` to the URL
50-
that the language server should use to reach Sourcegraph, which is likely different from the URL
51-
that end users use.
52-
5355
## Known issues
5456
5557
- Dependencies are not installed. Hovers, definitions, and references only work for sources checked into the single repository you are viewing.

0 commit comments

Comments
 (0)