|
6 | 6 | <body> |
7 | 7 | <div id="contentsHome"> |
8 | 8 | <h1>arq_restore</h1> |
9 | | -<p>An open-source command-line utility for restoring from backups created by <a href="http://www.haystacksoftware.com/arq/">Arq</a></p> |
10 | | -<p>Download a binary version <a href="arq_restore.zip">here</a>.</p> |
11 | | -<p>Get the source code <a href="http://github.com/sreitshamer/arq_restore">here</a>.</p> |
12 | | -<p>The data format is documented <a href="http://www.haystacksoftware.com/arq/s3_data_format.txt">here</a>.</p> |
13 | | - |
14 | | -<h2>Usage</h2> |
15 | | - |
16 | | -<p>arq_restore can list the computers ("backup sets") in your destination (Amazon, S3-compatible, GreenQloud, DreamObjects, Google Cloud Storage, and Google Drive), list the folders in a computer's backup set, and restore a folder.</p> |
17 | | - |
18 | | -<h3>Get Help</h3> |
19 | | - |
20 | | -<p>Type <code>arq_restore</code> with no arguments to see usage instructions.</p> |
21 | | - |
22 | | -<pre><code> |
23 | | -Usage: |
24 | | - arq_restore [-l log_level] listcomputers <target_type> <target_params> |
25 | | - arq_restore [-l log_level] listfolders <computer_uuid> <encryption_password> <target_type> <target_params> |
26 | | - arq_restore [-l log_level] restore <computer_uuid> <encryption_password> <folder_uuid> <bytes_per_second> <target_type> <target_params> |
27 | | - |
28 | | -target_params by target type: |
29 | | - aws: access_key secret_key bucket_name |
30 | | - sftp: hostname port path username password_or_keyfile [keyfile_passphrase] |
31 | | - greenqloud: access_key secret_key bucket_name |
32 | | - dreamobjects: public_key secret_key bucket_name |
33 | | - googlecloudstorage: public_key secret_key bucket_name |
34 | | - s3compatible: service_url access_key secret_key bucket_name |
35 | | - googledrive: refresh_token path |
36 | | -</code></pre> |
37 | | - |
38 | | -<p>As you can see the arguments are different depending on the type of your storage destination.</p> |
39 | | - |
40 | | -<h3>List Computers</h3> |
41 | | - |
42 | | -<p>To list all the computers in your destination, use the <code>listcomputers</code> command. Here's an example using AWS:</p> |
43 | | - |
44 | | -<pre><code> |
45 | | -$ arq_restore listcomputers aws AKIAIPXLWYHBMEO22ZNQ QMqT0cdSuHs6eCanSVGr/odThlgoBqYfiWuOsOGI akiaiyuk3n3tme6l4hfa.com.haystacksoftware.arq |
46 | | -target: Amazon |
47 | | - computer FFF83999-A5A5-4E56-B680-05E68FA51814 |
48 | | - Elise's iMac (elise) |
49 | | - computer 3BA5A6DF-C5EC-409F-9B97-9D437B289BC7 |
50 | | - Mac Mini (stefan) |
51 | | - computer 2CD9AD49-AE8E-4456-9C60-E75D4B33D4D1 |
52 | | - Sam Reitshamer's computer (sam) |
53 | | - computer 32D9D7A2-3B3E-4BE7-B85B-0605AF24F570 |
54 | | - Stefan's MacBook Pro (stefan) |
55 | | - computer 75EB74E3-2B18-4B1C-A54C-A518640C83C8 |
56 | | - office iMac (stefan) |
57 | | - |
58 | | -</code></pre> |
59 | | - |
60 | | -<h3>List Folders</h3> |
61 | | - |
62 | | -<p>To list the folders in a computer's backup set, use the <code>listfolders</code> command:</p> |
63 | | - |
64 | | - |
65 | | -<pre><code> |
66 | | -$ arq_restore listfolders 32D9D7A2-3B3E-4BE7-B85B-0605AF24F570 password aws AKIAIPXLWYHBMEO22ZNQ QMqT0cdSuHs6eCanSVGr/odThlgoBqYfiWuOsOGI akiaiyuk3n3tme6l4hfa.com.haystacksoftware.arq |
67 | | -target Amazon |
68 | | -computer 32D9D7A2-3B3E-4BE7-B85B-0605AF24F570 |
69 | | - folder /Users/stefan/.gnupg |
70 | | - uuid 7733A367-E6BA-4A71-A3BE-BCC3A67CF036 |
71 | | - folder /Users/stefan/.ssh |
72 | | - uuid A66799E8-1046-4458-84B7-C1A0BD751715 |
73 | | - folder /Applications |
74 | | - uuid 4A2942C3-463F-4B49-B6F8-AF847BA97496 |
75 | | - folder /Users/stefan/bin |
76 | | - uuid E1C3C6ED-0E22-4EC1-AAD8-08CDE0A3ED19 |
77 | | - folder /Users/stefan/Desktop |
78 | | - uuid B5547B68-832A-4C5C-96F1-5DA8CBF3F645 |
79 | | - folder /Users/stefan/Documents |
80 | | - uuid A215E970-1320-4B95-8133-7A50F68FC59D |
81 | | - folder /Users/stefan/Pictures/iPhoto Library |
82 | | - uuid 017CBF62-BD6C-4580-9A00-8D008D06B84E |
83 | | - folder /Users/stefan/Library |
84 | | - uuid 4F86F72A-7D70-4C55-A59A-038B96852C47 |
85 | | - folder /Volumes/Spinning Disk/stefan/Music |
86 | | - uuid 7C554E65-4324-4B81-9675-4D6EA686B0DD |
87 | | - folder /Users/stefan/src |
88 | | - uuid 1D142EAB-3218-48BD-BF5B-4EAEF504783E |
89 | | - |
90 | | -</code></pre> |
91 | | - |
92 | | -<h3>Restore Files</h3> |
93 | | - |
94 | | -<p>To restore (download) the latest backup of a folder, use the <code>restore</code> command:</p> |
95 | | - |
96 | | -<pre><code> |
97 | | -$ arq_restore restore 32D9D7A2-3B3E-4BE7-B85B-0605AF24F570 password 7C554E65-4324-4B81-9675-4D6EA686B0DD 10000 aws AKIAIPXLWYHBMEO22ZNQ QMqT0cdSuHs6eCanSVGr/odThlgoBqYfiWuOsOGI akiaiyuk3n3tme6l4hfa.com.haystacksoftware.arq |
98 | | - |
99 | | -restoring folder /Volumes/Spinning Disk/stefan/Music to /Users/stefan/temp/Music |
100 | | - |
101 | | -... |
102 | | - |
103 | | -</code></pre> |
104 | | - |
105 | | -<h2>Google Drive</h2> |
106 | | - |
107 | | -<p>If you want to use arq_restore with your Google Drive account, it's a bit more complicated. This is because Google Drive uses OAuth authentication. Arq has a client ID and client secret, but we need to keep that to ourselves, so you'll have to create your own client ID and client secret, authorize it for your account, and then copy/paste it into the arq_restore source and compile it.</p> |
108 | | - |
109 | | -<p>Get your own client ID and client secret at the <a href="https://console.developers.google.com/project">Google Developers Console</a>.</p> |
110 | | - |
111 | | -<p>Google's <a href="https://code.google.com/p/gtm-oauth2/">gtm-oauth2</a> project has a handy example app. You can enter your client ID and secret and then use it to authorize access for that client ID to your Google Drive account.</p> |
112 | | - |
113 | | -<h2>License</h2> |
114 | | - |
115 | | -<pre><code>Copyright (c) 2009-2014, Stefan Reitshamer http://www.haystacksoftware.com |
116 | | - |
117 | | -All rights reserved. |
118 | | - |
119 | | -Redistribution and use in source and binary forms, with or without |
120 | | -modification, are permitted provided that the following conditions are met: |
121 | | - |
122 | | -* Redistributions of source code must retain the above copyright |
123 | | -notice, this list of conditions and the following disclaimer. |
124 | | - |
125 | | -* Redistributions in binary form must reproduce the above copyright |
126 | | -notice, this list of conditions and the following disclaimer in the |
127 | | -documentation and/or other materials provided with the distribution. |
128 | | - |
129 | | -* Neither the names of PhotoMinds LLC or Haystack Software, nor the names of |
130 | | -their contributors may be used to endorse or promote products derived from |
131 | | -this software without specific prior written permission. |
132 | | - |
133 | | -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
134 | | -"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
135 | | -LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
136 | | -A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
137 | | -OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
138 | | -SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED |
139 | | -TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR |
140 | | -PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF |
141 | | -LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING |
142 | | -NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS |
143 | | -SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
144 | | -</code></pre> |
145 | | -</div> |
| 9 | +<p>This project has moved to <a href="https://arqbackup.github.io/arq_restore/">https://arqbackup.github.io/arq_restore/</a></p> |
146 | 10 | </body> |
147 | 11 | </html> |
0 commit comments