snipe-it

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 4.1 and uses the Sentry 2 package.

This project is being actively developed (at what seems like breakneck speed sometimes!) We're still in alpha release, so this is NOT recommended for production use yet, as many more things will likely change before v1.0-stable is ready - but we're releasing quite frequently.

This is web-based software. This means there 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, flavor of Linux, as well as Windows.

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 hasn't already been answered before opening a new issue.

We use Waffle.io to help better communicate our roadmap with users. Our project page there will show you the backlog, what's ready to be worked on, what's in progress, and what's completed.

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.

Requirements

PHP 5.4 or later
MCrypt PHP Extension

Important Notes on Updating

Whenever you pull down a new version from master or develop, when you grab the latest official release, make sure to run the following commands via command line:

php composer.phar dump-autoload
php artisan migrate

Forgetting to do this can mean your DB might end up out of sync with the new files you just pulled, or you may have some funky cached autoloader values. It's a good idea to get into the habit of running these every time you pull anything new down. If there are no database changes to migrate, it won't hurt anything to run migrations anyway.

How to Install in Production

Bear in mind that Snipe-IT is still in pre-release. While it's generally pretty stable, installing this in a production environment is generally not recommended. We do our best to make sure future changes won't hoark your install, but you should always back up your databases when you upgrade to newer releases.

Note: Installation for Windows IIS can be found here (thanks, madd15!)

1) Downloading

Clone the Repository

git clone https://github.com/snipe/snipe-it your-folder

Download the source from https://github.com/snipe/snipe-it/archive/master.zip

2) Setup Environment, Database and Mail Settings

2.1) Adjust Environments

Update the file bootstrap/start.php under the section Detect The Application Environment.

AS OF LARAVEL 4.1 Per the Laravel 4.1 upgrade docs:

"For security reasons, URL domains may no longer be used to detect your application environment. These values are easily spoofable and allow attackers to modify the environment for a request. You should convert your environment detection to use machine host names (hostname command on Mac & Ubuntu)."

To find out your local machine's hostname, type hostname from a terminal prompt on the machine you're installing it on. The command-line response is that machine's hostname. Please note that the hostname is NOT always the same as the domain name.

So for example, if you're installing this on your server named www.yourserver.com, the environmental variable section of bootstrap/start.php might look like this:

$env = $app->detectEnvironment(array(
	...
	'production' 	=> array('www.yourserver.com')
));

If your development, staging and production sites all run on the same server (which is generally a terrible idea), see this example of how to configure the app using environmental variables.

2.2) Setup Your Database

Copy the example database config app/config/production/database.example.php to app/config/production/database.php. Update the file app/config/production/database.php with your database name and credentials:

    'mysql' => array(
        'driver'    => 'mysql',
        'host'      => 'localhost',
        'database'  => 'snipeit_laravel',
        'username'  => 'travis',
        'password'  => '',
        'charset'   => 'utf8',
        'collation' => 'utf8_unicode_ci',
        'prefix'    => '',
    ),

2.3) Setup Mail Settings

Copy the example mail config app/config/production/mail.example.php to app/config/production/mail.php. Update the file app/config/production/mail.php with your mail settings.

This will be used to send emails to your users, when they register and when they request a password reset.

2.4) Adjust the application settings.

Copy the example app config app/config/production/app.example.php to app/config/production/app.php.

Update the file app/config/production/app.php with your URL settings.

'url' => 'http://www.yourserver.com',

You should also change your secret key here -- if you prefer to have your key randomly generated, run the artisan key:generate command from the application root.

php artisan key:generate --env=production

3) Install the Dependencies via Composer

3.1) If you don't have composer installed globally

cd your-folder
curl -sS https://getcomposer.org/installer | php
php composer.phar install

3.2) For global composer installations

cd your-folder
composer install

4) Use custom CLI Installer Command

Now, you need to create yourself a user and finish the installation.

Use the following command to create your default user, user groups and run all the necessary migrations automatically.

php artisan app:install

6) Fix permissions

