cad778fe5282e409b6cf96c67d9f13c154effa3e
[crypto-install.git] / README.md
1 crypto-install.py
2
3 # USAGE
4
5 Run the script to install a baseline setup for both GnuPG and OpenSSH.
6
7 Existing files are detected and not touched in the process, so running
8 it is always safe to do.
9
10 # OPTIONS
11
12 - `--no-gui` disables the GUI, which means text mode will be enabled for
13   everything including the passphrase input
14 - `--no-gpg` disables the GnuPG key generation and related setup
15   routines
16 - `--no-ssh` does the same for the OpenSSH setup
17 - `--gpg-home` sets the directory for the GnuPG files
18 - `--ssh-home` does the same for OpenSSH files
19
20 There is also `-h/--help` and `-v/--version` as expected.
21
22 # INSTALLATION
23
24 Until I set up a better routine:
25
26     git clone https://github.com/Ferada/crypto-install.git
27     # or
28     git clone git@github.com:Ferada/crypto-install.git
29
30     cd crypto-install
31     make
32     cp build/crypto-install.py ~/bin # or wherever
33
34 Simply copy the built file into your path and possibly ensure execution
35 permissions.