From f372c69ef4ee4d7a2c0111b5108a8f9496f208ca Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20S=C3=A1nchez-Gallego?= Date: Mon, 9 Dec 2024 12:15:19 -0800 Subject: [PATCH] Add instructions for local development using memcached --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 3860f3e..2fa349a 100644 --- a/README.md +++ b/README.md @@ -49,6 +49,8 @@ uvicorn valis.wsgi:app --reload ``` This will start a local web server at `http://localhost:8000/valis/`. The API documentation will be located at `http://localhost:8000/valis/docs`. Or to see the alternate documentation, go to `http://localhost:8000/valis/redoc/` +By default, the app will try to cache some route responses to a Redis database in localhost. If you don't have a Redis instance running you can use `memcached` for testing. To do so, edit `~/.config/sdss/valis.yaml` and add `cache_backend: memcached`. + ### Database Connection Valis uses the `sdssdb` package for all connections to databases. The most relevant database for the API is the `sdss5db` on `pipelines.sdss.org`. The easiest way to connect is through a local SSH tunnel. To set up a tunnel,