added language bindings, python implementation and docs for the feature add
root node
This commit is contained in:
BIN
Docs/Colored-On-Light-Image.png
Normal file
BIN
Docs/Colored-On-Light-Image.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 276 KiB |
178
Docs/index.html
178
Docs/index.html
@@ -3,7 +3,7 @@
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
|
||||
<head>
|
||||
<!-- 2025-04-25 Fri 23:17 -->
|
||||
<!-- 2025-04-28 Mon 23:14 -->
|
||||
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<title>‎</title>
|
||||
@@ -26,12 +26,12 @@
|
||||
<h2>Table of Contents</h2>
|
||||
<div id="text-table-of-contents" role="doc-toc">
|
||||
<ul>
|
||||
<li><a href="#org9c37a3a">1. Guide through video</a>
|
||||
<li><a href="#org3cfeea9">1. Guide through video</a>
|
||||
<ul>
|
||||
<li>
|
||||
<ul>
|
||||
<li><a href="#org73ac1f8">1.0.1. The video below shows the setup and usage of P2PRC.</a></li>
|
||||
<li><a href="#orgf3f19a6">1.0.2. Source code: https://github.com/Akilan1999/p2p-rendering-computation</a></li>
|
||||
<li><a href="#org4256417">1.0.1. The video below shows the setup and usage of P2PRC.</a></li>
|
||||
<li><a href="#orgecee0c3">1.0.2. Source code: https://github.com/Akilan1999/p2p-rendering-computation</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -78,7 +78,8 @@
|
||||
<li><a href="#pulling-plugin-from-a-remote-repo">4.0.17. Pulling plugin from a remote repo</a></li>
|
||||
<li><a href="#deleting-plugin-from-the-plugin-directory">4.0.18. Deleting plugin from the plugin directory</a></li>
|
||||
<li><a href="#added-custom-metadata-about-the-current-node">4.0.19. Added custom metadata about the current node</a></li>
|
||||
<li><a href="#org8aff015">4.0.20. MapPort and link to domain name</a></li>
|
||||
<li><a href="#org899f210">4.0.20. MapPort and link to domain name</a></li>
|
||||
<li><a href="#orge681470">4.0.21. Add root node</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -108,8 +109,8 @@
|
||||
</li>
|
||||
<li><a href="#current-languages-supported">6.3. Current languages supported</a>
|
||||
<ul>
|
||||
<li><a href="#orga857f83">6.3.1. Python</a></li>
|
||||
<li><a href="#orgf0d5243">6.3.2. Haskell</a></li>
|
||||
<li><a href="#org92a1e8c">6.3.1. Python</a></li>
|
||||
<li><a href="#org780e43b">6.3.2. Haskell</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -126,22 +127,22 @@
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#client-mode">10. Client mode</a></li>
|
||||
<li><a href="#orgefbf5e1">11. Blog posts</a>
|
||||
<li><a href="#org1b92827">11. Blog posts</a>
|
||||
<ul>
|
||||
<li><a href="#org0aff8a2">11.1. Self host within 5 minutes any program</a>
|
||||
<li><a href="#orgec8979c">11.1. Self host within 5 minutes any program</a>
|
||||
<ul>
|
||||
<li><a href="#orgc1cd454">11.1.1. 1. Find a program you want to run</a></li>
|
||||
<li><a href="#orgd03815a">11.1.1. 1. Find a program you want to run</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#org6a05ac1">12. Ideas for future potencial features</a>
|
||||
<li><a href="#orgb32e475">12. Ideas for future potencial features</a>
|
||||
<ul>
|
||||
<li><a href="#org2136819">12.1. To support hetrogenous set of Nodes that cannot run P2PRC</a>
|
||||
<li><a href="#org2666d00">12.1. To support hetrogenous set of Nodes that cannot run P2PRC</a>
|
||||
<ul>
|
||||
<li><a href="#org8f98161">12.1.1. Assumptions:</a></li>
|
||||
<li><a href="#org806bc11">12.1.2. Set of interesting possible:</a></li>
|
||||
<li><a href="#org2df764e">12.1.3. Implementation</a></li>
|
||||
<li><a href="#org332fcc8">12.1.1. Assumptions:</a></li>
|
||||
<li><a href="#org21a29ac">12.1.2. Set of interesting possible:</a></li>
|
||||
<li><a href="#org4947494">12.1.3. Implementation</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -150,26 +151,26 @@
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="org93c8684" class="figure">
|
||||
<p><img src="../artwork/p2prc-logos/Colored-On-Light-Image.png" alt="Colored-On-Light-Image.png" width="300px" />
|
||||
<div id="orgefb6d6c" class="figure">
|
||||
<p><img src="./Colored-On-Light-Image.png" alt="Colored-On-Light-Image.png" width="300px" />
|
||||
</p>
|
||||
</div>
|
||||
<div id="outline-container-org9c37a3a" class="outline-2">
|
||||
<h2 id="org9c37a3a"><span class="section-number-2">1.</span> Guide through video</h2>
|
||||
<div id="outline-container-org3cfeea9" class="outline-2">
|
||||
<h2 id="org3cfeea9"><span class="section-number-2">1.</span> Guide through video</h2>
|
||||
<div class="outline-text-2" id="text-1">
|
||||
</div>
|
||||
<div id="outline-container-org73ac1f8" class="outline-4">
|
||||
<h4 id="org73ac1f8"><span class="section-number-4">1.0.1.</span> The video below shows the setup and usage of P2PRC.</h4>
|
||||
<div id="outline-container-org4256417" class="outline-4">
|
||||
<h4 id="org4256417"><span class="section-number-4">1.0.1.</span> The video below shows the setup and usage of P2PRC.</h4>
|
||||
<div class="outline-text-4" id="text-1-0-1">
|
||||
|
||||
<div id="org1f2f6d2" class="figure">
|
||||
<div id="org863dfc7" class="figure">
|
||||
<p><a href="https://www.youtube.com/watch?v=OMwCpedu5cs" class="video"><img src="https://i3.ytimg.com/vi/OMwCpedu5cs/maxresdefault.jpg" alt="maxresdefault.jpg" class="video" /></a>
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="outline-container-orgf3f19a6" class="outline-4">
|
||||
<h4 id="orgf3f19a6"><span class="section-number-4">1.0.2.</span> Source code: <a href="https://github.com/Akilan1999/p2p-rendering-computation">https://github.com/Akilan1999/p2p-rendering-computation</a></h4>
|
||||
<div id="outline-container-orgecee0c3" class="outline-4">
|
||||
<h4 id="orgecee0c3"><span class="section-number-4">1.0.2.</span> Source code: <a href="https://github.com/Akilan1999/p2p-rendering-computation">https://github.com/Akilan1999/p2p-rendering-computation</a></h4>
|
||||
</div>
|
||||
</div>
|
||||
<div id="outline-container-chapter1-introduction" class="outline-2">
|
||||
@@ -258,7 +259,7 @@ Go API to create and interact with the containers.
|
||||
to install docker GPU</a>
|
||||
</p>
|
||||
|
||||
<pre class="example" id="orgd9620d4">
|
||||
<pre class="example" id="orgfc326ea">
|
||||
// Do ensure that the docker command does not need sudo to run
|
||||
sudo chmod 666 /var/run/docker.sock
|
||||
</pre>
|
||||
@@ -272,7 +273,7 @@ To set up the internal dependencies and build the entire go code into a
|
||||
single binary
|
||||
</p>
|
||||
|
||||
<pre class="example" id="org1a7a29f">
|
||||
<pre class="example" id="org9abf859">
|
||||
make
|
||||
</pre>
|
||||
</div>
|
||||
@@ -284,7 +285,7 @@ To set up P2PRC on Windows, simply run this batch file. <b>Make sure you
|
||||
are not in admin mode when running this.</b>
|
||||
</p>
|
||||
|
||||
<pre class="example" id="org0bf0b81">
|
||||
<pre class="example" id="org754bc46">
|
||||
.\install.bat
|
||||
</pre>
|
||||
</div>
|
||||
@@ -294,7 +295,7 @@ are not in admin mode when running this.</b>
|
||||
<div id="outline-container-add-appropriate-paths-to-.bashrc" class="outline-4">
|
||||
<h4 id="add-appropriate-paths-to-.bashrc"><span class="section-number-4">3.2.4.</span> Add appropriate paths to <code>.bashrc</code></h4>
|
||||
<div class="outline-text-4" id="text-add-appropriate-paths-to-.bashrc">
|
||||
<pre class="example" id="orgabf26a3">
|
||||
<pre class="example" id="org06344db">
|
||||
export P2PRC=/<PATH>/p2p-rendering-computation
|
||||
export PATH=/<PATH>/p2p-rendering-computation:${PATH}
|
||||
</pre>
|
||||
@@ -303,14 +304,14 @@ export PATH=/<PATH>/p2p-rendering-computation:${PATH}
|
||||
<div id="outline-container-test-if-binary-works" class="outline-4">
|
||||
<h4 id="test-if-binary-works"><span class="section-number-4">3.2.5.</span> Test if binary works</h4>
|
||||
<div class="outline-text-4" id="text-test-if-binary-works">
|
||||
<pre class="example" id="org2685522">
|
||||
<pre class="example" id="org189a0e9">
|
||||
p2prc --help
|
||||
</pre>
|
||||
</div>
|
||||
<ol class="org-ol">
|
||||
<li><a id="output"></a>Output:<br />
|
||||
<div class="outline-text-5" id="text-output">
|
||||
<pre class="example" id="orgac10245">
|
||||
<pre class="example" id="org705fb25">
|
||||
NAME:
|
||||
p2p-rendering-computation - p2p cli application to create and access VMs in other servers
|
||||
|
||||
@@ -372,7 +373,7 @@ GLOBAL OPTIONS:
|
||||
<div id="outline-container-start-as-a-server" class="outline-4">
|
||||
<h4 id="start-as-a-server"><span class="section-number-4">4.0.1.</span> Start as a server</h4>
|
||||
<div class="outline-text-4" id="text-start-as-a-server">
|
||||
<pre class="example" id="org282e2af">
|
||||
<pre class="example" id="org1be9ce7">
|
||||
p2prc -s
|
||||
</pre>
|
||||
</div>
|
||||
@@ -380,7 +381,7 @@ p2prc -s
|
||||
<div id="outline-container-view-server-specification" class="outline-4">
|
||||
<h4 id="view-server-specification"><span class="section-number-4">4.0.2.</span> View server Specification</h4>
|
||||
<div class="outline-text-4" id="text-view-server-specification">
|
||||
<pre class="example" id="org985433e">
|
||||
<pre class="example" id="org7c6080c">
|
||||
p2prc --specs=<ip address>
|
||||
</pre>
|
||||
</div>
|
||||
@@ -392,7 +393,7 @@ p2prc --specs=<ip address>
|
||||
use the <code>--gpu</code> if you know the other machine has a gpu.
|
||||
</p>
|
||||
|
||||
<pre class="example" id="org9d5f05e">
|
||||
<pre class="example" id="org96ebc97">
|
||||
p2prc --touch=<server ip address> -p <number of ports> --gpu
|
||||
</pre>
|
||||
</div>
|
||||
@@ -404,7 +405,7 @@ p2prc --touch=<server ip address> -p <number of ports> --gpu
|
||||
The docker id is present in the output where you create a container
|
||||
</p>
|
||||
|
||||
<pre class="example" id="org9e5bd7e">
|
||||
<pre class="example" id="org3a50a5b">
|
||||
p2prc --rm=<server ip address> --id=<docker container id>
|
||||
</pre>
|
||||
</div>
|
||||
@@ -412,7 +413,7 @@ p2prc --rm=<server ip address> --id=<docker container id>
|
||||
<div id="outline-container-adding-servers-to-ip-table" class="outline-4">
|
||||
<h4 id="adding-servers-to-ip-table"><span class="section-number-4">4.0.5.</span> Adding servers to ip table</h4>
|
||||
<div class="outline-text-4" id="text-adding-servers-to-ip-table">
|
||||
<pre class="example" id="orgb1d5224">
|
||||
<pre class="example" id="orgd0b12dc">
|
||||
p2prc --as=<server ip address you want to add>
|
||||
</pre>
|
||||
</div>
|
||||
@@ -420,7 +421,7 @@ p2prc --as=<server ip address you want to add>
|
||||
<div id="outline-container-update-ip-table" class="outline-4">
|
||||
<h4 id="update-ip-table"><span class="section-number-4">4.0.6.</span> Update ip table</h4>
|
||||
<div class="outline-text-4" id="text-update-ip-table">
|
||||
<pre class="example" id="org671a527">
|
||||
<pre class="example" id="org2b52762">
|
||||
p2prc --us
|
||||
</pre>
|
||||
</div>
|
||||
@@ -428,7 +429,7 @@ p2prc --us
|
||||
<div id="outline-container-list-servers" class="outline-4">
|
||||
<h4 id="list-servers"><span class="section-number-4">4.0.7.</span> List Servers</h4>
|
||||
<div class="outline-text-4" id="text-list-servers">
|
||||
<pre class="example" id="org18aa560">
|
||||
<pre class="example" id="org9a40c4a">
|
||||
p2prc --ls
|
||||
</pre>
|
||||
</div>
|
||||
@@ -436,7 +437,7 @@ p2prc --ls
|
||||
<div id="outline-container-view-network-interfaces" class="outline-4">
|
||||
<h4 id="view-network-interfaces"><span class="section-number-4">4.0.8.</span> View Network interfaces</h4>
|
||||
<div class="outline-text-4" id="text-view-network-interfaces">
|
||||
<pre class="example" id="orge4afb87">
|
||||
<pre class="example" id="orge766dd3">
|
||||
p2prc --ni
|
||||
</pre>
|
||||
</div>
|
||||
@@ -444,7 +445,7 @@ p2prc --ni
|
||||
<div id="outline-container-viewing-containers-created-client-side" class="outline-4">
|
||||
<h4 id="viewing-containers-created-client-side"><span class="section-number-4">4.0.9.</span> Viewing Containers created Client side</h4>
|
||||
<div class="outline-text-4" id="text-viewing-containers-created-client-side">
|
||||
<pre class="example" id="orgb9767d1">
|
||||
<pre class="example" id="org9787c64">
|
||||
p2prc --tc
|
||||
</pre>
|
||||
</div>
|
||||
@@ -452,7 +453,7 @@ p2prc --tc
|
||||
<div id="outline-container-running-plugin" class="outline-4">
|
||||
<h4 id="running-plugin"><span class="section-number-4">4.0.10.</span> Running plugin</h4>
|
||||
<div class="outline-text-4" id="text-running-plugin">
|
||||
<pre class="example" id="orgc805e30">
|
||||
<pre class="example" id="org94b7a90">
|
||||
p2prc --plugin <plugin name> --id <container id or group id>
|
||||
</pre>
|
||||
</div>
|
||||
@@ -460,7 +461,7 @@ p2prc --plugin <plugin name> --id <container id or group id>
|
||||
<div id="outline-container-create-group" class="outline-4">
|
||||
<h4 id="create-group"><span class="section-number-4">4.0.11.</span> Create group</h4>
|
||||
<div class="outline-text-4" id="text-create-group">
|
||||
<pre class="example" id="orgaa0084e">
|
||||
<pre class="example" id="orge008a6c">
|
||||
p2prc --cgroup
|
||||
</pre>
|
||||
</div>
|
||||
@@ -468,7 +469,7 @@ p2prc --cgroup
|
||||
<div id="outline-container-add-container-to-group" class="outline-4">
|
||||
<h4 id="add-container-to-group"><span class="section-number-4">4.0.12.</span> Add container to group</h4>
|
||||
<div class="outline-text-4" id="text-add-container-to-group">
|
||||
<pre class="example" id="org25f0283">
|
||||
<pre class="example" id="org8598b18">
|
||||
p2prc --group <group id> --id <container id>
|
||||
</pre>
|
||||
</div>
|
||||
@@ -476,7 +477,7 @@ p2prc --group <group id> --id <container id>
|
||||
<div id="outline-container-view-groups" class="outline-4">
|
||||
<h4 id="view-groups"><span class="section-number-4">4.0.13.</span> View groups</h4>
|
||||
<div class="outline-text-4" id="text-view-groups">
|
||||
<pre class="example" id="org8abb354">
|
||||
<pre class="example" id="org5425a07">
|
||||
p2prc --groups
|
||||
</pre>
|
||||
</div>
|
||||
@@ -484,7 +485,7 @@ p2prc --groups
|
||||
<div id="outline-container-view-specific-group" class="outline-4">
|
||||
<h4 id="view-specific-group"><span class="section-number-4">4.0.14.</span> View specific group</h4>
|
||||
<div class="outline-text-4" id="text-view-specific-group">
|
||||
<pre class="example" id="org3a73cfe">
|
||||
<pre class="example" id="org187af36">
|
||||
p2prc --group <group id>
|
||||
</pre>
|
||||
</div>
|
||||
@@ -492,7 +493,7 @@ p2prc --group <group id>
|
||||
<div id="outline-container-delete-container-from-group" class="outline-4">
|
||||
<h4 id="delete-container-from-group"><span class="section-number-4">4.0.15.</span> Delete container from group</h4>
|
||||
<div class="outline-text-4" id="text-delete-container-from-group">
|
||||
<pre class="example" id="orge983347">
|
||||
<pre class="example" id="orga4687ab">
|
||||
p2prc --rmcgroup --group <group id> --id <container id>
|
||||
</pre>
|
||||
</div>
|
||||
@@ -500,7 +501,7 @@ p2prc --rmcgroup --group <group id> --id <container id>
|
||||
<div id="outline-container-delete-entire-group" class="outline-4">
|
||||
<h4 id="delete-entire-group"><span class="section-number-4">4.0.16.</span> Delete entire group</h4>
|
||||
<div class="outline-text-4" id="text-delete-entire-group">
|
||||
<pre class="example" id="org1a2d4d9">
|
||||
<pre class="example" id="orgf60b3a8">
|
||||
p2prc --rmgroup <group id>
|
||||
</pre>
|
||||
</div>
|
||||
@@ -508,7 +509,7 @@ p2prc --rmgroup <group id>
|
||||
<div id="outline-container-pulling-plugin-from-a-remote-repo" class="outline-4">
|
||||
<h4 id="pulling-plugin-from-a-remote-repo"><span class="section-number-4">4.0.17.</span> Pulling plugin from a remote repo</h4>
|
||||
<div class="outline-text-4" id="text-pulling-plugin-from-a-remote-repo">
|
||||
<pre class="example" id="orgee7b538">
|
||||
<pre class="example" id="orgb9bee77">
|
||||
p2prc --pp <repo link>
|
||||
</pre>
|
||||
</div>
|
||||
@@ -516,7 +517,7 @@ p2prc --pp <repo link>
|
||||
<div id="outline-container-deleting-plugin-from-the-plugin-directory" class="outline-4">
|
||||
<h4 id="deleting-plugin-from-the-plugin-directory"><span class="section-number-4">4.0.18.</span> Deleting plugin from the plugin directory</h4>
|
||||
<div class="outline-text-4" id="text-deleting-plugin-from-the-plugin-directory">
|
||||
<pre class="example" id="org380741b">
|
||||
<pre class="example" id="org2979ba1">
|
||||
p2prc --rp <plugin name>
|
||||
</pre>
|
||||
</div>
|
||||
@@ -524,28 +525,28 @@ p2prc --rp <plugin name>
|
||||
<div id="outline-container-added-custom-metadata-about-the-current-node" class="outline-4">
|
||||
<h4 id="added-custom-metadata-about-the-current-node"><span class="section-number-4">4.0.19.</span> Added custom metadata about the current node</h4>
|
||||
<div class="outline-text-4" id="text-added-custom-metadata-about-the-current-node">
|
||||
<pre class="example" id="org3da0b46">
|
||||
<pre class="example" id="org3c1dba9">
|
||||
p2prc --amd "custom metadata"
|
||||
</pre>
|
||||
</div>
|
||||
</div>
|
||||
<div id="outline-container-org8aff015" class="outline-4">
|
||||
<h4 id="org8aff015"><span class="section-number-4">4.0.20.</span> MapPort and link to domain name</h4>
|
||||
<div id="outline-container-org899f210" class="outline-4">
|
||||
<h4 id="org899f210"><span class="section-number-4">4.0.20.</span> MapPort and link to domain name</h4>
|
||||
<div class="outline-text-4" id="text-4-0-20">
|
||||
<p>
|
||||
Allows to expose remote ports from a machine in the P2P network.
|
||||
</p>
|
||||
<pre class="example" id="org971ad93">
|
||||
<pre class="example" id="org9d628c6">
|
||||
p2prc --mp <port no to map> --dn <domain name to link Mapped port against>
|
||||
</pre>
|
||||
</div>
|
||||
<ol class="org-ol">
|
||||
<li><a id="org0e256de"></a>MapPort in remote machine<br />
|
||||
<li><a id="org29021b1"></a>MapPort in remote machine<br />
|
||||
<div class="outline-text-5" id="text-4-0-20-1">
|
||||
<p>
|
||||
This is to ensure ports on remote machines on the P2PRC can be easily opened.
|
||||
</p>
|
||||
<pre class="example" id="orgdc964c0">
|
||||
<pre class="example" id="orga1ff65e">
|
||||
p2prc --mp <port no to map> --dn <domain name to link Mapped port against> --ra <remote server address>
|
||||
</pre>
|
||||
|
||||
@@ -554,6 +555,19 @@ p2prc --mp <port no to map> --dn <domain name to link Mapped port again
|
||||
</li>
|
||||
</ol>
|
||||
</div>
|
||||
<div id="outline-container-orge681470" class="outline-4">
|
||||
<h4 id="orge681470"><span class="section-number-4">4.0.21.</span> Add root node</h4>
|
||||
<div class="outline-text-4" id="text-4-0-21">
|
||||
<p>
|
||||
Adds a root node to P2RRC and overwrites all other nodes in the ip table.
|
||||
To be only added before the network is started and with
|
||||
the intention of a fresh instance.
|
||||
</p>
|
||||
<pre class="example" id="org79b869e">
|
||||
p2prc --arn --ip <root node ip address> -p <root node port no>
|
||||
</pre>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="outline-container-p2p-module-implementation" class="outline-2">
|
||||
<h2 id="p2p-module-implementation"><span class="section-number-2">5.</span> P2P Module Implementation</h2>
|
||||
@@ -660,7 +674,7 @@ from the TURN server. The flow below describes the workflow.
|
||||
<li>Call <code>/FRPPort</code></li>
|
||||
</ul>
|
||||
|
||||
<pre class="example" id="org1216e2d">
|
||||
<pre class="example" id="org90a2001">
|
||||
http://<turn server ip>:<server port no>/FRPport
|
||||
</pre>
|
||||
|
||||
@@ -749,7 +763,7 @@ p2prc.h p2prc.so
|
||||
Below are a sample set of commands to open the bindings implementation.
|
||||
</p>
|
||||
|
||||
<pre class="example" id="org43e18ca">
|
||||
<pre class="example" id="orgb8690e2">
|
||||
# run
|
||||
cd Bindings/
|
||||
# list files
|
||||
@@ -837,7 +851,7 @@ that convert a go object to JSON string initially and converts it to
|
||||
</li>
|
||||
<li><a id="a-pseudo-code-to-refer-to-the-common-function-implementation-shape-could-be-represented-as"></a>A Pseudo code to refer to the common function implementation shape could be represented as:<br />
|
||||
<div class="outline-text-5" id="text-a-pseudo-code-to-refer-to-the-common-function-implementation-shape-could-be-represented-as">
|
||||
<pre class="example" id="orgfc7fe39">
|
||||
<pre class="example" id="orgd0da451">
|
||||
func <Function name> (output *C.char) {
|
||||
<response>,<error> := <P2PRC function name>(<parameters if needed>)
|
||||
if <error> != nil {
|
||||
@@ -855,8 +869,8 @@ func <Function name> (output *C.char) {
|
||||
<h3 id="current-languages-supported"><span class="section-number-3">6.3.</span> Current languages supported</h3>
|
||||
<div class="outline-text-3" id="text-current-languages-supported">
|
||||
</div>
|
||||
<div id="outline-container-orga857f83" class="outline-4">
|
||||
<h4 id="orga857f83"><span class="section-number-4">6.3.1.</span> Python</h4>
|
||||
<div id="outline-container-org92a1e8c" class="outline-4">
|
||||
<h4 id="org92a1e8c"><span class="section-number-4">6.3.1.</span> Python</h4>
|
||||
<div class="outline-text-4" id="text-6-3-1">
|
||||
</div>
|
||||
<ol class="org-ol">
|
||||
@@ -893,8 +907,8 @@ called from other programming languages.
|
||||
</li>
|
||||
</ol>
|
||||
</div>
|
||||
<div id="outline-container-orgf0d5243" class="outline-4">
|
||||
<h4 id="orgf0d5243"><span class="section-number-4">6.3.2.</span> Haskell</h4>
|
||||
<div id="outline-container-org780e43b" class="outline-4">
|
||||
<h4 id="org780e43b"><span class="section-number-4">6.3.2.</span> Haskell</h4>
|
||||
<div class="outline-text-4" id="text-6-3-2">
|
||||
<p>
|
||||
P2PRC officially supports Haskell bindings and will further support
|
||||
@@ -1006,7 +1020,7 @@ from the TURN server. The flow below describes the workflow.
|
||||
<li>Call <code>/FRPPort</code></li>
|
||||
</ul>
|
||||
|
||||
<pre class="example" id="org19abd64">
|
||||
<pre class="example" id="org910dfb2">
|
||||
http://<turn server ip>:<server port no>/FRPport
|
||||
</pre>
|
||||
|
||||
@@ -1037,12 +1051,12 @@ func main() {
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="outline-container-orgefbf5e1" class="outline-2">
|
||||
<h2 id="orgefbf5e1"><span class="section-number-2">11.</span> Blog posts</h2>
|
||||
<div id="outline-container-org1b92827" class="outline-2">
|
||||
<h2 id="org1b92827"><span class="section-number-2">11.</span> Blog posts</h2>
|
||||
<div class="outline-text-2" id="text-11">
|
||||
</div>
|
||||
<div id="outline-container-org0aff8a2" class="outline-3">
|
||||
<h3 id="org0aff8a2"><span class="section-number-3">11.1.</span> Self host within 5 minutes any program</h3>
|
||||
<div id="outline-container-orgec8979c" class="outline-3">
|
||||
<h3 id="orgec8979c"><span class="section-number-3">11.1.</span> Self host within 5 minutes any program</h3>
|
||||
<div class="outline-text-3" id="text-11-1">
|
||||
<ul class="org-ul">
|
||||
<li>Author: <a href="http://akilan.io/">Akilan Selvacoumar</a></li>
|
||||
@@ -1054,7 +1068,7 @@ func main() {
|
||||
<li>Video tutorial:</li>
|
||||
</ul>
|
||||
|
||||
<div id="org96fc14a" class="figure">
|
||||
<div id="org756aa28" class="figure">
|
||||
<p><a href="https://youtu.be/rN4SiVowg5E" class="video"><img src="https://i3.ytimg.com/vi/rN4SiVowg5E/maxresdefault.jpg" alt="maxresdefault.jpg" class="video" /></a>
|
||||
</p>
|
||||
</div>
|
||||
@@ -1064,8 +1078,8 @@ This is a fun expirement for anyone to try to quickly run a server and
|
||||
quickly do a map port and domain name mapping in a single command.
|
||||
</p>
|
||||
</div>
|
||||
<div id="outline-container-orgc1cd454" class="outline-4">
|
||||
<h4 id="orgc1cd454"><span class="section-number-4">11.1.1.</span> 1. Find a program you want to run</h4>
|
||||
<div id="outline-container-orgd03815a" class="outline-4">
|
||||
<h4 id="orgd03815a"><span class="section-number-4">11.1.1.</span> 1. Find a program you want to run</h4>
|
||||
<div class="outline-text-4" id="text-11-1-1">
|
||||
<p>
|
||||
Let's try to setup a really easy program (Let's do with Linkwarden
|
||||
@@ -1074,7 +1088,7 @@ compose installed on your local machine.
|
||||
</p>
|
||||
</div>
|
||||
<ol class="org-ol">
|
||||
<li><a id="org29864ce"></a>Let's run Linkwarden using docker compose and P2PRC<br />
|
||||
<li><a id="orgc05f730"></a>Let's run Linkwarden using docker compose and P2PRC<br />
|
||||
<div class="outline-text-5" id="text-11-1-1-1">
|
||||
<p>
|
||||
<a href="https://docs.linkwarden.app/self-hosting/installation">Installation instructions</a>:
|
||||
@@ -1163,16 +1177,16 @@ ex: <a href="https://linkwarden.akilan.io">https://linkwarden.akilan.io</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="outline-container-org6a05ac1" class="outline-2">
|
||||
<h2 id="org6a05ac1"><span class="section-number-2">12.</span> Ideas for future potencial features</h2>
|
||||
<div id="outline-container-orgb32e475" class="outline-2">
|
||||
<h2 id="orgb32e475"><span class="section-number-2">12.</span> Ideas for future potencial features</h2>
|
||||
<div class="outline-text-2" id="text-12">
|
||||
<p>
|
||||
Consists of personal loideas for the future of P2PRC.
|
||||
At moment only has main contributors writiing to this.
|
||||
</p>
|
||||
</div>
|
||||
<div id="outline-container-org2136819" class="outline-3">
|
||||
<h3 id="org2136819"><span class="section-number-3">12.1.</span> To support hetrogenous set of Nodes that cannot run P2PRC</h3>
|
||||
<div id="outline-container-org2666d00" class="outline-3">
|
||||
<h3 id="org2666d00"><span class="section-number-3">12.1.</span> To support hetrogenous set of Nodes that cannot run P2PRC</h3>
|
||||
<div class="outline-text-3" id="text-12-1">
|
||||
<p>
|
||||
This stems from a personal issue I have when doing research
|
||||
@@ -1188,8 +1202,8 @@ and would introduce a new layer fault tolerance within a local
|
||||
network nodes.
|
||||
</p>
|
||||
</div>
|
||||
<div id="outline-container-org8f98161" class="outline-4">
|
||||
<h4 id="org8f98161"><span class="section-number-4">12.1.1.</span> Assumptions:</h4>
|
||||
<div id="outline-container-org332fcc8" class="outline-4">
|
||||
<h4 id="org332fcc8"><span class="section-number-4">12.1.1.</span> Assumptions:</h4>
|
||||
<div class="outline-text-4" id="text-12-1-1">
|
||||
<ul class="org-ul">
|
||||
<li>I have a Morello board that cannot run P2PRC</li>
|
||||
@@ -1202,8 +1216,8 @@ as well look into custom tasks into the hetrogenous hardware.</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div id="outline-container-org806bc11" class="outline-4">
|
||||
<h4 id="org806bc11"><span class="section-number-4">12.1.2.</span> Set of interesting possible:</h4>
|
||||
<div id="outline-container-org21a29ac" class="outline-4">
|
||||
<h4 id="org21a29ac"><span class="section-number-4">12.1.2.</span> Set of interesting possible:</h4>
|
||||
<div class="outline-text-4" id="text-12-1-2">
|
||||
<p>
|
||||
We build a cool set possibilities before and use this to build up the implementation
|
||||
@@ -1220,8 +1234,8 @@ weight hypervisors.</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div id="outline-container-org2df764e" class="outline-4">
|
||||
<h4 id="org2df764e"><span class="section-number-4">12.1.3.</span> Implementation</h4>
|
||||
<div id="outline-container-org4947494" class="outline-4">
|
||||
<h4 id="org4947494"><span class="section-number-4">12.1.3.</span> Implementation</h4>
|
||||
<div class="outline-text-4" id="text-12-1-3">
|
||||
<ul class="org-ul">
|
||||
<li>To use implementations similar to <a href="https://linux.die.net/man/1/socat">socat</a> to ensure we can bind address of local
|
||||
@@ -1235,7 +1249,7 @@ other nodes can access the Morello board who have permission access.</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<div id="orga7ceb3b" class="figure">
|
||||
<div id="orgf818690" class="figure">
|
||||
<p><img src="./images/P2PRCRemoteNodes.png" alt="P2PRCRemoteNodes.png" />
|
||||
</p>
|
||||
<p><span class="figure-number">Figure 1: </span>Implementation idea (To be improved upon)</p>
|
||||
@@ -1247,7 +1261,7 @@ other nodes can access the Morello board who have permission access.</li>
|
||||
</div>
|
||||
<div id="postamble" class="status">
|
||||
<p class="author">Author: Akilan</p>
|
||||
<p class="date">Created: 2025-04-25 Fri 23:17</p>
|
||||
<p class="date">Created: 2025-04-28 Mon 23:14</p>
|
||||
<p class="validation"><a href="https://validator.w3.org/check?uri=referer">Validate</a></p>
|
||||
</div>
|
||||
</body>
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="style.css"/>
|
||||
|
||||
#+attr_html: :width 300px
|
||||
[[../artwork/p2prc-logos/Colored-On-Light-Image.png]]
|
||||
[[./Colored-On-Light-Image.png]]
|
||||
|
||||
* Guide through video
|
||||
*** The video below shows the setup and usage of P2PRC.
|
||||
@@ -356,6 +356,14 @@ p2prc --mp <port no to map> --dn <domain name to link Mapped port against> --ra
|
||||
|
||||
--------------
|
||||
|
||||
*** Add root node
|
||||
Adds a root node to P2RRC and overwrites all other nodes in the ip table.
|
||||
To be only added before the network is started and with
|
||||
the intention of a fresh instance.
|
||||
#+begin_example
|
||||
p2prc --arn --ip <root node ip address> -p <root node port no>
|
||||
#+end_example
|
||||
|
||||
* P2P Module Implementation
|
||||
:PROPERTIES:
|
||||
:CUSTOM_ID: p2p-module-implementation
|
||||
|
||||
Reference in New Issue
Block a user