diff --git a/templates/InvoiceNinja/0/README.md b/templates/InvoiceNinja/0/README.md index 6c21e7f..e88fab4 100644 --- a/templates/InvoiceNinja/0/README.md +++ b/templates/InvoiceNinja/0/README.md @@ -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= 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=` 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 \ No newline at end of file +### Required Configuration Files + +* Place a "nginx.conf" file in the `/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 `/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 \ No newline at end of file