Rails::Application::Configuration - Ruby on Rails 繁體中文

[RW]（讀寫）	add_autoload_paths_to_load_path（將自動載入路徑添加到載入路徑）
[RW]（讀寫）	allow_concurrency（允許並行）
[R]（唯讀）	api_only（僅限 API）
[RW]（讀寫）	asset_host（資源主機）
[RW]（讀寫）	assume_ssl（假設 SSL）
[RW]（讀寫）	autoflush_log（自動清空日誌）
[RW]（讀寫）	beginning_of_week（一週的開始）
[RW]（讀寫）	cache_classes（快取類別）
[RW]（讀寫）	cache_store（快取儲存）
[RW]（讀寫）	consider_all_requests_local（將所有請求視為本地）
[RW]（讀寫）	console（控制台）
[RW]（讀寫）	content_security_policy_nonce_directives（內容安全策略 nonce 指令）
[RW]（讀寫）	content_security_policy_nonce_generator（內容安全策略 nonce 生成器）
[RW]（讀寫）	content_security_policy_report_only（僅報告內容安全策略）
[RW]（讀寫）	credentials (憑證)
[W]（唯寫）	debug_exception_response_format（除錯例外回應格式）
[RW]（讀寫）	disable_sandbox（禁用沙盒）
[RW]（讀寫）	dom_testing_default_html_version(DOM 測試預設 HTML 版本)
[RW]（讀寫）	eager_load（立即載入）
[R]（唯讀）	encoding（編碼）
[RW]（讀寫）	exceptions_app（例外應用程式）
[RW]（讀寫）	file_watcher（檔案監視器）
[RW]（讀寫）	filter_parameters（過濾參數）
[RW]（讀寫）	filter_redirect（過濾重新導向）
[RW]（讀寫）	force_ssl（強制使用 SSL）
[RW]（讀寫）	helpers_paths（輔助方法路徑）
[RW]（讀寫）	host_authorization（主機授權）
[RW]（讀寫）	hosts（主機）
[R]（唯讀）	loaded_config_version（已載入的配置版本）
[RW]（讀寫）	log_file_size（日誌檔案大小）
[RW]（讀寫）	log_formatter（日誌格式器）
[R]（唯讀）	log_level（日誌級別）
[RW]（讀寫）	log_tags（日誌標籤）
[RW]（讀寫）	logger（記錄器）
[RW]（讀寫）	precompile_filter_parameters（預編譯過濾參數）
[RW]（讀寫）	public_file_server（公共檔案伺服器）
[RW]（讀寫）	railties_order（Railties 順序）
[RW]（讀寫）	rake_eager_load (Rake 立即載入)
[RW]（讀寫）	relative_url_root（相對 URL 根目錄）
[RW]（讀寫）	reload_classes_only_on_change（僅在變更時重新載入類別）
[RW]（讀寫）	require_master_key（需要主金鑰）
[RW]（讀寫）	sandbox_by_default（預設使用沙盒）
[RW]（讀寫）	server_timing（伺服器計時）
[RW]（讀寫）	session_options（會話選項）
[RW]（讀寫）	silence_healthcheck_path(靜默健康檢查路徑)
[RW]（讀寫）	ssl_options（SSL 選項）
[RW]（讀寫）	time_zone（時區）
[RW]（讀寫）	x
[RW]（讀寫）	yjit

類別公開方法

new(*) 連結

來源：顯示 | 在 GitHub 上

