Skip to content

A free open source IT asset/license management system

Updated readme info

snipe5ad563616ad9
diff --git a/README.md b/README.md
index e9d7d253c2..91d5d7b9f3 100644
--- a/README.md
+++ b/README.md
@@ -3,20 +3,25 @@
[![Crowdin](https://d322cqt584bo4o.cloudfront.net/snipe-it/localized.svg)](https://crowdin.com/project/snipe-it) [![Docker Pulls](https://img.shields.io/docker/pulls/snipe/snipe-it.svg)](https://hub.docker.com/r/snipe/snipe-it/) [![Tests in MySQL](https://github.com/grokability/snipe-it/actions/workflows/tests-mysql.yml/badge.svg)](https://github.com/grokability/snipe-it/actions/workflows/tests-mysql.yml)
[![All Contributors](https://img.shields.io/badge/all_contributors-331-orange.svg?style=flat-square)](#contributing) [![Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.gg/yZFtShAcKk)
-## Snipe-IT - Open Source Asset Management System
+# Snipe-IT - Open Source Asset Management System
-This 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.
-
-It is built on [Laravel 12](http://laravel.com).
+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](https://github.com/grokability/snipe-it/releases). ([Check out the live demo here](https://snipeitapp.com/demo/).)
> [!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 OSX, any flavor of Linux, as well as Windows, and we have a [Docker image](https://snipe-it.readme.io/docs/docker) available if that's what you're into.
+> __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](https://snipe-it.readme.io/docs/docker) available if that's what you're into.
-----
-### Table of Contents
+## Table of Contents
+
+* [General Features](#general-features)
+* [Included Sync Adapters](#included-sync-adapters)
+* [Live Demo](#live-demo)
* [Installation](#installation)
* [User's Manual](#users-manual)
* [Bug Reports & Feature Requests](#bug-reports--feature-requests)
@@ -28,21 +33,142 @@ Snipe-IT is actively developed and we [release quite frequently](https://github.
* [Contributing](#contributing)
* [Announcement List](#announcement-list)
+-----
+
+## General Features
+
+<table border="0" width="100%">
+<tr>
+<td valign="top" width="50%">
+
+πŸŽ‰ Mobile-friendly for asset updates on the go<br />
+πŸŽ‰ Runs on any Linux, Windows or Mac web server<br />
+πŸŽ‰ Web-based software so it works on any device<br />
+πŸŽ‰ Slack/Teams notification integration for check-in/check-out<br />
+πŸŽ‰ Tons of security features to keep your data safe<br />
+πŸŽ‰ Pre-defined "kits" for faster checkouts<br />
+πŸŽ‰ SAML SSO login<br />
+πŸŽ‰ JAMF integration via Jamf2Snipe or Jira<br />
+πŸŽ‰ Role-based groups with granular permissions<br />
+πŸŽ‰ Easy transferring of items between users<br />
+πŸŽ‰ Per-user light/dark mode<br />
+πŸŽ‰ Optional digital signatures on item acceptance<br />
+
+
+</td>
+<td valign="top" width="50%">
+
+πŸŽ‰ Includes a robust JSON REST API<br />
+πŸŽ‰ Translated into over 55 languages for easy localization<br />
+πŸŽ‰ Per-user language support for distributed teams<br />
+πŸŽ‰ One-click (or cron) backups<br />
+πŸŽ‰ Active Directory/LDAP login & user sync<br />
+πŸŽ‰ Google Secure LDAP user sync<br />
+πŸŽ‰ SCIM support for automatic user provisioning<br />
+πŸŽ‰ Third-party integrations with RMMs, MDMs, and other cloud services<br />
+πŸŽ‰ CSV import for quickly getting up and running<br />
+πŸŽ‰ Supports multiple companies within one installation<br />
+πŸŽ‰ Native MDM/RMM sync adapters πŸ†•<br />
+πŸŽ‰ Calendar view πŸ†•<br />
+
+</td>
+</tr>
+</table>
+
+Check out the project's [features]([https://snipeitapp.com/features](https://snipeitapp.com/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.
+
+<table border="0" width="100%">
+<colgroup>
+<col width="50%" />
+<col width="50%" />
+</colgroup>
+<tr>
+<td valign="top">
+
+πŸ”„ Addigy<br />
+πŸ”„ Apple Business Manager<br />
+πŸ”„ Custom HTTP<br />
+πŸ”„ Fleet<br />
+πŸ”„ Google Workspace (ChromeOS)<br />
+πŸ”„ Iru (Kandji)<br />
+πŸ”„ Jamf Platform<br />
+πŸ”„ Jamf Pro<br />
+πŸ”„ Jamf School<br />
+πŸ”„ JumpCloud<br />
+πŸ”„ Kaseya VSA 10<br />
+πŸ”„ Landscape<br />
+πŸ”„ Level.io<br />
+
+</td>
+<td valign="top">
+
+πŸ”„ ManageEngine Endpoint Central<br />
+πŸ”„ Meraki Systems Manager<br />
+πŸ”„ Microsoft Intune<br />
+πŸ”„ Mosyle Business<br />
+πŸ”„ Mosyle Manager<br />
+πŸ”„ NinjaOne<br />
+πŸ”„ Omnissa Workspace ONE<br />
+πŸ”„ osctrl<br />
+πŸ”„ Sophos Central<br />
+πŸ”„ UniFi<br />
+πŸ”„ UniFi Access<br />
+πŸ”„ Zentral<br />
+
+</td>
+</tr>
+</table>
+
+
+-----
+
+## Live Demo
+
+Want to try Snipe-IT before installing it? Hop into one of our public sandboxes. No signup required.
+
+- **Stable release**: [demo.snipeitapp.com](https://demo.snipeitapp.com)
+- **Develop branch** (previews unreleased features): [develop.snipeitapp.com](https://develop.snipeitapp.com)
+
+
+- Admin User: Log in as `admin` / `password`.
+- Assets Manager User: Log in as `assets` / `password`.
+- Test User: Log in as `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
+## Installation
For instructions on installing and configuring Snipe-IT on your server, check out the [installation manual](https://snipe-it.readme.io/docs). (Please see the [requirements documentation](https://snipe-it.readme.io/docs/requirements) for full requirements.)
If you're having trouble with the installation, please check the [Common Issues](https://snipe-it.readme.io/docs/common-issues) and [Getting Help](https://snipe-it.readme.io/docs/getting-help) documentation, and search this repository's open *and* closed issues for help.
-----
-### User's Manual
+
+## User's Manual
For help using Snipe-IT, check out the [user's manual](https://snipe-it.readme.io/docs/overview).
-----
-### Bug Reports & Feature Requests
+
+## Bug Reports & Feature Requests
Feel free to check out the [GitHub Issues for this project](https://github.com/grokability/snipe-it/issues) 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.
@@ -51,32 +177,58 @@ Feel free to check out the [GitHub Issues for this project](https://github.com/g
-----
-### Security
+## Security
> [!IMPORTANT]
-> **To report a security vulnerability, please email [email protected] instead of using the issue tracker.**
------
+> To report a security vulnerability, use
+**[GitHub Security Advisories](https://github.com/grokability/snipe-it/security)**
+or email [[email protected]](mailto:[email protected]). 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](https://github.com/grokability/snipe-it/security/advisories) 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](https://snipeitapp.com/thanks#security-researcher-hall-of-fame).
-### Upgrading
+-----
+
+## Upgrading
Please see the [upgrading documentation](https://snipe-it.readme.io/docs/upgrading) for instructions on upgrading Snipe-IT.
------
-### Translations!
+
+## Translations!
Please see the [translations documentation](https://snipe-it.readme.io/docs/translations) for information about available languages and how to add translations to Snipe-IT.
-----
-### Libraries, Modules & Related Projects
+## 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 project, 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. :)
+> [!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
+### Libraries & Modules
- [SnipeScheduler](https://github.com/JSY-Ben/SnipeScheduler) by [@JSY-Ben](https://github.com/JSY-Ben) - An Asset Reservation/Checkout System for Snipe-IT
- [Snipe-IT MCP Server](https://github.com/jameshgordy/snipeit-mcp) by [@jameshgordy](https://github.com/jameshgordy) - A Model Context Protocol (MCP) server for managing Snipe-IT inventory systems
@@ -93,28 +245,45 @@ Since the release of the JSON REST API, several third-party developers have been
- [WWW::SnipeIT](https://github.com/SEDC/perl-www-snipeit) by [@SEDC](https://github.com/SEDC) - perl module for accessing the API
- [UniFi to Snipe-IT](https://www.edtechirl.com/p/snipe-it-and-azure-asset-management) originally by [@karpadiem](https://github.com/karpadiem) - Python script that synchronizes UniFi devices with Snipe-IT.
- [Kandji2Snipe](https://github.com/grokability/kandji2snipe) by [@briangoldstein](https://github.com/briangoldstein) - Python script that synchronizes Kandji with Snipe-IT.
-* [snipeit-warranty-sync](https://github.com/checkwarranty/snipeit-warranty-sync) by [@checkwarranty](https://github.com/checkwarranty) - Python script to synchronize hardware warranty expiration dates and factory specs (Dell, Lenovo, HP, Apple) with Snipe-IT.
+- [snipeit-warranty-sync](https://github.com/checkwarranty/snipeit-warranty-sync)
+ by [@checkwarranty](https://github.com/checkwarranty) - Python script to synchronize hardware warranty expiration
+ dates and factory specs (Dell, Lenovo, HP, Apple) with Snipe-IT.
- [SnipeAgent](https://github.com/ReticentRobot/SnipeAgent) by [@ReticentRobot](https://github.com/ReticentRobot) - Windows agent for Snipe-IT.
- [Gate Pass Generator](https://github.com/cha7uraAE/snipe-it-gate-pass-system) by [@cha7uraAE](https://github.com/cha7uraAE) - A Streamlit application for generating gate passes based on hardware data from a Snipe-IT API.
-- [InQRy (archived)](https://github.com/Microsoft/InQRy) by [@Microsoft](https://github.com/Microsoft)
-- [Marksman (archived)](https://github.com/Scope-IT/marksman) - A Windows agent for Snipe-IT
-- [Python Module (archived)](https://github.com/jbloomer/SnipeIT-PythonAPI) by [@jbloomer](https://github.com/jbloomer)
-[IT-Tools](https://github.com/chrisnox/Snipeit-it-tools) by @chrisnox - Browser bookmarklets for PDF handover/return protocols, digital signatures, label printing (Zebra ZD410), AirWatch MDM sync and Lansweeper CSV import.
+- [IT-Tools](https://github.com/chrisnox/Snipeit-it-tools) by [@chrisnox](https://github.com/chrisnox) - Browser
+ bookmarklets for PDF handover/return
+ protocols, digital signatures, label printing (Zebra ZD410), AirWatch MDM sync and Lansweeper CSV import.
We also have a handful of [Google Apps scripts](https://github.com/grokability/google-apps-scripts-for-snipe-it) to help with various tasks.
-#### Mobile Apps
+-----
+
+## Mobile Apps
-We're currently working on our own mobile app, but in the meantime, check out these third-party apps that work with Snipe-IT:
+Our [official mobile app](https://github.com/grokability/snipe-it-mobile) 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](https://discord.com/channels/849770616521359401/1430282366995267584) in the
+**[Snipe-IT Discord](https://discord.gg/yZFtShAcKk)** server. To download the beta, grab it
+on [Testflight (iOS)](https://testflight.apple.com/join/3B3YcWph) or
+the [Google Play store for Android](https://play.google.com/store/apps/details?id=com.grokability.snipeitmobile).
+
+Third-party apps built on the Snipe-IT API:
- [SnipeMate](https://snipemate.app/) (iOS, Google Play, Huawei AppGallery) by Mars Technology
- [Snipe-Scan](https://apps.apple.com/do/app/snipe-scan/id6744179400?uo=2) (iOS) by Nicolas Maton
-- [Snipe-IT Assets Management](https://play.google.com/store/apps/details?id=com.diegogarciadev.assetsmanager.snipeit&hl=en&pli=1) (Google Play) by DiegoGarciaDEV
-- [AssetX](https://apps.apple.com/my/app/assetx-for-snipe-it/id6741996196?uo=2) (iOS) for Snipe-IT by Rishi Gupta
+- [Snipe-IT Assets Management](https://play.google.com/store/apps/details?id=com.diegogarciadev.assetsmanager.snipeit&hl=en&pli=1)
+ (Google Play) by DiegoGarciaDEV\*
+- [AssetX for Snipe-IT](https://apps.apple.com/my/app/assetx-for-snipe-it/id6741996196?uo=2) (iOS) by Rishi Gupta
+- [SnipeScanner](https://apps.apple.com/au/app/snipescanner/id6746058955) (iOS) by Jimmy Fletcher
+- [SnipeMobile](https://github.com/Callandt/SnipeMobile) (iOS, beta) by Avery Callandt
+
+\* Requires a file to be placed on the Snipe-IT server. Not compatible with hosted versions.
-----
-### Join the Community!
+## Join the Community!
- **[Join our Discord](https://discord.gg/yZFtShAcKk)!** It’s full of great people. We even wrote about it [here](https://grokstar.dev/culture/2024/06/the-unlikely-rise-of-discord-as-a-support-channel/)!
- **Follow us on Bluesky** at [@snipeitapp.com](https://bsky.app/profile/snipeitapp.com)
@@ -124,11 +293,13 @@ We're currently working on our own mobile app, but in the meantime, check out th
-----
-### Contributing
+## 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](https://snipe-it.readme.io/docs/contributing-overview#ai-usage-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 )
+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](https://snipe-it.readme.io/docs/contributing-overview).
@@ -139,7 +310,8 @@ The ERD is available [online here](https://drawsql.app/templates/snipe-it).
Be sure to check out all of the [amazing people](CONTRIBUTORS.md) that have contributed to Snipe-IT over the years!
------
-### Announcement List
+
+## Announcement List
To be notified of important news (such as new releases, security advisories, etc), [sign up for our list](http://eepurl.com/XyZKz). We'll never sell or give away your info, and we'll only email you when it's important.