mobiletto 1.1.10 → 1.1.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (116) hide show
  1. package/README.md +74 -0
  2. package/docs/README.md +113 -0
  3. package/docs/af/README.md +481 -0
  4. package/docs/am/README.md +481 -0
  5. package/docs/ar/README.md +481 -0
  6. package/docs/az/README.md +481 -0
  7. package/docs/be/README.md +481 -0
  8. package/docs/bg/README.md +481 -0
  9. package/docs/bn/README.md +481 -0
  10. package/docs/bs/README.md +481 -0
  11. package/docs/ca/README.md +481 -0
  12. package/docs/ceb/README.md +481 -0
  13. package/docs/co/README.md +481 -0
  14. package/docs/cs/README.md +481 -0
  15. package/docs/cy/README.md +481 -0
  16. package/docs/da/README.md +481 -0
  17. package/docs/de/README.md +481 -0
  18. package/docs/el/README.md +481 -0
  19. package/docs/eo/README.md +481 -0
  20. package/docs/es/README.md +481 -0
  21. package/docs/et/README.md +481 -0
  22. package/docs/eu/README.md +481 -0
  23. package/docs/fa/README.md +481 -0
  24. package/docs/fi/README.md +481 -0
  25. package/docs/fr/README.md +481 -0
  26. package/docs/fy/README.md +481 -0
  27. package/docs/ga/README.md +481 -0
  28. package/docs/gd/README.md +481 -0
  29. package/docs/gl/README.md +481 -0
  30. package/docs/gu/README.md +481 -0
  31. package/docs/ha/README.md +481 -0
  32. package/docs/haw/README.md +481 -0
  33. package/docs/he/README.md +481 -0
  34. package/docs/hi/README.md +481 -0
  35. package/docs/hmn/README.md +481 -0
  36. package/docs/hr/README.md +481 -0
  37. package/docs/ht/README.md +481 -0
  38. package/docs/hu/README.md +481 -0
  39. package/docs/hy/README.md +481 -0
  40. package/docs/id/README.md +481 -0
  41. package/docs/ig/README.md +481 -0
  42. package/docs/is/README.md +481 -0
  43. package/docs/it/README.md +481 -0
  44. package/docs/iw/README.md +481 -0
  45. package/docs/ja/README.md +481 -0
  46. package/docs/jv/README.md +481 -0
  47. package/docs/ka/README.md +481 -0
  48. package/docs/kk/README.md +481 -0
  49. package/docs/km/README.md +481 -0
  50. package/docs/kn/README.md +481 -0
  51. package/docs/ko/README.md +481 -0
  52. package/docs/ku/README.md +481 -0
  53. package/docs/ky/README.md +481 -0
  54. package/docs/la/README.md +481 -0
  55. package/docs/lb/README.md +481 -0
  56. package/docs/lo/README.md +481 -0
  57. package/docs/lt/README.md +481 -0
  58. package/docs/lv/README.md +481 -0
  59. package/docs/mg/README.md +481 -0
  60. package/docs/mi/README.md +481 -0
  61. package/docs/mk/README.md +481 -0
  62. package/docs/ml/README.md +481 -0
  63. package/docs/mn/README.md +481 -0
  64. package/docs/mr/README.md +481 -0
  65. package/docs/ms/README.md +481 -0
  66. package/docs/mt/README.md +481 -0
  67. package/docs/my/README.md +481 -0
  68. package/docs/ne/README.md +481 -0
  69. package/docs/nl/README.md +481 -0
  70. package/docs/no/README.md +481 -0
  71. package/docs/ny/README.md +481 -0
  72. package/docs/or/README.md +481 -0
  73. package/docs/pa/README.md +481 -0
  74. package/docs/pl/README.md +481 -0
  75. package/docs/ps/README.md +481 -0
  76. package/docs/pt/README.md +481 -0
  77. package/docs/ro/README.md +481 -0
  78. package/docs/ru/README.md +481 -0
  79. package/docs/rw/README.md +481 -0
  80. package/docs/sd/README.md +481 -0
  81. package/docs/si/README.md +481 -0
  82. package/docs/sk/README.md +481 -0
  83. package/docs/sl/README.md +481 -0
  84. package/docs/sm/README.md +481 -0
  85. package/docs/sn/README.md +481 -0
  86. package/docs/so/README.md +481 -0
  87. package/docs/sq/README.md +481 -0
  88. package/docs/sr/README.md +481 -0
  89. package/docs/st/README.md +481 -0
  90. package/docs/su/README.md +481 -0
  91. package/docs/sv/README.md +481 -0
  92. package/docs/sw/README.md +481 -0
  93. package/docs/ta/README.md +481 -0
  94. package/docs/te/README.md +481 -0
  95. package/docs/tg/README.md +481 -0
  96. package/docs/th/README.md +481 -0
  97. package/docs/tk/README.md +481 -0
  98. package/docs/tl/README.md +481 -0
  99. package/docs/tr/README.md +481 -0
  100. package/docs/tt/README.md +481 -0
  101. package/docs/ug/README.md +481 -0
  102. package/docs/uk/README.md +481 -0
  103. package/docs/ur/README.md +481 -0
  104. package/docs/uz/README.md +481 -0
  105. package/docs/vi/README.md +481 -0
  106. package/docs/xh/README.md +481 -0
  107. package/docs/yi/README.md +481 -0
  108. package/docs/yo/README.md +481 -0
  109. package/docs/zh/README.md +481 -0
  110. package/docs/zu/README.md +481 -0
  111. package/drivers/b2/index.js +25 -6
  112. package/hokey.json +16 -0
  113. package/index.js +7 -2
  114. package/package.json +1 -1
  115. package/test/api.spec.js +13 -9
  116. package/util/redis.js +2 -2
