Permalink
Browse files

Update README to have consistent style with respect to % vs $

  • Loading branch information...
freebsdfrau committed Nov 8, 2018
1 parent f8b5e9c commit 66f5932bc96218ad832c4f2d487bc1f2cbf6e94f
Showing with 23 additions and 23 deletions.
  1. +23 −23 README.md
@@ -1,4 +1,4 @@
[//]: # ($FrauBSD: secure_thumb/README.md 2018-11-08 11:58:27 -0800 freebsdfrau $)
[//]: # ($FrauBSD: secure_thumb/README.md 2018-11-08 12:00:01 -0800 freebsdfrau $)

# Welcome to [FrauBSD.org/secure\_thumb](https://fraubsd.org/secure_thumb)!

@@ -17,68 +17,68 @@ This will ensure the FrauBSD keyword is expanded/updated for each commit.

## Build image (requires `sudo` access)

> `% make`
> `$ make`
## Deploy image to physical hardware (requires `sudo` access)

> 1. `% make deploy`
> 1. `$ make deploy`
> 2. Insert thumb drive and press `ENTER`
## Install `bash_profile` additions (some manual steps required)

> 1. `% make install`
> 1. `$ make install`
> 2. Follow steps to finalize system setup
# Creating SSH keys (requires `sudo` access)

> 1. Connect USB thumb drive to host
> 2. `% openkey`
> 3. `% cd /mnt/keys`
> 4. `% make`
> 5. `% cd -`
> 6. `% closekey -e`
> 2. `$ openkey`
> 3. `$ cd /mnt/keys`
> 4. `$ make`
> 5. `$ cd -`
> 6. `$ closekey -e`
## Loading keys and ejecting the thumb drive (requires `sudo access`)

> 1. `% loadkeys`
> 1. `$ loadkeys`
> 2. **NOTE:** By default, keys are loaded for 1800s (30m)
> 3. `% closekey -e`
> 3. `$ closekey -e`
## Load keys for an extended period (requires `sudo access`)

> 1. `% loadkeys -t13h`
> 2. `% closekey -e`
> 1. `$ loadkeys -t13h`
> 2. `$ closekey -e`
> 3. **NOTE:** Keys will remain usable via ssh-agent for 13h
# Additional Features

## Optionally expand thumb drive to take up free space (requires `sudo`)

> `% make expand`
> `$ make expand`
## Usage statement

> `% make help`
> `$ make help`
## Help on `bash_profile` additions

> 1. `% openkey -h`
> 2. `% closekey -h`
> 3. `% loadkeys -h`
> 4. `% unloadkeys -h`
> 1. `$ openkey -h`
> 2. `$ closekey -h`
> 3. `$ loadkeys -h`
> 4. `$ unloadkeys -h`
## Sync files created on the thumb drive to the local image

> `% make synctoimg`
> `$ make synctoimg`
## Sync files created in the image to the thumb drive

> `% make synctousb`
> `$ make synctousb`
## Resize the image to 1GB to increase free space

> `% make IMGSIZE=1024 resize`
> `$ make IMGSIZE=1024 resize`
## Load keys and then eject the thumb drive

> `% loadkeys -e`
> `$ loadkeys -e`

0 comments on commit 66f5932

Please sign in to comment.