+
+
-
-
1. Guide through video
+
+
-
1. Guide through video
-
3.2.4. Add appropriate paths to
1.0.1. The video below shows the setup and usage of P2PRC.
+
+
@@ -294,7 +294,7 @@ are not in admin mode when running this.
1.0.1. The video below shows the setup and usage of P2PRC.
-
-
+
-
1.0.2. Source code: https://github.com/Akilan1999/p2p-rendering-computation
+
+
1.0.2. Source code: https://github.com/Akilan1999/p2p-rendering-computation
@@ -258,7 +258,7 @@ Go API to create and interact with the containers.
to install docker GPU
-
@@ -284,7 +284,7 @@ To set up P2PRC on Windows, simply run this batch file. Make sure you
are not in admin mode when running this.
-+// Do ensure that the docker command does not need sudo to run sudo chmod 666 /var/run/docker.sock@@ -272,7 +272,7 @@ To set up the internal dependencies and build the entire go code into a single binary -+make
+.\install.bat
3.2.4. Add appropriate paths to .bashrc
-
+export P2PRC=/<PATH>/p2p-rendering-computation export PATH=/<PATH>/p2p-rendering-computation:${PATH}@@ -303,14 +303,14 @@ export PATH=/<PATH>/p2p-rendering-computation:${PATH}3.2.5. Test if binary works
-+p2prc --help
- Output:
-+NAME: p2p-rendering-computation - p2p cli application to create and access VMs in other servers @@ -372,7 +372,7 @@ GLOBAL OPTIONS:@@ -412,7 +412,7 @@ p2prc --rm=<server ip address> --id=<docker container id>4.0.1. Start as a server
-@@ -380,7 +380,7 @@ p2prc -s+p2prc -s@@ -404,7 +404,7 @@ p2prc --touch=<server ip address> -p <number of ports> --gpu The docker id is present in the output where you create a container -4.0.2. View server Specification
-@@ -392,7 +392,7 @@ p2prc --specs=<ip address> use the+p2prc --specs=<ip address>--gpuif you know the other machine has a gpu. -+p2prc --touch=<server ip address> -p <number of ports> --gpu+p2prc --rm=<server ip address> --id=<docker container id>4.0.5. Adding servers to ip table
-@@ -420,7 +420,7 @@ p2prc --as=<server ip address you want to add>+p2prc --as=<server ip address you want to add>4.0.6. Update ip table
-@@ -428,7 +428,7 @@ p2prc --us+p2prc --us4.0.7. List Servers
-@@ -436,7 +436,7 @@ p2prc --ls+p2prc --ls4.0.8. View Network interfaces
-@@ -444,7 +444,7 @@ p2prc --ni+p2prc --ni4.0.9. Viewing Containers created Client side
-@@ -452,7 +452,7 @@ p2prc --tc+p2prc --tc4.0.10. Running plugin
-@@ -460,7 +460,7 @@ p2prc --plugin <plugin name> --id <container id or group id>+p2prc --plugin <plugin name> --id <container id or group id>4.0.11. Create group
-@@ -468,7 +468,7 @@ p2prc --cgroup+p2prc --cgroup4.0.12. Add container to group
-@@ -476,7 +476,7 @@ p2prc --group <group id> --id <container id>+p2prc --group <group id> --id <container id>4.0.13. View groups
-@@ -484,7 +484,7 @@ p2prc --groups+p2prc --groups4.0.14. View specific group
-@@ -492,7 +492,7 @@ p2prc --group <group id>+p2prc --group <group id>4.0.15. Delete container from group
-@@ -500,7 +500,7 @@ p2prc --rmcgroup --group <group id> --id <container id>+p2prc --rmcgroup --group <group id> --id <container id>4.0.16. Delete entire group
-@@ -508,7 +508,7 @@ p2prc --rmgroup <group id>+p2prc --rmgroup <group id>4.0.17. Pulling plugin from a remote repo
-@@ -516,7 +516,7 @@ p2prc --pp <repo link>+p2prc --pp <repo link>4.0.18. Deleting plugin from the plugin directory
-@@ -524,28 +524,28 @@ p2prc --rp <plugin name>+p2prc --rp <plugin name>-4.0.19. Added custom metadata about the current node
-+p2prc --amd "custom metadata"-4.0.20. MapPort and link to domain name
++4.0.20. MapPort and link to domain name
Allows to expose remote ports from a machine in the P2P network.
-+p2prc --mp <port no to map> --dn <domain name to link Mapped port against>-
- MapPort in remote machine
+- MapPort in remote machine
This is to ensure ports on remote machines on the P2PRC can be easily opened.
-+p2prc --mp <port no to map> --dn <domain name to link Mapped port against> --ra <remote server address>@@ -567,7 +567,7 @@ servers with optimal performance, enhancing their overall network experience.-[[
] +[[
]
@@ -660,7 +660,7 @@ from the TURN server. The flow below describes the workflow.
- Call
-/FRPPort+http://<turn server ip>:<server port no>/FRPport@@ -749,7 +749,7 @@ p2prc.h p2prc.so Below are a sample set of commands to open the bindings implementation. -+# run cd Bindings/ # list files @@ -837,7 +837,7 @@ that convert a go object to JSON string initially and converts it to- A Pseudo code to refer to the common function implementation shape could be represented as:
-+func <Function name> (output *C.char) { <response>,<error> := <P2PRC function name>(<parameters if needed>) if <error> != nil { @@ -855,8 +855,8 @@ func <Function name> (output *C.char) {6.3. Current languages supported
--6.3.1. Python
++-6.3.1. Python
@@ -893,8 +893,8 @@ called from other programming languages.
--6.3.2. Haskell
++6.3.2. Haskell
P2PRC officially supports Haskell bindings and will further support @@ -1006,7 +1006,7 @@ from the TURN server. The flow below describes the workflow.
- Call
-/FRPPort+http://<turn server ip>:<server port no>/FRPport@@ -1037,12 +1037,12 @@ func main() {-11. Blog posts
++11. Blog posts
--11.1. Self host within 5 minutes any program
++11.1. Self host within 5 minutes any program
-
- Author: Akilan Selvacoumar
@@ -1054,7 +1054,7 @@ func main() {- Video tutorial:
+-@@ -1064,8 +1064,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.
--11.1.1. 1. Find a program you want to run
++11.1.1. 1. Find a program you want to run
Let's try to setup a really easy program (Let's do with Linkwarden @@ -1074,7 +1074,7 @@ compose installed on your local machine.
-
- Let's run Linkwarden using docker compose and P2PRC
+- Let's run Linkwarden using docker compose and P2PRC
Installation instructions: @@ -1163,16 +1163,16 @@ ex: https://linkwarden.akilan.io
-12. Ideas for future potencial features
++12. Ideas for future potencial features
-Consists of personal loideas for the future of P2PRC. At moment only has main contributors writiing to this.
-12.1. To support hetrogenous set of Nodes that cannot run P2PRC
++12.1. To support hetrogenous set of Nodes that cannot run P2PRC
-This stems from a personal issue I have when doing research @@ -1188,8 +1188,8 @@ and would introduce a new layer fault tolerance within a local network nodes.
-12.1.1. Assumptions:
++-12.1.1. Assumptions:
- I have a Morello board that cannot run P2PRC
@@ -1202,8 +1202,8 @@ as well look into custom tasks into the hetrogenous hardware.-12.1.2. Set of interesting possible:
++-12.1.2. Set of interesting possible:
We build a cool set possibilities before and use this to build up the implementation @@ -1220,8 +1220,8 @@ weight hypervisors.
-12.1.3. Implementation
++12.1.3. Implementation
-
- To use implementations similar to socat to ensure we can bind address of local @@ -1235,8 +1235,8 @@ other nodes can access the Morello board who have permission access.
-diff --git a/index.org b/Docs/index.org similarity index 99% rename from index.org rename to Docs/index.org index eb6f536..ed74e4f 100644 --- a/index.org +++ b/Docs/index.org @@ -4,7 +4,7 @@ #+HTML_HEAD: #+attr_html: :width 300px -[[./artwork/p2prc-logos/Colored-On-Light-Image.png]] +[[../artwork/p2prc-logos/Colored-On-Light-Image.png]] * Guide through video *** The video below shows the setup and usage of P2PRC. @@ -367,7 +367,7 @@ to determine upload and download speeds. This valuable information enables users servers with optimal performance, enhancing their overall network experience. #+caption: UML diagram of P2P module -[[file:Docs/images/p2pmoduleArch.png] +[[file:./images/p2pmoduleArch.png] The peer to peer implementation was built from scratch. This is because other peer to peer libraries were on the implementation of the @@ -909,4 +909,4 @@ network nodes. other nodes can access the Morello board who have permission access. #+CAPTION: Implementation idea (To be improved upon) - [[./Docs/images/P2PRCRemoteNodes.png]] + [[./images/P2PRCRemoteNodes.png]] diff --git a/style.css b/Docs/style.css similarity index 100% rename from style.css rename to Docs/style.css
+
+@@ -1247,7 +1247,7 @@ other nodes can access the Morello board who have permission access.
Figure 1: Implementation idea (To be improved upon)