linegrok

English | 日本語

linegrok performs both starting ngrok and acquiring URL, and updating the Webhook URL in LINE Developers console at the same time.
If you have not authenticated ngrok, the URL will become invalid after two hours (as of 2023/3/8), but linegrok will automatically regenerate the ngrok URL and update the Webhook URL every 1.5 hours.

Installation

$ npm install linegrok

Usage

Run linegrok by passing the Client and port for the LINE Bot as arguments.
Then the ngrok process will start automatically and the generated ngrok URL will be set as the Webhook URL for the channel associated with the Client.

const { linegrok } = require("linegrok")
const { Client, middleware } = require("@line/bot-sdk")

const port = process.env.PORT || 3000

const config = {
    channelAccessToken: process.env.CHANNEL_ACCESS_TOKEN,
    channelSecret: process.env.CHANNEL_SECRET,
}

const client = new Client(config)

linegrok({ client, port })

...

As an example, the code for a parrot bot would be as follows.
(Please set the CHANNEL_ACCESS_TOKEN and CHANNEL_SECRET as environment variables and try running it)

const express = require("express")
const { Client, middleware } = require("@line/bot-sdk")
const { linegrok } = require("linegrok")

const port = process.env.PORT || 3000
const config = {
    channelAccessToken: process.env.CHANNEL_ACCESS_TOKEN,
    channelSecret: process.env.CHANNEL_SECRET,
}
const client = new Client(config)

linegrok({ client, port })



const app = express()
app.post("/", middleware(config), (req, res) => {
    handleEvents(req.body.events)
    res.send({ status: 200 })
})
app.listen(port, () => console.log(`Start server!`))



const handleEvents = events => {
    events.forEach(event => {
        switch (event.type) {
            case "message": client.replyMessage(event.replyToken, {
                type: "text",
                text: event.message.text,
            }); break
        }
    })
}

Options

Option	Required	Default	Description
client	✔	-	Specify the Client for the LINE Bot. The Webhook URL for the channel associated with this Client will be automatically updated.
port	✔	-	Specifies the port number of the bot server.
path		"/"	Specifies the path of the Webhook URL.
authtoken		undefined	Specifies the ngrok Auth Token. If an Auth Token is specified, the URL is not updated periodically.
region		"ja"	Specifies the region of ngrok.
interval		5,400,000	Specify the interval to restart ngrok in msec. The default value is 1.5 hours.

License

MIT