# File railties/lib/rails/application/configuration.rb, line 30
def initialize(*)
  super
  self.encoding                            = Encoding::UTF_8
  @allow_concurrency                       = nil
  @consider_all_requests_local             = false
  @filter_parameters                       = []
  @filter_redirect                         = []
  @helpers_paths                           = []
  if Rails.env.development?
    @hosts = ActionDispatch::HostAuthorization::ALLOWED_HOSTS_IN_DEVELOPMENT +
      ENV["RAILS_DEVELOPMENT_HOSTS"].to_s.split(",").map(&:strip)
  else
    @hosts = []
  end
  @host_authorization                      = {}
  @public_file_server                      = ActiveSupport::OrderedOptions.new
  @public_file_server.enabled              = true
  @public_file_server.index_name           = "index"
  @assume_ssl                              = false
  @force_ssl                               = false
  @ssl_options                             = {}
  @session_store                           = nil
  @time_zone                               = "UTC"
  @beginning_of_week                       = :monday
  @log_level                               = :debug
  @log_file_size                           = nil
  @generators                              = app_generators
  @cache_store                             = [ :file_store, "#{root}/tmp/cache/" ]
  @railties_order                          = [:all]
  @relative_url_root                       = ENV["RAILS_RELATIVE_URL_ROOT"]
  @reload_classes_only_on_change           = true
  @file_watcher                            = ActiveSupport::FileUpdateChecker
  @exceptions_app                          = nil
  @autoflush_log                           = true
  @log_formatter                           = ActiveSupport::Logger::SimpleFormatter.new
  @silence_healthcheck_path                = nil
  @eager_load                              = nil
  @secret_key_base                         = nil
  @api_only                                = false
  @debug_exception_response_format         = nil
  @x                                       = Custom.new
  @content_security_policy                 = nil
  @content_security_policy_report_only     = false
  @content_security_policy_nonce_generator = nil
  @content_security_policy_nonce_directives = nil
  @require_master_key                      = false
  @loaded_config_version                   = nil
  @credentials                             = ActiveSupport::InheritableOptions.new(credentials_defaults)
  @disable_sandbox                         = false
  @sandbox_by_default                      = false
  @add_autoload_paths_to_load_path         = true
  @permissions_policy                      = nil
  @rake_eager_load                         = false
  @server_timing                           = false
  @dom_testing_default_html_version        = :html4
  @yjit                                    = false
end

實例公開方法

annotations（註釋）() 連結

來源：顯示 | 在 GitHub 上

# File railties/lib/rails/application/configuration.rb, line 561
def annotations
  Rails::SourceAnnotationExtractor::Annotation
end

api_only=（僅限 API）(value) 連結

來源：顯示 | 在 GitHub 上

# File railties/lib/rails/application/configuration.rb, line 376
def api_only=(value)
  @api_only = value
  generators.api_only = value

  @debug_exception_response_format ||= :api
end

autoload_lib（自動載入 lib）(ignore:) 連結

來源：顯示 | 在 GitHub 上

# File railties/lib/rails/application/configuration.rb, line 471
def autoload_lib(ignore:)
  lib = root.join("lib")

  # Set as a string to have the same type as default autoload paths, for
  # consistency.
  autoload_paths << lib.to_s
  eager_load_paths << lib.to_s

  ignored_abspaths = Array.wrap(ignore).map { lib.join(_1) }
  Rails.autoloaders.main.ignore(ignored_abspaths)
end

autoload_lib_once（自動載入 lib 一次）(ignore:) 連結

來源：顯示 | 在 GitHub 上

# File railties/lib/rails/application/configuration.rb, line 483
def autoload_lib_once(ignore:)
  lib = root.join("lib")

  # Set as a string to have the same type as default autoload paths, for
  # consistency.
  autoload_once_paths << lib.to_s
  eager_load_paths << lib.to_s

  ignored_abspaths = Array.wrap(ignore).map { lib.join(_1) }
  Rails.autoloaders.once.ignore(ignored_abspaths)
end

colorize_logging（日誌著色）() 連結

來源：顯示 | 在 GitHub 上

# File railties/lib/rails/application/configuration.rb, line 495
def colorize_logging
  ActiveSupport::LogSubscriber.colorize_logging
end

colorize_logging=（設定日誌著色）(val) 連結

來源：顯示 | 在 GitHub 上

# File railties/lib/rails/application/configuration.rb, line 499
def colorize_logging=(val)
  ActiveSupport::LogSubscriber.colorize_logging = val
  generators.colorize_logging = val
end

content_security_policy（內容安全策略）(&block) 連結

配置 ActionDispatch::ContentSecurityPolicy。

來源：顯示 | 在 GitHub 上

