Skip to content

Commit b730577

Browse files
committed
docs: extensive usage documentation
1 parent 6039c3e commit b730577

File tree

6 files changed

+47
-17
lines changed

6 files changed

+47
-17
lines changed

README.md

Lines changed: 47 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,57 @@
11
# no2fa [![CI Build](https://github.com/MrExplode/no2fa/actions/workflows/check.yml/badge.svg)](https://github.com/MrExplode/no2fa/actions/workflows/check.yml)
22

3-
A simple userscript to bypass the Neptun 2fa.
4-
This userscript is compatible with [npu](https://github.com/solymosi/npu).
3+
[English description](https://github.com/MrExplode/no2fa/blob/6039c3edd50082ae893ffc4e33097577c37f4021/README.md)
54

6-
> Why would I want to do that?
5+
Ez az userscript "kikerüli" a 2 faktoros hitelesítést a Neptunban.
6+
Igen, működik a [Neptun PowerUp](https://github.com/solymosi/npu)-al.
77

8-
This tool is right for you if:
9-
- You are confident in your security measures without 2fa
10-
- Annoyed with the dumb implementation on Neptun (no session restore, no device remembering)
8+
**Mire való ez, miért jó?**
9+
Egyre több intézményben kötelező a Neptunban kétfaktoros hitelesítést használni, ugyanakkor a Neptun által biztosított rendszer alsóhangon nem felhasználóbarát.
10+
Unod már minden egyes alkalommal újra és újra beírni a kódot? Miért nem lehet megjegyeztetni az eszközt?
11+
A **no2fa** script átveszi ezt a feladatot helyetted, minden bejelentkezésnél automatikusan átugorja a kétfaktoros hitelesítés ablakját.
1112

12-
## Install
13-
1. Install [**TamperMonkey**](https://www.tampermonkey.net/)
14-
2. Download the script by clicking [here](https://github.com/MrExplode/no2fa/releases/latest/download/no2fa.user.js).
15-
3. Click install on the TamperMonkey page.
13+
> [!NOTE]
14+
> Jelenleg egyszerre csak egy gépen lehet használni.
1615
17-
By installing this script you accept the license.
16+
<details>
17+
<summary>Hogy működik?</summary>
18+
A script lementi a 2fa beállításakor a TOTP secret keyt, majd bejelentkezéskor kiszámolja az aktuális kódot, beírja a mezőbe és rákattint a bejelentkezés gombra.<br>
19+
Ezzel felhasználói élmény szempontjából "kikerültük" a 2fa-t.
20+
</details>
1821

19-
## Usage
20-
2. Go to `My Data > Settings > Two-factor authentication`
21-
3. Click `Turn off`
22-
4. Click enable
23-
5. Click on the `Enable Bypass` button
24-
6. Enable the 2fa as usual (eg. with Microsoft Authenticator)
22+
## Telepítés
23+
1. Telepítsd a [**TamperMonkey**](https://www.tampermonkey.net/)-t
24+
2. Telepítsd a scriptet [ide](https://github.com/MrExplode/no2fa/releases/latest/download/no2fa.user.js) kattintva
25+
3. Kattints a **Telepítés** (vagy **Install**) gombra a *TamperMonkey* oldalán (amire az előző lépés végrehajtásakor kerültél)
26+
27+
A script telepítésével elfogadod a *License*-t.
28+
> Lásd: [itt](#licensing), lényegében nem adok garanciát semmire és nem vállalok felelősséget semmiért.
29+
30+
## Használat
31+
0. Telepítsd a scriptet ha nem tetted meg (remélem ez evidens!!)
32+
33+
1. Navigálj ide: `Saját adatok > Beállítások > Kétfaktoros hitelesítés`
34+
35+
2. Kattints a **Kikapcsolás** gombra (ha még nem kapcsoltad be, vagy már kikapcsoltad valamiért, akkor ugorj a következő pontra)
36+
![](docs/1.png)
37+
38+
3. Kattints a **Beállítás** gombra
39+
![](docs/2.png)
40+
41+
4. Kattints az **Enable Bypass** gombra.
42+
<img src="docs/3.png" width="550"/>
43+
44+
5. Okézd le a felugró visszaigazolást.
45+
![](docs/4.png)
46+
47+
6. **NINCS VÉGE, NE ZÁRD BE AZ ABLAKOT!!**
48+
7. Követsd a *Kétfaktoros hitelesítés* ablakban látható utasításokat.
49+
8. Ha megcsináltál mindent (QR kód, kód beírása, jelszó), kattints a **Beállítás** gombra.
50+
9. Ellenőrzésképpen frissítsd újra az oldalt (és ha nem a *Kétfaktoros hitelesítés* az első elem a beállítások közt, navigálj rá)
51+
A következőt kell látnod:
52+
![](docs/5.png)
53+
54+
10. A következő bejelentkezésnél már nem kell beírnod a kódot.
2555

2656
## Development
2757
This project is built with [Vite](https://vitejs.dev/) using [pnpm](https://pnpm.io/).

docs/1.png

12.4 KB
Loading

docs/2.png

12.4 KB
Loading

docs/3.png

35.1 KB
Loading

docs/4.png

6.76 KB
Loading

docs/5.png

13.5 KB
Loading

0 commit comments

Comments
 (0)