diff --git a/docs/index.rst b/docs/index.rst index b5e5c910ce1e..c57ce6902d1d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -46,7 +46,7 @@ Want to find out everything there is to know about how to use your Invoice Ninja install configure update - iphone_app + mobile_apps api developer_guide custom_modules diff --git a/docs/iphone_app.rst b/docs/mobile_apps.rst similarity index 50% rename from docs/iphone_app.rst rename to docs/mobile_apps.rst index 5cb6dcce34f0..f5d2269ed8c6 100644 --- a/docs/iphone_app.rst +++ b/docs/mobile_apps.rst @@ -1,14 +1,14 @@ -iPhone Application -================== +Mobile Applications +=================== -The Invoice Ninja iPhone application allows a user to connect to their self-hosted Invoice Ninja web application. +The Invoice Ninja iPhone and Android applications 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. +Connecting your to your self-hosted invoice ninja installation requires a couple of easy steps. -Web app configuration +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. +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. @@ -17,10 +17,10 @@ The additional field to add is API_SECRET, set this to your own defined alphanum Save your .env file and now open Invoice Ninja on your iPhone. -iPhone configuration -"""""""""""""""""""" +Mobile App 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. +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. The first is the Base URL of your self-hosted installation, ie http://ninja.yourapp.com @@ -30,7 +30,7 @@ The second field is the API_SECRET, enter in the API_SECRET you used in your .en Click SAVE. -You should be able to login now from your iPhone! +You should now be able to login! FAQ: @@ -40,9 +40,9 @@ 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. +Q: I get a HTTP 403 error when i attempt to login with the iPhone or Android device. -A: Most likely your API_SECRET on the iPhone does not match that on your self-hosted installation. +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?