Gateway: dynamic image for social sharing · ipfs/kubo#8811

(8 comments) (1 reaction) (0 assignees)Go (13,906 stars) (2,725 forks)batch import

P2dif/mediumgood first issuehelp wantedkind/enhancementneed/community-inputtopic/design-visualtopic/gateway

Description

@lanzafame pointed me at this nice prior art from Github shows how UX can be improved by showing useful data via image:

In IPFS context, a cool improvement would be to provide image-per-CID with:

QR code with shareable URL that could be scanned via phone
- prior art: share.ipfs.io has nice IPFS-branded QR codes (https://github.com/ipfs-shipyard/ipfs-share-files/pull/119), we could do something similar
  - I like the idea of having a branded QR code, as it looks interesting even when not consumed.
    
    QR code playground: https://zpao.github.io/qrcode.react/ URL of the icon: https://share.ipfs.io/favicon-32x32.png
CID breakdown (codec, hash)
dag-pb stats (total size, number of blocks)

Hot take:

If we implement image generation as an alternative response format named share-img (as in, gateway response changing based on parameter ?format=json|cbor|car|block|share-img) then we don't need to inline the data and don't need to deal with relative vs absolute vs cross-origin links (making this work on all gateway types without any additional configuration).

Tech stack: go
Domain: backend
Issue type: feature
Difficulty: 3
Estimated time: over 1 week
Activity status: stale
Clarity: clear
Prerequisites: GoIPFS gatewayImage generation
Newbie friendliness: 50
Research direction: Start by examining the gateway's response format handling in the codebase, particularly how formats like 'json', 'cbor', 'car' are implemented. Then investigate existing QR code generation libraries in Go, such as go qrcode. Also review the linked PR #36 in dir index html for the social sharing markup. Finally, consider the proposed 'share img' format approach and check if there are any open issues or discussions about it.