Skip to content

Commit 604467d

Browse files
authored
Merge pull request #93 from smswithoutborders/dev
updated gateway client tutorail
2 parents e5e4464 + c77d500 commit 604467d

12 files changed

Lines changed: 61 additions & 75 deletions

File tree

docs/Android Tutorial/Getting-Started-With-Android.md

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ This method is ideal if you want to post to platforms like **Gmail, Twitter, or
2323

2424
Steps to Use the Platform Feature:
2525

26-
1. **Download the RelaySMS app.**
26+
### 1. **Download the RelaySMS app.**
2727

2828

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

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

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

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

45-
3. **Create an account:**
45+
### 3. **Create an account:**
4646

4747
- Tap Sign Up.
4848

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

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

6565
<img src="/SAndroid/Login.png" alt="onbording2" class="resized-image"/>
66-
5. **Verify your phone:**
66+
67+
### 5. **Verify your phone:**
6768

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

7273

73-
6. **Save your platforms:**
74+
### 6. **Save your platforms:**
7475

7576

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

9091

91-
92-
7. **Choose a Gateway Client:**
92+
### 7. **Choose a Gateway Client:**
9393

9494

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

108108

109-
8. **Send a message:**
109+
### 8. **Send a message:**
110110

111111

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

136136
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.
137137

138-
**Enabling On-Device Token Storage**
138+
## **Enabling On-Device Token Storage**
139139

140140
To start storing your access tokens locally on your device:
141141

142-
1. Open the **RelaySMS** app.
142+
### 1. Open the **RelaySMS** app.
143143

144144
<img src="/SAndroid/Afterlogin.png" alt="GatewayAvailable" class="resized-image"/>
145-
2. Tap on **Settings**.
145+
146+
### 2. Tap on **Settings**.
147+
146148
<img src="/SAndroid/settings.png" alt="GatewayAvailable" class="resized-image"/>
147149

148-
3. Go to the **Publishing**section.
150+
### 3. Go to the **Publishing**section.
149151

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

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

154156

155-
**What happens next?**
157+
## **What happens next?**
156158

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

159161

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

162-
**Disabling On-Device Token Storage**
164+
## **Disabling On-Device Token Storage**
163165

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

166-
1. Go to **Settings > Publishing.**
168+
### 1. Go to **Settings > Publishing.**
167169

170+
171+
### 2. Switch the **“Store tokens on-device”** toggle **OFF.**
168172

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

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

179182

180-
181-
**Refreshing Twitter Tokens (For On-Device Use Only)**
183+
### **Refreshing Twitter Tokens (For On-Device Use Only)**
182184

183185
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.
184186

185187
Here’s how:
186188

187-
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**.
188-
189+
### 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**.
189190

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

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

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

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

196-
4. **Paste** the full SMS message into the inbox.
197197

198+
### 4. **Paste** the full SMS message into the inbox.
198199

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

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

202-
6. You’re now ready to send your next tweet.
203+
204+
### 6. You’re now ready to send your next tweet.
203205

204206

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

207209

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

docs/Gateway Clients Guide/GatewayClientsGuide.md

Lines changed: 31 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -9,81 +9,67 @@ Follow this simple guide to set up and configure a Deku SMS Gateway Client on yo
99
## Requirements for Setting Up a Gateway Client:
1010

1111
### Android Device:
12-
13-
- Your device must be able to connect to the internet.
14-
- It should have a SIM card capable of receiving SMS messages.
12+
Your device must be able to connect to the internet.
13+
It should have a SIM card capable of receiving SMS messages.
1514

1615
### Internet Connection:
17-
18-
- You will need a reliable internet connection (Wi-Fi or mobile data).
19-
- Deku SMS uses very little data, so mobile data is sufficient.
16+
You will need a reliable internet connection (Wi-Fi or mobile data).
17+
Deku SMS uses very little data, so mobile data is sufficient.
2018

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

