-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Reshaping: Rework "Getting Started" section
- Compress the previous pages "introduction", "create-user", and "connect" into a single page "getting-started". - Divert ORM and dataframe content into dedicated pages within the "Integrations" section. - Divert "create-user" page into "Administration" section.
- Loading branch information
Showing
12 changed files
with
191 additions
and
228 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
(create-user)= | ||
# Create User | ||
|
||
This part of the documentation sheds some light on the topics of | ||
[](inv:crate-reference#administration_user_management) and | ||
[](inv:crate-reference#administration-privileges). | ||
|
||
|
||
## Superuser Account | ||
|
||
CrateDB ships with a superuser account called "`crate`", which has the | ||
privileges to perform any action. | ||
|
||
However, with the default configuration, this superuser can only access | ||
CrateDB from the local machine CrateDB has been installed on. If you are | ||
trying to connect from another machine, you are prompted to enter a | ||
username and password. | ||
|
||
|
||
## `CREATE USER` command | ||
|
||
In order to create a user that can be used to authenticate from a remote | ||
machine, first | ||
[install crash](inv:crate-crash:*:label#getting-started) or other | ||
[](inv:crate-clients-tools:*:label#index) on the same machine you installed | ||
CrateDB on. Then, connect to CrateDB running on `localhost`. | ||
|
||
While you can also perform the steps outlined below within | ||
[](inv:crate-admin-ui:*:label#index) itself, the | ||
walkthrough will outline how to do it using the | ||
[](inv:crate-crash:*:label#index) on the command line. | ||
|
||
Invoke Crash within the terminal of your choice. | ||
|
||
```console | ||
sh$ crash | ||
``` | ||
|
||
Add your first user with a secure password to the database: | ||
|
||
```sql | ||
cr> CREATE USER username WITH (password = 'a_secret_password'); | ||
``` | ||
|
||
Grant all privileges to the newly created user: | ||
|
||
```sql | ||
cr> GRANT ALL PRIVILEGES TO username; | ||
``` | ||
|
||
![image](/_assets/img/getting-started/create-user.png){width=640px} | ||
|
||
Now try navigating to the [](inv:crate-admin-ui:*:label#index) in your | ||
browser. In the URL below, please replace `cratedb.example.org` with | ||
the host name or IP address of the machine CrateDB is running on, and | ||
sign in with your newly created user account. | ||
|
||
http://cratedb.example.org:4200/ | ||
|
||
After creating the user and granting all privileges, you should be able | ||
to continue with [the guided tour](#use), connecting to CrateDB from a | ||
remote machine. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
(use)= | ||
(getting-started)= | ||
|
||
# Getting Started | ||
|
||
|
||
{#introduction} | ||
## Introduction | ||
|
||
Once CrateDB is [installed and running](#install), you can start to interact | ||
with the database for the first time. | ||
|
||
|
||
{#use-admin-ui} | ||
### The Admin UI | ||
|
||
CrateDB ships with a browser-based administration interface called | ||
[Admin UI](inv:crate-admin-ui:*:label#index). | ||
It is enabled on each CrateDB node, you can use it to inspect and | ||
interact with the whole CrateDB cluster in a number of ways. | ||
|
||
If CrateDB is running on your workstation, access the Admin UI using | ||
`http://localhost:4200/`. Otherwise, replace `localhost` with the | ||
hostname CrateDB is running on. | ||
|
||
When using CrateDB Cloud, the URL will look like | ||
`https://testdrive.aks1.westeurope.azure.cratedb.net:4200/`. | ||
|
||
![image](https://cratedb.com/docs/crate/admin-ui/en/latest/_images/console-query.png){width=320px} | ||
![image](/_assets/img/getting-started/first-use/admin-ui.png){width=320px} | ||
|
||
:::{note} | ||
If you are running CrateDB on a remote machine, you will have to create | ||
a dedicated user account for accessing the Admin UI. See [](#create-user). | ||
::: | ||
|
||
|
||
{#use-crash} | ||
### The CrateDB Shell | ||
|
||
The CrateDB Shell, called `crash`, is an interactive command-line interface | ||
(CLI) program for working with CrateDB on your favorite terminal. To learn more | ||
about it, please refer to its documentation at [](inv:crate-crash:*:label#index). | ||
|
||
![image](https://cratedb.com/docs/crate/crash/en/latest/_images/query.png){width=320px} | ||
|
||
|
||
(connect)= | ||
{#use-dive-in} | ||
{#use-start-building} | ||
## Connect | ||
|
||
You have a variety of options to connect to CrateDB, and integrate it with | ||
off-the-shelve, 3rd-party, open-source, and proprietary applications, mostly | ||
using [CrateDB's PostgreSQL interface]. | ||
|
||
To learn more, please refer to the documentation sections about supported | ||
client drivers, libraries, and frameworks, and corresponding tutorials. | ||
|
||
- [Drivers and Integrations] | ||
- [Database Driver Code Examples] | ||
- [Integration Tutorials] | ||
- [More integration tutorials] | ||
|
||
|
||
:::{tip} | ||
To learn more about all the details of CrateDB features, operations, and | ||
its SQL dialect, please also visit the [CrateDB Reference Manual]. | ||
::: | ||
|
||
|
||
|
||
[CrateDB Cloud]: inv:cloud:*:label#index | ||
[CrateDB Reference Manual]: inv:crate-reference:*:label#index | ||
[CrateDB's PostgreSQL interface]: inv:crate-reference:*:label#interface-postgresql | ||
[Database Driver Code Examples]: inv:crate-clients-tools:*:label#connect | ||
[Drivers and Integrations]: inv:crate-clients-tools:*:label#index | ||
[Integration Tutorials]: #integrate | ||
[More integration tutorials]: https://community.crate.io/t/overview-of-cratedb-integration-tutorials/1015 |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.