├── .github
└── workflows
│ └── sync.yml
├── .gitmodules
├── Customizesupernode.png
├── Hiring.md
├── Hiringcn.md
├── LICENSE
├── OmniEdge-clients.png
├── OmniEdgeComparison.gif
├── README.md
├── README
├── README-AR.md
├── README-ES.md
├── README-IT.md
├── README-JP.md
├── README-KR.md
├── README-TH.md
├── README-VN.md
├── README-zh-Hans.md
└── README-zh-Hant.md
├── check_version.xml
├── docs
└── compile
│ ├── compile-windows-Kits.png
│ └── compile-windows-release.png
└── protocol
├── OmniEdge_Flow.md
├── OmniEdge_Node_API.md
├── README.md
└── how-omniedge-works-main-architecture.png
/.github/workflows/sync.yml:
--------------------------------------------------------------------------------
1 | name: sync
2 | on:
3 | push:
4 | branches:
5 | - main
6 | schedule:
7 | - cron: "0 */24 * * *"
8 | jobs:
9 | build:
10 | runs-on: ubuntu-latest
11 | steps:
12 | - name: Check out code
13 | uses: actions/checkout@v2
14 |
15 | - name: update submodule
16 | id: update-submodule
17 | run: |
18 | git submodule update --remote
19 | echo ::set-output name=commit-status::$(git status --porcelain=v1 2>/dev/null | wc -l)
20 | - name: Commit files
21 | if: ${{ steps.update-submodule.outputs.commit-status==1 }}
22 | id: commit
23 | run: |
24 | git config --local user.email "github-actions@omniedge.io"
25 | git config --local user.name "github-actions"
26 | git add .
27 | git commit -m "sync submodule" -a
28 | - name: Push changes
29 | id: push
30 | if: ${{ steps.update-submodule.outputs.commit-status==1 }}
31 | uses: ad-m/github-push-action@master
32 | with:
33 | force_with_lease: true
34 |
35 |
--------------------------------------------------------------------------------
/.gitmodules:
--------------------------------------------------------------------------------
1 | [submodule "omniedge-android"]
2 | path = omniedge-android
3 | url = https://github.com/omniedgeio/omniedge-android.git
4 | branch = main
5 | [submodule "omniedge-windows"]
6 | path = omniedge-windows
7 | url = https://github.com/omniedgeio/omniedge-windows.git
8 | branch = main
9 | [submodule "omniedge-iOS"]
10 | path = omniedge-iOS
11 | url = https://github.com/omniedgeio/omniedge-iOS.git
12 | branch = main
13 | [submodule "omniedge-macOS"]
14 | path = omniedge-macOS
15 | url = https://github.com/omniedgeio/omniedge-macOS.git
16 | branch = main
17 | [submodule "omniedge-cli"]
18 | path = omniedge-cli
19 | url = https://github.com/omniedgeio/omniedge-cli.git
20 | branch = main
21 | [submodule "docker-customize-supernode"]
22 | path = docker-customize-supernode
23 | url = https://github.com/omniedgeio/docker-customize-supernode.git
24 | branch = main
25 | [submodule "omniedge-synology"]
26 | path = omniedge-synology
27 | url = https://github.com/omniedgeio/omniedge-synology.git
28 | [submodule "omniedge-github-action"]
29 | path = omniedge-github-action
30 | url = https://github.com/omniedgeio/github-action.git
31 | [submodule "omniedge-supernode-status"]
32 | path = omniedge-supernode-status
33 | url = https://github.com/omniedgeio/server-status.git
34 | [submodule "Documentation"]
35 | path = Documentation
36 | url = https://github.com/omniedgeio/docs.git
37 | [submodule "omniedge-docker"]
38 | path = omniedge-docker
39 | url = https://github.com/omniedgeio/omniedge-docker.git
40 | [submodule "omniedge-backend"]
41 | path = omniedge-backend
42 | url = https://github.com/omniedgeio/omniedge-backend.git
43 | [submodule "omniedge-frontend"]
44 | path = omniedge-frontend
45 | url = https://github.com/omniedgeio/omniedge-frontend.git
46 |
--------------------------------------------------------------------------------
/Customizesupernode.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/omniedgeio/omniedge/b00eab23707f2311c42ec5c4f007656138ed4197/Customizesupernode.png
--------------------------------------------------------------------------------
/Hiring.md:
--------------------------------------------------------------------------------
1 | # Job Title: Lead Developer - OmniEdge Enterprise VPN Project
2 |
3 | Location: Remote
4 |
5 | Job Type: Contributor/Moderator
6 |
7 | ## About Us :
8 |
9 | We are seeking a highly skilled Lead Developer to join our team and spearhead the enhancement of the OmniEdge enterprise VPN project. As a crucial member of our development team, you will play a key role in meeting the diverse requirements of various industries through the improvement and optimization of the project.
10 |
11 | ## Responsibilities:
12 |
13 | Collaborate with the development team to enhance the openwrt client for industrial remote applications, incorporating device scanning capabilities, IP address uploads, and port accessibility.
14 | Elevate network bandwidth and reduce latency for hybrid cloud and edge cloud applications.
15 | Develop device networking capabilities, including the implementation of Exit Node functionality.
16 | Optimize and potentially rewrite protocols for improved efficiency and performance.
17 |
18 | ## Qualifications:
19 |
20 | Proven experience in leading development projects, particularly in VPN or network-related domains.
21 | Strong proficiency in openwrt, remote protocols, and network optimization.
22 | Familiarity with industrial remote applications, hybrid cloud, and edge cloud technologies.
23 | Solid understanding of device networking and Exit Node functionality.
24 | Expertise in protocol optimization and rewriting.
25 |
26 | ## How to Apply:
27 |
28 | Interested candidates are invited to apply by submitting their resume and portfolio to [opensource@omniedge.io]. Please include a cover letter highlighting relevant experience and detailing your approach to enhancing the OmniEdge enterprise VPN project.
29 |
30 | Note: The GitHub repository for the OmniEdge project can be accessed here: https://github.com/omniedgeio/omniedge/issues, providing additional insights into the project's current state and potential areas for improvement.
31 |
--------------------------------------------------------------------------------
/Hiringcn.md:
--------------------------------------------------------------------------------
1 | # 职位名称:首席开发人员 - OmniEdge 企业VPN项目
2 |
3 | 地点: 远程
4 |
5 | 工作类型: Contributor/Moderator
6 |
7 | ## 关于我们:
8 |
9 | 我们正在寻找一位高技能的首席开发人员加入我们的团队,引领OmniEdge企业VPN项目的完善工作。作为我们开发团队的关键成员,您将在改进和优化项目方面发挥关键作用,以满足各个行业的多样化需求。
10 |
11 | ## 职责:
12 |
13 | 与开发团队合作,改进工业远程应用的openwrt客户端,包括设备扫描功能、LAN设备IP地址上传和端口可访问性。
14 | 提升混合云和边缘云应用的网络带宽,降低延迟。
15 | 开发设备组网功能,包括实施Exit Node功能。
16 | 优化并有可能重写协议,以提高效率和性能。
17 |
18 | ## 资格要求:
19 |
20 | 在领导VPN或网络相关领域的开发项目方面有经验。
21 | 熟练掌握openwrt、远程协议和网络优化。
22 | 熟悉工业远程应用、混合云和边缘云技术。
23 | 对设备组网和Exit Node功能有深刻理解。
24 | 在协议优化和重写方面具备专业知识。
25 |
26 | ## 如何申请:
27 |
28 | 有兴趣的候选人可以通过将简历和作品集提交至[opensource@omniedge.io]来申请。请附上一封简短的求职信,突显相关经验并详细说明您改进OmniEdge企业VPN项目的方法。
29 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
/OmniEdge-clients.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/omniedgeio/omniedge/b00eab23707f2311c42ec5c4f007656138ed4197/OmniEdge-clients.png
--------------------------------------------------------------------------------
/OmniEdgeComparison.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/omniedgeio/omniedge/b00eab23707f2311c42ec5c4f007656138ed4197/OmniEdgeComparison.gif
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | 
2 |
3 |
34 |
35 | [【English】](README.md) [【繁体中文】](README/README-zh-Hant.md) [【简体中文】](README/README-zh-Hans.md) [【日本语】](README/README-JP.md) [【Español】](README/README-ES.md) [【Italiano】](README/README-IT.md) [【한국어】](README/README-KR.md)
36 | [【العربي】](README/README-AR.md) [【Tiếng Việt】](README/README-VN.md) [【แบบไทย】](README/README-TH.md)
37 |
38 | ## The total cost to run OmniEdge SaaS Service : $57.15
39 |
40 | - Backend : $12
41 | - Frontend: $25
42 | - 1 Supernode: $6
43 | - PostgresSQL: $15.15
44 | - GitHub : $0
45 |
46 | [Hiring: Lead Developer - OmniEdge Enterprise VPN Project](Hiring.md)
47 |
48 | OmniEdge is an Open source p2p layer 2 VPN infrastructure based on [n2n](https://github.com/ntop/n2n) protocol, a traditional VPN alternative. No central server, easy to scale with less maintenance. What happens in intranet, stays in in intranet. OmniEdge is fully open sourced the code including backend, frontend, and Apps.
49 |
50 |
51 |
52 | 
53 |
54 | ## Key features:
55 |
56 | ||||
57 | |----|----|----|
58 | |Dashboard administration management| :fire: Mesh VPNs|Desktop GUI apps for MacOS(menubar) and Windows(systray)|
59 | | :fire: Multi virtual networks| :fire: Site-to-Site VPNs|Command line cli apps for Linux,FreeBSD, Raspbian and MacOS|
60 | |Multi users|Unlimited data transfer|Command line cli apps for armv7,arm64,RISC-V64,x86_64 and amd64|
61 | |Multi devices|Encrypted peer-to-peer connection|Mobile apps for iOS and Android|
62 | | :fire: Self-hosted Supernode |Encrypted connection relay|Tablet apps for iPad, Android Tablet and Android TV|
63 | | :fire: Sharing virtual network|Hybrid-cloud support|NAS App for Synology|
64 | |Security Keys| :fire: Zero-Config|Automatic public supernode allocation|
65 | | :fire: [Remote Device Control](https://omniedge.io/docs/article/Cases/VNC)|[Drop Files remotely](https://omniedge.io/docs/article/Cases/landrop) |Automatic IP allocation|
66 |
67 |
68 | ## Supported
69 |
70 | | App| Version | Linux | Windows | MacOS | FreeBSD |iOS | Android | Synology | OpenWrt |Docker | Github Action |
71 | | --------- | ---------- | --- | --- | --- |--- |--- |--- |--- | --- |--- | --- |
72 | | OmniEdge | [0.2.3](https://github.com/omniedgeio/omniedge/releases/tag/v0.2.3) | ✅ | ✅ | ✅ | ✅ |✅ |✅ |✅ |✅ |✅ |✅ |
73 | | OmniEdge | [0.2.4](https://github.com/omniedgeio/omniedge/releases/tag/v0.2.3) | ✅ | | | ✅ | | |✅ |✅ |✅ |✅ |
74 | | OmniEdge | [0.2.5](https://github.com/omniedgeio/omniedge/releases/tag/v0.2.3) | |✅ | | ✅ | | |✅ |✅ |✅ |✅ |
75 |
76 | ## Get Started in 5 minutes
77 |
78 | 1. Sign up your account: [Sign up](https://omniedge.io/register)
79 | 2. [Download](https://omniedge.io/download) OmniEdge apps for your platform: macOS, linux, FreeBSD, iOS, android and more.
80 | 3. Or run the following command if you want to use cli version:
81 | ```bash
82 | curl https://omniedge.io/install/omniedge-install.sh | bash
83 | ```
84 | 4. Login with your Email and password, select your virtual network, connect!
85 |
86 | You are all set!
87 |
88 | And if you want to login with **security key**, or manage your devices, go and check [Documenation](https://omniedge.io/docs) for more.
89 |
90 | ### Docker
91 |
92 | Bring container into intranet.
93 |
94 | ```bash
95 | sudo docker run -d \
96 | -e OMNIEDGE_SECURITYKEY=OMNIEDGE_SECURITYKEY \
97 | -e OMNIEDGE_VIRUTALNETWORK_ID="OMNIEDGE_VIRUTALNETWORK_ID" \
98 | --network host \
99 | --privileged \
100 | omniedge/omniedge:latest
101 | ```
102 | ### Github Action
103 |
104 | Bring Github Action into intranet, access nodes/devices from CI workflows.
105 |
106 | ```bash
107 | - name: OmniEdge for Github Action
108 | uses: omniedgeio/github-action@v1
109 | with:
110 | securitykey: ${{ secrets.OMNIEDGE_SECURITY_KEY }}
111 | virtualnetworkid: ${{ secrets.OMNIEDGE_VIRTUALNETWORK_ID }}
112 | ```
113 |
114 | ## Server status
115 |
116 | >This Server Status is generated every 5 hours by OmniEdge Github action.
117 |
118 | [OmniEdge server-status](https://github.com/omniedgeio/server-status#server-status)
119 |
120 |
121 | ## Compile
122 |
123 | ### Linux
124 |
125 | **Install golang for your distribution**
126 |
127 | Follow the [instruction](https://go.dev/doc/install) to install golang, we use **1.16.6**, or running the following command:
128 |
129 | ```bash
130 | wget https://go.dev/dl/go1.16.6.linux-amd64.tar.gz
131 | rm -rf /usr/local/go && tar -C /usr/local -xzf go1.16.6.linux-amd64.tar.gz
132 | export PATH=$PATH:/usr/local/go/bin
133 | go version
134 | ```
135 |
136 |
137 | #### Build for Ubuntu 18.04, 20.04, 22.04/Debian 10, 11
138 |
139 | ```bash
140 | sudo apt-get -y update
141 | sudo apt-get install -y openssl build-essential libssl-dev zip autoconf
142 | git clone https://github.com/omniedgeio/omniedge-cli
143 | cd omniedge-cli
144 | go mod download
145 | go generate
146 | BUILD_ENV=prod make build
147 | ```
148 |
149 | #### Build for Fedora 36, CentOS 8
150 |
151 | ```bash
152 | sudo yum update
153 | sudo yum -y install gcc-c++ curl wget zip wget git openssl-devel net-tools automake autoconf make
154 | git clone https://github.com/omniedgeio/omniedge-cli
155 | cd omniedge-cli
156 | go mod download
157 | go generate
158 | chmod +x internal/make
159 | BUILD_ENV=prod make build
160 | ```
161 |
162 | #### Build for Arch(Manjaro)
163 |
164 | ```bash
165 | sudo pacman -Syu --needed unzip git gcc curl wget zip make pkg-config openssl net-tools automake autoconf make
166 | git clone https://github.com/omniedgeio/omniedge-cli
167 | cd omniedge-cli
168 | go mod download
169 | go generate
170 | chmod +x internal/make
171 | BUILD_ENV=prod make build
172 | ```
173 |
174 | #### Build for Opensuse
175 |
176 | ```bash
177 | sudo zypper update
178 | sudo zypper install unzip git gcc curl wget zip make pkg-config openssl net-tools automake autoconf make tar
179 | git clone https://github.com/omniedgeio/omniedge-cli
180 | cd omniedge-cli
181 | go mod download
182 | go generate
183 | chmod +x internal/make
184 | BUILD_ENV=prod make build
185 | ```
186 |
187 | The compiled omniedge-cli will be found in **/out/**
188 |
189 | ### BSD
190 |
191 | #### FreeBSD
192 |
193 | ```bash
194 | su
195 | pkg update && pkg install go gmake git openssl zip autoconf automake libtool
196 | git clone https://github.com/omniedgeio/omniedge-cli
197 | cd omniedge-cli
198 | go mod download
199 | go generate
200 | BUILD_ENV=prod make build-freebsd
201 | ```
202 |
203 | The compiled omniedge-cli will be found in **/out/**
204 |
205 | ### Cross Compile
206 |
207 | #### Compile for RISCV64
208 |
209 | Host OS: Ubuntu 20.04
210 |
211 | ```bash
212 | apt-get update
213 | apt-get install -y openssl autoconf build-essential libssl-dev zip wget g++-riscv64-linux-gnu gcc-riscv64-linux-gnu
214 |
215 | wget https://go.dev/dl/go1.18.4.linux-amd64.tar.gz
216 | rm -rf /usr/local/go && tar -C /usr/local -xzf go1.18.4.linux-amd64.tar.gz
217 | export PATH=$PATH:/usr/local/go/bin
218 | go version
219 | export GOOS=linux
220 | export GOARCH=riscv64
221 | export CGO_ENABLED=1
222 | export CC=riscv64-linux-gnu-gcc
223 | git clone https://github.com/omniedgeio/omniedge-cli.git
224 | cd omniedge-cli
225 | go mod download
226 | go generate
227 | BUILD_ENV=prod make build-riscv64
228 | ```
229 |
230 | The compiled omniedge-cli will be found in **/out/**
231 |
232 | ### Android
233 |
234 | 1. Download Android Studio: https://developer.android.com/studio
235 | 2. Get the repo and compile
236 |
237 | ```bash
238 | git clone https://github.com/omniedgeio/omniedge-android.git`
239 | ./gradlew test --stacktrace
240 | ./gradlew assembleDebug --stacktrace
241 | ```
242 |
243 | We have also prepared the CI for Github and Gitlab for building automatically.
244 |
245 | 1. Github: https://github.com/omniedgeio/omniedge-android/blob/main/.github/workflows/build.yml
246 | 2. GitLab: https://github.com/omniedgeio/omniedge-android/blob/main/.gitlab-ci.yml
247 |
248 |
249 | ### iOS
250 |
251 | 1. Download and install Xcode
252 | 2. Get the repo and compile
253 |
254 | ```bash
255 | git clone https://github.com/omniedgeio/omniedge-iOS.git
256 | cd omniedge-iOS
257 | open OmniEdgeNew/OmniEdgeNew.xcworkspace
258 | ```
259 |
260 | Xcode will open automatically, you have to set your developer account to start the compile. We recommend compiling the package on your devices separately, specially the **Tunnel** package.
261 |
262 |
263 |
264 | ### macOS
265 |
266 | #### macOS GUI
267 |
268 | 1. Download and install Xcode
269 | 2. Get the repo and compile
270 |
271 | ```bash
272 | git clone https://github.com/omniedgeio/omniedge-macOS.git
273 | cd omniedge-macOS
274 | open Omniedge.xcodeproj
275 | ```
276 |
277 | Xcode will open automatically, you have to set your developer account to start the compile.
278 |
279 | #### macOS Cli
280 |
281 | ```bash
282 | brew install autoconf automake libtool
283 | git clone https://github.com/omniedgeio/omniedge-cli
284 | cd omniedge-cli
285 | go mod download
286 | go generate
287 | BUILD_ENV=prod make build-darwin
288 | ```
289 |
290 | The compiled omniedge-cli will be found in **/out/**
291 |
292 | ### Windows
293 |
294 | 1. Download [QT 5.12.12 for windows](https://download.qt.io/official_releases/qt/5.12/5.12.12/) and [Inno Setup for windows](https://jrsoftware.org/isdl.php#stable)
295 | 2. Get the repo and compile
296 |
297 | ```bash
298 | git clone https://github.com/omniedgeio/omniedge-windows.git
299 | cd omniedge-windows
300 | ```
301 |
302 | 3. open **OmniEdge.pro** and **QT Creator** will open automatically
303 | 4. Set the Kits to **Desktop Qt 5.12.12 MSVC2017 32bit**, select build with **Release**, set the Build directory to: `.\build-package\build\`
304 |
305 | 
306 |
307 | 
308 |
309 | 5. Press `crtl+B` to build, and you will find **OmniEdge.exe** in the folder`.\build-package\build\release\`.
310 | 6. copy **OmniEdge.exe** to `.\build-package\package\`,open **omniedge_withTAP_V02_bat.iss** with Inno Setup Compile, press `ctril+F9` to compile and you will find the installer package in the folder `.\build-package\release`
311 |
312 | ### OpenWrt
313 |
314 | 1. Compile the binary
315 |
316 | We use the github action with the docker to build the binary for openwrt, the docker file is located at:
317 | `https://github.com/omniedgeio/omniedge-cli/blob/dev/docker/openwrt-binary`
318 |
319 | 2. Package the ipk
320 |
321 | A seperated repo `https://github.com/omniedgeio/omniedge-openwrt` with github action is used to download the openwrt binary and package the ipk.
322 |
323 | ## Usage
324 |
325 | - [Virtual Network, Devices, Security Key, and Settings](https://omniedge.io/docs/article/admin)
326 | - [Windows 7,10,11 for Intel or Arm](https://omniedge.io/docs/article/install/windows)
327 | - [Android](https://omniedge.io/docs/article/install/android)
328 | - [Linux Cli for raspberry Pi, Nvidia Jeston,and more](https://omniedge.io/docs/article/install/cli)
329 | - [MacOS Cli](https://omniedge.io/docs/article/install/macoscli)
330 | - [Synology](https://omniedge.io/docs/article/install/synology)
331 | - [Docker](https://omniedge.io/docs/article/install/docker)
332 | - [Github Action](https://omniedge.io/docs/article/install/github-action)
333 | - [iOS](https://omniedge.io/docs/article/install/ios)
334 | - [Setup custom supernode](https://omniedge.io/docs/article/install/customize-supernode)
335 |
336 |
337 | ## Use Cases
338 |
339 | > Tell us your use-case, so we can share to others
340 |
341 | - [Remote connect windows without exposing public IP with Omniedge](https://omniedge.io/docs/article/Cases/RDP)
342 | - [Display and control macOS, Linux and Windows ](https://omniedge.io/docs/article/Cases/VNC)
343 | - [Keep connection with your AI based Project on Jetson](https://omniedge.io/docs/article/Cases/jetson)
344 | - [Display and control your Android device with Omniedge from anywhere on MacOS, Windows and Linux](https://omniedge.io/docs/article/Cases/android-remote)
345 | - [Talk to your family and share photos in a LAN on the internet](https://omniedge.io/docs/article/Cases/lan-messenger)
346 | - [Air Drop Any Files between MacOS, Windows, Routers, Linux and Android with Omniedge from anywhere](https://omniedge.io/docs/article/Cases/landrop)
347 |
348 | ## Compare
349 |
350 | - [VPN vs. OmniEdge](https://omniedge.io/docs/article/compare/vpn-vs-omniedge)
351 | - [Express VPN vs. OmniEdge](https://omniedge.io/docs/article/compare/expressvpn-vs-omniedge)
352 | - [frp/ngrok vs. OmniEdge](https://omniedge.io/docs/article/compare/frp-ngrok-vs-omniedge)
353 | - [ZeroTier vs. OmniEdge](https://omniedge.io/docs/article/compare/zerotier-vs-omniedge)
354 | - [n2n vs. OmniEdge](https://omniedge.io/docs/article/compare/n2n-vs-omniedge)
355 |
356 | ## Who are talking about us
357 |
358 | - [Founded by a Single Tweet Startup OmniEdge’s effort to let connect without concern](https://threat.technology/founded-by-a-single-tweet-startup-omniedges-effort-to-let-connect-without-concern/)
359 | - [voonze: OmniEdge, to access your Intranet from the Internet using P2P](https://voonze.com/omniedge-to-access-your-intranet-from-the-internet-using-p2p/)
360 | - [wwwhatsnew: OMNIEDGE, PARA ACCEDER A TU INTRANET DESDE INTERNET USANDO P2P](https://wwwhatsnew.com/2022/03/03/omniedge-para-acceder-a-tu-intranet-desde-internet-usando-p2p/)
361 | - [l'Entrepreneur: OmniEdge, pour accéder à votre Intranet depuis Internet en P2P](https://lentrepreneur.co/style/technologie/omniedge-pour-acceder-a-votre-intranet-depuis-internet-en-p2p-04032022)
362 | - [RunaCapital: Awesome OSS alternatives](https://github.com/RunaCapital/awesome-oss-alternatives)
363 | - [OmniEdge in ntopconf 2022](https://www.ntop.org/ntopconf2022/)
364 |
365 | ## Advisor
366 |
367 | [lucaderi](https://github.com/lucaderi)
368 |
369 | ## Contributors
370 |
371 | [harri8807](https://github.com/orgs/omniedgeio/people/harri8807) , [Tex-Tang](https://github.com/Tex-Tang), [ivyxjc](https://github.com/orgs/omniedgeio/people/ivyxjc), [kidylee](https://github.com/kidylee), [EbenDang](https://github.com/orgs/omniedgeio/people/EbenDang)
372 | ,[zteshadow](https://github.com/zteshadow), [ChenYouping](https://github.com/orgs/omniedgeio/people/ChenYouping),[ddrandy](https://github.com/orgs/omniedgeio/people/ddrandy), **Tsingv**, [mtx2d](https://github.com/mtx2d),[Blackrose](https://github.com/Blackrose), [cheung-chifung](https://github.com/cheung-chifung),[我不是矿神](https://imnks.com/5768.html)
373 |
374 |
375 | >feel free to tell us about any posts related us via issue or PR.
376 |
377 | ----
378 |
379 | If you have more questions, feel free to talk to us at [Discussions](https://github.com/omniedgeio/omniedge/discussions).
380 |
--------------------------------------------------------------------------------
/README/README-AR.md:
--------------------------------------------------------------------------------
1 |
2 | 
3 |
4 |
36 |
37 |
38 | [【English】](../README.md) [【繁体中文】](README-zh-Hant.md) [【简体中文】](README-zh-Hans.md) [【日本语】](README-JP.md) [【Español】](README-ES.md) [【Italiano】](README-IT.md) [【한국어】](README-KR.md)
39 | [【العربي】](README-AR.md) [【Tiếng Việt】](README-VN.md) [【แบบไทย】](README-TH.md)
40 |
41 | OmniEdge عبارة عن بنية أساسية لشبكة VPN من الطبقة الثانية من p2p مفتوحة المصدر تعتمد على بروتوكول [n2n](https://github.com/ntop/n2n) ، وهو بديل تقليدي للشبكات الظاهرية الخاصة. لا يوجد خادم مركزي ، سهل القياس مع صيانة أقل. ما يحدث في الإنترانت ، يبقى في الإنترانت.
42 |
43 | 
44 |
45 | ## دلائل الميزات:
46 |
47 | ||||
48 | | ---- | ---- | ---- |
49 | | إدارة إدارة لوحة المعلومات | الشبكات الظاهرية الخاصة الشبكية | تطبيقات واجهة المستخدم الرسومية لسطح المكتب لنظام التشغيل MacOS (شريط القوائم) و Windows (نظام التشغيل systray) |
50 | | شبكات افتراضية متعددة | شبكات VPN من موقع إلى موقع | تطبيقات سطر الأوامر cli لنظام التشغيل Linux و FreeBSD و Raspbian و MacOS |
51 | | تعدد المستخدمين | نقل غير محدود للبيانات | تطبيقات سطر الأوامر cli لـ armv7 و arm64 و RISC-V64 و x86_64 و amd64 |
52 | | أجهزة متعددة | اتصال نظير إلى نظير مشفر | تطبيقات الجوال لنظامي التشغيل iOS و Android |
53 | | Supernode ذاتية الاستضافة | ترحيل اتصال مشفر | تطبيقات الأجهزة اللوحية لأجهزة iPad و Android Tablet و Android TV |
54 | | مشاركة الشبكة الافتراضية | دعم السحابة المختلطة | تطبيق NAS لـ Synology |
55 | | مفاتيح الأمان | التكوين الصفري | التخصيص التلقائي للعموم الفائق |
56 | | [التحكم في الجهاز عن بُعد](https://omniedge.io/docs/article/Cases/VNC) | [إفلات الملفات عن بُعد](https://omniedge.io/docs/article/Cases/landrop) | التخصيص التلقائي لعنوان IP |
57 |
58 |
59 | يمكنك العثور على مزيد من الميزات في صفحة [التسعير] (https://omniedge.io/pricing) للمؤسسات.
60 |
61 | ## ابدأ في 5 دقائق
62 |
63 | 1. اشترك في حسابك: [اشترك] (https://omniedge.io/register)
64 | 2. [تنزيل] (https://omniedge.io/download) تطبيقات OmniEdge لمنصتك
65 | 3. أو قم بتشغيل الأمر التالي إذا كنت تريد استخدام إصدار cli:
66 | "" باش
67 | حليقة https://omniedge.io/install/omniedge-install.sh | سحق
68 | ""
69 | 4. تسجيل الدخول باستخدام البريد الإلكتروني وكلمة المرور الخاصة بك ، حدد الشبكة الخاصة بك ، والاتصال!
70 |
71 | أنت كل مجموعة!
72 |
73 | وإذا كنت تريد تسجيل الدخول باستخدام ** مفتاح الأمان ** ، أو إدارة أجهزتك ، فانتقل وتحقق من [التوثيق] (https://omniedge.io/docs) لمزيد من المعلومات.
74 |
75 | ## ترجمة
76 |
77 | ### OmniEdge Cli
78 |
79 | 1. البيئة: جولانج 1.16.6
80 | 2. تجميع:
81 |
82 | - 2.1. Ubuntu /linux
83 |
84 | ```bash
85 | sudo apt-get -y update
86 | sudo apt-get install -y openssl build-essential libssl-dev zip autoconf
87 | git clone https://github.com/omniedgeio/omniedge-cli
88 | cd omniedge-cli
89 | go mod download
90 | go generate
91 | BUILD_ENV=prod make build
92 | ```
93 |
94 | - 2.2. macOS
95 |
96 | ```bash
97 | brew install autoconf automake libtool
98 | git clone https://github.com/omniedgeio/omniedge-cli
99 | cd omniedge-cli
100 | go mod download
101 | go generate
102 | BUILD_ENV=prod make build-darwin
103 | ```
104 |
105 | - 2.3. freebsd
106 |
107 | ```bash
108 | su
109 | pkg update && pkg install go gmake git openssl zip autoconf automake libtool
110 | git clone https://github.com/omniedgeio/omniedge-cli
111 | cd omniedge-cli
112 | go mod download
113 | go generate
114 | BUILD_ENV=prod make build-freebsd
115 | ```
116 |
117 | 3. عبر ترجمة
118 |
119 | - 3.1 RISC-V
120 |
121 | Host OS: Ubuntu 20.04
122 |
123 | ```bash
124 | apt-get update
125 | apt-get install -y openssl autoconf build-essential libssl-dev zip wget g++-riscv64-linux-gnu gcc-riscv64-linux-gnu
126 |
127 | wget https://go.dev/dl/go1.18.4.linux-amd64.tar.gz
128 | rm -rf /usr/local/go && tar -C /usr/local -xzf go1.18.4.linux-amd64.tar.gz
129 | export PATH=$PATH:/usr/local/go/bin
130 | go version
131 | export GOOS=linux
132 | export GOARCH=riscv64
133 | export CGO_ENABLED=1
134 | export CC=riscv64-linux-gnu-gcc
135 | git clone https://github.com/omniedgeio/omniedge-cli.git
136 | cd omniedge-cli
137 | go mod download
138 | go generate
139 | BUILD_ENV=prod make build-riscv64
140 | ```
141 |
142 | سيتم العثور على omniedge-cli المترجم في ** / خارج / **
143 |
144 | ### OmniEdge Android
145 |
146 | 1. قم بتنزيل Android Studio: https://developer.android.com/studio
147 | 2. الحصول على الريبو والترجمة
148 |
149 | ```bash
150 | git clone https://github.com/omniedgeio/omniedge-android.git`
151 | ./gradlew test --stacktrace
152 | ./gradlew assembleDebug --stacktrace
153 | ```
154 |
155 | لقد أعددنا أيضًا CI لـ Github و Gitlab للبناء تلقائيًا.
156 |
157 | 1. Github: https://github.com/omniedgeio/omniedge-android/blob/main/.github/workflows/build.yml
158 | 2. GitLab: https://github.com/omniedgeio/omniedge-android/blob/main/.gitlab-ci.yml
159 |
160 |
161 | ### OmniEdge iOS
162 |
163 | 1. قم بتنزيل وتثبيت Xcode
164 | 2. الحصول على الريبو والترجمة
165 |
166 | ```bash
167 | git clone https://github.com/omniedgeio/omniedge-iOS.git
168 | cd omniedge-iOS
169 | open OmniEdgeNew/OmniEdgeNew.xcworkspace
170 | ```
171 |
172 | سيتم فتح Xcode تلقائيًا ، يجب عليك تعيين حساب المطور الخاص بك لبدء الترجمة. نوصي بتجميع الحزمة على أجهزتك بشكل منفصل ، خاصة حزمة **Tunnel**.
173 |
174 |
175 |
176 | ### OmniEdge-macOS
177 |
178 | 1. قم بتنزيل وتثبيت Xcode
179 | 2. الحصول على الريبو والترجمة
180 |
181 | ```bash
182 | git clone https://github.com/omniedgeio/omniedge-macOS.git
183 | cd omniedge-macOS
184 | open Omniedge.xcodeproj
185 | ```
186 |
187 | سيتم فتح Xcode تلقائيًا ، يجب عليك تعيين حساب المطور الخاص بك لبدء الترجمة.
188 |
189 | ### OmniEdge-windows
190 |
191 | 1. قم بتنزيل وتثبيت QT
192 | 2. الحصول على الريبو والترجمة
193 |
194 | ```bash
195 | git clone https://github.com/omniedgeio/omniedge-windows.git
196 | cd omniedge-windows
197 | ```
198 |
199 | افتح **OmniEdge.pro** وابدأ في التجميع.
200 |
201 | ## الاستخدام
202 |
203 | - [Virtual Network, Devices, Security Key, and Settings](https://omniedge.io/docs/article/admin)
204 | - [Windows 7,10,11 for Intel or Arm](https://omniedge.io/docs/article/install/windows)
205 | - [Android](https://omniedge.io/docs/article/install/android)
206 | - [Linux Cli for raspberry Pi, Nvidia Jeston,and more](https://omniedge.io/docs/article/install/cli)
207 | - [MacOS Cli](https://omniedge.io/docs/article/install/macoscli)
208 | - [Synology](https://omniedge.io/docs/article/install/synology)
209 | - [Docker](https://omniedge.io/docs/article/install/docker)
210 | - [Github Action](https://omniedge.io/docs/article/install/github-action)
211 | - [iOS](https://omniedge.io/docs/article/install/ios)
212 | - [Setup custom supernode](https://omniedge.io/docs/article/install/customize-supernode)
213 |
214 | ## استخدم حالات
215 |
216 | > أخبرنا بحالة الاستخدام الخاصة بك ، حتى نتمكن من مشاركتها مع الآخرين
217 |
218 | - [Remote connect windows without exposing public IP with Omniedge](https://omniedge.io/docs/article/Cases/RDP)
219 | - [Display and control macOS, Linux and Windows ](https://omniedge.io/docs/article/Cases/VNC)
220 | - [Keep connection with your AI based Project on Jetson](https://omniedge.io/docs/article/Cases/jetson)
221 | - [Display and control your Android device with Omniedge from anywhere on MacOS, Windows and Linux](https://omniedge.io/docs/article/Cases/android-remote)
222 | - [Talk to your family and share photos in a LAN on the internet](https://omniedge.io/docs/article/Cases/lan-messenger)
223 | - [Air Drop Any Files between MacOS, Windows, Routers, Linux and Android with Omniedge from anywhere](https://omniedge.io/docs/article/Cases/landrop)
224 |
225 | ## قارن
226 |
227 | - [VPN vs. OmniEdge](https://omniedge.io/docs/article/compare/vpn-vs-omniedge)
228 | - [Express VPN vs. OmniEdge](https://omniedge.io/docs/article/compare/expressvpn-vs-omniedge)
229 | - [frp/ngrok vs. OmniEdge](https://omniedge.io/docs/article/compare/frp-ngrok-vs-omniedge)
230 | - [ZeroTier vs. OmniEdge](https://omniedge.io/docs/article/compare/zerotier-vs-omniedge)
231 | - [n2n vs. OmniEdge](https://omniedge.io/docs/article/compare/n2n-vs-omniedge)
232 |
233 | ## من يتحدث عنا
234 |
235 | - [Founded by a Single Tweet Startup OmniEdge’s effort to let connect without concern](https://threat.technology/founded-by-a-single-tweet-startup-omniedges-effort-to-let-connect-without-concern/)
236 | - [voonze: OmniEdge, to access your Intranet from the Internet using P2P](https://voonze.com/omniedge-to-access-your-intranet-from-the-internet-using-p2p/)
237 | - [wwwhatsnew: OMNIEDGE, PARA ACCEDER A TU INTRANET DESDE INTERNET USANDO P2P](https://wwwhatsnew.com/2022/03/03/omniedge-para-acceder-a-tu-intranet-desde-internet-usando-p2p/)
238 | - [l'Entrepreneur: OmniEdge, pour accéder à votre Intranet depuis Internet en P2P](https://lentrepreneur.co/style/technologie/omniedge-pour-acceder-a-votre-intranet-depuis-internet-en-p2p-04032022)
239 | - [RunaCapital: Awesome OSS alternatives](https://github.com/RunaCapital/awesome-oss-alternatives)
240 | - [OmniEdge in ntopconf 2022](https://www.ntop.org/ntopconf2022/)
241 |
242 | ## Advisor
243 |
244 | [lucaderi](https://github.com/lucaderi)
245 |
246 | ## Contributors
247 |
248 | [harri8807](https://github.com/orgs/omniedgeio/people/harri8807) , [Tex-Tang](https://github.com/Tex-Tang), [ivyxjc](https://github.com/orgs/omniedgeio/people/ivyxjc), [kidylee](https://github.com/kidylee), [EbenDang](https://github.com/orgs/omniedgeio/people/EbenDang)
249 | ,[zteshadow](https://github.com/zteshadow), [ChenYouping](https://github.com/orgs/omniedgeio/people/ChenYouping),[ddrandy](https://github.com/orgs/omniedgeio/people/ddrandy), **Tsingv**, [mtx2d](https://github.com/mtx2d),[Blackrose](https://github.com/Blackrose), [cheung-chifung](https://github.com/cheung-chifung),[我不是矿神](https://imnks.com/5768.html)
250 |
251 |
252 | > لا تتردد في إخبارنا بأي منشورات تتعلق بنا عبر المشكلة أو العلاقات العامة.
253 |
254 | ----
255 |
256 | إذا كان لديك المزيد من الأسئلة ، فلا تتردد في التحدث إلينا على [Discussions](https://github.com/omniedgeio/omniedge/discussions).
--------------------------------------------------------------------------------
/README/README-ES.md:
--------------------------------------------------------------------------------
1 |
2 | 
3 |
4 |
36 |
37 | [【English】](../README.md) [【繁体中文】](README-zh-Hant.md) [【简体中文】](README-zh-Hans.md) [【日本语】](README-JP.md) [【Español】](README-ES.md) [【Italiano】](README-IT.md) [【한국어】](README-KR.md)
38 | [【العربي】](README-AR.md) [【Tiếng Việt】](README-VN.md) [【แบบไทย】](README-TH.md)
39 |
40 |
41 | OmniEdge es una infraestructura VPN p2p de código abierto de capa 2 basada en el protocolo [n2n](https://github.com/ntop/n2n), una alternativa VPN tradicional. Sin servidor central, fácil de escalar con menos mantenimiento. Lo que pasa en la intranet, se queda en la intranet.
42 |
43 | 
44 |
45 | ## Características clave:
46 |
47 | ||||
48 | |----|----|----|
49 | |Gestión de la administración del panel de control|VPN en malla|Aplicaciones GUI de escritorio para MacOS (barra de menú) y Windows (bandeja del sistema)|
50 | |Multiredes virtuales|VPN de sitio a sitio|Aplicaciones CLI de línea de comando para Linux, FreeBSD, Raspbian y MacOS|
51 | |Usuarios múltiples|Transferencia de datos ilimitada|Aplicaciones CLI de línea de comandos para armv7,arm64,RISC-V64,x86_64 y amd64|
52 | |Dispositivos múltiples|Conexión punto a punto cifrada|Aplicaciones móviles para iOS y Android|
53 | |Supernodo autohospedado |Retransmisión de conexión cifrada|Aplicaciones de tableta para iPad, tableta Android y Android TV|
54 | |Compartir red virtual|Compatibilidad con nube híbrida|Aplicación NAS para Synology|
55 | |Llaves de seguridad| Zero-Config|Asignación automática de supernodos públicos|
56 | |[Control remoto de dispositivos](https://omniedge.io/docs/article/Cases/VNC)|[Soltar archivos de forma remota](https://omniedge.io/docs/article/Cases/landdrop) |Asignación automática de IP |
57 |
58 |
59 | Puede encontrar más funciones en la página de [Precios](https://omniedge.io/pricing) para empresas.
60 |
61 | ## Comience en 5 minutos
62 |
63 | 1. Registre su cuenta: [Registrarse](https://omniedge.io/register)
64 | 2. [Descargar](https://omniedge.io/download) Aplicaciones OmniEdge para su plataforma
65 | 3. O ejecute el siguiente comando si desea usar la versión cli:
66 | ```bash
67 | curl https://omniedge.io/install/omniedge-install.sh | intento
68 | ```
69 | 4. Inicie sesión con su correo electrónico y contraseña, seleccione su red virtual, ¡conéctese!
70 |
71 | ¡Estas listo!
72 |
73 | Y si desea iniciar sesión con **clave de seguridad** o administrar sus dispositivos, consulte [Documentación](https://omniedge.io/docs) para obtener más información.
74 |
75 | ## Compilar
76 |
77 | ### OmniEdge Clip
78 |
79 | 1. Medio ambiente: Golang 1.16.6
80 | 2. Compilar:
81 |
82 | - 2.1. Ubuntu /linux
83 |
84 | ```bash
85 | sudo apt-get -y update
86 | sudo apt-get install -y openssl build-essential libssl-dev zip autoconf
87 | git clone https://github.com/omniedgeio/omniedge-cli
88 | cd omniedge-cli
89 | go mod download
90 | go generate
91 | BUILD_ENV=prod make build
92 | ```
93 |
94 | - 2.2. macOS
95 |
96 | ```bash
97 | brew install autoconf automake libtool
98 | git clone https://github.com/omniedgeio/omniedge-cli
99 | cd omniedge-cli
100 | go mod download
101 | go generate
102 | BUILD_ENV=prod make build-darwin
103 | ```
104 |
105 | - 2.3. freebsd
106 |
107 | ```bash
108 | su
109 | pkg update && pkg install go gmake git openssl zip autoconf automake libtool
110 | git clone https://github.com/omniedgeio/omniedge-cli
111 | cd omniedge-cli
112 | go mod download
113 | go generate
114 | BUILD_ENV=prod make build-freebsd
115 | ```
116 | 3. Compilación cruzada
117 |
118 | - 3.1 RISC-V
119 |
120 | Sistema operativo anfitrión: Ubuntu 20.04
121 |
122 | ```bash
123 | apt-get update
124 | apt-get install -y openssl autoconf build-essential libssl-dev zip wget g++-riscv64-linux-gnu gcc-riscv64-linux-gnu
125 |
126 | wget https://go.dev/dl/go1.18.4.linux-amd64.tar.gz
127 | rm -rf /usr/local/go && tar -C /usr/local -xzf go1.18.4.linux-amd64.tar.gz
128 | export PATH=$PATH:/usr/local/go/bin
129 | go version
130 | export GOOS=linux
131 | export GOARCH=riscv64
132 | export CGO_ENABLED=1
133 | export CC=riscv64-linux-gnu-gcc
134 | git clone https://github.com/omniedgeio/omniedge-cli.git
135 | cd omniedge-cli
136 | go mod download
137 | go generate
138 | BUILD_ENV=prod make build-riscv64
139 | ```
140 |
141 | El omniedge-cli compilado se encontrará en **/out/**
142 |
143 | ### OmniEdge Android
144 |
145 | 1. Descarga Android Studio: https://developer.android.com/studio
146 | 2. Obtener el repositorio y compilar
147 |
148 | ```bash
149 | git clone https://github.com/omniedgeio/omniedge-android.git`
150 | ./gradlew test --stacktrace
151 | ./gradlew assembleDebug --stacktrace
152 | ```
153 |
154 | También hemos preparado el CI para Github y Gitlab para construir automáticamente.
155 |
156 | 1. Github: https://github.com/omniedgeio/omniedge-android/blob/main/.github/workflows/build.yml
157 | 2. GitLab: https://github.com/omniedgeio/omniedge-android/blob/main/.gitlab-ci.yml
158 |
159 |
160 | ### OmniEdge iOS
161 |
162 | 1. Descarga e instala Xcode
163 | 2. Obtener el repositorio y compilar
164 |
165 | ```bash
166 | git clone https://github.com/omniedgeio/omniedge-iOS.git
167 | cd omniedge-iOS
168 | open OmniEdgeNew/OmniEdgeNew.xcworkspace
169 | ```
170 |
171 | Xcode se abrirá automáticamente, debe configurar su cuenta de desarrollador para iniciar la compilación. Recomendamos compilar el paquete en sus dispositivos por separado, especialmente el paquete **Tunnel**.
172 |
173 |
174 |
175 | ### OmniEdge-macOS
176 |
177 | 1. Descarga e instala Xcode
178 | 2. Obtener el repositorio y compilar
179 |
180 | ```bash
181 | git clone https://github.com/omniedgeio/omniedge-macOS.git
182 | cd omniedge-macOS
183 | open Omniedge.xcodeproj
184 | ```
185 |
186 | Xcode se abrirá automáticamente, debe configurar su cuenta de desarrollador para iniciar la compilación.
187 |
188 | ### OmniEdge-windows
189 |
190 | 1. Descarga e instala QT
191 | 2. Obtener el repositorio y compilar
192 |
193 | ```bash
194 | git clone https://github.com/omniedgeio/omniedge-windows.git
195 | cd omniedge-windows
196 | ```
197 |
198 | abre **OmniEdge.pro** y comienza a compilar.
199 |
200 |
201 | ## Uso
202 |
203 | - [Virtual Network, Devices, Security Key, and Settings](https://omniedge.io/docs/article/admin)
204 | - [Windows 7,10,11 for Intel or Arm](https://omniedge.io/docs/article/install/windows)
205 | - [Android](https://omniedge.io/docs/article/install/android)
206 | - [Linux Cli for raspberry Pi, Nvidia Jeston,and more](https://omniedge.io/docs/article/install/cli)
207 | - [MacOS Cli](https://omniedge.io/docs/article/install/macoscli)
208 | - [Synology](https://omniedge.io/docs/article/install/synology)
209 | - [Docker](https://omniedge.io/docs/article/install/docker)
210 | - [Github Action](https://omniedge.io/docs/article/install/github-action)
211 | - [iOS](https://omniedge.io/docs/article/install/ios)
212 | - [Setup custom supernode](https://omniedge.io/docs/article/install/customize-supernode)
213 |
214 | ## Casos de uso
215 |
216 | > Cuéntenos su caso de uso, para que podamos compartirlo con otros
217 |
218 | - [Remote connect windows without exposing public IP with Omniedge](https://omniedge.io/docs/article/Cases/RDP)
219 | - [Display and control macOS, Linux and Windows ](https://omniedge.io/docs/article/Cases/VNC)
220 | - [Keep connection with your AI based Project on Jetson](https://omniedge.io/docs/article/Cases/jetson)
221 | - [Display and control your Android device with Omniedge from anywhere on MacOS, Windows and Linux](https://omniedge.io/docs/article/Cases/android-remote)
222 | - [Talk to your family and share photos in a LAN on the internet](https://omniedge.io/docs/article/Cases/lan-messenger)
223 | - [Air Drop Any Files between MacOS, Windows, Routers, Linux and Android with Omniedge from anywhere](https://omniedge.io/docs/article/Cases/landrop)
224 |
225 | ## Comparar
226 |
227 | - [VPN vs. OmniEdge](https://omniedge.io/docs/article/compare/vpn-vs-omniedge)
228 | - [Express VPN vs. OmniEdge](https://omniedge.io/docs/article/compare/expressvpn-vs-omniedge)
229 | - [frp/ngrok vs. OmniEdge](https://omniedge.io/docs/article/compare/frp-ngrok-vs-omniedge)
230 | - [ZeroTier vs. OmniEdge](https://omniedge.io/docs/article/compare/zerotier-vs-omniedge)
231 | - [n2n vs. OmniEdge](https://omniedge.io/docs/article/compare/n2n-vs-omniedge)
232 |
233 | ## Quien esta hablando de nosotros
234 |
235 | - [Founded by a Single Tweet Startup OmniEdge’s effort to let connect without concern](https://threat.technology/founded-by-a-single-tweet-startup-omniedges-effort-to-let-connect-without-concern/)
236 | - [voonze: OmniEdge, to access your Intranet from the Internet using P2P](https://voonze.com/omniedge-to-access-your-intranet-from-the-internet-using-p2p/)
237 | - [wwwhatsnew: OMNIEDGE, PARA ACCEDER A TU INTRANET DESDE INTERNET USANDO P2P](https://wwwhatsnew.com/2022/03/03/omniedge-para-acceder-a-tu-intranet-desde-internet-usando-p2p/)
238 | - [l'Entrepreneur: OmniEdge, pour accéder à votre Intranet depuis Internet en P2P](https://lentrepreneur.co/style/technologie/omniedge-pour-acceder-a-votre-intranet-depuis-internet-en-p2p-04032022)
239 | - [RunaCapital: Awesome OSS alternatives](https://github.com/RunaCapital/awesome-oss-alternatives)
240 | - [OmniEdge in ntopconf 2022](https://www.ntop.org/ntopconf2022/)
241 |
242 | ## Advisor
243 |
244 | [lucaderi](https://github.com/lucaderi)
245 |
246 | ## Contributors
247 |
248 | [harri8807](https://github.com/orgs/omniedgeio/people/harri8807) , [Tex-Tang](https://github.com/Tex-Tang), [ivyxjc](https://github.com/orgs/omniedgeio/people/ivyxjc), [kidylee](https://github.com/kidylee), [EbenDang](https://github.com/orgs/omniedgeio/people/EbenDang)
249 | ,[zteshadow](https://github.com/zteshadow), [ChenYouping](https://github.com/orgs/omniedgeio/people/ChenYouping),[ddrandy](https://github.com/orgs/omniedgeio/people/ddrandy), **Tsingv**, [mtx2d](https://github.com/mtx2d),[Blackrose](https://github.com/Blackrose), [cheung-chifung](https://github.com/cheung-chifung),[我不是矿神](https://imnks.com/5768.html)
250 |
251 |
252 | > siéntase libre de informarnos sobre cualquier publicación relacionada con nosotros a través de un problema o relaciones públicas.
253 |
254 | ----
255 |
256 | Si tiene más preguntas, no dude en comunicarse con nosotros en [Discussions](https://github.com/omniedgeio/omniedge/discussions).
257 |
--------------------------------------------------------------------------------
/README/README-IT.md:
--------------------------------------------------------------------------------
1 |
2 | 
3 |
4 |
36 |
37 | [【English】](../README.md) [【繁体中文】](README-zh-Hant.md) [【简体中文】](README-zh-Hans.md) [【日本语】](README-JP.md) [【Español】](README-ES.md) [【Italiano】](README-IT.md) [【한국어】](README-KR.md)
38 | [【العربي】](README-AR.md) [【Tiếng Việt】](README-VN.md) [【แบบไทย】](README-TH.md)
39 |
40 | OmniEdge è un'infrastruttura VPN di livello 2 p2p open source basata sul protocollo [n2n](https://github.com/ntop/n2n), un'alternativa VPN tradizionale. Nessun server centrale, facile da scalare con meno manutenzione. Ciò che accade in intranet, rimane in intranet.
41 |
42 | 
43 |
44 | ## Caratteristiche principali:
45 |
46 | ||||
47 | |----|----|----|
48 | |Gestione amministrazione dashboard|VPN mesh|App GUI desktop per MacOS(barra dei menu) e Windows(systray)|
49 | |Reti virtuali multiple|VPN da sito a sito|App cli da riga di comando per Linux, FreeBSD, Raspbian e MacOS|
50 | |Multi utenti|Trasferimento dati illimitato|App cli riga di comando per armv7, arm64, RISC-V64, x86_64 e amd64|
51 | |Multi dispositivi|Connessione peer-to-peer crittografata|App mobili per iOS e Android|
52 | |Supernodo self-hosted |Relè di connessione crittografato|App per tablet per iPad, tablet Android e Android TV|
53 | |Condivisione rete virtuale|Supporto cloud ibrido|App NAS per Synology|
54 | |Chiavi di sicurezza| Zero-Config|Assegnazione automatica dei supernodi pubblici|
55 | |[Controllo dispositivo remoto](https://omniedge.io/docs/article/Cases/VNC)|[Rilascia file in remoto](https://omniedge.io/docs/article/Cases/landrop) |Assegnazione IP automatica |
56 |
57 |
58 | Puoi trovare altre funzionalità nella pagina [Pricing](https://omniedge.io/pricing) per Enterprise.
59 |
60 | ## Inizia in 5 minuti
61 |
62 | 1. Registra il tuo account: [Registrati](https://omniedge.io/register)
63 | 2. [Scarica](https://omniedge.io/download) App OmniEdge per la tua piattaforma
64 | 3. Oppure esegui il seguente comando se desideri utilizzare la versione cli:
65 | ```bash
66 | curl https://omniedge.io/install/omniedge-install.sh | bash
67 | ```
68 | 4. Accedi con la tua Email e password, seleziona la tua rete virtuale, connettiti!
69 |
70 | Siete a posto!
71 |
72 | E se vuoi accedere con la **chiave di sicurezza**, o gestire i tuoi dispositivi, vai e controlla [Documentazione](https://omniedge.io/docs) per ulteriori informazioni.
73 |
74 | ## Compila
75 |
76 | ### OmniEdge Cli
77 |
78 | 1. Ambiente: Golang 1.16.6
79 | 2. Compila:
80 |
81 | - 2.1. Ubuntu /linux
82 |
83 | ```bash
84 | sudo apt-get -y update
85 | sudo apt-get install -y openssl build-essential libssl-dev zip autoconf
86 | git clone https://github.com/omniedgeio/omniedge-cli
87 | cd omniedge-cli
88 | go mod download
89 | go generate
90 | BUILD_ENV=prod make build
91 | ```
92 |
93 | - 2.2. macOS
94 |
95 | ```bash
96 | brew install autoconf automake libtool
97 | git clone https://github.com/omniedgeio/omniedge-cli
98 | cd omniedge-cli
99 | go mod download
100 | go generate
101 | BUILD_ENV=prod make build-darwin
102 | ```
103 |
104 | - 2.3. freebsd
105 |
106 | ```bash
107 | su
108 | pkg update && pkg install go gmake git openssl zip autoconf automake libtool
109 | git clone https://github.com/omniedgeio/omniedge-cli
110 | cd omniedge-cli
111 | go mod download
112 | go generate
113 | BUILD_ENV=prod make build-freebsd
114 | ```
115 |
116 | 3. Compilazione incrociata
117 |
118 | - 3.1 RISC-V
119 |
120 | Sistema operativo host: Ubuntu 20.04
121 |
122 | ```bash
123 | apt-get update
124 | apt-get install -y openssl autoconf build-essential libssl-dev zip wget g++-riscv64-linux-gnu gcc-riscv64-linux-gnu
125 |
126 | wget https://go.dev/dl/go1.18.4.linux-amd64.tar.gz
127 | rm -rf /usr/local/go && tar -C /usr/local -xzf go1.18.4.linux-amd64.tar.gz
128 | export PATH=$PATH:/usr/local/go/bin
129 | go version
130 | export GOOS=linux
131 | export GOARCH=riscv64
132 | export CGO_ENABLED=1
133 | export CC=riscv64-linux-gnu-gcc
134 | git clone https://github.com/omniedgeio/omniedge-cli.git
135 | cd omniedge-cli
136 | go mod download
137 | go generate
138 | BUILD_ENV=prod make build-riscv64
139 | ```
140 |
141 | L'omniedge-cli compilato si troverà in **/out/**
142 |
143 | ### OmniEdge Android
144 |
145 | 1. Scarica Android Studio: https://developer.android.com/studio
146 | 2. Ottieni il repository e compila
147 |
148 | ```bash
149 | git clone https://github.com/omniedgeio/omniedge-android.git`
150 | ./gradlew test --stacktrace
151 | ./gradlew assembleDebug --stacktrace
152 | ```
153 |
154 | Abbiamo anche preparato il CI per Github e Gitlab per la compilazione automatica.
155 |
156 | 1. Github: https://github.com/omniedgeio/omniedge-android/blob/main/.github/workflows/build.yml
157 | 2. GitLab: https://github.com/omniedgeio/omniedge-android/blob/main/.gitlab-ci.yml
158 |
159 |
160 | ### OmniEdge iOS
161 |
162 | 1. Scarica e installa Xcode
163 | 2. Ottieni il repository e compila
164 |
165 | ```bash
166 | git clone https://github.com/omniedgeio/omniedge-iOS.git
167 | cd omniedge-iOS
168 | open OmniEdgeNew/OmniEdgeNew.xcworkspace
169 | ```
170 |
171 | Xcode si aprirà automaticamente, devi impostare il tuo account sviluppatore per avviare la compilazione. Ti consigliamo di compilare il pacchetto sui tuoi dispositivi separatamente, in particolare il pacchetto **Tunnel**.
172 |
173 |
174 |
175 | ### OmniEdge-macOS
176 |
177 | 1. Scarica e installa Xcode
178 | 2. Ottieni il repository e compila
179 |
180 | ```bash
181 | git clone https://github.com/omniedgeio/omniedge-macOS.git
182 | cd omniedge-macOS
183 | open Omniedge.xcodeproj
184 | ```
185 |
186 | Xcode si aprirà automaticamente, devi impostare il tuo account sviluppatore per avviare la compilazione.
187 |
188 | ### OmniEdge-windows
189 |
190 | 1. Scarica e installa QT
191 | 2. Ottieni il repository e compila
192 |
193 | ```bash
194 | git clone https://github.com/omniedgeio/omniedge-windows.git
195 | cd omniedge-windows
196 | ```
197 |
198 | apri **OmniEdge.pro** e inizia a compilare.
199 |
200 | ## Utilizzo
201 |
202 | - [Virtual Network, Devices, Security Key, and Settings](https://omniedge.io/docs/article/admin)
203 | - [Windows 7,10,11 for Intel or Arm](https://omniedge.io/docs/article/install/windows)
204 | - [Android](https://omniedge.io/docs/article/install/android)
205 | - [Linux Cli for raspberry Pi, Nvidia Jeston,and more](https://omniedge.io/docs/article/install/cli)
206 | - [MacOS Cli](https://omniedge.io/docs/article/install/macoscli)
207 | - [Synology](https://omniedge.io/docs/article/install/synology)
208 | - [Docker](https://omniedge.io/docs/article/install/docker)
209 | - [Github Action](https://omniedge.io/docs/article/install/github-action)
210 | - [iOS](https://omniedge.io/docs/article/install/ios)
211 | - [Setup custom supernode](https://omniedge.io/docs/article/install/customize-supernode)
212 |
213 | ## Casi d'uso
214 |
215 | > Dicci il tuo caso d'uso, così possiamo condividerlo con gli altri
216 |
217 | - [Remote connect windows without exposing public IP with Omniedge](https://omniedge.io/docs/article/Cases/RDP)
218 | - [Display and control macOS, Linux and Windows ](https://omniedge.io/docs/article/Cases/VNC)
219 | - [Keep connection with your AI based Project on Jetson](https://omniedge.io/docs/article/Cases/jetson)
220 | - [Display and control your Android device with Omniedge from anywhere on MacOS, Windows and Linux](https://omniedge.io/docs/article/Cases/android-remote)
221 | - [Talk to your family and share photos in a LAN on the internet](https://omniedge.io/docs/article/Cases/lan-messenger)
222 | - [Air Drop Any Files between MacOS, Windows, Routers, Linux and Android with Omniedge from anywhere](https://omniedge.io/docs/article/Cases/landrop)
223 |
224 | ## Confrontare
225 |
226 | - [VPN vs. OmniEdge](https://omniedge.io/docs/article/compare/vpn-vs-omniedge)
227 | - [Express VPN vs. OmniEdge](https://omniedge.io/docs/article/compare/expressvpn-vs-omniedge)
228 | - [frp/ngrok vs. OmniEdge](https://omniedge.io/docs/article/compare/frp-ngrok-vs-omniedge)
229 | - [ZeroTier vs. OmniEdge](https://omniedge.io/docs/article/compare/zerotier-vs-omniedge)
230 | - [n2n vs. OmniEdge](https://omniedge.io/docs/article/compare/n2n-vs-omniedge)
231 |
232 | ## Chi parla di noi
233 |
234 | - [Founded by a Single Tweet Startup OmniEdge’s effort to let connect without concern](https://threat.technology/founded-by-a-single-tweet-startup-omniedges-effort-to-let-connect-without-concern/)
235 | - [voonze: OmniEdge, to access your Intranet from the Internet using P2P](https://voonze.com/omniedge-to-access-your-intranet-from-the-internet-using-p2p/)
236 | - [wwwhatsnew: OMNIEDGE, PARA ACCEDER A TU INTRANET DESDE INTERNET USANDO P2P](https://wwwhatsnew.com/2022/03/03/omniedge-para-acceder-a-tu-intranet-desde-internet-usando-p2p/)
237 | - [l'Entrepreneur: OmniEdge, pour accéder à votre Intranet depuis Internet en P2P](https://lentrepreneur.co/style/technologie/omniedge-pour-acceder-a-votre-intranet-depuis-internet-en-p2p-04032022)
238 | - [RunaCapital: Awesome OSS alternatives](https://github.com/RunaCapital/awesome-oss-alternatives)
239 | - [OmniEdge in ntopconf 2022](https://www.ntop.org/ntopconf2022/)
240 |
241 | ## Advisor
242 |
243 | [lucaderi](https://github.com/lucaderi)
244 |
245 |
246 | ## Contributors
247 |
248 | [harri8807](https://github.com/orgs/omniedgeio/people/harri8807) , [Tex-Tang](https://github.com/Tex-Tang), [ivyxjc](https://github.com/orgs/omniedgeio/people/ivyxjc), [kidylee](https://github.com/kidylee), [EbenDang](https://github.com/orgs/omniedgeio/people/EbenDang)
249 | ,[zteshadow](https://github.com/zteshadow), [ChenYouping](https://github.com/orgs/omniedgeio/people/ChenYouping),[ddrandy](https://github.com/orgs/omniedgeio/people/ddrandy), **Tsingv**, [mtx2d](https://github.com/mtx2d),[Blackrose](https://github.com/Blackrose), [cheung-chifung](https://github.com/cheung-chifung),[我不是矿神](https://imnks.com/5768.html)
250 |
251 | > sentiti libero di parlarci di qualsiasi post relativo a noi tramite problema o PR.
252 |
253 | ----
254 |
255 | Se hai altre domande, sentiti libero di parlare con noi su [Discussions](https://github.com/omniedgeio/omniedge/discussions).
--------------------------------------------------------------------------------
/README/README-JP.md:
--------------------------------------------------------------------------------
1 |
2 | 
3 |
4 |
36 |
37 | [【English】](../README.md) [【繁体中文】](README-zh-Hant.md) [【简体中文】](README-zh-Hans.md) [【日本语】](README-JP.md) [【Español】](README-ES.md) [【Italiano】](README-IT.md) [【한국어】](README-KR.md)
38 | [【العربي】](README-AR.md) [【Tiếng Việt】](README-VN.md) [【แบบไทย】](README-TH.md)
39 |
40 | OmniEdgeは、従来のVPNの代替手段である[n2n](https://github.com/ntop/n2n)プロトコルに基づくオープンソースのp2pレイヤー2VPNインフラストラクチャです。 中央サーバーがなく、メンテナンスが少なくて簡単に拡張できます。 イントラネットで何が起こるかは、イントラネットにとどまります。
41 |
42 | 
43 |
44 | ## 主な機能:
45 |
46 | ||||
47 | | ---- | ---- | ---- |
48 | |ダッシュボード管理|メッシュVPN|MacOS(メニューバー)およびWindows(システムトレイ)用のデスクトップGUIアプリ|
49 | |マルチ仮想ネットワーク|サイト間VPN|Linux、FreeBSD、Raspbian、MacOS用のコマンドラインCLIアプリ|
50 | |マルチユーザー|無制限のデータ転送|armv7、arm64、RISC-V64、x86_64およびamd64用のコマンドラインCLIアプリ|
51 | |マルチデバイス|暗号化されたピアツーピア接続|iOSおよびAndroid用のモバイルアプリ|
52 | |セルフホストスーパーノード|暗号化接続リレー|iPad、Androidタブレット、AndroidTV用のタブレットアプリ|
53 | |仮想ネットワークの共有|ハイブリッドクラウドのサポート|Synology用のNASアプリ|
54 | |セキュリティキー| Zero-Config|自動パブリックスーパーノード割り当て|
55 | | [リモートデバイス制御](https://omniedge.io/docs/article/Cases/VNC)| [ファイルをリモートでドロップ](https://omniedge.io/docs/article/Cases/landrop)|自動IP割り当て |
56 |
57 |
58 | その他の機能については、エンタープライズ向けの[価格設定](https://omniedge.io/pricing)ページをご覧ください。
59 |
60 | ## 5分で始めましょう
61 |
62 | 1. アカウントにサインアップします:[サインアップ](https://omniedge.io/register)
63 | 2. [ダウンロード](https://omniedge.io/download)プラットフォーム用のOmniEdgeアプリ
64 | 3. または、cliバージョンを使用する場合は、次のコマンドを実行します。
65 | `` `bash
66 | curl https://omniedge.io/install/omniedge-install.sh | bash
67 | `` `
68 | 4. メールアドレスとパスワードでログインし、仮想ネットワークを選択して接続します。
69 |
70 | 準備万端です!
71 |
72 | また、**セキュリティキー**でログインする場合、またはデバイスを管理する場合は、[ドキュメント](https://omniedge.io/docs)にアクセスして詳細を確認してください。
73 |
74 |
75 | ## コンパイル
76 |
77 | ### OmniEdge Cli
78 |
79 | 1. 環境:Golang 1.16.6
80 | 2. コンパイル:
81 |
82 | - 2.1. Ubuntu /linux
83 |
84 | ```bash
85 | sudo apt-get -y update
86 | sudo apt-get install -y openssl build-essential libssl-dev zip autoconf
87 | git clone git clone https://github.com/omniedgeio/omniedge-cli
88 | cd omniedge-cli
89 | go mod download
90 | go generate
91 | BUILD_ENV=prod make build
92 | ```
93 |
94 | - 2.2. macOS
95 |
96 | ```bash
97 | brew install autoconf automake libtool
98 | git clone https://github.com/omniedgeio/omniedge-cli
99 | cd omniedge-cli
100 | go mod download
101 | go generate
102 | BUILD_ENV=prod make build-darwin
103 | ```
104 |
105 | - 2.3. freebsd
106 |
107 | ```bash
108 | #freebsd
109 | su
110 | pkg update && pkg install go gmake git openssl zip autoconf automake libtool
111 | https://github.com/omniedgeio/omniedge-cli
112 | cd omniedge-cli
113 | go mod download
114 | go generate
115 | BUILD_ENV=prod make build-freebsd
116 | ```
117 |
118 | 3. クロスコンパイル
119 |
120 | - 3.1 RISC-V
121 |
122 | ホストOS: Ubuntu 20.04
123 |
124 | ```bash
125 | apt-get update
126 | apt-get install -y openssl autoconf build-essential libssl-dev zip wget g++-riscv64-linux-gnu gcc-riscv64-linux-gnu
127 |
128 | wget https://go.dev/dl/go1.18.4.linux-amd64.tar.gz
129 | rm -rf /usr/local/go && tar -C /usr/local -xzf go1.18.4.linux-amd64.tar.gz
130 | export PATH=$PATH:/usr/local/go/bin
131 | go version
132 | export GOOS=linux
133 | export GOARCH=riscv64
134 | export CGO_ENABLED=1
135 | export CC=riscv64-linux-gnu-gcc
136 | git clone https://github.com/omniedgeio/omniedge-cli.git
137 | cd omniedge-cli
138 | go mod download
139 | go generate
140 | BUILD_ENV=prod make build-riscv64
141 | ```
142 |
143 | コンパイルされたomniedge-cliは**/out/**にあります
144 |
145 |
146 | ### OmniEdge Android
147 |
148 | 1. Android Studioをダウンロードします:https://developer.android.com/studio
149 | 2. リポジトリを取得してコンパイルします
150 |
151 | ```bash
152 | git clone https://github.com/omniedgeio/omniedge-android.git`
153 | ./gradlew test --stacktrace
154 | ./gradlew assembleDebug --stacktrace
155 | ```
156 |
157 | また、GithubとGitlabのCIを自動的にビルドするために準備しました。
158 |
159 | - Github: https://github.com/omniedgeio/omniedge-android/blob/main/.github/workflows/build.yml
160 | - GitLab: https://github.com/omniedgeio/omniedge-android/blob/main/.gitlab-ci.yml
161 |
162 |
163 | ### OmniEdge iOS
164 |
165 | 1. Xcodeをダウンロードしてインストールします
166 | 2. リポジトリを取得してコンパイルします
167 |
168 | ```bash
169 | git clone https://github.com/omniedgeio/omniedge-iOS.git
170 | cd omniedge-iOS
171 | open OmniEdgeNew/OmniEdgeNew.xcworkspace
172 | ```
173 |
174 | Xcodeが自動的に開きます。コンパイルを開始するには、開発者アカウントを設定する必要があります。 パッケージ、特に**Tunnel**パッケージをデバイスで個別にコンパイルすることをお勧めします。
175 |
176 |
177 |
178 | ### OmniEdge-macOS
179 |
180 | 1. Xcodeをダウンロードしてインストールします
181 | 2. リポジトリを取得してコンパイルします
182 |
183 | ```bash
184 | git clone https://github.com/omniedgeio/omniedge-macOS.git
185 | cd omniedge-macOS
186 | open Omniedge.xcodeproj
187 | ```
188 |
189 | Xcodeが自動的に開きます。コンパイルを開始するには、開発者アカウントを設定する必要があります。
190 |
191 | ### OmniEdge-windows
192 |
193 | 1. QTをダウンロードしてインストールします
194 | 2. リポジトリを取得してコンパイルします
195 |
196 | ```bash
197 | git clone https://github.com/omniedgeio/omniedge-windows.git
198 | cd omniedge-windows
199 | ```
200 |
201 | **OmniEdge.pro**を開き、コンパイルを開始します。
202 |
203 | ## 使用法
204 |
205 | - [Virtual Network, Devices, Security Key, and Settings](https://omniedge.io/docs/article/admin)
206 | - [Windows 7,10,11 for Intel or Arm](https://omniedge.io/docs/article/install/windows)
207 | - [Android](https://omniedge.io/docs/article/install/android)
208 | - [Linux Cli for raspberry Pi, Nvidia Jeston,and more](https://omniedge.io/docs/article/install/cli)
209 | - [MacOS Cli](https://omniedge.io/docs/article/install/macoscli)
210 | - [Synology](https://omniedge.io/docs/article/install/synology)
211 | - [Docker](https://omniedge.io/docs/article/install/docker)
212 | - [Github Action](https://omniedge.io/docs/article/install/github-action)
213 | - [iOS](https://omniedge.io/docs/article/install/ios)
214 | - [Setup custom supernode](https://omniedge.io/docs/article/install/customize-supernode)
215 |
216 | ## ユースケース
217 |
218 | >他の人と共有できるように、ユースケースを教えてください
219 |
220 | - [Remote connect windows without exposing public IP with Omniedge](https://omniedge.io/docs/article/Cases/RDP)
221 | - [Display and control macOS, Linux and Windows ](https://omniedge.io/docs/article/Cases/VNC)
222 | - [Keep connection with your AI based Project on Jetson](https://omniedge.io/docs/article/Cases/jetson)
223 | - [Display and control your Android device with Omniedge from anywhere on MacOS, Windows and Linux](https://omniedge.io/docs/article/Cases/android-remote)
224 | - [Talk to your family and share photos in a LAN on the internet](https://omniedge.io/docs/article/Cases/lan-messenger)
225 | - [Air Drop Any Files between MacOS, Windows, Routers, Linux and Android with Omniedge from anywhere](https://omniedge.io/docs/article/Cases/landrop)
226 |
227 | ## 比較
228 |
229 | - [VPN vs. OmniEdge](https://omniedge.io/docs/article/compare/vpn-vs-omniedge)
230 | - [Express VPN vs. OmniEdge](https://omniedge.io/docs/article/compare/expressvpn-vs-omniedge)
231 | - [frp/ngrok vs. OmniEdge](https://omniedge.io/docs/article/compare/frp-ngrok-vs-omniedge)
232 | - [ZeroTier vs. OmniEdge](https://omniedge.io/docs/article/compare/zerotier-vs-omniedge)
233 | - [n2n vs. OmniEdge](https://omniedge.io/docs/article/compare/n2n-vs-omniedge)
234 |
235 |
236 | ## Media
237 |
238 | - [Founded by a Single Tweet Startup OmniEdge’s effort to let connect without concern](https://threat.technology/founded-by-a-single-tweet-startup-omniedges-effort-to-let-connect-without-concern/)
239 | - [voonze: OmniEdge, to access your Intranet from the Internet using P2P](https://voonze.com/omniedge-to-access-your-intranet-from-the-internet-using-p2p/)
240 | - [wwwhatsnew: OMNIEDGE, PARA ACCEDER A TU INTRANET DESDE INTERNET USANDO P2P](https://wwwhatsnew.com/2022/03/03/omniedge-para-acceder-a-tu-intranet-desde-internet-usando-p2p/)
241 | - [l'Entrepreneur: OmniEdge, pour accéder à votre Intranet depuis Internet en P2P](https://lentrepreneur.co/style/technologie/omniedge-pour-acceder-a-votre-intranet-depuis-internet-en-p2p-04032022)
242 | - [RunaCapital: Awesome OSS alternatives](https://github.com/RunaCapital/awesome-oss-alternatives)
243 | - [OmniEdge in ntopconf 2022](https://www.ntop.org/ntopconf2022/)
244 |
245 | >問題またはPRを介して私たちに関連する投稿についてお気軽にお知らせください。
246 |
247 | ## Advisor
248 |
249 | [lucaderi](https://github.com/lucaderi)
250 |
251 | ## Contributors
252 |
253 | [harri8807](https://github.com/orgs/omniedgeio/people/harri8807) , [Tex-Tang](https://github.com/Tex-Tang), [ivyxjc](https://github.com/orgs/omniedgeio/people/ivyxjc), [kidylee](https://github.com/kidylee), [EbenDang](https://github.com/orgs/omniedgeio/people/EbenDang)
254 | ,[zteshadow](https://github.com/zteshadow), [ChenYouping](https://github.com/orgs/omniedgeio/people/ChenYouping),[ddrandy](https://github.com/orgs/omniedgeio/people/ddrandy), **Tsingv**, [mtx2d](https://github.com/mtx2d),[Blackrose](https://github.com/Blackrose), [cheung-chifung](https://github.com/cheung-chifung),[我不是矿神](https://imnks.com/5768.html)
255 |
256 | ----
257 |
258 | ご不明な点がございましたら、[Discord](https://discord.gg/d4faRPYj)までお気軽にお問い合わせください。
259 |
--------------------------------------------------------------------------------
/README/README-KR.md:
--------------------------------------------------------------------------------
1 |
2 | 
3 |
4 |
36 |
37 | [【English】](../README.md) [【繁体中文】](README-zh-Hant.md) [【简体中文】](README-zh-Hans.md) [【日本语】](README-JP.md) [【Español】](README-ES.md) [【Italiano】](README-IT.md) [【한국어】](README-KR.md)
38 | [【العربي】](README-AR.md) [【Tiếng Việt】](README-VN.md) [【แบบไทย】](README-TH.md)
39 |
40 | OmniEdge는 기존 VPN의 대안인 [n2n](https://github.com/ntop/n2n) 프로토콜을 기반으로 하는 오픈 소스 p2p 레이어 2VPN 인프라입니다. 중앙 서버가 없고 유지 보수가 적고 쉽게 확장할 수 있습니다. 인트라넷에서 일어나는 일은 인트라넷에 남아 있습니다.
41 |
42 | 
43 |
44 | ## 주요 특징들:
45 |
46 | ||||
47 | |----|----|----|
48 | |대시보드 관리 관리|메시 VPN|MacOS(메뉴 모음) 및 Windows(시스템 트레이)용 데스크탑 GUI 앱|
49 | |다중 가상 네트워크|사이트 간 VPN|Linux, FreeBSD, Raspbian 및 MacOS용 명령줄 cli 앱|
50 | |다중 사용자|무제한 데이터 전송|armv7,arm64,RISC-V64,x86_64 및 amd64용 명령줄 cli 앱|
51 | |다중 장치|암호화된 P2P 연결|iOS 및 Android용 모바일 앱|
52 | |자체 호스팅 슈퍼노드 |암호화된 연결 릴레이|iPad, Android 태블릿 및 Android TV용 태블릿 앱|
53 | |가상 네트워크 공유|하이브리드 클라우드 지원|Synology용 NAS 앱|
54 | |보안 키| Zero-Config|자동 공개 슈퍼노드 할당|
55 | |[Remote Device Control](https://omniedge.io/docs/article/Cases/VNC)|[Drop Files remote](https://omniedge.io/docs/article/Cases/landdrop) |자동 IP 할당 |
56 |
57 |
58 | 기업용 [가격](https://omniedge.io/pricing) 페이지에서 더 많은 기능을 찾을 수 있습니다.
59 |
60 | ## 5분으로 시작하자
61 |
62 | 1. 계정에 가입합니다. 가입(https://omniedge.io/register)
63 | 2. [다운로드](https://omniedge.io/download) 플랫폼용 OmniEdge 앱
64 | 3. 또는 cli 버전을 사용하는 경우 다음 명령을 실행합니다.
65 | ```bash
66 | curl https://omniedge.io/install/omniedge-install.sh | bash
67 | ``
68 | 4. 이메일 주소와 암호로 로그인하고 가상 네트워크를 선택하여 연결합니다.
69 |
70 | 준비 만단입니다!
71 |
72 | 또한 **보안 키**로 로그인하거나 기기를 관리하려면 문서(https://omniedge.io/docs)로 이동하여 자세한 내용을 확인하세요.
73 |
74 |
75 | ## 컴파일
76 |
77 | ### OmniEdge Cli
78 |
79 | 1. 환경: Golang 1.16.6
80 | 2. 컴파일:
81 |
82 | - 2.1. Ubuntu /linux
83 |
84 | ```bash
85 | sudo apt-get -y update
86 | sudo apt-get install -y openssl build-essential libssl-dev zip autoconf
87 | git clone git clone https://github.com/omniedgeio/omniedge-cli
88 | cd omniedge-cli
89 | go mod download
90 | go generate
91 | BUILD_ENV=prod make build
92 | ```
93 |
94 | - 2.2. macOS
95 |
96 | ```bash
97 | brew install autoconf automake libtool
98 | git clone https://github.com/omniedgeio/omniedge-cli
99 | cd omniedge-cli
100 | go mod download
101 | go generate
102 | BUILD_ENV=prod make build-darwin
103 | ```
104 |
105 | - 2.3. freebsd
106 |
107 | ```bash
108 | #freebsd
109 | su
110 | pkg update && pkg install go gmake git openssl zip autoconf automake libtool
111 | https://github.com/omniedgeio/omniedge-cli
112 | cd omniedge-cli
113 | go mod download
114 | go generate
115 | BUILD_ENV=prod make build-freebsd
116 | ```
117 |
118 | 3. 크로스 컴파일
119 |
120 | - 3.1 RISC-V
121 |
122 | 호스트 OS: Ubuntu 20.04
123 |
124 | ```bash
125 | apt-get update
126 | apt-get install -y openssl autoconf build-essential libssl-dev zip wget g++-riscv64-linux-gnu gcc-riscv64-linux-gnu
127 |
128 | wget https://go.dev/dl/go1.18.4.linux-amd64.tar.gz
129 | rm -rf /usr/local/go && tar -C /usr/local -xzf go1.18.4.linux-amd64.tar.gz
130 | export PATH=$PATH:/usr/local/go/bin
131 | go version
132 | export GOOS=linux
133 | export GOARCH=riscv64
134 | export CGO_ENABLED=1
135 | export CC=riscv64-linux-gnu-gcc
136 | git clone https://github.com/omniedgeio/omniedge-cli.git
137 | cd omniedge-cli
138 | go mod download
139 | go generate
140 | BUILD_ENV=prod make build-riscv64
141 | ```
142 |
143 | 컴파일된 omniedge-cli는 **/out/**에 있습니다.
144 |
145 |
146 | ### OmniEdge Android
147 |
148 | 1. Android Studio 다운로드: https://developer.android.com/studio
149 | 2. 리포지토리를 검색하고 컴파일합니다.
150 |
151 | ```bash
152 | git clone https://github.com/omniedgeio/omniedge-android.git`
153 | ./gradlew test --stacktrace
154 | ./gradlew assembleDebug --stacktrace
155 | ```
156 |
157 | 또한 Github과 Gitlab의 CI를 자동으로 빌드하기 위해 준비했습니다.
158 |
159 | - Github: https://github.com/omniedgeio/omniedge-android/blob/main/.github/workflows/build.yml
160 | - GitLab: https://github.com/omniedgeio/omniedge-android/blob/main/.gitlab-ci.yml
161 |
162 |
163 | ### OmniEdge iOS
164 |
165 | 1. Xcode를 다운로드하여 설치합니다.
166 | 2. 리포지토리를 검색하고 컴파일합니다.
167 |
168 | ```bash
169 | git clone https://github.com/omniedgeio/omniedge-iOS.git
170 | cd omniedge-iOS
171 | open OmniEdgeNew/OmniEdgeNew.xcworkspace
172 | ```
173 |
174 | Xcode가 자동으로 열립니다. 컴파일을 시작하려면 개발자 계정을 설정해야 합니다. 패키지, 특히 **Tunnel** 패키지를 기기에서 개별적으로 컴파일하는 것이 좋습니다.
175 |
176 |
177 |
178 | ### OmniEdge-macOS
179 |
180 | 1. Xcode를 다운로드하여 설치합니다.
181 | 2. 리포지토리를 검색하고 컴파일합니다.
182 |
183 | ```bash
184 | git clone https://github.com/omniedgeio/omniedge-macOS.git
185 | cd omniedge-macOS
186 | open Omniedge.xcodeproj
187 | ```
188 |
189 | Xcode가 자동으로 열립니다. 컴파일을 시작하려면 개발자 계정을 설정해야 합니다.
190 |
191 | ### OmniEdge-windows
192 |
193 | 1. QT를 다운로드하여 설치합니다.
194 | 2. 리포지토리를 검색하고 컴파일합니다.
195 |
196 | ```bash
197 | git clone https://github.com/omniedgeio/omniedge-windows.git
198 | cd omniedge-windows
199 | ```
200 |
201 | **OmniEdge.pro**를 열고 컴파일을 시작합니다.
202 |
203 | ## 사용법
204 |
205 | - [Virtual Network, Devices, Security Key, and Settings](https://omniedge.io/docs/article/admin)
206 | - [Windows 7,10,11 for Intel or Arm](https://omniedge.io/docs/article/install/windows)
207 | - [Android](https://omniedge.io/docs/article/install/android)
208 | - [Linux Cli for raspberry Pi, Nvidia Jeston,and more](https://omniedge.io/docs/article/install/cli)
209 | - [MacOS Cli](https://omniedge.io/docs/article/install/macoscli)
210 | - [Synology](https://omniedge.io/docs/article/install/synology)
211 | - [Docker](https://omniedge.io/docs/article/install/docker)
212 | - [Github Action](https://omniedge.io/docs/article/install/github-action)
213 | - [iOS](https://omniedge.io/docs/article/install/ios)
214 | - [Setup custom supernode](https://omniedge.io/docs/article/install/customize-supernode)
215 |
216 | ## 유스 케이스
217 |
218 | > 다른 사람들과 공유 할 수 있도록 유스 케이스를 알려주세요.
219 |
220 | - [Remote connect windows without exposing public IP with Omniedge](https://omniedge.io/docs/article/Cases/RDP)
221 | - [Display and control macOS, Linux and Windows ](https://omniedge.io/docs/article/Cases/VNC)
222 | - [Keep connection with your AI based Project on Jetson](https://omniedge.io/docs/article/Cases/jetson)
223 | - [Display and control your Android device with Omniedge from anywhere on MacOS, Windows and Linux](https://omniedge.io/docs/article/Cases/android-remote)
224 | - [Talk to your family and share photos in a LAN on the internet](https://omniedge.io/docs/article/Cases/lan-messenger)
225 | - [Air Drop Any Files between MacOS, Windows, Routers, Linux and Android with Omniedge from anywhere](https://omniedge.io/docs/article/Cases/landrop)
226 |
227 | ## 비교
228 |
229 | - [VPN vs. OmniEdge](https://omniedge.io/docs/article/compare/vpn-vs-omniedge)
230 | - [Express VPN vs. OmniEdge](https://omniedge.io/docs/article/compare/expressvpn-vs-omniedge)
231 | - [frp/ngrok vs. OmniEdge](https://omniedge.io/docs/article/compare/frp-ngrok-vs-omniedge)
232 | - [ZeroTier vs. OmniEdge](https://omniedge.io/docs/article/compare/zerotier-vs-omniedge)
233 | - [n2n vs. OmniEdge](https://omniedge.io/docs/article/compare/n2n-vs-omniedge)
234 |
235 |
236 | ## 누가 우리에 대해 이야기하는지
237 |
238 | - [Founded by a Single Tweet Startup OmniEdge’s effort to let connect without concern](https://threat.technology/founded-by-a-single-tweet-startup-omniedges-effort-to-let-connect-without-concern/)
239 | - [voonze: OmniEdge, to access your Intranet from the Internet using P2P](https://voonze.com/omniedge-to-access-your-intranet-from-the-internet-using-p2p/)
240 | - [wwwhatsnew: OMNIEDGE, PARA ACCEDER A TU INTRANET DESDE INTERNET USANDO P2P](https://wwwhatsnew.com/2022/03/03/omniedge-para-acceder-a-tu-intranet-desde-internet-usando-p2p/)
241 | - [l'Entrepreneur: OmniEdge, pour accéder à votre Intranet depuis Internet en P2P](https://lentrepreneur.co/style/technologie/omniedge-pour-acceder-a-votre-intranet-depuis-internet-en-p2p-04032022)
242 | - [RunaCapital: Awesome OSS alternatives](https://github.com/RunaCapital/awesome-oss-alternatives)
243 | - [OmniEdge in ntopconf 2022](https://www.ntop.org/ntopconf2022/)
244 |
245 | > 문제 또는 PR을 통해 Google과 관련된 게시물에 대해 언제든지 알려주십시오.
246 |
247 | ## Advisor
248 |
249 | [lucaderi](https://github.com/lucaderi)
250 |
251 |
252 |
253 | ## Contributors
254 |
255 | [harri8807](https://github.com/orgs/omniedgeio/people/harri8807) , [Tex-Tang](https://github.com/Tex-Tang), [ivyxjc](https://github.com/orgs/omniedgeio/people/ivyxjc), [kidylee](https://github.com/kidylee), [EbenDang](https://github.com/orgs/omniedgeio/people/EbenDang)
256 | ,[zteshadow](https://github.com/zteshadow), [ChenYouping](https://github.com/orgs/omniedgeio/people/ChenYouping),[ddrandy](https://github.com/orgs/omniedgeio/people/ddrandy), **Tsingv**, [mtx2d](https://github.com/mtx2d),[Blackrose](https://github.com/Blackrose), [cheung-chifung](https://github.com/cheung-chifung),[我不是矿神](https://imnks.com/5768.html)
257 |
258 |
259 | ----
260 |
261 | 궁금한 점이 있으시면 [Discussions](https://github.com/omniedgeio/omniedge/discussions)로 문의해 주십시오.
--------------------------------------------------------------------------------
/README/README-TH.md:
--------------------------------------------------------------------------------
1 |
2 | 
3 |
4 |
36 |
37 | [【English】](../README.md) [【繁体中文】](README-zh-Hant.md) [【简体中文】](README-zh-Hans.md) [【日本语】](README-JP.md) [【Español】](README-ES.md) [【Italiano】](README-IT.md) [【한국어】](README-KR.md)
38 | [【العربي】](README-AR.md) [【Tiếng Việt】](README-VN.md) [【แบบไทย】](README-TH.md)
39 |
40 | OmniEdge เป็นโครงสร้างพื้นฐาน VPN แบบโอเพ่นซอร์ส p2p เลเยอร์ 2 ที่ใช้โปรโตคอล [n2n](https://github.com/ntop/n2n) ซึ่งเป็นทางเลือก VPN แบบดั้งเดิม ไม่มีเซิร์ฟเวอร์กลาง ปรับขนาดได้ง่ายพร้อมการบำรุงรักษาน้อย เกิดอะไรขึ้นในอินทราเน็ต อยู่ในอินทราเน็ต
41 |
42 | 
43 |
44 | ## ฟีเจอร์หลัก:
45 |
46 | ||||
47 | |----|----|----|
48 | |การจัดการการดูแลแดชบอร์ด| VPN แบบตาข่าย|แอป GUI บนเดสก์ท็อปสำหรับ MacOS (แถบเมนู) และ Windows (ซิสเต็มเทรย์)|
49 | |เครือข่ายเสมือนหลายเครือข่าย|Site-to-Site VPNs|แอปบรรทัดคำสั่ง cli สำหรับ Linux, FreeBSD, Raspbian และ MacOS|
50 | |ผู้ใช้หลายคน|การถ่ายโอนข้อมูลไม่จำกัด|แอปบรรทัดคำสั่ง cli สำหรับ armv7,arm64,RISC-V64,x86_64 และ amd64|
51 | |อุปกรณ์หลายเครื่อง|การเชื่อมต่อเพียร์ทูเพียร์ที่เข้ารหัส|แอปมือถือสำหรับ iOS และ Android|
52 | |Supernode ที่โฮสต์เอง |รีเลย์การเชื่อมต่อที่เข้ารหัส|แอปแท็บเล็ตสำหรับ iPad, แท็บเล็ต Android และ Android TV|
53 | |การแชร์เครือข่ายเสมือน|รองรับระบบไฮบริดคลาวด์|แอป NAS สำหรับ Synology|
54 | |กุญแจนิรภัย| Zero-Config|การจัดสรร supernode สาธารณะอัตโนมัติ|
55 | |[การควบคุมอุปกรณ์ระยะไกล](https://omniedge.io/docs/article/Cases/VNC)|[วางไฟล์จากระยะไกล](https://omniedge.io/docs/article/Cases/landrop) |การจัดสรร IP อัตโนมัติ |
56 |
57 |
58 | คุณสามารถค้นหาคุณสมบัติเพิ่มเติมได้ในหน้า [การกำหนดราคา](https://omniedge.io/pricing) สำหรับองค์กร
59 |
60 | ## เริ่มต้นใน 5 นาที
61 |
62 | 1. ลงทะเบียนบัญชีของคุณ: [สมัคร](https://omniedge.io/register)
63 | 2. [ดาวน์โหลด](https://omniedge.io/download) แอป OmniEdge สำหรับแพลตฟอร์มของคุณ
64 | 3. หรือเรียกใช้คำสั่งต่อไปนี้หากคุณต้องการใช้เวอร์ชัน cli:
65 | ``` ทุบตี
66 | curl https://omniedge.io/install/omniedge-install.sh | ทุบตี
67 | ```
68 | 4. เข้าสู่ระบบด้วยอีเมลและรหัสผ่าน เลือกเครือข่ายไวรัส เชื่อมต่อ!
69 |
70 | คุณพร้อมแล้ว!
71 |
72 | และหากคุณต้องการเข้าสู่ระบบด้วย **คีย์ความปลอดภัย** หรือจัดการอุปกรณ์ของคุณ ให้ไปที่ [เอกสารประกอบ](https://omniedge.io/docs) เพื่อดูข้อมูลเพิ่มเติม
73 |
74 | ## รวบรวม
75 |
76 | ### OmniEdge Cli
77 |
78 | 1. สิ่งแวดล้อม: Golang 1.16.6
79 | 2. รวบรวม:
80 |
81 | - 2.1. Ubuntu /linux
82 |
83 | ```bash
84 | sudo apt-get -y update
85 | sudo apt-get install -y openssl build-essential libssl-dev zip autoconf
86 | git clone https://github.com/omniedgeio/omniedge-cli
87 | cd omniedge-cli
88 | go mod download
89 | go generate
90 | BUILD_ENV=prod make build
91 | ```
92 |
93 | - 2.2. macOS
94 |
95 | ```bash
96 | brew install autoconf automake libtool
97 | git clone https://github.com/omniedgeio/omniedge-cli
98 | cd omniedge-cli
99 | go mod download
100 | go generate
101 | BUILD_ENV=prod make build-darwin
102 | ```
103 |
104 | - 2.3. freebsd
105 |
106 | ```bash
107 | su
108 | pkg update && pkg install go gmake git openssl zip autoconf automake libtool
109 | git clone https://github.com/omniedgeio/omniedge-cli
110 | cd omniedge-cli
111 | go mod download
112 | go generate
113 | BUILD_ENV=prod make build-freebsd
114 | ```
115 |
116 | 3. ข้ามคอมไพล์
117 |
118 | - 3.1 RISC-V
119 |
120 | โฮสต์ระบบปฏิบัติการ: Ubuntu 20.04
121 |
122 | ```bash
123 | apt-get update
124 | apt-get install -y openssl autoconf build-essential libssl-dev zip wget g++-riscv64-linux-gnu gcc-riscv64-linux-gnu
125 |
126 | wget https://go.dev/dl/go1.18.4.linux-amd64.tar.gz
127 | rm -rf /usr/local/go && tar -C /usr/local -xzf go1.18.4.linux-amd64.tar.gz
128 | export PATH=$PATH:/usr/local/go/bin
129 | go version
130 | export GOOS=linux
131 | export GOARCH=riscv64
132 | export CGO_ENABLED=1
133 | export CC=riscv64-linux-gnu-gcc
134 | git clone https://github.com/omniedgeio/omniedge-cli.git
135 | cd omniedge-cli
136 | go mod download
137 | go generate
138 | BUILD_ENV=prod make build-riscv64
139 | ```
140 |
141 | omniedge-cli ที่คอมไพล์แล้วจะอยู่ใน **/out/**
142 |
143 | ### OmniEdge Android
144 |
145 | 1. ดาวน์โหลด Android Studio: https://developer.android.com/studio
146 | 2. รับ repo และคอมไพล์
147 |
148 | ```bash
149 | git clone https://github.com/omniedgeio/omniedge-android.git`
150 | ./gradlew test --stacktrace
151 | ./gradlew assembleDebug --stacktrace
152 | ```
153 |
154 | เราได้เตรียม CI สำหรับ Github และ Gitlab สำหรับการสร้างโดยอัตโนมัติ
155 |
156 | 1. Github: https://github.com/omniedgeio/omniedge-android/blob/main/.github/workflows/build.yml
157 | 2. GitLab: https://github.com/omniedgeio/omniedge-android/blob/main/.gitlab-ci.yml
158 |
159 |
160 | ### OmniEdge iOS
161 |
162 | 1. ดาวน์โหลดและติดตั้ง Xcode
163 | 2. รับ repo และคอมไพล์
164 |
165 | ```bash
166 | git clone https://github.com/omniedgeio/omniedge-iOS.git
167 | cd omniedge-iOS
168 | open OmniEdgeNew/OmniEdgeNew.xcworkspace
169 | ```
170 |
171 | Xcode จะเปิดขึ้นโดยอัตโนมัติ คุณต้องตั้งค่าบัญชีนักพัฒนาเพื่อเริ่มคอมไพล์ เราแนะนำให้รวบรวมแพ็คเกจบนอุปกรณ์ของคุณแยกกัน โดยเฉพาะแพ็คเกจ **Tunnel**
172 |
173 |
174 |
175 | ### OmniEdge-macOS
176 |
177 | 1. ดาวน์โหลดและติดตั้ง Xcode
178 | 2. รับ repo และคอมไพล์
179 |
180 | ```bash
181 | git clone https://github.com/omniedgeio/omniedge-macOS.git
182 | cd omniedge-macOS
183 | open Omniedge.xcodeproj
184 | ```
185 |
186 | Xcode จะเปิดขึ้นโดยอัตโนมัติ คุณต้องตั้งค่าบัญชีนักพัฒนาเพื่อเริ่มคอมไพล์
187 |
188 | ### OmniEdge-windows
189 |
190 | 1. ดาวน์โหลดและติดตั้ง QT
191 | 2. รับ repo และคอมไพล์
192 |
193 | ```bash
194 | git clone https://github.com/omniedgeio/omniedge-windows.git
195 | cd omniedge-windows
196 | ```
197 |
198 | เปิด **OmniEdge.pro** และเริ่มคอมไพล์
199 |
200 |
201 | ## การใช้งาน
202 |
203 | - [Virtual Network, Devices, Security Key, and Settings](https://omniedge.io/docs/article/admin)
204 | - [Windows 7,10,11 for Intel or Arm](https://omniedge.io/docs/article/install/windows)
205 | - [Android](https://omniedge.io/docs/article/install/android)
206 | - [Linux Cli for raspberry Pi, Nvidia Jeston,and more](https://omniedge.io/docs/article/install/cli)
207 | - [MacOS Cli](https://omniedge.io/docs/article/install/macoscli)
208 | - [Synology](https://omniedge.io/docs/article/install/synology)
209 | - [Docker](https://omniedge.io/docs/article/install/docker)
210 | - [Github Action](https://omniedge.io/docs/article/install/github-action)
211 | - [iOS](https://omniedge.io/docs/article/install/ios)
212 | - [Setup custom supernode](https://omniedge.io/docs/article/install/customize-supernode)
213 |
214 | ## กรณีการใช้งาน
215 |
216 | > บอกกรณีการใช้งานของคุณให้เราทราบ เพื่อที่เราจะสามารถแบ่งปันให้ผู้อื่นได้
217 |
218 | - [Remote connect windows without exposing public IP with Omniedge](https://omniedge.io/docs/article/Cases/RDP)
219 | - [Display and control macOS, Linux and Windows ](https://omniedge.io/docs/article/Cases/VNC)
220 | - [Keep connection with your AI based Project on Jetson](https://omniedge.io/docs/article/Cases/jetson)
221 | - [Display and control your Android device with Omniedge from anywhere on MacOS, Windows and Linux](https://omniedge.io/docs/article/Cases/android-remote)
222 | - [Talk to your family and share photos in a LAN on the internet](https://omniedge.io/docs/article/Cases/lan-messenger)
223 | - [Air Drop Any Files between MacOS, Windows, Routers, Linux and Android with Omniedge from anywhere](https://omniedge.io/docs/article/Cases/landrop)
224 |
225 | ## เปรียบเทียบ
226 |
227 | - [VPN vs. OmniEdge](https://omniedge.io/docs/article/compare/vpn-vs-omniedge)
228 | - [Express VPN vs. OmniEdge](https://omniedge.io/docs/article/compare/expressvpn-vs-omniedge)
229 | - [frp/ngrok vs. OmniEdge](https://omniedge.io/docs/article/compare/frp-ngrok-vs-omniedge)
230 | - [ZeroTier vs. OmniEdge](https://omniedge.io/docs/article/compare/zerotier-vs-omniedge)
231 | - [n2n vs. OmniEdge](https://omniedge.io/docs/article/compare/n2n-vs-omniedge)
232 |
233 | ## ใครพูดถึงเราบ้าง
234 |
235 | - [Founded by a Single Tweet Startup OmniEdge’s effort to let connect without concern](https://threat.technology/founded-by-a-single-tweet-startup-omniedges-effort-to-let-connect-without-concern/)
236 | - [voonze: OmniEdge, to access your Intranet from the Internet using P2P](https://voonze.com/omniedge-to-access-your-intranet-from-the-internet-using-p2p/)
237 | - [wwwhatsnew: OMNIEDGE, PARA ACCEDER A TU INTRANET DESDE INTERNET USANDO P2P](https://wwwhatsnew.com/2022/03/03/omniedge-para-acceder-a-tu-intranet-desde-internet-usando-p2p/)
238 | - [l'Entrepreneur: OmniEdge, pour accéder à votre Intranet depuis Internet en P2P](https://lentrepreneur.co/style/technologie/omniedge-pour-acceder-a-votre-intranet-depuis-internet-en-p2p-04032022)
239 | - [RunaCapital: Awesome OSS alternatives](https://github.com/RunaCapital/awesome-oss-alternatives)
240 | - [OmniEdge in ntopconf 2022](https://www.ntop.org/ntopconf2022/)
241 |
242 | ## Advisor
243 |
244 | [lucaderi](https://github.com/lucaderi)
245 |
246 | ## Contributors
247 |
248 | [harri8807](https://github.com/orgs/omniedgeio/people/harri8807) , [Tex-Tang](https://github.com/Tex-Tang), [ivyxjc](https://github.com/orgs/omniedgeio/people/ivyxjc), [kidylee](https://github.com/kidylee), [EbenDang](https://github.com/orgs/omniedgeio/people/EbenDang)
249 | ,[zteshadow](https://github.com/zteshadow), [ChenYouping](https://github.com/orgs/omniedgeio/people/ChenYouping),[ddrandy](https://github.com/orgs/omniedgeio/people/ddrandy), **Tsingv**, [mtx2d](https://github.com/mtx2d),[Blackrose](https://github.com/Blackrose), [cheung-chifung](https://github.com/cheung-chifung),[我不是矿神](https://imnks.com/5768.html)
250 |
251 | >อย่าลังเลที่จะบอกเราเกี่ยวกับโพสต์ใด ๆ ที่เกี่ยวข้องกับเราผ่านทางปัญหาหรือประชาสัมพันธ์
252 |
253 | ----
254 |
255 | หากมีคำถามเพิ่มเติม สามารถพูดคุยกับเราได้ที่ [Discussions](https://github.com/omniedgeio/omniedge/discussions)
256 |
--------------------------------------------------------------------------------
/README/README-VN.md:
--------------------------------------------------------------------------------
1 |
2 | 
3 |
4 |
36 |
37 | [【English】](../README.md) [【繁体中文】](README-zh-Hant.md) [【简体中文】](README-zh-Hans.md) [【日本语】](README-JP.md) [【Español】](README-ES.md) [【Italiano】](README-IT.md) [【한국어】](README-KR.md)
38 | [【العربي】](README-AR.md) [【Tiếng Việt】](README-VN.md) [【แบบไทย】](README-TH.md)
39 |
40 | OmniEdge là cơ sở hạ tầng VPN lớp 2 p2p mã nguồn mở dựa trên giao thức [n2n](https://github.com/ntop/n2n), một giải pháp thay thế VPN truyền thống. Không có máy chủ trung tâm, dễ mở rộng quy mô với ít bảo trì hơn. Điều gì xảy ra trong mạng nội bộ, vẫn ở trong mạng nội bộ.
41 |
42 | 
43 |
44 | ## Các tính năng chính:
45 |
46 | ||||
47 | | ---- | ---- | ---- |
48 | | Quản lý quản trị bảng điều khiển | Mesh VPN | Ứng dụng GUI trên máy tính để bàn cho MacOS (menubar) và Windows (systray) |
49 | | Nhiều mạng ảo | VPN Site-to-Site | Các ứng dụng cli dòng lệnh cho Linux, FreeBSD, Raspbian và MacOS |
50 | | Nhiều người dùng | Truyền dữ liệu không giới hạn | Các ứng dụng cli dòng lệnh cho armv7, arm64, RISC-V64, x86_64 và amd64 |
51 | | Nhiều thiết bị | Kết nối ngang hàng được mã hóa | Ứng dụng di động cho iOS và Android |
52 | | Supernode tự lưu trữ | Chuyển tiếp kết nối được mã hóa | Ứng dụng máy tính bảng cho iPad, Android Tablet và Android TV |
53 | | Chia sẻ mạng ảo | Hỗ trợ đám mây lai | Ứng dụng NAS cho Synology |
54 | | Khóa bảo mật | Zero-Config | Phân bổ supernode công khai tự động |
55 | | [Điều khiển thiết bị từ xa](https://omniedge.io/docs/article/Cases/VNC) | [Thả tệp từ xa](https://omniedge.io/docs/article/Cases/landrop) | Phân bổ IP tự động |
56 |
57 |
58 | Bạn có thể tìm thêm các tính năng trong Trang [Định giá] (https://omniedge.io/pricing) dành cho Doanh nghiệp.
59 |
60 | ## Bắt đầu sau 5 phút
61 |
62 | 1. Đăng ký tài khoản của bạn: [Đăng ký] (https://omniedge.io/register)
63 | 2. [Tải xuống] (https://omniedge.io/download) Ứng dụng OmniEdge cho nền tảng của bạn
64 | 3. Hoặc chạy lệnh sau nếu bạn muốn sử dụng phiên bản cli:
65 | `` bash
66 | curl https://omniedge.io/install/omniedge-install.sh | bấu víu
67 | ``
68 | 4. Đăng nhập bằng Email và mật khẩu của bạn, chọn mạng virut của bạn, kết nối!
69 |
70 | Bạn đã sẵn sàng!
71 |
72 | Và nếu bạn muốn đăng nhập bằng ** khóa bảo mật ** hoặc quản lý thiết bị của mình, hãy truy cập và kiểm tra [Documenation] (https://omniedge.io/docs) để biết thêm.
73 |
74 | ## Biên dịch
75 |
76 | ### OmniEdge Cli
77 |
78 | 1. Môi trường: Golang 1.16.6
79 | 2. Biên dịch:
80 |
81 | - 2.1. Ubuntu /linux
82 |
83 | ```bash
84 | sudo apt-get -y update
85 | sudo apt-get install -y openssl build-essential libssl-dev zip autoconf
86 | git clone https://github.com/omniedgeio/omniedge-cli
87 | cd omniedge-cli
88 | go mod download
89 | go generate
90 | BUILD_ENV=prod make build
91 | ```
92 |
93 | - 2.2. macOS
94 |
95 | ```bash
96 | brew install autoconf automake libtool
97 | git clone https://github.com/omniedgeio/omniedge-cli
98 | cd omniedge-cli
99 | go mod download
100 | go generate
101 | BUILD_ENV=prod make build-darwin
102 | ```
103 |
104 | - 2.3. freebsd
105 |
106 | ```bash
107 | su
108 | pkg update && pkg install go gmake git openssl zip autoconf automake libtool
109 | git clone https://github.com/omniedgeio/omniedge-cli
110 | cd omniedge-cli
111 | go mod download
112 | go generate
113 | BUILD_ENV=prod make build-freebsd
114 | ```
115 |
116 | 3. Biên dịch chéo
117 |
118 | - 3.1 RISC-V
119 |
120 | Máy chủ hệ điều hành: Ubuntu 20.04
121 |
122 | ```bash
123 | apt-get update
124 | apt-get install -y openssl autoconf build-essential libssl-dev zip wget g++-riscv64-linux-gnu gcc-riscv64-linux-gnu
125 |
126 | wget https://go.dev/dl/go1.18.4.linux-amd64.tar.gz
127 | rm -rf /usr/local/go && tar -C /usr/local -xzf go1.18.4.linux-amd64.tar.gz
128 | export PATH=$PATH:/usr/local/go/bin
129 | go version
130 | export GOOS=linux
131 | export GOARCH=riscv64
132 | export CGO_ENABLED=1
133 | export CC=riscv64-linux-gnu-gcc
134 | git clone https://github.com/omniedgeio/omniedge-cli.git
135 | cd omniedge-cli
136 | go mod download
137 | go generate
138 | BUILD_ENV=prod make build-riscv64
139 | ```
140 |
141 | Omniedge-cli đã biên dịch sẽ được tìm thấy trong ** / out / **
142 |
143 | ### OmniEdge Android
144 |
145 | 1. Tải xuống Android Studio: https://developer.android.com/studio
146 | 2. Nhận repo và biên dịch
147 |
148 | ```bash
149 | git clone https://github.com/omniedgeio/omniedge-android.git`
150 | ./gradlew test --stacktrace
151 | ./gradlew assembleDebug --stacktrace
152 | ```
153 |
154 | Chúng tôi cũng đã chuẩn bị CI cho Github và Gitlab để xây dựng tự động.
155 |
156 | 1. Github: https://github.com/omniedgeio/omniedge-android/blob/main/.github/workflows/build.yml
157 | 2. GitLab: https://github.com/omniedgeio/omniedge-android/blob/main/.gitlab-ci.yml
158 |
159 |
160 | ### OmniEdge iOS
161 |
162 | 1. Tải xuống và cài đặt Xcode
163 | 2. Nhận repo và biên dịch
164 |
165 | ```bash
166 | git clone https://github.com/omniedgeio/omniedge-iOS.git
167 | cd omniedge-iOS
168 | open OmniEdgeNew/OmniEdgeNew.xcworkspace
169 | ```
170 |
171 | Xcode sẽ tự động mở, bạn phải đặt tài khoản nhà phát triển của mình để bắt đầu biên dịch. Chúng tôi khuyên bạn nên biên dịch gói trên các thiết bị của mình một cách riêng biệt, đặc biệt là gói **Tunnel**.
172 |
173 |
174 |
175 | ### OmniEdge-macOS
176 |
177 | 1. Tải xuống và cài đặt Xcode
178 | 2. Nhận repo và biên dịch
179 |
180 | ```bash
181 | git clone https://github.com/omniedgeio/omniedge-macOS.git
182 | cd omniedge-macOS
183 | open Omniedge.xcodeproj
184 | ```
185 |
186 | Xcode sẽ tự động mở, bạn phải đặt tài khoản nhà phát triển của mình để bắt đầu biên dịch.
187 |
188 | ### OmniEdge-windows
189 |
190 | 1. Tải xuống và cài đặt QT
191 | 2. Nhận repo và biên dịch
192 |
193 | ```bash
194 | git clone https://github.com/omniedgeio/omniedge-windows.git
195 | cd omniedge-windows
196 | ```
197 |
198 | mở **OmniEdge.pro** và bắt đầu biên dịch.
199 |
200 |
201 | ## Cách sử dụng
202 |
203 | - [Virtual Network, Devices, Security Key, and Settings](https://omniedge.io/docs/article/admin)
204 | - [Windows 7,10,11 for Intel or Arm](https://omniedge.io/docs/article/install/windows)
205 | - [Android](https://omniedge.io/docs/article/install/android)
206 | - [Linux Cli for raspberry Pi, Nvidia Jeston,and more](https://omniedge.io/docs/article/install/cli)
207 | - [MacOS Cli](https://omniedge.io/docs/article/install/macoscli)
208 | - [Synology](https://omniedge.io/docs/article/install/synology)
209 | - [Docker](https://omniedge.io/docs/article/install/docker)
210 | - [Github Action](https://omniedge.io/docs/article/install/github-action)
211 | - [iOS](https://omniedge.io/docs/article/install/ios)
212 | - [Setup custom supernode](https://omniedge.io/docs/article/install/customize-supernode)
213 |
214 | ## Trường hợp sử dụng
215 |
216 | > Cho chúng tôi biết trường hợp sử dụng của bạn để chúng tôi có thể chia sẻ với những người khác
217 |
218 | - [Remote connect windows without exposing public IP with Omniedge](https://omniedge.io/docs/article/Cases/RDP)
219 | - [Display and control macOS, Linux and Windows ](https://omniedge.io/docs/article/Cases/VNC)
220 | - [Keep connection with your AI based Project on Jetson](https://omniedge.io/docs/article/Cases/jetson)
221 | - [Display and control your Android device with Omniedge from anywhere on MacOS, Windows and Linux](https://omniedge.io/docs/article/Cases/android-remote)
222 | - [Talk to your family and share photos in a LAN on the internet](https://omniedge.io/docs/article/Cases/lan-messenger)
223 | - [Air Drop Any Files between MacOS, Windows, Routers, Linux and Android with Omniedge from anywhere](https://omniedge.io/docs/article/Cases/landrop)
224 |
225 | ## So sánh
226 |
227 | - [VPN vs. OmniEdge](https://omniedge.io/docs/article/compare/vpn-vs-omniedge)
228 | - [Express VPN vs. OmniEdge](https://omniedge.io/docs/article/compare/expressvpn-vs-omniedge)
229 | - [frp/ngrok vs. OmniEdge](https://omniedge.io/docs/article/compare/frp-ngrok-vs-omniedge)
230 | - [ZeroTier vs. OmniEdge](https://omniedge.io/docs/article/compare/zerotier-vs-omniedge)
231 | - [n2n vs. OmniEdge](https://omniedge.io/docs/article/compare/n2n-vs-omniedge)
232 |
233 | ## Ai đang nói về chúng tôi
234 |
235 | - [Founded by a Single Tweet Startup OmniEdge’s effort to let connect without concern](https://threat.technology/founded-by-a-single-tweet-startup-omniedges-effort-to-let-connect-without-concern/)
236 | - [voonze: OmniEdge, to access your Intranet from the Internet using P2P](https://voonze.com/omniedge-to-access-your-intranet-from-the-internet-using-p2p/)
237 | - [wwwhatsnew: OMNIEDGE, PARA ACCEDER A TU INTRANET DESDE INTERNET USANDO P2P](https://wwwhatsnew.com/2022/03/03/omniedge-para-acceder-a-tu-intranet-desde-internet-usando-p2p/)
238 | - [l'Entrepreneur: OmniEdge, pour accéder à votre Intranet depuis Internet en P2P](https://lentrepreneur.co/style/technologie/omniedge-pour-acceder-a-votre-intranet-depuis-internet-en-p2p-04032022)
239 | - [RunaCapital: Awesome OSS alternatives](https://github.com/RunaCapital/awesome-oss-alternatives)
240 | - [OmniEdge in ntopconf 2022](https://www.ntop.org/ntopconf2022/)
241 |
242 | ## Advisor
243 |
244 | [lucaderi](https://github.com/lucaderi)
245 |
246 | ## Contributors
247 |
248 | [harri8807](https://github.com/orgs/omniedgeio/people/harri8807) , [Tex-Tang](https://github.com/Tex-Tang), [ivyxjc](https://github.com/orgs/omniedgeio/people/ivyxjc), [kidylee](https://github.com/kidylee), [EbenDang](https://github.com/orgs/omniedgeio/people/EbenDang)
249 | ,[zteshadow](https://github.com/zteshadow), [ChenYouping](https://github.com/orgs/omniedgeio/people/ChenYouping),[ddrandy](https://github.com/orgs/omniedgeio/people/ddrandy), **Tsingv**, [mtx2d](https://github.com/mtx2d),[Blackrose](https://github.com/Blackrose), [cheung-chifung](https://github.com/cheung-chifung),[我不是矿神](https://imnks.com/5768.html)
250 |
251 | > Vui lòng cho chúng tôi biết về bất kỳ bài đăng nào liên quan đến chúng tôi thông qua vấn đề hoặc PR.
252 |
253 | ----
254 |
255 | Nếu bạn có thêm câu hỏi, vui lòng nói chuyện với chúng tôi tại [Discussions](https://github.com/omniedgeio/omniedge/discussions).
--------------------------------------------------------------------------------
/README/README-zh-Hans.md:
--------------------------------------------------------------------------------
1 |
2 | 
3 |
4 |
36 |
37 |
38 | [【English】](../README.md) [【繁体中文】](README-zh-Hant.md) [【简体中文】](README-zh-Hans.md) [【日本语】](README-JP.md) [【Español】](README-ES.md) [【Italiano】](README-IT.md) [【한국어】](README-KR.md)
39 | [【العربي】](README-AR.md) [【Tiếng Việt】](README-VN.md) [【แบบไทย】](README-TH.md)
40 |
41 |
42 | >OmniEdge 的端到端企业 VPN 解决方案,无需公网 IP,无需端口转发,无需反向代理,零配置,不仅适用于初创业团队、个人,也适用于需要弹性扩张,在世界各地拥有成千上万台电脑的大公司。局域网的事情,就要放在局域网。
43 |
44 | 
45 |
46 | ## 关键功能:
47 |
48 | ||||
49 | |----|----|----|
50 | |控制管理平台| :fire: Mesh VPNs|桌面 GUI 客户端支持: MacOS(menubar) 和 Windows(systray)|
51 | | :fire: 多私有网络 | :fire: Site-to-Site VPNs|命令行客户端支持: Linux,FreeBSD, Raspian 和 MacOS|
52 | |多用户|无限流量|命令行客户端支持:armv7,arm64,RISC-V64,x86_64 和 amd64|
53 | |多设备|加密的端到端连接|手机客户端支持: iOS 和 Android|
54 | | :fire: 自建超级节点 |加密relay|平板客户端支持: iPad, Android Tablet 和 Android TV|
55 | | :fire: 分享私有网络|混合云支持|NAS GUI 客户端支持: 群晖|
56 | |安全码登录| :fire: 零配置|自动分配公共超级节点|
57 | | :fire: [远程控制](https://omniedge.io/docs/article/Cases/VNC)|[远程 Drop 文件](https://omniedge.io/docs/article/Cases/landrop) |自动IP分配|
58 |
59 |
60 | 您也可以查阅 [Pricing](https://omniedge.io/pricing) 页面获取更多的企业版功能。
61 |
62 | ## 5分钟启用OmniEdge
63 |
64 | 1. 注册您的个人帐号: [注册](https://omniedge.io/register)
65 | 2. [下载](https://omniedge.io/download) OmniEdge 客户端
66 | 3. 如果您想使用命令行版本,可以使用以下命令安装 Cli 版本:
67 | ```bash
68 | curl https://omniedge.io/install/omniedge-install.sh | bash
69 | ```
70 | 4. 使用邮箱和密码登录客户端,选择需要加入的虚拟网络,点击加入,一切就准备好了。
71 |
72 | 如果您想使用**安全码**登录或者想要管理设备和虚拟网络,请查阅[官方文档](https://omniedge.io/docs)
73 |
74 | ## 服务器状态
75 |
76 | >这个服务器状态由 OmniEdge for Github Action 自动生成,每5个小时更新一次。
77 |
78 | [OmniEdge 服务状态](https://github.com/omniedgeio/server-status#server-status)
79 |
80 | ## 编译
81 |
82 | ### 编译 OmniEdge Cli
83 |
84 | 1. 环境: Golang 1.16.6
85 | 2. 编译:
86 | - 2.1. Ubuntu /linux
87 |
88 | ```bash
89 | sudo apt-get -y update
90 | sudo apt-get install -y openssl build-essential libssl-dev zip autoconf
91 | git clone git clone https://github.com/omniedgeio/omniedge-cli
92 | cd omniedge-cli
93 | go mod download
94 | go generate
95 | BUILD_ENV=prod make build
96 | ```
97 |
98 | - 2.2. macOS
99 |
100 | ```bash
101 | brew install autoconf automake libtool
102 | git clone https://github.com/omniedgeio/omniedge-cli
103 | cd omniedge-cli
104 | go mod download
105 | go generate
106 | BUILD_ENV=prod make build-darwin
107 | ```
108 |
109 | - 2.3. freebsd
110 |
111 | ```bash
112 | #freebsd
113 | su
114 | pkg update && pkg install go gmake git openssl zip autoconf automake libtool
115 | https://github.com/omniedgeio/omniedge-cli
116 | cd omniedge-cli
117 | go mod download
118 | go generate
119 | BUILD_ENV=prod make build-freebsd
120 | ```
121 |
122 | 3. 交叉编译
123 |
124 | - 3.1 RISC-V
125 |
126 | Host OS: Ubuntu 20.04
127 |
128 | ```bash
129 | apt-get update
130 | apt-get install -y openssl autoconf build-essential libssl-dev zip wget g++-riscv64-linux-gnu gcc-riscv64-linux-gnu
131 |
132 | wget https://go.dev/dl/go1.18.4.linux-amd64.tar.gz
133 | rm -rf /usr/local/go && tar -C /usr/local -xzf go1.18.4.linux-amd64.tar.gz
134 | export PATH=$PATH:/usr/local/go/bin
135 | go version
136 | export GOOS=linux
137 | export GOARCH=riscv64
138 | export CGO_ENABLED=1
139 | export CC=riscv64-linux-gnu-gcc
140 | git clone https://github.com/omniedgeio/omniedge-cli.git
141 | cd omniedge-cli
142 | go mod download
143 | go generate
144 | BUILD_ENV=prod make build-riscv64
145 | ```
146 |
147 | 编译好的文件可以在 **/out/** 找到。
148 | 您也可以使用自带的 Github Workflow 自动化编译。
149 |
150 |
151 | ### 编译 OmniEdge Android
152 |
153 | 1. 下载并安装 Android Studio: https://developer.android.com/studio
154 | 2. 下载源代码开始编译
155 |
156 | ```bash
157 | git clone https://github.com/omniedgeio/omniedge-android.git`
158 | ./gradlew test --stacktrace
159 | ./gradlew assembleDebug --stacktrace
160 | ```
161 |
162 | 我们也针对 Github 和 Gitlab 准备了自动化编译脚本,可以直接使用:
163 |
164 | - Github: https://github.com/omniedgeio/omniedge-android/blob/main/.github/workflows/build.yml
165 | - GitLab: https://github.com/omniedgeio/omniedge-android/blob/main/.gitlab-ci.yml
166 |
167 |
168 | ### 编译 OmniEdge iOS
169 |
170 | 1. 下载并安装 Xcode
171 | 2. 下载源代码开始编译
172 |
173 | ```bash
174 | git clone https://github.com/omniedgeio/omniedge-iOS.git
175 | cd omniedge-iOS
176 | open OmniEdgeNew/OmniEdgeNew.xcworkspace
177 | ```
178 |
179 | Xcode 会自动打开,开始编译前请先设置开发者帐号。我们建议您单独编译以下每一个包,特别是**Tunnel**。
180 |
181 |
182 |
183 | ### 编译 OmniEdge-macOS
184 |
185 | 1. 下载并安装 Xcode
186 | 2. 下载源代码开始编译
187 |
188 | ```bash
189 | git clone https://github.com/omniedgeio/omniedge-macOS.git
190 | cd omniedge-macOS
191 | open Omniedge.xcodeproj
192 | ```
193 |
194 | Xcode 会自动打开,开始编译前请先设置开发者帐号。
195 |
196 | ### OmniEdge-windows
197 |
198 | 1. 下载并安装 QT
199 | 2. 下载源代码开始编译
200 |
201 | ```bash
202 | git clone https://github.com/omniedgeio/omniedge-windows.git
203 | cd omniedge-windows
204 | ```
205 |
206 | 打开 **OmniEdge.pro** 开始编译.
207 |
208 | ## 使用安装 OmniEdge
209 |
210 | - [Virtual Network, Devices, Security Key, and Settings](https://omniedge.io/docs/article/admin)
211 | - [Windows 7,10,11 for Intel or Arm](https://omniedge.io/docs/article/install/windows)
212 | - [Android](https://omniedge.io/docs/article/install/android)
213 | - [Linux Cli for raspberry Pi, Nvidia Jeston,and more](https://omniedge.io/docs/article/install/cli)
214 | - [MacOS Cli](https://omniedge.io/docs/article/install/macoscli)
215 | - [Synology](https://omniedge.io/docs/article/install/synology)
216 | - [Docker](https://omniedge.io/docs/article/install/docker)
217 | - [Github Action](https://omniedge.io/docs/article/install/github-action)
218 | - [iOS](https://omniedge.io/docs/article/install/ios)
219 | - [Setup custom supernode](https://omniedge.io/docs/article/install/customize-supernode)
220 |
221 | ## 应用场景
222 |
223 | > 如果您有以下没有列出的应用,欢迎提PR,分享给更多的人
224 |
225 | - [Remote connect windows without exposing public IP with Omniedge](https://omniedge.io/docs/article/Cases/RDP)
226 | - [Display and control macOS, Linux and Windows ](https://omniedge.io/docs/article/Cases/VNC)
227 | - [Keep connection with your AI based Project on Jetson](https://omniedge.io/docs/article/Cases/jetson)
228 | - [Display and control your Android device with Omniedge from anywhere on MacOS, Windows and Linux](https://omniedge.io/docs/article/Cases/android-remote)
229 | - [Talk to your family and share photos in a LAN on the internet](https://omniedge.io/docs/article/Cases/lan-messenger)
230 | - [Air Drop Any Files between MacOS, Windows, Routers, Linux and Android with Omniedge from anywhere](https://omniedge.io/docs/article/Cases/landrop)
231 |
232 | ## 比较
233 |
234 | - [VPN vs. OmniEdge](https://omniedge.io/docs/article/compare/vpn-vs-omniedge)
235 | - [Express VPN vs. OmniEdge](https://omniedge.io/docs/article/compare/expressvpn-vs-omniedge)
236 | - [frp/ngrok vs. OmniEdge](https://omniedge.io/docs/article/compare/frp-ngrok-vs-omniedge)
237 | - [ZeroTier vs. OmniEdge](https://omniedge.io/docs/article/compare/zerotier-vs-omniedge)
238 | - [n2n vs. OmniEdge](https://omniedge.io/docs/article/compare/n2n-vs-omniedge)
239 |
240 |
241 | ## 谁在谈论 OmniEdge
242 |
243 | - [Founded by a Single Tweet Startup OmniEdge’s effort to let connect without concern](https://threat.technology/founded-by-a-single-tweet-startup-omniedges-effort-to-let-connect-without-concern/)
244 | - [voonze: OmniEdge, to access your Intranet from the Internet using P2P](https://voonze.com/omniedge-to-access-your-intranet-from-the-internet-using-p2p/)
245 | - [wwwhatsnew: OMNIEDGE, PARA ACCEDER A TU INTRANET DESDE INTERNET USANDO P2P](https://wwwhatsnew.com/2022/03/03/omniedge-para-acceder-a-tu-intranet-desde-internet-usando-p2p/)
246 | - [l'Entrepreneur: OmniEdge, pour accéder à votre Intranet depuis Internet en P2P](https://lentrepreneur.co/style/technologie/omniedge-pour-acceder-a-votre-intranet-depuis-internet-en-p2p-04032022)
247 | - [RunaCapital: Awesome OSS alternatives](https://github.com/RunaCapital/awesome-oss-alternatives)
248 | - [OmniEdge in ntopconf 2022](https://www.ntop.org/ntopconf2022/)
249 |
250 | >如果您看到了任何有关于 OmniEdge 的文章,请给我们提PR或者发issue
251 |
252 | ## Advisor
253 |
254 | [lucaderi](https://github.com/lucaderi)
255 |
256 | ## Contributors
257 |
258 | [harri8807](https://github.com/orgs/omniedgeio/people/harri8807) , [Tex-Tang](https://github.com/Tex-Tang), [ivyxjc](https://github.com/orgs/omniedgeio/people/ivyxjc), [kidylee](https://github.com/kidylee), [EbenDang](https://github.com/orgs/omniedgeio/people/EbenDang)
259 | ,[zteshadow](https://github.com/zteshadow), [ChenYouping](https://github.com/orgs/omniedgeio/people/ChenYouping),[ddrandy](https://github.com/orgs/omniedgeio/people/ddrandy), **Tsingv**, [mtx2d](https://github.com/mtx2d),[Blackrose](https://github.com/Blackrose), [cheung-chifung](https://github.com/cheung-chifung),[我不是矿神](https://imnks.com/5768.html)
260 |
261 | ----
262 |
263 | 如果您有更多问题,请去[Discussions](https://github.com/omniedgeio/omniedge/discussions) 提问。
264 |
--------------------------------------------------------------------------------
/README/README-zh-Hant.md:
--------------------------------------------------------------------------------
1 |
2 | 
3 |
4 |
36 |
37 |
38 | [【English】](../README.md) [【正體中文】](README-zh-Hant.md) [【簡體中文】](README-zh-Hans.md) [【日本語】](README-JP.md) [【Español】](README-ES.md) [【Italiano】](README-IT.md) [【한국어】](README-KR.md)
39 | [【العربي】](README-AR.md) [【Tiếng Việt】](README-VN.md) [【แบบไทย】](README-TH.md)
40 |
41 | >OmniEdge 的端到端企業 VPN 解決方案,無需公網 IP,無需端口轉發,無需反嚮代理,零配置,不僅適用於初創業團隊、個人,也適用於需要彈性擴張,在世界各地擁有成仟上萬臺電腦的大公司。局域網的事情,就要放在局域網。
42 |
43 | 
44 |
45 | ## 關鍵功能:
46 |
47 | ||||
48 | |----|----|----|
49 | |控製管理平臺| :fire: Mesh VPNs|桌麵 GUI 客戶端支援: MacOS(menubar) 和 Windows(systray)|
50 | | :fire: 多私有網路 | :fire: Site-to-Site VPNs|命令行客戶端支援: Linux,FreeBSD, Raspian 和 MacOS|
51 | |多用戶|無限流量|命令行客戶端支援:armv7,arm64,RISC-V64,x86_64 和 amd64|
52 | |多設備|加密的端到端連接|手機客戶端支援: iOS 和 Android|
53 | | :fire: 自建超級節點 |加密relay|平闆客戶端支援: iPad, Android Tablet 和 Android TV|
54 | | :fire: 分享私有網路|混合雲支援|NAS GUI 客戶端支援: 群暉|
55 | |安全碼登入| :fire: 零配置|自動分配公共超級節點|
56 | | :fire: [遠程控製](https://omniedge.io/docs/article/Cases/VNC)|[遠程 Drop 文件](https://omniedge.io/docs/article/Cases/landrop) |自動IP分配|
57 |
58 |
59 | 您也可以查閱 [Pricing](https://omniedge.io/pricing) 頁麵獲取更多的企業版功能。
60 |
61 | ## 5分鍾啓用OmniEdge
62 |
63 | 1. 註冊您的個人帳號: [註冊](https://omniedge.io/register)
64 | 2. [下載](https://omniedge.io/download) OmniEdge 客戶端
65 | 3. 如果您想使用命令行版本,可以使用以下命令安裝 Cli 版本:
66 | ```bash
67 | curl https://omniedge.io/install/omniedge-install.sh | bash
68 | ```
69 | 4. 使用信箱和密碼登入客戶端,選擇需要加入的虛擬網路,點選加入,一切就準備好了。
70 |
71 | 如果您想使用**安全碼**登入或者想要管理設備和虛擬網路,請查閱[官方文檔](https://omniedge.io/docs)
72 |
73 | ## 服務器狀態
74 |
75 | >這個服務器狀態由 OmniEdge for Github Action 自動生成,每5個小時更新一次。
76 |
77 | [OmniEdge 服務狀態](https://github.com/omniedgeio/server-status#server-status)
78 |
79 | ## 編譯
80 |
81 | ### 編譯 OmniEdge Cli
82 |
83 | 1. 環境: Golang 1.16.6
84 | 2. 編譯:
85 | - 2.1. Ubuntu /linux
86 |
87 | ```bash
88 | sudo apt-get -y update
89 | sudo apt-get install -y openssl build-essential libssl-dev zip autoconf
90 | git clone git clone https://github.com/omniedgeio/omniedge-cli
91 | cd omniedge-cli
92 | go mod download
93 | go generate
94 | BUILD_ENV=prod make build
95 | ```
96 |
97 | - 2.2. macOS
98 |
99 | ```bash
100 | brew install autoconf automake libtool
101 | git clone https://github.com/omniedgeio/omniedge-cli
102 | cd omniedge-cli
103 | go mod download
104 | go generate
105 | BUILD_ENV=prod make build-darwin
106 | ```
107 |
108 | - 2.3. freebsd
109 |
110 | ```bash
111 | #freebsd
112 | su
113 | pkg update && pkg install go gmake git openssl zip autoconf automake libtool
114 | https://github.com/omniedgeio/omniedge-cli
115 | cd omniedge-cli
116 | go mod download
117 | go generate
118 | BUILD_ENV=prod make build-freebsd
119 | ```
120 |
121 | 3. 交叉編譯
122 |
123 | - 3.1 RISC-V
124 |
125 | Host OS: Ubuntu 20.04
126 |
127 | ```bash
128 | apt-get update
129 | apt-get install -y openssl autoconf build-essential libssl-dev zip wget g++-riscv64-linux-gnu gcc-riscv64-linux-gnu
130 |
131 | wget https://go.dev/dl/go1.18.4.linux-amd64.tar.gz
132 | rm -rf /usr/local/go && tar -C /usr/local -xzf go1.18.4.linux-amd64.tar.gz
133 | export PATH=$PATH:/usr/local/go/bin
134 | go version
135 | export GOOS=linux
136 | export GOARCH=riscv64
137 | export CGO_ENABLED=1
138 | export CC=riscv64-linux-gnu-gcc
139 | git clone https://github.com/omniedgeio/omniedge-cli.git
140 | cd omniedge-cli
141 | go mod download
142 | go generate
143 | BUILD_ENV=prod make build-riscv64
144 | ```
145 |
146 | 編譯好的文件可以在 **/out/** 找到。
147 | 您也可以使用自帶的 Github Workflow 自動化編譯。
148 |
149 |
150 | ### 編譯 OmniEdge Android
151 |
152 | 1. 下載並安裝 Android Studio: https://developer.android.com/studio
153 | 2. 下載源代碼開始編譯
154 |
155 | ```bash
156 | git clone https://github.com/omniedgeio/omniedge-android.git`
157 | ./gradlew test --stacktrace
158 | ./gradlew assembleDebug --stacktrace
159 | ```
160 |
161 | 我們也針對 Github 和 Gitlab 準備了自動化編譯腳本,可以直接使用:
162 |
163 | - Github: https://github.com/omniedgeio/omniedge-android/blob/main/.github/workflows/build.yml
164 | - GitLab: https://github.com/omniedgeio/omniedge-android/blob/main/.gitlab-ci.yml
165 |
166 |
167 | ### 編譯 OmniEdge iOS
168 |
169 | 1. 下載並安裝 Xcode
170 | 2. 下載源代碼開始編譯
171 |
172 | ```bash
173 | git clone https://github.com/omniedgeio/omniedge-iOS.git
174 | cd omniedge-iOS
175 | open OmniEdgeNew/OmniEdgeNew.xcworkspace
176 | ```
177 |
178 | Xcode 會自動打開,開始編譯前請先設定開發者帳號。我們建議您單獨編譯以下每一個包,特別是**Tunnel**。
179 |
180 |
181 |
182 | ### 編譯 OmniEdge-macOS
183 |
184 | 1. 下載並安裝 Xcode
185 | 2. 下載源代碼開始編譯
186 |
187 | ```bash
188 | git clone https://github.com/omniedgeio/omniedge-macOS.git
189 | cd omniedge-macOS
190 | open Omniedge.xcodeproj
191 | ```
192 |
193 | Xcode 會自動打開,開始編譯前請先設定開發者帳號。
194 |
195 | ### OmniEdge-windows
196 |
197 | 1. 下載並安裝 QT
198 | 2. 下載源代碼開始編譯
199 |
200 | ```bash
201 | git clone https://github.com/omniedgeio/omniedge-windows.git
202 | cd omniedge-windows
203 | ```
204 |
205 | 打開 **OmniEdge.pro** 開始編譯.
206 |
207 | ## 使用安裝 OmniEdge
208 |
209 | - [Virtual Network, Devices, Security Key, and Settings](https://omniedge.io/docs/article/admin)
210 | - [Windows 7,10,11 for Intel or Arm](https://omniedge.io/docs/article/install/windows)
211 | - [Android](https://omniedge.io/docs/article/install/android)
212 | - [Linux Cli for raspberry Pi, Nvidia Jeston,and more](https://omniedge.io/docs/article/install/cli)
213 | - [MacOS Cli](https://omniedge.io/docs/article/install/macoscli)
214 | - [Synology](https://omniedge.io/docs/article/install/synology)
215 | - [Docker](https://omniedge.io/docs/article/install/docker)
216 | - [Github Action](https://omniedge.io/docs/article/install/github-action)
217 | - [iOS](https://omniedge.io/docs/article/install/ios)
218 | - [Setup custom supernode](https://omniedge.io/docs/article/install/customize-supernode)
219 |
220 | ## 應用場景
221 |
222 | > 如果您有以下冇有列出的應用,歡迎提PR,分享給更多的人
223 |
224 | - [Remote connect windows without exposing public IP with Omniedge](https://omniedge.io/docs/article/Cases/RDP)
225 | - [Display and control macOS, Linux and Windows ](https://omniedge.io/docs/article/Cases/VNC)
226 | - [Keep connection with your AI based Project on Jetson](https://omniedge.io/docs/article/Cases/jetson)
227 | - [Display and control your Android device with Omniedge from anywhere on MacOS, Windows and Linux](https://omniedge.io/docs/article/Cases/android-remote)
228 | - [Talk to your family and share photos in a LAN on the internet](https://omniedge.io/docs/article/Cases/lan-messenger)
229 | - [Air Drop Any Files between MacOS, Windows, Routers, Linux and Android with Omniedge from anywhere](https://omniedge.io/docs/article/Cases/landrop)
230 |
231 | ## 比較
232 |
233 | - [VPN vs. OmniEdge](https://omniedge.io/docs/article/compare/vpn-vs-omniedge)
234 | - [Express VPN vs. OmniEdge](https://omniedge.io/docs/article/compare/expressvpn-vs-omniedge)
235 | - [frp/ngrok vs. OmniEdge](https://omniedge.io/docs/article/compare/frp-ngrok-vs-omniedge)
236 | - [ZeroTier vs. OmniEdge](https://omniedge.io/docs/article/compare/zerotier-vs-omniedge)
237 | - [n2n vs. OmniEdge](https://omniedge.io/docs/article/compare/n2n-vs-omniedge)
238 |
239 |
240 | ## 誰在談論 OmniEdge
241 |
242 | - [Founded by a Single Tweet Startup OmniEdge’s effort to let connect without concern](https://threat.technology/founded-by-a-single-tweet-startup-omniedges-effort-to-let-connect-without-concern/)
243 | - [voonze: OmniEdge, to access your Intranet from the Internet using P2P](https://voonze.com/omniedge-to-access-your-intranet-from-the-internet-using-p2p/)
244 | - [wwwhatsnew: OMNIEDGE, PARA ACCEDER A TU INTRANET DESDE INTERNET USANDO P2P](https://wwwhatsnew.com/2022/03/03/omniedge-para-acceder-a-tu-intranet-desde-internet-usando-p2p/)
245 | - [l'Entrepreneur: OmniEdge, pour accéder à votre Intranet depuis Internet en P2P](https://lentrepreneur.co/style/technologie/omniedge-pour-acceder-a-votre-intranet-depuis-internet-en-p2p-04032022)
246 | - [RunaCapital: Awesome OSS alternatives](https://github.com/RunaCapital/awesome-oss-alternatives)
247 | - [OmniEdge in ntopconf 2022](https://www.ntop.org/ntopconf2022/)
248 |
249 | >如果您看到了任何有關於 OmniEdge 的文章,請給我們提PR或者發issue
250 |
251 | ## Advisor
252 |
253 | [lucaderi](https://github.com/lucaderi)
254 |
255 | ## Contributors
256 |
257 | [harri8807](https://github.com/orgs/omniedgeio/people/harri8807) , [Tex-Tang](https://github.com/Tex-Tang), [ivyxjc](https://github.com/orgs/omniedgeio/people/ivyxjc), [kidylee](https://github.com/kidylee), [EbenDang](https://github.com/orgs/omniedgeio/people/EbenDang)
258 | ,[zteshadow](https://github.com/zteshadow), [ChenYouping](https://github.com/orgs/omniedgeio/people/ChenYouping),[ddrandy](https://github.com/orgs/omniedgeio/people/ddrandy), **Tsingv**, [mtx2d](https://github.com/mtx2d),[Blackrose](https://github.com/Blackrose), [cheung-chifung](https://github.com/cheung-chifung),[我不是礦神](https://imnks.com/5768.html)
259 |
260 | ----
261 |
262 | 如果您有更多問題,請去[Discussions](https://github.com/omniedgeio/omniedge/discussions) 提問。
263 |
--------------------------------------------------------------------------------
/check_version.xml:
--------------------------------------------------------------------------------
1 |
2 | 0.2.6
3 | 1
4 |
5 |
--------------------------------------------------------------------------------
/docs/compile/compile-windows-Kits.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/omniedgeio/omniedge/b00eab23707f2311c42ec5c4f007656138ed4197/docs/compile/compile-windows-Kits.png
--------------------------------------------------------------------------------
/docs/compile/compile-windows-release.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/omniedgeio/omniedge/b00eab23707f2311c42ec5c4f007656138ed4197/docs/compile/compile-windows-release.png
--------------------------------------------------------------------------------
/protocol/OmniEdge_Flow.md:
--------------------------------------------------------------------------------
1 | Short description of the term.
2 | - Proxy here I did not distinguish between Proxy, Worker, Web Backend
3 | - Web here refers to the user's management interface, including and not limited to Web / App
4 |
5 |
6 | ## 1: User initialization/management network
7 |
8 | ```mermaid
9 | sequenceDiagram
10 | participant O as OAuth2.0,Ldap
11 | participant U as User
12 | participant W as Web
13 |
14 | participant P as Proxy/Backend
15 | participant S as SNode
16 |
17 | rect rgb(0, 255, 120)
18 | %% auth2.0 block
19 | Note over O,W : Authentication Login
20 | U ->> W : Registered Login
21 | W ->> O : Redirect third party authentication
22 | alt User Confirmation
23 | U ->> O : User confirmation
24 | O ->> W : Complete authentication, return Token
25 | else User rejects
26 | U ->> O : User rejects or timeout
27 | O ->> W : Authentication failed, return error
28 | end
29 | end
30 |
31 | %% init network
32 | rect rgb(0, 255, 200)
33 | Note over U,S : Authentication completed to start network configuration
34 | U ->> W : Initialize VPN parameters (ID, IP, Gateway, route)
35 | W ->> P : Save network information
36 | P ->> S : Set VPN network information
37 | W ->> U : Return the network ID
38 | U ->> W : Create secret key pair
39 | W ->> P : Store the private and public keys
40 | P ->> S : Set Super Node private key
41 | Note over S : SuperNode Ready
42 | W ->> U : Return the public key
43 |
44 | end
45 | ```
46 |
47 |
48 | ## 2: Node joins the network for the first time
49 |
50 |
51 | ## Node joins the network
52 |
53 |
54 | ```mermaid
55 | sequenceDiagram
56 | participant W as Web
57 | participant U as User
58 | participant N as Node
59 |
60 | participant P as Proxy/Backend
61 | participant S as SNode
62 |
63 |
64 | rect rgb(230, 150, 200)
65 | %% auth2.0 block
66 | Note over U, N: Node start
67 | alt configured file
68 | N ->> N : Read configuration file
69 | else no config file
70 | N -> U : Waiting for network parameters
71 | U -> N : User enters VPN ID and alias
72 | end
73 | end
74 |
75 | rect rgb(200, 200, 200)
76 | %% auth2.0 block
77 | Note over W,P: Node network information is obtained, explicitly via http or https
78 | N ->> P : Use device information, try to get device status and public key (ID, HW UUID, SW Ver)
79 | alt The current node is an unaudited device
80 | rect rgb(250, 250, 0)
81 | P ->> W: Display the device to be audited
82 | U ->> W: user authentication device
83 | W ->> P: mark the device as authenticated
84 | P --> N: return to normal, node continues
85 | end
86 | else blacklisted devices
87 | rect rgb(100, 100, 150)
88 | P ->> N: Notify node of exception, node goes offline
89 | N ->> N: node exits
90 | end
91 | else authenticated device
92 | rect rgb(0, 250, 150)
93 | P --> N: return normal, node continues
94 | end
95 | end
96 | end
97 | P ->> N: return VPN public key
98 | rect rgb(230, 150, 200)
99 | Note over W,S: Follow up with public key encryption communication (which actually affects performance)
100 | N ->> P: Request node network information
101 | P ->> N: assign P2P secret key and IP information
102 | N ->> P: request a list of information about all nodes in the network
103 | P ->> N: Return a list of information about all nodes in the network
104 |
105 | N ->> S: Join SuperNode network via Proxy
106 | S ->> P: Check if it is an authenticated device
107 | P ->> S: Verify that the device is legitimate
108 | S ->> N: Confirm join success
109 |
110 | end
111 | par heartbeat information
112 | rect rgb(230, 150, 200)
113 | loop Loop node and Super Node heartbeat signal
114 | N -->> S: send a heartbeat signal using the secret key assigned to the node
115 | S -->> P: Update the Proxy maintenance list
116 | S ->> N: reply to the heartbeat signal using the node's assigned secret key
117 | end
118 | end
119 | and normal communication
120 | rect rgb(230, 200, 150)
121 | loop Loop Node and Super Node communicate legally
122 | N --> S: Encrypted communication using the secret key and algorithm assigned by the node
123 | S -->> N: Active or passive reply to the node using the node's assigned secret key
124 | end
125 | end
126 | end
127 | ```
128 |
129 | ## 3: Node P2P communication
130 |
131 | When communicating between two nodes, both parties need to make sure their P2P Profile List is up-to-date and each maintains information about the P2P devices in the network
132 |
133 | ### P2P direct penetration communication
134 |
135 | ```mermaid
136 | sequenceDiagram
137 |
138 | participant N0 as legal node 0
139 | participant N1 as Legal Node 1
140 |
141 | participant P as Proxy
142 | participant S as SuperNode
143 |
144 | par heartbeat information
145 | rect rgb(230, 150, 200)
146 | loop Node update P2P Profile List
147 | N0 ->> P: request to update P2P Profile List
148 | P ->> N0: return the latest
149 | end
150 | end
151 | and normal communication
152 | rect rgb(230, 200, 150)
153 | loop Node update P2P Profile List
154 | N1 ->> P: request to update the P2P Profile List
155 | P ->> N1: return the latest
156 | end
157 | end
158 | end
159 |
160 | alt P2P direct connection
161 | rect rgb(255, 255, 0)
162 | N0 ->> N1 : Establish a communication link using the pass-through parameter
163 | rect rgb(0, 250, 150)
164 | loop Start formal communication (encryption optional))
165 | N0 ->> N1 : hello (encrypt the payload using its own encryption method and secret key)
166 | N1 ->> N0 : decrypt with the initiator's secret key, and reply with your own secret key if successful
167 | end
168 | end
169 | end
170 | else server relay
171 | rect rgb(255, 255, 0)
172 | N0 ->> S : Node and SuperNode establish a link, multiplex the heartbeat link
173 | N1 ->> S : Node and SuperNode establish a link, multiplex the heartbeat link
174 | rect rgb(0, 250, 150)
175 | loop Start formal communication (encryption optional))
176 | N0 ->> S : hello (encrypt the payload using its own encryption method and secret key)
177 | S ->> N1 : SuperNode verifies the node and then forwards to the target node
178 | N1 ->> S : The receiver decrypts using the sender's secret key, and then replies with its own secret key encryption
179 | S ->> N0 : SuperNode verifies the node and then forwards to the target node
180 | end
181 | end
182 | end
183 | end
184 | ```
185 |
186 | ## Security protection
187 |
188 | ### 1: Self-protection of nodes
189 |
190 | Nodes may have possible data leakage during use
191 |
192 |
193 | | Possibility | Description | Solution Ideas |
194 | | ---- | ---- | ---- |
195 | | public key data | public key is not worried about losing | try not to store it locally, and use https encryption during the acquisition process |
196 | | https hijacking | https hijacking | calibrate https public key |
197 | | P2P Profile List secret key leak | hole-punching and encryption information leakage throughout the network | data is updated regularly, node self-checking, proximity node detection and timely blackout |
198 |
199 | ### 2: Active prevention of data leakage
200 |
201 | The possibility of leakage includes.
202 |
203 | | possibility | description | solution ideas |
204 | | ---- | ---- | ---- |
205 | | Storage | Store sensitive data locally | Try to store in memory and obfuscate |
206 | | debug crack | memory intrusion crack | program self-check and add anti-debug code, and promptly notify the proxy to pull the hack |
207 |
208 |
209 |
210 | ## Brief description of data structure
211 |
212 | P2P Profile List Info
213 |
214 | For each device in the P2P network, there is a structure to describe its P2P profile as follows
215 | | Key | Type | Comment |
216 | | ---- | ---- | ---- |
217 | | old n2n | struct | original n2n parameters |
218 | | encryp_type | int | Encryption method, such as cha20 symmetric encryption |
219 | | compress_type | int | Compression methods, such as gzip
220 | | key | char[64] | The secret key of the current node |
221 | | timeout | uint64_t | The time out deadline of the current profile |
222 |
223 |
224 |
225 |
226 | ## Data traffic analysis
227 |
228 | ```mermaid
229 | pie title node traffic
230 | "P2P direct connection" : 60
231 | "Server transit" : 40
232 | ```
--------------------------------------------------------------------------------
/protocol/OmniEdge_Node_API.md:
--------------------------------------------------------------------------------
1 | # 1. OmniEdge_Node_API
2 |
3 | - Authors: Bright
4 | - Status: **Draft** | Discussion | Development | Active | Dropped | Superseded
5 |
6 | **ChangeLog**
7 | | Version | Developer |Time|Remark |
8 | |--- | --- | --- | --- |
9 | |Draft| Bright | Jan.15th,2020 |
10 |
11 |
12 | # 2. API Summary
13 | Here the API definition is divided into two categories.
14 |
15 | - Node (including Super Node) and back-end communication, using **RestAPI + Https**
16 | - Communication between Nodes, to improve data parsing and forwarding efficiency, use **Data Structure + Encryption + UDP**
17 |
18 | ## 2.1. RESTAPI List
19 |
20 | | API | URI | Parameters | Remarks | Priority|
21 | | --- | --- | --- | --- | --- |
22 | | register node device | /node/register | | | 1 |
23 | | register super node device | /snode/register | | | 2 |
24 | | Get node network | /node/{node_id}/network | Correspondig fingerprint node(id) to the network information| | 1 |
25 | | Get supernode network | /snode/{snode_id}/network | Corresponding to the supernode network information | | 2 |
26 | | Node get p2p network information | /node/{node_id}/p2p/{network_id}/network | P2P information to the networkf information {ID} | | 1 |
27 | | Super Get P2P Network Information | /snode/{snode_id}/p2p/{network_id}/network | P2P information of the corresponding network{ID} | | 1 |
28 | | Uploading node statistics| /node/{node_id}/statistic | Traffic statistics, etc | | 3 |
29 | | Uploading supernode statistics | /snode/{node_id}/statistic | Traffic statistics, etc | | 3 |
30 | | Uploading supernode network statistics| /snode/{snode_id}/network/{network_id}/statistic | Traffic statistics, etc | | 3 |
31 | | Send supernode command | /snode/{id}/command | supernodeID | | 4|
32 | | Send node command | /node/{id}/command | NodeID | | 4 |
33 |
34 | ### 2.2. Error code description
35 | ### 2.2.1. Error code enumeration
36 | | situation | code | message | description | solution |
37 | | --- | ---| --- | --- | --- |
38 | | command success | 200 | success | - |
39 | | command success | 201 | success, unauthorized | unauthenticated device | - |
40 | | device is repeatedly registered, failed | 401 | does not exist | - |
41 | | blacklist, failed | 402 | certificate revoked | reset device or delete public and private keys, rejoin |
42 |
43 | ***TODO, need add more***
44 | ### 2.2.2. Device duplicate registration
45 | - Public key
46 | - Hardware computed UUID (hardware UUID computation, with backend for processing to avoid being hacked)
47 | - Network ID
48 |
49 |
50 | ## 3. RestAPI description
51 | ## 3.1. Registering Node
52 | **Backend related interface**, this interface can register a device to different networks according to different users, here the user ID is not used, but the network id obtained after the user created the network is used instead.
53 | ### 3.1.1. URI
54 | - **Post** /node/register
55 |
56 | Parameter description (** parameters are only supported on specific platforms**, the corresponding parameters do not exist for unsupported platforms).
57 | ### 3.1.2. Input parameters
58 | The parameters contain three major categories.
59 | - Hardware UUID
60 | - Network
61 | - Secret key
62 |
63 | **Hardware UUID** Related parameters :
64 |
65 | | Parameters | Description | mac | win/linux | openwrt | nas | android | ios |
66 | | --- | --- | :---: | :---: | :---: | :---: | :---: |:---: |
67 | | os | OS Type | Y | Y |Y |Y | Y | Y |
68 | | verison | Version | Y | Y |Y |Y | Y | Y |
69 | | hostname | Hostname | Y | Y |Y |Y | Y | Y |
70 | | cpu | cpu type | Y | Y | Y | - | - | - |
71 | | disk | disk S/N | - | Y | - | - | - | - |
72 | | nic | Network card macID list | Y | Y | Y | Y | - | - |
73 | | oaid | CN OAID | - | - | - | - | Y | - |
74 | | adid | Goole ID | Y | Y | - | - | - | Y |
75 | | wlan | Wifi macID | Y | Y | - | - | - | - | - |
76 | | idfa | IOS ID1 | - | - | - | - |- | Y|
77 | | idfv | IOS ID2 | - | - | - | - | - | Y |
78 | | uuid | UUID generated by client | Y | Y |Y |Y | Y | Y |
79 |
80 |
81 | **Network** Related,Using this parameter will attempt to add the device to the specified network
82 | | Paramters | Description | mac | win/linux | openwrt | nas | android | ios |
83 | | --- | --- | :---: | :---: | :---: | :---: | :---: |:---: |
84 | | network_id | NetworkID | Y | Y |Y |Y | Y | Y |
85 | | alias | Device Alias for dashboard| Y | Y |Y |Y | Y | Y |
86 |
87 | **Secret Key** Related
88 | When encountering revocation of permission on the web side, the secret key will be regenerated and re-registered
89 |
90 | | Paramters | Description | mac | win/linux | openwrt | nas | android | ios |
91 | | --- | --- | :---: | :---: | :---: | :---: | :---: |:---: |
92 | | rsa | Public Key | Y | Y |Y |Y | Y | Y |
93 |
94 | **Other**Related
95 | | Paramters | Description | mac | win/linux | openwrt | nas | android | ios |
96 | | --- | --- | :---: | :---: | :---: | :---: | :---: |:---: |
97 | | sw_version | Public Key | Y | Y |Y |Y | Y | Y |
98 |
99 | ### 3.1.3. Output parameters
100 | | Parameters | Type | Description |
101 | | --- | --- | --- |
102 | | code | int32_t | Returns the status code |
103 | | msg | string | Error information |
104 | | uuid | uint64_t |fingerprint information assigned by the device, here simply use large integers, for node fast identification has advantages, it is recommended that the server side can be a database index configuration other mechanisms to generate UUID |
105 | ### 3.1.4. Example
106 | #### 3.1.4.1. input
107 | An example with the Windows parameter
108 | ```json
109 | {
110 | os :“Windows”,
111 | version:“6.5”,
112 | hostname :“wang-win-16.04”,
113 | cpu:“cpu1|cpu2”,
114 | disk:“disk1|disk2”,
115 | nic:“mac1|mac2”,
116 | alias :“Omni-Aws-01”,
117 | sw_version:“0.1.0-beta”,
118 | uuid : "01FEFESQSWEQWEQW"
119 | ras :"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCs60i09byvd0DboJMsrLOYIg1r7FQhR9mmo43SGV5AHwha6wlvmZfGlBCNq6O96INwNud6JN+P0cbf4+rMjdh/pQ+d+xNTcostq8dgdd7CLJg4tjWt8Pzu+x7iqMwQZtVDeFGUv5JK1Ro8np505qfhd/jNGlW2TrfVP9095uYmig1kEQ19EWELfutROe/zPPQKwGhiPiYnd+T91h3t8BfsSJFbnLBO7S37yjsb/g7yqEAEWtNXjShTGvCQenYQjViPjm9SOVUIScPuNmImRrIzcV1VIAgq8rrFgKNg/T2Za8niGGprABCBmVeEi4xXtnrcVg8vaANoF9opMx+W7ulf Dandan@DESKTOP-FNSU7A9"
120 | }
121 | ```
122 | #### 3.1.4.2. output
123 | ```json
124 | {
125 | code: ,
126 | msg: "Device is added Successfully",
127 | uuid : 125687
128 | }
129 | ```
130 |
131 |
132 | ## 3.2. Registering Super Node
133 | **Backend related interface**, this interface can register a device to different networks according to different users, instead of using the user id, the network id obtained after the user created the network is used here instead.
134 | ### 3.2.1. URI
135 | - **Post** /snode/register
136 |
137 | ### 3.2.2. Register Super Node
138 |
139 | ### 3.2.3. Input Parameters
140 | Hardware UUID Related parameters:
141 |
142 | | Parameters | Description | win | linux | openwrt |
143 | | --- | --- | :---: | :---: | :---: |
144 | | os | OS type | Y | Y | Y |
145 | | verison | Version | Y | Y | Y |
146 | | hostname | Hostname | Y | Y | Y |
147 | | ip | IP Address | Y | Y | Y |
148 | | port | Port | Y | Y | Y |
149 |
150 | **Network** related, using this parameter will try to add the device to the specified network
151 | | Parameters | Description | mac | win/linux | openwrt | nas | android | ios |
152 | | --- | --- | :---: | :---: | :---: | :---: | :---: |:---: |
153 | | alias | Deivce alias | Y | Y |Y |Y | Y | Y |
154 |
155 | **Secret Key** Related
156 | When encountering revocation of permission on the web side, the secret key will be regenerated and re-registered
157 |
158 | | Parameters | Description | mac | win/linux | openwrt | nas | android | ios |
159 | | --- | --- | :---: | :---: | :---: | :---: | :---: |:---: |
160 | | rsa | Public Key | Y | Y |Y |Y | Y | Y |
161 |
162 | **Other** Related
163 | | Parameters | Description | mac | win/linux | openwrt | nas | android | ios |
164 | | --- | --- | :---: | :---: | :---: | :---: | :---: |:---: |
165 | | sw_version | Public key | Y | Y |Y |Y | Y | Y |
166 |
167 | ### 3.2.4. Output parameters
168 | | Parameters | Type | Description |
169 | | --- | --- | --- |
170 | | code | int32_t | Returns the status code |
171 | | msg | string | error message |
172 | | uuid | uint64_t | fingerprint information assigned by the device, here simply use large integers, for node fast identification has advantages, it is recommended that the server side can be a database index configuration other mechanisms to generate UUID |
173 |
174 |
175 | **NOTE** Conditions for duplicate registration of devices.
176 | - Public key
177 | - Hardware calculated UUID (hardware UUID calculation with backend for processing to avoid being hacked)
178 | - Network ID
179 |
180 |
181 | ### 3.2.5. Example
182 | #### 3.2.5.1. input
183 | An example with the CentOS parameter
184 | ```json
185 | {
186 | os :“Centos”,
187 | version:“6.5”,
188 | hostname :“centos-16.04”,
189 | ip :“88.88.88.88”,
190 | port:“1024”,
191 | version:“5.0”,
192 | sw_version:“0.1.0-beta”,
193 | alias:“aws_east_us”
194 | }
195 | ```
196 | #### 3.2.5.2. output
197 | ```json
198 | {
199 | code: ,
200 | msg: "Device is added Successfully",
201 | uuid : 125687
202 | }
203 | ```
204 |
205 |
206 | Return Results:
207 | | Parameters | Description | win | linux | openwrt |
208 | | --- | --- | :---: | :---: | :---: |
209 | | code | error code | Y | Y | Y |
210 | | message | message | Y | Y | Y |
211 | | device_id | Device fingerprint, here simply use large integers, for node fast identification has the advantage of suggesting that the server side can be a database index configuration other mechanisms | Y | Y | Y |
212 |
213 |
214 | ## 3.3. Get node network information
215 | **Backend related interface**
216 | Get the required network network related information of the node
217 | ## 3.3.1. Base path
218 | - **GET** /node/{id}/network
219 | ### 3.3.2. Input parameters
220 | | parameters | type | description |
221 | | --- | --- | --- |
222 | | id | int32_t | Node node encoding |
223 | ### 3.3.3. Output parameters
224 | | parameters | type | description |
225 | | --- | --- | --- |
226 | | code | int32_t | Returns the status code |
227 | | msg | string | |
228 | | ip | string | IP information |
229 | | netmask | string | network mask |
230 | | gateway | string | gateway information |
231 | | route | string | Return status code |
232 |
233 |
234 | ### 3.3.4. Example
235 | #### 3.3.4.1. input
236 | None
237 |
238 | #### 3.3.4.2. output
239 | ```json
240 | {
241 | code: 200,
242 | msg: "success",
243 | ip : “10.10.10.110”,
244 | netmask:“255.255.255.0”,
245 | gateway:“10.10.10.1”,
246 | route: [
247 | {
248 | network: "0.0.0.0" ,
249 | mask: "0.0.0.0",
250 | gateway: "10.10.10.1",
251 | metric: "1"
252 | },
253 | {
254 | network: "192.168.1.0" ,
255 | mask: "255.255.255.0",
256 | gateway: "192.168.0.1",
257 | metric: "1"
258 | }
259 | ]
260 | }
261 | ```
262 |
263 | ## 3.4. Get super node network information
264 | **Backend related interface** to get the information related to the network network required by the node
265 | ## 3.4.1. Base path
266 | - **GET** /snode/{id}/network
267 | ### 3.4.2. Input parameters
268 | | parameter | type | description |
269 | | --- | --- | --- |
270 | | id | int32_t | Super Node node encoding |
271 | ### 3.4.3. Output parameters
272 | | parameters | type | description |
273 | | --- | --- | --- |
274 | | code | int32_t | Returns the status code |
275 | | msg | string | |
276 | | ip | string | IP information |
277 | | port | string | port information |
278 |
279 | ### 3.4.4. Example
280 | #### 3.4.4.1. input
281 | None
282 |
283 | #### 3.4.4.2. output
284 | ```json
285 | {
286 | code: 200,
287 | msg: "success",
288 | ip : “10.10.10.110”,
289 | port:“88.88.88.88”,
290 | ras :" rsa Public Key"
291 | }
292 | ```
293 |
294 |
295 |
296 | ## 3.5. Super Node Network Statistics
297 | **Backend related interface**, statistics of SuperNode
298 | ## 3.5.1. URI
299 | - **Post** /snode/{super_node_id}/{network_id}/statistic
300 | ### 3.5.2. URL parameters
301 | | parameters | type | description |
302 | | --- | --- | --- |
303 | | super_node_id | uint64_t | SuperNode node ID |
304 | | network_id | uint64_t | network_id |
305 |
306 | ### 3.5.3. Input Parameters
307 | | parameters | type | description |
308 | | --- | --- | --- |
309 | | active_node | uint64_t | SuperNode node ID |
310 | | route_flow | uint64_t | |
311 | **NOTE** Add more later as needed
312 |
313 |
314 | ### 3.5.4. Output parameters
315 | The P2P network parameters consist of two parts.
316 | - Super Node information
317 | - Node penetration information
318 |
319 | | Parameters | Type | Description |
320 | | --- | --- | --- |
321 | | code | int32_t | Return status code |
322 | | msg | string | |
323 |
324 |
325 | ### 3.5.5. Example
326 | #### 3.5.5.1. input
327 | None
328 |
329 | #### 3.5.5.2. output
330 | ```json
331 | {
332 | code: 200,
333 | msg: "success",
334 | snode: [
335 | {
336 | uuid :100,
337 | ip : “10.10.10.110”,
338 | port:“5000”,
339 | rsa :"RSA Publich Key"
340 | }
341 | ],
342 | node: [
343 | {
344 | uuid :123455,
345 | rsa :" RSA Publich Key",
346 | ip : “10.100.10.110”,
347 | port:“11223”
348 | },
349 | {
350 | uuid :123456,
351 | rsa :" RSA Publich Key",
352 | ip : “10.165.10.111”,
353 | port:“11225”
354 | }
355 | ]
356 | }
357 | }
358 | ```
359 |
360 |
361 |
362 | ## 3.6. Node statistics reporting
363 | **Backend related interface**, statistics of SuperNode
364 | ## 3.6.1. URI
365 | - **Post** /node/{id}/statistic
366 | ### 3.6.2. Input parameters
367 | | parameters | type | description |
368 | | --- | --- | --- |
369 | | id | int64_t | node fingerprint information |
370 |
371 | ### 3.6.3. Output parameters
372 | The P2P network parameters consist of two parts.
373 | - Super Node information
374 | - Node node penetration information
375 |
376 |
377 | | parameters | type | description |
378 | | --- | --- | --- |
379 | | code | int32_t | Return status code |
380 | | msg | string | |
381 |
382 |
383 | **Super Node** Related
384 | | parameters | type | description |
385 | | --- | --- | --- |
386 | | uuid | uint64_t | node fingerprint |
387 | | ip | string | public IP information |
388 | | port | string | port information |
389 | | rsa | string | public key information |
390 |
391 | **Node** related
392 | | parameters | type | description |
393 | | --- | --- | --- |
394 | | uuid | uint64_t | Node fingerprint |
395 | | ip | string | Export IP information |
396 | | port | string | port information |
397 | | rsa | string | public key information |
398 |
399 | ***NOTE*** Some penetration information will be added later based on N2N
400 |
401 | ### 3.6.4. Example
402 | #### 3.6.4.1. input
403 | None
404 |
405 | #### 3.6.4.2. output
406 | ```json
407 | {
408 | code: 200,
409 | msg: "success",
410 | snode: [
411 | {
412 | uuid :100,
413 | ip : “10.10.10.110”,
414 | port:“5000”,
415 | rsa :"RSA Publich Key"
416 | }
417 | ],
418 | node: [
419 | {
420 | uuid :123455,
421 | rsa :" RSA Publich Key",
422 | ip : “10.100.10.110”,
423 | port:“11223”
424 | },
425 | {
426 | uuid :123456,
427 | rsa :" RSA Publich Key",
428 | ip : “10.165.10.111”,
429 | port:“11225”
430 | }
431 | ]
432 | }
433 | }
434 | ```
435 |
436 |
437 |
438 |
439 |
440 |
441 | ## 3.7. Super Node statistics reporting
442 | **Backend related interface**, statistics of SuperNode
443 | ## 3.7.1. Base path
444 | - **Post** /snode/{network_id}/statistic
445 | ### 3.7.2. Input parameters
446 | | Parameters | Type | Description |
447 | | --- | --- | --- |
448 | | network_id | int32_t | network_id_code |
449 |
450 | ### 3.7.3. Output parameters
451 | The P2P network parameters consist of two parts.
452 | - Super Node information
453 | - Node node penetration information
454 |
455 |
456 | | parameters | type | description |
457 | | --- | --- | --- |
458 | | code | int32_t | Return status code |
459 | | msg | string | |
460 |
461 |
462 | **Super Node** Related
463 | | parameters | type | description |
464 | | --- | --- | --- |
465 | | uuid | uint64_t | node fingerprint |
466 | | ip | string | public IP information |
467 | | port | string | port information |
468 | | rsa | string | public key information |
469 |
470 | **Node** related
471 | | parameters | type | description |
472 | | --- | --- | --- |
473 | | uuid | uint64_t | Node fingerprint |
474 | | ip | string | Export IP information |
475 | | port | string | port information |
476 | | rsa | string | public key information |
477 |
478 | ***NOTE*** Some penetration information will be added later based on N2N
479 |
480 | ### 3.7.4. Example
481 | #### 3.7.4.1. input
482 | None
483 |
484 | #### 3.7.4.2. output
485 | ```json
486 | {
487 | code: 200,
488 | msg: "success",
489 | snode: [
490 | {
491 | uuid :100,
492 | ip : “10.10.10.110”,
493 | port:“5000”,
494 | rsa :"RSA Publich Key"
495 | }
496 | ],
497 | node: [
498 | {
499 | uuid :123455,
500 | rsa :" RSA Publich Key",
501 | ip : “10.100.10.110”,
502 | port:“11223”
503 | },
504 | {
505 | uuid :123456,
506 | rsa :" RSA Publich Key",
507 | ip : “10.165.10.111”,
508 | port:“11225”
509 | }
510 | ]
511 | }
512 | }
513 | ```
514 |
515 |
516 |
517 | # 4. inter-Node API list
518 | Each packet consists of header+payload
519 | ## 4.1 header data structure
520 |
521 | The data structure uses Big-Endian to be compatible with different platforms, and the header should not be too large, considering that each packet should be limited to MTU, so moderate size is necessary.
522 |
523 | **Data content:**
524 | | Parameter | Type | Description | Remarks |
525 | | --- | --- | --- | --- |
526 | | des_uuid | uint64_t | target_fingerprint |
527 | | src_uuid | uint64_t | originator fingerprint |
528 | | cmd_id | uint16_t | command_definition |
529 | | token | char[8] | | Server-assigned communication token, simple checksum between user nodes, set valid time |
530 | | timestamp | uint32_t | Current timestamp | Timestamp affects header hash generation to prevent forgery |
531 | | payload_size | uint16_t | payload encrypted data size | | payload_crc | uint16_t
532 | | payload_crc | uint16_t | payload encrypted data crc | |
533 | | payload_plain_size | uint16_t | payload original_data_size | |
534 | | payload_plain_crc | uint16_t | payload raw_data_crc | |
535 | | header_plain_crc | uint16_t | payload raw data crc | |
536 | | ------ | ----- | ----- |
537 | | header_crc | uint16_t | header header encrypted data calculated by CRC | |
538 |
539 | **NOTE:** Here use crc32 or crc16, and then or more simplified heterogeneous checksum, the hash value of all the content encrypted before the hash, the receiver confirms whether the data header is valid by comparing the hash, here use more than medium strength encryption to avoid being cracked, or even completely use public and private keys not called encryption, but it depends on the actual performance
540 |
541 | ### 4.11 header encryption operation flow
542 |
543 | ```mermaid
544 | sequenceDiagram
545 | participant N as Node
546 | participant S as Super Node/Node
547 | loop Communication flow
548 | N --> N : fill payload, calculate plain and encrypted data and corresponding crc
549 | N --> N : fill header corresponding field, select cmd field, calculate Header plain crc
550 | N -->> N : encrypt and calculate fill header crc
551 | N ->> S : send header+payload
552 | S ->>> S : check header crc
553 | S ->>> S : decrypt header and verify
554 | S ->>> S : decrypt the payload
555 | S ->>> S : Process the payload
556 | S -->> S : Ensure package-fill payload, calculate plain and encrypted data and corresponding crc
557 | S -->> S : Secure package-populate header corresponding field, select cmd field, calculate Header plain crc
558 | S -->> S : encrypt and calculate header crc
559 | S -->> N : Ensure packet-padding header hash and send
560 | N ->>> N : check header crc
561 | N -->> N : decrypt header and check
562 | N -->> N : Decrypt the payload
563 | N -->> N : Process the payload
564 | end
565 |
566 | ```
567 |
568 | **NOTE** Symmetric encryption algorithms are approximately 1500 times faster than asymmetric encryption algorithms
569 | **Examples of data structures:**
570 | ```c
571 | struct{
572 | uint64_t des_uuid,
573 | uint64_t src_uuid,
574 | uint32_t cmd_id,
575 | char[8] token,
576 | uint32_t timestamp,
577 | uint16_t payload_size,
578 | uint16_t payload_crc,
579 | char[8] header_hash
580 | }
581 | ```
582 |
583 | ### 4.12 header cmd definition
584 | The command is a 16-bit unsigned integer, the initiating packet will be defined, the acknowledgement packet will be the highest position 1 by default, and the payload will be discarded and returned. Except for special packets.
585 | | command | description | description | comments |
586 | | --- | --- | --- | --- |
587 | | 0x1 | Initiate symmetric secret key negotiation | Initiator selects symmetric secret key and algorithm |
588 | | 0x8001 | Symmetric secret key confirmation | The reverse-order secret key returns the symmetric secret key using the symmetric secret key encryption.
589 | | 0x2 | Normal packet sending | |
590 | | 0x8002 | Normal packet acknowledgement | |
591 | | 0x30 | Command packet | Reserved here
592 | | 0x8030 | Command packet acknowledgement | |
593 |
594 |
595 |
596 | ## 4.2 payload data structure
597 | ### payload data structure
598 |
599 | ### cmd corresponding payload definition
600 |
--------------------------------------------------------------------------------
/protocol/README.md:
--------------------------------------------------------------------------------
1 | # OmniEdge
2 |
3 | The Protocol of OmniEdge, building an intranet on the internet.
4 |
5 | # The Flow of OmniEdge
6 |
7 | Short description of the term.
8 | - Proxy here I did not distinguish between Proxy, Worker, Web Backend
9 | - Web here refers to the user's management interface, including and not limited to Web / App
10 |
11 |
12 | ## 1: User initialization/management network
13 |
14 | ```mermaid
15 | sequenceDiagram
16 | participant O as OAuth2.0,Ldap
17 | participant U as User
18 | participant W as Web
19 |
20 | participant P as Proxy/Backend
21 | participant S as SNode
22 |
23 | rect rgb(0, 255, 120)
24 | %% auth2.0 block
25 | Note over O,W : Authentication Login
26 | U ->> W : Registered Login
27 | W ->> O : Redirect third party authentication
28 | alt User Confirmation
29 | U ->> O : User confirmation
30 | O ->> W : Complete authentication, return Token
31 | else User rejects
32 | U ->> O : User rejects or timeout
33 | O ->> W : Authentication failed, return error
34 | end
35 | end
36 |
37 | %% init network
38 | rect rgb(0, 255, 200)
39 | Note over U,S : Authentication completed to start network configuration
40 | U ->> W : Initialize VPN parameters (ID, IP, Gateway, route)
41 | W ->> P : Save network information
42 | P ->> S : Set VPN network information
43 | W ->> U : Return the network ID
44 | U ->> W : Create secret key pair
45 | W ->> P : Store the private and public keys
46 | P ->> S : Set Super Node private key
47 | Note over S : SuperNode Ready
48 | W ->> U : Return the public key
49 |
50 | end
51 | ```
52 |
53 |
54 | ## 2: Node joins the network for the first time
55 |
56 |
57 | ## Node joins the network
58 |
59 |
60 | ```mermaid
61 | sequenceDiagram
62 | participant W as Web
63 | participant U as User
64 | participant N as Node
65 |
66 | participant P as Proxy/Backend
67 | participant S as SNode
68 |
69 |
70 | rect rgb(230, 150, 200)
71 | %% auth2.0 block
72 | Note over U, N: Node start
73 | alt configured file
74 | N ->> N : Read configuration file
75 | else no config file
76 | N -> U : Waiting for network parameters
77 | U -> N : User enters VPN ID and alias
78 | end
79 | end
80 |
81 | rect rgb(200, 200, 200)
82 | %% auth2.0 block
83 | Note over W,P: Node network information is obtained, explicitly via http or https
84 | N ->> P : Use device information, try to get device status and public key (ID, HW UUID, SW Ver)
85 | alt The current node is an unaudited device
86 | rect rgb(250, 250, 0)
87 | P ->> W: Display the device to be audited
88 | U ->> W: user authentication device
89 | W ->> P: mark the device as authenticated
90 | P --> N: return to normal, node continues
91 | end
92 | else blacklisted devices
93 | rect rgb(100, 100, 150)
94 | P ->> N: Notify node of exception, node goes offline
95 | N ->> N: node exits
96 | end
97 | else authenticated device
98 | rect rgb(0, 250, 150)
99 | P --> N: return normal, node continues
100 | end
101 | end
102 | end
103 | P ->> N: return VPN public key
104 | rect rgb(230, 150, 200)
105 | Note over W,S: Follow up with public key encryption communication (which actually affects performance)
106 | N ->> P: Request node network information
107 | P ->> N: assign P2P secret key and IP information
108 | N ->> P: request a list of information about all nodes in the network
109 | P ->> N: Return a list of information about all nodes in the network
110 |
111 | N ->> S: Join SuperNode network via Proxy
112 | S ->> P: Check if it is an authenticated device
113 | P ->> S: Verify that the device is legitimate
114 | S ->> N: Confirm join success
115 |
116 | end
117 | par heartbeat information
118 | rect rgb(230, 150, 200)
119 | loop Loop node and Super Node heartbeat signal
120 | N -->> S: send a heartbeat signal using the secret key assigned to the node
121 | S -->> P: Update the Proxy maintenance list
122 | S ->> N: reply to the heartbeat signal using the node's assigned secret key
123 | end
124 | end
125 | and normal communication
126 | rect rgb(230, 200, 150)
127 | loop Loop Node and Super Node communicate legally
128 | N --> S: Encrypted communication using the secret key and algorithm assigned by the node
129 | S -->> N: Active or passive reply to the node using the node's assigned secret key
130 | end
131 | end
132 | end
133 | ```
134 |
135 | ## 3: Node P2P communication
136 |
137 | When communicating between two nodes, both parties need to make sure their P2P Profile List is up-to-date and each maintains information about the P2P devices in the network
138 |
139 | ### P2P direct penetration communication
140 |
141 | ```mermaid
142 | sequenceDiagram
143 |
144 | participant N0 as legal node 0
145 | participant N1 as Legal Node 1
146 |
147 | participant P as Proxy
148 | participant S as SuperNode
149 |
150 | par heartbeat information
151 | rect rgb(230, 150, 200)
152 | loop Node update P2P Profile List
153 | N0 ->> P: request to update P2P Profile List
154 | P ->> N0: return the latest
155 | end
156 | end
157 | and normal communication
158 | rect rgb(230, 200, 150)
159 | loop Node update P2P Profile List
160 | N1 ->> P: request to update the P2P Profile List
161 | P ->> N1: return the latest
162 | end
163 | end
164 | end
165 |
166 | alt P2P direct connection
167 | rect rgb(255, 255, 0)
168 | N0 ->> N1 : Establish a communication link using the pass-through parameter
169 | rect rgb(0, 250, 150)
170 | loop Start formal communication (encryption optional))
171 | N0 ->> N1 : hello (encrypt the payload using its own encryption method and secret key)
172 | N1 ->> N0 : decrypt with the initiator's secret key, and reply with your own secret key if successful
173 | end
174 | end
175 | end
176 | else server relay
177 | rect rgb(255, 255, 0)
178 | N0 ->> S : Node and SuperNode establish a link, multiplex the heartbeat link
179 | N1 ->> S : Node and SuperNode establish a link, multiplex the heartbeat link
180 | rect rgb(0, 250, 150)
181 | loop Start formal communication (encryption optional))
182 | N0 ->> S : hello (encrypt the payload using its own encryption method and secret key)
183 | S ->> N1 : SuperNode verifies the node and then forwards to the target node
184 | N1 ->> S : The receiver decrypts using the sender's secret key, and then replies with its own secret key encryption
185 | S ->> N0 : SuperNode verifies the node and then forwards to the target node
186 | end
187 | end
188 | end
189 | end
190 | ```
191 |
192 | ## Security protection
193 |
194 | ### 1: Self-protection of nodes
195 |
196 | Nodes may have possible data leakage during use
197 |
198 |
199 | | Possibility | Description | Solution Ideas |
200 | | ---- | ---- | ---- |
201 | | public key data | public key is not worried about losing | try not to store it locally, and use https encryption during the acquisition process |
202 | | https hijacking | https hijacking | calibrate https public key |
203 | | P2P Profile List secret key leak | hole-punching and encryption information leakage throughout the network | data is updated regularly, node self-checking, proximity node detection and timely blackout |
204 |
205 | ### 2: Active prevention of data leakage
206 |
207 | The possibility of leakage includes.
208 |
209 | | possibility | description | solution ideas |
210 | | ---- | ---- | ---- |
211 | | Storage | Store sensitive data locally | Try to store in memory and obfuscate |
212 | | debug crack | memory intrusion crack | program self-check and add anti-debug code, and promptly notify the proxy to pull the hack |
213 |
214 |
215 |
216 | ## Brief description of data structure
217 |
218 | P2P Profile List Info
219 |
220 | For each device in the P2P network, there is a structure to describe its P2P profile as follows
221 | | Key | Type | Comment |
222 | | ---- | ---- | ---- |
223 | | old n2n | struct | original n2n parameters |
224 | | encryp_type | int | Encryption method, such as cha20 symmetric encryption |
225 | | compress_type | int | Compression methods, such as gzip
226 | | key | char[64] | The secret key of the current node |
227 | | timeout | uint64_t | The time out deadline of the current profile |
228 |
229 |
230 |
231 |
232 | ## Data traffic analysis
233 |
234 | ```mermaid
235 | pie title node traffic
236 | "P2P direct connection" : 60
237 | "Server transit" : 40
238 | ```
239 |
240 | 2. [OmniEdge_Node_API.md](OmniEdge_Node_API.md)
241 |
242 | https://omniedge.io
243 |
--------------------------------------------------------------------------------
/protocol/how-omniedge-works-main-architecture.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/omniedgeio/omniedge/b00eab23707f2311c42ec5c4f007656138ed4197/protocol/how-omniedge-works-main-architecture.png
--------------------------------------------------------------------------------