Skip to content

Latest commit

 

History

History
356 lines (253 loc) · 17.1 KB

README.md

File metadata and controls

356 lines (253 loc) · 17.1 KB

snipe-it-by-grok

Crowdin Docker Pulls Tests in MySQL All Contributors Discord

Snipe-IT - Open Source Asset Management System

Snipe-IT is a FOSS project for asset management in IT Operations. Knowing who has which laptop, when it was purchased in order to depreciate it correctly, handling software licenses, etc.

Snipe-IT is actively developed and we release quite frequently. (Check out the live demo here.)

Tip

This is web-based software. This means there is no executable file (aka no .exe files), and it must be run on a web server and accessed through a web browser. It runs on any Mac OS X, any flavor of Linux, as well as Windows, and we have a Docker image available if that's what you're into.


🍽️ Table of Contents


🎯 General Features

🎉 Mobile-friendly for asset updates on the go
🎉 Runs on any Linux, Windows or Mac web server
🎉 Web-based software so it works on any device
🎉 Slack/Teams notification integration for check-in/check-out
🎉 Tons of security features to keep your data safe
🎉 Pre-defined "kits" for faster checkouts
🎉 SAML SSO login
🎉 JAMF integration via Jamf2Snipe or Jira
🎉 Role-based groups with granular permissions
🎉 Easy transferring of items between users
🎉 Per-user light/dark mode
🎉 Optional digital signatures on item acceptance

🎉 Includes a robust JSON REST API
🎉 Translated into over 55 languages for easy localization
🎉 Per-user language support for distributed teams
🎉 One-click (or cron) backups
🎉 Active Directory/LDAP login & user sync
🎉 Google Secure LDAP user sync
🎉 SCIM support for automatic user provisioning
🎉 Third-party integrations with RMMs, MDMs, and other cloud services
🎉 CSV import for quickly getting up and running
🎉 Supports multiple companies within one installation
🎉 Native MDM/RMM sync adapters 🆕
🎉 Calendar view 🆕

Check out the project's features for a more complete list!


🔄 Included Sync Adapters

Snipe-IT comes with 25 (and growing!) sync adapters that let you integrate your favorite (or at least begrudgingly useful) MDM and RMM systems with Snipe-IT so that everything stays updated across all of your tooling.

🔄 Addigy
🔄 Apple Business Manager
🔄 Custom HTTP
🔄 Fleet
🔄 Google Workspace (ChromeOS)
🔄 Iru (Kandji)
🔄 Jamf Platform
🔄 Jamf Pro
🔄 Jamf School
🔄 JumpCloud
🔄 Kaseya VSA 10
🔄 Landscape
🔄 Level.io

🔄 ManageEngine Endpoint Central
🔄 Meraki Systems Manager
🔄 Microsoft Intune
🔄 Mosyle Business
🔄 Mosyle Manager
🔄 NinjaOne
🔄 Omnissa Workspace ONE
🔄 osctrl
🔄 Sophos Central
🔄 UniFi
🔄 UniFi Access
🔄 Zentral


🌟 Live Demo

Want to try Snipe-IT before installing it? Hop into one of our public sandboxes. No signup required.

Branch URL
Stable release demo.snipeitapp.com
Develop branch (previews unreleased features) develop.snipeitapp.com

Log in with any of the following accounts:

Role Username Password
Admin user admin password
Assets manager assets password
Test user (no privs) testuser password

Important

These are public demos. Please do not enter real asset, license, or user information while testing. Data resets several times a day, and email editing, access-level changes, password changes, and outbound email are all disabled to prevent abuse.

If you hit a maintenance page, give it a few minutes and refresh. That means the demo server is being updated with the latest code from the develop branch, or the database is being reset.


🛠️ Installation

For instructions on installing and configuring Snipe-IT on your server, check out the installation manual. (Please see the requirements documentation for full requirements.)

If you're having trouble with the installation, please check the Common Issues and Getting Help documentation, and search this repository's open and closed issues for help.


🫶🏻 User's Manual

For help using Snipe-IT, check out the user's manual.


🐛 Bug Reports & Feature Requests

Feel free to check out the GitHub Issues for this project to open a bug report or see what open issues you can help with. Please search through existing issues (open and closed) to see if your question has already been answered before opening a new issue.

Important

PLEASE see the Getting Help Guidelines and Common Issues before opening a ticket, and be sure to complete all of the questions in the Github Issue template to help us to help you as quickly as possible.


🔒 Security

Important

To report a security vulnerability, use GitHub Security Advisories or email security@snipeitapp.com. Please do not open a regular issue, since security reports should stay off the public issue tracker until a fix is released.

We use GitHub Security Advisories (GHSAs) to manage responsible disclosure for the Snipe-IT codebase.

Before you submit a report, please:

  1. Search the existing GHSA list first. A match may already be reported, and if the fix isn't in a tagged release yet, the advisory may not be published.
  2. Test against master or develop to be sure the issue isn't already patched.
  3. Leave the package name and ecosystem fields blank. Snipe-IT is not distributed as a package.
  4. Specify the version range that is affected.
  5. Provide CVSS and CWE references via the GHSA UI.

Response time: You can typically expect a response within five business days, and most fixes are released within a week of the initial disclosure. If you report a vulnerability we've already received from someone else, we will add your GitHub username to the original GHSA so you get credit for the parallel discovery.

🏆 We do not run a bug bounty program and do not offer monetary rewards, but researchers who report multiple high-quality vulnerabilities may be added to our Security Researchers Hall of Fame.


⬆️ Upgrading

Please see the upgrading documentation for instructions on upgrading Snipe-IT.


🌐 Translations!

Please see the translations documentation for information about available languages and how to add translations to Snipe-IT.


👩‍💻 Libraries, Modules & Related Projects

Since the release of the JSON REST API, several third-party developers have been developing modules and libraries to work with Snipe-IT.

Note

As these were created by third-parties, Snipe-IT cannot provide support for these projects, and you should contact the developers directly if you need assistance. Additionally, Snipe-IT makes no guarantees as to the reliability, accuracy or maintainability of these libraries. Use at your own risk. :)

Libraries & Modules

We also have a handful of Google Apps scripts to help with various tasks.


📱 Mobile Apps

Our official mobile app is currently in beta, and other developers have also created native mobile apps for Snipe-IT using our API.

For updates on the official mobile app, join us in the #official-mobile-app channel in the Snipe-IT Discord server. To download the beta, grab it on Testflight (iOS) or the Google Play store for Android.

Third-party apps built on the Snipe-IT API:

* Requires a file to be placed on the Snipe-IT server. Not compatible with hosted versions.


🕺 Join the Community!


✍️ Contributing

Please refrain from submitting issues or pull requests generated by fully-automated tools. Maintainers reserve the right, at their sole discretion, to close such submissions and to block any account responsible for them. Please see our AI Contribution Policy for more information.

Contributions should follow from a human-to-human discussion in the form of an issue for the best chances of being merged into the core project. (Sometimes we might already be working on that feature, sometimes we've decided against it for a reason, and sometimes we just need to discuss the best way to implement it.)

Please see the complete documentation on contributing and developing for Snipe-IT.

This project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

The ERD is available online here.

Be sure to check out all of the amazing people that have contributed to Snipe-IT over the years!


📢 Announcement List

To be notified of important news (such as new releases, security advisories, etc.), sign up for our list. We'll never sell or give away your info, and we'll only email you when it's important.

We also usually make smaller announcements on our social accounts, our Discord channel, and our blog, so be sure to subscribe to those if you're looking for more granular announcements.