Snipe-IT Asset Management Installation Documentation

Welcome to the Snipe-IT documentation hub. You'll find comprehensive guides and documentation to help you install Snipe-IT as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Getting Help

If you're having trouble setting up Snipe-IT, don't worry!

Snipe-IT has an active community of core developers as well as great community support, and we're happy to try to help you through your issue. The more information you can provide us, the easier it will be for us to help you.

Please do not email for installation support.

Github Issues allows us to share solutions so that other people can learn from them, which gives the community the most benefit.

Step 1: Enable debug mode

In your .env, set APP_DEBUG to true. You'll switch this back to false once we're done debugging your issue, but this will turn on verbose errors on the screen and will help you see what's breaking.

If you get an "Oops!" or "Whoops!" message in the browser when you hit a specific page, that means debug is set to false.

Set it to true, and reload the page for more detailed errors. It will be nearly impossible for us to help you without the information provided there, so please try to be sure to include it with every help request so that we can try to get your problem sorted quickly.

Step 2: Enable your browser's error console

Sometimes errors reported by your browser can lend a clue as to what's going on. Enable your browser's error console to see any client-side errors that may be causing issues.

Step 3: Check your app and server logs

Your app logs (found in storage/logs) and your web server logs will provide more detailed information about what's going wrong, as well as any logging output that we have put in place for debugging purposes.

Step 4: Check the Common Issues page

First, check the Common Issues page to make sure your problem hasn't already been addressed. We update that page frequently as requests come in.

Step 5: Post an issue to Github or Gitter

If you can't find your issue in the Common Issues page, simply post a new issue in the Github Issues for Snipe-IT, or ask in the Snipe-IT Gitter chat room and we'll try to get you sorted out.

When posting a new issue, please be SURE to include the following in every issue:

  • Version of Snipe-IT you're running. (If you didn't grab an official release, let us know which branch you pulled from.)
  • What OS and web server you're running Snipe-IT on
  • What method you used to install Snipe-IT (install.sh, manual installation, docker, etc)
  • If you're getting an error in your browser, include that error.
  • What specific Snipe-IT page you're on, and what specific element you're interacting with to trigger the error
  • If a stacktrace is provided in the error, include that too.
  • Any errors that appear in your browser's error console.
  • Confirm whether the error is reproduceable on the demo.
  • Include any additional information you can find in storage/logs and your webserver's logs.
  • Include what you've done so far in the installation, and if you got any error messages along the way.
  • Indicate whether or not you've manually edited any data directly in the database

NOTE:

Github issues that have not been updated/replied to by a user will be closed after two weeks.


Getting Help

If you're having trouble setting up Snipe-IT, don't worry!