Skip to content

Commit

Permalink
doc updates from feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
mble-sfdc committed May 17, 2024
1 parent 0dcb1d7 commit ef86f4d
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 14 deletions.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,12 @@ This is a [Heroku buildpack](http://devcenter.heroku.com/articles/buildpacks) th
allows an application to use an [stunnel](http://stunnel.org) to connect securely to
Heroku Redis. It is meant to be used in conjunction with other buildpacks.

> [!WARNING]
> This buildpack is not compatible with `heroku-24` and is not needed for Redis6+
**This buildpack is only for use with Heroku Redis 4 and 5. For Heroku Redis 6 and newer, use its built-in TLS support instead.**

**For more information, see [Securing Heroku Redis](https://devcenter.heroku.com/articles/securing-heroku-redis).**
**For more information, see [Securing Heroku Redis](https://devcenter.heroku.com/articles/heroku-redis#security-and-compliance).**

## Usage

Expand Down
11 changes: 6 additions & 5 deletions bin/compile
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,12 @@ unset GIT_DIR
BUILD_DIR=$1
BUILDPACK_DIR="$(dirname $(dirname $0))"

STUNNEL=$(command -v stunnel4)

if [ -z $STUNNEL ]; then
echo "------> stunnel not detected! stunnel not supported on heroku-24+"
echo "------> this buildpack is not required for Redis 6+: https://devcenter.heroku.com/articles/heroku-redis#security-and-compliance"
if ! command -v stunnel4 > /dev/null; then
echo "! stunnel not detected! stunnel not supported on heroku-24+"
echo "! This buildpack is not required for Redis 6+. Remove this buildpack using:"
echo "! $ heroku buildpacks:remove heroku/redis"
echo "! And then follow the instructions for using Redis' native TLS support:"
echo "! https://devcenter.heroku.com/articles/heroku-redis#security-and-compliance"
exit 1
fi

Expand Down
8 changes: 0 additions & 8 deletions bin/start-stunnel
Original file line number Diff line number Diff line change
@@ -1,14 +1,6 @@
#!/usr/bin/env bash

main() {
STUNNEL=$(command -v stunnel4)

if [ -z $STUNNEL ]; then
echo "buildpack=stunnel at=error stunnel not detected! stunnel not supported on heroku-24+"
echo "buildpack=stunnel at=error this buildpack is not required for Redis 6+: https://devcenter.heroku.com/articles/heroku-redis#security-and-compliance"
exit 1
fi

if ! is-enabled "${STUNNEL_ENABLED:-1}"; then
at stunnel-disabled
exec "$@"
Expand Down

0 comments on commit ef86f4d

Please sign in to comment.