Install

Thanks for taking the time to setup Invoice Ninja.

Note

The applications requires PHP >= 5.5.9 and MySQL.

Detailed Guides

Automated Installers

Tip

You can use github.com/turbo124/Plane2Ninja to migrate your data from InvoicePlane.

Steps to Install

Step 1: Download the code

You can either download the zip file below or checkout the code from our GitHub repository. The zip includes all third party libraries whereas using GitHub requires you to use Composer to install the dependencies.

https://download.invoiceninja.com

Note

All Pro and Enterprise features from our hosted app are included in both the zip file and the GitHub repository. We offer a $20 per year white-label license to remove our branding.

Step 2: Upload the code to your server

Copy the ZIP file to your server and then check that the storage folder has 755 permissions and is owned by the webserver user.

cd /path/to/ninja/code
chmod -R 755 storage
sudo chown -R www-data:www-data storage bootstrap public/logo

Step 3: Setup the database

You’ll need to create a new database along with a user to access it. Most hosting companies provide an interface to handle this or you can run the SQL statements below.

CREATE DATABASE ninja;
CREATE USER 'ninja'@'localhost' IDENTIFIED BY 'ninja';
GRANT ALL PRIVILEGES ON ninja.* TO 'ninja'@'localhost';

Step 4: Configure the web server

See the guides listed above for detailed information on configuring Apache or Nginx.

Once you can access the site the initial setup screen will enable you to configure the database and email settings as well as create the initial admin user.

Tip

To remove public/ from the URL map the webroot to the /public folder, alternatively you can uncomment RewriteRule ^(.*)$ public/$1 [L] in the .htaccess file.

Troubleshooting

  • Check your webserver log (ie, /var/log/apache2/error.log) and the application logs (storage/logs/laravel-error.log) for more details or set APP_DEBUG=true in .env
  • To resolve [Symfony\Component\Debug\Exception\FatalErrorException] Class 'SomeClass' not found try running php artisan optimize
  • To resolve file_put_contents(...): failed to open stream: Permission denied run chmod -R 777 storage then chmod -R 755 storage
  • If index.php is in the URL it likely means that mod_rewrite needs to be enabled.
  • Running composer install and composer dump-autoload can sometimes help with composer problems.
  • If you’re using a subdomain. ie, invoice.mycompany.com You will need to add RewriteBase / to public/.htaccess otherwise it may fail with Request exceeded the limit of 10 internal redirects due to probable configuration error. messages in the logs.
  • Composer install error: Fatal error: Allowed memory size of... Try the following: php -d memory_limit=-1 /usr/local/bin/composer install
  • PHP Fatal error: Call to undefined method Illuminate\Support\Facades\Session::get() try deleting bootstrap/cache/services.php