Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/photon-storage/falcon
Falcon is an IPFS node that can join Gateway3 protocol to offer a decentralized IPFS gateway service.
https://github.com/photon-storage/falcon
ipfs ipfs-gateway ipfs-node
Last synced: 2 months ago
JSON representation
Falcon is an IPFS node that can join Gateway3 protocol to offer a decentralized IPFS gateway service.
- Host: GitHub
- URL: https://github.com/photon-storage/falcon
- Owner: photon-storage
- License: mit
- Created: 2023-05-19T05:22:54.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-16T04:04:40.000Z (7 months ago)
- Last Synced: 2024-09-27T17:01:13.487Z (3 months ago)
- Topics: ipfs, ipfs-gateway, ipfs-node
- Language: Go
- Homepage: https://www.gw3.app
- Size: 297 KB
- Stars: 28
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Falcon
Falcon is a port of the official IPFS node implementation [Kubo](https://github.com/ipfs/kubo).
It is one critical component of the [Gateway3](https://www.gw3.io) project, which tries to provide a decentralized IPFS gateway alternative.
The falcon node is able to run by its own and acts like a normal IPFS node.
However, it needs to join the [Gateway3](https://www.gw3.io) protocol in order to make its service accessible from the world.
# Setup
Falcon `checks` runs against major Gateway APIs to ensure they return expected response.
The `checks` run requires subdomain to work.
However, localhost does not support subdomain by default.
We use local `dnsmasq` service to mock the DNS for localhost resolution.
Use brew to install and start `dnsmasq` on MacOS:
```
brew install dnsmasq
sudo brew services start dnsmasq
```
Add the following line to /usr/local/etc/dnsmasq.conf and restart `dnsmasq`.
```
address=/localhost/127.0.0.1
```
Update resolver so that DNS query for domain `localhost` is forwarded to `dnsmasq`:
```
sudo mkdir -p /etc/resolver
```
Create a file /etc/resolver/localhost with content:
```
nameserver 127.0.0.1
```
# How to Run
Run `make` under the repo directory to start Falcon node in loner mode.
The loner mode is the same as prod or dev mode except it does not communicate with other [Gateway3](https://www.gw3.io) services.
In this mode, you can test Falcon's API using end-to-end checks by running `make checks`.
The end-to-end checks report successes or failures for varioues APIs.
It is recommended to run checks against changes made to node.
Run `make prod` or `make dev` to start other modes.