From 6b1edd3d8ac4f38d664f8628596b4a51c6463484 Mon Sep 17 00:00:00 2001 From: Akilan Date: Fri, 25 Apr 2025 23:18:19 +0100 Subject: [PATCH] revert back docs directory --- index.html => Docs/index.html | 168 +++++++++++++++++----------------- index.org => Docs/index.org | 6 +- style.css => Docs/style.css | 0 3 files changed, 87 insertions(+), 87 deletions(-) rename index.html => Docs/index.html (91%) rename index.org => Docs/index.org (99%) rename style.css => Docs/style.css (100%) diff --git a/index.html b/Docs/index.html similarity index 91% rename from index.html rename to Docs/index.html index dce9d62..2cef8e0 100644 --- a/index.html +++ b/Docs/index.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + ‎ @@ -26,12 +26,12 @@

Table of Contents

@@ -108,8 +108,8 @@
  • 6.3. Current languages supported
    • @@ -126,22 +126,22 @@
  • 10. Client mode
    • -
  • 11. Blog posts +
  • 11. Blog posts
    • -
  • 12. Ideas for future potencial features +
  • 12. Ideas for future potencial features @@ -150,26 +150,26 @@
    • -
    -

    Colored-On-Light-Image.png +

    +

    Colored-On-Light-Image.png

    -
    -

    1. Guide through video

    +
    +

    1. Guide through video

    -
    -

    1.0.1. The video below shows the setup and usage of P2PRC.

    +
    +

    1.0.1. The video below shows the setup and usage of P2PRC.

    -
    +

    maxresdefault.jpg

    -
    @@ -258,7 +258,7 @@ Go API to create and interact with the containers. to install docker GPU

    -
    +
     // 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
    @@ -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.

    -
    +
     .\install.bat
    @@ -294,7 +294,7 @@ are not in admin mode when running this.

    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
 
    
 
    
 
      
 
    1. Output:
      
 
      
-
      +
       NAME:
    p2p-rendering-computation - p2p cli application to create and access VMs in other servers
 
@@ -372,7 +372,7 @@ GLOBAL OPTIONS:
 
      
 
      4.0.1. Start as a server
      
 
      
-
      +
       p2prc -s 
 
      
 
      
@@ -380,7 +380,7 @@ p2prc -s
 
      
 
      4.0.2. View server Specification
      
 
      
-
      +
       p2prc --specs=<ip address>
 
      
 
      
@@ -392,7 +392,7 @@ p2prc --specs=<ip address>
 use the --gpu if you know the other machine has a gpu.
 
      
 
-
      +
       p2prc --touch=<server ip address> -p <number of ports> --gpu
 
      
 
      
@@ -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
 
      
 
-
      +
       p2prc --rm=<server ip address> --id=<docker container id> 
 
      
 
      
@@ -412,7 +412,7 @@ p2prc --rm=<server ip address> --id=<docker container id>
 
      
 
      4.0.5. Adding servers to ip table
      
 
      
-
      +
       p2prc --as=<server ip address you want to add> 
 
      
 
      
@@ -420,7 +420,7 @@ p2prc --as=<server ip address you want to add>
 
      
 
      4.0.6. Update ip table
      
 
      
-
      +
       p2prc --us 
 
      
 
      
@@ -428,7 +428,7 @@ p2prc --us
 
      
 
      4.0.7. List Servers
      
 
      
-
      +
       p2prc --ls 
 
      
 
      
@@ -436,7 +436,7 @@ p2prc --ls
 
      
 
      4.0.8. View Network interfaces
      
 
      
-
      +
       p2prc --ni
 
      
 
      
@@ -444,7 +444,7 @@ p2prc --ni
 
      
 
      4.0.9. Viewing Containers created Client side
      
 
      
-
      +
       p2prc --tc
 
      
 
      
@@ -452,7 +452,7 @@ p2prc --tc
 
      
 
      4.0.10. Running plugin
      
 
      
-
      +
       p2prc --plugin <plugin name> --id <container id or group id>
 
      
 
      
@@ -460,7 +460,7 @@ p2prc --plugin <plugin name> --id <container id or group id>
 
      
 
      4.0.11. Create group
      
 
      
-
      +
       p2prc --cgroup
 
      
 
      
@@ -468,7 +468,7 @@ p2prc --cgroup
 
      
 
      4.0.12. Add container to group
      
 
      
-
      +
       p2prc --group <group id> --id <container id>
 
      
 
      
@@ -476,7 +476,7 @@ p2prc --group <group id> --id <container id>
 
      
 
      4.0.13. View groups
      
 
      
-
      +
       p2prc --groups
 
      
 
      
@@ -484,7 +484,7 @@ p2prc --groups
 
      
 
      4.0.14. View specific group
      
 
      
-
      +
       p2prc --group <group id>
 
      
 
      
@@ -492,7 +492,7 @@ p2prc --group <group id>
 
      
 
      4.0.15. Delete container from group
      
 
      
-
      +
       p2prc --rmcgroup --group <group id> --id <container id> 
 
      
 
      
@@ -500,7 +500,7 @@ p2prc --rmcgroup --group <group id> --id <container id>
 
      
 
      4.0.16. Delete entire group
      
 
      
-
      +
       p2prc --rmgroup <group id>
 
      
 
      
@@ -508,7 +508,7 @@ p2prc --rmgroup <group id>
 
      
 
      4.0.17. Pulling plugin from a remote repo
      
 
      
-
      +
       p2prc --pp <repo link>
 
      
 
      
@@ -516,7 +516,7 @@ p2prc --pp <repo link>
 
      
 
      4.0.18. Deleting plugin from the plugin directory
      
 
      
-
      +
       p2prc --rp <plugin name> 
 
      
 
      
@@ -524,28 +524,28 @@ 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>
 
      
 
      
 
        
-
      1. MapPort in remote machine
        
+
      2. 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.
 
        
 
 
        
-[[p2pmoduleArch.png]
+[[p2pmoduleArch.png]
 
        
 
 
        
@@ -660,7 +660,7 @@ from the TURN server. The flow below describes the workflow.
 
      3. Call /FRPPort
        4. 
 
 
-
        +
         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
 
        4. 
 
      4. 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.
 
      5. Call /FRPPort
        6. 
 
 
-
        +
         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
        
 
        
 
 
-
        
+
        
 
        maxresdefault.jpg
 
        
 
        
@@ -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.
 
        
 
        
 
          
-
        1. Let's run Linkwarden using docker compose and P2PRC
          
+
        2. 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.
        6. 
 
 
      
 
      
-
      
-
      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.
        • 
 
      
 
 
-
      
-
      P2PRCRemoteNodes.png
+
      
+
      P2PRCRemoteNodes.png
 
      
 
      Figure 1: Implementation idea (To be improved upon)
      
 
      
@@ -1247,7 +1247,7 @@ other nodes can access the Morello board who have permission access.
      2. 
 
    
 
    
 
    Author: Akilan
    
-
    Created: 2025-04-25 Fri 23:06
    
+
    Created: 2025-04-25 Fri 23:17
    
 
    Validate
    
 
    
 
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