docs: comment localhost:<port> vs :<port> for server "listen" specifi…

…cations (kythe#3906)
pseyfert · Aug 7, 2019 · c41cf52 · c41cf52
1 parent d8df920
commit c41cf52
Show file tree

Hide file tree

Showing 8 changed files with 15 additions and 10 deletions.
diff --git a/README.langserver.md b/README.langserver.md
@@ -50,8 +50,8 @@ bazel-bin/kythe/go/indexer/cmd/go_indexer/go_indexer -code $(find bazel-out/k8-f
 # See https://github.com/kythe/kythe/issues/3412.
 bazel-bin/kythe/go/serving/tools/write_tables/write_tables --entries $ENTRIES --experimental_beam_pipeline --out $TAB
 
-# Serve.
-bazel-bin/kythe/go/serving/tools/http_server/http_server --serving_table $TAB --listen 0.0.0.0:8080 --public_resources $UI
+# Serve.  ("--listen :8080" allows access from other machines)
+bazel-bin/kythe/go/serving/tools/http_server/http_server --serving_table $TAB --listen localhost:8080 --public_resources $UI
 ```
 
 ## Augment the local-to-vname mapping

diff --git a/kythe/docs/schema/writing-an-indexer.txt b/kythe/docs/schema/writing-an-indexer.txt
@@ -76,7 +76,7 @@ mkdir -p graphstore tables
 # Host the browser UI.
 /opt/kythe/tools/http_server -serving_table tables \
   -public_resources="/opt/kythe/web/ui" \
-  -listen="localhost:${BROWSE_PORT}"
+  -listen="localhost:${BROWSE_PORT}"  # ":${BROWSE_PORT}" allows access from other machines
 ----
 
 TIP: The

diff --git a/kythe/examples/bazel/kythe-index.sh b/kythe/examples/bazel/kythe-index.sh
@@ -31,7 +31,9 @@ Paths to output artifacts are controlled with the --graphstore and --serving_tab
 defaults are $TMPDIR/gs.bazel and $TMPDIR/serving.bazel, respectively.
 
 The --serving_addr flag controls the listening address of the Kythe http_server.
-It's default is localhost:8888.  Any --webui path provided will be passed to the
+Its default is localhost:8080.  ("localhost:8080" allows access from
+only the same machine the server is running on; ":8080" allows access
+from any machine.)  Any --webui path provided will be passed to the
 http_server as its --public_resources flag.
 
 The --bazel_root and --kythe_repo flags control which Bazel repository to index
@@ -56,7 +58,7 @@ BAZEL_ROOT="$PWD"
 
 GRAPHSTORE="$TMPDIR"/gs.bazel
 SERVING_TABLE="$TMPDIR"/serving.bazel
-SERVING_ADDR=localhost:8888
+SERVING_ADDR=localhost:8080  # :8080 allows access from any machine
 WEBUI=()
 
 EXTRACT=

diff --git a/kythe/go/languageserver/bin/main.go b/kythe/go/languageserver/bin/main.go
@@ -38,7 +38,7 @@ var (
 	pageSize = flag.Int("page_size", 0, "Set the default xrefs page size")
 
 	serverAddr = flag.String("server", "localhost:8080",
-		"The address of the Kythe service to use")
+		"The address of the Kythe service to use (:8080 allows access from other machines)")
 )
 
 func main() {

diff --git a/kythe/go/serving/tools/http_server/http_server.go b/kythe/go/serving/tools/http_server/http_server.go
@@ -45,7 +45,7 @@ import (
 var (
 	servingTable = flag.String("serving_table", "", "LevelDB serving table")
 
-	httpListeningAddr = flag.String("listen", "localhost:8080", "Listening address for HTTP server")
+	httpListeningAddr = flag.String("listen", "localhost:8080", "Listening address for HTTP server (\":<port>\" allows access from any machine)")
 	httpAllowOrigin   = flag.String("http_allow_origin", "", "If set, each HTTP response will contain a Access-Control-Allow-Origin header with the given value")
 	publicResources   = flag.String("public_resources", "", "Path to directory of static resources to serve")
 

diff --git a/kythe/release/appengine/xrefs/server.go b/kythe/release/appengine/xrefs/server.go
@@ -39,7 +39,7 @@ import (
 var (
 	servingTable    = flag.String("serving_table", "/srv/table", "LevelDB serving table path")
 	publicResources = flag.String("public_resources", "/srv/public", "Path to directory of static resources to serve")
-	listeningAddr   = flag.String("listen", "localhost:8080", "Listening address for HTTP server")
+	listeningAddr   = flag.String("listen", "localhost:8080", "Listening address for HTTP server (:<port> allows access from any machine)")
 )
 
 func main() {

diff --git a/kythe/rust/cargo-kythe/src/main.rs b/kythe/rust/cargo-kythe/src/main.rs
@@ -107,9 +107,10 @@ fn web(kythe_dir: &Path) {
                 "-public_resources",
                 &kythe_dir.join("web/ui").to_string_lossy(),
                 "-grpc_listen",
-                "localhost:8081",
+                "localhost:8081",  // ":8081" allows access from any machine
                 "-listen",
-                "localhost:8080"])
+                "locahost:8080"  // ":8080" allows access from any machine
+                ])
         .spawn()
         .expect("could not start http_server");
 

diff --git a/kythe/web/site/examples.md b/kythe/web/site/examples.md
@@ -155,6 +155,8 @@ basic cross-reference capabilities.  The following command can be run over the
 serving table created with the `write_tables` binary (see above).
 
 {% highlight bash %}
+# --listen localhost:8080 allows access from only this machine; change to
+# --listen :8080 to allow access from any machine
 /opt/kythe/tools/http_server \
   --public_resources /opt/kythe/web/ui \
   --listen localhost:8080 \