mirror of
https://codeberg.org/Kankys/doxa.git
synced 2026-11-11 14:44:36 +01:00
91 lines
3.5 KiB
Markdown
91 lines
3.5 KiB
Markdown
# **DOXA secreet**
|
|
|
|
**DOXA secret** je minimalistický nástroj pro šifrování a ochranu vašich tajných myšlenek z příkazové řádky. Umožňuje převádět zprávy do vlastní abecedy definované v JSON formátu, čímž zajišťuje soukromí bez nutnosti spoléhat se na složité a neznámé systémy. Aplikace je napsána v jazyce Go a nabízí přehledné terminálové uživatelské rozhraní (TUI) postavené na knihovně Bubbletea.
|
|
|
|
## **Předpoklady**
|
|
|
|
Před instalací **DOXA secret** se ujistěte, že máte na svém systému nainstalovaný **Go**. Doporučená verze je 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 secreet na váš systém postupujte podle následujících kroků:
|
|
|
|
> 1. **Naklonujte repozitář:** Získejte nejnovější verzi kódu z Codebergu:
|
|
> Bash
|
|
> git clone https://codeberg.org/Kankys/doxa-secret.git
|
|
> cd doxa-secret \# Přejděte do adresáře projektu
|
|
|
|
> 2. **Spusťte instalační skript:**
|
|
> Bash
|
|
> chmod \+x install.sh
|
|
> ./install.sh
|
|
|
|
Instalační skript provede následující:
|
|
|
|
* Zkontroluje, zda máte nainstalované Go.
|
|
* Stáhne všechny potřebné Go moduly a závislosti projektu (včetně Bubbletea).
|
|
* Zkompiluje aplikaci pro váš operační systém.
|
|
* Nainstaluje spustitelný soubor doxa-secret do adresáře $HOME/.local/bin/.
|
|
* Vytvoří konfigurační adresář ~/.doxa-secret a výchozí soubor s abecedou, pokud neexistují.
|
|
|
|
**Přidání do PATH (pokud je nutné):**
|
|
Po úspěšné instalaci byste měli být schopni spustit aplikaci odkudkoliv. Pokud příkaz není rozpoznán, přidejte následující řádek do svého shell profilu (např. ~/.bashrc, ~/.zshrc):
|
|
|
|
Bash
|
|
export PATH=$PATH:$HOME/.local/bin
|
|
|
|
Po úpravě souboru profilu restartujte terminál nebo jej načtěte příkazem source ~/.bashrc.
|
|
|
|
## **Úklid po instalaci**
|
|
|
|
Jakmile je instalace úspěšně dokončena, zdrojové soubory v adresáři projektu již nejsou potřeba. Celou složku s klonovaným repozitářem můžete smazat:
|
|
|
|
Bash
|
|
rm \-rf doxa-secret
|
|
|
|
## **Konfigurace abecedy**
|
|
|
|
Síla DOXA secret spočívá v tom, že si sami definujete vlastní pravidla a šifrovací klíč v souboru alphabet.json uvnitř konfiguračního adresáře ~/.doxa-secreet/. Aplikace se postará o překlad za vás, takže si složité kombinace nemusíte pamatovat.
|
|
Ukázka struktury abecedy:
|
|
|
|
JSON
|
|
{
|
|
"version": "1.0",
|
|
"mappings": {
|
|
"a": "x9\#m",
|
|
"b": "k2$p",
|
|
"ahoj": "z8\*9"
|
|
}
|
|
}
|
|
|
|
## **Použití**
|
|
|
|
Po úspěšné instalaci můžete aplikaci spustit z jakéhokoliv adresáře zadáním:
|
|
|
|
Bash
|
|
doxa-secret
|
|
|
|
Pro detailní ovládání v TUI rozhraní se řiďte nápovědou zobrazovanou přímo v aplikaci.
|
|
|
|
## **Záloha**
|
|
|
|
Pro zachování vašich šifrovacích klíčů a dat je nutné si uložit obsah konfiguračního adresáře ~/.doxa-secreet (především soubory s definicí abecedy) kamkoliv do vašeho záložního úložiště.
|
|
|
|
## **Odinstalace**
|
|
|
|
Pro odinstalaci DOXA secreet postupujte takto:
|
|
|
|
> 1. **Odstraňte spustitelný soubor:**
|
|
> Bash
|
|
> rm ~/.local/bin/doxa-secreet
|
|
|
|
> 2. **Odstraňte konfigurační adresář (volitelné):**
|
|
> Bash
|
|
> rm -rf ~/.doxa-secreet
|
|
|
|
> *UPOZORNĚNÍ: Tento krok smaže vaše šifrovací klíče a nastavení.*
|
|
|
|
## **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."* |