invoiceninja/docs/update.rst

Update
======

.. NOTE:: Note: v5 is now in beta. To upgrade from v4 you need to `install v5 <https://invoiceninja.github.io/selfhost.html>`_ as a separate app and then use the migration tool in the latest version of v4 on Settings > Account Management.

To update the app you just need to copy over the latest code. The app tracks the current version in a file called version.txt, if it notices a change it loads ``/update`` to run the database migrations.

https://download.invoiceninja.com

.. NOTE:: We recommend backing up your database with mysqldump before updating the app.

If you have trouble updating you can manually load /update to check for errors.

.. TIP:: We recommend using this `shell script <https://pastebin.com/j657uv9A>`_ to automate the update process, run it as a daily cron to automatically keep your app up to date.

If you're moving servers make sure to copy over the .env file.

You can manually run the update with the following commands. Once completed add ``?clear_cache=true`` to the end of the URL to clear the application cache.

.. code-block:: shell

   composer dump-autoload --optimize
   php artisan optimize --force
   php artisan migrate
   php artisan db:seed --class=UpdateSeeder

A common error with shared hosting is "open_basedir restriction in effect", if you see this you'll need to either temporarily modify your open_basedir settings or run the update from the command line.

.. NOTE:: If you've downloaded the code from GitHub you also need to run ``composer install``

.. TIP:: You can see the detailed changes for each release on our `GitHub release notes <https://github.com/invoiceninja/invoiceninja/releases>`_.

Version 4.3
"""""""""""

You may need to manually delete ``bootstrap/cache/compiled.php``.

Version 4.0
"""""""""""

The minimum PHP version is now 7.0.0

If you're using a rijndael cipher run ``php artisan ninja:update-key --legacy=true`` to change to AES-256-CBC.

Version 3.2
"""""""""""

An import folder has been adding to storage/, you may need to run ``sudo chown -R www-data:www-data storage``

Version 2.5
"""""""""""

The minimum PHP version is now 5.5.9

Version 2.0
"""""""""""

Copy .env.example to .env and set config settings

If unset, set the app cipher to ``rijndael-256``.

Check that ``/path/to/ninja/storage`` has 755 permissions and is owned by the webserver user
Moving self host docs to readthedocs 2017-01-26 16:19:44 +01:00			`Update`
			`======`

Clarify v5 status 2020-08-27 14:28:54 +02:00			.. NOTE:: Note: v5 is now in beta. To upgrade from v4 you need to `install v5 <https://invoiceninja.github.io/selfhost.html>`_ as a separate app and then use the migration tool in the latest version of v4 on Settings > Account Management.
Moving self host docs to readthedocs 2017-01-26 16:19:44 +01:00
Working on docs 2017-01-26 19:08:48 +01:00			To update the app you just need to copy over the latest code. The app tracks the current version in a file called version.txt, if it notices a change it loads ``/update`` to run the database migrations.
Moving self host docs to readthedocs 2017-01-26 16:19:44 +01:00
Add download link to update docs 2017-08-17 09:35:51 +02:00			`https://download.invoiceninja.com`

Clarify v5 status 2020-08-27 14:28:54 +02:00			`.. NOTE:: We recommend backing up your database with mysqldump before updating the app.`

Update docs 2018-02-14 14:39:35 +01:00			`If you have trouble updating you can manually load /update to check for errors.`

update docs 2017-11-07 09:55:45 +01:00			.. TIP:: We recommend using this `shell script <https://pastebin.com/j657uv9A>`_ to automate the update process, run it as a daily cron to automatically keep your app up to date.
Update docs 2017-06-26 20:52:14 +02:00
Update docs 2017-06-04 15:05:51 +02:00			`If you're moving servers make sure to copy over the .env file.`

Update docs 2018-02-14 14:39:35 +01:00			You can manually run the update with the following commands. Once completed add ``?clear_cache=true`` to the end of the URL to clear the application cache.
Update docs 2017-12-06 13:04:52 +01:00
Working on docs 2017-01-26 16:37:35 +01:00			`.. code-block:: shell`
Moving self host docs to readthedocs 2017-01-26 16:19:44 +01:00
Working on docs 2017-01-26 16:37:35 +01:00			`composer dump-autoload --optimize`
			`php artisan optimize --force`
			`php artisan migrate`
			`php artisan db:seed --class=UpdateSeeder`
Moving self host docs to readthedocs 2017-01-26 16:19:44 +01:00
Update docs 2018-02-14 14:39:35 +01:00			`A common error with shared hosting is "open_basedir restriction in effect", if you see this you'll need to either temporarily modify your open_basedir settings or run the update from the command line.`

Add composer install to update docs 2017-03-22 12:58:40 +01:00			.. NOTE:: If you've downloaded the code from GitHub you also need to run ``composer install``

Update docs 2017-05-22 11:46:01 +02:00			.. TIP:: You can see the detailed changes for each release on our `GitHub release notes <https://github.com/invoiceninja/invoiceninja/releases>`_.

Update docs 2018-04-08 10:00:09 +02:00			`Version 4.3`
			`"""""""""""`

			You may need to manually delete ``bootstrap/cache/compiled.php``.

Update min php to 7 2017-11-15 10:54:23 +01:00			`Version 4.0`
Update docs 2018-04-08 10:00:09 +02:00			`"""""""""""`
Update min php to 7 2017-11-15 10:54:23 +01:00
			`The minimum PHP version is now 7.0.0`

Update docs 2017-12-14 10:17:27 +01:00			If you're using a rijndael cipher run ``php artisan ninja:update-key --legacy=true`` to change to AES-256-CBC.

Update docs 2017-04-12 08:50:23 +02:00			`Version 3.2`
			`"""""""""""`

Update docs 2017-04-12 09:08:10 +02:00			An import folder has been adding to storage/, you may need to run ``sudo chown -R www-data:www-data storage``
Update docs 2017-04-12 08:50:23 +02:00
Update docs 2017-12-25 14:00:24 +01:00			`Version 2.5`
Moving self host docs to readthedocs 2017-01-26 16:19:44 +01:00			`"""""""""""`

Update min php to 7 2017-11-15 10:54:23 +01:00			`The minimum PHP version is now 5.5.9`
Moving self host docs to readthedocs 2017-01-26 16:19:44 +01:00
			`Version 2.0`
			`"""""""""""`

Working on docs 2017-01-26 16:37:35 +01:00			`Copy .env.example to .env and set config settings`
Moving self host docs to readthedocs 2017-01-26 16:19:44 +01:00
Update docs 2017-12-25 14:00:24 +01:00			If unset, set the app cipher to ``rijndael-256``.
Moving self host docs to readthedocs 2017-01-26 16:19:44 +01:00
			Check that ``/path/to/ninja/storage`` has 755 permissions and is owned by the webserver user