Як вирішити помилку "Відсутня" секретна_відна_база` для середовища "виробництва" (Rails 4.1)

Я створив додаток Rails, використовуючи Rails 4.1, з нуля, і я стикаюся з дивною проблемою, яку я не в змозі вирішити.

Кожен раз, коли я намагаюся розгорнути свою програму на Heroku, я отримую помилку 500:

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

secret.ymlФайл містить наступну конфігурацію:

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

На Heroku я налаштував SECRET_KEY_BASEзмінну середовища " " з результатом rake secretкоманди. Якщо я запускаю heroku config, я можу побачити змінну з правильним ім'ям та значенням.

Чому я все-таки отримую цю помилку?

У мене була така ж проблема, і я вирішив її, створивши змінну середовища, яку потрібно завантажувати щоразу, коли я входив на сервер виробництва, і робив міні-посібник із кроків, щоб налаштувати її:

Я використовував Rails 4.1 з Unicorn v4.8.2, і коли я намагався розгорнути свою програму, вона не запустилася належним чином, і у unicorn.logфайлі я знайшов це повідомлення про помилку:

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

Після деяких досліджень я з'ясував, що Rails 4.1 змінив спосіб управління secret_key, тому якщо ви прочитаєте secrets.ymlфайл, розташований у exampleRailsProject/config/secrets.ymlвас, ви знайдете щось подібне:

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

Це означає, що Rails рекомендує використовувати змінну середовища для на secret_key_baseсвоєму виробничому сервері. Для вирішення цієї помилки слід виконати наступні кроки для створення змінної середовища для Linux (у моєму випадку Ubuntu) на виробничому сервері:

1. У терміналі вашого виробничого сервера виконайте:

   $ RAILS_ENV=production rake secret

   Це повертає великий рядок з літерами та цифрами. Скопіюйте те, що ми будемо називати цим кодом GENERATED_CODE.

2. Увійдіть на свій сервер

   • Якщо ви ввійшли як користувач root, знайдіть цей файл і відредагуйте його:

     $ vi /etc/profile

     Перейдіть до нижньої частини файлу, використовуючи Shift+ G(з великої літери "G") in vi.

     Напишіть змінну вашого середовища клавішею GENERATED_CODE, натиснувши, iщоб вставити в vi. Не забудьте бути в новому рядку в кінці файлу:

     $ export SECRET_KEY_BASE=GENERATED_CODE

     Збережіть зміни та закрийте файл за допомогою, Escа потім " :x" і Enterдля збереження та виходу у vi.

   • Але якщо ви ввійдете як звичайний користувач, давайте назвемо це " example_user" для цього суті, вам потрібно буде знайти один з цих інших файлів:

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

     Ці файли мають порядок важливості, а це означає, що якщо у вас перший файл, вам не потрібно буде редагувати інші. Якщо ви знайшли ці два файли у своєму каталозі, ~/.bash_profileі ~/.profileвам доведеться писати лише в першому ~/.bash_profile, оскільки Linux прочитає лише цей, а другий буде проігноровано.

     Потім ми переходимо до нижньої частини файлу, використовуючи Shift+ Gще раз, і записуємо змінну середовища з нашим повторним GENERATED_CODEвикористанням i, і обов'язково додаємо новий рядок в кінці файлу:

     $ export SECRET_KEY_BASE=GENERATED_CODE

     Написавши код, збережіть зміни та закрийте файл, використовуючи Escзнову і " :x", а Enterтакож збережіть та вийдіть.

3. Ви можете переконатися, що наша змінна середовище правильно встановлена ​​в Linux за допомогою цієї команди:

   $ printenv | grep SECRET_KEY_BASE

   або з:

   $ echo $SECRET_KEY_BASE

   Коли ви виконаєте цю команду, якщо все пішло нормально, воно покаже вам GENERATED_CODEраніше. Нарешті, після всієї конфігурації ви зможете без проблем розгортати свою програму Rails з Unicorn або іншим інструментом.

Коли ви закриєте свою оболонку та знову ввійдете на сервер виробництва, ви встановите цю змінну середовища та будете готові її використовувати.

І це все! Сподіваюся, цей міні-посібник допоможе вам вирішити цю помилку.

Відмова: Я не гуру Linux або Rails, тому якщо ви знайдете щось не так або будь-яку помилку, я буду радий це виправити.

Я припускаю, що у вас немає secrets.ymlперевіреного контролю джерела (тобто це у .gitignoreфайлі). Навіть якщо це не ваша ситуація, це зробили багато інших людей, які переглядають це питання, оскільки їх код виставлений на Github і не хочуть, щоб їх секретний ключ плавав навколо.

Якщо це не в контролі джерел, Героку про це не знає. Таким чином, Rails шукає, Rails.application.secrets.secret_key_baseі він не був встановлений, тому що Rails встановлює його, перевіряючи secrets.ymlфайл, який не існує. Простий спосіб вирішити - увійти у config/environments/production.rbфайл і додати наступний рядок:

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

Це повідомляє вашій програмі встановити секретний ключ за допомогою змінної середовища, а не шукати його secrets.yml. Це врятувало б мені багато часу, щоб знати це наперед.

Додати config/secrets.ymlдо контролю версій та знову розгорнути. Можливо, вам доведеться видалити рядок, .gitignoreщоб ви могли зробити файл.

У мене був такий самий випуск, і якраз виявилося, що котловарка .gitignoreGithub, створена для моєї програми Rails, включена config/secrets.yml.

Це працювало для мене.

SSH у ваш виробничий сервер та cdу поточний каталог, запустіть bundle exec rake secretабо rake secret, ви отримаєте довгу рядок як вихід, скопіюйте цей рядок.

Тепер біжи sudo nano /etc/environment.

Вставте внизу файлу

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

Де rake secretзнаходиться рядок, який ви щойно скопіювали, замість нього вставте скопійований рядок rake secret.

Перезавантажте сервер і протестуйте, запустивши echo $SECRET_KEY_BASE.

Хоча ви можете використовувати ініціалізатори, як і інші відповіді, звичайним способом Rails 4.1+ є використання config/secrets.yml. Причина, щоб команда Rails представила це, виходить за межі цієї відповіді, але TL; DR полягає в тому, що secret_token.rbконфігурує конфігурацію та код, а також є ризиком для безпеки, оскільки маркер перевіряється в історію управління джерелами і єдина система, якій потрібно знати виробничий секретний знак - це виробнича інфраструктура.

Ви повинні додати цей файл .gitignoreтак, як ви також не додали його config/database.ymlдо джерела управління.

Посилаючись на власний код Heroku для налаштування config/database.ymlз DATABASE_URLйого Buildpack для Ruby , я закінчив форкінг їх репо і змінив його, щоб створити config/secrets.ymlз SECRETS_KEY_BASEзмінної середовища.

Оскільки ця функція була введена в Rails 4.1, я вважав за доцільне відредагувати ./lib/language_pack/rails41.rbта додати цю функціональність.

Нижче наведено фрагмент модифікованого buildpack, який я створив у своїй компанії:

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

Звичайно, ви можете розширити цей код, щоб додати інші секрети (наприклад, сторонні ключі API тощо), які слід зчитувати зі змінної вашого середовища:

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

Таким чином, ви можете отримати доступ до цієї таємниці дуже стандартним способом:

Rails.application.secrets.third_party_api_key

Перш ніж перерозподілити додаток, не забудьте спочатку встановити змінну середовища:

Потім додайте модифікований пакунок збірки (або ви більше ніж ласкаво просимо зв’язатись з моїм) у свій додаток Heroku (див. Документацію Heroku ) та переустановіть свою програму.

Пакет нарощування автоматично створить вашу config/secrets.ymlзі змінної середовища як частину процесу складання dyno кожного разу, коли ви перейдете git pushна Heroku.

EDIT: Власна документація Heroku пропонує створити config/secrets.ymlдля читання з змінної середовища, але це означає, що ви повинні перевірити цей файл у контролі джерела. У моєму випадку це не працює добре, оскільки у мене є жорсткі секрети для розробки та тестування середовищ, які я краще не перевіряю.

Ви можете експортувати секретні ключі як змінні середовища на ~/.bashrcабо ~/.bash_profileна вашому сервері:

export SECRET_KEY_BASE = "YOUR_SECRET_KEY"

І потім, ви можете вихідний код свого .bashrcабо .bash_profile:

source ~/.bashrc 
source ~/.bash_profile

Ніколи не вчиняйте свої секрети.yml

У моєму випадку проблема полягала в тому, що це config/master.keyбуло не в контролі версій, і я створив проект на іншому комп’ютері.

Файл .gitignore, створений Rails, виключає цей файл. Оскільки неможливо розгортати без цього файлу, він повинен знаходитись у контролі версій, щоб мати змогу розгортатися з комп’ютера будь-якого члена команди.

Рішення: видаліть config/master.keyрядок .gitignore, зафіксуйте файл із комп'ютера, на якому створено проект, і тепер ви можете git pullна іншому комп’ютері та розгорнути з нього.

Люди говорять не привласнювати деякі з цих файлів до контролю версій, не пропонуючи альтернативного рішення. Поки ви не працюєте над проектом з відкритим кодом, я не бачу причин не здійснювати все, що потрібно для запуску проекту, включаючи облікові дані.

Для rails6 я зіткнувся з тією ж проблемою, оскільки мені не вистачало наступних файлів, коли я їх додав, проблема вирішена:

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

Переконайтеся, що у вас є ці файли. !!!

Що я зробив: на своєму виробничому сервері я створюю конфігураційний файл (confthin.yml) для Thin (я його використовую) і додаю таку інформацію:

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

Потім я запускаю додаток за допомогою

thin start -C /whereeveristhefieonprod/configthin.yml

Працюйте як шарм, і тоді не потрібно мати секретний ключ для контролю версій

Сподіваюся, це могло б допомогти, але я впевнений, що те саме можна було б зробити і з Єдинорогом та іншими.

У мене є патч, який я використовував у додатку Rails 4.1, щоб дозволити мені продовжувати використовувати застарілий генератор ключів (і, отже, сумісність сеансу назад з Rails 3), дозволяючи порожній секретний_кідок_бази.

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

З тих пір я переформатував патч, подаю його до Rails як запит на витягнення

Я створив config/initializers/secret_key.rbфайл і написав лише наступний рядок коду:

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

Але я думаю, що рішення, розміщене @Erik Trautman, є більш елегантним;)

Редагувати: О, і нарешті я знайшов цю пораду на Heroku: https://devcenter.heroku.com/changelog-items/426 :)

Насолоджуйтесь!

це добре працює https://gist.github.com/pablosalgadom/4d75f30517edc6230a67 для користувача root має редагувати

$ /etc/profile

але якщо ви не кореневі, слід поставити код генерації у наступному

$ ~/.bash_profile

$ ~/.bash_login

$ ~/.profile

На Nginx / Пасажирський / Рубін (2.4) / Рейки (5.1.1) нічого іншого не працювало, крім:

passenger_env_varв /etc/nginx/sites-available/defaultблоці сервера.

Джерело: https://www.phusionpassenger.com/library/config/nginx/reference/#passenger_env_var

Відповідь Демі Магус працювала на мене до Рейки 5.

На Apache2 / Пасажир / Рубін (2.4) / Рейки (5.1.6) мені довелося покласти

export SECRET_KEY_BASE=GENERATED_CODE

відповідь Демі Магуса в / etc / apache2 / envvars, здається, що причина / etc / profile ігнорується.

Джерело: https://www.phusionpassenger.com/library/indepth/environment_variables.html#apache

У мене була така ж проблема після використання файлу .gitignore з https://github.com/github/gitignore/blob/master/Rails.gitignore

Все склалося добре після того, як я прокоментував наступні рядки у файлі .gitignore.

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