mirror of
https://codeberg.org/Kankys/doxa.git
synced 2026-11-11 06:44:36 +01:00
94 lines
3.7 KiB
Markdown
94 lines
3.7 KiB
Markdown
# **DOXA secret**
|
||
|
||
**DOXA secret** je minimalistický, lokální nástroj pro šifrování a ochranu vašich tajných zpráv z příkazové řádky. Umožňuje převádět zprávy do vlastní abecedy definované v JSON formátu. Každý znak zprávy je převeden na unikátní 5znakový kód, čímž je zajištěno soukromí.
|
||
|
||
Aplikace je napsána v jazyce Go a nabízí přehledné terminálové uživatelské rozhraní (TUI) postavené na knihovně Bubble Tea.
|
||
|
||
> [!IMPORTANT]
|
||
> **Kompatibilita a diakritika:** Aplikace z důvodu stoprocentní kompatibility mezi různými platformami a kódováními pracuje pouze se znaky základní latinky (bez diakritiky). Veškerá česká diakritika (háčky, čárky) je při šifrování automaticky normalizována (např. „ž“ se změní na „z“, „á“ na „a“). Mezery, čárky, tečky a nové řádky jsou plnohodnotně šifrovány a po dešifrování se zobrazí v původní podobě.
|
||
|
||
---
|
||
|
||
|
||
|
||
## **Předpoklady**
|
||
|
||
Před instalací se ujistěte, že máte na svém systému nainstalovaný **Go** (doporučená verze 1.20 nebo vyšší). Stáhnout Go můžete z oficiálního webu: [https://go.dev/doc/install](https://go.dev/doc/install)
|
||
|
||
---
|
||
|
||
## **Instalace**
|
||
|
||
Pro instalaci DOXA secret na váš systém postupujte podle následujících kroků:
|
||
|
||
```bash
|
||
git clone https://codeberg.org/Kankys/doxa-secret.git
|
||
cd doxa-secret
|
||
chmod +x install.sh
|
||
./install.sh
|
||
```
|
||
|
||
Instalační skript provede následující:
|
||
* Zkontroluje přítomnost Go v systému.
|
||
* Stáhne potřebné závislosti (Bubble Tea, Lip Gloss atd.).
|
||
* Zkompiluje aplikaci.
|
||
* Přesune spustitelný soubor `doxa-secret` do adresáře `$HOME/.local/bin/`.
|
||
* Vytvoří konfigurační složku `~/.doxa-secret/` a výchozí abecedu `default.json`.
|
||
|
||
**Přidání do PATH (pokud je nutné):**
|
||
Pokud příkaz není po instalaci rozpoznán, přidejte následující řádek do svého profilu shellu (např. `~/.bashrc`, `~/.zshrc`):
|
||
```bash
|
||
export PATH=$PATH:$HOME/.local/bin
|
||
```
|
||
Poté restartujte terminál nebo načtěte profil příkazem `source ~/.bashrc`.
|
||
|
||
### **Úklid po instalaci**
|
||
Jakmile je instalace úspěšně dokončena, můžete složku s repozitářem smazat:
|
||
```bash
|
||
rm -rf doxa-secret
|
||
```
|
||
|
||
---
|
||
|
||
## **Organizace zpráv (Import & Export)**
|
||
|
||
Pro lepší přehlednost a organizaci pracuje aplikace se dvěma hlavními složkami ve vašem domovském adresáři:
|
||
* **`~/doxa-secret/export/`** – Sem se automaticky ukládají vaše nově napsané a zašifrované zprávy (`.txt`).
|
||
* **`~/doxa-secret/import/`** – Sem vkládejte šifrované zprávy, které vám přišly od jiných uživatelů a které chcete v aplikaci dešifrovat a přečíst.
|
||
|
||
---
|
||
|
||
## **Konfigurace abecedy**
|
||
|
||
Pravidla šifrování jsou definována v JSON souborech uvnitř konfiguračního adresáře `~/.doxa-secret/`. Můžete si vytvořit více pojmenovaných šifer a v aplikaci se mezi nimi přepínat.
|
||
Ukázka struktury abecedy (všechny kódy mají délku přesně 5 znaků):
|
||
|
||
```json
|
||
{
|
||
"version": "1.0",
|
||
"mappings": {
|
||
" ": "k9#pA",
|
||
",": "L5z2M",
|
||
".": "q7R1o",
|
||
"a": "H3nK9",
|
||
"b": "8vX1m"
|
||
}
|
||
}
|
||
```
|
||
|
||
---
|
||
|
||
## **Použití**
|
||
|
||
Po instalaci stačí spustit z jakéhokoliv adresáře příkazem:
|
||
```bash
|
||
doxa-secret
|
||
```
|
||
Klávesou `l` v hlavním menu můžete přepínat jazyk rozhraní mezi češtinou a angličtinou. Pro podrobné informace o ovládání a klávesových zkratkách doporučujeme nahlédnout do [Uživatelského manuálu (MANUAL_CZ.md)](file:///home/kankys/Repos/Codeberg/doxa-secret/MANUAL_CZ.md).
|
||
|
||
---
|
||
|
||
## **Licence**
|
||
|
||
Aplikace je open-source a licencována pod MIT licencí.
|
||
> *"Skrýt tajemství za fasádou běžného zdání je prvním krokem k ochraně vnitřního klidu."* |