Skip to content

docs: clarify env file placeholders and safety notes #633

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
AndersonUece wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: clarify env file placeholders and safety notes #633

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions docs/env-safety.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Environment File Safety Notes

This project uses an `.env` file for local deployment and scripts.

## Keep placeholders empty
These should remain empty in templates and examples:
- `DEPLOYER_PRIVATE_KEY=`
- any production keys or credentials

## Required fields (local runs)
Fill these for local/test usage:
- `PROXY_ADMIN_ADDRESS=...`
- `OWNER_ADDRESS=...`
- `MASTER_MINTER_OWNER_ADDRESS=...`

## Recommended workflow
1. Copy the template to `.env`
2. Fill only test values
3. Confirm `.env` is gitignored
4. Double-check with `git diff` before commit