Skip to main content

​
Соглашения для плейсхолдеров секретов

Используйте плейсхолдеры, которые понятны человеку, но не похожи на настоящие секреты.

​
Рекомендуемый стиль

  • Предпочитайте описательные значения вроде example-openai-key-not-real или example-discord-bot-token.
  • В фрагментах shell предпочитайте ${OPENAI_API_KEY} вместо встроенных строк, похожих на токены.
  • Оставляйте примеры очевидно ненастоящими и ограниченными назначением (провайдер, канал, тип аутентификации).

​
Избегайте этих шаблонов в документации

  • Буквальный текст заголовка или окончания приватного ключа PEM.
  • Префиксы, похожие на действительные учетные данные, например sk-..., xoxb-..., AKIA....
  • Похожие на настоящие bearer-токены, скопированные из runtime-журналов.

​
Пример

# Хорошо
export OPENAI_API_KEY="example-openai-key-not-real"

# Лучше (когда документ о подключении env)
export OPENAI_API_KEY="${OPENAI_API_KEY}"