Adds Default Connection Support

Dockerfile

@@ -5,10 +5,9 @@ COPY . /graph-explorer/
 WORKDIR /graph-explorer
 # Keeping all the RUN commands on a single line reduces the number of layers and,
 # as a result, significantly reduces the final image size.
-RUN curl -sL https://rpm.nodesource.com/setup_16.x | bash - && yum install -y nodejs openssl && npm install -g pnpm && pnpm install && rm -rf /var/cache/yum
+RUN curl -sL https://rpm.nodesource.com/setup_16.x | bash - && yum install -y nodejs openssl && npm install -g pnpm && pnpm install && rm -rf /var/cache/yum && chmod a+x ./process-environment.sh
 WORKDIR /graph-explorer/
 ENV HOME=/graph-explorer
-RUN pnpm build
 EXPOSE 443
 EXPOSE 80
 RUN chmod a+x ./docker-entrypoint.sh

README.md

@@ -94,6 +94,37 @@ You can search, browse, expand, customize views of your graph data using Graph E
 ## Connections
 The Graph Explorer supports visualizing both **property graphs** and **RDF graphs**. You can connect to Amazon Neptune or you can also connect to open graph databases that implement an Apache TinkerPop Gremlin Server endpoint or the SPARQL 1.1 protocol, such as Blazegraph. For additional details on connecting to different graph databases, see [Connections](./additionaldocs/connections.md).
 
+### Providing a Default Connection 
+To provide a default connection such that initial loads of the graph explorer always result with the same starting connection, modify the `docker run ...` command to either take in a json configuration or runtime environment variables. A json configuration approach would look like `docker run -p 80:80 -p 443:443 --env HOST={hostname-or-ip-address} -v /path/to/config.json:/graph-explorer/config.json graph-explorer` or create a `config.json` file at the root of the project. An environment variable approach would look like `docker run -p 80:80 -p 443:443 --env HOST={hostname-or-ip-address} --env PUBLIC_OR_PROXY_ENDPOINT=https://public-endpoint --env GRAPH_TYPE=gremlin --env USING_PROXY_SERVER=true --env IAM=false --env GRAPH_CONNECTION_URL=https://cluster-cqmizgqgrsbf.us-west-2.neptune.amazonaws.com:8182 --env AWS_REGION=us-west-2 graph-explorer`. IF you provide both, the json approach will be prioritized.
+
+
+The set of valid ENV connection variables and their defaults:
+* Required:
+     * PUBLIC_OR_PROXY_ENDPOINT - None
+* Optional
+     * GRAPH_TYPE - PG (Property Graph)
+     * USING_PROXY_SERVER - False
+     * IAM - False
+* Conditionally Required:
+     * GRAPH_CONNECTION_URL - None 
+* Required if USING_PROXY_SERVER=True
+     * AWS_REGION - None
+* Required if USING_PROXY_SERVER=True and IAM=True
+
+
+The config.json file should provide values for the attributes at the top level as in the example below:
+
+```
+{
+     "PUBLIC_OR_PROXY_ENDPOINT": "https://public-endpoint",
+     "GRAPH_CONNECTION_URL": "https://cluster-cqmizgqgrsbf.us-west-2.neptune.amazonaws.com:8182",
+     "USING_PROXY_SERVER": true, (Can be string or boolean)
+     "IAM": true, (Can be string or boolean)
+     "AWS_REGION": "us-west-2",
+     "GRAPH_TYPE": "gremlin" (Possible Values: "gremlin" or "sparql")
+}
+```
+
 ## Development
 For development guidance, see [Development](./additionaldocs/development.md).
 

docker-entrypoint.sh

@@ -1,5 +1,7 @@
 #!/bin/sh
 
+./process-environment.sh
+
 if [ $(grep -e 'GRAPH_EXP_HTTPS_CONNECTION' ./packages/graph-explorer/.env | cut -d "=" -f 2) ]; then
 
     if [ $HOST ]; then
@@ -25,5 +27,8 @@ else
     echo "SSL disabled. Skipping self-signed certificate generation."
     exit 1
 fi
+
+echo "Building graph explorer..."
+pnpm -w build
 echo "Starting graph explorer..."
 pnpm -w start:proxy-server

packages/graph-explorer/src/index.tsx

