William/Personal-Rancher-Catalog
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Major overhaul of deployment guide

Browse Source
This commit is contained in:
WilliamMiceli
2019-01-01 22:45:08 -05:00
parent 98b476e058
commit d5c40bcb88
1 changed files with 34 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
templates/InvoiceNinja/0/README.md
View File

@@ -6,23 +6,46 @@
[Docker Page](https://hub.docker.com/r/invoiceninja/invoiceninja/)
## From Website
## Description
Free Open-Source Invoicing
Expenses & time-tracking built with Laravel
### Pre-Installation:
## Pre-Deployment
Make sure that you have a "nginx.conf" file for the nginx container.
Copying the default one located [on their GitHub](https://github.com/invoiceninja/dockerfiles/blob/master/docker-compose/nginx.conf) should be sufficient.
### Optional Features Preparation
You may need to "chmod -R 777 storage" in the "App" container.
#### Google Maps Integration
Google Maps:
Get an API Key [Here](https://developers.google.com/maps/documentation/javascript/get-api-key) first.
Then add GOOGLE_MAPS_API_KEY=<your key> in your .env file.
1. [Get an API Key Here](https://developers.google.com/maps/documentation/javascript/get-api-key).
If using without HTTPS (like using the direct IP instead of through Traefik), please take out the line: "fastcgi_param HTTPS 1;" from your nginx.conf
2. Insert `GOOGLE_MAPS_API_KEY=<Your API Key>` into your .env file.
### To-Do List
* Add documentation for easier adding environment variables, and see if there's a better way to do so
### Required Configuration Files
* Place a "nginx.conf" file in the `<Stack Directory>/Configuration` directory.
* An Example can be found in the "Resources" directory for this catalog item.
* This file has been modified for this configuration, based on the [Example](https://github.com/invoiceninja/dockerfiles/blob/master/docker-compose/nginx.conf) located in the official GitHub repository.
* Place a ".env" file in the `<Stack Directory>/Configuration` directory.
* An example can be found in the "Resources" directory for this catalog item.
* This file has been modified for this configuration, based on the ".env.example" file provided within the container image.
* [A Configuration Guide](https://invoice-ninja.readthedocs.io/en/latest/configure.html) related to environment variables, along with the [Full Example](https://github.com/invoiceninja/invoiceninja/blob/master/.env.example) from the official GitHub repository.
## Tips
* With this configuration, DO NOT enable "Require HTTPS", as the connection between Traefik and InvoiceNinja is over non-SSL HTTP, and is not setup for internal HTTPS.
## Backing Up Your Instance
### Complete Backup
Through the MySQL container, run a MySQL Dump.
(Will complete this later)
### Easy Backup
The web interface provides an easy backup method by exporting to a JSON file, which saves most information.
## TODO
* Add more integration instructions