Backup script for Windows #512

bdleedy · 2017-08-07T14:45:38Z

This script will backup the userdata (except unnecessary files) and conf
folders into a .zip file.

Signed-off-by: Brian Leedy awsnap@gmail.com

This script will backup the userdata (except unnecessary files) and conf folders into a .zip file. Signed-off-by: Brian Leedy <awsnap@gmail.com>

Signed-off-by: Brian Leedy <awsnap@gmail.com>

BClark09 · 2017-09-20T14:12:59Z

Hi @bdleedy, I'm a PowerScript novice. But wanted to test out the script today to see if it produces the same zip as the Linux version, how do I use the file? Running it by right-click doesn't seem to do anything?

DarkLite1 · 2017-09-23T18:28:37Z

@BClark09 it tells you in the well documented .EXAMPLE section how to use it:

+    .EXAMPLE
 +    Backup an openHAB instance to a zip file
 +    Backup-openHAB
 +    .EXAMPLE
 +    Backup the openHAB distribution in the C:\openHAB2 directory to c:\openhab-backup\backup.zip
 +    Backup-openHAB -OHDirectory C:\openHAB2 -OHBackups c:\openHAB-backup -ZipFileOut backup.zip

If you are on Windows box it should be possible to load the function first and then you can use it as in the example. Something like this would do:

# Loads the function
& 'C:\Backup.ps1'

# Executes the function
Backup-openHAB

BClark09 · 2017-09-23T20:08:40Z

Thank you @DarkLite1, unfortunately I could not get it to work.

The backup folder is set as .\backups, however it looks like the error references the backup folder to be in system32!? I'm assuming these directories should probably be expanded to a full path first.

bdleedy · 2017-09-23T21:42:33Z

I remember that occurring but I thought I had fixed it. I’ll try to take a look in the next day or two. Thanks for trying it. On Sep 23, 2017, at 4:08 PM, Ben Clark <notifications@github.com> wrote: Thank you @DarkLite1, unfortunately I could not get it to work. The backup folder is set as ./backups, however it looks like the error references the backup folder to be in system32!? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or mute the thread.

DarkLite1 · 2017-09-24T06:21:31Z

You probably already know this, but I feel I need to say it anyhow. To have this work on all Windows machines you need to use PowerShell.exe -ExecutionPolicy Bypass -Command {MyCode}.

kaikreuzer · 2017-12-10T20:17:41Z

@bdleedy Are you still around? As we are heading towards the 2.2 by the end of this week, is there any chance to finish this off?

bdleedy · 2017-12-10T23:19:36Z

Yes actually. I’ll have time Tuesday. (Sent from my iPhone) On Dec 10, 2017, at 3:17 PM, Kai Kreuzer <notifications@github.com> wrote: @bdleedy Are you still around? As we are heading towards the 2.2 by the end of this week, is there any chance to finish this off? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or mute the thread.

tmrobert8 · 2017-12-12T12:23:44Z

@bdleedy
Let me know if you want any help on testing it (or the update.ps1) - I can certainly take the time to test.

bdleedy · 2017-12-13T06:44:31Z

Seems like the CreateFromDirectory doesn't like .\ so I handled that and used pwd to grab the current directory.

@tmrobert8 et al, this needs a quick test also.

DarkLite1 · 2017-12-13T07:48:18Z

When we create production code in PowerShell we usually create a Pester file full of tests. It could maybe be an idea to add this too. Makes updating easier in the future.

BClark09

I can't comment on efficiency/safety of the code. (@DarkLite1 are you able to comment?) but I can say that it fails to include backup.properties to the zipfile. Implementing my comments seems to resolve the issue and a good zip file is created.

BClark09 · 2017-12-13T18:07:32Z

distributions/openhab/src/main/resources/bin/backup.ps1

+        $CurrentVersionIndex = $VersionLine.IndexOf(":")
+        $CurrentVersion = $VersionLine.Substring($currentVersionIndex + 2)
+        $timestamp = Get-Date -Format yyyyMMddHHmm
+        Write-Output "version=$CurrentVersion" | Set-Content "$TempDir\backup.properties"


$TempDir hasn't been set yet, so this writes backup.properties to the C:\\ root.

BClark09 · 2017-12-13T18:08:43Z

