Doument spelling corrections

pull/1/head
Tom Peltonen 2021-08-15 16:55:48 +10:00
parent e068d4da39
commit f05d8b72be
12 changed files with 32 additions and 32 deletions

View File

@ -5,7 +5,7 @@ There are various options for using PeterDocs. The following sections will cove
## File Filter ## File Filter
The ``-FileFilter`` parameter allows selection of files that are to be included into the archive file. The ``-FileFilter`` parameter allows selection of files that are to be included into the archive file.
The parameter only applies to the compress function or buidling the reconciliation file. The parameter only applies to the compress function or building the reconciliation file.
For example: For example:
@ -23,7 +23,7 @@ will only include files with the extension ".jpg" and starting with the characte
## ReconcileFile ## ReconcileFile
The ``-ReconcileFile`` parameter allows specification of the reocnciliation file if you The ``-ReconcileFile`` parameter allows specification of the reconciliation file if you
wish to select your own name. wish to select your own name.
For example: For example:
@ -67,7 +67,7 @@ includes the date.
## Compression Level ## Compression Level
By setting the Compression level to a value recognized by the 7Zip4Powershell module you can gain more control By setting the Compression level to a value recognized by the 7Zip4Powershell module you can gain more control
of the compresison. The main use case here is for documents that are already compressed and would of the compression. The main use case here is for documents that are already compressed and would
not benefit from future compression. To use this feature you need to set the environment variable. not benefit from future compression. To use this feature you need to set the environment variable.
If all documents are JPEG pictures then setting this value can speed up the compress process If all documents are JPEG pictures then setting this value can speed up the compress process

View File

@ -11,7 +11,7 @@ You can use ``PeterDocs`` to reconcile files transferred using the Windows
system. system.
Robocopy does require your source and target folders to be accessible from Robocopy does require your source and target folders to be accessible from
the coputer that is executing the command. the computer that is executing the command.
To use ``PeterDocs`` and ``Robocopy`` install PeterDocs from the PowerShell Gallery To use ``PeterDocs`` and ``Robocopy`` install PeterDocs from the PowerShell Gallery
and execute the below commands in a PowerShell terminal, changing the values to suit. and execute the below commands in a PowerShell terminal, changing the values to suit.
@ -52,7 +52,7 @@ below command in a PowerShell terminal, changing the values to suit.
New-PeterReconcile -ReconcileFile .\mypictures_metadata.csv -SourceFolder <Source> -ExcludeHash -IncludeExif New-PeterReconcile -ReconcileFile .\mypictures_metadata.csv -SourceFolder <Source> -ExcludeHash -IncludeExif
``` ```
At the conclusion of the exceution, you will have a file named ``##peter_exif##.csv`` that At the conclusion of the execution, you will have a file named ``##peter_exif##.csv`` that
contains your pictures metadata. You will also have a CSV file with picture file contains your pictures metadata. You will also have a CSV file with picture file
general metadata named ``mypictures_metadata.csv`` such as creation time and size. general metadata named ``mypictures_metadata.csv`` such as creation time and size.

View File

@ -7,7 +7,7 @@ or cloned to a remote location securely. The documents can be binary or text do
including personal photographs or sensitive Microsoft Word documents. including personal photographs or sensitive Microsoft Word documents.
At the remote location a reconciliation can be performed to verify that the documents At the remote location a reconciliation can be performed to verify that the documents
have been recieved and no alteration occurred. have been received and no alteration occurred.
## Why ## Why
@ -49,7 +49,7 @@ You can ignore the remaining parameters if you are happy with the defaults.
## What ## What
The ```Compress-Peter``` compressess the contet of the ```SourceFolder``` and saves the result The ```Compress-Peter``` compresses the content of the ```SourceFolder``` and saves the result
as the encrypted ```ArchiveFile```. The archive file also contains the reconciliation file as the encrypted ```ArchiveFile```. The archive file also contains the reconciliation file
so that the recipient of the archive is able to reconcile the restore at the remote location. so that the recipient of the archive is able to reconcile the restore at the remote location.
@ -67,7 +67,7 @@ generate delta archive files.
## Send Usage ## Send Usage
Once the archive file is created you will commonly send or transfer it to anohter Once the archive file is created you will commonly send or transfer it to another
location where it wll be unpacked. location where it wll be unpacked.
Please read next the documentation on [sending the archive](SendArchive.md) Please read next the documentation on [sending the archive](SendArchive.md)

View File

@ -3,7 +3,7 @@
## Objective ## Objective
The objective is to provide a simple capability to create a secure The objective is to provide a simple capability to create a secure
archive file containiung documents to be restored and reconciled at the destination. archive file containing documents to be restored and reconciled at the destination.
The design artefacts must provide all the tools required to pack, The design artefacts must provide all the tools required to pack,
secure, unpack and reconcile the restored/cloned documents. secure, unpack and reconcile the restored/cloned documents.

View File

