“'Üretim' ortamı için eksik 'secret_key_base` hatası nasıl giderilir (Rails 4.1)

Rails 4.1'i kullanarak sıfırdan bir Rails uygulaması oluşturdum ve çözemediğim garip bir sorunla karşılaşıyorum.

Uygulamamı Heroku üzerinde dağıtmaya çalıştığımda 500 hatası alıyorum:

Missing `secret_key_base` for 'production' environment, set this value in `config/secrets.yml`

secret.ymlDosya aşağıdaki yapılandırmayı içerir:

secret_key_base: <%= ENV["SECRET_KEY_BASE"] %>

Heroku'da " SECRET_KEY_BASE" ortam değişkenini rake secretkomutun sonucuyla yapılandırdım . Başlatılırsam heroku configdeğişkeni doğru ad ve değerle görebilirim.

Neden hala bu hatayı alıyorum?

Aynı sorunu yaşadım ve üretim sunucusuna her giriş yaptığımda yüklenecek bir ortam değişkeni oluşturarak çözdüm ve yapılandırmak için adımların bir mini kılavuzunu yaptım:

Unicorn v4.8.2 ile Rails 4.1 kullanıyordum ve uygulamamı dağıtmaya çalıştığımda düzgün başlamadı ve unicorn.logdosyada bu hata mesajını buldum:

app error: Missing `secret_key_base` for 'production' environment, set this value in `config/secrets.yml` (RuntimeError)

Biraz araştırma yaptıktan sonra, Rails 4.1'in yönetim yolunu değiştirdiğini öğrendim secret_key, bu nedenle secrets.ymlbulunan dosyayı okursanız şöyle bir exampleRailsProject/config/secrets.ymlşey bulacaksınız:

# Do not keep production secrets in the repository,
# instead read values from the environment.
production:
  secret_key_base: <%= ENV["SECRET_KEY_BASE"] %>

Bu, Rails'in secret_key_baseüretim sunucunuzdaki ortam değişkenini kullanmanızı tavsiye ettiği anlamına gelir . Bu hatayı çözmek için üretim sunucunuzda Linux (benim durumumda Ubuntu) için bir ortam değişkeni oluşturmak üzere şu adımları izlemelisiniz:

1. Üretim sunucunuzun terminalinde şunları yürütün:

   $ RAILS_ENV=production rake secret

   Bu, harf ve rakam içeren büyük bir dize döndürür. Kodu kopyalayacağız, ki bu koddan bahsedeceğiz GENERATED_CODE.

2. Sunucunuza giriş yapın

   • Kök kullanıcı olarak oturum açarsanız, bu dosyayı bulun ve düzenleyin:

     $ vi /etc/profile

     Vi'de Shift+ G(büyük harf "G") kullanarak dosyanın altına gidin .

     Vi değişkenini eklemek için GENERATED_CODEtuşuna basarak ortam değişkeninizi yazın i. Dosyanın sonunda yeni bir satırda olduğunuzdan emin olun:

     $ export SECRET_KEY_BASE=GENERATED_CODE

     Değişiklikleri kaydedin Escve sonra " :x" ile dosyayı kapatın ve Entervi'da kaydedip çıkın.

   • Ancak normal kullanıcı olarak giriş yaparsanız, example_userbu öz için " " diyelim , şu diğer dosyalardan birini bulmanız gerekecek:

     $ vi ~/.bash_profile
     $ vi ~/.bash_login
     $ vi ~/.profile

     Bu dosyalar önem sırasına göre sıralanır, yani ilk dosyanız varsa, diğerlerini düzenlemenize gerek yoktur. Bu iki dosyayı dizininizde bulduysanız ~/.bash_profileve ~/.profileyalnızca birincisinde yazmak zorunda kalırsanız ~/.bash_profile, çünkü Linux yalnızca bunu okuyacak ve diğeri yok sayılacaktır.

     Sonra tekrar Shift+ kullanarak dosyanın altına gidip Gtekrar GENERATED_CODEkullanarak bizim ortam değişkenini yazıyoruz ive dosyanın sonuna yeni bir satır eklediğinizden emin olun:

     $ export SECRET_KEY_BASE=GENERATED_CODE

     Kodu yazdıktan sonra, değişiklikleri kaydedin ve dosyayı Esctekrar kapatın ve " :x" Enterile kaydedin ve çıkın.

