# START HERE 👋

Welcome to ADMS Local Sync Agent!

## 🚀 Quick Start (Choose Your Platform)

### Windows
1. Extract folder
2. Double-click `setup.bat`
3. Edit `sync_agent_config.json`
4. Run: `python sync_agent.py`

### Ubuntu/Linux (24.04+)
1. Extract folder
2. Run: `./setup.sh`
3. Edit `sync_agent_config.json`
4. Run: `python3 sync_agent.py`

### Mac
1. Extract folder
2. Run: `./setup.sh`
3. Edit `sync_agent_config.json`
4. Run: `python3 sync_agent.py`

---

## 📚 Documentation Guide

### Getting Started
- **QUICK_START.md** - 5-minute setup (fastest!)
- **README.md** - Complete overview

### Platform-Specific
- **UBUNTU_SETUP.md** - Ubuntu 24.04+ guide (if on Ubuntu!)
- **TROUBLESHOOTING.md** - Common errors & fixes

### Advanced
- **PASSWORD_GUIDE.md** - Device password configuration
- **config.examples.json** - Example configurations

---

## ⚠️ Ubuntu 24.04+ Users - READ THIS!

If you get this error:
```
error: externally-managed-environment
```

**Solution:**
```bash
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
```

👉 **See [UBUNTU_SETUP.md](UBUNTU_SETUP.md) for details**

---

## 📋 First Steps

1. **Download & Extract** this folder
2. **Read** one of these (pick your platform):
   - Windows: Run `setup.bat`
   - Ubuntu/Mac: Run `./setup.sh`
3. **Edit** `sync_agent_config.json` with your cloud URL
4. **Test** with: `python3 sync_agent.py --device 192.168.1.100`
5. **Deploy** as background service

---

## 🔧 File Overview

| File | Purpose |
|------|---------|
| **sync_agent.py** | Main Python app (523 lines) |
| **requirements.txt** | Python dependencies |
| **setup.sh** | Linux/Mac auto setup |
| **setup.bat** | Windows auto setup |
| **QUICK_START.md** | 5-minute guide |
| **README.md** | Complete overview |
| **UBUNTU_SETUP.md** | Ubuntu 24.04+ fix |
| **PASSWORD_GUIDE.md** | Device password setup |
| **TROUBLESHOOTING.md** | Common errors |
| **config.examples.json** | Configuration examples |
| **.gitignore** | Git ignore rules |

---

## 🎯 Features

✅ Device password support  
✅ Auto-discovery  
✅ Works through firewalls  
✅ Logs everything  
✅ Easy configuration  
✅ Runs in background  
✅ Multi-location support  

---

## 💡 Tips

- **On Ubuntu 24.04+?** See UBUNTU_SETUP.md first!
- **Got an error?** Check TROUBLESHOOTING.md
- **Need passwords?** See PASSWORD_GUIDE.md
- **Want examples?** See config.examples.json

---

## 📞 Support

1. Check TROUBLESHOOTING.md for your error
2. Read the platform-specific guide (UBUNTU_SETUP.md, etc.)
3. Review configuration examples
4. Check logs: `tail -f logs/sync_agent_*.log`

---

## 📦 What's in This Package

**Everything you need:**
- ✓ Ready-to-run Python application
- ✓ Auto setup scripts for your platform
- ✓ Complete documentation (5 guides)
- ✓ Configuration examples
- ✓ Troubleshooting guide
- ✓ Ubuntu 24.04+ fix

**Total size:** 80 KB  
**No external downloads needed** (except Python packages)

---

## ✨ Next Step

👉 **Run setup for your platform:**

Windows:
```
setup.bat
```

Linux/Mac:
```
./setup.sh
```

Then edit `sync_agent_config.json` with your cloud URL!

---

**Ready?** Let's sync those users! 🚀