Huge role refactoring/cleanup. Other commits will propably follow. Because some bugs will exist. Still important for longrun and also for auto docs/help/slideshow generation

This commit is contained in:
2025-07-08 23:43:13 +02:00
parent 6b87a049d4
commit 563d5fd528
1242 changed files with 2301 additions and 1355 deletions

View File

@@ -0,0 +1,40 @@
# SnipeIT
## Description
SnipeIT is an opensource asset management system designed to streamline hardware and software inventory tracking. This deployment provides an automated, containerized solution using Docker Compose, centralized MariaDB database integration, and secure, configurable environment settings—including robust SMTP email support and pending SAML authentication enhancements.
## Overview
This Docker deployment uses Ansible automation to set up SnipeIT along with necessary services such as a MariaDB database, an optional OAuth2 proxy for additional security, and a reverse proxy configuration. The system is built for reliable asset management in various environments.
## Features
- **Automated Deployment:**
Launch SnipeIT quickly with Docker Compose and Ansible automation for a productionready platform.
- **Centralized Database Support:**
Leverage MariaDB for secure and reliable data storage.
- **Configurable SMTP Settings:**
Manage email notifications and alerts with customizable SMTP configurations.
- **Optional SAML Authentication:**
Prepare for enhanced, standardsbased authentication (integration pending).
- **Redis Caching:**
Improve application performance with builtin Redis caching support.
## Other Resources
- [SnipeIT Official Documentation](https://snipe-it.readme.io/docs/ldap-sync-login)
- [SAML Setup Instructions](https://snipe-it.readme.io/docs/saml)
- [Mattermost SSO Integration Guide](https://docs.mattermost.com/onboard/sso-saml-keycloak.html)
- [Additional GitHub Issues and Discussions](https://github.com/snipe/snipe-it/issues)
## Credits
Developed and maintained by **Kevin Veen-Birkenbach**.
Learn more at [veen.world](https://veen.world)
Part of the [CyMaIS Project](https://github.com/kevinveenbirkenbach/cymais)
License: [CyMaIS NonCommercial License (CNCL)](https://s.veen.world/cncl)