# File railties/lib/rails/application/configuration.rb, line 566
def content_security_policy(&block)
  if block_given?
    @content_security_policy = ActionDispatch::ContentSecurityPolicy.new(&block)
  else
    @content_security_policy
  end
end

database_configuration（資料庫配置）() 連結

從儲存在 `config/database.yml` 中的值載入並返回資料庫的完整原始配置。

來源：顯示 | 在 GitHub 上

# File railties/lib/rails/application/configuration.rb, line 434
def database_configuration
  path = paths["config/database"].existent.first
  yaml = Pathname.new(path) if path

  config = if yaml&.exist?
    loaded_yaml = ActiveSupport::ConfigurationFile.parse(yaml)
    if (shared = loaded_yaml.delete("shared"))
      loaded_yaml.each do |env, config|
        if config.is_a?(Hash) && config.values.all?(Hash)
          if shared.is_a?(Hash) && shared.values.all?(Hash)
            config.map do |name, sub_config|
              sub_config.reverse_merge!(shared[name])
            end
          else
            config.map do |name, sub_config|
              sub_config.reverse_merge!(shared)
            end
          end
        else
          config.reverse_merge!(shared)
        end
      end
    end
    Hash.new(shared).merge(loaded_yaml)
  elsif ENV["DATABASE_URL"]
    # Value from ENV['DATABASE_URL'] is set to default database connection
    # by Active Record.
    {}
  else
    raise "Could not load database configuration. No such file - #{paths["config/database"].instance_variable_get(:@paths)}"
  end

  config
rescue => e
  raise e, "Cannot load database configuration:\n#{e.message}", e.backtrace
end

debug_exception_response_format（除錯例外回應格式）() 連結

來源：顯示 | 在 GitHub 上

# File railties/lib/rails/application/configuration.rb, line 390
def debug_exception_response_format
  @debug_exception_response_format || :default
end

default_log_file（預設日誌檔案）() 連結

來源：顯示 | 在 GitHub 上

# File railties/lib/rails/application/configuration.rb, line 583
def default_log_file
  path = paths["log"].first
  unless File.exist? File.dirname path
    FileUtils.mkdir_p File.dirname path
  end

  f = File.open path, "a"
  f.binmode
  f.sync = autoflush_log # if true make sure every write flushes
  f
end

enable_reloading(啟用重新載入)() 連結

來源：顯示 | 在 GitHub 上

# File railties/lib/rails/application/configuration.rb, line 360
def enable_reloading
  !cache_classes
end

enable_reloading=（設定啟用重新載入）(value) 連結

來源：顯示 | 在 GitHub 上

# File railties/lib/rails/application/configuration.rb, line 364
def enable_reloading=(value)
  self.cache_classes = !value
end

encoding=（設定編碼）(value) 連結

來源：顯示 | 在 GitHub 上

# File railties/lib/rails/application/configuration.rb, line 368
def encoding=(value)
  @encoding = value
  silence_warnings do
    Encoding.default_external = value
    Encoding.default_internal = value
  end
end

load_defaults（載入預設值）(target_version) 連結

載入目標版本的預設配置值。這包括目標版本之前的版本的預設值。有關特定版本關聯的預設值，請參閱配置指南。

來源：顯示 | 在 GitHub 上

