Skip to content

Commit

Permalink
Spelling
Browse files Browse the repository at this point in the history
Signed-off-by: Viktor Söderqvist <[email protected]>
  • Loading branch information
zuiderkwast committed Dec 10, 2024
1 parent 6fdbbc2 commit a0256fd
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 4 deletions.
2 changes: 1 addition & 1 deletion topics/admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: Advice for configuring and managing Valkey in production
### Linux

* Deploy Valkey using the Linux operating system.
Valkey is also tested on macOS and FreeBSD, and from time to time on other OpenBSD, NetBSD, DragonFlyBSD and Solaris derivates.
Valkey is also tested on macOS and FreeBSD, and from time to time on other OpenBSD, NetBSD, DragonFlyBSD and Solaris-derived systems.
However, Linux is where most of the stress testing is performed, and where most production deployments are run.

* Set the Linux kernel overcommit memory setting to 1. Add `vm.overcommit_memory = 1` to `/etc/sysctl.conf`. Then, reboot or run the command `sysctl vm.overcommit_memory=1` to activate the setting. See [FAQ: Background saving fails with a fork() error on Linux?](faq.md#background-saving-fails-with-a-fork-error-on-linux) for details.
Expand Down
2 changes: 1 addition & 1 deletion topics/functions-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ This approach suits many light-weight scripting use cases, but introduces severa

1. All client application instances must maintain a copy of all scripts. That means having some mechanism that applies script updates to all of the application's instances.
1. Calling cached scripts within the context of a [transaction](transactions.md) increases the probability of the transaction failing because of a missing script. Being more likely to fail makes using cached scripts as building blocks of workflows less attractive.
1. SHA1 digests are not readalbe for humans, making debugging the system hard (e.g. in a [`MONITOR`](../commands/monitor.md) session).
1. SHA1 digests are not readable for humans, making debugging the system hard (e.g. in a [`MONITOR`](../commands/monitor.md) session).
1. When used naively, `EVAL` promotes an anti-pattern in which the client application renders verbatim scripts instead of responsibly using the [`KEYS` and `ARGV` Lua APIs](lua-api.md#runtime-globals).
1. Because they are ephemeral, a script can't call another script. This makes sharing and reusing code between scripts nearly impossible, short of client-side preprocessing.

Expand Down
2 changes: 1 addition & 1 deletion topics/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ By default Valkey binds to **all the interfaces** and has no authentication at a

1. Make sure the port Valkey uses to listen for connections (by default 6379 and additionally 16379 if you run Valkey in cluster mode, plus 26379 for Sentinel) is firewalled, so that it is not possible to contact Valkey from the outside world.
2. Use a configuration file where the `bind` directive is set in order to guarantee that Valkey listens on only the network interfaces you are using. For example, only the loopback interface (127.0.0.1) if you are accessing Valkey locally from the same computer.
3. Set up authenticaltion using [Access Control List (ACL)](acl.md) or use the `requirepass` option to add an additional layer of security so that clients will be required to authenticate using the `AUTH` command.
3. Set up authentication using [Access Control List (ACL)](acl.md) or use the `requirepass` option to add an additional layer of security so that clients will be required to authenticate using the `AUTH` command.
4. Use [TLS](encryption.md) to encrypt traffic between Valkey servers and Valkey clients if your environment requires encryption.

Make sure you understand the above and apply **at least** a firewall layer. After the firewall is in place, try to connect with `valkey-cli` from an external host to confirm that the instance is not reachable.
Expand Down
2 changes: 1 addition & 1 deletion topics/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Valkey also includes:

You can use Valkey from most programming languages. See [clients](../clients/).

Valkey is written in **ANSI C 11** with Atomics and a few GCC/Clang builtins like `__builtin_clz()`.
Valkey is written in **ANSI C 11** with Atomics and a few GCC/Clang built-ins like `__builtin_clz()`.
It works on most POSIX systems like Linux, \*BSD and MacOS, without external dependencies.
Linux and MacOS are the two operating systems where Valkey is developed and tested the most, and we **recommend using Linux for deployment**.
Valkey may work on Solaris-derived systems like Illumos, but support is *best effort*.
Expand Down
11 changes: 11 additions & 0 deletions wordlist
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
.rdb
ˈrɛd-ɪs
A1
AArch64
acknowledgement
ACKs
acl
Expand All @@ -20,6 +21,7 @@ allkeys-random
allocator
allocator's
allocators
amd64
AMD64
analytics
antirez
Expand All @@ -44,6 +46,7 @@ Async
async
Asyncio
atomicity
Atomics
Atomicvar
Attribution-ShareAlike
Auth
Expand Down Expand Up @@ -196,7 +199,9 @@ Diskless
diskless
DistLock
distlock
distros
dnf
DragonFlyBSD
dup-sentinel
Dynomite
earts
Expand Down Expand Up @@ -344,6 +349,7 @@ Identinal
idletime
idx
idx'-th
Illumos
incr
incrby
incrby_get_mget
Expand Down Expand Up @@ -735,6 +741,7 @@ runlevels
RW
Rx/Tx
S[1-9]
s390x
SaaS
sadd
sadd_smembers
Expand Down Expand Up @@ -782,6 +789,7 @@ Snapcraft
snapd
Snapshotting
snapshotting
Solaris
Solaris-derived
somekey
SomeOtherValue
Expand Down Expand Up @@ -832,6 +840,7 @@ SYNC_RDB_START
syncd
syscall
systemctl
systemd
T1
T2
taskset
Expand Down Expand Up @@ -924,6 +933,8 @@ whos-using-redis
WQE
WQEs
WSL2
x86
x86-64
xack
xadd
xadd_2
Expand Down

0 comments on commit a0256fd

Please sign in to comment.