Skip to main content

Guides

How-to guides and best practices for using EnvCat effectively.

Available Guides​

Detailed guides will be added during M1-M3 implementation. For now, start with the Getting Started guide.

Getting Started​

  • Installation - Set up EnvCat using Docker Compose
  • First Run - Create your first bundle and request secrets

Planned Guides (M1-M3)​

The following guides will be created during feature implementation:

Bundle Management​

  • Creating and Organizing Bundles - Best practices for bundle naming and organization
  • Importing from .env Files - Migrate existing secrets to EnvCat
  • Exporting Bundles - Backup and share bundle data
  • Managing Bundle Items - Add, update, and delete environment variables

CLI Usage​

  • Shell Integration - Add EnvCat to your shell profile
  • Multi-Environment Workflows - Switch between dev/staging/prod
  • Team Collaboration - Share bundles with your team
  • CI/CD Integration - Use EnvCat in GitHub Actions, GitLab CI, etc.

Security​

  • Rotating Secrets - How to rotate credentials safely
  • Access Control - Who should have access to which bundles (M9+)
  • Audit Trails - Track who accessed what and when (M10+)
  • Git Safety - Prevent accidental secret leaks

Advanced​

  • Custom Output Formats - Write custom formatters
  • Scripting with EnvCat - Automate secret management
  • Performance Optimization - Tips for large bundles
  • Troubleshooting Common Issues - Debug guide

Guide Templates​

Guides follow a consistent structure:

  1. Overview - What you'll learn
  2. Prerequisites - What you need before starting
  3. Steps - Step-by-step instructions
  4. Verification - How to verify it worked
  5. Common Issues - Troubleshooting tips
  6. Next Steps - Related guides

Contributing Guides​

Have a use case or workflow you'd like to share? We welcome guide contributions!

How to contribute:

  1. Fork the repository
  2. Create a guide using the guide template
  3. Submit a pull request

What makes a good guide:

  • Clear problem statement (what you're solving)
  • Step-by-step instructions with code examples
  • Expected outputs at each step
  • Common issues and solutions
  • Real-world use cases

Community Guides​

Coming soon: Community-contributed guides will be featured here.

Feedback​

Found an issue with a guide or have a suggestion? Open an issue on GitHub.

More guides coming during M1-M3 implementation.

For now, start with: