|
| 1 | + |
| 2 | + |
| 3 | + |
| 4 | +# 🔒 [Authlocal.org](https://authlocal.org/) User Guide |
| 5 | +> ***Developers,*** also see the technical [README.md](README.md) |
| 6 | +
|
| 7 | +**Visit https://authlocal.org/ to manage your identities.** |
| 8 | + |
| 9 | +🗽 **User-sovereign** – you own your identity |
| 10 | +🔑 **Cryptographic** – no emails, no passwords |
| 11 | +🥷 **Privacy-focused** – device-local, no databases |
| 12 | +🥞 **Easy as pancakes** – login with two clicks |
| 13 | +💖 **Free and open-source** – zero-cost at global scale |
| 14 | + |
| 15 | +### You hold the keys |
| 16 | + |
| 17 | +Authlocal stores identities *locally* in your web browser, on your device. |
| 18 | + |
| 19 | +You must keep your keys safe, because some web browsers have a habit of unexpectedly wiping your web storage *(Safari, we see you).* |
| 20 | + |
| 21 | +### Any third-party website can request your login from https://authlocal.org/ |
| 22 | + |
| 23 | +You can approve login requests in the Authlocal popup. Third-party websites *never* see your seed. |
| 24 | + |
| 25 | +<br/> |
| 26 | + |
| 27 | +## 🤔 Authlocal FAQ |
| 28 | + |
| 29 | +### What if I lose my identity file or seed? |
| 30 | +- It's gone. Generate a new one. |
| 31 | +- Some apps may offer recovery options, but some won't. Back up your seeds! |
| 32 | + |
| 33 | +### How do I recover my identity from a seed? |
| 34 | +- Go to https://authlocal.org/, then either: |
| 35 | + 1. Drag-and-drop your seed file from your computer. |
| 36 | + 1. Click `Import` and use the `Uploader` tab to choose a seed file from your computer. |
| 37 | + 1. Click `Import` and use the `Recovery seed` tab to paste the seed text in directly. |
| 38 | + |
| 39 | +### Somebody, or some website, asked for my seed? |
| 40 | +- It's a scam! Never share your seed with anybody anywhere except https://authlocal.org/ |
| 41 | + |
| 42 | +### What's with the weird names like "`dozmut.winpex`"? |
| 43 | +- That's a *sigil*, the shorthand for an identity's cryptographic thumbprint. |
| 44 | +- Thumbprint: "`dozmut.winpex.linner.forsep.KgisJ8Pdgey1HC4o8cG59NaLYSoRTiHfA`" |
| 45 | + - This is the full-size and formal public identifier. |
| 46 | + - There are more possible thumbprints than atoms in the entire galaxy. And there are a quintillion atoms in a grain of sand... I mean, think about that for awhile.. There are a lot of atoms... |
| 47 | + |
| 48 | +### Can I change the color associated with my identity? |
| 49 | +- No. It's derived from the identity's cryptographic thumbprint, which cannot be changed. |
| 50 | + |
| 51 | +### What does "Persistence off" mean? |
| 52 | +- If it says *"Persistence off"*, your browser *might* delete your identities after awhile. |
| 53 | +- You can click it to request persistence. Firefox will ask politely. Safari and Chrome will usually ignore you. |
| 54 | +- Safari is the worst — if persistence is off, there's a 7-day inactive data deletion policy — so Safari users will need to re-import identities. |
| 55 | + |
| 56 | +### Zero-cost at global scale? How is it technically possible!? |
| 57 | +- [Authlocal.org](https://authlocal.org/) is a static http deployment. Dirt cheap hosting. |
| 58 | +- No api servers or microservices. Runs clientside, using postMessage. |
| 59 | +- It's open source, so GitHub Pages is willing to host it for free. |
| 60 | + |
| 61 | +### How many people are using Authlocal? |
| 62 | +- We don't know. |
| 63 | +- We don't collect data or track analytics. |
| 64 | +- Star this project on GitHub to give us a clue. |
| 65 | + |
| 66 | +### What vectors threaten my keys on [authlocal.org](https://authlocal.org/)? |
| 67 | +- Yourself. |
| 68 | +- Your web browser, operating system, and hardware. |
| 69 | +- GitHub and GitHub Pages, which hosts the source and app for free. |
| 70 | + - They surely record their own pageview analytics, and a compromised Microsoft could inject a trojan to steal keys on authlocal.org. |
| 71 | + - In the future, we may need to secure funding to host Authlocal on its own security hardened servers. |
| 72 | +- Maintainers of e280: https://github.com/e280/ |
| 73 | + - [Chase Moskal](https://github.com/chase-moskal/) |
| 74 | + - [Przemysław Gałęzki](https://github.com/zenkyuv), |
| 75 | +- Maintainers of dependencies: |
| 76 | + - [`@noble/ed25519`](https://github.com/paulmillr/noble-ed25519) — [Paul Miller](https://github.com/paulmillr) |
| 77 | + - [`@benev`](https://github.com/benevolent-games) — [Chase Moskal](https://github.com/chase-moskal/), [Lonnie Ralfs](https://github.com/lonnie-ralfs/) |
| 78 | + - Technical people can investigate the dependencies in the [package.json](package.json) |
| 79 | + |
| 80 | +<br/> |
| 81 | + |
| 82 | +## 💖 Authlocal is free and open source |
| 83 | +- Authlocal is an https://e280.org/ project. |
| 84 | +- Got questions or feedback? Don't hesitate to open a github issue or discussion anytime! |
| 85 | +- Like the project? Star it on github, it's the only way we're paid. |
| 86 | + |
0 commit comments