diff --git a/README.md b/README.md index c81843c07..9f9d7240f 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,8 @@ # SQLPad -[![Build Status](https://travis-ci.org/rickbergfalk/sqlpad.svg?branch=master)](https://travis-ci.org/rickbergfalk/sqlpad) +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). -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). - -![SQLPad Query Editor](https://rickbergfalk.github.io/sqlpad/images/screenshots/v3-beta.png) +![SQLPad Query Editor](https://rickbergfalk.github.io/sqlpad/images/screenshots/v5.1.0.png) ## Docker Image diff --git a/docs/README.md b/docs/README.md index fc9cb143f..934363e8d 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,8 +1,8 @@ # SQLPad -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. +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. -![SQLPad](images/screenshots/v3-beta.png) +SQLPad screenshot ## Database Support @@ -22,6 +22,9 @@ A web app for writing and running SQL queries and visualizing the results. Suppo
Crate
+
+ ClickHouse +
Presto
diff --git a/docs/authentication.md b/docs/authentication.md index 30a5427e6..a66372e4b 100644 --- a/docs/authentication.md +++ b/docs/authentication.md @@ -145,3 +145,19 @@ LDAP-based authentication can be enabled and used with local authencation togeth ## Allowed Domains for User Administration 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. + +## Service Token + +The REST API may be called using generated service tokens scoped by role and some optional amount of time. + +To enable the creation of service tokens, a token secret must be supplied via `SQLPAD_SERVICE_TOKEN_SECRET`. + +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. + +The generated Bearer token may be used by passing it via the Authorization header: + +```sh +curl -X GET -H 'Accept: application/json' -H "Authorization: Bearer the.generated.token" http://localhost:3010/sqlpad/api/users +``` + +For more information on APIs available see [API Overview](/api-overview). diff --git a/docs/configuration.md b/docs/configuration.md index 2410bd63e..ec4b9837b 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -254,7 +254,17 @@ Default role to assign user created when `samlAutoSignUp` is turned on. Accepted ## serviceTokenSecret -Secret to sign the generated Service Tokens +Secret to sign the generated Service Tokens. + +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. + +The generated Bearer token may be used by passing it via the Authorization header: + +```sh +curl -X GET -H 'Accept: application/json' -H "Authorization: Bearer the.generated.token" http://localhost:3010/sqlpad/api/users +``` + +For more information on APIs available see [API Overview](/api-overview). - Key: `serviceTokenSecret` - Env: `SQLPAD_SERVICE_TOKEN_SECRET` diff --git a/docs/connections.md b/docs/connections.md index 7bc075ba1..4feeab75b 100644 --- a/docs/connections.md +++ b/docs/connections.md @@ -20,6 +20,8 @@ Work is under way to add multi-statement transaction support to drivers that ben ?> As of 3.2.0 connections may be defined via application configuration. +?> JSON & INI config files deprecated as of 5.1.0 + ### Via Environment Variable & .env File When defining connections via environment variables, connection field values must be provided using an environment variable with the convention `SQLPAD_CONNECTIONS____`. Note double underscores between `SQLPAD_CONNECTIONS`, ``, and ``. diff --git a/docs/images/logo-clickhouse.png b/docs/images/logo-clickhouse.png new file mode 100644 index 000000000..4fece48f3 Binary files /dev/null and b/docs/images/logo-clickhouse.png differ diff --git a/docs/images/screenshots/v5.1.0.png b/docs/images/screenshots/v5.1.0.png new file mode 100644 index 000000000..2ef4a202d Binary files /dev/null and b/docs/images/screenshots/v5.1.0.png differ diff --git a/docs/styles/docs.css b/docs/styles/docs.css index 93fbbbe1a..d144e1b4e 100644 --- a/docs/styles/docs.css +++ b/docs/styles/docs.css @@ -1,3 +1,7 @@ +.screenshot { + box-shadow: 3px 3px 12px rgba(0, 0, 0, 0.4); +} + .db-images { display: flex; flex-wrap: wrap;