Installation

Prerequisites

The core of Paperless does not require OS X. However, all of the integrations are developed to use applications that run on OS X. Therefore, as the project currently stands, you will need to be running OS X.

Install For Not-So-Much-Geeks

There is a nice installer that was built so that you don't have to attempt to get down and dirty with the command-line. You can get it at https://github.com/joeworkman/paperless-install.

Install For Geeks (with command-line voodoo)

Ruby

Paperless was developed and fully tested using Ruby v1.9.3. It has not been verified to using older versions of ruby. OS X ships with ruby v1.8.7. This means that you will need to install your own version of ruby.

I recommend that you install RVM. Its makes it really simple to manage ruby installs. You also will not need to worry about any OS X updates messing things up.

Paperless if pretty easy to install once you have the proper environment built mentioned in the prerequisites. Its just a gem command away...

Install gem

1. Install it via the gem command in terminal:

   $ gem install paperless

2. You can now execute it:

   $ paperless help

3. Setup the config file:

   $ paperless initconfig

4. Edit the config file and add your customizations:

   $ paperless editconfig

Installing Updates

Since Paperless is a ruby gem, you can use the standard methodology to obtain updates.

$ gem update paperless