Skip to content

chore: set password on embedded Redis instance #41634

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

Open
wyattwalter wants to merge 1 commit into
base: release
Choose a base branch
from
+36 −3
Open

chore: set password on embedded Redis instance #41634

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
33 changes: 32 additions & 1 deletion deploy/docker/fs/opt/appsmith/entrypoint.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,8 +102,29 @@ init_env_file() {
tr -dc A-Za-z0-9 </dev/urandom | head -c 13
echo ''
)
local generated_appsmith_redis_password=$(
tr -dc A-Za-z0-9 </dev/urandom | head -c 13
echo ''
)

bash "$TEMPLATES_PATH/docker.env.sh" "$default_appsmith_mongodb_user" "$generated_appsmith_mongodb_password" "$generated_appsmith_encryption_password" "$generated_appsmith_encription_salt" "$generated_appsmith_supervisor_password" > "$ENV_PATH"
bash "$TEMPLATES_PATH/docker.env.sh" "$default_appsmith_mongodb_user" "$generated_appsmith_mongodb_password" "$generated_appsmith_encryption_password" "$generated_appsmith_encription_salt" "$generated_appsmith_supervisor_password" "$generated_appsmith_redis_password" > "$ENV_PATH"
else
tlog "Configuration file already exists"
# Backfill APPSMITH_REDIS_PASSWORD for existing installs that don't have it yet.
# Only inject auth into the Redis URL when it points to the embedded (localhost) Redis.
if ! grep -q "APPSMITH_REDIS_PASSWORD" "$ENV_PATH"; then
local generated_appsmith_redis_password=$(
tr -dc A-Za-z0-9 </dev/urandom | head -c 13
echo ''
)
echo $'\nAPPSMITH_REDIS_PASSWORD='"$generated_appsmith_redis_password" >> "$ENV_PATH"
# Update the Redis URL to include the password, but only for the embedded Redis.
local current_redis_url
current_redis_url=$(grep "^APPSMITH_REDIS_URL=" "$ENV_PATH" | tail -1 | cut -d= -f2-)
if [[ "$current_redis_url" == *"localhost"* || "$current_redis_url" == *"127.0.0.1"* ]]; then
sed -i "s|^APPSMITH_REDIS_URL=.*|APPSMITH_REDIS_URL=redis://:${generated_appsmith_redis_password}@127.0.0.1:6379|" "$ENV_PATH"
fi
Comment on lines +115 to +126
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot Mar 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

Preserve existing localhost Redis URL details during backfill.

Line 125 rewrites to a fixed 127.0.0.1:6379 URL, which can break upgrades where local Redis used a custom port/path/query. Also, Line 115 should treat empty APPSMITH_REDIS_PASSWORD as missing.

Proposed fix 
-    if ! grep -q "APPSMITH_REDIS_PASSWORD" "$ENV_PATH"; then
+    if ! grep -qE '^APPSMITH_REDIS_PASSWORD=.+$' "$ENV_PATH"; then
       local generated_appsmith_redis_password=$(
         tr -dc A-Za-z0-9 </dev/urandom | head -c 13
         echo ''
       )
       echo $'\nAPPSMITH_REDIS_PASSWORD='"$generated_appsmith_redis_password" >> "$ENV_PATH"
       # Update the Redis URL to include the password, but only for the embedded Redis.
       local current_redis_url
+      local redis_target
       current_redis_url=$(grep "^APPSMITH_REDIS_URL=" "$ENV_PATH" | tail -1 | cut -d= -f2-)
       if [[ "$current_redis_url" == *"localhost"* || "$current_redis_url" == *"127.0.0.1"* ]]; then
-        sed -i "s|^APPSMITH_REDIS_URL=.*|APPSMITH_REDIS_URL=redis://:${generated_appsmith_redis_password}@127.0.0.1:6379|" "$ENV_PATH"
+        redis_target="${current_redis_url#redis://}"  # strip scheme
+        redis_target="${redis_target#*@}"             # strip existing credentials if present
+        sed -i "s|^APPSMITH_REDIS_URL=.*|APPSMITH_REDIS_URL=redis://:${generated_appsmith_redis_password}@${redis_target}|" "$ENV_PATH"
       fi
     fi
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
if ! grep -q "APPSMITH_REDIS_PASSWORD" "$ENV_PATH"; then
local generated_appsmith_redis_password=$(
tr -dc A-Za-z0-9 </dev/urandom | head -c 13
echo ''
)
echo $'\nAPPSMITH_REDIS_PASSWORD='"$generated_appsmith_redis_password" >> "$ENV_PATH"
# Update the Redis URL to include the password, but only for the embedded Redis.
local current_redis_url
current_redis_url=$(grep "^APPSMITH_REDIS_URL=" "$ENV_PATH" | tail -1 | cut -d= -f2-)
if [[ "$current_redis_url" == *"localhost"* || "$current_redis_url" == *"127.0.0.1"* ]]; then
sed -i "s|^APPSMITH_REDIS_URL=.*|APPSMITH_REDIS_URL=redis://:${generated_appsmith_redis_password}@127.0.0.1:6379|" "$ENV_PATH"
fi
if ! grep -qE '^APPSMITH_REDIS_PASSWORD=.+$' "$ENV_PATH"; then
local generated_appsmith_redis_password=$(
tr -dc A-Za-z0-9 </dev/urandom | head -c 13
echo ''
)
echo $'\nAPPSMITH_REDIS_PASSWORD='"$generated_appsmith_redis_password" >> "$ENV_PATH"
# Update the Redis URL to include the password, but only for the embedded Redis.
local current_redis_url
local redis_target
current_redis_url=$(grep "^APPSMITH_REDIS_URL=" "$ENV_PATH" | tail -1 | cut -d= -f2-)
if [[ "$current_redis_url" == *"localhost"* || "$current_redis_url" == *"127.0.0.1"* ]]; then
redis_target="${current_redis_url#redis://}" # strip scheme
redis_target="${redis_target#*@}" # strip existing credentials if present
sed -i "s|^APPSMITH_REDIS_URL=.*|APPSMITH_REDIS_URL=redis://:${generated_appsmith_redis_password}@${redis_target}|" "$ENV_PATH"
fi
🧰 Tools
🪛 Shellcheck (0.11.0)

