add custom s3 support storage config option

[OrangeDrangon]

Options are documented here including an example on how to set a custom endpoint:

https://guides.rubyonrails.org/active_storage_overview.html#s3-service-amazon-s3-and-s3-compatible-apis

Summary by CodeRabbit

Release Notes

• New Features
  • Added support for Generic S3-compatible storage configuration, enabling users to integrate S3-compatible storage providers with customizable endpoint URLs, access credentials, region, bucket settings, and path style options for flexible cloud storage deployment.

[coderabbitai]

Walkthrough

Adds Generic S3 storage configuration to the application. Introduces environment variables in .env.example for S3-compatible endpoint configuration and adds corresponding storage service definition in config/storage.yml enabling use of S3-compatible storage providers.

Changes

Cohort / File(s)	Summary
Environment Configuration \.env\.example	Added six new environment variables for Generic S3 storage: GENERIC_S3_ACCESS_KEY_ID, GENERIC_S3_SECRET_ACCESS_KEY, GENERIC_S3_REGION, GENERIC_S3_BUCKET, GENERIC_S3_ENDPOINT, and GENERIC_S3_FORCE_PATH_STYLE (defaults to false). Marked ACTIVE_STORAGE_SERVICE=generic_s3 as the enabling option.
Storage Configuration config/storage\.yml	Added new generic_s3 storage service block configured with S3 service type, mapping all six environment variables as credentials and connection parameters, with force_path_style cast to boolean.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

• Configuration-only changes with no business logic modifications
• Straightforward, repetitive key-value declarations
• No control flow or error handling impacts

Poem

🐰 A storage path so S3-fine,
Generic endpoints in a line,
Configuration, clean and true,
New buckets spring from morning dew! 🪣✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title "add custom s3 support storage config option" accurately describes the main change in the pull request. The changeset adds a new generic_s3 storage configuration block to both .env.example and config/storage.yml, enabling S3-compatible API support. The title is concise, clear, and specific enough for reviewers scanning the commit history to understand the primary objective of introducing custom S3 storage configuration capability.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b24b102 and 431aea4.

📒 Files selected for processing (2)

