Skip to content

Commit 7c10c76

Browse files
committed
update README with homebrew information
1 parent 8d69c3a commit 7c10c76

File tree

1 file changed

+70
-46
lines changed

1 file changed

+70
-46
lines changed

README.md

Lines changed: 70 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -13,47 +13,52 @@ Graphik is a Backend as a Service implemented as an identity-aware, permissioned
1313

1414
Support: support@graphikdb.io
1515

16-
* [Problem Statement](#problem-statement)
17-
- [Traditional relational databases are powerful but come with a number of issues that interfere with agile development methodologies:](#traditional-relational-databases-are-powerful-but-come-with-a-number-of-issues-that-interfere-with-agile-development-methodologies-)
18-
- [Traditional non-relational databases are non-relational](#traditional-non-relational-databases-are-non-relational)
19-
- [Traditional non-relational databases often don't have a declarative query language](#traditional-non-relational-databases-often-don-t-have-a-declarative-query-language)
20-
- [Traditional non-relational databases often don't support custom constraints](#traditional-non-relational-databases-often-don-t-support-custom-constraints)
21-
- [No awareness of origin/end user accessing the records(only the API/dba making the request)](#no-awareness-of-origin-end-user-accessing-the-records-only-the-api-dba-making-the-request-)
22-
+ [Solution](#solution)
23-
* [Features](#features)
24-
* [Key Dependencies](#key-dependencies)
25-
* [Flags](#flags)
26-
* [gRPC Client SDKs](#grpc-client-sdks)
27-
* [Implemenation Details](#implemenation-details)
28-
+ [Primitives](#primitives)
29-
+ [Identity Graph](#identity-graph)
30-
+ [Login/Authorization/Authorizers](#login-authorization-authorizers)
31-
- [Authorizers Examples](#authorizers-examples)
32-
+ [Secondary Indexes](#secondary-indexes)
33-
- [Secondary Index Examples](#secondary-index-examples)
34-
+ [Constraints](#constraints)
35-
- [Constraint Examples](#type-validator-examples)
36-
+ [Triggers](#triggers)
37-
- [Trigger Examples](#trigger-examples)
38-
+ [GraphQL vs gRPC API](#graphql-vs-grpc-api)
39-
+ [Streaming/PubSub](#streaming-pubsub)
40-
+ [Graphik Playground](#graphik-playground)
41-
+ [Additional Details](#additional-details)
42-
* [Sample GraphQL Queries](#sample-graphql-queries)
43-
+ [Get Currently Logged In User(me)](#get-currently-logged-in-user-me-)
44-
+ [Get the Graph Schema](#get-the-graph-schema)
45-
+ [Set a Request Authorizer](#set-a-request-authorizer)
46-
+ [Create a Document](#create-a-document)
47-
+ [Traverse Documents](#traverse-documents)
48-
+ [Traverse Documents Related to Logged In User](#traverse-documents-related-to-logged-in-user)
49-
+ [Change Streaming](#change-streaming)
50-
+ [Broadcasting a Message](#broadcasting-a-message)
51-
+ [Filtered Streaming](#filtered-streaming)
52-
* [Deployment](#deployment)
53-
+ [Docker-Compose](#docker-compose)
54-
+ [Kubernetes](#kubernetes)
55-
* [OIDC Metadata Urls](#oidc-metadata-urls)
56-
* [Glossary](#glossary)
16+
- [Problem Statement](#problem-statement)
17+
+ [Traditional relational databases are powerful but come with a number of issues that interfere with agile development methodologies:](#traditional-relational-databases-are-powerful-but-come-with-a-number-of-issues-that-interfere-with-agile-development-methodologies-)
18+
+ [Traditional non-relational databases are non-relational](#traditional-non-relational-databases-are-non-relational)
19+
+ [Traditional non-relational databases often don't have a declarative query language](#traditional-non-relational-databases-often-don-t-have-a-declarative-query-language)
20+
+ [Traditional non-relational databases often don't support custom constraints](#traditional-non-relational-databases-often-don-t-support-custom-constraints)
21+
+ [No awareness of origin/end user accessing the records(only the API/dba making the request)](#no-awareness-of-origin-end-user-accessing-the-records-only-the-api-dba-making-the-request-)
22+
* [Solution](#solution)
23+
- [Features](#features)
24+
- [Key Dependencies](#key-dependencies)
25+
- [Flags](#flags)
26+
- [gRPC Client SDKs](#grpc-client-sdks)
27+
- [Implemenation Details](#implemenation-details)
28+
* [Primitives](#primitives)
29+
* [Identity Graph](#identity-graph)
30+
* [Login/Authorization/Authorizers](#login-authorization-authorizers)
31+
+ [Authorizers Examples](#authorizers-examples)
32+
* [Secondary Indexes](#secondary-indexes)
33+
+ [Secondary Index Examples](#secondary-index-examples)
34+
* [Constraints](#constraints)
35+
+ [Constraint Examples](#constraint-examples)
36+
* [Triggers](#triggers)
37+
+ [Trigger Examples](#trigger-examples)
38+
* [GraphQL vs gRPC API](#graphql-vs-grpc-api)
39+
* [Streaming/PubSub](#streaming-pubsub)
40+
* [Graphik Playground](#graphik-playground)
41+
* [Additional Details](#additional-details)
42+
- [Sample GraphQL Queries](#sample-graphql-queries)
43+
* [Get Currently Logged In User(me)](#get-currently-logged-in-user-me-)
44+
* [Get the Graph Schema](#get-the-graph-schema)
45+
* [Set a Request Authorizer](#set-a-request-authorizer)
46+
* [Create a Document](#create-a-document)
47+
* [Traverse Documents](#traverse-documents)
48+
* [Traverse Documents Related to Logged In User](#traverse-documents-related-to-logged-in-user)
49+
* [Change Streaming](#change-streaming)
50+
* [Broadcasting a Message](#broadcasting-a-message)
51+
* [Filtered Streaming](#filtered-streaming)
52+
- [Deployment](#deployment)
53+
* [Docker-Compose](#docker-compose)
54+
* [Kubernetes](#kubernetes)
55+
* [Mac/OSX (Homebrew)](#mac-osx--homebrew-)
56+
- [Open ID Connect Providers](#open-id-connect-providers)
57+
* [Google](#google)
58+
* [Microsoft](#microsoft)
59+
* [Okta](#okta)
60+
* [Auth0](#auth0)
61+
- [Glossary](#glossary)
5762

5863
## Problem Statement
5964

@@ -935,12 +940,31 @@ to shutdown:
935940

936941
Coming Soon
937942

938-
## OIDC Metadata Urls
943+
### Mac/OSX (Homebrew)
944+
945+
brew tap graphik/tools git@github.com:graphikDB/graphik-homebrew.git
946+
947+
brew install graphik
948+
949+
brew install graphikctl
950+
951+
## Open ID Connect Providers
952+
953+
### Google
954+
955+
- metadata uri: https://accounts.google.com/.well-known/openid-configuration
956+
957+
### Microsoft
958+
959+
- metadata uri: [See More](https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-protocols-oidc)
960+
961+
### Okta
962+
963+
- metadata uri: https://${yourOktaOrg}/.well-known/openid-configuration [See More](https://developer.okta.com/docs/concepts/auth-servers/)
964+
965+
### Auth0
939966

940-
- Google: https://accounts.google.com/.well-known/openid-configuration
941-
- Microsoft: [See More](https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-protocols-oidc)
942-
- Auth0: https://${YOUR_DOMAIN}/.well-known/openid-configuration [See More](https://auth0.com/docs/protocols/configure-applications-with-oidc-discovery)
943-
- Okta: https://${yourOktaOrg}/.well-known/openid-configuration [See More](https://developer.okta.com/docs/concepts/auth-servers/)
967+
- metadata uri: https://${YOUR_DOMAIN}/.well-known/openid-configuration [See More](https://auth0.com/docs/protocols/configure-applications-with-oidc-discovery)
944968

945969

946970
## Glossary

0 commit comments

Comments
 (0)