DECA's IPFS Nodes Setup Guide

The following guide is on how to setup an IPFS node for DECA Protocol Requirements if you want to contribute and provide some infrastructure. This guide is based on Debian 12.1, improvements to our documentation are welcome.

IPFS Instalation

Download the Linux Kubo binary from dist.ipfs.tech.

$ wget https://dist.ipfs.tech/kubo/v0.22.0/kubo_v0.22.0_linux-amd64.tar.gz

Untargz the file:

$ tar -xvzf kubo_v0.22.0_linux-amd64.tar.gz
> x kubo/LICENSE
> x kubo/LICENSE-APACHE
> x kubo/LICENSE-MIT
> x kubo/README.md
> x kubo/install.sh
> x kubo/ipfs

Move into the go-ipfs folder and run the install script:

$ cd kubo

$ sudo bash install.sh

> Moved ./ipfs to /usr/local/bin

Test that IPFS has installed correctly:
```
ipfs --version

> ipfs version 0.22.0
```

Setup ipfs service for deca

First time config setup for a server:

   ipfs init --profile server

This removes local discovery requests

Enable Public Gateway

Modify the GateWay section with the IP Address 0.0.0.0 :

 "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):

    "Swarm": [
      "/ip4/0.0.0.0/tcp/4001",
      "/ip4/0.0.0.0/tcp/4004/ws",
      "/ip6/::/tcp/4001",
      "/ip4/0.0.0.0/udp/4001/quic",
      "/ip6/::/udp/4001/quic"
    ]

Enable Circuit Relay V2

Enable Swarm.RelayService with the following command:

   ipfs config --json Swarm.RelayService.Enabled true

and

   ipfs config --json Swarm.RelayClient.Enabled true

Enable Public Gateway

To enable the public gateway setting your Gateway section should look as the following:

  "Gateway": {
    "APICommands": [],
    "DeserializedResponses": null,
    "HTTPHeaders": {},
    "NoDNSLink": false,
    "NoFetch": false,
    "PathPrefixes": [],
    "PublicGateways":{
      "devteam": {
        "UseSubdomains": false,
        "Paths": [
          "/ipfs",
          "/ipns"
        ]
      }
    },
    "RootRedirect": ""
  },

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:

 $ sudo vim /etc/systemd/system/ipfs.service

[Unit]
Description=IPFS Daemon
After=network.target

[Service]
Type=notify
ExecStart=/usr/local/bin/ipfs daemon --enable-gc=true --migrate=true
ExecStop=/usr/local/bin/ipfs shutdown
User=nodemaster
Restart=on-failure
LimitNOFILE=10240
KillSignal=SIGINT

[Install]
WantedBy=multi-user.target

NOTE: in this example user that runs ipfs is nodemaster, also the ipfs location is at /usr/local/bin/ipfs if you don't know the path, try $ whereis ipfs

Enable the service

 $ sudo systemctl daemon-reload
 $ sudo systemctl enable ipfs.service
 $ sudo systemctl start ipfs.service
 $ sudo systemctl status ipfs.service

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

NOTE: websocket is required for the Orbitdb which hold search.deca.eco our carbon credits distributed database

The Gateway setup: Change the server name for your own domain name:

server {
    listen 80;
    server_name gateway.decentralizescience.org;

    location / {
        proxy_pass http://localhost:8080;
        proxy_set_header Host $host;
        proxy_cache_bypass $http_upgrade;
        allow all;
    }
}

Note: Remember to enable the service and get ssl with certbot

The enabling Secure WebSocket with nginx:

NOTE: Change the server name for your own domain name.

server {
    listen 80; 
    server_name ipfs.decentralizedscience.org;

    location / {
        proxy_pass http://127.0.0.1:4004;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
    }
}

NOTE: Remember to enable the service and get ssl with certbot

Testing

Verify Secure WebSocket connection

Doing an IPFS ping

ipfs ping /dns4/gateway.decentralizedscience.org/443/wss/p2p/12D3KooWQzickgUJ1N9dNZMJpNnFUCHmhndTVgexXnt6dQhPFcEE

PING 12D3KooWQzickgUJ1N9dNZMJpNnFUCHmhndTVgexXnt6dQhPFcEE.
Pong received: time=161.27 ms
Pong received: time=161.13 ms
Pong received: time=161.55 ms

Doing a swarm connect

ipfs swarm connect /dns4/gateway.decentralizedscience.org/443/wss/p2p/12D3KooWQzickgUJ1N9dNZMJpNnFUCHmhndTVgexXnt6dQhPFcEE

connect 12D3KooWQzickgUJ1N9dNZMJpNnFUCHmhndTVgexXnt6dQhPFcEE success