# File railties/lib/rails/application/configuration.rb, line 92
def load_defaults(target_version)
  # To introduce a change in behavior, follow these steps:
  # 1. Add an accessor on the target object (e.g. the ActiveJob class for
  #    global Active Job config).
  # 2. Set a default value there preserving existing behavior for existing
  #    applications.
  # 3. Implement the behavior change based on the config value.
  # 4. In the section below corresponding to the next release of Rails,
  #    configure the default value.
  # 5. Add a commented out section in the `new_framework_defaults` to
  #    configure the default value again.
  # 6. Update the guide in `configuring.md`.

  # To remove configurable deprecated behavior, follow these steps:
  # 1. Update or remove the entry in the guides.
  # 2. Remove the references below.
  # 3. Remove the legacy code paths and config check.
  # 4. Remove the config accessor.

  case target_version.to_s
  when "5.0"
    if respond_to?(:action_controller)
      action_controller.per_form_csrf_tokens = true
      action_controller.forgery_protection_origin_check = true
    end

    if respond_to?(:active_support)
      active_support.to_time_preserves_timezone = :offset
    end

    if respond_to?(:active_record)
      active_record.belongs_to_required_by_default = true
    end

    self.ssl_options = { hsts: { subdomains: true } }
  when "5.1"
    load_defaults "5.0"

    if respond_to?(:assets)
      assets.unknown_asset_fallback = false
    end

    if respond_to?(:action_view)
      action_view.form_with_generates_remote_forms = true
    end
  when "5.2"
    load_defaults "5.1"

    if respond_to?(:active_record)
      active_record.cache_versioning = true
    end

    if respond_to?(:action_dispatch)
      action_dispatch.use_authenticated_cookie_encryption = true
    end

    if respond_to?(:active_support)
      active_support.use_authenticated_message_encryption = true
      active_support.hash_digest_class = OpenSSL::Digest::SHA1
    end

    if respond_to?(:action_controller)
      action_controller.default_protect_from_forgery = true
    end

    if respond_to?(:action_view)
      action_view.form_with_generates_ids = true
    end
  when "6.0"
    load_defaults "5.2"

    if respond_to?(:action_view)
      action_view.default_enforce_utf8 = false
    end

    if respond_to?(:action_dispatch)
      action_dispatch.use_cookies_with_metadata = true
    end

    if respond_to?(:action_mailer)
      action_mailer.delivery_job = "ActionMailer::MailDeliveryJob"
    end

    if respond_to?(:active_storage)
      active_storage.queues.analysis = :active_storage_analysis
      active_storage.queues.purge    = :active_storage_purge
    end

    if respond_to?(:active_record)
      active_record.collection_cache_versioning = true
    end
  when "6.1"
    load_defaults "6.0"

    if respond_to?(:active_record)
      active_record.has_many_inversing = true
    end

    if respond_to?(:active_job)
      active_job.retry_jitter = 0.15
    end

    if respond_to?(:action_dispatch)
      action_dispatch.cookies_same_site_protection = :lax
      action_dispatch.ssl_default_redirect_status = 308
    end

    if respond_to?(:action_view)
      action_view.form_with_generates_remote_forms = false
      action_view.preload_links_header = true
    end

    if respond_to?(:active_storage)
      active_storage.track_variants = true

      active_storage.queues.analysis = nil
      active_storage.queues.purge = nil
    end

    if respond_to?(:action_mailbox)
      action_mailbox.queues.incineration = nil
      action_mailbox.queues.routing = nil
    end

    if respond_to?(:action_mailer)
      action_mailer.deliver_later_queue_name = nil
    end

    ActiveSupport.utc_to_local_returns_utc_offset_times = true
  when "7.0"
    load_defaults "6.1"

    if respond_to?(:action_dispatch)
      action_dispatch.default_headers = {
        "X-Frame-Options" => "SAMEORIGIN",
        "X-XSS-Protection" => "0",
        "X-Content-Type-Options" => "nosniff",
        "X-Download-Options" => "noopen",
        "X-Permitted-Cross-Domain-Policies" => "none",
        "Referrer-Policy" => "strict-origin-when-cross-origin"
      }
      action_dispatch.cookies_serializer = :json
    end

    if respond_to?(:action_view)
      action_view.button_to_generates_button_tag = true
      action_view.apply_stylesheet_media_default = false
    end

    if respond_to?(:active_support)
      active_support.hash_digest_class = OpenSSL::Digest::SHA256
      active_support.key_generator_hash_digest_class = OpenSSL::Digest::SHA256
      active_support.cache_format_version = 7.0
      active_support.executor_around_test_case = true
    end

    if respond_to?(:action_mailer)
      action_mailer.smtp_timeout = 5
    end

    if respond_to?(:active_storage)
      active_storage.video_preview_arguments =
        "-vf 'select=eq(n\\,0)+eq(key\\,1)+gt(scene\\,0.015),loop=loop=-1:size=2,trim=start_frame=1'" \
        " -frames:v 1 -f image2"

      active_storage.variant_processor = :vips
      active_storage.multiple_file_field_include_hidden = true
    end

    if respond_to?(:active_record)
      active_record.verify_foreign_keys_for_fixtures = true
      active_record.partial_inserts = false
      active_record.automatic_scope_inversing = true
    end

    if respond_to?(:action_controller)
      action_controller.raise_on_open_redirects = true
      action_controller.wrap_parameters_by_default = true
    end
  when "7.1"
    load_defaults "7.0"

    self.add_autoload_paths_to_load_path = false
    self.precompile_filter_parameters = true
    self.dom_testing_default_html_version = defined?(Nokogiri::HTML5) ? :html5 : :html4

    if Rails.env.local?
      self.log_file_size = 100 * 1024 * 1024
    end

    if respond_to?(:active_record)
      active_record.run_commit_callbacks_on_first_saved_instances_in_transaction = false
      active_record.sqlite3_adapter_strict_strings_by_default = true
      active_record.query_log_tags_format = :sqlcommenter
      active_record.raise_on_assign_to_attr_readonly = true
      active_record.belongs_to_required_validates_foreign_key = false
      active_record.before_committed_on_all_records = true
      active_record.default_column_serializer = nil
      active_record.encryption.hash_digest_class = OpenSSL::Digest::SHA256
      active_record.encryption.support_sha1_for_non_deterministic_encryption = false
      active_record.marshalling_format_version = 7.1
      active_record.run_after_transaction_callbacks_in_order_defined = true
      active_record.generate_secure_token_on = :initialize
    end

    if respond_to?(:action_dispatch)
      action_dispatch.default_headers = {
        "X-Frame-Options" => "SAMEORIGIN",
        "X-XSS-Protection" => "0",
        "X-Content-Type-Options" => "nosniff",
        "X-Permitted-Cross-Domain-Policies" => "none",
        "Referrer-Policy" => "strict-origin-when-cross-origin"
      }
      action_dispatch.debug_exception_log_level = :error
    end

    if respond_to?(:active_support)
      active_support.cache_format_version = 7.1
      active_support.message_serializer = :json_allow_marshal
      active_support.use_message_serializer_for_metadata = true
      active_support.raise_on_invalid_cache_expiration_time = true
    end

    if respond_to?(:action_view)
      require "action_view/helpers"
      action_view.sanitizer_vendor = Rails::HTML::Sanitizer.best_supported_vendor
    end

    if respond_to?(:action_text)
      require "action_view/helpers"
      action_text.sanitizer_vendor = Rails::HTML::Sanitizer.best_supported_vendor
    end
  when "7.2"
    load_defaults "7.1"

    self.yjit = true

    if respond_to?(:active_storage)
      active_storage.web_image_content_types = %w( image/png image/jpeg image/gif image/webp )
    end

    if respond_to?(:active_record)
      active_record.postgresql_adapter_decode_dates = true
      active_record.validate_migration_timestamps = true
    end
  when "8.0"
    load_defaults "7.2"

    if respond_to?(:active_support)
      active_support.to_time_preserves_timezone = :zone
    end

    if respond_to?(:action_dispatch)
      action_dispatch.strict_freshness = true
    end

    Regexp.timeout ||= 1
  else
    raise "Unknown version #{target_version.to_s.inspect}"
  end

  @loaded_config_version = target_version
