Mirrors/invoiceninja
1
0
Fork 0
mirror of https://github.com/invoiceninja/invoiceninja.git synced 2024-09-20 00:11:35 +02:00
Code Issues Releases Activity

Update configure docs

Browse Source
This commit is contained in:
Hillel Coren 2017-05-23 22:00:40 +03:00
parent a1437e4b98
commit 6c9a484aa8
1 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/configure.rst
View File

@ -49,19 +49,23 @@ Create an application in either Google, Facebook, GitHub or LinkedIn and then se
PhantomJS
"""""""""
We use phantomjscloud.com to attach PDFs to emails sent by background processes. Check for the following line in the .env file to enable this feature or sign up to increase your daily limit.
There are two methods to attach PDFs to emails sent by background processes: phantomjscloud.com or local PhantomJS install.
To use phantomjscloud.com check for the following line in the .env file.
.. code-block:: shell
PHANTOMJS_CLOUD_KEY='a-demo-key-with-low-quota-per-ip-address'
If you require contacts to enter a password to see their invoice you'll need to set a random value for ``PHANTOMJS_SECRET``.
To use a local PhantomJS install add ``PHANTOMJS_BIN_PATH=/usr/local/bin/phantomjs``.
You can install PhantomJS to generate the PDF locally, to enable it add ``PHANTOMJS_BIN_PATH=/usr/local/bin/phantomjs``.
Troubleshooting
---------------
We suggest using version >= 2.1.1, users have reported seeing 'Error: 0' with older versions.
.. TIP:: To determine the path you can run ``which phantomjs`` from the command line.
- To determine the path you can run ``which phantomjs`` from the command line.
- We suggest using PhantomJS version >= 2.1.1, users have reported seeing 'Error: 0' with older versions.
- You can use `this script <https://raw.githubusercontent.com/invoiceninja/invoiceninja/develop/resources/test.pjs>`_ to test from the command line, change ``__YOUR_LINK_HERE__`` to a 'View as recipient' link.
- If you require contacts to enter a password to see their invoice you'll need to set a random value for ``PHANTOMJS_SECRET``.
Custom Fonts
""""""""""""