3 Star 0 Fork 0

mirrors_digitalocean/marketplace-openmptcprouter

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

OpenMPTCProuter VPS [Beta]

This project is used to create an OpenMPTCProuter (OMR) VPS image. OMR uses MultiPath TCP (MPTCP) and OpenWrt to aggregate multiple Internet connections. This Droplet serves as the aggregation endpoint for your local OMR. If you like OMR, consider donating at: openmptcprouter.com.

MPTCP

Wait Wat? ELI5: OK, so let's say you spend a lot of time in an area with unreliable and/or slow Internet (🚐 🌲 🏕️). You can't get a single good Internet connection, but you can get several so-so options (Starlink, Cellular, Open Hotspots, etc.). OMR allows you to leverage MPTCP so that you can aggregate or bond those connections together into a faster, more reliable connection.

Cool, cool cool cool...so how do I...

Use It

If you want to get up and running in as little time as possible:

  1. Go here, create a Droplet, wait a bit, then SSH in (port 65222)
  2. Grab your server key from /root/openmptcprouter_config.txt & add it along with your Droplet IP to your local OMR (see OMR Homelab Client Setup Guides)
  3. Profit

Slightly more info:

  • This image was built using a $4 Droplet, and it should (🤞) work just fine on one
  • First boot setup takes a bit of time
    • Why? On first boot, the OS is updated. Then, OpenMPTCProuter is installed.
  • The README in the Droplet provides additional info
  • Using Floating / Reserved IPs:
    • Create your Droplet
    • Assign your Reserved IP to the Droplet

OMR Homelab Client Setup Guides

UDM Pro SE & Raspberry Pi 4

The image below is the setup I used to test the OMR VPS Image. To use this setup in the field:

  • Remove the Primary UDM Pro SE from the picture
  • Connect the OMR WAN 1 port (UDM port 5 in the picture below) to your first modem/router, e.g. a Starlink router (preferrably in passthrough mode)
  • Connect the OMR WAN 2 port (UDM port 7 in the picture below) to your second modem/router, e.g. a cellular modem

UDM Pi Config

UDM Config
  • Create 3 VLAN only networks; in the picture above:
    • OMR is VLAN 10
    • OMR WAN 1 is VLAN 11
    • OMR WAN 2 is VLAN 12
  • Create a port profile (OMR VLANs):
    • Native network is OMR (VLAN 10), i.e. untagged
    • Tagged networks are:
      • OMR WAN 1 (VLAN 11)
      • OMR WAN 2 (VLAN 12)
  • Assign each network and the port profile:
    • VLAN 10 is on Port 8
    • VLAN 11 is on Port 5
    • VLAN 12 is on Port 7
    • OMR VLANs is on Port 6
  • Connect your cables:
    • Modem/router 1 to Port 5
    • Modem/router 2 to Port 7
    • WAN Port 9 to Port 8
    • OMR to Port 6

🤞 I didn't forget anything

OMR Config

Kamru has an excellent guide on this! It's what I used to setup my OMR. A summary below:

  • Set a password
    • System > Administration
  • Probably change the LAN subnet as it collides with Starlink
    • Network > Interfaces > LAN > Edit
    • 10.10.10.0/29 is used in the picture above
  • Delete the default WAN ports and create two new ones:
    • Create one on eth0.11 interface
    • Create another on eth0.12 interface
    • Set the appropriate protocol for each (DHCP here)
    • Make sure they are added to WAN under Firewall Settings
  • Go to: System > OpenMPTCProuter > Settings Wizard
    • Set the Server IP to your OMR VPS
    • Set the Server Key to your OMR VPS Server Key
    • Set ISP1 MultiPath TCP to Master
    • Set IPS2 MultiPath TCP to enabled
    • Verify protocol and interface for both ISP1 & ISP2

🤞 I didn't forget anything

Contribute Changes

Create the OpenMPTCProuter Image

First, generate an API_TOKEN on the API page. Then, create a vars file:

echo 'do_token = "API_TOKEN"' > variables.auto.pkrvars.hcl

Finally, validate and build the image:

packer init .
packer validate .
packer build .

Provision Droplets for Testing

The recommended way to provision droplets for testing is by using terraform.

Use Cases:

  1. You created an image by following the steps in the Create the OpenMPTCProuter Image section above and you would like to now create a Droplet using that image.
  2. You want to create a Droplet using the image that the packer build is based off of so you can test the build scripts in a clean environment.

Terraform Configuration

First, we need to create a vars file:

cd terraform
echo 'do_token = "API_TOKEN"' > terraform.auto.tfvars
echo 'image    = "IMAGE_ID"' >> terraform.auto.tfvars
echo 'ssh_keys = [SSH_ID]'   >> terraform.auto.tfvars

NB: the square brackets [] around SSH_ID are required.

Now that we have a template, let's grab the required information:

API_TOKEN: use the API_TOKEN that you generated in the Create the OpenMPTCProuter Image section above.

IMAGE_ID: the IMAGE_ID you use here depends on the use case (listed above)

  1. For use case 1, the IMAGE_ID is a string of numbers output by the Packer build process.
  2. For use case 2, the IMAGE_ID is debian-11-x64

Alternatively:

  • Find the IMAGE_ID in the URL (imageId= for Snapshots, distroImage= for Distributions) of the Create Droplets page after selecting the desired image in the "Snapshots" tab.

  • Acquire the IMAGE_ID from the API:

    • Distributions

        curl -s -X GET \
        -H "Content-Type: application/json" \
        -H "Authorization: Bearer API_TOKEN" \
        "https://api.digitalocean.com/v2/images?type=distribution" | \
        jq -r '.images | .[] | [.id, .name] | @tsv'
      
    • Snapshots

        curl -s -X GET \
        -H "Content-Type: application/json" \
        -H "Authorization: Bearer API_TOKEN" \
        "https://api.digitalocean.com/v2/images?private=true" | \
        jq -r '.images | .[] | [.id, .name] | @tsv'
      

SSH_ID: DO's ID for your SSH public key. You can obtain the SSH_ID for any previously added keys (i.e. any public keys added via the API or via the Settings -> Security page) with the following query:

    curl -s -X GET \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer API_TOKEN" \
    "https://api.digitalocean.com/v2/account/keys" | \
    jq -r '.ssh_keys | .[] | [.name, .id] | @tsv'

If you haven't yet added a key, you can use the query below to upload your SSH public key and get its SSH_ID:

  curl -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer API_TOKEN" \
  -d "{\"name\":\"OMR Key\",\"public_key\":\"$(cat ~/.ssh/id_rsa.pub)\"}" \
  "https://api.digitalocean.com/v2/account/keys"

Terraform Use

If you don't already have Terraform installed, checkout Terraform's installation page . The terraform code requires version 1.2.0 or later.

Make sure you've setup your vars file as described in the previous section. Then:

terraform init
terraform validate
terraform plan
terraform apply

You may use terraform show to see your Droplet's IP address:

terraform show

Finally, to destroy your Droplet:

terraform destroy
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

暂无描述 展开 收起
README
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

语言

近期动态

不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/mirrors_digitalocean/marketplace-openmptcprouter.git
git@gitee.com:mirrors_digitalocean/marketplace-openmptcprouter.git
mirrors_digitalocean
marketplace-openmptcprouter
marketplace-openmptcprouter
main

搜索帮助