IntenseFinance/firefly-iii
3
0
Fork 0
mirror of https://github.com/firefly-iii/firefly-iii.git synced 2025-02-25 18:45:27 -06:00
Code Issues Packages Projects Releases Wiki Activity

Updated Installation (markdown)

James Cole 2015-06-13 08:12:42 +02:00
parent 6ee33ab3d2
commit 48a8335708
1 changed files with 24 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

75
Installation.md

@ -1,73 +1,46 @@
## Normal installation # Normal installation
You will need: To install Firefly III you'll need to have the following:
* Access to the terminal of a Linux server with the following software: * A web server (Apache, nginx);
* Apache or nginx * A database server (MySQL, etc.);
* PHP 5.5+ * A GMail address or other mailing facilities.
* MySQL
* [Composer](https://getcomposer.org/)
* git
Make sure you have a MySQL database ready, together with the username and password for that database. Because Firefly III needs some special tools to install it, you must have access to the terminal on your web server. It's simply not enough to have web hosting where you may upload stuff.
### Git clone ## Prerequisites
Then login, find the root of the web server and run the following commands:
``git clone https://github.com/JC5/firefly-iii.git .`` * Access to [Composer](https://getcomposer.org/)
* Make sure you have a MySQL database ready, together with the username and password for that database.
This should checkout the entirety of Firefly III into the current directory. ## Installation steps
### Install dependencies Login to your webserver and go to the directory where you want to install Firefly III. Please keep in mind that the web root of Firefly III is in the ``firefly-iii/public/`` directory, so you may need to update your web server configuration.
Then, run the following command:
``composer update --prefer-dist --no-dev`` ``composer create-project grumpydictator/firefly-iii``
This should install all external dependencies. Everything will be installed in the ``firefly-iii/`` directory.
### Edit config file Open ``firefly-iii/.env``.
To continue, you need to copy ``.env.example`` to ``.env``. Edit the file to match your current environment.
Make sure the mentioned fields are exactly like this: * Change the DB_ settings as you see fit.
* Update the EMAIL_ settings as you see fit.
* If you want to track statistics, update the Google Analytics ID.
* Set RUNCLEANUP to ``false``
* Set SITE_OWNER to your own email address.
``` Once you've set this up, run the following commands:
APP_ENV=production
APP_DEBUG=false
```
Make sure you [generate a random key](https://identitysafe.norton.com/password-generator/) (max length: 32) for the ``APP_KEY`` field. * ``cd firefly-iii``
* ``php artisan migrate --seed --env=production``
### Migration
Once you've set this up, run the following command:
``php artisan migrate --seed --env=production``
### Storage directories.
Finally, make sure that the storage directories are writeable, _for example_ by using this command: Finally, make sure that the storage directories are writeable, _for example_ by using this command:
* ``chmod -R g+w storage`` * ``chmod -R g+w storage``
* ``chmod -R 777 storage`` * ``chmod -R 775 storage``
### Registering ### Registering
Surf to your web server, the ``public/`` directory is your root. You may want to change your web server's configuration so you can surf to / and get Firefly. Surf to your web server, the ``public/`` directory is your root. You may want to change your web server's configuration so you can surf to / and get Firefly.
You will see a Sign In screen. Use the Register pages to create a new account. You will see a Sign In screen. Use the Register pages to create a new account.
## Upgrading
An upgrade of Firefly III should be easy. First, go to the root of your application. This is not the ``public/`` directory, but rather the directory below it.
Run the following command to retreive the latest files from Github:
``git pull``
Run this command to find out what your _environment_ is. It's usually "production" but results may vary:
``php artisan env``
Then, run the following command to upgrade the database:
``php artisan migrate --env=xxxxx``
Make sure that you replace XXXX with your current environment.