2321
### Step 1: Download the Deku SMS App
24-
2522
You can download the Deku SMS app from one of the following sources:
26-
27-
- [Google Play Store](https://play.google.com/store/apps/details?id=com.afkanerd.deku)
28-
- [F-Droid](https://f-droid.org/packages/com.afkanerd.deku/)
29-
- [GitHub Releases](https://github.com/deku-messaging/Deku-SMS-Android/releases)
23+
- Google Play Store
24+
- F-Droid
25+
- GitHub Releases
3026

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

29+
<img src="/GatewayHosting/1.png" alt="GatewayAvailable" class="resized-image"/>
30+
3331
Once the app is installed, set it as the default SMS app on your Android device.
3432

3533
### Step 3: Configure Message Forwarding
3634

37-
<img src="/GatewayHosting/1-messageForwarding.png" alt="onbording1" class="resized-image"/>
38-
39-
1. Open the Deku SMS app.
40-
41-
2. Tap on the three dots in the top right corner of the app.
35+
<img src="/GatewayHosting/2.png" alt="GatewayAvailable" class="resized-image"/>
4236

43-
3. From the dropdown menu, select **Message Forwarding**.
37+
Open the Deku SMS app.
38+
Tap on the three dots in the top right corner of the app.
39+
From the dropdown menu, select Message Forwarding.
4440

4541
### Step 4: Add a Gateway Server
4642

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

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

54-
2. Select **View Gateway Servers** from the dropdown.
55-
56-
<div style={{ display: 'flex', justifyContent: 'space-around', gap: '10px' }}>
57-
<img src="/GatewayHosting/4-sms-routing-gateway.png" alt="Deku SMS App" class="resized-image" />
58-
<img src="/GatewayHosting/5-selectHTTPS.png" alt="Deku SMS App" class="resized-image" />
59-
</div>
60-
61-
3. Tap the three dots once more and choose **Add HTTPS Gateway Server**.
62-
63-
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.
48+
Tap on the menu dots in the top right corner of the routed messages page.
49+
Tap on the three dots in the top right corner of the Gateway clients messages page.
50+
Tap the three dots once more and choose Add HTTPS Forwarders.
6451

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

67-
<img src="/GatewayHosting/6-FillRequirement.png" alt="Deku SMS App" class="resized-image" />
68-
69-
- **URL 1**: Enter the following URL:
70-
`https://gatewayserver.smswithoutborders.com/v3/publish`
56+
Enter the following URL:
57+
https://gatewayserver.smswithoutborders.com/v3/publish
7158

72-
- **Tag**: Enter a name for your gateway server.
59+
Tag: Enter a name for your gateway server.
7360

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

7663
### Step 6: Finalize the Setup
7764

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

80-
1. Tap **Add** to save your gateway server configuration.
67+
Tap Save to save your gateway server configuration.
8168

82-
2. Repeat the process and add the second gateway server with **URL 2**:
83-
`https://gatewayserver.smswithoutborders.com/sms/platform/android`
84-
85-
<img src="/GatewayHosting/8-smsroutinggate.png" alt="Deku SMS App" class="resized-image" />
69+
<img src="/GatewayHosting/9.png" alt="GatewayAvailable" class="resized-image"/>
8670

8771
## Your Gateway Client is Now Ready!
8872

89-
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.
73+
74+
75+
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.

src/css/custom.css

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -206,6 +206,6 @@ h3, h4, h5, h6, p, li {
206206
color: #ffffff;
207207
}
208208
.resized-image {
209-
width: 200px;
209+
width: 300px;
210210
height: auto;
211211
}

static/GatewayHosting/1.png

348 KB
Loading

static/GatewayHosting/2.png

719 KB
Loading

static/GatewayHosting/3.png

217 KB
Loading

static/GatewayHosting/4.png

216 KB
Loading

static/GatewayHosting/5.png

242 KB
Loading

static/GatewayHosting/6.png

277 KB
Loading

static/GatewayHosting/7.png

427 KB
Loading

0 commit comments

Comments
 (0)