Download the PHP package datlechin/flarum-link-preview without Composer
On this page you can find all versions of the php package datlechin/flarum-link-preview. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Table of contents
Download datlechin/flarum-link-preview
More information about datlechin/flarum-link-preview
Files in datlechin/flarum-link-preview
Download datlechin/flarum-link-preview
More information about datlechin/flarum-link-preview
Files in datlechin/flarum-link-preview
Vendor datlechin
Package flarum-link-preview
Short Description Show a preview card for links in posts, with the page's title, description and image.
License MIT
Homepage https://nqd.vn
Package flarum-link-preview
Short Description Show a preview card for links in posts, with the page's title, description and image.
License MIT
Homepage https://nqd.vn
FAQ
After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.
Example:
Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories.
In this case some credentials are needed to access such packages.
Please use the auth.json textarea to insert credentials, if a package is coming from a private repository.
You can look here for more information.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?
Informations about the package flarum-link-preview
Link Preview
A Flarum extension. Shows a preview card for links in posts, with the page's title, description and image. Your forum fetches the page itself, so links are not sent to a third-party service.
Features
- Preview cards for links in posts and private messages.
- A large card with the page's image, or a compact card, depending on the page's metadata.
- Links to your own forum (discussions, users, tags and the index) are previewed from the database, and only show what the reader is allowed to see.
- Allowed and blocked site lists.
- Users can turn off previews in their settings.
- Shows the click count when Link Clicks is installed.
- Other extensions can add cards for their own pages.
Installation
Requires Flarum 2.0 and PHP 8.3 or later.
Updating
Configuration
| Setting | Default | Description |
|---|---|---|
| Open links in a new tab | On | Opens links to other sites in a new tab. |
| Fall back to Google for site icons | Off | Uses Google's favicon service when a site has no icon. |
| Preview links to this forum | On | Previews discussions, users, tags and other forum pages from the database. |
| Skip links to media files | Off | Does not preview links to image, audio and video files. |
| Previews per post | 5 | The maximum number of previews in one post. |
| Fetch previews in batches | On | Requests the previews on a page together instead of one request per link. |
| Cache duration (minutes) | 60 | How long a preview is cached. 0 disables caching. |
| Allowed sites | Empty | If set, only these sites are previewed. |
| Blocked sites | Empty | These sites are never previewed. |
Allowed and blocked sites
Enter one site per line, or separate them with commas.
| Entry | Matches |
|---|---|
example.com |
example.com and its subdomains |
example.com/news |
example.com/news and the pages under it |
*.example.com |
subdomains of example.com, but not example.com itself |
Entries match the whole host name, so example.com does not match notexample.com.
Which links are previewed
- A link is previewed when its text is the URL itself. A link with its own text, such as
[the docs](https://example.com), is not. - If the link is on a line of its own, the card replaces it. Otherwise the card is added at the end of the paragraph.
- A link to a discussion on this forum is only previewed when it is on a line of its own.
- Links in quotes, code blocks and mentions are not previewed.
- If a preview cannot be loaded, the link is left as it is.
Security
Anyone who can read a post can make your server fetch a URL, so the extension limits what it fetches:
- Private, loopback and reserved IP addresses are blocked, for IPv4 and IPv6. This uses Symfony's
NoPrivateNetworkHttpClient, and the connection uses the address that was checked. - Only
httpandhttpsURLs on ports 80, 443, 8080 and 8443. - Up to 3 redirects. Each redirect is checked again.
- Up to 2 MiB of HTML per page, and reading stops at the end of
<head>. Each page has an 8-second timeout. - 30 preview requests per minute for each user, or for each IP address for guests.
- Failed previews are cached for up to 10 minutes.
For developers
Adding a card for your pages
Register a card for a forum route name. The route is matched by Flarum's router.
- Return
nullif the page does not exist or the actor cannot see it. - The forum's title and favicon are added for you.
Meta::count()takes the translation key of a plural string in your own locale file.- If a card throws an exception, it is logged and skipped. The other previews in the request are still returned.
Previewing links in your own content
Posts and private messages are handled already. To preview links in content that your own component renders, register the component and a selector for the elements that hold the content:
- Get the extender inside the initializer, not with a top-level
ext:import. Your script may load before Link Preview's. - The component can be a module path or the component class. Use a module path for a lazy-loaded component.
- The second argument is a CSS selector, or a function that receives the vnode and returns the elements.
Changing the HTTP client
Pages are fetched with the client bound as datlechin-link-preview.transport in the container. To add options, such as a proxy, extend it in a service provider:
The private network check is always applied on top of this client.
Links
All versions of flarum-link-preview with dependencies
PHP Build Version
Package Version
Requires
php Version
^8.3
flarum/core Version ^2.0.0-rc.7
symfony/http-client Version ^7.4
symfony/http-foundation Version ^7.4
ext-dom Version *
ext-mbstring Version *
ext-json Version *
flarum/core Version ^2.0.0-rc.7
symfony/http-client Version ^7.4
symfony/http-foundation Version ^7.4
ext-dom Version *
ext-mbstring Version *
ext-json Version *
The package datlechin/flarum-link-preview contains the following files
Loading the files please wait ...