@ -22,7 +22,7 @@ encryption. The secret (or password) needs to be complex and at least
The complex secret needs to contain lower case letter, upper case letter, The complex secret needs to contain lower case letter, upper case letter,
numeric digit and special symbol. numeric digit and special symbol.
The secret is used directly on the 7ZIP compresison and you can use the The secret is used directly on the 7ZIP compression and you can use the
secret to decrypt the archive file and check its contents. secret to decrypt the archive file and check its contents.
Make a note of the secret as you will need it to decrypt the contents. Make a note of the secret as you will need it to decrypt the contents.
@ -34,10 +34,10 @@ file itself.
## RecipientKey ## RecipientKey
The PeterDocs parameter labelled ```RecipientKey``` is used for asymmetric The PeterDocs parameter labelled ```RecipientKey``` is used for asymmetric
keys provided by the Microsft Certificate Manager for encrypting content. keys provided by the Microsoft Certificate Manager for encrypting content.
This is the most secure method for transfer as it is secured with the This is the most secure method for transfer as it is secured with the
certficates. Using certificates requires: certificates. Using certificates requires:
1. your recipient to send you their public certificate 1. your recipient to send you their public certificate
2. you to load the public certificate into your Windows Certificate Manager 2. you to load the public certificate into your Windows Certificate Manager
@ -49,7 +49,7 @@ contents.
The recipient will need to receive the archive file plus the ```.key``` The recipient will need to receive the archive file plus the ```.key```
file generated by PeterDocs. Both files must be accessible to the file generated by PeterDocs. Both files must be accessible to the
recipient for decryptingg the contents. recipient for decrypting the contents.
### Internal process ### Internal process
@ -58,7 +58,7 @@ is saved into the ```.key``` file which is encrypted using the recipients
public key. public key.
The reason for doing this process is because there are technical limitations The reason for doing this process is because there are technical limitations
in encrypting large files using the certficate public keys. The maximum in encrypting large files using the certificate public keys. The maximum
size is around 60MB when using public keys. size is around 60MB when using public keys.
### Generating your Certificate ### Generating your Certificate
@ -70,7 +70,7 @@ Manager or executing the below PowerShell command.
New-SelfSignedCertificate -Subject "CN=PeterDocs" -FriendlyName "PeterDocs" -KeyDescription "Encryption key for PeterDocs data encipherment" -CertStoreLocation "Cert:\CurrentUser\My" -KeyUsage KeyEncipherment,DataEncipherment, KeyAgreement -Type DocumentEncryptionCert New-SelfSignedCertificate -Subject "CN=PeterDocs" -FriendlyName "PeterDocs" -KeyDescription "Encryption key for PeterDocs data encipherment" -CertStoreLocation "Cert:\CurrentUser\My" -KeyUsage KeyEncipherment,DataEncipherment, KeyAgreement -Type DocumentEncryptionCert
``` ```
To list your current certficates use the below PowerShell command. To list your current certificates use the below PowerShell command.
```powershell ```powershell
Get-Childitem -Path "Cert:\CurrentUser\My" -DocumentEncryptionCert Get-Childitem -Path "Cert:\CurrentUser\My" -DocumentEncryptionCert

View File

@ -36,7 +36,7 @@ To expand the archive you will need write access to the ```RestoreFolder``` loca
## What ## What
The ```Expand-Peter``` decrypts the archive file and expands the contents into The ```Expand-Peter``` decrypts the archive file and expands the contents into
the specified restore folder. It does not peform a reconciliation which is the the specified restore folder. It does not perform a reconciliation which is the
next step. next step.
## Reconcile Usage ## Reconcile Usage

View File

