Skip to content

Commit 8bd4321

Browse files
authored
Feature/change detection (#43)
* multiple file uploads supported when authenticated * change detection is working * working through the bugs * partial fix for bulk automation failing * fixed issue with restarting automated job * duplicate issue is resolved, again * added scheduled automation monitoring to context menus * fixing bugs * wrap db insert in transaction. * Converted mhtml to html to improve viewability of artifacts * mhtml to html on the fly added * fixing render issues, added hash to attachment data structure * remove unused file * remove more dead code * fixed deep save issue when using the context menu * working on improving badge updates * add timestamp to debug statement * timestamp the last time the scheduled automation ran
1 parent d9510f7 commit 8bd4321

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+1590
-942
lines changed

README.md

Lines changed: 112 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -4,84 +4,132 @@
44

55
# Your Rapport – Collect, Reflect, and Collaborate.
66

7-
Your Rapport is an open source "Chrome Extension" digital archiving and intelligence tool that collects online conversations using intelligent screenshot automation
8-
and makes the content fully searchable for professionals, amateurs, and archivists who need to preserve, analyze, or audit digital
9-
dialogue across platforms, Your Rapport bridges visual capture with text-based search, turning ephemeral interactions
10-
into permanent, searchable records. Your Rapport is an Open Source tool that implements the best practices for
11-
protecting your privacy and documenting online content. You can easily import, export, or print screenshots from
12-
your collection. Your Rapport is free to use, but has a couple pro features you will need to pay for, eventually.
13-
This enables us to continue development and support for this product.
14-
15-
Please consider supporting this project with a [pro license](https://buy.stripe.com/4gM5kDbRcgWW8d7gLedAk00).
16-
17-
Check out the wiki for more in depth information.
7+
Your Rapport is an open source digital archiving platform that runs entirely within your browser. It uses plugins written
8+
in json to provide additional functionality. The functionality aids in adding flexibility without introducing lots of
9+
custom code or complexity. This product is meant to simplify digital archiving by providing tools that can automate most
10+
of the collection process.
1811

1912
### Getting Started
2013
After installing the Chrome extension from https://chromewebstore.google.com/detail/your-rapport/clkaalonjdkliiaadkgodlfbiipidjmn,
2114
"Your Rapport" will automatically be ready to collect.
2215

23-
There are several options for collecting a screenshot of a web page:
24-
* `Mouse - Right Click` and select the **Autoscroll Collect** menu option with the "Your Rapport" logo
25-
* `Alt+S` collects a single screenshot and deep copy which is an mhtml file
16+
After installing, click the "Your Rapport" pin in your extension tab and select the action you want performed or,
17+
18+
There are several options and actions available when archiving data:
19+
* `Alt+S` collects a single screenshot and deep copy which is a mhtml file and a html version of the web page.
2620
* `Alt+A` autoscroll and collect multiple screenshots, or stop the autoscroll.
2721
* `Alt+X` opens up the dashboard where you can search, print, share, or delete your collection.
28-
* `Alt+Q` quick scan the web page for selectors and show the counts on the extension pin.
29-
* Click the "Your Rapport" pin in your extension tab and select the action you want performed.
30-
31-
Your Rapport is an open source commercial tool for the following reasons:
32-
* Transparency in how software works and where the data goes is an important security and privacy concern to all of us
33-
* A commercial tool is the only viable way to support developing a standard set of open source tools, useful for doing online research
34-
* Keeps the infrastructure costs lower by not having additional overhead with privatized Software as a Service approach
35-
* Implement best practices based on community feedback
36-
* The target price for the Pro license can be set to $3 a month support us [here](https://buy.stripe.com/4gM5kDbRcgWW8d7gLedAk00)
37-
38-
🌟 Key Features
39-
40-
📸 Smart Screenshot Capture
41-
Automatically takes screenshots of chats, posts, comments, and threads across the web.
22+
* `Alt+Q` quick scan opens a sub-panel that displays data extracted insights from the live web page.
23+
* `Mouse - Right Click` gives several options depending upon what you click on within a web page
4224

43-
🤖 Automated Bulk Screenshot Captures
44-
Your Rapport lets you provide a list of URLs to scrape. This saves you time by being able to scrape large amounts of
45-
data, while you work on other tasks. You can also right click on a link to add the URL to the automation queue for
46-
future scraping.
4725

48-
🔍 Searchable Text Extraction
49-
Uses advanced algorithms to extract text from screenshots, making every captured conversation searchable by keyword,
50-
username, or phrase.
26+
Consider supporting this project for $3 a month, available through stripe [pro license](https://buy.stripe.com/4gM5kDbRcgWW8d7gLedAk00).
5127

52-
📗 Quick Scan
53-
Shows how many of your keyword selectors are contained on the web page within the Extension Pin. Making it
54-
easy to determine if the current page has any pertinent information
28+
[Change Log](https://github.com/yooper/your-rapport/wiki/Change-Log)
5529

30+
[Wiki Docs](https://github.com/yooper/your-rapport/wiki)
5631

57-
📚 Discovery Plugins
58-
Are small json scripts that allow you to link your selectors to specific websites for enrichment. Example, if you find a
59-
phone number and have installed the Discovery Plugin from the Package Management screen, you will now be able to streamline
60-
searching against several of the data brokers.
32+
Check out the wiki for more in depth information. Or review the source code in the github repo.
6133

62-
🌱 Companion Extensions
63-
Are chrome extensions that will provide improvements to your workflow. For example, "[Who Am I](https://chromewebstore.google.com/detail/who-am-i/gdnhlhadhgnhaenfcphpeakdghkccfoo)"
64-
a Chrome extension, provides username enumeration across a couple thousand websites. Who Am I has a button in its
65-
UI that will trigger the "Your Rapport" extension to scrape the selected social website with the click of a button.
66-
67-
💬 Platform-Agnostic
68-
Works across social media platforms, messaging apps (via web interfaces), forums, and more.
69-
70-
🔐 Private & Secure
71-
Your captured content stays on your machine utilizing your browser's security and privacy protections.
72-
73-
🔗 Share Your Rapport Collection
74-
The data exported from Your Rapport is in a Non-Proprietary format known as JSON.
75-
Your collection can be downloaded as "json" file(s) which lets you easily share them with
76-
others using email or other file sharing apps. The screenshots can be individually downloaded, too.
34+
# Key Features
35+
* Mostly Free
36+
* Archive thousands of web pages, images, articles, recipes, or other content from the web.
37+
* Search using text, tags, selectors or dates to filter and dive into your digital archives.
38+
* Source code is Open Source
7739

78-
🖨️ Printable Report(s)
79-
There is a lightweight print function that lets you download a PDF with the screenshot and metadata.
8040

41+
# Technical and Product Roadmap
42+
43+
Below are the stages used to process collected information, commonly referred to as an ETL pipeline. This workflow is
44+
designed to run entirely inside a Chrome extension. Discovery Plugins connect events to actions. For example, you might
45+
save a web page, an MHTML file, an image, or a snippet of JavaScript and then trigger a scan by a remote service to
46+
extract people, places, or names from the text, or run OCR to pull text from an image. The extension collects the
47+
content through your browser and stores it locally. When you choose to send data to a remote service, you can also store
48+
the response locally so it becomes part of your archive. Below is a breakdown of each stage involved in processing
49+
online content within the Chrome extension.
50+
51+
* [Collecting](Collecting-Web-Content)
52+
* Digital Media Content
53+
* [Deep Save](Deep-Save)
54+
* [Auto Collect](Auto-Collect)
55+
* [Audio Collect](Audio-Collect) (Not Supported, yet)
56+
* [Video Collect](Video-Collect) (Not Supported, yet)
57+
* [Media Types](supported-collection-types)
58+
* [Text Types](Text-Types)
59+
* [Image Types](Image-Types)
60+
* [Audio Types](Audio-Types) (Not Supported, yet)
61+
* [Video Types](Video-Types) (Not Supported, yet)
62+
* [Formats](Formats)
63+
* [MHTML](MHTML)
64+
* [HTML](HTML)
65+
* [JSON](JSON)
66+
* [Base64](Base64)
67+
* [Automations](Setting-Up-And-Running-Automations)
68+
* [Bulk Url Input](Your-Rapport-Bulk-Collection)
69+
* [Scheduled Automations](Scheduled-Automations)
70+
* [Persistence](Persistence)
71+
* [Indexeddb](IndexedDB) (In app database)
72+
* [Importing](import-a-collection)
73+
* [Uploading Dialog](Uploading-Dialog)
74+
* [Auto Sync](Auto-Sync) (Not Available, yet)
75+
* [Exporting](exporting-and-sharing-your-collection)
76+
* [Sync to Local Disk](Sync-to-Local-Vault) (Pro Feature)
77+
* [Sync to Remote Source](Sync-to-Remote-Source) (Available through Discovery Plugins)
78+
* [Export to File](Export-to-File)
79+
* [Change Data Capture](Change-Data-Capture)
80+
* [Change Detection](Change-Detection)
81+
* [Audit Logging](Audit-Logging) (Not Available, yet)
82+
* [Indexing](Indexing)
83+
* [Search](Working-With-Your-Rapport-Collections-in-the-Search-Dashboard)
84+
* [Free Text](Free-Text-Search)
85+
* [Tags](Your-Rapport-Tag-Management)
86+
* [Selectors](Your-Rapport-Selectors)
87+
* [Domains](Domains)
88+
* [Boolean Operators](Boolean-Operators) (Not Available, yet)
89+
* [Schemas](Schemas)
90+
* [Rapport](Rapport-Schema)
91+
* [DiscoveryPlugin](DiscoveryPlugin-Schema)
92+
* [Artifact](Artifact-Schema)
93+
* [Analysis](Analysis)
94+
* [Merging Screenshots](Merging-Screenshots)
95+
* [Quick Scan](Quick-Scan)
96+
* [SQL](SQL) (Not Available, yet)
97+
* [Web Application Integrations](Web-Application-Integrations)
98+
* [Chrome Extension Integrations](Chrome-Extension-Integrations)
99+
* [Data Viewer](Data-Viewer)
100+
* [Data Integrity Hash](Data-Integrity-Hash)
101+
* [Workflow](Workflow)
102+
* [Api Keys](Api-Key-Management)
103+
* [Discovery Plugins](discovery-plugins-tutorial)
104+
* [Events](Discovery-Plugin-Events)
105+
* [Create](Discovery-Plugin-Create)
106+
* [Update](Discovery-Plugin-Update)
107+
* [Delete](Discovery-Plugin-Delete)
108+
* [Actions](Discovery-Plugin-Actions)
109+
* [Create Tab](Create-Tab)
110+
* [Submit Form](Submit-Form)
111+
* [Foreground Runner](Foreground-Runner)
112+
* [Background Runner](Background-Runner)
113+
* [Case Management](Case-Management) (Not Available, yet)
114+
* [Create](Case-Create)
115+
* [Update](Case-Update)
116+
* [Delete](Case-Delete)
117+
* [Reporting](Reporting)
118+
* [Basic Reports](Basic-Reports)
119+
* [Dashboard Reports](Dashboard-Reports) (Not Available, yet)
120+
* [Simplified Export](Simplified-Export-For-AI-Tools) (For AI Tools)
121+
122+
123+
Your Rapport is an Open Source tool that implements the best practices for
124+
protecting your privacy and archiving online content. You can easily import, export, or print screenshots from
125+
your collection. Your Rapport is free to use, but has a couple pro features you will need to pay for, such as local sync
126+
or advanced change detection algorithms when collecting data. This enables us to continue development and support for this product.
81127

82-
🧠 Best Data Integrity Practices, so far:
83-
* Signed Hash for verifying each screenshot's integrity
84-
* Multiple timestamps are collected
85-
* Multiple attributes about the computer that took the screenshot are captured
86-
* Source code is Open Source
128+
Your Rapport is an open source commercial tool for the following reasons:
129+
* Transparency in how software works and where the data goes is an important security and privacy concern to all of us
130+
* A commercial tool is the only viable way to support developing a standard set of open source tools, useful for doing online research or archiving
131+
* Keeps the infrastructure costs lower by not having additional overhead with privatized Software as a Service approach
132+
* Implement best practices based on community feedback
133+
* Provide the data in multiple formats and make it easy to transfer to different locations
134+
* The target price for the Pro license can be set to $3 a month support us [here](https://buy.stripe.com/4gM5kDbRcgWW8d7gLedAk00)
87135

0 commit comments

Comments
 (0)