https://github.com/hyvor/unfold

Unfold URLs. Rich embeds via oEmbed and custom parsers. Link previews by scraping meta tags - as a PHP library or a self-hostable Docker image.
https://github.com/hyvor/unfold

docker-image embed link-preview php unfurl

Last synced: about 2 months ago
JSON representation

Unfold URLs. Rich embeds via oEmbed and custom parsers. Link previews by scraping meta tags - as a PHP library or a self-hostable Docker image.

• Host: GitHub
• URL: https://github.com/hyvor/unfold
• Owner: hyvor
• License: mit
• Created: 2024-10-14T07:26:18.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2024-10-28T10:50:34.000Z (about 2 months ago)
• Last Synced: 2024-10-28T13:24:01.056Z (about 2 months ago)
• Topics: docker-image, embed, link-preview, php, unfurl
• Language: PHP
• Homepage: https://unfold.hyvor.com
• Size: 330 KB
• Stars: 2
• Watchers: 0
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Unfold

Unfold URLs. Rich embeds via oEmbed and custom parsers. Link previews by scraping meta tags - as a PHP library or a

self-hostable Docker image.

## Supported Platforms for embeds

OEmbed:

- X (Twitter)

- TikTok

- Reddit

Custom:

- Youtube

- Facebook

- Instagram

- Github Gist

## Rules for selecting platforms for embeds

- **oEmbed**: If a platform supports oEmbed, it is used.

- **Public Content**: The platform must mainly be used for public content.

    - Facebook posts are okay since the default is usually public

    - Google Drive is not okay as they are meant to be private in most cases

- **10 million active monthly users**: If a platform has less than 10 million registered active monthly users, it won't

  be supported.

- **Demand**: There should be a demand (from website owners) to add a new platform.

## Object Construction

- If the type is link or link_embed and if we can't create the embed any other way, we will try to use og tags to create

  the embed. There is a custom config to disable this fallback.