Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 29 additions & 29 deletions docs/Android Tutorial/Getting-Started-With-Android.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ This method is ideal if you want to post to platforms like **Gmail, Twitter, or

Steps to Use the Platform Feature:

1. **Download the RelaySMS app.**
### 1. **Download the RelaySMS app.**


- [Google_Play_Store](https://play.google.com/store/apps/details?id=com.afkanerd.sw0b)
Expand All @@ -32,7 +32,7 @@ Steps to Use the Platform Feature:

<img src="/Android/Playstore.png" alt="onbording1" class="resized-image"/>

2. **Go through onboarding to get familiar.**
### 2. **Go through onboarding to get familiar.**
- Click the Make app default button (Optional)

<img src="/SAndroid/Welcome.png" alt="onbording1" class="resized-image"/>
Expand All @@ -42,7 +42,7 @@ Steps to Use the Platform Feature:
<img src="/SAndroid/SkipSecure.png" alt="onbording2" class="resized-image"/>
<img src="/SAndroid/MakeAppDefualt.png" alt="onbording2" class="resized-image"/>

3. **Create an account:**
### 3. **Create an account:**

- Tap Sign Up.

Expand All @@ -60,17 +60,18 @@ Steps to Use the Platform Feature:
<img src="/SAndroid/verification.png" alt="onbording2" class="resized-image"/>
<img src="/SAndroid/Afterlogin.png" alt="onbording2" class="resized-image"/>

4. **Already have an account?** Tap **Login**, fill in your details, click **Login**and put in the recaptcha code.
### 4. **Already have an account?** Tap **Login**, fill in your details, click **Login**and put in the recaptcha code.

<img src="/SAndroid/Login.png" alt="onbording2" class="resized-image"/>
5. **Verify your phone:**

### 5. **Verify your phone:**

<img src="/SAndroid/capcha.png" alt="onbording2" class="resized-image"/>
<img src="/SAndroid/verification.png" alt="onbording2" class="resized-image"/>
- Enter the SMS code you received and hit **Submit.**


6. **Save your platforms:**
### 6. **Save your platforms:**


- Tap the **Platforms** tab.
Expand All @@ -88,8 +89,7 @@ Steps to Use the Platform Feature:
- When successful, the icon will light up!



7. **Choose a Gateway Client:**
### 7. **Choose a Gateway Client:**


- Tap the **Country** tab.
Expand All @@ -106,7 +106,7 @@ Steps to Use the Platform Feature:
- Alternatively, you can select a gateway client from the list that pops up when you hit the send button after composing your message.


8. **Send a message:**
### 8. **Send a message:**


- On the **Recent** page, tap the **Compose icon.**
Expand Down Expand Up @@ -135,38 +135,41 @@ Your encrypted message will appear there, just hit Send.*

Our **"Store Tokens On-Device"** feature gives you more control over your account credentials by keeping your access tokens on your phone instead of on the RelaySMS servers. This tutorial walks you through how to enable or disable this feature and how to refresh Twitter tokens when using local storage.

**Enabling On-Device Token Storage**
## **Enabling On-Device Token Storage**

To start storing your access tokens locally on your device:

1. Open the **RelaySMS** app.
### 1. Open the **RelaySMS** app.

<img src="/SAndroid/Afterlogin.png" alt="GatewayAvailable" class="resized-image"/>
2. Tap on **Settings**.

### 2. Tap on **Settings**.

<img src="/SAndroid/settings.png" alt="GatewayAvailable" class="resized-image"/>

3. Go to the **Publishing**section.
### 3. Go to the **Publishing**section.

<img src="/SAndroid/deleteAccount.png" alt="GatewayAvailable" class="resized-image"/>

4. Find the toggle for **“Store tokens on-device”** and switch it **ON.**
### 4. Find the toggle for **“Store tokens on-device”** and switch it **ON.**


**What happens next?**
## **What happens next?**

- All access tokens that were previously stored on RelaySMS servers will be securely transferred to your device.


- From now on, all **new tokens** will only be stored **locally** on your phone.

**Disabling On-Device Token Storage**
## **Disabling On-Device Token Storage**

To stop using local token storage and go back to storing tokens on the cloud:

1. Go to **Settings > Publishing.**
### 1. Go to **Settings > Publishing.**


### 2. Switch the **“Store tokens on-device”** toggle **OFF.**

2. Switch the **“Store tokens on-device”** toggle **OFF.**
<img src="/SAndroid/deleteAccount.png" alt="GatewayAvailable" class="resized-image"/>

**What this means:**
Expand All @@ -177,35 +180,32 @@ To stop using local token storage and go back to storing tokens on the cloud:
- However, **new tokens** generated after this will be saved to the **RelaySMS cloud server**, not your device.



**Refreshing Twitter Tokens (For On-Device Use Only)**
### **Refreshing Twitter Tokens (For On-Device Use Only)**

Due to Twitter's security limitations, tokens stored on your device can only be used **once per tweet**. To send another tweet, you’ll need to **revoke and restore** the token.

Here’s how:

1. After sending a tweet, you’ll receive an **SMS delivery status message**. If you're using an on-device token, this message will include a **refreshed Twitter token**.

### 1. After sending a tweet, you’ll receive an **SMS delivery status message**. If you're using an on-device token, this message will include a **refreshed Twitter token**.

2. **Copy the entire SMS message** (as-is).

### 2. **Copy the entire SMS message** (as-is).

3. Open the **RelaySMS app** and go to the **Inbox** section.

### 3. Open the **RelaySMS app** and go to the **Inbox** section.

4. **Paste** the full SMS message into the inbox.

### 4. **Paste** the full SMS message into the inbox.

5. The app will automatically extract and refresh your Twitter token.

### 5. The app will automatically extract and refresh your Twitter token.

6. You’re now ready to send your next tweet.

### 6. You’re now ready to send your next tweet.


Repeat this process **after every Twitter message** if you're using local token storage.




## [How to Use the On-Device Token Storage Feature](/docs/On-Device%20Tutorial/On-DeviceToken#how-to-use-the-on-device-token-storage-feature)

76 changes: 31 additions & 45 deletions docs/Gateway Clients Guide/GatewayClientsGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,81 +9,67 @@ Follow this simple guide to set up and configure a Deku SMS Gateway Client on yo
## Requirements for Setting Up a Gateway Client:

### Android Device:

- Your device must be able to connect to the internet.
- It should have a SIM card capable of receiving SMS messages.
Your device must be able to connect to the internet.
It should have a SIM card capable of receiving SMS messages.

### Internet Connection:

- You will need a reliable internet connection (Wi-Fi or mobile data).
- Deku SMS uses very little data, so mobile data is sufficient.
You will need a reliable internet connection (Wi-Fi or mobile data).
Deku SMS uses very little data, so mobile data is sufficient.

## Steps to Configure Deku SMS on an Android Device:

### Step 1: Download the Deku SMS App

You can download the Deku SMS app from one of the following sources:

- [Google Play Store](https://play.google.com/store/apps/details?id=com.afkanerd.deku)
- [F-Droid](https://f-droid.org/packages/com.afkanerd.deku/)
- [GitHub Releases](https://github.com/deku-messaging/Deku-SMS-Android/releases)
- Google Play Store
- F-Droid
- GitHub Releases

### Step 2: Set Deku SMS as Your Default SMS App

<img src="/GatewayHosting/1.png" alt="GatewayAvailable" class="resized-image"/>

Once the app is installed, set it as the default SMS app on your Android device.

### Step 3: Configure Message Forwarding

<img src="/GatewayHosting/1-messageForwarding.png" alt="onbording1" class="resized-image"/>

1. Open the Deku SMS app.

2. Tap on the three dots in the top right corner of the app.
<img src="/GatewayHosting/2.png" alt="GatewayAvailable" class="resized-image"/>

3. From the dropdown menu, select **Message Forwarding**.
Open the Deku SMS app.
Tap on the three dots in the top right corner of the app.
From the dropdown menu, select Message Forwarding.

### Step 4: Add a Gateway Server

<div style={{ display: 'flex', justifyContent: 'space-around', gap: '10px' }}>
<img src="/GatewayHosting/2-forwarding.png" alt="Deku SMS App" class="resized-image" />
<img src="/GatewayHosting/3-viewGatewayServers.png" alt="Deku SMS App" class="resized-image" />
</div>
<img src="/GatewayHosting/3.png" alt="GatewayAvailable" class="resized-image"/>
<img src="/GatewayHosting/4.png" alt="GatewayAvailable" class="resized-image"/>
<img src="/GatewayHosting/5.png" alt="GatewayAvailable" class="resized-image"/>

1. Tap on the three dots in the top right corner again.

2. Select **View Gateway Servers** from the dropdown.

<div style={{ display: 'flex', justifyContent: 'space-around', gap: '10px' }}>
<img src="/GatewayHosting/4-sms-routing-gateway.png" alt="Deku SMS App" class="resized-image" />
<img src="/GatewayHosting/5-selectHTTPS.png" alt="Deku SMS App" class="resized-image" />
</div>

3. Tap the three dots once more and choose **Add HTTPS Gateway Server**.

4. Two gateway servers need to be added in order for both Android and iOS users of the RelaySMS app to use the gateway client to publish their messages online.
Tap on the menu dots in the top right corner of the routed messages page.
Tap on the three dots in the top right corner of the Gateway clients messages page.
Tap the three dots once more and choose Add HTTPS Forwarders.

### Step 5: Fill in the Required Information
<img src="/GatewayHosting/6.png" alt="GatewayAvailable" class="resized-image"/>
<img src="/GatewayHosting/7.png" alt="GatewayAvailable" class="resized-image"/>

<img src="/GatewayHosting/6-FillRequirement.png" alt="Deku SMS App" class="resized-image" />

- **URL 1**: Enter the following URL:
`https://gatewayserver.smswithoutborders.com/v3/publish`
Enter the following URL:
https://gatewayserver.smswithoutborders.com/v3/publish

- **Tag**: Enter a name for your gateway server.
Tag: Enter a name for your gateway server.

- **Check "All"**: Ensure the "All" checkbox is checked to route all SMS messages through the server.
Check "All": Ensure the "All" checkbox is checked to route all SMS messages through the server.

### Step 6: Finalize the Setup

<img src="/GatewayHosting/7-addhttps.png" alt="Deku SMS App" class="resized-image" />
<img src="/GatewayHosting/8.png" alt="GatewayAvailable" class="resized-image"/>

1. Tap **Add** to save your gateway server configuration.
Tap Save to save your gateway server configuration.

2. Repeat the process and add the second gateway server with **URL 2**:
`https://gatewayserver.smswithoutborders.com/sms/platform/android`

<img src="/GatewayHosting/8-smsroutinggate.png" alt="Deku SMS App" class="resized-image" />
<img src="/GatewayHosting/9.png" alt="GatewayAvailable" class="resized-image"/>

## Your Gateway Client is Now Ready!

You can now share your number with RelaySMS users. Your Android device will act as a gateway client, helping route messages through the Deku SMS app.


You can now share your number with RelaySMS users. Your Android device will act as a gateway client, helping route messages through the Deku SMS app.
Loading
Loading