From 327e005bc89637211d90e38f5de2ff0dd247bffe Mon Sep 17 00:00:00 2001 From: tzadmin Date: Mon, 8 Dec 2025 15:48:42 -0800 Subject: [PATCH] Add README.md --- README.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..0da28d8 --- /dev/null +++ b/README.md @@ -0,0 +1,42 @@ +🛠️ System Reference Card +Access: + +Web UI: https://config.tierzero.net + +Admin Repo (NOC): rancid-admin (Edit noc_devices.tcl here) + +Configs Repo: devices (View backups here) + +Key File Locations (Server): + +RANCID Config: /etc/rancid/rancid.conf + +Device Type Overrides: /etc/rancid/rancid.types.conf (Where we defined cisco-clean) + +Credentials (Encrypted 600): /var/lib/rancid/rancid_login_rules.tcl + +Sync Script: /usr/local/bin/update-rancid-config.sh + +Gitea Config: /etc/gitea/app.ini + +Logs: + +Sync Log: /var/log/rancid/rancid-sync.log + +RANCID Logs: /var/log/rancid/ + +Troubleshooting Commands: + +Force Sync from Gitea: sudo /usr/local/bin/update-rancid-config.sh + +Force Backup Run: sudo -u rancid /usr/lib/rancid/bin/rancid-run + +Test Login/Credentials: sudo -u rancid /usr/lib/rancid/bin/clogin + +Debug a Device Parse: sudo -u rancid /usr/lib/rancid/bin/rancid -d -t cisco-clean + +Automation: + +Cron: Runs every 15 mins (Sync) and Hourly (Backup). + +Log Rotation: Configured in /etc/logrotate.d/rancid-sync. \ No newline at end of file