Skip to content

follow-on to explain redis in the LOCAL_DEVELOPMENT_SETUP documentation #3615

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

follow-on to explain redis in the LOCAL_DEVELOPMENT_SETUP documentation #3615

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
60f8abe
follow-on to explain redis in the LOCAL_DEVELOPMENT_SETUP documentation
heckj Jan 17, 2025
36c8016
Merge branch 'main' into localdev-redis
daveverwer Jan 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions LOCAL_DEVELOPMENT_SETUP.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,18 @@ Note that this will launch several services defined in `app.yml`, including the
env VERSION=... docker-compose -f app.yml up -d server
```

The site uses Redis as a local reference cache for some of the documentation resolution(`getDocRoute`).
In the code, it's handled as an in-memory cache when running in DEBUG mode.
Redis is not required to run the site locally - it's an optimization for the production setup.

You can run an instance of redis in docker locally, should you want to leverage or work on that section:

```
make redis-up-dev
```

Use `make redis-down-dev` to cleanly disable the local redis instance.

## Running in a Linux container

Sometimes you need to run tests or even the server on the target platform, Linux. The best way to do that is to build and run in a Linux container.
Expand Down Expand Up @@ -297,3 +309,5 @@ psql 'postgres://[email protected]:5432/spi_test' -c 'select count(*
# check connection for spi_dev database:
psql 'postgres://[email protected]:6432/spi_dev' -c 'select count(*) from packages;'
```

##