Docs

Getting started

Four steps to a working cache: sign up, create an instance, find your credentials, connect.

1. Sign up

Create an account at https://app.velstash.io/register. The free plan requires no credit card and no payment information at all.

2. Create a cache instance

From your dashboard, create a new cache instance by picking the region the cache should reside and a plan sized to how much memory you need, from Free (100 MB) up to Business (16 GB).

At this step, you may also give the instance a custom name (for example, to reflect the kind of data it will hold, or where it is deployed), as well as change the default prefix delimiter. The instance name can be anything you want and can be changed later from the instance details page. However, the prefix delimiter serves to aggregate item keys and show per-prefix statistics in your dashboard later on and can't be changed once the instance is created. Note the prefix is only used to compute statistics.

When you create an instance, a default set of credentials is generated and shown once: save the password somewhere safe, since it won't be shown again. However, you may create a new set of credentials later if you need to.

3. Find your connection details and credentials

Your instance's detail page shows the host and port you will need to connect to. The plain host and port may be used for connecting to your instance using a non-encrypted connection, and is normally used when your application runs on the same hosting provider and datacenter as your cache instance.

On the other hand, using TLS makes the connection encrypted and prevents data from traveling in plain form (including the credentials you use for connecting the cache), which is preferred when you connect from outside the region the cache is deployed to or when you want maximum security. However, using encryption may increase the connection latency.

If you need to, you may also add additional sets of credentials to your instance, and restrict the kind of commands a client using them is allowed to perform.

4. Connect

See the language-specific connection guide for your stack in the sidebar:

• Node.js
• Python
• PHP
• Go