Skip to content

Commit adbb633

Browse files
committed
GH-5: Adding note on Compose installation and updating credits.
1 parent df55c37 commit adbb633

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,13 +90,18 @@ poetry env remove <PATH-TO-PYTHON-EXE>
9090
* Run Docker Compose, and open an interactive shell:
9191
```bash
9292
docker compose up -d
93+
```
94+
* *Note*: When running for the first time, ```compose``` might show error in the first line as the image does not exist yet, but this will be remedied automatically by the script building/pulling the container images.
95+
96+
* Open an interactive shell to run the code, or develop within the container using VSCode [remote development](https://code.visualstudio.com/docs/remote/remote-overview) extension.
97+
```bash
9398
docker exec -it twingraph-twingraph-1 bash
9499
```
95100
* Once completed, you can bring down all the containers:
96101
```bash
97102
docker compose down
98103
```
99-
* Note that when using Compose, TwinGraph API decorator variables need to point to Redis, Gremlin server and TwinGraph hosts - examples included in the provided [Dockerfile](Dockerfile) should run without any changes with the provided [Compose script](docker-compose.yaml); key in 'tinkergraph-server' instead of 'localhost' when using the Gremlin visualizer in the *host* field.
104+
* *Note*: When using Compose, TwinGraph API decorator variables need to point to Redis, Gremlin server and TwinGraph hosts - examples included in the provided [Dockerfile](Dockerfile) should run without any changes with the provided [Compose script](docker-compose.yaml); key in 'tinkergraph-server' instead of 'localhost' when using the Gremlin visualizer in the *host* field.
100105
* If using the provided [Dockerfile](Dockerfile) without Compose, please replace the ENV vars in lines 3-5 with localhost or the host where the other containers are running.
101106

102107
## (**OPTIONAL**) Installation Option 3: Manual Full Installation Steps & Using Poetry Env
@@ -160,4 +165,4 @@ AWS Resources:
160165

161166
## Credits
162167

163-
This open source framework was developed by the Autonomous Computing Team within Amazon Web Services (AWS) Worldwide Specialist Organization (WWSO), led by Vidyasagar Ananthan and Satheesh Maheswaran, with contributions from Cheryl Abundo on Amazon EKS Blueprints. The authors acknowledge and thank Adam Rasheed for his leadership and support to our team, and to Alex Iankoulski for his detailed guidance and contributions on Docker tools and expertise in reviewing the code.
168+
This open source framework was developed by the Autonomous Computing Team within Amazon Web Services (AWS) Worldwide Specialist Organization (WWSO), led by Vidyasagar Ananthan and Satheesh Maheswaran, with contributions from Cheryl Abundo on Amazon EKS Blueprints, David Sauerwein on applications, and Ross Pivovar for initial testing and identifying issues. The authors acknowledge and thank Adam Rasheed for his leadership and support to our team, and to Alex Iankoulski for his detailed guidance and contributions on Docker tools and expertise in reviewing the code.

0 commit comments

Comments
 (0)