q/matrix-searxng
1
0
Fork 0
Code Issues 3 Pull Requests Packages Projects Releases Wiki Activity

Clarifying which settings are required and optional in example.js

Browse Source
This commit is contained in:
q
2025-12-15 16:43:07 -05:00
parent 2effd5ec95
commit 2e74637c79
2 changed files with 36 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
example.js
View File

@@ -5,41 +5,65 @@ matrixcs.request(request);
const startupTime = Date.now();
// --------- The following settings are all required: ----------------------
// Provide a matrix ID, access token, and homeserver that the bot will use.
const myUserId = "@glowy:glowers.club"
const myAccessToken = "syt_TotallyMyRealAccessTokenAndNotAFake";
const homeserver = "https://glowers.club";
// Provide the link to SearXNG. Include any directories used in a search query.
const searxng_server = "https://searxng.example.com/searxng"
// --------------------------------------------------------------------------
const matrixClient = sdk.createClient({
baseUrl: "https://glowers.club",
baseUrl: homeserver,
accessToken: myAccessToken,
userId: myUserId
});
const Searx = require('./index.js');
const searx = new Searx(matrixClient)
searx.setSearxInstance(searxng_server);
// --------- The following settings are all optional: ----------------------
// This allows you to use a different Matrix user and homeserver for uploading the image results. If this is not provided then the bot's Matrix ID and homeserver will be used instead.
const uploadMatrixClient = sdk.createClient({
baseUrl: "https://midov.pl",
accessToken: "syt_AnotherRealAccessTokenDoNotCommit",
userId: "@upload_leech:midov.pl"
});
const Searx = require('./index.js');
const searx = new Searx(matrixClient)
searx.setUploadMatrixClient(uploadMatrixClient);
// Set which rooms are not allowed to search for images.
searx.setBlacklistedImgRooms(["!wehateimagesearching:matrix.org", "!wehateittoo:nerdsin.space"]);
// Set which rooms are not allowed to search for images with safesearch disabled.
searx.setBlacklistedUimgRooms(["!sfw:matrix.org", "!church:nerdsin.space"]);
searx.setCooldownImmuneUsers(["@q:glowers.club","@midov:midov.pl"]);
// Set the amount of time in milliseconds users in a room are required to wait between searches (and allow some users to be immune to the cooldown and send as many as they want)
searx.setCooldownImmuneUsers(["@q:glowers.club", "@romanticusgondolaticus:glowers.club"]);
searx.setRoomCooldowns(new Map([
["!sCbWouzHiLEyfOAaSJ:midov.pl",30000]
]));
searx.setSearxInstance("https://searx.example.com");
// Lets you set which URL parameters are used in SearXNG queries. Useful for changing which search engines are included and excluded. See SearXNG's documentation for all of the parameters available.
searx.setSearxParameters("disabled_engines=flickr__images");
// Lets you add a whitelist for a room. When added, only the users in that whitelist will be able to search. Other users will receive an error.
searxng.setRoomUserWhitelists(new Map([
["!blahblahblah:midov.pl",
[
"@q:glowers.club",
"@midek:midov.pl"
"@romanticusgondolaticus:glowers.club"
]
]
]));
// --------------------------------------------------------------------------
matrixClient.on("Room.timeline", function(event, room, toStartOfTimeline) {
if (event.getTs() >= startupTime && event.getType() == "m.room.message" && event.getContent().body != null) {

8
index.js
View File

@@ -274,9 +274,11 @@ Searxng.prototype.handleMessage = function(event, room) {
};
Searxng.prototype.startUploadMatrixClient = function() {
(async () => {
this.uploadMatrixClient.startClient({initialSyncLimit: 1});
})();
if (this.uploadMatrixClient != undefined && this.uploadMatrixClient != this.matrixClient) {
(async () => {
this.uploadMatrixClient.startClient({initialSyncLimit: 1});
})();
}
}
Searxng.prototype.getFormattedHelp = function() {