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

Hopefully HTML is parsed

Browse Source
This commit is contained in:
WilliamMiceli
2019-01-01 23:02:37 -05:00
parent f34abe2fc6
commit 6aebf621ab
1 changed files with 18 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1,35 +1,28 @@
# Invoice Ninja # Invoice Ninja
<br />
[Hosted Official Website](https://www.invoiceninja.com/) [Hosted Official Website](https://www.invoiceninja.com/)
[Self-Hosted Official Website](https://www.invoiceninja.org/) [Self-Hosted Official Website](https://www.invoiceninja.org/)
[Docker Page](https://hub.docker.com/r/invoiceninja/invoiceninja/) [Docker Page](https://hub.docker.com/r/invoiceninja/invoiceninja/)
<br />
## Description ## Description
<br />
Free Open-Source Invoicing Free Open-Source Invoicing
Expenses & time-tracking built with Laravel Expenses & time-tracking built with Laravel
<br />
## Pre-Deployment ## Pre-Deployment
<br />
### Optional Features Preparation ### Optional Features Preparation
<br />
#### Google Maps Integration #### Google Maps Integration
<br />
1. [Get an API Key Here](https://developers.google.com/maps/documentation/javascript/get-api-key). 1. [Get an API Key Here](https://developers.google.com/maps/documentation/javascript/get-api-key).
2. Insert `GOOGLE_MAPS_API_KEY=<Your API Key>` into your .env file. 2. Insert `GOOGLE_MAPS_API_KEY=<Your API Key>` into your .env file.
<br />
### Required Configuration Files ### Required Configuration Files
<br />
* Place a "nginx.conf" file in the `<Stack Directory>/Configuration` directory. * Place a "nginx.conf" file in the `<Stack Directory>/Configuration` directory.
* An Example can be found in the "Resources" directory for this catalog item. * 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. * 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.
@@ -37,31 +30,22 @@
* An example can be found in the "Resources" directory for this catalog item. * 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. * 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. * [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.
<br />
## Tips ## Tips
<br />
* 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. * 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.
<br />
## Backing Up Your Instance ## Backing Up Your Instance
<br />
### Complete Backup ### Complete Backup
<br />
Through the MySQL container, run a MySQL Dump. Through the MySQL container, run a MySQL Dump.
(Will complete this later) (Will complete this later)
<br />
### Easy Backup ### Easy Backup
<br />
The web interface provides an easy backup method by exporting to a JSON file, which saves most information. The web interface provides an easy backup method by exporting to a JSON file, which saves most information.
<br />
## TODO ## TODO
<br />
* Add more integration instructions * Add more integration instructions