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

Adds Markdown Alerts for Notes

Browse Source 
Reference: https://github.com/orgs/community/discussions/16925

And adds some minor fixes
This commit is contained in:
CSK
2024-03-12 14:41:29 +04:00
committed by GitHub
parent 00629b604f
commit 0c86c6e673
8 changed files with 37 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
Docs/ClientImplementation.md
View File

@@ -83,8 +83,6 @@ show a sample structure of file ```grouptrackcontainer.json```.
```
The default path to the container tracker is ```client/trackcontainers/grouptrackcontainer.json```.
### Note:
The group id will be auto-generated and will have its own prefix in the start which will mostly be ```grp<UUID>```.
When a container is removed using the command. ```p2prc --rm <IP Address> --id <Container id>```. It will be automatically deleted
from the groups it exists in.
> [!NOTE]
> The group id will be auto-generated and will have its own prefix in the start which will mostly be ```grp<UUID>```.
> When a container is removed using the command. ```p2prc --rm <IP Address> --id <Container id>```. It will be automatically deleted from the groups it exists in.

11
Docs/Installation.md
View File

@@ -232,12 +232,13 @@ This feature is still Under Development:
- Generate Test Case Ansible file
- ```make testcases```
- Enter inside plugin directory and run tests.<br>
**Note:** That docker needs to installed and needs to run without
sudo. Refer the section [Install Docker](#install-docker).
- ```cd plugin```
- ```go test .```
> [!NOTE]
> That docker needs to installed and needs to run without
> sudo. Refer the section [Install Docker](#install-docker).
> - ```cd plugin```
> - ```go test .```
---
### Next Chapter: [Abstractions](Abstractions.md)

4
Docs/P2P.md
View File

@@ -23,5 +23,5 @@ In this repository the P2P module has been designed from sratch at the point of
- Taking to nodes behind NAT. [More about the implementation](NAT-Traversal)...
## Note:
If you are running in server mode it is recommended to use [DMZ](https://routerguide.net/when-and-how-to-setup-dmz-host-for-home-use/) to bypass the [NAT](https://en.wikipedia.org/wiki/Network_address_translation).
> [!NOTE]
> If you are running in server mode it is recommended to use [DMZ](https://routerguide.net/when-and-how-to-setup-dmz-host-for-home-use/) to bypass the [NAT](https://en.wikipedia.org/wiki/Network_address_translation).

33
Docs/PluginImplementation.md
View File

@@ -54,22 +54,23 @@ nodes to execute Ansible instructions. In this project this file needs to be set
go code or binary will populate this file automatically with the appropriate information required to connect to local or
remote containers.
#### Note: Add as exactly specified below
```
all:
vars:
ansible_python_interpreter: /usr/bin/python3 // Path to your python 3 interpreter
main:
hosts:
host1:
// Note: These values will be automatically overwritten
// by the Go functions
ansible_host: 0.0.0.0
ansible_port: 39269
ansible_user: master
ansible_ssh_pass: password
ansible_sudo_pass: password
```
> [!NOTE]
> Add as exactly specified below:
> ```
>all:
> vars:
> ansible_python_interpreter: /usr/bin/python3 // Path to your python 3 interpreter
>main:
> hosts:
> host1:
> // Note: These values will be automatically overwritten
> // by the Go functions
> ansible_host: 0.0.0.0
> ansible_port: 39269
> ansible_user: master
> ansible_ssh_pass: password
> ansible_sudo_pass: password
>```
## Ports.json
The ```ports.json``` file is intended to mention the number of ports required