distributions/openhab/src/main/resources/bin/backup.ps1

+        $timestamp = Get-Date -Format yyyyMMddHHmm
+        Write-Output "version=$CurrentVersion" | Set-Content "$TempDir\backup.properties"
+        Write-Output "timestamp=$timestamp" | Add-Content "$TempDir\backup.properties"
+        #Write-Output "user=$OHUser" | Add-Content "$TempDir\backup.properties"


Setting this to something like "windows" would be better for cross platform compatibility.

What is the 'this' you are referring to? The directory, property, file, ...?

Apologies, I assume you commented out this line because OHUser and OHGroup is blank? If you set to this to the default: user=openhab, group=openhab then it would be clearer to the restore scripts on other operating systems.

Yeah, in Windows there isn't a real reason to grab that info as there is in your case so I just left if commented out in case someone thought we needed something there. I'll just hardcode 'openhab' for both then. Check that. openHAB.

Case is important in unix/macos, so please let it be 'openhab'. The idea here is to be able to use a backup from Windows, on a restore to Unix, and visa versa.

BClark09 · 2017-12-13T18:09:05Z

distributions/openhab/src/main/resources/bin/backup.ps1

+        Write-Output "version=$CurrentVersion" | Set-Content "$TempDir\backup.properties"
+        Write-Output "timestamp=$timestamp" | Add-Content "$TempDir\backup.properties"
+        #Write-Output "user=$OHUser" | Add-Content "$TempDir\backup.properties"
+        #Write-Output "group=$OHGroup" | Add-Content "$TempDir\backup.properties"


Same as above.

BClark09 · 2017-12-13T18:09:45Z

distributions/openhab/src/main/resources/bin/backup.ps1

+        #Write-Output "group=$OHGroup" | Add-Content "$TempDir\backup.properties"
+
+        Write-Host -ForegroundColor Cyan "Copying userdata and conf folder contents to temp directory"
+        $TempDir=([Environment]::GetEnvironmentVariable("TEMP", "Machine"))+"\openhab"


These two lines (82 and 83) have to be moved before L76 and L77 for the script to work properly.

Fixed and ready to go, just waiting on your clarification above.

DarkLite1 · 2017-12-13T21:54:41Z

Sorry, no time for the moment. Packing to leave on a vacation trip tomorrow..

Fixed issue with CreateFromDirectory using .\ relative path Fixed synopsis Moved $TempDir creation up, added default user and group of openHAB to backup.properties Changed openHAB to openhab in backup.properties Signed-off-by: Brian Leedy <awsnap@gmail.com>

tmrobert8 · 2017-12-14T14:29:10Z

@bdleedy
This worked fine for me - great job! Are you going to wrap both of these in an easily executed .bat file (I have .bat wrappers around both right now - pretty simple to create).

BClark09

Excellent, thats working well! Thanks @bdleedy!

martinvw · 2017-12-14T14:45:38Z

Hooray thanks guys!

kaikreuzer · 2017-12-14T15:03:15Z

Awesome!

bdleedy · 2017-12-14T15:47:45Z

@tmrobert8 I kind of despise .bat wrappers a little but I think it makes sense in this case and easier for 'Joe Automator' to use. I can do a PR or feel free to do it yourself. I need to work on the update script still and I'm making progress on the restore script but behind on that. Also, the documentation needs some work as well.

bdleedy added 3 commits August 7, 2017 10:41

Add backup.ps1 script for Windows

031b978

This script will backup the userdata (except unnecessary files) and conf folders into a .zip file. Signed-off-by: Brian Leedy <awsnap@gmail.com>

Fixed help

fd64b3b

Signed-off-by: Brian Leedy <awsnap@gmail.com>

Fixed backups directory location

29d0b21

Signed-off-by: Brian Leedy <awsnap@gmail.com>

bdleedy force-pushed the backup-ps1 branch from ca99887 to d25870e Compare December 13, 2017 06:43

bdleedy force-pushed the backup-ps1 branch from d25870e to 98f285c Compare December 13, 2017 06:50

BClark09 suggested changes Dec 13, 2017

View reviewed changes

bdleedy force-pushed the backup-ps1 branch from 98f285c to 342bc9d Compare December 13, 2017 19:33

Fix backup.properties

a932621