[warning] 116-116: Declare and assign separately to avoid masking return values.

(SC2155)

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@deploy/docker/fs/opt/appsmith/entrypoint.sh` around lines 115 - 126, Treat
empty APPSMITH_REDIS_PASSWORD as missing and when backfilling a
generated_appsmith_redis_password, preserve the existing APPSMITH_REDIS_URL
host/port/path/query instead of hardcoding 127.0.0.1:6379: check for
APPSMITH_REDIS_PASSWORD being unset or empty, generate
generated_appsmith_redis_password as you already do, append it to the env, then
parse current_redis_url (from the APPSMITH_REDIS_URL line) and inject the
password into that URL by inserting :<generated_appsmith_redis_password>@ after
the scheme (e.g. redis://) while keeping the original host/port/path/query
intact; update the APPSMITH_REDIS_URL line with the modified URL rather than
replacing it with a fixed host.

fi
fi

tlog "Load environment configuration"
Expand Down Expand Up @@ -424,6 +445,16 @@ configure_supervisord() {
if [[ $APPSMITH_REDIS_URL == *"localhost"* || $APPSMITH_REDIS_URL == *"127.0.0.1"* ]]; then
cp "$supervisord_conf_source/redis.conf" "$SUPERVISORD_CONF_TARGET"
mkdir -p "$stacks_path/data/redis"
# Write Redis server config so the password is not visible in the process list.
# Placed in $TMP so it is regenerated each startup.
cat > "$TMP/redis.conf" <<REDIS_CONF
save 15 1
dir /appsmith-stacks/data/redis
daemonize no
logfile ""
requirepass ${APPSMITH_REDIS_PASSWORD:-}
REDIS_CONF
chmod 600 "$TMP/redis.conf"
fi
if [[ $runEmbeddedPostgres -eq 1 ]]; then
cp "$supervisord_conf_source/postgres.conf" "$SUPERVISORD_CONF_TARGET"
Expand Down
4 changes: 3 additions & 1 deletion deploy/docker/fs/opt/appsmith/templates/docker.env.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ DB_PASSWORD="$2"
ENCRYPTION_PASSWORD="$3"
ENCRYPTION_SALT="$4"
SUPERVISOR_PASSWORD="$5"
REDIS_PASSWORD="${6:-}"

cat <<EOF
# Sentry
Expand Down Expand Up @@ -63,7 +64,8 @@ APPSMITH_POSTGRES_DB_URL=postgresql://appsmith:$DB_PASSWORD@localhost:5432/appsm
APPSMITH_MONGODB_USER=$MONGO_USER
APPSMITH_MONGODB_PASSWORD=$DB_PASSWORD

APPSMITH_REDIS_URL=redis://127.0.0.1:6379
APPSMITH_REDIS_URL=redis://:$REDIS_PASSWORD@127.0.0.1:6379
APPSMITH_REDIS_PASSWORD=$REDIS_PASSWORD

APPSMITH_ENCRYPTION_PASSWORD=$ENCRYPTION_PASSWORD
APPSMITH_ENCRYPTION_SALT=$ENCRYPTION_SALT
Expand Down
2 changes: 1 addition & 1 deletion deploy/docker/fs/opt/appsmith/templates/supervisord/redis.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[program:redis]
; The `--save` is for saving session data to disk more often, so recent sessions aren't cleared on restart.
; The empty string to `--logfile` is for logging to stdout so that supervisor can capture it.
command=redis-server --save 15 1 --dir /appsmith-stacks/data/redis --daemonize no --logfile ""
command=redis-server %(ENV_TMP)s/redis.conf
autorestart=true
autostart=true
priority=5
Expand Down
Loading