Merge pull request rails#52725 from sharvy/update_active_storage_documentation

Fix rails#52724 Active Storage Overview documentation to promote use of Rails.application.credentials and better bucket names

Author: rafaelfranca

guides/source/active_storage_overview.md

@@ -82,11 +82,12 @@ test:
   service: Disk
   root: <%= Rails.root.join("tmp/storage") %>
 
+# Use bin/rails credentials:edit to set the AWS secrets (as aws:access_key_id|secret_access_key)
 amazon:
   service: S3
-  access_key_id: ""
-  secret_access_key: ""
-  bucket: ""
+  access_key_id: <%= Rails.application.credentials.dig(:aws, :access_key_id) %>
+  secret_access_key: <%= Rails.application.credentials.dig(:aws, :secret_access_key) %>
+  bucket: your_own_bucket-<%= Rails.env %>
   region: "" # e.g. 'us-east-1'
 ```
 
@@ -159,23 +160,25 @@ local:
 To connect to Amazon S3, declare an S3 service in `config/storage.yml`:
 
 ```yaml
+# Use bin/rails credentials:edit to set the AWS secrets (as aws:access_key_id|secret_access_key)
 amazon:
   service: S3
-  access_key_id: ""
-  secret_access_key: ""
-  region: ""
-  bucket: ""
+  access_key_id: <%= Rails.application.credentials.dig(:aws, :access_key_id) %>
+  secret_access_key: <%= Rails.application.credentials.dig(:aws, :secret_access_key) %>
+  region: "" # e.g. 'us-east-1'
+  bucket: your_own_bucket-<%= Rails.env %>
 ```
 
 Optionally provide client and upload options:
 
 ```yaml
+# Use bin/rails credentials:edit to set the AWS secrets (as aws:access_key_id|secret_access_key)
 amazon:
   service: S3
-  access_key_id: ""
-  secret_access_key: ""
-  region: ""
-  bucket: ""
+  access_key_id: <%= Rails.application.credentials.dig(:aws, :access_key_id) %>
+  secret_access_key: <%= Rails.application.credentials.dig(:aws, :secret_access_key) %>
+  region: "" # e.g. 'us-east-1'
+  bucket: your_own_bucket-<%= Rails.env %>
   http_open_timeout: 0
   http_read_timeout: 0
   retry_limit: 0
@@ -205,8 +208,8 @@ To connect to an S3-compatible object storage API such as DigitalOcean Spaces, p
 digitalocean:
   service: S3
   endpoint: https://nyc3.digitaloceanspaces.com
-  access_key_id: ...
-  secret_access_key: ...
+  access_key_id: <%= Rails.application.credentials.dig(:digitalocean, :access_key_id) %>
+  secret_access_key: <%= Rails.application.credentials.dig(:digitalocean, :secret_access_key) %>
   # ...and other options
 ```
 
@@ -217,11 +220,12 @@ There are many other options available. You can check them in [AWS S3 Client](ht
 Declare an Azure Storage service in `config/storage.yml`:
 
 ```yaml
+# Use bin/rails credentials:edit to set the Azure Storage secret (as azure_storage:storage_access_key)
 azure:
   service: AzureStorage
-  storage_account_name: ""
-  storage_access_key: ""
-  container: ""
+  storage_account_name: your_account_name
+  storage_access_key: <%= Rails.application.credentials.dig(:azure_storage, :storage_access_key) %>
+  container: your_container_name-<%= Rails.env %>
 ```
 
 Add the [`azure-storage-blob`](https://github.com/Azure/azure-storage-ruby) gem to your `Gemfile`:
@@ -239,12 +243,13 @@ google:
   service: GCS
   credentials: <%= Rails.root.join("path/to/keyfile.json") %>
   project: ""
-  bucket: ""
+  bucket: your_own_bucket-<%= Rails.env %>
 ```
 
 Optionally provide a Hash of credentials instead of a keyfile path:
 
 ```yaml
+# Use bin/rails credentials:edit to set the GCS secrets (as gcs:private_key_id|private_key)
 google:
   service: GCS
   credentials:
@@ -259,7 +264,7 @@ google:
     auth_provider_x509_cert_url: "https://www.googleapis.com/oauth2/v1/certs"
     client_x509_cert_url: ""
   project: ""
-  bucket: ""
+  bucket: your_own_bucket-<%= Rails.env %>
 ```
 
 Optionally provide a Cache-Control metadata to set on uploaded assets:
@@ -314,19 +319,20 @@ Define each of the services you'd like to mirror as described above. Reference
 them by name when defining a mirror service:
 
 ```yaml
+# Use bin/rails credentials:edit to set the AWS secrets (as aws:access_key_id|secret_access_key)
 s3_west_coast:
   service: S3
-  access_key_id: ""
-  secret_access_key: ""
-  region: ""
-  bucket: ""
+  access_key_id: <%= Rails.application.credentials.dig(:aws, :access_key_id) %>
+  secret_access_key: <%= Rails.application.credentials.dig(:aws, :secret_access_key) %>
+  region: "" # e.g. 'us-west-1'
+  bucket: your_own_bucket-<%= Rails.env %>
 
 s3_east_coast:
   service: S3
-  access_key_id: ""
-  secret_access_key: ""
-  region: ""
-  bucket: ""
+  access_key_id: <%= Rails.application.credentials.dig(:aws, :access_key_id) %>
+  secret_access_key: <%= Rails.application.credentials.dig(:aws, :secret_access_key) %>
+  region: "" # e.g. 'us-east-1'
+  bucket: your_own_bucket-<%= Rails.env %>
 
 production:
   service: Mirror
@@ -354,12 +360,12 @@ gcs: &gcs
 private_gcs:
   <<: *gcs
   credentials: <%= Rails.root.join("path/to/private_key.json") %>
-  bucket: ""
+  bucket: your_own_bucket-<%= Rails.env %>
 
 public_gcs:
   <<: *gcs
   credentials: <%= Rails.root.join("path/to/public_key.json") %>
-  bucket: ""
+  bucket: your_own_bucket-<%= Rails.env %>
   public: true
 ```