3. Ortam değişkenimizin Linux'ta bu komutla düzgün şekilde ayarlandığını doğrulayabilirsiniz:

   $ printenv | grep SECRET_KEY_BASE

   veya:

   $ echo $SECRET_KEY_BASE

   Bu komutu yürüttüğünüzde, her şey yolunda giderse size daha GENERATED_CODEönce gösterecektir . Son olarak, tüm konfigürasyon tamamlandığında, Rails uygulamanızı Unicorn veya başka bir araçla sorunsuz bir şekilde dağıtabilirsiniz.

Kabuğunuzu kapatıp tekrar üretim sunucusuna giriş yaptığınızda, bu ortam değişkenini ayarlamış ve kullanmaya hazır olacaksınız.

Ve bu kadar! Umarım bu mini kılavuz bu hatayı çözmenize yardımcı olur.

Yasal Uyarı: Ben bir Linux ya da Rails gurusu değilim, bu yüzden yanlış bir şey ya da herhangi bir hata bulursanız düzeltmekten memnuniyet duyarız.

Ben secrets.ymlkontrol kaynak kontrol (yani .gitignoredosyada) olmadığını varsayalım . Bu sizin durumunuz olmasa bile, bu soruyu görüntüleyen diğer birçok kişi yapmıştır, çünkü kodları Github'da açıktadır ve gizli anahtarlarının etrafında dolaşmasını istemezler.

Kaynak kontrolünde değilse, Heroku bunu bilmiyor. Bu yüzden Rails arıyor Rails.application.secrets.secret_key_baseve ayarlanmadı çünkü Rails secrets.ymlmevcut olmayan dosyayı kontrol ederek ayarlıyor . Basit çözüm, config/environments/production.rbdosyanıza gidip aşağıdaki satırı eklemektir:

Rails.application.configure do
    ...
    config.secret_key_base = ENV["SECRET_KEY_BASE"]
    ...
end

Bu, uygulamanıza gizli anahtarı aramak yerine ortam değişkenini kullanarak ayarlamasını söyler secrets.yml. Bunu önceden tanımak bana çok zaman kazandıracaktı.

config/secrets.ymlSürüm kontrolüne ekleyin ve tekrar konuşlandırın. 'Den bir satırı kaldırmanız gerekebilir.gitignoreDosyayı işleyebilmeniz için .

Aynı sorunu yaşadım ve .gitignoreRails uygulamam için oluşturulan ortak Github'un dahil olduğu ortaya çıktı config/secrets.yml.

Bu benim için çalıştı.

SSH'yi üretim sunucunuza ve cdgeçerli dizininize, çalıştırın bundle exec rake secretveyarake secret çıktı olarak uzun bir dize alırsınız, bu dizeyi kopyalayın.

Şimdi koş sudo nano /etc/environment .

Dosyanın altına yapıştır

export SECRET_KEY_BASE=rake secret
ruby -e 'p ENV["SECRET_KEY_BASE"]'

rake secretKopyaladığınız dize nerede , kopyalanan dizeyi yerine yapıştırınrake secret .

Sunucuyu yeniden başlatın ve çalıştırarak test edin echo $SECRET_KEY_BASE.

Başlatıcıları diğer yanıtlar gibi kullanabilirsiniz, ancak geleneksel Rails 4.1+ yolu config/secrets.yml. Rails ekibinin bunu tanıtmasının nedeni bu cevabın kapsamı dışındadır, ancak TL; DR, secret_token.rbtoken kaynak kontrol geçmişine ve ihtiyaç duyulan tek sisteme kontrol edildiğinden, bir güvenlik riski olmanın yanı sıra konfigürasyon ve kodu da birleştirir. üretim gizli belirtecinin üretim altyapısı olduğunu bilir.

Bu dosyayı , kaynak denetimine .gitignoreeklemeyeceğiniz gibi eklemelisiniz config/database.yml.

