diff --git a/docs/images/env_file_api_secret.png b/docs/images/env_file_api_secret.png new file mode 100644 index 000000000000..ca647030590b Binary files /dev/null and b/docs/images/env_file_api_secret.png differ diff --git a/docs/images/iphone_self_hosted.png b/docs/images/iphone_self_hosted.png new file mode 100644 index 000000000000..503e2cc1aafa Binary files /dev/null and b/docs/images/iphone_self_hosted.png differ diff --git a/docs/index.rst b/docs/index.rst index 44c8ee9aaf66..411e67bf98ec 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -36,3 +36,11 @@ Want to find out everything there is to know about how to use your Invoice Ninja data_visualizations api_tokens user_management + +.. _self_host: + +.. toctree:: + :maxdepth: 1 + :caption: Self Host + + iphone_app diff --git a/docs/iphone_app.rst b/docs/iphone_app.rst new file mode 100644 index 000000000000..5cb6dcce34f0 --- /dev/null +++ b/docs/iphone_app.rst @@ -0,0 +1,49 @@ +iPhone Application +================== + +The Invoice Ninja iPhone application allows a user to connect to their self-hosted Invoice Ninja web application. + +Connecting your iPhone to your self-hosted invoice ninja installation requires a couple of easy steps. + +Web app configuration +""""""""""""""""""""" + +Firstly 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. + +.. image:: images/env_file_api_secret.png + +Save your .env file and now open Invoice Ninja on your iPhone. + + +iPhone configuration +"""""""""""""""""""" + +Once you have completed the in-app purchase to unlock the iPhone to connect to your own server, you'll be presented with two fields. + +The first is the Base URL of your self-hosted installation, ie http://ninja.yourapp.com + +The second field is the API_SECRET, enter in the API_SECRET you used in your .env file. + +.. image:: images/iphone_self_hosted.png + +Click SAVE. + +You should be able to login now from your iPhone! + + +FAQ: +"""" + +Q: I get a HTTP 500 error. + +A: Most likely you have not entered your API_SECRET in your .env file + +Q: I get a HTTP 403 error when i attempt to login with the iPhone. + +A: Most likely your API_SECRET on the iPhone 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.