Welcome to the Home Security Lab repository! This repository is maintained by Jerry P. Collins, Jr. [@securitasis], a Cyber Security Engineer / Architect, with the aim of sharing expertise and knowledge with others who are interested in the field of cybersecurity.
The purpose of this repository is to provide detailed documentation, guides, and best practices for deploying and managing various security tools and technologies. Whether you are a beginner or an experienced professional, you will find valuable resources to enhance your understanding and skills in cybersecurity.
| File | Title | Purpose | Details |
|---|---|---|---|
| deploy_phpIPAM.md | Deploy phpIPAM on Ubuntu & Remote MySQL | A step-by-step guide for securely deploying phpIPAM on an Ubuntu system with a remote MySQL database. | phpIPAM is an open-source IP Address Management (IPAM) platform designed to streamline and automate the administration of IP spaces in modern networks. Written in PHP, it provides a web-based interface for managing IPv4 and IPv6 address pools, subnet allocations, VLANs, and related network resources. Its modular structure, extensive API support, and user-friendly dashboards make phpIPAM a flexible choice for both small-scale deployments and enterprise environments seeking efficient, centralized oversight of critical network assets. |
| Software / Appliance | Purpose | Details |
|---|---|---|
| Proxmox VE | Deploy and configure | Proxmox VE is an open-source server virtualization platform that supports both Kernel-based Virtual Machine (KVM) for full virtualization and Linux Containers (LXC) for lightweight virtualization. It features a web-based management interface, high availability clustering, software-defined storage, and disaster recovery tools, making it suitable for managing complex IT infrastructures efficiently. |
| Adguard Home | Deploy & configure | Free and open source, powerful network-wide ads & trackers blocking DNS server. |
| Ubuquiti UDM Pro Hardware | Configure VLANs and Firewall to isolate IOTs | The Ubiquiti UniFi Dream Machine Pro (UDM Pro) is an all-in-one security gateway designed for small networks, offering advanced features like a firewall, VPN services, and intrusion detection and prevention systems. It also includes deep packet inspection, URL content filtering, and a managed eight-port Gigabit switch, making it a robust solution for protecting network traffic and devices. |
| Wazuh | Deploy, configure & integrate | Wazuh is an open-source security platform that provides threat detection, intrusion prevention, and compliance monitoring for small networks. Its capabilities include log data analysis, file integrity monitoring, vulnerability detection, and automated responses to security incidents, making it effective for safeguarding various endpoints and ensuring regulatory compliance. |
| Ansible | Deploy & configure | Ansible is an open-source IT automation tool that can help secure small networks by automating tasks such as configuration management, application deployment, and security compliance. It allows users to define desired system states and enforce security policies consistently across all devices without needing to install agents on managed nodes, making it efficient and easy to use. |
| Nginx | Deploy & configure | NGINX can enhance the security of small networks by acting as a reverse proxy, which helps to shield backend servers from direct exposure to the internet. It also supports SSL/TLS termination, load balancing, and can manage traffic to prevent overload, thereby improving overall network security and performance. |
We welcome contributions from the community! If you have expertise in a particular security tool or technology and would like to share your knowledge, please follow the guidelines below to add new documentation:
-
Create a New Markdown File: Create a new
.mdfile in the root directory of the repository. Name the file appropriately to reflect the content (e.g.,tool_name_deployment.md). -
Follow the Template: Use the following template to structure your documentation:
# Tool Name ## **Document Information** - **Title:** [Title of the Document] - **Author:** [Your Name or GitHub Handle] - **Version:** [Document Version] - **Last Updated:** [Date] - **Purpose:** [Brief description of the document's purpose] - **License:** [License information] - **Repository:** [Link to the repository if applicable] ## **Assumptions** - [List any assumptions or prerequisites] ## **Prerequisites** 1. **Operating System:** [OS details] 2. **System Access:** [Access requirements] 3. **Database Server:** [Database details if applicable] 4. **Required Network Ports:** [Network port details] 5. **Installed Packages:** [List of required packages] 6. **Security Considerations:** [Security best practices] ## **Installation Steps** ### Step 1: [Step Title] 1. **[Instruction]** ```bash [Command] ``` 2. **[Instruction]** ```bash [Command] ``` ### Step 2: [Step Title] 1. **[Instruction]** ```bash [Command] ``` 2. **[Instruction]** ```bash [Command] ``` ## **Final Steps** 1. **[Instruction]** ```html [URL or Command] ``` 2. **[Instruction]** ```html [URL or Command] ```
-
Submit a Pull Request: Once you have completed your documentation, submit a pull request for review. Ensure that your documentation is clear, concise, and follows the best practices outlined in the template.
This repository is licensed under the GNU Free Documentation License (GFDL) v1.3 or later. You are free to copy, modify, and distribute the documents, provided that credit is given to the original author(s). See GNU Free Documentation License for the full license.
If you have any questions or need further assistance, feel free to reach out to me via GitHub.
Happy learning and stay secure!