Skip to content

Commit

Permalink
Add instructions for local development using memcached
Browse files Browse the repository at this point in the history
  • Loading branch information
albireox committed Dec 9, 2024
1 parent cc8a703 commit f372c69
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down

0 comments on commit f372c69

Please sign in to comment.