DECA
/
docs
2
0
Fork 1
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

initial commit #3

Merged
p1r0 merged 3 commits from itzelot01/docs:develop into develop 2023-10-26 21:02:08 +00:00
Conversation 1 Commits 3 Files Changed 7 +65 -19
5 changed files with 65 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 6c1e603954 - Show all commits

4
README.md
View File

@ -112,6 +112,7 @@ You can view the page on any browser using the following link <http://127.0.0.1:
> NOTE: If you want to access remotely use the `mdbook serve -n 0.0.0.0` which means any IP address can access the DECA Docs project. > NOTE: If you want to access remotely use the `mdbook serve -n 0.0.0.0` which means any IP address can access the DECA Docs project.
## Contribute (Usage) ## Contribute (Usage)
>ToDo
@ -120,6 +121,9 @@ You can view the page on any browser using the following link <http://127.0.0.1:
* [Telegram](https://t.me/deca_currency/1) * [Telegram](https://t.me/deca_currency/1)
* [Matrix](https://matrix.to/#/#DECA:matrix.org) * [Matrix](https://matrix.to/#/#DECA:matrix.org)
***Developers***
- [itzelot01](mailto:itzeltellez59@aragon.unam.mx)
## License ## License
``` ```

6
index.html
View File

@ -83,7 +83,7 @@
<nav id="sidebar" class="sidebar" aria-label="Table of contents"> <nav id="sidebar" class="sidebar" aria-label="Table of contents">
<div class="sidebar-scrollbox"> <div class="sidebar-scrollbox">
<ol class="chapter"><li class="chapter-item expanded affix "><a href="../index.html" class="active">Introduction</a></li><li class="chapter-item expanded "><a href="chapter_1.html"><strong aria-hidden="true">1.</strong> Chapter 1</a></li><li class="chapter-item expanded "><a href="IPFSNodes.html"><strong aria-hidden="true">2.</strong> IPFSNodes</a></li></ol> <ol class="chapter"><li class="chapter-item expanded affix "><a href="../index.html" class="active">Introduction</a></li><li class="chapter-item expanded "><a href="IPFSNodes.html"><strong aria-hidden="true">1.</strong> IPFSNodes</a></li></ol>
</div> </div>
<div id="sidebar-resize-handle" class="sidebar-resize-handle"></div> <div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
</nav> </nav>
@ -285,7 +285,7 @@ Free Documentation License&quot;.
<nav class="nav-wrapper" aria-label="Page navigation"> <nav class="nav-wrapper" aria-label="Page navigation">
<!-- Mobile navigation buttons --> <!-- Mobile navigation buttons -->
<a rel="next" href="chapter_1.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right"> <a rel="next" href="IPFSNodes.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<i class="fa fa-angle-right"></i> <i class="fa fa-angle-right"></i>
</a> </a>
@ -296,7 +296,7 @@ Free Documentation License&quot;.
<nav class="nav-wide-wrapper" aria-label="Page navigation"> <nav class="nav-wide-wrapper" aria-label="Page navigation">
<a rel="next" href="chapter_1.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right"> <a rel="next" href="IPFSNodes.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<i class="fa fa-angle-right"></i> <i class="fa fa-angle-right"></i>
</a> </a>
</nav> </nav>

72
src/IPFSNodes.md
View File

@ -47,7 +47,17 @@ First time config setup for a server:
``` ```
> This removes local discovery requests > This removes local discovery requests
### Setup Circuit Relay V2 ### Enable Public Gateway
Modify the GateWay section with the IP Address 0.0.0.0 :
```sh
"Addresses": {
"API": "/ip4/127.0.0.1/tcp/5001",
"Announce": [],
"AppendAnnounce": [],
"Gateway": "/ip4/0.0.0.0/tcp/8080",
```
### Enable WebSocket on port 4004
Add swarm address in the config (specifically the ws line): Add swarm address in the config (specifically the ws line):
```sh ```sh
"Swarm": [ "Swarm": [
@ -59,18 +69,42 @@ Add swarm address in the config (specifically the ws line):
] ]
``` ```
### Enable Circuit Relay V2
Enable Swarm.RelayService with the following command: Enable Swarm.RelayService with the following command:
```sh ```sh
ipfs config --json Swarm.RelayService.Enabled true ipfs config --json Swarm.RelayService.Enabled true
``` ```
and and
```sh ```sh
ipfs config --json Swarm.RelayClient.Enabled true ipfs config --json Swarm.RelayClient.Enabled true
``` ```
## Set IPFS as a daemon and Nginx Reverse Proxy ### Enable Public Gateway
To enable the public gateway setting your Gateway section should look as the
following:
```sh
"Gateway": {
"APICommands": [],
"DeserializedResponses": null,
"HTTPHeaders": {},
"NoDNSLink": false,
"NoFetch": false,
"PathPrefixes": [],
"PublicGateways":{
"devteam": {
"UseSubdomains": false,
"Paths": [
"/ipfs",
"/ipns"
]
}
},
"RootRedirect": ""
},
```
### Set IPFS as a daemon ### Set IPFS as a daemon
Copy the following lines after the `sudo vim... command`, modify user and path to ipfs so that it matches with your system and user that runs ipfs: Copy the following lines after the `sudo vim... command`, modify user and path to ipfs so that it matches with your system and user that runs ipfs:
@ -80,12 +114,16 @@ Copy the following lines after the `sudo vim... command`, modify user and path t
[Unit] [Unit]
Description=IPFS Daemon Description=IPFS Daemon
After=network.target
[Service] [Service]
ExecStart=/usr/local/bin/ipfs daemon --enable-pubsub-experiment Type=notify
ExecStart=/usr/local/bin/ipfs daemon --enable-gc=true --migrate=true
ExecStop=/usr/local/bin/ipfs shutdown
User=nodemaster User=nodemaster
Restart=always Restart=on-failure
LimitNOFILE=10240 LimitNOFILE=10240
KillSignal=SIGINT
[Install] [Install]
WantedBy=multi-user.target WantedBy=multi-user.target
@ -103,7 +141,12 @@ Enable the service
``` ```
**NOTE: service must be set as active (running), if not please verify the preview steps** **NOTE: service must be set as active (running), if not please verify the preview steps**
## Set IPFS as a daemon and Nginx Reverse Proxy
### Nginx Reverse Proxy for a public gateway and websocket ### Nginx Reverse Proxy for a public gateway and websocket
> NOTE: websocket is required for the Orbitdb which hold search.deca.eco
> our carbon credits distributed database
The Gateway setup: The Gateway setup:
Change the server name for your own domain name: Change the server name for your own domain name:
@ -113,7 +156,7 @@ Change the server name for your own domain name:
server_name gateway.decentralizescience.org; server_name gateway.decentralizescience.org;
location / { location / {
proxy_pass http://localhost:4001; proxy_pass http://localhost:8080;
proxy_set_header Host $host; proxy_set_header Host $host;
proxy_cache_bypass $http_upgrade; proxy_cache_bypass $http_upgrade;
allow all; allow all;
@ -146,7 +189,7 @@ The enabling Secure WebSocket with nginx:
### Verify Secure WebSocket connection ### Verify Secure WebSocket connection
Doing an IPFS ping Doing an IPFS ping
```sh ```sh
ipfs ping /dns4/ipfs.decentralizedscience.org/443/wss/p2p/12D3KooWQzickgUJ1N9dNZMJpNnFUCHmhndTVgexXnt6dQhPFcEE ipfs ping /dns4/gateway.decentralizedscience.org/443/wss/p2p/12D3KooWQzickgUJ1N9dNZMJpNnFUCHmhndTVgexXnt6dQhPFcEE
PING 12D3KooWQzickgUJ1N9dNZMJpNnFUCHmhndTVgexXnt6dQhPFcEE. PING 12D3KooWQzickgUJ1N9dNZMJpNnFUCHmhndTVgexXnt6dQhPFcEE.
Pong received: time=161.27 ms Pong received: time=161.27 ms
@ -155,18 +198,18 @@ Doing an IPFS ping
``` ```
Doing a swarm connect Doing a swarm connect
```sh ```sh
ipfs swarm connect /dns4/ipfs.decentralizedscience.org/443/wss/p2p/12D3KooWQzickgUJ1N9dNZMJpNnFUCHmhndTVgexXnt6dQhPFcEE ipfs swarm connect /dns4/gateway.decentralizedscience.org/443/wss/p2p/12D3KooWQzickgUJ1N9dNZMJpNnFUCHmhndTVgexXnt6dQhPFcEE
connect 12D3KooWQzickgUJ1N9dNZMJpNnFUCHmhndTVgexXnt6dQhPFcEE success connect 12D3KooWQzickgUJ1N9dNZMJpNnFUCHmhndTVgexXnt6dQhPFcEE success
``` ```
### check the IPFS public Gateway: ### check the IPFS public Gateway:
Browse by adding `/ipns/deca.eco/` to your gateway address: Browse by adding `/ipns/docs.deca.eco/` to your gateway address:
> You should see the IPFS official web3 website > You should see the IPFS official web3 website
Example: Example:
https://gateway.decentralizedscience.org/ipns/deca.eco/ https://gateway.decentralizedscience.org/ipns/docs.deca.eco/
## License ## License
@ -186,9 +229,10 @@ https://gateway.decentralizedscience.org/ipns/deca.eco/
## References ## References
1. [Install IPFS Kubo](https://docs.ipfs.tech/install/command-line/#install-official-binary-distributions) 1. [Install IPFS Kubo](https://docs.ipfs.tech/install/command-line/#install-official-binary-distributions)
2. [file transfer](https://github.com/ipfs/go-ipfs/blob/master/docs/file-transfer.md) 2. [Hosting a public IPFS gateway](https://gist.github.com/NatoBoram/09d244ab02af16fecb62b917f7bee3c0)
3. [circuit relay](https://docs.libp2p.io/concepts/circuit-relay/) 3. [file transfer](https://github.com/ipfs/go-ipfs/blob/master/docs/file-transfer.md)
4. [understanding circuit relay](https://blog.aira.life/understanding-ipfs-circuit-relay-ccc7d2a39) 4. [circuit relay](https://docs.libp2p.io/concepts/circuit-relay/)
5. [experimental features](https://github.com/ipfs/go-ipfs/blob/master/docs/experimental-features.md) 5. [understanding circuit relay](https://blog.aira.life/understanding-ipfs-circuit-relay-ccc7d2a39)
6. [experimental features](https://github.com/ipfs/go-ipfs/blob/master/docs/experimental-features.md)

1
src/SUMMARY.md
View File

@ -2,5 +2,4 @@
[Introduction](../README.md) [Introduction](../README.md)
- [Chapter 1](./chapter_1.md)
- [IPFSNodes](./IPFSNodes.md) - [IPFSNodes](./IPFSNodes.md)

1
src/chapter_1.md
View File

@ -1 +0,0 @@
# Chapter 1