Fixed issue with CreateFromDirectory using .\ relative path Fixed synopsis Moved $TempDir creation up, added default user and group of openHAB to backup.properties Changed openHAB to openhab in backup.properties Signed-off-by: Brian Leedy <awsnap@gmail.com>

bdleedy force-pushed the backup-ps1 branch from 342bc9d to a932621 Compare December 14, 2017 02:02

BClark09 approved these changes Dec 14, 2017

View reviewed changes

kaikreuzer merged commit 70392f4 into openhab:master Dec 14, 2017

kaikreuzer changed the title ~~Add backup.ps1 script for Windows~~ Added backup script for Windows Dec 15, 2017

kaikreuzer added the enhancement An enhancement or new feature label Dec 15, 2017

kaikreuzer added this to the 2.2 milestone Dec 15, 2017

kaikreuzer changed the title ~~Added backup script for Windows~~ Backup script for Windows Dec 15, 2017

kaikreuzer modified the milestone: 2.2 Dec 15, 2017

bdleedy deleted the backup-ps1 branch December 16, 2017 00:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Backup script for Windows #512

Backup script for Windows #512

bdleedy commented Aug 7, 2017 •

edited

BClark09 commented Sep 20, 2017

DarkLite1 commented Sep 23, 2017

BClark09 commented Sep 23, 2017 •

edited

bdleedy commented Sep 23, 2017 via email

DarkLite1 commented Sep 24, 2017

kaikreuzer commented Dec 10, 2017

bdleedy commented Dec 10, 2017 via email

tmrobert8 commented Dec 12, 2017

bdleedy commented Dec 13, 2017

DarkLite1 commented Dec 13, 2017

BClark09 left a comment

BClark09 Dec 13, 2017

BClark09 Dec 13, 2017

bdleedy Dec 13, 2017

BClark09 Dec 13, 2017 •

edited

bdleedy Dec 13, 2017 •

edited

BClark09 Dec 13, 2017 •

edited

BClark09 Dec 13, 2017

BClark09 Dec 13, 2017 •

edited

bdleedy Dec 13, 2017

DarkLite1 commented Dec 13, 2017

tmrobert8 commented Dec 14, 2017

BClark09 left a comment

martinvw commented Dec 14, 2017

kaikreuzer commented Dec 14, 2017

bdleedy commented Dec 14, 2017

Backup script for Windows #512

Backup script for Windows #512

Conversation

bdleedy commented Aug 7, 2017 • edited

BClark09 commented Sep 20, 2017

DarkLite1 commented Sep 23, 2017

BClark09 commented Sep 23, 2017 • edited

bdleedy commented Sep 23, 2017 via email

DarkLite1 commented Sep 24, 2017

kaikreuzer commented Dec 10, 2017

bdleedy commented Dec 10, 2017 via email

tmrobert8 commented Dec 12, 2017

bdleedy commented Dec 13, 2017

DarkLite1 commented Dec 13, 2017

BClark09 left a comment

Choose a reason for hiding this comment

BClark09 Dec 13, 2017

Choose a reason for hiding this comment

BClark09 Dec 13, 2017

Choose a reason for hiding this comment

bdleedy Dec 13, 2017

Choose a reason for hiding this comment

BClark09 Dec 13, 2017 • edited

Choose a reason for hiding this comment

bdleedy Dec 13, 2017 • edited

Choose a reason for hiding this comment

BClark09 Dec 13, 2017 • edited

Choose a reason for hiding this comment

BClark09 Dec 13, 2017

Choose a reason for hiding this comment

BClark09 Dec 13, 2017 • edited

Choose a reason for hiding this comment

bdleedy Dec 13, 2017

Choose a reason for hiding this comment

DarkLite1 commented Dec 13, 2017

tmrobert8 commented Dec 14, 2017

BClark09 left a comment

Choose a reason for hiding this comment

martinvw commented Dec 14, 2017

kaikreuzer commented Dec 14, 2017

bdleedy commented Dec 14, 2017

bdleedy commented Aug 7, 2017 •

edited

BClark09 commented Sep 23, 2017 •

edited

BClark09 Dec 13, 2017 •

edited

bdleedy Dec 13, 2017 •

edited

BClark09 Dec 13, 2017 •

edited

BClark09 Dec 13, 2017 •

edited