Skip to content

keydb overview #237

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 11, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
112 changes: 110 additions & 2 deletions apps/docs/content/keydb/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,112 @@
---
title: KeyDB overview
description: Learn about working with KeyDB with ease on Zerops.
---
description: Learn about working with KeyDB on Zerops.
---

import DocCardList from '@theme/DocCardList';
import Icons from '@theme/Icon';
import LargeCardList from '@site/src/components/LargeCardList';
import LargeCard from '@site/src/components/LargeCard';

[KeyDB ↗](https://docs.keydb.dev/) is a fully open source database, a faster drop-in alternative to Redis. It offers enhanced performance, multithreading capabilities, and maintains full compatibility with Redis clients and APIs.

:::important
While KeyDB is available on Zerops, please note that KeyDB development has not been very active recently. For new Redis-compatible deployments, we recommend considering [Valkey](/valkey/overview) as the preferred alternative due to its active development and ongoing support.
:::

## Feature Highlights

<DocCardList
colSize={4}
items={[
{
type: 'link',
href: '/keydb/how-to/create',
label: 'Create KeyDB service',
customProps: {
icon: Icons['computer-desktop'],
description:
'Start with creating a KeyDB service using GUI or zCLI.',
},
},
{
type: 'link',
href: '/keydb/how-to/create#highly-available',
label: 'HA mode',
customProps: {
icon: Icons['squares-plus'],
description: 'Learn how to setup your database to be production-ready with high availability.',
},
},
{
type: 'link',
href: '/keydb/how-to/create#full-example',
label: 'Import config file',
customProps: {
icon: Icons['puzzle'],
description: 'Use an example config file to import your KeyDB service.',
},
},
]}
/>

### Connect to KeyDB service

<DocCardList
colSize={4}
items={[
{
type: 'link',
href: '/keydb/how-to/manage',
label: 'Manage KeyDB database',
customProps: {
icon: Icons['circle-stack'],
},
},
{
type: 'link',
href: '/keydb/how-to/connect#connect-to-keydb-from-runtime-services-of-the-same-project',
label: 'Connect from the same project',
customProps: {
icon: Icons['link'],
},
},
{
type: 'link',
href: '/keydb/how-to/connect#connect-to-keydb-in-zerops-remotely',
label: 'Connect remotely',
customProps: {
icon: Icons['globe-europe'],
},
},
]}
/>

## Popular Guides

<DocCardList
colSize={6}
items={[
{
type: 'link',
href: '/references/cli',
label: 'zCLI',
customProps: {
icon: Icons['command-line'],
description:
'Get even more out of Zerops with the zCLI command line tool.',
},
},
{
type: 'link',
href: '/references/vpn',
label: 'Zerops VPN',
customProps: {
icon: Icons['globe-europe'],
description: 'Connect to your KeyDB service securely with Zerops VPN.',
},
},
]}
/>

*Need help? Join our [Discord community](https://discord.gg/zeropsio).*
195 changes: 185 additions & 10 deletions apps/docs/static/llms-full.txt
Original file line number Diff line number Diff line change
Expand Up @@ -26377,10 +26377,189 @@ Zerops doesn't scale KeyDB service horizontally, it means no containers are adde
Zerops provides information about how much hardware resources the KeyDB service is currently using. Go to KeyDB service detail in Zerops GUI and select **Service dashboard & database containers** in the left menu. Zerops also provides the history of resource usage.


---
title: KeyDB overview
description: Learn about working with KeyDB with ease on Zerops.
---


[KeyDB ↗](https://docs.keydb.dev/) is a fully open source database, a faster drop-in alternative to Redis. It offers enhanced performance, multithreading capabilities, and maintains full compatibility with Redis clients and APIs.

:::important
While KeyDB is available on Zerops, please note that KeyDB development has not been very active recently. For new Redis-compatible deployments, we recommend considering [Valkey](https://valkey.io/) as the preferred alternative due to its active development and ongoing support.
:::

## Feature Highlights

<DocCardList
colSize={4}
items={[
{
type: 'link',
href: '/keydb/how-to/create',
label: 'Create KeyDB service',
customProps: {
icon: Icons['computer-desktop'],
description:
'Start with creating a KeyDB service using GUI or zCLI.',
},
},
{
type: 'link',
href: '/keydb/how-to/create#highly-available',
label: 'HA mode',
customProps: {
icon: Icons['squares-plus'],
description: 'Learn how to setup your database to be production-ready with high availability.',
},
},
{
type: 'link',
href: '/keydb/how-to/create#full-example',
label: 'Import config file',
customProps: {
icon: Icons['puzzle'],
description: 'Use an example config file to import your KeyDB service.',
},
},
]}
/>

### Connect to KeyDB service

<DocCardList
colSize={4}
items={[
{
type: 'link',
href: '/keydb/how-to/manage',
label: 'Manage KeyDB database',
customProps: {
icon: Icons['circle-stack'],
},
},
{
type: 'link',
href: '/keydb/how-to/connect#connect-to-keydb-from-runtime-services-of-the-same-project',
label: 'Connect from the same project',
customProps: {
icon: Icons['link'],
},
},
{
type: 'link',
href: '/keydb/how-to/connect#connect-to-keydb-in-zerops-remotely',
label: 'Connect remotely',
customProps: {
icon: Icons['globe-europe'],
},
},
]}
/>

### Service Management

<DocCardList
colSize={6}
items={[
{
type: 'link',
href: '/keydb/how-to/scale',
label: 'Scale KeyDB service',
customProps: {
icon: Icons['adjustments'],
},
},
{
type: 'link',
href: '/keydb/how-to/stop-start',
label: 'Stop and start service',
customProps: {
icon: Icons['pause'],
},
},
]}
/>

### Additional Operations

<DocCardList
colSize={6}
items={[
{
type: 'link',
href: '/keydb/how-to/delete',
label: 'Delete KeyDB service',
customProps: {
icon: Icons['trash'],
},
},
{
type: 'link',
href: '/keydb/how-to/use-environment-variables',
label: 'Use environment variables',
customProps: {
icon: Icons['variable'],
},
},
]}
/>

## When in doubt, reach out

Don't know how to start or got stuck during the process? You might not be the first one, visit the FAQ section to find out.

In case you haven't found an answer (and also if you have), we and our community are looking forward to hearing from you on Discord.

Have you built something that others might find useful? Don't hesitate to share your knowledge!

<DocCardList
colSize={6}
items={[
{
type: 'link',
href: '/keydb/faq',
label: 'FAQ',
customProps: {
icon: Icons['chat-bubble-left-right'],
description: 'Most common questions in one place.',
},
},
{
type: 'link',
href: 'https://discord.com/invite/WDvCZ54',
label: 'Discord',
customProps: {
icon: Icons['discord'],
description:
'Join our core team and Zerops community on Discord. Ask questions and share your tips with other members.',
},
},
]}
/>

## Popular Guides

<DocCardList
colSize={6}
items={[
{
type: 'link',
href: '/references/cli',
label: 'zCLI',
customProps: {
icon: Icons['command-line'],
description:
'Get even more out of Zerops with the zCLI command line tool.',
},
},
{
type: 'link',
href: '/references/vpn',
label: 'Zerops VPN',
customProps: {
icon: Icons['globe-europe'],
description: 'Connect to your KeyDB service securely with Zerops VPN.',
},
},
]}
/>



Expand Down Expand Up @@ -37607,8 +37786,8 @@ You can securely connect to PostgreSQL from your local workstation via Zerops VP
4. When finished, [stop the Zerops VPN](/references/vpn#stop-vpn)

:::warning Important notes
* If your connection over VPN doesn't work, try adding `.zerops` suffix to the service hostname (e.g., `database1.zerops`). For additional help, check the [VPN troubleshooting page](/references/vpn/troubleshooting).
* Do not use SSL/TLS protocols when connecting over VPN. Security is provided by the VPN tunnel.
* If your connection over VPN doesn't work, try adding `.zerops` suffix to the service hostname (e.g., `database1.zerops`). For additional help, check the [VPN troubleshooting page](/references/vpn/troubleshooting).
:::

For database management tools and how to manage users and databases, see [Manage PostgreSQL Users and Databases](/postgresql/how-to/manage).
Expand Down Expand Up @@ -45547,10 +45726,6 @@ Upon connection, you'll have secure access to your project's private network wit
- The VPN daemon maintains connection stability with automatic reconnection
- Environment variables are not available through VPN connections

:::caution Known issue
If your connection over VPN doesn't work, try adding `.zerops` suffix to the service hostname (e.g., `database1.zerops`). For additional help, check the [VPN troubleshooting page](/references/vpn/troubleshooting).
:::

### Stop VPN

To stop the VPN session:
Expand Down Expand Up @@ -45602,7 +45777,7 @@ zcli vpn up
could not translate host name "hostname" to address: nodename nor servname provided, or not known
```

* The issue is known to happen on macOS and rarely on Windows
* The issue is known to happen rarely on Windows

**Solution**: Append `.zerops` to the hostname, even when VPN shows as connected:
```bash
Expand Down
Loading