• .env.example (1 hunks)
• config/storage.yml (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

config/**

📄 CodeRabbit inference engine (AGENTS.md)

Store application and environment configuration under config/

Files:

• config/storage.yml

[coderabbitai]

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

Clarify region requirement and add guidance in .env.example documentation.

The Generic S3 section omits important documentation compared to the existing Amazon S3 section:

1. Region guidance missing: The Amazon S3 section documents that S3_REGION defaults to us-east-1 if not set. The Generic S3 section doesn't clarify whether GENERIC_S3_REGION is required, optional, or has a default.

2. Endpoint guidance missing: No guidance on what format to expect for GENERIC_S3_ENDPOINT (e.g., is it required? what format?).

3. Use case clarity: Users may be unclear when to choose generic S3 vs. AWS S3 directly.

Add documentation similar to the Amazon section to align expectations with the actual configuration behavior.

Consider adding inline comments like:

# GENERIC_S3_REGION= # required; specify the region for your S3-compatible service
# GENERIC_S3_ENDPOINT= # required; e.g., https://s3.custom-provider.com
# GENERIC_S3_FORCE_PATH_STYLE= # defaults to false; set to true if using path-style URLs

Also clarify whether the region handling matches the behavior documented in config/storage.yml.

---

---

🏁 Script executed:

```shell
#!/bin/bash
# Inspect .env.example to compare Amazon S3 and Generic S3 sections
echo "=== .env.example lines 90-120 ==="
sed -n '90,120p' .env.example

Length of output: 959

---

🏁 Script executed:

#!/bin/bash
# Find and display config/storage.yml or similar configuration file
echo "=== Looking for storage configuration files ==="
find . -name "storage.yml" -o -name "storage.yaml" | head -20

Length of output: 68

---

🏁 Script executed:

#!/bin/bash
# Search for Rails config files that might set S3 defaults
echo "=== Searching for S3 configuration in Rails config ==="
fd -e rb -e yml . config/ 2>/dev/null | xargs -I {} sh -c 'grep -l "REGION\|generic_s3" {} 2>/dev/null' | head -20

Length of output: 73

---

🏁 Script executed:

#!/bin/bash
# Look for any documentation about generic S3 or S3 region defaults in the codebase
echo "=== Searching for region default mentions ==="
rg -i "region.*default\|default.*region" -C 2 --type rb --type yml 2>/dev/null | head -50

Length of output: 45

---

---

🏁 Script executed:

```shell
#!/bin/bash
# Display config/storage.yml to understand S3 configurations
echo "=== config/storage.yml ==="
cat ./config/storage.yml

Length of output: 1144

---

🏁 Script executed:

#!/bin/bash
# Search for generic_s3 implementation and region/endpoint handling
echo "=== Searching for generic_s3 implementation ==="
rg -i "generic_s3\|generic.*s3" -C 5 --type rb --type yml 2>/dev/null | head -80

Length of output: 47

---

🏁 Script executed:

#!/bin/bash
# Search for ENV variable access related to region/endpoint
echo "=== Searching for GENERIC_S3 ENV variable usage ==="
rg "GENERIC_S3_REGION|GENERIC_S3_ENDPOINT" -C 3 --type rb 2>/dev/null

Length of output: 51

---

Document required GENERIC_S3_REGION and GENERIC_S3_ENDPOINT in .env.example.

Verification confirms the documentation gaps. The implementation shows:

• GENERIC_S3_REGION has no default: Unlike Amazon S3 which defaults to us-east-1, the generic_s3 config in config/storage.yml uses <%= ENV["GENERIC_S3_REGION"] %> with no fallback—setting it to nil if unset.
• GENERIC_S3_ENDPOINT has no default: Similarly, <%= ENV["GENERIC_S3_ENDPOINT"] %> will be nil if unset, making it effectively required.
• GENERIC_S3_FORCE_PATH_STYLE correctly documents the default: The code confirms it defaults to "false", matching the .env.example inline comment.

Update .env.example lines 114–116 to clarify these are required and match the actual behavior:

# GENERIC_S3_REGION= # required; specify the region for your S3-compatible service
# GENERIC_S3_ENDPOINT= # required; e.g., https://s3.custom-provider.com
# GENERIC_S3_FORCE_PATH_STYLE= # defaults to false

🤖 Prompt for AI Agents

In .env.example around lines 110 to 118 (update lines 114–116), the
GENERIC_S3_REGION and GENERIC_S3_ENDPOINT entries are not documented as required
even though the runtime config reads them with no fallback; change those
commented lines to indicate they are required and provide an example for the
endpoint and keep GENERIC_S3_FORCE_PATH_STYLE noted as default false—e.g.,
replace the three lines with comments stating GENERIC_S3_REGION= # required;
specify the region for your S3-compatible service, GENERIC_S3_ENDPOINT= #
required; e.g., https://s3.custom-provider.com, and GENERIC_S3_FORCE_PATH_STYLE=
# defaults to false.

[coderabbitai]

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

Add default region for generic S3 to avoid potential runtime errors.

The generic_s3 configuration is missing a default region (line 30), unlike the amazon configuration on line 13 which provides "us-east-1" as a default. S3-compatible services typically require a region parameter, and a nil value may cause the AWS SDK to fail or behave unexpectedly.

Consider whether this should match the amazon pattern with a sensible default, or if the absence of a default is intentional for generic S3.

---

🏁 Script executed:

#!/bin/bash
# Description: Check if AWS SDK or Rails Active Storage has region validation/requirements
# Search for how region is used in storage config initialization

rg -A 5 -B 5 "GENERIC_S3_REGION|S3_REGION" --type yaml --type rb

Length of output: 26

---

🏁 Script executed:

#!/bin/bash
# Corrected search: use proper ripgrep syntax without unsupported type
rg -n -C5 "GENERIC_S3_REGION|S3_REGION" --type yaml --type ruby

Length of output: 1151

---

🏁 Script executed:

#!/bin/bash
# Search for how region is actually used in Rails storage initialization
rg -n -C3 "region.*ENV|region.*fetch" --type yaml

Length of output: 904

---

🏁 Script executed:

#!/bin/bash
# Look for any AWS SDK or boto/S3 client initialization with region handling
rg -n -C3 "aws|s3|region" config/storage.yml

Length of output: 1032

---

🏁 Script executed:

#!/bin/bash
# Check if there are any Rails storage adapter implementations or docs
fd -e yml -e yaml config/ | head -20

Length of output: 333

---

🏁 Script executed:

#!/bin/bash
# Look for generic_s3 references in tests, docs, or other config files
rg -n "generic_s3|GENERIC_S3" --type yaml --type ruby

Length of output: 530

---

🏁 Script executed:

#!/bin/bash
# Search for Rails storage initialization or adapter code
fd . config/ -name "*.yml" -o -name "*.yaml"

Length of output: 230

---

🏁 Script executed:

#!/bin/bash
# Check for .env.example or documentation that shows expected env vars
find . -name ".env*" -o -name "README*" -o -name "SETUP*" | head -20

Length of output: 67

---

🏁 Script executed:

#!/bin/bash
# Look for any comments or documentation around storage configuration
rg -n "storage|S3" --type yaml -B2 -A2 | head -50

Length of output: 2319

---

🏁 Script executed:

#!/bin/bash
# Check .env.example for GENERIC_S3 configuration
cat ./.env.example | grep -i generic

Length of output: 255

---

🏁 Script executed:

#!/bin/bash
# Check .env.example for S3 pattern to understand expected format
cat ./.env.example | grep -i "s3"

Length of output: 512

---

🏁 Script executed:

#!/bin/bash
# Search README for any mention of generic_s3 or custom S3 setup
rg -n "generic|s3|storage" README.md -i

Length of output: 0

---

Add default region for generic_s3 configuration to match established pattern.

The inconsistency is confirmed: amazon config has region: <%= ENV["S3_REGION"] || "us-east-1" %> (with documented default in .env.example), but generic_s3 config has region: <%= ENV["GENERIC_S3_REGION"] %> with no fallback. If GENERIC_S3_REGION is not set, the region will be nil, which the AWS SDK requires and will likely fail. The .env.example file explicitly documents the amazon default but provides no guidance for generic_s3.

Either add a default region to config/storage.yml line 30 (e.g., || "us-east-1") or explicitly document in .env.example why generic_s3 requires explicit region configuration with no default.

🤖 Prompt for AI Agents

In config/storage.yml around lines 26 to 33, the generic_s3 block sets region
from ENV["GENERIC_S3_REGION"] with no fallback which can result in a nil region
and AWS SDK failures; update this line to provide a sensible default (e.g., ||
"us-east-1") to match the amazon config pattern or alternatively document in
.env.example that GENERIC_S3_REGION is required — implement the change by adding
the fallback default to the region setting in storage.yml or add explicit
guidance to .env.example ensuring behavior is consistent with the amazon config.

[OrangeDrangon]

I do not really think the AI comments are particularly relevant without human opinion. If a human has thoughts happy to make any changes to conform to maintainer desires.

[jjmata]

I do not really think the AI comments are particularly relevant without human opinion. If a human has thoughts happy to make any changes to conform to maintainer desires.

Agreed. What might be nice is adding a document in docs/hosting/storage.md that explains how Sure manages this.

[jjmata]

Config-only changes, so low risk. Didn't test this, but LGTM.