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

はじめに

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】Railsアップグレードまとめ
# はじめに Ruby on Railsに限らず、何らかのフレームワークを使ってWebシステムを構築している場合、フレームワークのアップグレード作業は避けて通れません。 一般的にフレームワークはバージョン毎にEOL (End of Life [...]
2022年10月1日 14:32
【Rails】ユーザー登録時に行うメールアドレス認証機能の実装方法
# はじめに ユーザー登録/解除やログイン/ログアウトといった認証機能の導入に「devise」というGemを使っている人は多いと思います。「devise」では以下のように記述するだけで、ユーザー登録時に確認メールを送付しメールアドレス認証を行う機 [...]
2022年9月24日 14:24
【Rails】モデルに列挙型(enum)を定義し、使いこなす方法
# はじめに Railsはモデルでカラム名と同名の列挙型(enum)を定義することで、カラムと列挙型の変数を紐付けることができます。カラムと列挙型の変数を紐付けると、カラムに対して様々な便利な使い方ができるようになります。 本記事では、モデ [...]
2022年9月3日 10:29
【Rails】RailsでCORSとPreflight requestの設定を行う方法
# はじめに RailsアプリをAPIサーバーとして構築するには、CORS (Cross-Origin Resource Sharing)と Preflight requestの設定を行う必要があります。APIサーバーは外部からの要求に対して処理 [...]
2022年8月27日 10:44
【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】モデルに外部キーを設定する方法とよく起こるエラー内容について
# はじめに Railsでモデルに外部キーを設定する方法について説明します。 # モデルに外部キーを設定する ## リレーションシップ 今回は1つのブログ記事は複数のコメントを持つ1対多のリレーションシップを例に説明します。現在は` [...]
2022年2月10日 14:18
【Rails】Capybaraのfill_inメソッドを実行すると「既存レコードの内容+指定した内容」がセットされる事象の原因と対処【RSpec】
# はじめに RSpec + Capybaraを使用して、Railsアプリの統合テストを実装しています。とあるモデルの編集画面において、入力フォームの内容を書き換えた上で送信し、レコードが更新されることを確認します。 入力フォームの内容を書 [...]
2022年1月27日 21:22