1
0
mirror of https://github.com/invoiceninja/invoiceninja.git synced 2024-11-08 12:12:48 +01:00
invoiceninja/docs/mobile_apps.rst

55 lines
2.0 KiB
ReStructuredText
Raw Normal View History

2017-04-11 22:51:16 +02:00
Mobile Applications
===================
2023-01-16 23:03:51 +01:00
For Version 5.x documentation, please go to `invoiceninja.github.io <https://invoiceninja.github.io/>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2017-04-11 22:51:16 +02:00
The Invoice Ninja iPhone and Android applications allows a user to connect to their self-hosted Invoice Ninja web application.
2017-09-29 12:02:43 +02:00
.. TIP:: If you're unable to access the Android app store you can download the APK here: https://download.invoiceninja.com/apk
2017-04-11 22:51:16 +02:00
Connecting your to your self-hosted invoice ninja installation requires a couple of easy steps.
2017-04-11 22:51:16 +02:00
Web App configuration
"""""""""""""""""""""
2017-04-11 22:51:16 +02:00
First, you'll need to add an additional field to your .env file which is located in the root directory of your self-hosted Invoice Ninja installation.
The additional field to add is API_SECRET, set this to your own defined alphanumeric string.
2016-09-20 13:23:42 +02:00
.. image:: images/env_file_api_secret.png
Save your .env file and now open Invoice Ninja on your iPhone.
2017-04-11 22:51:16 +02:00
Mobile App configuration
""""""""""""""""""""""""
2017-04-11 22:51:16 +02:00
Once you have completed the in-app purchase to unlock the mobile app to connect to your own server, you'll be presented with two fields.
2019-07-21 08:28:24 +02:00
The first is the Base URL of your self-hosted installation, ie. https://ninja.example.com or https://ninja.example.com/public
The second field is the API_SECRET, enter in the API_SECRET you used in your .env file.
2016-09-20 13:23:42 +02:00
.. image:: images/iphone_self_hosted.png
Click SAVE.
2017-08-15 14:16:17 +02:00
You should now be able to login with your username and password!
FAQ:
""""
Q: I get a HTTP 500 error.
A: Most likely you have not entered your API_SECRET in your .env file
2017-04-11 22:51:16 +02:00
Q: I get a HTTP 403 error when i attempt to login with the iPhone or Android device.
2017-04-11 22:51:16 +02:00
A: Most likely your API_SECRET on the iPhone/Android device does not match that on your self-hosted installation.
Q: Do I need to create a token on the server?
A: No, this is not required. The server will automagically create a token if one does not exist on first login.