end

log_level=（設定日誌級別）(level) 連結

來源：顯示 | 在 GitHub 上

# File railties/lib/rails/application/configuration.rb, line 383
def log_level=(level)
  @log_level = level
  @broadcast_log_level = level
end

paths（路徑）() 連結

來源：顯示 | 在 GitHub 上

# File railties/lib/rails/application/configuration.rb, line 396
def paths
  @paths ||= begin
    paths = super
    paths.add "config/database",    with: "config/database.yml"
    paths.add "config/environment", with: "config/environment.rb"
    paths.add "lib/templates"
    paths.add "log",                with: "log/#{Rails.env}.log"
    paths.add "public"
    paths.add "public/javascripts"
    paths.add "public/stylesheets"
    paths.add "tmp"
    paths
  end
end

permissions_policy（權限策略）(&block) 連結

配置 ActionDispatch::PermissionsPolicy。

來源：顯示 | 在 GitHub 上

# File railties/lib/rails/application/configuration.rb, line 575
def permissions_policy(&block)
  if block_given?
    @permissions_policy = ActionDispatch::PermissionsPolicy.new(&block)
  else
    @permissions_policy
  end
end

reloading_enabled?（重新載入已啟用？）() 連結

來源：顯示 | 在 GitHub 上

# File railties/lib/rails/application/configuration.rb, line 356
def reloading_enabled?
  enable_reloading