Kurma Heroku kendi kodunu referans config/database.ymlgelen DATABASE_URLkendi içinde Ruby Buildpack , ben bitti onların repo bölmek ve oluşturmak için modifiye config/secrets.ymlgelen SECRETS_KEY_BASEortam değişkeni.

Bu özellik Rails 4.1'de tanıtıldığından, ./lib/language_pack/rails41.rbbu işlevselliği düzenlemenin ve eklemenin uygun olduğunu hissettim .

Şirketimde oluşturduğum değiştirilmiş yapı paketindeki snippet :

class LanguagePack::Rails41 < LanguagePack::Rails4

  # ...

  def compile
    instrument "rails41.compile" do
      super
      allow_git do
        create_secrets_yml
      end
    end
  end

  # ...

  # writes ERB based secrets.yml for Rails 4.1+
  def create_secrets_yml
    instrument 'ruby.create_secrets_yml' do
      log("create_secrets_yml") do
        return unless File.directory?("config")
        topic("Writing config/secrets.yml to read from SECRET_KEY_BASE")
        File.open("config/secrets.yml", "w") do |file|
          file.puts <<-SECRETS_YML
<%
raise "No RACK_ENV or RAILS_ENV found" unless ENV["RAILS_ENV"] || ENV["RACK_ENV"]
%>

<%= ENV["RAILS_ENV"] || ENV["RACK_ENV"] %>:
  secret_key_base: <%= ENV["SECRET_KEY_BASE"] %>
          SECRETS_YML
        end
      end
    end
  end

  # ...

end

Elbette bu kodu, ortam değişkeninizden okunacak diğer sırları (örn. Üçüncü taraf API anahtarları, vb.) Eklemek için genişletebilirsiniz:

...
<%= ENV["RAILS_ENV"] || ENV["RACK_ENV"] %>:
  secret_key_base: <%= ENV["SECRET_KEY_BASE"] %>
  third_party_api_key: <%= ENV["THIRD_PARTY_API"] %>

Bu şekilde, bu sırra çok standart bir şekilde erişebilirsiniz:

Rails.application.secrets.third_party_api_key

Uygulamanızı yeniden konuşlandırmadan önce ortam değişkeninizi ayarladığınızdan emin olun:

