diff options
Diffstat (limited to 'web/content.en/docs')
| -rw-r--r-- | web/content.en/docs/_index.md | 5 | ||||
| -rw-r--r-- | web/content.en/docs/android/_index.md | 5 | ||||
| -rw-r--r-- | web/content.en/docs/android/anyconnect.md.j2 | 97 | ||||
| -rw-r--r-- | web/content.en/docs/android/nekobox.md.j2 | 90 | ||||
| -rw-r--r-- | web/content.en/docs/android/nekossh.md.j2 | 96 | ||||
| -rw-r--r-- | web/content.en/docs/windows/_index.md | 5 | ||||
| -rw-r--r-- | web/content.en/docs/windows/nekoray.md.j2 | 88 | ||||
| -rw-r--r-- | web/content.en/docs/windows/openconnect.md.j2 | 53 |
8 files changed, 439 insertions, 0 deletions
diff --git a/web/content.en/docs/_index.md b/web/content.en/docs/_index.md new file mode 100644 index 00000000..dfd18748 --- /dev/null +++ b/web/content.en/docs/_index.md @@ -0,0 +1,5 @@ +--- +bookFlatsection: true +title: Introduction +type: docs +--- 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. + + + +5. Grant it the relevant permissions (Access to your **notifications**, in this case). + + + +6. Click on the menu button on top right corner and go to **“Settings”**. + + + +7. Uncheck the second option that says **“Block Untrusted Servers”**. + + + +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”**. + + + +10. Click on the + icon at the bottom of the screen. + + + +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”**. + + + +12. Click on the first option that says **“Certificate”**. + + + +13. Click on the **“Import”** button at the bottom of the screeen. + + + +14. Click on **“File System”**. It should open your file browser app. + + + +15. Find the **.p12 certificate** file that you downloaded in step 2. + + + +16. It will ask for a password. The password is: **{{ item }}** + + + +17. Once the certificate is imported, click on it. + + + +18. Click on **“Done”** at the bottom of the screen, and click on **“Done”** again. + + + + +19. Click on the arrow icon at the top left corner. + + + +20. **Turn on** the VPN by clicking on the VPN toggle. + + + +21. Click on **“Continue”**. + + + +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. + +
\ 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 {{ '>}}' }} + + + +{{ '{{<' }} 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). + + + +4. In the **“VpnService Policy”**, click on YES. + + + +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”**. + + + +7. Go to the **“Backup”** tab and click on **“Import from file”** button. + + + +8. Select the setting file that you downloaded from **step 5**, then click on **“IMPORT”**. + + + + +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.) + + + + +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. + + + +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. + + + +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 {{ '>}}' }} + + + +{{ '{{<' }} 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). + + + +4. In the **“VpnService Policy”**, click on YES. + + + +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”**. + + + +7. Go to the **“Backup”** tab and click on **“Import from file”** button. + + + +8. Select the setting file that you downloaded from **step 5**, then click on **“IMPORT”**. + + + + +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"** + + + + + +11. In the next menu, click on the option that says **"Authentication Type"** and change it to **"Public Key".** + + + + +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 }} +``` + + + +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. + + + +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. + + + +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/windows/_index.md b/web/content.en/docs/windows/_index.md new file mode 100644 index 00000000..fa3a83c1 --- /dev/null +++ b/web/content.en/docs/windows/_index.md @@ -0,0 +1,5 @@ +--- +bookFlatSection: true +title: Windows Clients +weight: 1 +--- diff --git a/web/content.en/docs/windows/nekoray.md.j2 b/web/content.en/docs/windows/nekoray.md.j2 new file mode 100644 index 00000000..a9f533cf --- /dev/null +++ b/web/content.en/docs/windows/nekoray.md.j2 @@ -0,0 +1,88 @@ +--- +title: NekoRay (V2Ray) +type: docs +--- + +# NekoRay + +In this tutorial you will learn how to use NekoRay VPN client on Windows devices. + +NekoRay 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 desktop computers, including VLess, VMess, and Trojan. + +## How to use NekoRay: + +1. Go to NekoRay's GitHub page by clicking the button below. Click on the link that is highlighted in the screenshot below and download NekoRay. It doesn't need installation, just extract it somewhere in your computer (it doesn't matter where but preferably somewhere easy to find). + +{{ '{{<' }} button href="https://github.com/MatsuriDayo/nekoray/releases" {{ '>}}' }}**NekoRay's GitHub Page**{{ '{{<' }} /button {{ '>}}' }} + + + +2. Go to the folder where you extracted NekoRay and launch “nekoray” **as administrator**. + + + +3. Click on the button that says “sing-box” + + + +4. You will see the interface of the program in front of you. Click on the “Program” button at the top left corner. + + + +5. Click on “Remember last profile”. + + + +6. Copy the VPN URL of your of the protocol of your choice (VMess, VLess and/or Trojan) from below and then click on the “Program” button. This time, click on “Add profile from clipboard”. + +{% 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 %} + + + +7. You will see that the VPN profile will appear in the middle. Right click on the VPN profile and choose “Start” (or click on the VPN profile and press Enter) + + + +8. You will see a checkmark appear next to the VPN profile and the text turns blue. This happens when a VPN profile is selected. To select another profile, repeat the previous step (Step 5) on another profile. + +9. In order to turn on the VPN and access the internet, you will need to click on either of the two VPN modes: “System Proxy” and “Tun Mode”. Click on “Tun Mode”. This will tunnel all of your computer's internet traffic through the VPN, this includes all the programs. (You need to run the program as Administrator in order to use “Tun Mode”. If you haven't done so, you will be asked whether or not you want to run the program as Administrator.). + + + +10. After clicking on “Tun Mode”, you will notice that a red dot appears on the system tray icon of NekoRay. This is to indicate that “Tun Mode” is on. + + + +11. To turn the VPN off, simply click on the “Tun Mode” checkbox again. Do remember to turn off the VPN when you're done using it. Do not turn your PC off or close the program while the VPN is connected. + +12. And that's it! You can check your IP location to ensure that you are connected to the VPN and it's working properly. + +## Other notes + +1. You can turn the VPN on or off via the system tray icon. Right click on the system tray icon and go to system proxy and then choose either mode. + + + +2. “System Proxy” mode activates the VPN via a proxy. This mode only works for browsers or web-clients (such as Discord's desktop app) and it will not work on any software is not browser-based (such as online games). + +3. In case you forget to turn the VPN off before turning off your PC or closing the program, you might run into some connection issues. This can be solved by launching NekoRay and turning off the VPN mode that you previously selected. + +4. In case you decide to change the program's settings and the client stops working, delete NekoRay's folder and download it again, and repeat the steps at the beginning of this tutorial. + +5. If you wish to test the latency of the VPN profile, right click on the profile you want, go to “Current Select” and click on “Url Test”. The number that appears under “Test results” column is the latency. Alternatively, you can click on the bottom left of the program where the name of the selected profile is displayed and it will also tell you what the latency is. diff --git a/web/content.en/docs/windows/openconnect.md.j2 b/web/content.en/docs/windows/openconnect.md.j2 new file mode 100644 index 00000000..a63e3f70 --- /dev/null +++ b/web/content.en/docs/windows/openconnect.md.j2 @@ -0,0 +1,53 @@ +--- +title: OpenConnect +type: docs +--- + +# OpenConnect + +## How to install and use OpenConnect client on Windows devices: + +1. Go to the OpenConnect client's GitLab page by clicking the button below. Click on the link that is marked in the screenshot below. Installation is straightforward and very easy. + +{{ '{{<' }} button href="https://gitlab.com/openconnect/openconnect-gui/-/releases" {{ '>}}' }}**OpenConnect client GitLab Page**{{ '{{<' }} /button {{ '>}}' }} + + + +2. It should prompt you to install a distributable and a network adapter, give it permission to do so. + +3. Open the client, click on the gear icon in the middle, then click on **“New profile (Advanced)”** + + + +4. Download the two files that are provided below: + + 1. **User Certificate:** [Click to download User Certificate](/{{item}}/{{item}}-User-Certificate.pem) + + 2. **User Key:** [Click to download User Key](/{{item}}/{{item}}-User-Key.pem) + +5. Do the following in the given order: + + 1. Enter a **name** (any name you want) + + 2. Copy the following and paste it in the server address field: **{{ ansible_all_ipv4_addresses[0] }}:{{ ocserv_port | default(4430) }}** + + 3. Click on the button next to the **“User Certificated”** field, and choose the User Certificate file that you downloaded from **step 4**. + + 4. Click on the button next to the **“User Key”** field, and choose the User Key file that you downloaded from **step 4**. + + + + +6. Click save, then click on the big button in the middle saying **"connect"**. + + + +7. You'll be prompted to confirm the information regarding the destination address. Click on **“Accurate information”**. + + + +8. To disconnect the VPN, simply click on the **Disconnect** button in the main interface. + + + +9. And that's it! You can check your IP location to ensure that you are connected to the VPN and it's working properly. |