Update 'README.md'
This commit is contained in:
parent
1680026bc4
commit
ea70d26a38
103
README.md
103
README.md
@ -1,56 +1,5 @@
|
|||||||
<h1 style="display: flex; align-items: center;"><img src="./assets/icon-addon-2048.png" alt="Rentgen logo" style="margin-right: 1rem;" width="48"/> Rentgen</h1>
|
<h1 style="display: flex; align-items: center;"><img src="./assets/icon-addon-2048.png" alt="Rentgen logo" style="margin-right: 1rem;" width="48"/> Rentgen</h1>
|
||||||
|
|
||||||
<strong>Rentgen</strong> to wtyczka dla przeglądarek opartych o Firefoxa, która automatycznie wizualizuje, jakie dane zostały ~~wykradzione~~ wysłane do podmiotów trzecich przez odwiedzane strony. Wtyczka obrazuje ilość skryptów śledzących na stronie internetowej i pomaga w sformułowaniu maila do administratora strony, który może być podstawą do skargi RODO w Urzędzie Ochrony Danych Osobowych.
|
|
||||||
|
|
||||||
**Funkcje Rentgena:**
|
|
||||||
|
|
||||||
- analiza ruchu sieciowego generowanego przez stronę internetową;
|
|
||||||
- wizualizacja danych przekazanych do podmiotów trzecich przez odwiedzaną stronę (historia przeglądania użytkownika oraz jego ciasteczka);
|
|
||||||
- przygotowywanie zrzutów ekranów narzędzi deweloperskich będących dowodem przekazanych danych do podmiotów trzecich;
|
|
||||||
- pomoc w oszacowaniu potencjalnych obszarów roboczych względem zgodności z RODO;
|
|
||||||
- generowanie raportu lub treści maila, którą można wysłać do administratora oraz Urzędu Ochrony Danych Osobowych.
|
|
||||||
|
|
||||||
## Instalacja
|
|
||||||
|
|
||||||
Firefox: https://addons.mozilla.org/en-US/firefox/addon/rentgen/
|
|
||||||
|
|
||||||
## Jak zbudować i uruchomić Rentgena ze źródeł
|
|
||||||
|
|
||||||
### Wymagania wstępne
|
|
||||||
|
|
||||||
- System operacyjny: Linux x86_64
|
|
||||||
- Node.js: 16.x
|
|
||||||
- npm: 7.x lub wyższy
|
|
||||||
|
|
||||||
### Proces budowy
|
|
||||||
|
|
||||||
1. Pobierz repozytorium przez `git pull https://git.internet-czas-dzialac.pl/icd/rentgen.git` lub pobierz archwium zip
|
|
||||||
2. Przejdź do głównego katalogu pobranego repozytorium
|
|
||||||
3. Uruchom komendę: `npm install`
|
|
||||||
4. Uruchom komendę: `npm run build`
|
|
||||||
5. Uruchom komendę: `npm run create-package`
|
|
||||||
6. Przejdź do katalogu `web-ext-artifacts`
|
|
||||||
7. Znajdziesz tam archiwum zip: `rentgen-x-x-x.zip` (`x-x-x` oznaczają wersję wtyczki)
|
|
||||||
|
|
||||||
### Kroki do uruchomienia
|
|
||||||
|
|
||||||
1. Uruchom Firefoxa i przejdź do strony `about:debugging`
|
|
||||||
2. Kliknij zakładkę _This Firefox_
|
|
||||||
3. Kliknij przycisk _Load Temporary Add-on..._
|
|
||||||
4. Wybierz archiwum, które zbudowałeś w ostatnim kroku procesu budowy
|
|
||||||
|
|
||||||
## Zgłaszanie błędów
|
|
||||||
|
|
||||||
Jeżeli znajdziesz jakieś problem, napisz do nas maila: kontakt@internet-czas-dzialac.pl
|
|
||||||
|
|
||||||
Nie przyjmujemy zgłoszeń na platformie Microsoft Github.
|
|
||||||
|
|
||||||
Każdy problem zostanie sprawdzony i przeniesiony na wewnętrzną listę problemów na naszej instancji Gitea: https://git.internet-czas-dzialac.pl/icd/rentgen/issues. Korzystamy z Gitea i najprawdopodobniej w przyszłości dzięki federalizacji Gitea będziemy w stanie wpuścić użytkowników do zgłaszania błędów bezpośrednio ze strony Gitea.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## English description 🇬🇧
|
|
||||||
|
|
||||||
<strong>Rentgen</strong> is an add-on prepared for Firefox-based browsers. This extension will automatically visualize all the data that a given website ~~steals~~ sends to third parties.
|
<strong>Rentgen</strong> is an add-on prepared for Firefox-based browsers. This extension will automatically visualize all the data that a given website ~~steals~~ sends to third parties.
|
||||||
|
|
||||||
Note: At the moment, we support Polish language because this extension generates mail content that is dedicated to Polish website owners. In further versions of this add-on, we will add other languages as well.
|
Note: At the moment, we support Polish language because this extension generates mail content that is dedicated to Polish website owners. In further versions of this add-on, we will add other languages as well.
|
||||||
@ -111,3 +60,55 @@ Each issue will be reviewed and moved to an internal issues list of our Gitea in
|
|||||||
<img src="./assets/screenshots/5a.png" />
|
<img src="./assets/screenshots/5a.png" />
|
||||||
<img src="./assets/screenshots/5b.png" />
|
<img src="./assets/screenshots/5b.png" />
|
||||||
<img src="./assets/screenshots/2022-07-14_21-04.png" />
|
<img src="./assets/screenshots/2022-07-14_21-04.png" />
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
<strong>Rentgen</strong> to wtyczka dla przeglądarek opartych o Firefoxa, która automatycznie wizualizuje, jakie dane zostały ~~wykradzione~~ wysłane do podmiotów trzecich przez odwiedzane strony. Wtyczka obrazuje ilość skryptów śledzących na stronie internetowej i pomaga w sformułowaniu maila do administratora strony, który może być podstawą do skargi RODO w Urzędzie Ochrony Danych Osobowych.
|
||||||
|
|
||||||
|
**Funkcje Rentgena:**
|
||||||
|
|
||||||
|
- analiza ruchu sieciowego generowanego przez stronę internetową;
|
||||||
|
- wizualizacja danych przekazanych do podmiotów trzecich przez odwiedzaną stronę (historia przeglądania użytkownika oraz jego ciasteczka);
|
||||||
|
- przygotowywanie zrzutów ekranów narzędzi deweloperskich będących dowodem przekazanych danych do podmiotów trzecich;
|
||||||
|
- pomoc w oszacowaniu potencjalnych obszarów roboczych względem zgodności z RODO;
|
||||||
|
- generowanie raportu lub treści maila, którą można wysłać do administratora oraz Urzędu Ochrony Danych Osobowych.
|
||||||
|
|
||||||
|
## Instalacja
|
||||||
|
|
||||||
|
Firefox: https://addons.mozilla.org/pl/firefox/addon/rentgen/
|
||||||
|
|
||||||
|
## Jak zbudować i uruchomić Rentgena ze źródeł
|
||||||
|
|
||||||
|
### Wymagania wstępne
|
||||||
|
|
||||||
|
- System operacyjny: Linux x86_64
|
||||||
|
- Node.js: 16.x
|
||||||
|
- npm: 7.x lub wyższy
|
||||||
|
|
||||||
|
### Proces budowy
|
||||||
|
|
||||||
|
1. Pobierz repozytorium przez `git pull https://git.internet-czas-dzialac.pl/icd/rentgen.git` lub pobierz archwium zip
|
||||||
|
2. Przejdź do głównego katalogu pobranego repozytorium
|
||||||
|
3. Uruchom komendę: `npm install`
|
||||||
|
4. Uruchom komendę: `npm run build`
|
||||||
|
5. Uruchom komendę: `npm run create-package`
|
||||||
|
6. Przejdź do katalogu `web-ext-artifacts`
|
||||||
|
7. Znajdziesz tam archiwum zip: `rentgen-x-x-x.zip` (`x-x-x` oznaczają wersję wtyczki)
|
||||||
|
|
||||||
|
### Kroki do uruchomienia
|
||||||
|
|
||||||
|
1. Uruchom Firefoxa i przejdź do strony `about:debugging`
|
||||||
|
2. Kliknij zakładkę _This Firefox_
|
||||||
|
3. Kliknij przycisk _Load Temporary Add-on..._
|
||||||
|
4. Wybierz archiwum, które zbudowałeś w ostatnim kroku procesu budowy
|
||||||
|
|
||||||
|
## Zgłaszanie błędów
|
||||||
|
|
||||||
|
Jeżeli znajdziesz jakieś problem, napisz do nas maila: kontakt@internet-czas-dzialac.pl
|
||||||
|
|
||||||
|
Nie przyjmujemy zgłoszeń na platformie Microsoft Github.
|
||||||
|
|
||||||
|
Każdy problem zostanie sprawdzony i przeniesiony na wewnętrzną listę problemów na naszej instancji Gitea: https://git.internet-czas-dzialac.pl/icd/rentgen/issues. Korzystamy z Gitea i najprawdopodobniej w przyszłości dzięki federalizacji Gitea będziemy w stanie wpuścić użytkowników do zgłaszania błędów bezpośrednio ze strony Gitea.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user