You'll need to make sure that the app/storage directory is writable by your webserver, since caches and log files get written there. You should use the minimum permissions available for writing, based on how you've got your webserver configured.

chmod -R 755 app/storage

If you still run into a permissions error, you may need to increase the permissions to 775, or twiddle your user/group permissions on your server.

chmod -R 775 app/storage

7) Set the correct document root for your server

The document root for the app should be set to the public directory. In a standard Apache virtualhost setup, that might look something like this on a standard linux LAMP stack:

<VirtualHost *:80>
	<Directory /var/www/html/public>
		AllowOverride All
	</Directory>
	DocumentRoot /var/www/html/public
    	ServerName www.yourserver.com
    	# Other directives here
</VirtualHost>

An OS X virtualhost setup could look more like:

<Directory "/Users/youruser/Sites/snipe-it/public/">
	Allow From All
	AllowOverride All
	Options +Indexes
</Directory>
<VirtualHost *:80>
	ServerName "www.yourserver.com"
	DocumentRoot "/Users/youruser/Sites/snipe-it/public"
SetEnv LARAVEL_ENV development
</VirtualHost>

8) Seed the Database

Loading up the sample data will give you an idea of how this should look, how your info should be structured, etc. It only pre-loads a handful of items, so you won't have to spend an hour deleting sample data.

php artisan db:seed

If you run this command on a database that already has your own asset data in it, it will over-write your database. ALL of your data will be gone. NEVER run the db seeder on production after on your initial install.

Application logs

Application logs for this app are found in app/storage/logs, as is customary of Laravel.

Running this on an EC2 Micro Instance

Depending on your needs, you could probably run this system in an EC2 micro instance. It doesn't take up very much memory and typically won't be a super-high-traffic application. EC2 micros fall into the free/dirt-cheap tier, which might make this a nice option. One thing to note though - composer can be a little memory-intensive while you're running updates, and you may have trouble with it failing on a micro. You can crank the memory_limit up in php.ini, but EC2 micros have swap disabled by default, so even that may not cut it. If you run into totally unhelpful error messages while running composer updates (like simply 'Killed') or fatal memory issues mentioning phar, your best bet will be to enable swap:

sudo /bin/dd if=/dev/zero of=/var/swap.1 bs=1M count=1024
sudo /sbin/mkswap /var/swap.1
sudo /sbin/swapon /var/swap.1

If you need more than 1024MB then change that to something higher.

To enable it by default after reboot, add this line to /etc/fstab:

/var/swap.1 swap swap defaults 0 0

Developing & Contributing

Please be sure to see the contributing guidelines before submitting pull requests.

The only real difference in setting Snipe-IT up for local development versus setting it up for production usage is the configuration files, and remembering to add the local environment flag on the artisan commands.

You'll notice in your app/config directory, you have directories such as local, staging, and production. (The testing directory is reserved for unit tests, so don't mess with that one.)

You'll want to make sure you have the configuration files updated for whichever environment you're in, which will most likely be local.

If you run the command line tools without the local flag, it will default to the production environment, so you'll want to make sure you run the commands as:

php artisan key:generate --env=local
php artisan app:install --env=local

Set up the debugbar

In dev mode, I use the fabulous Laravel Debugbar by barryvdh. After you've installed/updated composer, you'll need to publish the assets for the debugbar:

php artisan debugbar:publish

The profiler is enabled by default if you have debug set to true in your app.php. You certainly don't have to use it, but it's pretty handy for troubleshooting queries, seeing how much memory your pages are using, etc.

Purging the autoloader

If you're doing any development on this, make sure you purge the auto-loader if you see any errors stating the new model you created can't be found, etc, otherwise your new models won't be grokked.

php composer.phar dump-autoload

License

Copyright (C) 2013 Alison Gianotto - snipe@snipe.net

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

Languages

PHP 91.8%

Blade 6.9%

Less 0.8%

JavaScript 0.3%

Shell 0.2%

README.md

Snipe-IT - Asset Management For the Rest of Us