【Rails6】Action Textで挿入した画像の保存先をAmazon S3やGCSに変更する方法

2021年2月15日 15:48

はじめに

Rails 6.0で追加された「Action Text」で挿入した画像の保存先は、デフォルトではローカルディスク(Railsアプリの実行環境)となっています。

本記事では、Action Textで挿入した画像の保存先をローカルディスクからAmazon S3やGCSといったクラウドストレージサービスに変更する方法について説明しています。

本記事ではAction Textの実装方法については説明していないので、以下の記事を参照してAction Textを実装してください。

画像の保存先について

Action Textで挿入した画像は、Active Storageという機能を使って保存されます。Active Storageの設定は、app/config/environments/development.rb(開発環境)またはapp/config/environments/production.rb(本番環境)で確認できます。

  config.active_storage.service = :local

ここで記述している:localという設定は、app/config/storage.ymlで定義してあります。

local:
  service: Disk
  root: <%= Rails.root.join("storage") %>

画像の保存先をAmazon S3やGCSに変更

前提

  • AWSに登録済み、IAMとバケット作成済み
  • GCPに登録済み、サービスアカウントとバケット作成済み

Amazon S3

Gemfileに以下を追加し、bundle installを実行します。

gem 'aws-sdk-s3', require: false

app/config/environments/development.rb(開発環境)またはapp/config/environments/production.rb(本番環境)を以下のように変更します。

  config.active_storage.service = :amazon

app/config/storage.ymlに以下を追記します。

項目 設定例
service S3
access_key_id Credentialsで設定(後述)
secret_access_key Credentialsで設定(後述)
region バケットのリージョン
bucket バケットの名称
amazon:
  service: S3
  access_key_id: <%= Rails.application.credentials.dig(:aws, :access_key_id) %>
  secret_access_key: <%= Rails.application.credentials.dig(:aws, :secret_access_key) %>
  region: <バケットのリージョン>
  bucket: <バケットの名称>

以下のコマンドを実行して、Credentialsを設定します。

$ EDITOR=vi rails credentials:edit
 aws:
   access_key_id: <アクセスキー>
   secret_access_key: <シークレットキー>

これで画像の保存先がAmazon S3に変更できました。

GCS

Gemfileに以下を追加し、bundle installを実行します。

gem 'google-cloud-storage'

app/config/environments/development.rb(開発環境)またはapp/config/environments/production.rb(本番環境)を以下のように変更します。

  config.active_storage.service = :google

app/config/storage.ymlに以下を追記します。

項目 設定例
service GCS
project プロジェクト名
private_key_id Credentialsで設定(後述)
private_key Credentialsで設定(後述、末尾に.dumpをつける)
bucket バケットの名称
google:
  service: GCS
  project: <プロジェクト名>
  credentials: 
    type: 
    project_id: 
    private_key_id: <%= Rails.application.credentials.dig(:gcs, :private_key_id) %>
    private_key: <%= Rails.application.credentials.dig(:gcs, :private_key).dump %>
    client_email: 
    client_id: 
    auth_uri: 
    token_uri: 
    auth_provider_x509_cert_url: 
    client_x509_cert_url: 
  bucket: <バケットの名称>

以下のコマンドを実行して、Credentialsを設定します。なお、private_keyは値に改行コード(\n)が含まれているので、ダブルクォーテーション("")で囲む必要があります。

$ EDITOR=vi rails credentials:edit
gcs:
  private_key_id: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
  private_key: "-----BEGIN PRIVATE KEY-----\nXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX..."

これで画像の保存先がGCSに変更できました。

Credentialsが保存されない場合

上記のコマンドではCredentialsが保存されないという場合、以下のコマンドを試してみてください。Visual Studio CodeでCredentialsを編集できるようになります。

$ EDITOR="code --wait" rails credentials:edit

まとめ

Action Textで挿入した画像は、開発環境ではローカルディスク、本番環境ではクラウドストレージサービスに設定するのが一般的です。本記事を参考にしてAction Textで挿入した画像の保存先を変更していただければと思います。

関連記事

【Rails】M1チップ搭載MacでRuby on Railsの開発環境構築
# はじめに M1チップ搭載MacにRuby on Railsの開発環境を構築する手順を記載します。 - MacBook Air (M1, 2020) - macOS Monterey 12.3.1 # Homebrew ## [...]
2022年5月5日 11:56
【Rails】Rakeタスクの基本情報と作成・実行方法
# はじめに Railsには標準でRakeというGemが同梱されています。RakeはRubyで実装されたMake(UNIX系のOSで使用できるコマンド)のようなビルド作業を自動化するツールです。Ruby Make、略してRakeというわけですね。 [...]
2022年3月7日 22:12
【Rails】Capybaraのfill_inメソッドを実行すると「既存レコードの内容+指定した内容」がセットされる事象の原因と対処【RSpec】
# はじめに RSpec + Capybaraを使用して、Railsアプリの統合テストを実装しています。とあるモデルの編集画面において、入力フォームの内容を書き換えた上で送信し、レコードが更新されることを確認します。 入力フォームの内容を書 [...]
2022年1月27日 21:22
【Rails】GitHubのセキュリティアラートで発見された脆弱性を解消する方法
# はじめに GitHubにはセキュリティアラートという機能があります。セキュリティアラートはリポジトリに含まれるライブラリやパッケージの脆弱性を定期的にチェックし、脆弱性のあるライブラリやパッケージが発見されたらアラートで知らせてくれるという機 [...]
2022年1月16日 10:36
【Rails】devise-two-factorを使った2段階認証の実装方法【初学者】
# はじめに Railsアプリで2段階認証を実装するには、「rotp」というGemを使う方法の他に、「devise-two-factor」というGemを使う方法があります。「devise-two-factor」はその名の通り、IDとパスワードによ [...]
2021年12月12日 17:58
【Rails】rotpを使った2段階認証の実装方法【初学者】
# はじめに 昨今はIDとパスワードによる認証だけでなく、ワンタイムパスワードによる2段階認証を導入するWebアプリが増えてきました。Railsで作成したWebアプリでも、IDとパスワードによる認証に加えて2段階認証を導入するニーズが高まっていま [...]
2021年11月27日 13:02
【Rails】deviseを使った認証機能の実装【初学者】
# はじめに Railsアプリに認証機能を導入するには「devise」というGemを使う方法が最も簡単です。「devise」は認証に係る機能をほとんどコードを書くことなく実装できる反面、処理がブラックボックス化されており、全容が把握しづらいという [...]
2021年11月27日 13:01
【Rails】IDとパスワードによる認証機能の実装【初学者】
# はじめに 大抵のWebアプリでは、ユーザー登録/解除、ログイン/ログアウトといった認証機能を持っています。Railsには簡単に認証機能を導入できる「device」というGemが用意されています。「devise」は多くのRailsアプリで使われ [...]
2021年11月27日 13:00