@@ -0,0 +1,481 @@
1
+ Mobiletto
2
+ ==========
3
+
4
+ Mobiletto er JavaScript geymsluádráttarlag, með valfrjálsum gagnsæjum dulkóðun viðskiptavinarhliðar.
5
+
6
+ # Innihald
7
+ * [Af hverju Mobiletto?](#Why-Mobiletto?)
8
+ * [Fljót byrjun](#Fljótbyrjun)
9
+ * [Mobiletto CLI](#mobiletto-cli)
10
+ * [Heimild](#Heimild)
11
+ * [Uppsetning](#Uppsetning)
12
+ * [Support and Funding](#Support-and-Funding)
13
+ * [Grunnnotkun](#Grunnnotkun)
14
+ * [Lýsigögn](#Lýsigögn)
15
+ * [Vari innflutningsstíll](#Alternate-import-style)
16
+ * [Caching](#Caching)
17
+ * [speglun](#speglun)
18
+ * [Gegnsæ dulkóðun](#Gegnsæ dulkóðun)
19
+ * [Snúningur lykla](#snúningur lykla)
20
+ * [ökumannsviðmót](#ökumannsviðmót)
21
+ * [Logging](#Logging)
22
+
23
+ # Lestu þetta á öðru tungumáli
24
+ Þetta README.md skjal hefur verið þýtt, með [hokeylization](https://github.com/cobbzilla/hokeylization), yfir á
25
+ **[öll tungumál studd af Google Translate](https://cloud.google.com/translate/docs/languages)!**
26
+
27
+ Ég er viss um að það er ekki fullkomið, en ég vona að það sé betra en ekkert!
28
+
29
+ [🇸🇦 arabíska](../ar/README.md)
30
+ [🇧🇩 bengalska](../bn/README.md)
31
+ [🇩🇪 þýska](../de/README.md)
32
+ [🇺🇸 enska](../en/README.md)
33
+ [🇪🇸 spænska](../es/README.md)
34
+ [🇫🇷 franska](../fr/README.md)
35
+ [🇹🇩 Hausa](../ha/README.md)
36
+ [🇮🇳 hindí](../hi/README.md)
37
+ [🇮🇩 indónesíska](../id/README.md)
38
+ [🇮🇹 ítalska](../it/README.md)
39
+ [🇯🇵 japanska](../ja/README.md)
40
+ [🇰🇷 kóreska](../ko/README.md)
41
+ [🇮🇳 Maranthi](../mr/README.md)
42
+ [🇵🇱 pólska](../pl/README.md)
43
+ [🇧🇷 portúgalska](../pt/README.md)
44
+ [🇷🇺 rússneska](../ru/README.md)
45
+ [🇰🇪 svahílí](../sw/README.md)
46
+ [🇵🇭 Tagalog](../tl/README.md)
47
+ [🇹🇷 tyrkneska](../tr/README.md)
48
+ [🇵🇰 Úrdú](../ur/README.md)
49
+ [🇻🇳 víetnamska](../vi/README.md)
50
+ [🇨🇳 kínverska](../zh/README.md)
51
+
52
+
53
+ **[📚 ... Öll tungumál ...](../README.md)**
54
+ ----
55
+
56
+ ### Er vandamál með þessa þýðingu á README?
57
+ Þessi tiltekna þýðing á upprunalegu [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
58
+ gæti verið gölluð -- *leiðréttingar eru mjög vel þegnar!* Vinsamlegast sendu [dragbeiðni á GitHub](https://github.com/cobbzilla/mobiletto/pulls),
59
+ eða ef þú ert ekki sátt við að gera það, [opnaðu mál](https://github.com/cobbzilla/mobiletto/issues)
60
+
61
+ Þegar þú býrð til nýtt GitHub tölublað um þýðingu, vinsamlegast gerðu:
62
+ * láttu vefslóð síðunnar fylgja (afritaðu/límdu af veffangastiku vafrans)
63
+ * láttu nákvæmlega texta sem er rangur fylgja með (afrita/líma úr vafra)
64
+ * vinsamlegast lýstu hvað er rangt -- er þýðingin röng? er sniðið eitthvað bilað?
65
+ * komdu með tillögu um betri þýðingu eða hvernig textinn ætti að vera rétt sniðinn
66
+ * **Þakka þér fyrir!**
67
+
68
+ ## Hvers vegna Mobiletto?
69
+
70
+ ### Bless söluaðili lokun!
71
+ Hinar ýmsu skýjageymsluveitur eru með ósamrýmanleg API. Jafnvel þeir sem leitast við „S3 samhæfni“
72
+ hafa sérkennilega hegðun.
73
+
74
+ Þegar þú velur tiltekinn geymslusöluaðila fyrir appið þitt, ef þú kóðar beint í API þeirra, appið þitt
75
+ er nú háð þeirri þjónustu. Eftir því sem tíminn líður og kóði safnast upp, breytast framleiðendur
76
+ sífellt óviðunandi. Velkomin í skemmtilegan heim innláns söluaðila!
77
+
78
+ Mobiletto var hannað til að leysa þetta vandamál. Með því að kóða forritið þitt í API fyrir mobiletto geturðu auðveldlega
79
+ skiptu um geymsluþjónustu og veistu að geymslulag appsins þíns mun hegða sér eins.
80
+
81
+ ### Umfangsmiklar prófanir
82
+ Allir ökumenn eru prófaðir fyrir eins hegðun með 60+ prófum fyrir hvern ökumann.
83
+ Við prófum alla ökumenn með hverri samsetningu af:
84
+ * Dulkóðun: bæði virkt og óvirkt
85
+ * Redis skyndiminni: bæði virkt og óvirkt
86
+
87
+ Þessi nálgun veitir okkur hugarró að mobiletto hegðar sér eins óháð því hvaða bílstjóri þú notar,
88
+ og óháð því hvort þú virkjar skyndiminni og/eða dulkóðun.
89
+
90
+ ### Stuðningur við ökumenn
91
+ Núverandi Mobiletto geymslureklar:
92
+ * `s3` : Amazon S3
93
+ * `b2` : Bakslag B2
94
+ * `local` : staðbundið skráarkerfi
95
+
96
+ *Framlög til að styðja við fleiri skýjageymsluveitur eru mjög vel þegnar!*
97
+
98
+ ## mobiletto-cli
99
+ Mobiletto er ætlað að vera notað sem bókasafn með öðrum JavaScript kóða.
100
+
101
+ Til að vinna með mobiletto á skipanalínunni, notaðu [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
102
+
103
+ ## Heimild
104
+ * [mobiletto á GitHub](https://github.com/cobbzilla/mobiletto)
105
+ * [mobiletto á npm](https://www.npmjs.com/package/mobiletto)
106
+
107
+ ## Stuðningur og fjármögnun
108
+ Ég er að reyna að vera faglegur opinn hugbúnaðarframleiðandi. Ég hef verið að vinna í
109
+ hugbúnaðariðnaðinum í mörg ár, ég hef stofnað farsæl fyrirtæki og selt þau til opinberra fyrirtækja.
110
+ Nýlega missti ég vinnuna mína og ég er í rauninni ekki með neina aðra vinnu í röðinni
111
+
112
+ Svo ég ætla að prófa að skrifa gagnlegan hugbúnað og sjá hvort það virkar
113
+
114
+ Ef þú hefur gaman af því að nota þennan hugbúnað, væri ég mjög þakklátur fyrir jafnvel
115
+ minnsta [mánaðarlegt framlag í gegnum Patreon](https://www.patreon.com/cobbzilla)
116
+
117
+ *Þakka þér fyrir!*
118
+
119
+ ## Uppsetning
120
+ Settu upp með því að nota `npm` eða `yarn` . Þú vilt líklega `lite` útgáfuna sem inniheldur ekki alla
121
+ þýddar README skrár:
122
+
123
+ npm install mobiletto-lite
124
+ yarn add mobiletto-lite
125
+
126
+ Ef þú vilt virkilega hafa README skrárnar á hverju tungumáli skaltu setja upp heildarútgáfuna:
127
+
128
+ npm install mobiletto
129
+ yarn add mobiletto
130
+
131
+ ## Fljót byrjun
132
+ Stutt dæmi um að nota mobiletto `s3` bílstjórann.
133
+
134
+ Þessi kóði myndi keyra eins ef ökumaðurinn væri `b2` eða `local` .
135
+
136
+ const storage = require('mobiletto')
137
+ const bucket = await storage.connect('s3', aws_key, aws_secret, {bucket: 'bk'})
138
+
139
+ // list objects: returns array of metadata objects
140
+ const listing = await bucket.list()
141
+ const dirList = await bucket.list('some/dir/')
142
+ const everything = await bucket.list('', {recursive: true})
143
+
144
+ // write an entire file
145
+ let bytesWritten = await bucket.writeFile('some/path', someBufferOfData)
146
+
147
+ // write a file from a stream/generator
148
+ bytesWritten = await bucket.write('some/path', streamOrGenerator)
149
+
150
+ // read an entire file
151
+ // returns null if an exception would otherwise be thrown
152
+ const bufferOrNull = await bucket.safeReadFile('some/path')
153
+
154
+ // stream-read a file, passing data to callback
155
+ const bytesRead = await bucket.read('some/path', (chunk) => { ...do something with chunk... } )
156
+
157
+ // remove a file, returns the path removed
158
+ let removed = await bucket.remove('some/path') // removed is a string
159
+
160
+ // remove a directory, returns array of paths removed
161
+ removed = await bucket.remove('some/directory', {recursive: true}) // removed is now an array!
162
+
163
+ ----
164
+ ## Grunnnotkun
165
+ Miklu víðtækara dæmi sem sýnir flesta eiginleika sem í boði eru:
166
+
167
+ const { mobiletto } = require('mobiletto')
168
+
169
+ // General usage
170
+ const api = await mobiletto(driverName, key, secret, opts)
171
+
172
+ // To use 'local' driver:
173
+ // * key: base directory
174
+ // * secret: ignored, can be null
175
+ // * opts object:
176
+ // * readOnly: optional, never change anything on the filesystem; default is false
177
+ // * fileMode: optional, permissions used when creating new files, default is 0600. can be string or integer
178
+ // * dirMode: optional, permissions used when creating new directories, default is 0700. can be string or integer
179
+ const local = await mobiletto('local', '/home/ubuntu/tmp', null, {fileMode: 0o0600, dirMode: '0700'})
180
+
181
+ // To use 's3' driver:
182
+ // * key: AWS Access Key ID
183
+ // * secret: AWS Secret Key
184
+ // * opts object:
185
+ // * readOnly: optional, never change anything on the bucket; default is false
186
+ // * bucket: required, name of the S3 bucket
187
+ // * region: optional, the AWS region to communicate with, default is us-east-1
188
+ // * prefix: optional, all read/writes within the S3 bucket will be under this prefix
189
+ // * delimiter: optional, directory delimiter, default is '/' (note: always '/' when encryption is enabled)
190
+ const s3 = await mobiletto('s3', aws_key, aws_secret, {bucket: 'bk', region: 'us-east-1'})
191
+
192
+ // To use 'b2' driver:
193
+ // * key: Backblaze Key ID
194
+ // * secret: Backblaze Application Key
195
+ // * opts object:
196
+ // * readOnly: optional, never change anything on the bucket; default is false
197
+ // * bucket: required, the ID (**not the name**) of the B2 bucket
198
+ // * prefix: optional, all read/writes within the B2 bucket will be under this prefix
199
+ // * delimiter: optional, directory delimiter, default is '/' (note: always '/' when encryption is enabled)
200
+ // * partSize: optional, large files will be split into chunks of this size when uploading
201
+ const b3 = await mobiletto('b2', b2_key_id, b2_app_key, {bucket: 'bk', partSize: 10000000})
202
+
203
+ // List files
204
+ api.list() // --> returns an array of metadata objects
205
+
206
+ // List files recursively
207
+ api.list({ recursive: true })
208
+
209
+ // List files in a directory
210
+ const path = 'some/path'
211
+ api.list(path)
212
+ api.list(path, { recursive: true }) // also supports recursive flag
213
+
214
+ // Visit files in a directory -- visitor function must be async
215
+ api.list(path, { visitor: myAsyncFunc })
216
+ api.list(path, { visitor: myAsyncFunc, recursive: true })
217
+
218
+ // The `list` method throws MobilettoNotFoundError if the path does not exist
219
+ // When you call `safeList` on a non-existent path, it returns an empty array
220
+ api.safeList('/path/that/does/not/exist') // returns []
221
+
222
+ // Read metadata for a file
223
+ api.metadata(path) // returns metadata object
224
+
225
+ // The `metadata` method throws MobilettoNotFoundError if the path does not exist
226
+ // When you call `safeMetadata` on a non-existent path, it returns null
227
+ api.safeMetadata('/tmp/does_not_exist') // returns null
228
+
229
+ // Read a file
230
+ // Provide a callback that writes the data someplace
231
+ const callback = (chunk) => { ... write chunk somewhere ... }
232
+ api.read(path, callback) // returns count of bytes read
233
+
234
+ // Read an entire file at once
235
+ const data = await api.readFile(path) // returns a byte Buffer of the file contents
236
+
237
+ // Read an entire file at once
238
+ // returns null if an exception would otherwise be thrown
239
+ const bufferOrNull = await bucket.safeReadFile('some/path')
240
+
241
+ // Write a file
242
+ // Provide a generator function that yields chunks of data
243
+ const generator = function* () {
244
+ while ( ... more-data-to-return ... ) {
245
+ data = ... load-data ...
246
+ yield data
247
+ }
248
+ }
249
+ local.api(path, generator) // returns count of bytes written
250
+
251
+ // Write an entire file at once (convenience method)
252
+ await api.writeFile(path, bufferOrString) // returns count of bytes written
253
+
254
+ // Delete a file
255
+ // Quiet param is optional (default false), when set errors will not be thrown if the path does not exist
256
+ // Always returns a value or throws an error.
257
+ // Return value may be a single string of the file removed, or an array of all files removed (driver-dependent)
258
+ const quiet = true
259
+ api.remove(path, {quiet}) // returns single path removed
260
+
261
+ // Recursively delete a directory and do it quietly (do not report errors)
262
+ const recursive = true
263
+ const quiet = true
264
+ api.remove(path, {recursive, quiet}) // returns array of paths removed
265
+
266
+ ## Lýsigögn
267
+ Skipunin `metadata` skilar lýsigögnum um eina skráakerfisfærslu.
268
+ Sömuleiðis er skilgildið frá skipuninni `list` fylki lýsigagnahluta.
269
+
270
+ Lýsigagnahlutur lítur svona út:
271
+
272
+ {
273
+ "name": "fully/qualified/path/to/file",
274
+ "type": "entry-type",
275
+ "size": size-in-bytes,
276
+ "ctime": creation-time-epoch-millis,
277
+ "mtime": modification-time-epoch-millis
278
+ }
279
+
280
+ Eiginleikinn `type` type` getur verið `file` , `dir` , `link` eða `special` .
281
+
282
+ Það fer eftir tegund ökumanns, `list` skipun getur ekki skilað öllum reitum. Eiginleikar `name` og `type` gerð“
283
+ ætti alltaf að vera til staðar. Síðari `metadata` skipun mun skila öllum tiltækum eiginleikum.
284
+
285
+ ## Annar innflutningsstíll
286
+ Flyttu inn fullkomna eininguna og notaðu `connect` aðgerðina:
287
+
288
+ const storage = require('mobiletto')
289
+ const opts = {bucket: 'bk', region: 'us-east-1'}
290
+ const s3 = await storage.connect('s3', aws_key, aws_secret, opts)
291
+ const objectData = await s3.readFile('some/path')
292
+
293
+ ## Skyndiminni
294
+ Mobiletto virkar best með <a href="https://redis.io">redis</a> skyndiminni.
295
+
296
+ Mobiletto mun reyna að tengjast redis dæmi á 127.0.0.1:6379
297
+
298
+ Þú getur hnekið öðru hvoru af þessu:
299
+ * Stilltu `MOBILETTO_REDIS_HOST` env var, mobiletto tengja hér í stað staðbundinnar gestgjafa
300
+ * Stilltu `MOBILETTO_REDIS_PORT` env var, þetta port verður notað
301
+
302
+ Mobiletto mun geyma alla endurupptökulykla sína með forskeytinu `_mobiletto__` . Þú getur breytt þessu
303
+ með því að stilla `MOBILETTO_REDIS_PREFIX` env var.
304
+
305
+ Þú getur líka stillt skyndiminni fyrir hverja tengingu með `opts.redisConfig` hlutnum:
306
+
307
+ const redisConfig = {
308
+ enabled: true, // optional, default is true. if false other props are ignored
309
+ host: '127.0.0.1',
310
+ port: 6379,
311
+ prefix: '_mobiletto__'
312
+ }
313
+ const opts = { redisConfig, bucket: 'bk', region: 'us-east-1' }
314
+ const s3 = await storage.connect('s3', aws_key, aws_secret, opts)
315
+
316
+ ### Viltu ekki endurupptöku skyndiminni?
317
+ Til að slökkva á: `enabled: false` í `opts.redisConfig` hlutnum þínum þegar þú kemur á tengingu þinni.
318
+
319
+ Eins og fjallað er um hér að neðan mun slökkva á skyndiminni hafa slæm áhrif á frammistöðu og fá fleiri beiðnir
320
+ til geymslu sem þú þarft virkilega á að halda.
321
+
322
+ ### Leiðbeiningar um skyndiminni
323
+ **Dulkóðuð geymsla**: að lesa/skrifa dulkóðuð geymsla er aðeins hægari en venjulega,
324
+ en að fletta um möppur (sem sumir hlutir gera) er frekar dýrt. Að nota redis skyndiminni
325
+ mun gefa þér verulegan árangur.
326
+
327
+ Sjálfgefið skyndiminni er öruggt, en virkar ekki vel ef þú ert með mikið af skrif-/fjarlægingaraðgerðum.
328
+ Sérhver skrif- eða fjarlægðaraðgerð ógildir allt skyndiminni og tryggir að síðari lestur sjái
329
+ nýjustu breytingar.
330
+
331
+ ### CLI verkfæri
332
+ Ef þú ert að nota CLI tól eins og [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
333
+ þú munt örugglega vilja að redis skyndiminni sé virkt, þar sem það endist yfir ákall um `mo` skipunina.
334
+
335
+ ## Speglun
336
+
337
+ // Copy a local filesystem mobiletto to S3
338
+ s3.mirror(local)
339
+
340
+ // Mirror a local subdirectory from one mobiletto to an S3 mobiletto, with it's own subdirectory
341
+ local.mirror(s3, 'some/local-folder', 'some/s3-folder')
342
+
343
+ `mirror` framkvæmir einu sinni afrit af öllum skrám frá einum farsíma til annars.
344
+ Það keyrir ekkert ferli til að viðhalda speglinum með tímanum. Keyrðu aftur `mirror` skipunina
345
+ til að samstilla allar skrár sem vantar.
346
+
347
+ Skilagildið frá `mirror` er einfaldur hlutur með teljara fyrir hversu margar skrár tókst
348
+ speglaðar og hversu margar skrár voru með villur:
349
+
350
+ {
351
+ success: count-of-files-mirrored,
352
+ errors: count-of-files-with-errors
353
+ }
354
+
355
+ VIÐVÖRUN: Það getur verið mjög tímafrekt og bandbreidd að spegla stór gagnasöfn
356
+
357
+ Með merkingarfræði `mirror` kalla getur það stundum verið ruglingslegt að skilja hver er
358
+ lesanda og hver er rithöfundurinn. Ímyndaðu þér það eins og verkefnayfirlýsingu: „vinstri farsímann“
359
+ er hluturinn sem verið er að úthluta til (speglað gögn skrifuð), og "hægri hönd farsíma" (the
360
+ rök fyrir `mirror` aðferðina) er gildið sem verið er að úthluta (speglað gögn eru lesin).
361
+
362
+ ## Gegnsætt dulkóðun
363
+ Virkja gagnsæja dulkóðun viðskiptavinarhliðar:
364
+
365
+ // Pass encryption parameters
366
+ const encryption = {
367
+ // key is required, must be >= 16 chars
368
+ key: randomstring.generate(128),
369
+
370
+ // optional, the default is to derive IV from key
371
+ // when set, IV must be >= 16 chars
372
+ iv: randomstring.generate(128),
373
+
374
+ // optional, the default is aes-256-cbc
375
+ algo: 'aes-256-cbc'
376
+ }
377
+ const api = await mobiletto(driverName, key, secret, opts, encryption)
378
+
379
+ // Subsequent write operations will encrypt data (client side) when writing
380
+ // Subsequent read operations will decrypt data (client side) when reading
381
+
382
+ Hvað er að gerast? Sérstök „skráafærsla“ (dirent) möppu (dulkóðuð) rekur hvaða skrár eru í henni
383
+ möppu (aka beina skráin).
384
+ * `list` skipunin les möppuskrárnar, afkóðar hverja slóð sem skráð er; skilar síðan lýsigögnum fyrir hverja skrá
385
+ * `list` skipanir eru óhagkvæmari, sérstaklega fyrir möppur með miklum fjölda skráa
386
+ * `write` skipunin skrifar óhreinar skrár í leiðbeiningaskrá hvers foreldris, endurkvæmt; skrifar síðan skrána
387
+ * `write`
388
+ * `remove` skipunin fjarlægir samsvarandi dirent skrá, og foreldri hennar ef tóm, endurkvæmt; fjarlægir síðan skrána
389
+ * `remove` skipanir munu hafa O(N) lestur og hugsanlega eins margar eyðingar, með N = dýpt í möppustigveldinu
390
+ * Endurkvæmar `remove` skipanir á stórum og djúpum skráarkerfum geta verið dýrar
391
+
392
+ Athugaðu að jafnvel með dulkóðun viðskiptavinarhliðar virkt, andstæðingur með fullan sýnileika á dulkóðuðu miðlarahliðinni þinni
393
+ geymsla, jafnvel án lykils, getur samt séð heildarfjölda möppum og hversu margar skrár eru í hverri, og með
394
+ smá viðleitni, uppgötva að hluta eða öllu heildarskipulagi möppustigveldisins.
395
+ *Athugið: Notaðu tiltölulega flata uppbyggingu fyrir betra öryggi.*
396
+ Andstæðingurinn myndi ekki vita nöfnin á möppunum/skránum nema þeir vissu líka um dulkóðunina þína
397
+ lykil eða hafði á annan hátt brotið dulkóðunina. Þá eru öll veðmál slökkt!
398
+
399
+ ### Afköst og skyndiminni
400
+ Aðgerðir á dulkóðuðu geymslurými geta verið hægar. Endurkvæmar skráningar og fjarlægingar geta verið mjög hægar.
401
+ Skyndiminni í gegnum Redis hjálpar gríðarlega, en athugaðu að skyndiminni er tæmt við skrif eða fjarlægingu.
402
+
403
+ ## Snúningur lykla
404
+ Búðu til mobiletto með nýja lyklinum þínum og speglaðu síðan gömlu gögnin inn í hann:
405
+
406
+ const storage = require('mobiletto')
407
+
408
+ const oldEncryption = { key: .... }
409
+ const oldStorage = await storage.connect('s3', aws_key, aws_secret, {bucket: 'bk', region: 'us-east-1'}, oldEncryption)
410
+
411
+ const newEncryption = { key: .... }
412
+ const newStorage = await storage.connect('s3', aws_key, aws_secret, {bucket: 'zz', region: 'us-east-1'}, newEncryption)
413
+
414
+ newStorage.mirror(oldStorage) // if oldStorage is very large, this may take a looooooong time...
415
+
416
+ ## Bílstjóri tengi
417
+ Bílstjóri er hvaða JS skrá sem er sem flytur út 'storageClient' aðgerð með þessari undirskrift:
418
+
419
+ function storageClient (key, secret, opts)
420
+
421
+ * `key` : strengur, API lykillinn þinn (fyrir `local` er þetta grunnskráin)
422
+ * `secret` leyndarmál`: strengur, API leyndarmálið þitt (hægt að sleppa fyrir `local` rekla)
423
+ * `opts` : hlutur, eiginleikarnir eru fyrir hvern ökumann:
424
+ * Fyrir `local` `fileMode` og `dirMode` eiginleikar hvernig nýjar skrár og möppur eru búnar til
425
+ * Fyrir `s3` “ er `bucket` eignin nauðsynleg. Valfrjálsir eiginleikar eru:
426
+ * `region`: the S3 region, default is us-east-1
427
+ * `prefix`: a prefix to prepend to all S3 paths, default is the empty string
428
+ * `delimiter`: the directory delimiter, default is '/'
429
+
430
+ Hluturinn sem storageClient aðgerðin skilar verður að skilgreina þessar aðgerðir:
431
+
432
+ // Test the driver before using, ensure proper configuration
433
+ async testConfig ()
434
+
435
+ // List files in path (or from base-directory)
436
+ // If recursive is true, list recursively
437
+ // If visitor is defined, it will be an async function. await the visitor function on each file found
438
+ // Otherwise, perform the listing and return an array of objects
439
+ async list (path, recursive = false, visitor = null) // path may be omitted
440
+
441
+ // Read metadata for a path
442
+ async metadata (path)
443
+
444
+ // Read a file
445
+ // callback receives a chunk of data. endCallback is called at end-of-stream
446
+ async read (path, callback, endCallback = null)
447
+
448
+ // Write a file
449
+ // driver must be able to handle a generator or a stream
450
+ async write (path, generatorOrReadableStream)
451
+
452
+ // Remove a file, or recursively delete a directory
453
+ // returns a string of a single path removed, or an array of multiple paths removed
454
+ async remove (path, recursive = false, quiet = false)
455
+
456
+ ## Skráning
457
+ Mobiletto notar [winston](https://www.npmjs.com/package/winston) skráningarsafnið.
458
+
459
+ Dagskrár **mun** innihalda skráarslóðir og villuskilaboð, en munu **aldrei** innihalda lykla, leyndarmál,
460
+ eða aðrar upplýsingar um tengingarstillingar.
461
+
462
+ ### Log stig
463
+ Notaðu `MOBILETTO_LOG_LEVEL` umhverfisbreytuna til að stilla logstigið með því að nota eina
464
+ af `npm` sem eru skilgreind í [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
465
+
466
+ Sjálfgefið stig er `error` . `silly` , þó að það sé nú mobiletto
467
+ skráir sig ekki á stigum fyrir neðan `debug`
468
+
469
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
470
+
471
+ ### Notkunarskrá
472
+ Sjálfgefið er að skógarhöggsmaðurinn skrifar á stjórnborðið. Til að senda annála í skrá skaltu stilla `MOBILETTO_LOG_FILE`
473
+ umhverfisbreytu. Þegar þú skráir þig inn í skrá verða annálar ekki lengur skrifaðar á stjórnborðið.
474
+
475
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
476
+
477
+ Til að slökkva á skráningu:
478
+
479
+ MOBILETTO_LOG_FILE=/dev/null
480
+
481
+ </pre>