@@ -24,12 +24,12 @@ if (params.configFile) {
       import.meta.env.GRAPH_EXP_CONNECTION_NAME ||
       import.meta.env.GRAPH_EXP_CONNECTION_URL,
     connection: {
-      url: import.meta.env.GRAPH_EXP_CONNECTION_URL,
-      queryEngine:
-        (import.meta.env.GRAPH_EXP_CONNECTION_ENGINE as
-          | "gremlin"
-          | "sparql"
-          | undefined) || "gremlin",
+      url: import.meta.env.GRAPH_EXP_PUBLIC_OR_PROXY_ENDPOINT || "",
+      queryEngine: (import.meta.env.GRAPH_EXP_GRAPH_TYPE.toLowerCase() === "gremlin" || import.meta.env.GRAPH_EXP_GRAPH_TYPE.toLowerCase() === "sparql") ? import.meta.env.GRAPH_EXP_GRAPH_TYPE.toLowerCase() : "gremlin",
+      proxyConnection: (import.meta.env.GRAPH_EXP_USING_PROXY_SERVER.toUpperCase() === "TRUE") ? true : false,
+      graphDbUrl: import.meta.env.GRAPH_EXP_CONNECTION_URL || "",
+      awsAuthEnabled: (import.meta.env.GRAPH_EXP_IAM.toUpperCase() === "TRUE") ? true : false,
+      awsRegion: import.meta.env.GRAPH_EXP_AWS_REGION || "",
     },
   };
 }

process-environment.sh

@@ -0,0 +1,39 @@
+#!/bin/sh
+
+if [ -f "./config.json" ]; then 
+
+    json=$(cat ./config.json)
+
+    PUBLIC_OR_PROXY_ENDPOINT=$(echo "$json" | grep -o '"PUBLIC_OR_PROXY_ENDPOINT":[^,}]*' | cut -d '"' -f 4)
+    GRAPH_TYPE=$(echo "$json" | grep -o '"GRAPH_TYPE":[^,}]*' | cut -d '"' -f 4)
+    USING_PROXY_SERVER=$(echo "$json" | grep -o '"USING_PROXY_SERVER":[^,}]*' | cut -d ':' -f 2 | tr -d '[:space:]' | sed 's/"//g')
+    IAM=$(echo "$json" | grep -o '"IAM":[^,}]*' | cut -d ':' -f 2 | tr -d '[:space:]' | sed 's/"//g')
+    GRAPH_CONNECTION_URL=$(echo "$json" | grep -o '"CONNECTION_URL":[^,}]*' | cut -d '"' -f 4)
+    AWS_REGION=$(echo "$json" | grep -o '"AWS_REGION":[^,}]*' | cut -d '"' -f 4)
+fi
+
+# Update the .env file with the configuration values
+if [ -n "$PUBLIC_OR_PROXY_ENDPOINT" ]; then 
+    echo -e "\nGRAPH_EXP_PUBLIC_OR_PROXY_ENDPOINT=${PUBLIC_OR_PROXY_ENDPOINT}" >> ./packages/graph-explorer/.env
+
+    if [ -n "$GRAPH_TYPE" ]; then 
+        echo "GRAPH_EXP_GRAPH_TYPE=${GRAPH_TYPE}" >> ./packages/graph-explorer/.env
+    else 
+        echo "GRAPH_EXP_GRAPH_TYPE=PG" >> ./packages/graph-explorer/.env
+    fi
+
+    if [ -n "$USING_PROXY_SERVER" ]; then 
+        echo "GRAPH_EXP_USING_PROXY_SERVER=${USING_PROXY_SERVER}" >> ./packages/graph-explorer/.env
+    else 
+        echo "GRAPH_EXP_USING_PROXY_SERVER=false" >> ./packages/graph-explorer/.env
+    fi 
+
+    if [ -n "$IAM" ]; then 
+        echo "GRAPH_EXP_IAM=${IAM}" >> ./packages/graph-explorer/.env
+    else 
+        echo "GRAPH_EXP_IAM=false" >> ./packages/graph-explorer/.env
+    fi
+
+    echo "GRAPH_EXP_CONNECTION_URL=${GRAPH_CONNECTION_URL}" >> ./packages/graph-explorer/.env
+    echo "GRAPH_EXP_AWS_REGION=${AWS_REGION}" >> ./packages/graph-explorer/.env
+fi