Skip to content

Commit

Permalink
Merge pull request #26 from tigergraph/GML-1492-auth-with-secret
Browse files Browse the repository at this point in the history
doc(auth): add authentication section
  • Loading branch information
parkererickson-tg authored Jan 29, 2024
2 parents feaacfe + 6d831e8 commit 22cf36c
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,9 @@ docker run -d -v $(pwd)/configs/openai_gpt4_config.json:/llm_config.json -v $(pw
## Open Swagger Doc Page
Navigate to `http://localhost/docs` when the Docker container is running.

## Authentication
There are two options to authenticate with the service. First is an username/password pair generated from the TigerGraph database. The second is a GSQL secret, also obtained from the database. However, when using the GSQL secret, the username field must be specified as `__GSQL__secret`, with the password field containing the secret. If pyTigerGraph is being used and a connection is created with the `gsqlSecret` parameter, this will already be done for you.

## Using pyTigerGraph
First, update pyTigerGraph to utilize the latest build:
```sh
Expand Down

0 comments on commit 22cf36c

Please sign in to comment.