envayasms/.phrozn/entries/install/index.twig

id: install
title: Installing EnvayaSMS
---
In order to install and deploy EnvayaSMS, you will need the following prerequisites:

<ul>
    <li>An Android phone (1.6 or higher),  registered on a mobile network
    </li>
    <li>A way for the phone to connect to the internet, either via Wi-Fi
    or mobile data service<br  />
    (Even with Wi-Fi, mobile data service is necessary to receive MMS messages.)</li>
    <li>A web server accessible from the public internet</li>
</ul>

<p>
Note: If you don't have an Android phone yet, you can <a href='/test/'>test EnvayaSMS on your computer</a>.
</p>

To install EnvayaSMS on an Android phone, open EnvayaSMS on Android Market by clicking the link below from your phone's browser, or scanning the barcode with a QR code app.<br />

<div style='float:left;padding-right:10px;padding-top:20px'>
<div style='font-size:16px;font-weight:bold; text-align:center'>
<a href="https://market.android.com/details?id=org.envaya.sms">Open Android Market</a>
</div>
<a href="https://market.android.com/details?id=org.envaya.sms">
<img src='/media/qr.png' width='175' height='175' />
</a>
</div>

<div style='float:left;padding-top:10px'>
<img src='/media/screenshot-market.png' style='border:1px solid black' width='440' height='218' />
</div>

<div style='clear:both;padding-top:10px'>

<p>
In order to download from Android Market, you will need a Google account and the Market app on your phone. 
Alternatively, you can also install download EnvayaSMS directly from the link below:
</p>
<strong><a href='https://github.com/downloads/youngj/EnvayaSMS/EnvayaSMS-release.apk'>EnvayaSMS-release.apk</a></strong>
<p>
Software developers may also <a href="https://github.com/youngj/EnvayaSMS">download the source code from GitHub</a>
and build EnvayaSMS themselves.
</p>
</div>


<h2>Configuring EnvayaSMS</h2>

<h3>Server Configuration</h3>

<p>
It is assumed that your organization already has an HTTP server, or has the technical expertise to set up an HTTP server.
</p>

<p>
Follow the instructions in the <a href='/serverapi/'>API Reference</a> page to learn how to construct a 
resource on your HTTP server that can communicate with EnvayaSMS.
</p>

<h3>Phone Configuration</h3>

<div style='float:right;padding-left:10px;padding-bottom:10px'>    
<img src='/media/screenshot-settings.png' width='212' height='350' />
</div>


<p>
After your server is configured, configure EnvayaSMS on your phone to connect to your server as follows:
</p>

<ol>

<li>Open the EnvayaSMS app</li>
<li>Click the Menu button, then "Settings"</li>
<li>Configure EnvayaSMS to work with your server by entering:</li>
        <ul>
            <li>your server URL</li>
            <li>your phone number</li>
            <li>the password shared with the server</li>
        </ul>
<li>Choose an interval to poll for new outgoing messages</li>
<li><em>Recommended:</em> under Wi-Fi sleep policy, select "always stay connected".
    (Otherwise, EnvayaSMS will be unable to forward messages after the phone goes to sleep.)
</li>
<li><em>Optional:</em> enable Network Failover so that the phone will automatically switch 
to mobile data if the Wi-Fi network stops working.
</li>
<li>Check "Enable EnvayaSMS"</li>
<li>Click the Back button to return to the main screen</li>
</ol>

<p>
To test if EnvayaSMS has been configured properly and can connect
to your server, open the EnvayaSMS app, click the Menu button, 
then click "Test Connection".
</p>

<p>
<strong>Important:</strong> After EnvayaSMS is enabled, it will forward all SMS messages regardless of whether the
EnvayaSMS app is open. If you want to use SMS normally again, return to EnvayaSMS' settings screen
and uncheck "Enable EnvayaSMS".</p>

<p>If you're testing EnvayaSMS with an Android phone that you're also using for normal communication, 
you can enable "Test mode" on the settings screen. When Test mode is enabled, EnvayaSMS will only handle SMS messages
from the phone numbers you specify.</p>

<h3 id='expansion'>Installing Expansion Packs</h3>

<p>
    By default, Android prevents EnvayaSMS from sending more than 100 outgoing SMS messages per hour. 
    However, that limit can be increased by installing EnvayaSMS Expansion Packs.
</p>
<p>
    Each Expansion Pack allows EnvayaSMS to increase its sending limit by an additional 100 outgoing SMS messages
    per hour. For example, if you install 8 expansion packs, EnvayaSMS will be able to send up to 900 outgoing SMS messages
    per hour.
</p>
<p>
    <a href="https://market.android.com/details?id=org.envaya.sms.pack01">Install EnvayaSMS Expansion Pack 01</a>
</p>
<p>
    With Expansion Packs, EnvayaSMS is limited only by how fast your phone can send and receive SMS (likely about 1000 messages/hour), 
    and by your mobile provider's usage limits and terms of service.
</p>
<p>
</p>