me/p2p-rendering-computation
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

added docs for architecture

Browse Source
This commit is contained in:
Akilan Selvacoumar
2021-05-09 19:36:55 +04:00
parent 279e29d5b7
commit 1031c44d68
11 changed files with 112 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
Docs/Installation.md
View File

@@ -6,6 +6,7 @@ Over here we will cover the basic steps to get the server and client side runnin
The entire the implementation of this project is done using Go lang.
Thus, we need go lang to compile to code to a binary file.
[Instructions to install Go lang](https://golang.org/doc/install)
### Install Docker
In this project the choice of virtualization is Docker due to it's wide usage
in the developer community. In the server module we use the Docker Go API to create and
@@ -17,11 +18,11 @@ interact with the containers.
Do ensure that the docker command does not need sudo to run
````
### Build Project
### Build Project and install project
To set up the internal dependencies and build the entire go code
into a single binary
```
make build
make install
```
### Test if binary works
@@ -43,12 +44,19 @@ COMMANDS:
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--Mode value Specifies mode of running (default: "client") [$P2P_MODE]
--ListServers List servers which can render tasks (default: false) [$LIST_SERVERS]
--CreateVM value Creates Docker container on the selected server [$CREATE_VM]
--FilePath Testing for absolute path (default: false)
--help, -h show help (default: false)
--version, -v print the version (default: false)
--Mode value Specifies mode of running (default: "client") [$P2P_MODE]
--UpdateServerList Update List of Server available based on servers iptables (default: false) [$UPDATE_SERVER_LIST]
--ListServers List servers which can render tasks (default: false) [$LIST_SERVERS]
--CreateVM value Creates Docker container on the selected server [$CREATE_VM]
--RemoveVM value Stop and Remove Docker container [$REMOVE_VM]
--ID value Docker Container ID [$ID]
--Ports value Number of ports to open for the Docker Container [$NUM_PORTS]
--GPU Create Docker Containers to access GPU (default: false) [$USE_GPU]
--Specs value Specs of the server node [$SPECS]
--SetDefaultConfig Sets a default configuration file (default: false) [$SET_DEFAULT_CONFIG]
--help, -h show help (default: false)
--version, -v print the version (default: false)
```