Skip to content

Commit 56ad2ee

Browse files
rickbergfalkrickbergfalk
authored
Documentation updates (sqlpad#785)
* Add mention of ClickHouse * Add updated screenshot * Add documentation for service tokens
1 parent 4952e7b commit 56ad2ee

8 files changed

Lines changed: 40 additions & 7 deletions

File tree

‎README.md‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
11
# SQLPad
22

3-
[![Build Status](https://travis-ci.org/rickbergfalk/sqlpad.svg?branch=master)](https://travis-ci.org/rickbergfalk/sqlpad)
3+
A web app for writing and running SQL queries and visualizing the results. Supports Postgres, MySQL, SQL Server, ClickHouse, Crate, Vertica, Presto, SAP HANA, Cassandra, Snowflake, Google BigQuery, SQLite, and many more via [ODBC](https://github.com/rickbergfalk/sqlpad/wiki/ODBC).
44

5-
A web app for writing and running SQL queries and visualizing the results. Supports Postgres, MySQL, SQL Server, Crate, Vertica, Presto, SAP HANA, Cassandra, Snowflake, Google BigQuery, SQLite, and many more via [ODBC](https://github.com/rickbergfalk/sqlpad/wiki/ODBC).
6-
7-
![SQLPad Query Editor](https://rickbergfalk.github.io/sqlpad/images/screenshots/v3-beta.png)
5+
![SQLPad Query Editor](https://rickbergfalk.github.io/sqlpad/images/screenshots/v5.1.0.png)
86

97
## Docker Image
108

‎docs/README.md‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# SQLPad
22

3-
A web app for writing and running SQL queries and visualizing the results. Supports Postgres, MySQL, SQL Server, Crate, Vertica, Presto, SAP HANA, Snowflake, BigQuery, SQLite, and many others via ODBC.
3+
A web app for writing and running SQL queries and visualizing the results. Supports Postgres, MySQL, SQL Server, ClickHouse, Crate, Vertica, Presto, SAP HANA, Snowflake, BigQuery, SQLite, and many others via ODBC.
44

5-
![SQLPad](images/screenshots/v3-beta.png)
5+
<img class="screenshot" src="images/screenshots/v5.1.0.png" data-origin="images/screenshots/v5.1.0.png" alt="SQLPad screenshot" >
66

77
## Database Support
88

@@ -22,6 +22,9 @@ A web app for writing and running SQL queries and visualizing the results. Suppo
2222
<div class="db-container">
2323
<img src="images/logo-crate.svg" data-origin="images/logo-crate.svg" alt="Crate" >
2424
</div>
25+
<div class="db-container">
26+
<img src="images/logo-clickhouse.png" data-origin="images/logo-clickhouse.png" alt="ClickHouse" >
27+
</div>
2528
<div class="db-container db-container-bg">
2629
<img src="images/logo-presto.png" data-origin="images/logo-presto.png" alt="Presto" >
2730
</div>

‎docs/authentication.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,3 +145,19 @@ LDAP-based authentication can be enabled and used with local authencation togeth
145145
## Allowed Domains for User Administration
146146

147147
An entire domain can be allowed for username administration by setting enviornment variable `SQLPAD_ALLOWED_DOMAINS`. This may be particularly useful in combination with OAuth.
148+
149+
## Service Token
150+
151+
The REST API may be called using generated service tokens scoped by role and some optional amount of time.
152+
153+
To enable the creation of service tokens, a token secret must be supplied via `SQLPAD_SERVICE_TOKEN_SECRET`.
154+
155+
To generate a service token, log into SQLPad as an `admin` user and click `Service Tokens`. A service token can be scoped to a certain role (admin or editor) and limited to a window of time.
156+
157+
The generated Bearer token may be used by passing it via the Authorization header:
158+
159+
```sh
160+
curl -X GET -H 'Accept: application/json' -H "Authorization: Bearer the.generated.token" http://localhost:3010/sqlpad/api/users
161+
```
162+
163+
For more information on APIs available see [API Overview](/api-overview).

‎docs/configuration.md‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,17 @@ Default role to assign user created when `samlAutoSignUp` is turned on. Accepted
254254

255255
## serviceTokenSecret
256256

257-
Secret to sign the generated Service Tokens
257+
Secret to sign the generated Service Tokens.
258+
259+
To generate a service token, log into SQLPad as an `admin` user and click `Service Tokens`. A service token can be scoped to a certain role (admin or editor) and limited to a window of time.
260+
261+
The generated Bearer token may be used by passing it via the Authorization header:
262+
263+
```sh
264+
curl -X GET -H 'Accept: application/json' -H "Authorization: Bearer the.generated.token" http://localhost:3010/sqlpad/api/users
265+
```
266+
267+
For more information on APIs available see [API Overview](/api-overview).
258268

259269
- Key: `serviceTokenSecret`
260270
- Env: `SQLPAD_SERVICE_TOKEN_SECRET`

‎docs/connections.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ Work is under way to add multi-statement transaction support to drivers that ben
2020

2121
?> As of 3.2.0 connections may be defined via application configuration.
2222

23+
?> JSON & INI config files deprecated as of 5.1.0
24+
2325
### Via Environment Variable & .env File
2426

2527
When defining connections via environment variables, connection field values must be provided using an environment variable with the convention `SQLPAD_CONNECTIONS__<connectionId>__<fieldName>`. Note double underscores between `SQLPAD_CONNECTIONS`, `<connectionId>`, and `<fieldName>`.

‎docs/images/logo-clickhouse.png‎

3.41 KB
Loading

‎docs/images/screenshots/v5.1.0.png‎

1.03 MB
Loading

‎docs/styles/docs.css‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
.screenshot {
2+
box-shadow: 3px 3px 12px rgba(0, 0, 0, 0.4);
3+
}
4+
15
.db-images {
26
display: flex;
37
flex-wrap: wrap;

0 commit comments

Comments
 (0)