|
| 1 | +# Espilon Documentation |
| 2 | + |
| 3 | +Official documentation for the Espilon ESP32 embedded agent framework. |
| 4 | + |
| 5 | +**Live Documentation**: https://docs.espilon.net |
| 6 | + |
| 7 | +**Main Project**: https://github.com/Espilon-Net |
| 8 | + |
| 9 | +## About |
| 10 | + |
| 11 | +Complete documentation for Espilon, built with [MkDocs](https://www.mkdocs.org/) and the [Material theme](https://squidfunk.github.io/mkdocs-material/). |
| 12 | + |
| 13 | +## Documentation Contents |
| 14 | + |
| 15 | +- **Getting Started**: Installation, quick start, and overview |
| 16 | +- **Hardware**: Supported boards and setup guides |
| 17 | +- **Configuration**: Menuconfig and network settings |
| 18 | +- **Tools**: Flasher and C2 server |
| 19 | +- **Modules**: Command reference and module system |
| 20 | +- **Security**: Best practices and encryption |
| 21 | + |
| 22 | +## Quick Start |
| 23 | + |
| 24 | +### Local Development |
| 25 | + |
| 26 | +```bash |
| 27 | +# Clone |
| 28 | +git clone https://github.com/Espilon-Net/espilon-docs.git |
| 29 | +cd espilon-docs |
| 30 | + |
| 31 | +# Setup |
| 32 | +python3 -m venv venv |
| 33 | +source venv/bin/activate |
| 34 | +pip install -r requirements.txt |
| 35 | + |
| 36 | +# Run |
| 37 | +mkdocs serve |
| 38 | +``` |
| 39 | + |
| 40 | +Documentation available at http://localhost:8000 |
| 41 | + |
| 42 | +### Docker Build |
| 43 | + |
| 44 | +```bash |
| 45 | +# Build |
| 46 | +docker build -t espilon-docs . |
| 47 | + |
| 48 | +# Run |
| 49 | +docker run -p 8080:80 espilon-docs |
| 50 | +``` |
| 51 | + |
| 52 | +Access at http://localhost:8080 |
| 53 | + |
| 54 | +## Deployment |
| 55 | + |
| 56 | +### Self-Hosted with Docker Compose |
| 57 | + |
| 58 | +```bash |
| 59 | +docker-compose -f docker-compose.docs.yml up -d |
| 60 | +``` |
| 61 | + |
| 62 | +The service will be available on port 80 and can be proxied via Nginx. |
| 63 | + |
| 64 | +### Configuration Example (Nginx) |
| 65 | + |
| 66 | +```nginx |
| 67 | +server { |
| 68 | + listen 443 ssl; |
| 69 | + server_name docs.espilon.net; |
| 70 | +
|
| 71 | + ssl_certificate /etc/letsencrypt/live/espilon.net/fullchain.pem; |
| 72 | + ssl_certificate_key /etc/letsencrypt/live/espilon.net/privkey.pem; |
| 73 | +
|
| 74 | + location / { |
| 75 | + proxy_pass http://espilon-docs:80; |
| 76 | + proxy_set_header Host $host; |
| 77 | + proxy_set_header X-Real-IP $remote_addr; |
| 78 | + } |
| 79 | +} |
| 80 | +``` |
| 81 | + |
| 82 | +## Repository Structure |
| 83 | + |
| 84 | +``` |
| 85 | +espilon-docs/ |
| 86 | +├── docs/ # Markdown files |
| 87 | +├── mkdocs.yml # MkDocs config |
| 88 | +├── requirements.txt # Python dependencies |
| 89 | +├── Dockerfile # Multi-stage build |
| 90 | +├── docker-compose.docs.yml # Docker Compose config |
| 91 | +└── .github/workflows/ # CI/CD |
| 92 | +``` |
| 93 | + |
| 94 | +## Contributing |
| 95 | + |
| 96 | +1. Fork the repository |
| 97 | +2. Create your feature branch |
| 98 | +3. Make changes and test locally with `mkdocs serve` |
| 99 | +4. Commit your changes |
| 100 | +5. Push and create a Pull Request |
| 101 | + |
| 102 | +## License |
| 103 | + |
| 104 | +Documentation for the Espilon project. |
| 105 | + |
| 106 | +--- |
| 107 | + |
| 108 | +**Built with MkDocs Material** |
0 commit comments