docs: add secrets.yaml.example and gitignore#33
Open
malaiwah wants to merge 1 commit into
Open
Conversation
The YAML uses !secret references for five values (wifi_ssid,
wifi_password, wifi_fallback_password, ota_password,
home_assistant_key) that aren't documented anywhere. New users have
to read the YAML to figure out what to put in secrets.yaml.
Adds:
* secrets.yaml.example with all five required keys, comments
explaining what each one is for, and generation hints for the
OTA / HA Noise keys
* .gitignore covering secrets.yaml and .esphome/ build artifacts
* README pointer to copy the example before flashing
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #32
Adds:
secrets.yaml.examplelisting all five required keys with comments explaining what each is for and how to generate the OTA / Noise keys.gitignorecoveringsecrets.yamland.esphome/build artefactsVerification
esphome configpasses both YAMLs (using a stubsecrets.yamlfilled from the example template)Disclosure
Drafted with Claude (Anthropic). Author-reviewed.