Update README.md

This commit is contained in:
Tanner Van Teeffelen 2026-05-08 16:21:43 -04:00
parent 249114fe2d
commit bfd8e4fa36

View file

@ -1,11 +1,34 @@
# MerakiApiUtilities
# Meraki API Utilities
.ENV file required to run both scripts.
## Configuration
ENV Variables:
This project requires a `.env` file to run both scripts.
- **API_KEY** = Your Meraki API key to access your Meraki networks.
- **SMTP_SERVER** = Your outgoing SMTP mail server.
- **SMTP_PORT** = Your outgoing SMTP mail port.
- **SMTP_EMAIL** = Your outgoing SMTP email address.
- **SMTP_PASS** = Your outgoing SMTP email password.
---
## Environment Variables
The following environment variables must be defined in your `.env` file:
- **API_KEY**
Your Cisco Meraki API key used to access and manage Meraki networks.
- **SMTP_SERVER**
Your outgoing SMTP mail server address.
- **SMTP_PORT**
Your outgoing SMTP mail server port.
- **SMTP_EMAIL**
The email address used to send notifications.
- **SMTP_PASS**
The password for the SMTP email account.
---
## Notes
- Ensure the `.env` file is stored securely and is not committed to version control.
- Verify that the API key has the required permissions for your intended operations.
- SMTP credentials should be for a dedicated service account where possible.