From c7847d2e8f3638489e3a55e22005fd59d17f8d16 Mon Sep 17 00:00:00 2001 From: Remzi Arpaci-Dusseau Date: Tue, 6 Sep 2022 11:36:54 -0500 Subject: [PATCH] initial README --- initial-memcached/README.md | 53 +++++++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 initial-memcached/README.md diff --git a/initial-memcached/README.md b/initial-memcached/README.md new file mode 100644 index 0000000..8fe067b --- /dev/null +++ b/initial-memcached/README.md @@ -0,0 +1,53 @@ +# Memcached + +Memcached is a high performance multithreaded event-based key/value cache +store intended to be used in a distributed system. + +See: https://memcached.org/about + +A fun story explaining usage: https://memcached.org/tutorial + +If you're having trouble, try the wiki: https://memcached.org/wiki + +If you're trying to troubleshoot odd behavior or timeouts, see: +https://memcached.org/timeouts + +https://memcached.org/ is a good resource in general. Please use the mailing +list to ask questions, github issues aren't seen by everyone! + +## Dependencies + +* libevent - https://www.monkey.org/~provos/libevent/ (libevent-dev) +* libseccomp (optional, experimental, linux) - enables process restrictions for + better security. Tested only on x86-64 architectures. +* openssl (optional) - enables TLS support. need relatively up to date + version. pkg-config is needed to find openssl dependencies (such as -lz). + +## Environment + +Be warned that the -k (mlockall) option to memcached might be +dangerous when using a large cache. Just make sure the memcached machines +don't swap. memcached does non-blocking network I/O, but not disk. (it +should never go to disk, or you've lost the whole point of it) + +## Build status + +See https://build.memcached.org/ for multi-platform regression testing status. + +## Bug reports + +Feel free to use the issue tracker on github. + +**If you are reporting a security bug** please contact a maintainer privately. +We follow responsible disclosure: we handle reports privately, prepare a +patch, allow notifications to vendor lists. Then we push a fix release and your +bug can be posted publicly with credit in our release notes and commit +history. + +## Website + +* https://www.memcached.org + +## Contributing + +See https://github.com/memcached/memcached/wiki/DevelopmentRepos