Ardından, değiştirilmiş derleme paketinizi (veya benimkine bağlanmaktan daha fazlası) Heroku uygulamanıza ekleyin (Heroku'nun belgelerine bakın) ) ve uygulamanızı yeniden konuşlandırın.

Buildpack, Heroku'ya config/secrets.ymlher gittiğinizde dyno oluşturma işleminin bir parçası olarak ortam değişkeninizden otomatik olarak oluşturur git push.

EDIT: Heroku'nun kendi belgelericonfig/secrets.yml , ortam değişkeninden okumak için oluşturmayı önerir , ancak bu, bu dosyayı kaynak denetiminde denetlemeniz gerektiği anlamına gelir. Benim durumumda, kontrol etmek istemediğim geliştirme ve test ortamları için sabit kodlu sırlarım olduğundan bu iyi çalışmıyor.

Gizli anahtarları sunucunuzda ~/.bashrcveya ~/.bash_profilesunucunuzda ortam değişkenleri olarak dışa aktarabilirsiniz :

export SECRET_KEY_BASE = "YOUR_SECRET_KEY"

Ve sonra, kaynak olabilir .bashrcya .bash_profile:

source ~/.bashrc 
source ~/.bash_profile

Sırlarınızı asla taahhüt etmeyin.

Benim durumumda, sorun config/master.keysürüm kontrolünde değildi ve projeyi farklı bir bilgisayarda yaratmıştım.

Rails tarafından oluşturulan varsayılan .gitignore bu dosyayı içermez. Bu dosya olmadan dağıtım yapmak imkansız olduğu için, herhangi bir ekip üyesinin bilgisayarından dağıtılabilmesi için sürüm kontrolünde olması gerekir.

Çözüm: config/master.keySatırı buradan kaldırın, .gitignoredosyayı projenin oluşturulduğu bilgisayardan teslim edin ve şimdi git pulldiğer bilgisayarda da dağıtabilirsiniz.

İnsanlar bu dosyaların bir kısmını alternatif bir çözüm sunmadan sürüm kontrolüne tabi tutmamalarını söylüyorlar. Açık kaynaklı bir proje üzerinde çalışmadığınız sürece, kimlik bilgileri de dahil olmak üzere projeyi çalıştırmak için gereken her şeyi yerine getirmemek için hiçbir neden göremiyorum.

Rails6 için, aşağıdaki dosyaları eksik olduğum için aynı sorunla karşı karşıya kaldım, onları ekledikten sonra sorun çözüldü:

1. config/master.key
2. config/credentials.yml.enc

Bu dosyalara sahip olduğunuzdan emin olun. !!!

Ne yaptım: Üretim sunucumda, Thin (kullanıyorum) için bir yapılandırma dosyası (confthin.yml) oluşturuyorum ve aşağıdaki bilgileri ekliyorum:

environment: production
user: www-data
group: www-data
SECRET_KEY_BASE: mysecretkeyproduction

Daha sonra uygulamayı

thin start -C /whereeveristhefieonprod/configthin.yml

Bir cazibe gibi çalışın ve daha sonra sürüm kontrolünde gizli anahtara gerek yok

Umarım yardımcı olabilir, ama eminim aynı şey Unicorn ve diğerleri için de yapılabilir.

Secret_key_base boş olmasına izin vererek, eski anahtar üreteci kullanmaya devam etmek için bir Rails 4.1 uygulamasında kullandığım bir yama var (ve bu nedenle Rails 3 ile geriye doğru uyumluluk).

Rails::Application.class_eval do
  # the key_generator will then use ActiveSupport::LegacyKeyGenerator.new(config.secret_token)
  fail "I'm sorry, Dave, there's no :validate_secret_key_config!" unless instance_method(:validate_secret_key_config!)
  def validate_secret_key_config! #:nodoc:
    config.secret_token = secrets.secret_token
    if config.secret_token.blank?
      raise "Missing `secret_token` for '#{Rails.env}' environment, set this value in `config/secrets.yml`"
    end 
  end 
end

O zamandan beri yamayı yeniden biçimlendirdim, Çekme Talebi olarak Rails'e gönderdim

config/initializers/secret_key.rbDosya oluşturdum ve sadece aşağıdaki kod satırını yazdım:

Rails.application.config.secret_key_base = ENV["SECRET_KEY_BASE"]

Ama @Erik Trautman tarafından gönderilen çözümün daha zarif olduğunu düşünüyorum ;)

Edit: Oh, ve sonunda bu tavsiyeyi Heroku'da buldum: https://devcenter.heroku.com/changelog-items/426 :)

Zevk almak!

Bu iyi çalışır https://gist.github.com/pablosalgadom/4d75f30517edc6230a67 kök kullanıcı için düzenlemelisiniz

$ /etc/profile

ama eğer root olmayan ise aşağıdaki kodu oluşturma kodunu

$ ~/.bash_profile

$ ~/.bash_login

$ ~/.profile

Nginx / Passenger / Ruby (2.4) / Rails (5.1.1) üzerinde aşağıdakiler dışında hiçbir şey işe yaramadı:

passenger_env_variçinde /etc/nginx/sites-available/defaultsunucu bloğunda.

Kaynak: https://www.phusionpassenger.com/library/config/nginx/reference/#passenger_env_var

Demi Magus'un cevabı Rails 5'e kadar benim için çalıştı.

Apache2 / Yolcu / Yakut (2.4) / Raylar (5.1.6) üzerine,

export SECRET_KEY_BASE=GENERATED_CODE

/ etc / apache2 / envvars'daki Demi Magus cevabından, / etc / profile neden yok sayılıyor gibi görünüyor.

Kaynak: https://www.phusionpassenger.com/library/indepth/environment_variables.html#apache

Https://github.com/github/gitignore/blob/master/Rails.gitignore adresinden .gitignore dosyasını kullandıktan sonra aynı sorunu yaşadım.

.Gitignore dosyasında aşağıdaki satırları yorumladıktan sonra her şey iyi çalıştı.

config/initializers/secret_token.rb
config/secrets.yml