Skip to content

Commit 6475fa1

Browse files
committed
feat: improve getting-started guide and add mcp hint
1 parent c39be4f commit 6475fa1

File tree

4 files changed

+31
-32
lines changed

4 files changed

+31
-32
lines changed

img/getting_started/charts.png

-149 KB
Loading
12.7 KB
Loading

img/getting_started/database.png

81.6 KB
Loading

redis/overall/getstarted.mdx

Lines changed: 31 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,50 @@
11
---
22
title: Getting Started
3-
description: Create a Redis compatible database in seconds
3+
description: Create an Upstash Redis database in seconds
44
---
55

6-
<Check >
7-
**Prerequisite**
6+
Upstash Redis is a **highly available, infinitely scalable** Redis-compatible database:
87

9-
You need an account before creating a database, create one
10-
[here](https://console.upstash.com).
8+
- 99.99% uptime guarantee with auto-scaling
9+
- Ultra-low latency worldwide
10+
- Multi-region replication
11+
- Durable, persistent storage without sacrificing performance
12+
- Automatic backups
13+
- Optional SOC-2 compliance, encryption at rest and much more
1114

12-
</Check>
15+
---
1316

14-
## Create a Database
17+
## 1. Create an Upstash Redis Database
1518

16-
Once you logged in, you can create a database by clicking on the plus sign at
17-
the top right corner.
19+
Once you're logged in, create a database by clicking `+ Create Database` in the upper right corner. A dialog opens up:
1820

1921
<Frame>
2022
<img src="/img/getting_started/create-global.png" />
2123
</Frame>
2224

23-
**Database Name:** Type a name for your database.
25+
**Database Name:** Enter a name for your database.
2426

25-
**Primary Region and Read Regions:** Choose the regions for your database. For optimal performance, select the Primary region closest to where most of your writes will happen. Select Read Region(s) where most of your reads will happen. We have plans to expand support to additional regions and cloud providers. Feel free to send your requests to [[email protected]](mailto:[email protected]) to help us prioritize.
27+
**Primary Region and Read Regions:** For optimal performance, select the Primary Region closest to where most of your writes will occur. Select the read region(s) where most of your reads will occur.
2628

27-
Once you click on Create button, you should see your database up and running as
28-
below:
29+
Once you click `Next` and select a plan, your database is running and ready to connect:
2930

3031
<Frame>
31-
<img src="/img/getting_started/global-db-welcome.png" width="100%" />
32+
<img src="/img/getting_started/database.png" width="100%" />
3233
</Frame>
3334

34-
## Connect to Your Database
35+
---
3536

36-
You can connect to your database with any Redis client. For simplicity, we will
37-
use `redis-cli` tool in this guide but please refer to
38-
[Connect Your Client](../howto/connectclient) section for more about connecting
39-
via Redis clients.
37+
## 2. Connect to Your Database
4038

41-
`redis-cli` comes packaged with the official Redis distribution. If you do not
42-
have Redis installed, you can get it as described at
39+
You can connect to Upstash Redis with any Redis client. For simplicity, we'll use `redis-cli`. See the [Connect Your Client](../howto/connectclient) section for connecting via our TypeScript or Python SDKs and other clients.
4340

44-
<a href="https://redis.io/topics/quickstart" target="_blank">
45-
{" "}
46-
Redis Quick Start
47-
</a>
48-
document. Now, you can connect to and run commands on your database as below:
41+
The Redis CLI is included in the official Redis distribution. If you don't
42+
have Redis installed, you can get it [here](https://redis.io/docs/latest/operate/oss_and_stack/install/install-redis/).
4943

50-
```
44+
Connect to your database and execute commands on it:
45+
46+
```bash
5147
> redis-cli --tls -a PASSWORD -h ENDPOINT -p PORT
52-
Warning: Using a password with '-a' or '-u' option on the command line interface may not be safe.
5348
ENDPOINT:PORT> set counter 0
5449
OK
5550
ENDPOINT:PORT> get counter
@@ -60,12 +55,16 @@ ENDPOINT:PORT> incr counter
6055
(int) 2
6156
```
6257

63-
Now you will start to see some action on the charts. Please go to
64-
[Metrics and Charts](../howto/metricsandcharts) section for detailed information
65-
about metrics and charts. Note that charts are updated every 10 seconds.
58+
As you run commands, you'll see updates to your database metrics in (almost) real-time. These database metrics are refreshed every 10 seconds.
6659

6760
<Frame>
6861
<img src="/img/getting_started/charts.png" width="100%" />
6962
</Frame>
7063

71-
Congratulations! You have created your first database with Upstash.
64+
Congratulations! You have created an ultra-fast Upstash Redis database! 🎉
65+
66+
<Check>
67+
**New: Manage Upstash Redis From Cursor (optional)**
68+
69+
Manage Upstash Redis databases from Cursor and other AI tools by using our [MCP server](https://upstash.com/docs/redis/integrations/mcp).
70+
</Check>

0 commit comments

Comments
 (0)