mirror of
https://github.com/wickedyoda/public-setupfiles.git
synced 2026-11-16 13:31:56 -06:00
docs: add READMEs and wiki documentation for all directories
- Add comprehensive wiki documentation under .github/wiki/ (19 articles) - Add READMEs to directories that lacked them - Fix merge conflict markers in existing READMEs - Update root readme.md with improved structure Co-authored-by: Jarvis <jarvis@wickedyoda.local>
This commit is contained in:
1 parent
b40aaf6f0e
commit
0c62f7495a
42 files changed
+4501
-865
No files matched your search
+91
-40
@@ -1,46 +1,97 @@
|
||||
<<<<<<< HEAD
|
||||
# snmp
|
||||
|
||||
## Purpose
|
||||
This directory contains files related to **snmp**.
|
||||
|
||||
## Contents
|
||||
- `setup_snmp_openwrt_v2.sh`
|
||||
- `setup_snmp_openwrt_publicv2.sh`
|
||||
- `setup_snmp_openwrt.sh`
|
||||
- `setup_snmp.sh`
|
||||
- `Setup_snmp_macos.sh`
|
||||
|
||||
## Usage
|
||||
- Review each script or configuration file before running
|
||||
- Some scripts may require **root or sudo**
|
||||
- Paths and variables may need adjustment for your environment
|
||||
|
||||
## Notes
|
||||
- This folder is part of the **public-setupfiles** repository
|
||||
- Files are provided as-is for reference or automation
|
||||
|
||||
## Safety
|
||||
Always back up data before running scripts that modify system state.
|
||||
=======
|
||||
# snmp
|
||||
|
||||
## Overview
|
||||
This directory is part of the **public-setupfiles** repository.
|
||||
It contains scripts, configuration files, or resources related to **snmp**.
|
||||
|
||||
## Usage
|
||||
- Review scripts before execution
|
||||
- Some files may require **root or sudo privileges**
|
||||
- Paths, variables, or credentials may need customization
|
||||
|
||||
## Logging & Output
|
||||
Scripts may generate logs or output files in the same directory or system locations.
|
||||
|
||||
## Safety Notes
|
||||
- Always back up important data before running scripts
|
||||
- Test in a non-production environment when possible
|
||||
- Use at your own risk
|
||||
Scripts for setting up SNMP (Simple Network Management Protocol) monitoring on various platforms.
|
||||
|
||||
---
|
||||
>>>>>>> main
|
||||
|
||||
## Files
|
||||
|
||||
| Script | Platform | Version |
|
||||
|--------|----------|---------|
|
||||
| `setup_snmp.sh` | Linux | SNMPv3 |
|
||||
| `setup_snmp_openwrt.sh` | OpenWrt | SNMPv3 |
|
||||
| `setup_snmp_openwrt_v2.sh` | OpenWrt | SNMPv3 (alternative) |
|
||||
| `setup_snmp_openwrt_publicv2.sh` | OpenWrt | SNMPv2 (public) |
|
||||
| `Setup_snmp_macos.sh` | macOS | SNMPv3 |
|
||||
|
||||
---
|
||||
|
||||
## Linux SNMP Setup
|
||||
|
||||
### `setup_snmp.sh`
|
||||
|
||||
```bash
|
||||
sudo ./snmp/setup_snmp.sh
|
||||
```
|
||||
|
||||
**What it does:**
|
||||
1. Prompts for SNMPv3 credentials
|
||||
2. Installs snmpd and snmp packages
|
||||
3. Configures SNMPv3 with authPriv (MD5+AES)
|
||||
4. Sets up firewall rules
|
||||
5. Starts and enables SNMP service
|
||||
|
||||
**Configures:**
|
||||
- `/etc/snmp/snmpd.conf`
|
||||
- Access restricted to local network
|
||||
|
||||
---
|
||||
|
||||
## OpenWrt SNMP Setup
|
||||
|
||||
### SNMPv3
|
||||
|
||||
```bash
|
||||
ssh root@10.0.84.1
|
||||
# Run on router
|
||||
curl -sSL https://raw.githubusercontent.com/wickedyoda/public-setupfiles/main/snmp/setup_snmp_openwrt.sh | sh
|
||||
```
|
||||
|
||||
**Interactively prompts for:**
|
||||
- SNMPv3 username
|
||||
- Password
|
||||
- System location
|
||||
- System contact
|
||||
|
||||
---
|
||||
|
||||
## macOS SNMP Setup
|
||||
|
||||
### `Setup_snmp_macos.sh`
|
||||
|
||||
```bash
|
||||
# Install dependencies first
|
||||
brew install net-snmp
|
||||
|
||||
# Then run script
|
||||
sudo ./snmp/Setup_snmp_macos.sh
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## SNMP Monitoring
|
||||
|
||||
### Test Connection
|
||||
|
||||
```bash
|
||||
# From remote system
|
||||
snmpwalk -v2c -c public 10.0.84.1 system
|
||||
# Or SNMPv3
|
||||
snmpwalk -v3 -u admin -l authPriv -a MD5 -A "password" \
|
||||
-x AES -X "password" 10.0.84.1 system
|
||||
```
|
||||
|
||||
### Grafana Integration
|
||||
|
||||
Use any Prometheus/Grafana SNMP exporter with the configured community strings.
|
||||
|
||||
---
|
||||
|
||||
## Security
|
||||
|
||||
- Use SNMPv3 with authPriv whenever possible
|
||||
- Restrict SNMP to management network
|
||||
- Change default community strings
|
||||
- Do not expose to the internet
|
||||
Reference in new issue
Block a user