@ -1,6 +1,6 @@
# Install # Install
PeterDocs is a module that can be donwloaded or installed from PeterDocs is a module that can be downloaded or installed from
[PowerShell Gallery](https://xx.com/) [PowerShell Gallery](https://xx.com/)
## Pre-requisites ## Pre-requisites
@ -43,7 +43,7 @@ On a **computer with Internet (PowerShell Gallery) access** do the following ste
1. First check you have PowerShell version 5 or later 1. First check you have PowerShell version 5 or later
```powershell ```powershell
$PSVersionTabe.PSVersion $PSVersionTable.PSVersion
``` ```
2. Download the PeterDocs module 2. Download the PeterDocs module
@ -63,7 +63,7 @@ On the **computer lacking Internet (PowerShell Gallery) access** do the followin
1. First check you have PowerShell version 5 or later 1. First check you have PowerShell version 5 or later
```powershell ```powershell
$PSVersionTabe.PSVersion $PSVersionTable.PSVersion
``` ```
2. Run the following command to determine where the ZIP needs to be unpacked 2. Run the following command to determine where the ZIP needs to be unpacked

View File

@ -3,13 +3,13 @@
## Why ## Why
Once the archive file is sent, you need to download it from its intermediate Once the archive file is sent, you need to download it from its intermediate
location if the source and destination locations are not directky connected. location if the source and destination locations are not directly connected.
You can user other tools you have available to download the archive file. You can user other tools you have available to download the archive file.
## When ## When
The archive is received after it sent. The assunmption is that cloud storage The archive is received after it sent. The assumption is that cloud storage
is being used as an intermediary. is being used as an intermediary.
## How ## How
@ -36,8 +36,8 @@ The ```SourcePath``` is specified as follows:
The "s3" prefix is to download from AWS S3. The "b2" prefix The "s3" prefix is to download from AWS S3. The "b2" prefix
is to download from Backblaze. is to download from Backblaze.
If you are dowloading from AWS you can specify the AWS profile name If you are downloading from AWS you can specify the AWS profile name
in parameter ```SourceProfile```. In this situtation the profile in parameter ```SourceProfile```. In this situation the profile
needs to exist in the AWS credentials on your local device and user profile. needs to exist in the AWS credentials on your local device and user profile.
If you are downloading from Backblaze you specify the ```AccountId``` and the If you are downloading from Backblaze you specify the ```AccountId``` and the
@ -57,7 +57,7 @@ use other tools to download the archive file and the key file.
The function will not expand or reconcile the restore at the destination. The function will not expand or reconcile the restore at the destination.
Please ensure you have sufficent storage to accomodate the local copy of the Please ensure you have sufficient storage to accommodate the local copy of the
archive and space to unpack it. archive and space to unpack it.
## Expand Usage ## Expand Usage

View File

@ -4,7 +4,7 @@ A reconcile file is generated as part of the Compress process and packed with th
## Why ## Why
When transferring or cloning documenmts to another location, you will want to When transferring or cloning documents to another location, you will want to
verify that the same documents have been restored unaltered at the destination. verify that the same documents have been restored unaltered at the destination.
## When ## When
@ -44,7 +44,7 @@ The document last update and time is not checked because the value
will reflect the date and time of restore. will reflect the date and time of restore.
The reconciliation summary is displayed in the terminal and the log The reconciliation summary is displayed in the terminal and the log
wil lhave more information. will have more information.
If any errors are listed, please investigate the discrepancy. If any errors are listed, please investigate the discrepancy.

View File

@ -43,7 +43,7 @@ The "s3" prefix is to upload to AWS S3. The "b2" prefix
is to upload to Backblaze. is to upload to Backblaze.
If you are uploading to AWS you can specify the AWS profile name If you are uploading to AWS you can specify the AWS profile name
in parameter ```TargetProfile```. In this situtation the profile in parameter ```TargetProfile```. In this situation the profile
needs to exist in the AWS credentials on your local device and user profile. needs to exist in the AWS credentials on your local device and user profile.
If you are uploading to Backblaze you specify the ```AccountId``` and the If you are uploading to Backblaze you specify the ```AccountId``` and the

View File

@ -75,4 +75,4 @@ PeterTask
``` ```
**NOTE** Please do not use the VolumeSize parameter as it will fail due to a current **NOTE** Please do not use the VolumeSize parameter as it will fail due to a current
issue with the underlying 7zip4 Powershell module. issue with the underlying 7zip4 Powershell module.

View File

@ -1,4 +1,4 @@
# PeterDocs - Protect, Transfer, Reconcile Dcouments # PeterDocs - Protect, Transfer, Reconcile Documents
## Summary ## Summary
@ -14,7 +14,7 @@ that execute the code are required to have Windows PowerShell installed.
Use the script to create an encrypted archive of the source folder and its contents, then Use the script to create an encrypted archive of the source folder and its contents, then
transfer the archive file to your target, where the content are unpacked using the decryption transfer the archive file to your target, where the content are unpacked using the decryption
key. After archive contents are restored you can execute the reconcile function key. After archive contents are restored you can execute the reconcile function
to veriy that the contents are transferred, unaltered. to verify that the contents are transferred, unaltered.
See [Quick Start](QuickStart.md) if you are ready to start and don't need the details. See [Quick Start](QuickStart.md) if you are ready to start and don't need the details.
@ -90,11 +90,11 @@ will need write access on the target storage. A log file is written at execution
to record activity. to record activity.
Your bulk file transfer is encrypted in transit. Note that if you use the Your bulk file transfer is encrypted in transit. Note that if you use the
SecretKey method the ecnrypted contents will only be as secure as the strength SecretKey method the encrypted contents will only be as secure as the strength
of your secret. of your secret.
You can use storage providers such as Dropbox, AWS S3, Google Drive, OneDrive or BackBlaze You can use storage providers such as Dropbox, AWS S3, Google Drive, OneDrive or BackBlaze
and your documents have additonal protection. and your documents have additional protection.
A log file is produced on execution. Repeated executions on the same day A log file is produced on execution. Repeated executions on the same day
will add text content to the same log file. The default log name takes the form: will add text content to the same log file. The default log name takes the form: