README

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 10.

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 OSX, 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

• Installation
• User's Manual
• Bug Reports & Feature Requests
• Security
• Upgrading
• Translations!
• Libraries, Modules & Related Projects
• Join the Community!
• Contributing
• Announcement List

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, please email security@snipeitapp.com instead of using the issue tracker.

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 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. :)

• Python Module by @jbloomer
• SnipeSharp - .NET module in C# by @barrycarey
• InQRy -unmaintained- by @Microsoft
• SnipeitPS by @snazy2000 - Powershell API Wrapper for Snipe-it
• jamf2snipe - Python script to sync assets between a JAMFPro instance and a Snipe-IT instance
• jamf-snipe-rename - Python script to rename computers in Jamf from Snipe-IT
• Marksman - A Windows agent for Snipe-IT
• Snipe-IT plugin for Jira Service Desk
• Python 3 CSV importer - allows importing assets into Snipe-IT based on Item Name rather than Asset Tag.
• Snipe-IT Kubernetes Helm Chart - For more information, click here.
• Snipe-IT Bulk Edit - Google Script files to use Google Sheets as a bulk checkout/checkin/edit tool for Snipe-IT.
• MosyleSnipeSync by @Karpadiem - Python script to synchronize information between Mosyle and Snipe-IT.
• WWW::SnipeIT by @SEDC - perl module for accessing the API
• UniFi to Snipe-IT by @karpadiem - Python script that synchronizes UniFi devices with Snipe-IT.
• Kandji2Snipe by @briangoldstein - Python script that synchronizes Kandji with Snipe-IT.
• SnipeAgent by @ReticentRobot - Windows agent for Snipe-IT.
• Gate Pass Generator by @cha7uraAE - A Streamlit application for generating gate passes based on hardware data from a Snipe-IT API.

Join the Community!

• Join our Discord! It’s full of great people. We even wrote about it here!
• Follow us on Bluesky at @snipeitapp.com
• Follow us on Mastodon at hachyderm.io/@grokability
• Follow our blog at Grokstar.Dev
• Subscribe here on Github for notifications about new releases. (We recommend selecting "Releases" only for most users - this repo can get noisy.)

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.

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 )

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.