summaryrefslogtreecommitdiff
path: root/web/content.en/docs/android
diff options
context:
space:
mode:
Diffstat (limited to 'web/content.en/docs/android')
-rw-r--r--web/content.en/docs/android/_index.md5
-rw-r--r--web/content.en/docs/android/anyconnect.md.j297
-rw-r--r--web/content.en/docs/android/nekobox.md.j290
-rw-r--r--web/content.en/docs/android/nekossh.md.j296
4 files changed, 288 insertions, 0 deletions
diff --git a/web/content.en/docs/android/_index.md b/web/content.en/docs/android/_index.md
new file mode 100644
index 00000000..669d6c8b
--- /dev/null
+++ b/web/content.en/docs/android/_index.md
@@ -0,0 +1,5 @@
+---
+bookFlatSection: true
+title: Android Clients
+weight: 2
+---
diff --git a/web/content.en/docs/android/anyconnect.md.j2 b/web/content.en/docs/android/anyconnect.md.j2
new file mode 100644
index 00000000..c3a97a6e
--- /dev/null
+++ b/web/content.en/docs/android/anyconnect.md.j2
@@ -0,0 +1,97 @@
+---
+title: AnyConnect
+type: docs
+---
+
+# AnyConnect
+
+1. Install the android **Cisco AnyConnect** app from Google PlayStore. Click on the button below and it will take you to its Google Play Store page.
+
+{{ '{{<' }} button href="https://play.google.com/store/apps/details?id=com.cisco.anyconnect.vpn.android.avf&hl=en&gl=US" {{ '>}}' }}**Download Cisco AnyConnect from Google Play Store**{{ '{{<' }} /button {{ '>}}' }}
+
+2. Download your certificate file by clicking the button below:
+
+{{ '{{<' }} button href="/{{item}}/{{item}}-Certificate-Android.p12" {{ '>}}' }}**Download client .P12 certificate file**{{ '{{<' }} /button {{ '>}}' }}
+
+3. Launch the app.
+
+4. Click on **OK** to close the intial terms of service notice.
+
+![AnyConnect-01](/images/anyconnect-01.png)
+
+5. Grant it the relevant permissions (Access to your **notifications**, in this case).
+
+![AnyConnect-02](/images/anyconnect-02.png)
+
+6. Click on the menu button on top right corner and go to **“Settings”**.
+
+![AnyConnect-03](/images/anyconnect-03.png)
+
+7. Uncheck the second option that says **“Block Untrusted Servers”**.
+
+![AnyConnect-04](/images/anyconnect-04.png)
+
+8. Click on the arrow icon on top left corner to go back to the home menu of the app.
+
+9. In the middle of the screen, click on **“Connections”**.
+
+![AnyConnect-05](/images/anyconnect-05.png)
+
+10. Click on the + icon at the bottom of the screen.
+
+![AnyConnect-06](/images/anyconnect-06.png)
+
+11. In the next window:
+
+ 1. Enter any name you want.
+
+ 2. Enter the following server address and port: **{{ ansible_all_ipv4_addresses[0] }}:{{ ocserv_port | default(4430) }}**
+
+ 3. Once you entered the server address, click on **“Advanced Preferences”**.
+
+![AnyConnect-07](/images/anyconnect-07.png)
+
+12. Click on the first option that says **“Certificate”**.
+
+![AnyConnect-08](/images/anyconnect-08.png)
+
+13. Click on the **“Import”** button at the bottom of the screeen.
+
+![AnyConnect-09](/images/anyconnect-09.png)
+
+14. Click on **“File System”**. It should open your file browser app.
+
+![AnyConnect-10](/images/anyconnect-10.png)
+
+15. Find the **.p12 certificate** file that you downloaded in step 2.
+
+![AnyConnect-11](/images/anyconnect-11.png)
+
+16. It will ask for a password. The password is: **{{ item }}**
+
+![AnyConnect-12](/images/anyconnect-12.png)
+
+17. Once the certificate is imported, click on it.
+
+![AnyConnect-13](/images/anyconnect-13.png)
+
+18. Click on **“Done”** at the bottom of the screen, and click on **“Done”** again.
+
+![AnyConnect-14](/images/anyconnect-14.png)
+![AnyConnect-15](/images/anyconnect-15.png)
+
+19. Click on the arrow icon at the top left corner.
+
+![AnyConnect-16](/images/anyconnect-16.png)
+
+20. **Turn on** the VPN by clicking on the VPN toggle.
+
+![AnyConnect-17](/images/anyconnect-18.png)
+
+21. Click on **“Continue”**.
+
+![AnyConnect-18](/images/anyconnect-17.png)
+
+22. And that's it! You can check your IP location to ensure that you are connected to the VPN and it's working properly.
+
+![AnyConnect-19](/images/anyconnect-19.png) \ No newline at end of file
diff --git a/web/content.en/docs/android/nekobox.md.j2 b/web/content.en/docs/android/nekobox.md.j2
new file mode 100644
index 00000000..450635c9
--- /dev/null
+++ b/web/content.en/docs/android/nekobox.md.j2
@@ -0,0 +1,90 @@
+---
+title: NekoBox (V2Ray)
+type: docs
+weight: 1
+---
+
+# NekoBox
+
+In this tutorial you will learn how to use NekoBox VPN client on android devices.
+
+NekoBox is a VPN client supporting a variety of VPN protocols, and we will be using this handy client to use our main VPN protocols on android devices, including VLess, VMess, and Trojan.
+
+## How to install and use NekoBox:
+
+1. Go to NekoBox's GitHub page by clicking the button below. Download the APK that is compatible with your device. (In most cases, arm64-v8a version is compatible unless you have an old smartphone.)
+
+{{ '{{<' }} button href="https://github.com/MatsuriDayo/NekoBoxForAndroid/releases/tag/1.2.9" {{ '>}}' }}**NekoBox's GitHub Page**{{ '{{<' }} /button {{ '>}}' }}
+
+![Nekobox-01](/images/nekobox-12.png)
+
+{{ '{{<' }} hint danger {{ '>}}' }}
+**Warning**
+The version of Nekobox that you can download from Google Play Store is not developed by the official developer of NekoBox, **please do not use that application.**
+{{ '{{<' }} /hint {{ '>}}' }}
+
+2. Install the application and open it.
+
+3. Grant it the permission to send you notifications (if asked).
+
+![Nekobox-02](/images/nekobox-01.png)
+
+4. In the **“VpnService Policy”**, click on YES.
+
+![Nekobox-03](/images/nekobox-02.png)
+
+5. Download the NekoBox Settings file by clicking on the button below.
+
+{{ '{{<' }} button href="/nekoboxsetting/Nekobox-Settings.json" {{ '>}}' }}**Download NekoBox Settings**{{ '{{<' }} /button {{ '>}}' }}
+
+6. Open the **dashboard** by clicking on the menu icon on the top left corner of the interface and **“Tools”**.
+
+![Nekobox-04](/images/nekobox-03.png)
+
+7. Go to the **“Backup”** tab and click on **“Import from file”** button.
+
+![Nekobox-05](/images/nekobox-04.png)
+
+8. Select the setting file that you downloaded from **step 5**, then click on **“IMPORT”**.
+
+![Nekobox-06](/images/nekobox-05.png)
+![Nekobox-07](/images/nekobox-06.png)
+
+9. If done **properly**, the UI should then turn **blue** and you should be brought back to the main screen of the app.
+
+10. Copy the VPN URL of your of the protocol of your choice (**VMess**, **VLess** and/or **Trojan**) from below:
+
+{% if users[item].vless is defined %}
+```
+{{ users[item].vless }}
+```
+{% endif %}
+
+{% if users[item].vmess is defined %}
+```
+{{ users[item].vmess }}
+```
+{% endif %}
+
+{% if users[item].trojan is defined %}
+```
+{{ users[item].trojan }}
+```
+{% endif %}
+
+11. In the app, click on the + icon on at the top of the interface, and select **“Import from Clipboard”**. (Note: If it's imported successfully but the VPN profle doesn't appear in the list of your VPN profiles, close the app and open it again, and it will appear in the list.)
+
+![Nekobox-08](/images/nekobox-07.png)
+![Nekobox-09](/images/nekobox-08.png)
+
+12. Click on the VPN profile that was just added to select it. If you have multiple VPN profiles, the one that has a **highlight** on its left side is the one that is selected.
+
+13. Click on the **button** at the bottom of the screen to connect to the VPN profile.
+
+![Nekobox-10](/images/nekobox-09.png)
+
+14. To check the latency of the VPN profile, click on the tab that says **“Connected, tap to check connection”**. It will tell you the latency in milliseconds.
+
+![Nekobox-11](/images/nekobox-10.png)
+
+15. And that's it! You can check your IP location to ensure that you are connected to the VPN and it's working properly.
diff --git a/web/content.en/docs/android/nekossh.md.j2 b/web/content.en/docs/android/nekossh.md.j2
new file mode 100644
index 00000000..181b0520
--- /dev/null
+++ b/web/content.en/docs/android/nekossh.md.j2
@@ -0,0 +1,96 @@
+---
+title: SecureShell (SSH)
+type: docs
+weight: 1
+---
+
+# SecureShell (SSH) on NekoBox
+
+In this tutorial you will learn how to make use of the SSH VPN service using NekoBox.
+
+NekoBox is a VPN client supporting a variety of VPN protocols, and we will be using this handy client to use SecureShell (SSH) VPN protocol.
+
+**Please note that SSH is meant to be used as a last resort option in case the other methods don't work.**
+
+## How to install and use NekoBox for SSH VPN:
+
+1. Go to NekoBox's GitHub page by clicking the link below. Download the APK that is compatible with your device. (In most cases, arm64-v8a version is compatible unless you have an old smartphone.)
+
+{{ '{{<' }} button href="https://github.com/MatsuriDayo/NekoBoxForAndroid/releases/tag/1.2.9" {{ '>}}' }}**NekoBox's GitHub Page**{{ '{{<' }} /button {{ '>}}' }}
+
+![NekoSSH-01](/images/nekobox-12.png)
+
+{{ '{{<' }} hint danger {{ '>}}' }}
+**Warning**
+The version of Nekobox that you can download from Google Play Store is not developed by the official developer of NekoBox, **please do not use that application.**
+{{ '{{<' }} /hint {{ '>}}' }}
+
+2. Install the application and open it.
+
+3. Grant it the permission to send you notifications (if asked).
+
+![NekoSSH-02](/images/nekobox-01.png)
+
+4. In the **“VpnService Policy”**, click on YES.
+
+![NekoSSH-03](/images/nekobox-02.png)
+
+5. Download the NekoBox Settings file by clicking on the link below.
+
+[**Download NekoBox Settings**](/nekoboxsettings/Nekobox-Settings.json)
+
+6. Open the **dashboard** by clicking on the menu icon on the top left corner of the interface and **“Tools”**.
+
+![NekoSSH-04](/images/nekobox-03.png)
+
+7. Go to the **“Backup”** tab and click on **“Import from file”** button.
+
+![NekoSSH-05](/images/nekobox-04.png)
+
+8. Select the setting file that you downloaded from **step 5**, then click on **“IMPORT”**.
+
+![NekoSSH-06](/images/nekobox-05.png)
+![NekoSSH-07](/images/nekobox-06.png)
+
+9. If done **properly**, the UI should then turn **blue** and you should be brought back to the main screen of the app.
+
+10. In the app, click on the + icon on at the top of the interface, and select **"Manual"**, then click on **"SSH"**
+
+![NekoSSH-08](/images/nekobox-07.png)
+![NekoSSH-09](/images/nekossh-01.png)
+![NekoSSH-10](/images/nekossh-02.png)
+
+11. In the next menu, click on the option that says **"Authentication Type"** and change it to **"Public Key".**
+
+![NekoSSH-11](/images/nekossh-03.png)
+![NekoSSH-12](/images/nekossh-04.png)
+
+12. Once you've done the preivous step, **copy** and **paste** the following values in their respective fields.
+
+ 1. Any name that you want.
+
+ 2. {{ ansible_all_ipv4_addresses[0] }}
+
+ 3. **sshvpn**
+
+ 4. Copy and paste the entire box below and paste it in field **#4**.
+
+```bash
+{{ users[item].sshvpn }}
+```
+
+![NekoSSH-13](/images/nekossh-05.png)
+
+13. Once done, click on the checkmark button at top right corner. (Note: If it's imported successfully but the VPN profle doesn't appear in the list of your VPN profiles, close the app and open it again, and it will appear in the list.)
+
+14. Click on the VPN profile that was just added to select it. If you have multiple VPN profiles, the one that has a **highlight** on its left side is the one that is selected.
+
+13. Click on the **button** at the bottom of the screen to connect to the VPN profile.
+
+![NekoSSH-14](/images/nekossh-06.png)
+
+14. To check the latency of the VPN profile, click on the tab that says **“Connected, tap to check connection”**. It will tell you the latency in milliseconds.
+
+![NekoSSH-15](/images/nekobox-10.png)
+
+15. And that's it! You can check your IP location to ensure that you are connected to the VPN and it's working properly.