You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: get-started/install/install-as-docker-container.md
+42-8Lines changed: 42 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,16 +8,18 @@ description: >-
8
8
9
9
### Requirements
10
10
11
+
The container script is distributed via GitHub, so you will need Git to clone and update the TerminusDB bootstrap repo. You will also need Docker running.
12
+
11
13
A list of prerequisite components depending on your operating system. Click on the required component to download it from the provider's website.
12
14
13
15
#### Table: Installation requirements
14
16
15
-
| Component | Version | Required to: | Linux | macOS | Windows |
|[Git](https://git-scm.com/downloads)|`Latest`| Clone the TerminusDB bootstrap and run the container script. | ✔ | ✔ | ✔ |
20
+
|[Git Bash](https://git-scm.com/downloads)|`Latest`|Windows users should use the application "Git Bash" for all terminal commands described below, this application comes with Git for Windows. ||| ✔ |
|[Docker](https://www.docker.com/products/docker-desktop)|`Latest`| Use the TerminusDB docker container. | ✔ | ✔ | ✔ |
21
23
22
24
{% hint style="info" %}
23
25
**Docker memory allocation on Windows**\
@@ -26,7 +28,7 @@ On Windows, the default memory allocated for the Docker is **2GB**. TerminusDB i
26
28
27
29
{% hint style="info" %}
28
30
**Linux package manager**\
29
-
On Linux, use your distro's package manager for containerized deployments. Click on the Package manager link in the requirements table above for more information.
31
+
On Linux, use your distro's package manager for containerized deployments or find more information here: [https://www.docker.com/products/container-runtime](https://www.docker.com/products/container-runtime) 
30
32
{% endhint %}
31
33
32
34
## Install steps
@@ -51,7 +53,7 @@ cd terminusdb-bootstrap
51
53
52
54
### Run the container
53
55
54
-
Run the container using script `terminusdb-container`.
56
+
Run the container using `terminusdb-container` script.
55
57
56
58
#### Running for the first time
57
59
@@ -126,6 +128,38 @@ The TerminusDB local dashboard is included within terminusdb-bootstrap. The dash
126
128
localhost:6363/dashboard/
127
129
```
128
130
131
+
### Use GraphQL
132
+
133
+
TerminusDB hosts a GraphQL endpoint at:
134
+
135
+
```
136
+
SERVERNAME/api/graphql/ORG/DATAPRODUCT
137
+
```
138
+
139
+
For instance, with a data product named `admin/people`, and a locally installed TerminusDB, you can query it at:
140
+
141
+
```
142
+
http://127.0.0.1:6363/api/graphql/admin/people
143
+
```
144
+
145
+
TerminusDB ships with a GraphiQL graphical GraphQL query interface and schema browser. This is a quick way to get acquainted with GraphQL in TerminusDB.
146
+
147
+
You can reach this browser at:
148
+
149
+
```
150
+
http://127.0.0.1:6363/api/graphiql/admin/people
151
+
```
152
+
153
+
You will need to set your Authorization header in the Header dialog box at the bottom center.
154
+
155
+
For instance, in the default install, as:
156
+
157
+
```json
158
+
{
159
+
"Authorization": "Basic YWRtaW46cm9vdA=="
160
+
}
161
+
```
162
+
129
163
## Environment configuration
130
164
131
165
The container script uses a set of environment variables with default values. You can configure the environment by setting these variables.
Copy file name to clipboardExpand all lines: get-started/tutorials.md
+6-1Lines changed: 6 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,8 +5,13 @@ description: Quick links to tutorials to help you learn
5
5
# Tutorials
6
6
7
7
{% tabs %}
8
-
{% tab title="Getting Started" %}
8
+
{% tab title="GraphQL" %}
9
+
*****[**Build a Blog-Focused CMS using TerminusDB and GraphQL**](https://github.com/terminusdb/terminusdb-tutorials/blob/master/terminusBlog)****
10
+
*****[**Import RDF into TerminusDB and query the data using GraphQL**](https://github.com/terminusdb/terminusdb-tutorials/blob/master/star-wars)****
11
+
{% endtab %}
9
12
13
+
{% tab title="Getting Started" %}
14
+
****
10
15
11
16
*****[**Getting Started with the JavaScript client - 5-part tutorial**](https://github.com/terminusdb/terminusdb-tutorials/tree/master/getting\_started/javascript-client)****
12
17
*[Lesson 1 - Install, start project, and create an empty database with schema](https://github.com/terminusdb/terminusdb-tutorials/blob/master/getting\_started/javascript-client/lesson\_1.md)
Copy file name to clipboardExpand all lines: guides/how-to-guides/administer-the-database.md
+6-5Lines changed: 6 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,10 +6,11 @@ description: The basics for administering your database
6
6
7
7
There are several ways to work with TerminusDB. This section aims to point you in the right direction to enable you to get started with ease.Follow the links below to take you to the area of interest:
Where `ORG` is your organization, and `DATA_PRODUCT` is the name of your
23
-
data product.
21
+
Where `ORG` is your organization, and `DATA_PRODUCT` is the name of your data product.
24
22
25
23
## Authentication
26
24
27
-
Since TerminusDB requires authenatication to access data products, you
28
-
will need to use the authentication method that has been configured
29
-
for your server.
25
+
Since TerminusDB requires authentication to access data products, you will need to use the authentication method that has been configured for your server.
30
26
31
27
### Basic Auth
32
28
33
-
Using Basic Auth, the method which is default in locally installed
34
-
TerminusDB's, you can supply the Authorization header, with your basic
35
-
auth. (To generate a Basic Auth string, see [Basic Auth Generator](https://www.blitter.se/utils/basic-authentication-header-generator/)).
29
+
Using Basic Auth, the default method in locally installed TerminusDBs, you can supply the Authorization header, with your basic auth. (To generate a Basic Auth string, see [Basic Auth Generator](https://www.blitter.se/utils/basic-authentication-header-generator/)).
36
30
37
-
For example, if you would like to connect to `admin/people` with the
38
-
apollo client to download the associated GraphQL schema, simply use:
31
+
For example, if you would like to connect to `admin/people` with the apollo client to download the associated GraphQL schema, simply use:
39
32
40
33
```shell
41
34
npx apollo client:download-schema --endpoint=http://127.0.0.1:6363/api/graphql/admin/people schema.graphql --header='Authorization: Basic YWRtaW46cm9vdA=='
@@ -45,30 +38,27 @@ npx apollo client:download-schema --endpoint=http://127.0.0.1:6363/api/graphql/a
45
38
46
39
In TerminusX you can use an API key with the following header.
47
40
48
-
For instance, with the apollo client, you can download your schema as
49
-
follows:
41
+
For instance, with the apollo client, you can download your schema as follows:
50
42
51
43
```shell
52
44
npx apollo client:download-schema --endpoint=https://cloud.terminusdb.com/TEAM/api/graphql/TEAM/people schema.graphql --header="Authorization: Token $(cat ~/my_token_file)"
53
45
```
46
+
54
47
Where `my_token_file` contains an API token for TerminusX.
TerminusDB ships with a GraphiQL graphical GraphQL query interface and
61
-
schema browser. This is a quick way to get aquainted with GraphQL in
62
-
TerminusDB.
53
+
TerminusDB ships with a GraphiQL graphical GraphQL query interface and schema browser. This is a quick way to get acquainted with GraphQL in TerminusDB.
63
54
64
55
You can reach this browser at:
65
56
66
57
```
67
58
http://127.0.0.1:6363/api/graphiql/admin/people
68
59
```
69
60
70
-
You will also need to set your Authorization header in the Header
71
-
dialog box at the bottom centre.
61
+
You will also need to set your Authorization header in the Header dialog box at the bottom center.
0 commit comments