Menu

ランタイム設定

警告:

アプリにランタイム設定を追加するには、next.config.jsを開き、publicRuntimeConfigserverRuntimeConfigの設定を追加します:

next.config.js
module.exports = {
  serverRuntimeConfig: {
    // サーバー側でのみ利用可能
    mySecret: 'secret',
    secondSecret: process.env.SECOND_SECRET, // 環境変数をパススルー
  },
  publicRuntimeConfig: {
    // サーバーとクライアントの両方で利用可能
    staticFolder: '/static',
  },
}

サーバー専用のランタイム設定はserverRuntimeConfigの下に配置します。

クライアントとサーバーの両方のコードでアクセス可能な設定はpublicRuntimeConfigの下に配置します。

publicRuntimeConfigに依存するページは、必ずgetInitialPropsまたはgetServerSidePropsを使用するか、getInitialPropsを持つカスタムAppを使用して自動静的最適化をオプトアウトする必要があります。サーバーサイドでレンダリングされない限り、ランタイム設定はどのページ(またはページ内のコンポーネント)でも利用できません。

アプリ内でランタイム設定にアクセスするには、次のようにnext/configを使用します:

import getConfig from 'next/config'
import Image from 'next/image'
 
// serverRuntimeConfigとpublicRuntimeConfigのみを保持
const { serverRuntimeConfig, publicRuntimeConfig } = getConfig()
// サーバー側でのみ利用可能
console.log(serverRuntimeConfig.mySecret)
// サーバー側とクライアント側の両方で利用可能
console.log(publicRuntimeConfig.staticFolder)
 
function MyImage() {
  return (
    <div>
      <Image
        src={`${publicRuntimeConfig.staticFolder}/logo.png`}
        alt="logo"
        layout="fill"
      />
    </div>
  )
}
 
export default MyImage