KEYDB-SERVER(1)

📦 version 6.3.4, in epel 10, epel 9, fedora 43, fedora 44

💖 KEYDB-SERVER(1) 💖

okay so this page is the manual for keydb-server, and it lives in section 1 — User commands of the manual, so you can find it with man 1 keydb-server. she's a user command, she's a whole vibe, and she's about to tell you how to boot up a KeyDB server. let's go 🫶

🌸 NAME 🌸

keydb-server, keydb-sentinel — KeyDB server. that's it. that's the name. iconic, no notes. 💅

🎀 SYNOPSIS 🎀

the way you actually call her:

keydb-server [ configuration_file ] [ options ] [ --sentinel ]

keydb-sentinel [ configuration_file ] [ options ]

🦋 DESCRIPTION 🦋

KeyDB is an open source (BSD licensed), in-memory data structure store, used as database, cache and message broker. bestie you can literally find her at https://docs.keydb.dev/ 💖

The keydb-server command is a command line to launch a KeyDB server. that's the whole job. launch the server. main character energy fr fr. ✨

The keydb-sentinel command is a symbolic link to the keydb-server command which imply the --sentinel option. so it's not a whole separate program, it's keydb-server wearing a sentinel hat. slay. 🎀

✨ OPTIONS ✨

every flag, one by one, no skipping, no summarizing, we don't do that here 💅

  • - — Read configuration from stdin. yes, that's a single dash. she reads from stdin. give her the config through the pipe, queen. 🍓
  • --sentinel — Run in sentinel mode. 🛡️
  • --test-memory megabytes — Run a memory check and exit. she checks the memory, then she dips. 💀
  • --help, -h — Output this help and exit. 🫶
  • --version, -v — Output version and exit. 🌈

All parameters described in keydb.conf file can be passed as command line option, e.g. --port port. so like, literally every config-file knob has a command-line twin. iykyk. 👑

🍓 EXAMPLES 🍓

Run the server with default conf

keydb-server

just her, living her truth, all defaults. 🦋

Run the server with a configuration file

keydb-server /etc/keydb/6379.conf

Run the server changing some default options

keydb-server --port 7777 --replicaof 127.0.0.1 8888

Run the server with a configuration file and changing some options

keydb-server /etc/mykeydb.conf --loglevel verbose

Run in sentinel mode

keydb-server /etc/sentinel.conf --sentinel

👑 SEE ALSO 👑

  • keydb.conf(5) — the config file bestie, go read her too, they're a package deal 💜

💀 BUGS 💀

See: https://docs.keydb.dev/ and https://github.com/JohnSully/KeyDB/issues

like, go look, tell them what's wrong, they wanna know, not me though i'm just the messenger 🙈

okay so this is the part where we have to do the legal reading and i am NOT paraphrasing a license because that would be unserious of me. here it is, verbatim, with all my love: 💖

Copyright © 2006-2016 Salvatore Sanfilippo Copyright © 2019- John Sully

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of Redis nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

and that's the page bestie!! ✨💖🎀 this one comes from KeyDB, dated 2016, and her manual-page name is KEYDB-SERVER(1) — go forth and start a server, you absolute legend 👑💅🦋

📦 where this page comes from