end

secret_key_base（密鑰基底）() 連結

來源：顯示 | 在 GitHub 上

# File railties/lib/rails/application/configuration.rb, line 504
def secret_key_base
  @secret_key_base || begin
    self.secret_key_base = if generate_local_secret?
      generate_local_secret
    else
      ENV["SECRET_KEY_BASE"] || Rails.application.credentials.secret_key_base
    end
  end
end

secret_key_base=（設定密鑰基底）(new_secret_key_base) 連結

來源：顯示 | 在 GitHub 上

# File railties/lib/rails/application/configuration.rb, line 514
def secret_key_base=(new_secret_key_base)
  if new_secret_key_base.nil? && generate_local_secret?
    @secret_key_base = generate_local_secret
  elsif new_secret_key_base.is_a?(String) && new_secret_key_base.present?
    @secret_key_base = new_secret_key_base
  elsif new_secret_key_base
    raise ArgumentError, "`secret_key_base` for #{Rails.env} environment must be a type of String`"
  else
    raise ArgumentError, "Missing `secret_key_base` for '#{Rails.env}' environment, set this string with `bin/rails credentials:edit`"
  end
end

session_store（會話儲存）(new_session_store = nil, **options) 連結

指定用於儲存會話的類別。可能的值為 `:cache_store`、`:cookie_store`、`:mem_cache_store`、自定義儲存或 `:disabled`。`:disabled` 告知 Rails 不要處理會話。

其他選項將被設定為 `session_options`

config.session_store :cookie_store, key: "_your_app_session"
config.session_options # => {key: "_your_app_session"}

如果自定義儲存被指定為符號，它將被解析為 `ActionDispatch::Session` 命名空間

# use ActionDispatch::Session::MyCustomStore as the session store
config.session_store :my_custom_store

來源：顯示 | 在 GitHub 上

# File railties/lib/rails/application/configuration.rb, line 541
def session_store(new_session_store = nil, **options)
  if new_session_store
    @session_store = new_session_store
    @session_options = options || {}
  else
    case @session_store
    when :disabled
      nil
    when Symbol
      ActionDispatch::Session.resolve_store(@session_store)
    else
      @session_store
    end
  end
end

類別 Rails::Application::Configuration < Rails::Engine::Configuration

屬性

類別公開方法

new(*) 連結

實例公開方法

annotations（註釋）() 連結

api_only=（僅限 API）(value) 連結

autoload_lib（自動載入 lib）(ignore:) 連結

autoload_lib_once（自動載入 lib 一次）(ignore:) 連結

colorize_logging（日誌著色）() 連結

colorize_logging=（設定日誌著色）(val) 連結

content_security_policy（內容安全策略）(&block) 連結

database_configuration（資料庫配置）() 連結

debug_exception_response_format（除錯例外回應格式）() 連結

default_log_file（預設日誌檔案）() 連結

enable_reloading(啟用重新載入)() 連結

enable_reloading=（設定啟用重新載入）(value) 連結

encoding=（設定編碼）(value) 連結

load_defaults（載入預設值）(target_version) 連結

log_level=（設定日誌級別）(level) 連結

paths（路徑）() 連結

permissions_policy（權限策略）(&block) 連結

reloading_enabled?（重新載入已啟用？）() 連結

secret_key_base（密鑰基底）() 連結

secret_key_base=（設定密鑰基底）(new_secret_key_base) 連結

session_store（會話儲存）(new_session_store = nil, **options) 連結