waline-link-interceptor

A plugin of Waline Comment System which can add an intercept page for external links in comments or the nickname.

Waline 评论系统中间页插件。

Language: English | 中文

Install

npm i waline-link-interceptor

Use

// index.js
const Waline = require('@waline/vercel');
const LinkInterceptor = require('waline-link-interceptor');

module.exports = Waline({
    plugins: [
        LinkInterceptor({
            whiteList: [
                'example.com'
            ],
            // blackList: [],
            // interceptorTemplate: `redirect to __URL__`,  
            // redirectUrl: "https://example.com/go.html",
            // encodeFunc: (url) =>{
            //     return "u="+Buffer.from(url).toString('base64')
            // }
        })
    ]
});

Options:

• whiteList (optional): List of allowed domains and subdomains.
• blackList (optional): List of disallowed domains and subdomains.
• interceptorTemplate (optional): Html template of the middle page. You can also set it in environment variable INTERCEPTOR_TEMPLATE.
• redirectUrl (optional): The url of the middle page. You can also set it in environment variable INTERCEPTOR_REDIRECT_URL.
• encodeFunc (optional): Encoding function of external link.

Example: If the url of the middle page is https://example.com/go.html?u=https://external-link.com, the options will be:

LinkInterceptor({
    whiteList: [
        'example.com'
    ],
    redirectUrl: `https://example.com/go.html`,
    encodeFunc: (url) =>{
        return "u="+url;
    }
})

Environment variables have higher priority than options in the plugin. If you deploy your Waline on Vercel, redeploy it after changing environment variables.

More instructions can be seen on this article (Chinese).

Related Plugins

This plugin is based on @waline-plugins/link-interceptor.

License

MIT