You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,15 @@
1
-
# Discourse Dark Visitors Plugin
1
+
# Dark Visitors: Discourse Known Agents Plugin
2
2
3
-
This [Discourse](https://discourse.com) plugin adds an integration with [Dark Visitors](https://darkvisitors.com).
4
-
Via Dark Visitors you will get some insights into which bots or scrapers visit your forum.
3
+
This [Discourse](https://discourse.com) plugin adds an integration with [Known Agents](https://knownagents.com), previously called: _Dark Visitors_.
4
+
Via Known Agents you will get some insights into which bots or scrapers visit your forum.
5
5
6
6
It provides the following features:
7
7
8
8
- augmenting robots.txt
9
9
- server analytics
10
10
- client analytics
11
11
12
-
In order to use this plugin you need to sign up with [Dark Visitors](https://darkvisitors.com).
12
+
In order to use this plugin you need to sign up with [Known Agents](https://knownagents.com).
13
13
14
14
For more information and discussion see [this thread](https://meta.discourse.org/t/dark-visitors/365158) on the Discourse Meta forum.
15
15
@@ -24,7 +24,7 @@ It is no definite guarantee that there are no issues.
24
24
25
25
## Augmenting robots.txt
26
26
27
-
With this enabled the robots.txt file created by Discourse will be augmented with [agents](https://darkvisitors.com/agents) from the configured categories.
27
+
With this enabled the robots.txt file created by Discourse will be augmented with [agents](https://knownagents.com/agents) from the configured categories.
28
28
Once a day the latest list of agents is retrieved and the robots.txt is updated accordingly.
29
29
Only agents which are not already registered in the robots.txt are added.
30
30
@@ -34,15 +34,15 @@ This feature only works if you have not manually overridden robots.txt.
34
34
35
35
## Server Analytics
36
36
37
-
Requests to the server are reported to Dark Visitors.
37
+
Requests to the server are reported to Known Agents.
38
38
39
39
This feature can be enabled for everybody, or only unauthenticated users (recommended).
40
40
41
41
## Client Analytics
42
42
43
-
A javascript based tracker is added to the forum which, under certain conditions, will report back to Dark Visitors.
43
+
A javascript based tracker is added to the forum which, under certain conditions, will report back to Known Agents.
44
44
45
-
At the moment of writing under the following conditions trigger a callback to Dark Visitors:
45
+
At the moment of writing under the following conditions trigger a callback to Known Agents:
46
46
- User is referred to the forum from an AI service
darkvisitors_access_token: "Go to the project settings at Dark Visitors and copy the Access Token."
4
-
darkvisitors_robots_txt_enabled: "Only when enabled will the robots.txt be updated with agents retrieved from Dark Visitors."
5
-
darkvisitors_robots_txt_agents: "Agent types to include in the robots.txt. See https://darkvisitors.com/agentsfor an overview of all agents."
3
+
darkvisitors_access_token: "Go to the project settings at Known Agents and copy the Access Token."
4
+
darkvisitors_robots_txt_enabled: "Only when enabled will the robots.txt be updated with agents retrieved from Known Agents."
5
+
darkvisitors_robots_txt_agents: "Agent types to include in the robots.txt. See the <a href=\"https://knownagents.com/agents\">agent list</a> for an overview of all agents and what they are used for."
6
6
darkvisitors_robots_txt_path: "Path not allowed to be visited by the agents."
7
-
darkvisitors_server_analytics: "Send request data to Dark Visitors for analysis. With 'anonymous_only' only requests form unauthenticated visitors are reported."
8
-
darkvisitors_server_analytics_include: "Besides standard tracked requests, what other requests should be reported to Dark Visitors."
7
+
darkvisitors_server_analytics: "Send request data to Known Agents for analysis. With 'anonymous_only' only requests form unauthenticated visitors are reported."
8
+
darkvisitors_server_analytics_include: "Besides standard tracked requests, what other requests should be reported to Known Agents."
9
9
darkvisitors_server_analytics_ignore: "User agent substrings (case sensitive) to ignore. Use it to exclude uptime monitoring bots."
10
10
darkvisitors_client_analytics: "Add client-side analytics. Redirects from AI services can be traced this way. It also helps to identify possible hidden AI agents."
11
-
darkvisitors_client_analytics_project_key: "Go to the project settings at Dark Visitors and copy the project_key value from the \"JavaScript Tag\"."
11
+
darkvisitors_client_analytics_project_key: "Go to the project settings at Known Agents and copy the project_key value from the \"JavaScript Tag\"."
execute"UPDATE site_settings SET value = REPLACE(value, 'Headless Agent', 'Automated Agent') WHERE name = 'darkvisitors_robots_txt_agents' AND value LIKE '%Headless Agent%'"
6
+
end
7
+
8
+
defdown
9
+
execute"UPDATE site_settings SET value = REPLACE(value, 'Automated Agent', 'Headless Agent') WHERE name = 'darkvisitors_robots_txt_agents' AND value LIKE '%Automated Agent%'"
Copy file name to clipboardExpand all lines: plugin.rb
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,9 @@
1
1
# frozen_string_literal: true
2
2
3
3
# name: discourse-darkvisitors
4
-
# about: Connects to Dark Visitors to keep the robots.txt up to date and monitor crawlers and scrapers visiting your forum.
4
+
# about: Connects to Known Agents (formerly known as Dark Visitors) to keep the robots.txt up to date and monitor crawlers and scrapers visiting your community.
0 commit comments