mobiletto 1.1.10 → 1.1.11

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 +48 -0
  2. package/docs/README.md +113 -0
  3. package/docs/af/README.md +455 -0
  4. package/docs/am/README.md +455 -0
  5. package/docs/ar/README.md +455 -0
  6. package/docs/az/README.md +455 -0
  7. package/docs/be/README.md +455 -0
  8. package/docs/bg/README.md +455 -0
  9. package/docs/bn/README.md +455 -0
  10. package/docs/bs/README.md +455 -0
  11. package/docs/ca/README.md +455 -0
  12. package/docs/ceb/README.md +455 -0
  13. package/docs/co/README.md +455 -0
  14. package/docs/cs/README.md +455 -0
  15. package/docs/cy/README.md +455 -0
  16. package/docs/da/README.md +455 -0
  17. package/docs/de/README.md +455 -0
  18. package/docs/el/README.md +455 -0
  19. package/docs/eo/README.md +455 -0
  20. package/docs/es/README.md +455 -0
  21. package/docs/et/README.md +455 -0
  22. package/docs/eu/README.md +455 -0
  23. package/docs/fa/README.md +455 -0
  24. package/docs/fi/README.md +455 -0
  25. package/docs/fr/README.md +455 -0
  26. package/docs/fy/README.md +455 -0
  27. package/docs/ga/README.md +455 -0
  28. package/docs/gd/README.md +455 -0
  29. package/docs/gl/README.md +455 -0
  30. package/docs/gu/README.md +455 -0
  31. package/docs/ha/README.md +455 -0
  32. package/docs/haw/README.md +455 -0
  33. package/docs/he/README.md +455 -0
  34. package/docs/hi/README.md +455 -0
  35. package/docs/hmn/README.md +455 -0
  36. package/docs/hr/README.md +455 -0
  37. package/docs/ht/README.md +455 -0
  38. package/docs/hu/README.md +455 -0
  39. package/docs/hy/README.md +455 -0
  40. package/docs/id/README.md +455 -0
  41. package/docs/ig/README.md +455 -0
  42. package/docs/is/README.md +455 -0
  43. package/docs/it/README.md +455 -0
  44. package/docs/iw/README.md +455 -0
  45. package/docs/ja/README.md +455 -0
  46. package/docs/jv/README.md +455 -0
  47. package/docs/ka/README.md +455 -0
  48. package/docs/kk/README.md +455 -0
  49. package/docs/km/README.md +455 -0
  50. package/docs/kn/README.md +455 -0
  51. package/docs/ko/README.md +455 -0
  52. package/docs/ku/README.md +455 -0
  53. package/docs/ky/README.md +455 -0
  54. package/docs/la/README.md +455 -0
  55. package/docs/lb/README.md +455 -0
  56. package/docs/lo/README.md +455 -0
  57. package/docs/lt/README.md +455 -0
  58. package/docs/lv/README.md +455 -0
  59. package/docs/mg/README.md +455 -0
  60. package/docs/mi/README.md +455 -0
  61. package/docs/mk/README.md +455 -0
  62. package/docs/ml/README.md +455 -0
  63. package/docs/mn/README.md +455 -0
  64. package/docs/mr/README.md +455 -0
  65. package/docs/ms/README.md +455 -0
  66. package/docs/mt/README.md +455 -0
  67. package/docs/my/README.md +455 -0
  68. package/docs/ne/README.md +455 -0
  69. package/docs/nl/README.md +455 -0
  70. package/docs/no/README.md +455 -0
  71. package/docs/ny/README.md +455 -0
  72. package/docs/or/README.md +455 -0
  73. package/docs/pa/README.md +455 -0
  74. package/docs/pl/README.md +455 -0
  75. package/docs/ps/README.md +455 -0
  76. package/docs/pt/README.md +455 -0
  77. package/docs/ro/README.md +455 -0
  78. package/docs/ru/README.md +455 -0
  79. package/docs/rw/README.md +455 -0
  80. package/docs/sd/README.md +455 -0
  81. package/docs/si/README.md +455 -0
  82. package/docs/sk/README.md +455 -0
  83. package/docs/sl/README.md +455 -0
  84. package/docs/sm/README.md +455 -0
  85. package/docs/sn/README.md +455 -0
  86. package/docs/so/README.md +455 -0
  87. package/docs/sq/README.md +455 -0
  88. package/docs/sr/README.md +455 -0
  89. package/docs/st/README.md +455 -0
  90. package/docs/su/README.md +455 -0
  91. package/docs/sv/README.md +455 -0
  92. package/docs/sw/README.md +455 -0
  93. package/docs/ta/README.md +455 -0
  94. package/docs/te/README.md +455 -0
  95. package/docs/tg/README.md +455 -0
  96. package/docs/th/README.md +455 -0
  97. package/docs/tk/README.md +455 -0
  98. package/docs/tl/README.md +455 -0
  99. package/docs/tr/README.md +455 -0
  100. package/docs/tt/README.md +455 -0
  101. package/docs/ug/README.md +455 -0
  102. package/docs/uk/README.md +455 -0
  103. package/docs/ur/README.md +455 -0
  104. package/docs/uz/README.md +455 -0
  105. package/docs/vi/README.md +455 -0
  106. package/docs/xh/README.md +455 -0
  107. package/docs/yi/README.md +455 -0
  108. package/docs/yo/README.md +455 -0
  109. package/docs/zh/README.md +455 -0
  110. package/docs/zu/README.md +455 -0
  111. package/drivers/b2/index.js +24 -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 +12 -9
  116. package/util/redis.js +1 -1
@@ -0,0 +1,455 @@
1
+ Mobiletto
2
+ =========
3
+
4
+ Mobiletto iJavaScript yekuchengetera abstraction layer, ine sarudzo yakajeka mutengi-padivi encryption.
5
+
6
+ # Zviri mukati
7
+ * [Nei Mobiletto?](#Sei-Mobiletto?)
8
+ * [Kurumidza kutanga](#Kurumidza-kutanga)
9
+ * [Mobiletto CLI](#mobiletto-cli)
10
+ * [Kwakabva](#Mabviro)
11
+ * [Basic kushandiswa](#Basic-kushandisa)
12
+ * [Metadata](#Metadata)
13
+ * [Mamwe maitiro ekunze](#Alternate-import-style)
14
+ * [Kuchengeta](#Kuchengeta)
15
+ * [Mirroring](#Mirroring)
16
+ * [Transparent encryption](#Transparent-encryption)
17
+ * [Kiyi kutenderera](#Kiyi-kutenderera)
18
+ * [Mutyairi interface](#Driver-interface)
19
+ * [Kutema](#Logging)
20
+
21
+ # Verenga izvi mune mumwe mutauro
22
+ Gwaro iri README.md rakashandurwa, kuburikidza ne[hokeylization](https://github.com/cobbzilla/hokeylization), kupinda
23
+ **[mitauro yese inotsigirwa neGoogle Translate](https://cloud.google.com/translate/docs/languages)!**
24
+
25
+ Ndine chokwadi kuti haina kukwana, asi ndinovimba iri nani pane hapana!
26
+
27
+ [🇸🇦 ChiArabic](../ar/README.md)
28
+ [🇧🇩 Chibengali](../bn/README.md)
29
+ [🇩🇪 ChiGerman](../de/README.md)
30
+ [🇺🇸 Chirungu](../en/README.md)
31
+ [🇪🇸 Spanish](../es/README.md)
32
+ [🇫🇷 French](../fr/README.md)
33
+ [🇹🇩 Hausa](../ha/README.md)
34
+ [🇮🇳 Hindi](../hi/README.md)
35
+ [🇮🇩 Indonesian](../id/README.md)
36
+ [🇮🇹 Italian](../it/README.md)
37
+ [🇯🇵 Japanese](../ja/README.md)
38
+ [🇰🇷 Korean](../ko/README.md)
39
+ [🇮🇳 Maranthi](../mr/README.md)
40
+ [🇵🇱 Polish](../pl/README.md)
41
+ [🇧🇷 Chiputukezi](../pt/README.md)
42
+ [🇷🇺 Russian](../ru/README.md)
43
+ [🇰🇪 Swahili](../sw/README.md)
44
+ [🇵🇭 Tagalog](../tl/README.md)
45
+ [🇹🇷 Turkish](../tr/README.md)
46
+ [🇵🇰 Urdu](../ur/README.md)
47
+ [🇻🇳 Vietnamese](../vi/README.md)
48
+ [🇨🇳 Chinese](../zh/README.md)
49
+
50
+
51
+ **[📚 ... Mitauro Yese ...](../README.md)**
52
+ ----
53
+
54
+ ### Pane dambudziko here neshanduro iyi yeREADME?
55
+ Iyi chaiyo shanduro yepakutanga [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
56
+ inogona kunge isina kukanganisa -- *kugadzirisa kunogamuchirwa!* Ndokumbira utumire [kudhonza chikumbiro paGitHub](https://github.com/cobbzilla/mobiletto/pulls),
57
+ kana kuti kana usina kusununguka kuita izvozvo, [vhura nyaya](https://github.com/cobbzilla/mobiletto/issues)
58
+
59
+ Kana iwe ukagadzira itsva GitHub nyaya nezve dudziro, ndapota ita:
60
+ * sanganisira iyo URL peji (kopi/namira kubva kubrowser kero bar)
61
+ * sanganisira iwo chaiwo mameseji asiri iwo (kopi/namira kubva kubrowser)
62
+ * ndapota tsanangura kuti chii chakaipa -- shanduro haina kururama here? iyo fomati yakatyoka neimwe nzira?
63
+ * nemutsa ipa zano reshanduro iri nani, kana kuti mashoko acho anofanira kurongwa zvakanaka sei
64
+ * **Ndatenda!**
65
+
66
+ ## Sei Mobiletto?
67
+
68
+ ### Kwaziwai mutengesi kukiya-mukati!
69
+ Iwo akasiyana-siyana ekuchengetedza gore ane asingaenderane APIs. Kunyangwe avo vanovavarira "S3 kuenderana"
70
+ vane maitiro asina musoro.
71
+
72
+ Paunosarudza imwe yekuchengetera mutengesi yeapp yako, kana iwe ukakodha zvakananga kune yavo API, yako app
73
+ yava kutsamira pasevhisi iyoyo. Sezvo nguva inofamba uye kodhi inounganidza, kuchinja vatengesi kunova
74
+ kuwedzera kusatendeseka. Kugamuchirwa kune inonakidza nyika yevatengesi kukiya-mukati!
75
+
76
+ Mobiletto yakagadzirirwa kugadzirisa dambudziko iri. Nekukodha app yako kune mobiletto's API, unogona nyore
77
+ chinja vanopa kuchengetedza uye uzive kuti dura rekuchengetedza reapp yako rinoita zvakafanana.
78
+
79
+ ### Kuedza kwakadzama
80
+ Vese vatyairi vanoongororwa maitiro akafanana ne60+ bvunzo kumutyairi wega wega.
81
+ Isu tinoedza vese vatyairi nemusanganiswa wese we:
82
+ * Encryption: ese akagoneswa uye akaremara
83
+ * Redis cache: ese akagoneswa uye akaremara
84
+
85
+ Iyi nzira inotipa runyararo-rwepfungwa kuti mobiletto ichaita zvimwe chete zvisinei kuti unoshandisa mutyairi upi,
86
+ uye zvisinei nekuti unogonesa caching uye/kana encryption.
87
+
88
+ ### Tsigiro yemutyairi
89
+ Iyezvino Mobiletto kuchengetedza madhiraivha:
90
+ * `s3` : Amazon S3
91
+ * `b2` : Backblaze B2
92
+ * `local` : yenzvimbo faira system
93
+
94
+ *Mipiro yekutsigira mamwe vatariri vekuchengetedza gore inogamuchirwa kwazvo!*
95
+
96
+ ## mobiletto-cli
97
+ Mobiletto inotarisirwa kushandiswa seraibhurari neimwe JavaScript kodhi.
98
+
99
+ Kuti ushande nemobiletto pamutsetse wekuraira, shandisa [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
100
+
101
+ ## Source
102
+ * [mobiletto paGitHub](https://github.com/cobbzilla/mobiletto)
103
+ * [mobiletto pa npm](https://www.npmjs.com/package/mobiletto)
104
+
105
+ ## Kurumidza Kutanga
106
+ Muenzaniso mupfupi uchishandisa mobiletto `s3` mutyairi.
107
+
108
+ Kodhi iyi yaizomhanya zvakafanana kana mutyairi ari `b2` kana `local` .
109
+
110
+ const storage = require('mobiletto')
111
+ const bucket = await storage.connect('s3', aws_key, aws_secret, {bucket: 'bk'})
112
+
113
+ // list objects: returns array of metadata objects
114
+ const listing = await bucket.list()
115
+ const dirList = await bucket.list('some/dir/')
116
+ const everything = await bucket.list('', {recursive: true})
117
+
118
+ // write an entire file
119
+ let bytesWritten = await bucket.writeFile('some/path', someBufferOfData)
120
+
121
+ // write a file from a stream/generator
122
+ bytesWritten = await bucket.write('some/path', streamOrGenerator)
123
+
124
+ // read an entire file
125
+ // returns null if an exception would otherwise be thrown
126
+ const bufferOrNull = await bucket.safeReadFile('some/path')
127
+
128
+ // stream-read a file, passing data to callback
129
+ const bytesRead = await bucket.read('some/path', (chunk) => { ...do something with chunk... } )
130
+
131
+ // remove a file, returns the path removed
132
+ let removed = await bucket.remove('some/path') // removed is a string
133
+
134
+ // remove a directory, returns array of paths removed
135
+ removed = await bucket.remove('some/directory', {recursive: true}) // removed is now an array!
136
+
137
+ ----
138
+ ## Basic kushandiswa
139
+ Muenzaniso wakawedzera wakawedzera, unoratidza mazhinji ezvimiro zvinopihwa:
140
+
141
+ const { mobiletto } = require('mobiletto')
142
+
143
+ // General usage
144
+ const api = await mobiletto(driverName, key, secret, opts)
145
+
146
+ // To use 'local' driver:
147
+ // * key: base directory
148
+ // * secret: ignored, can be null
149
+ // * opts object:
150
+ // * readOnly: optional, never change anything on the filesystem; default is false
151
+ // * fileMode: optional, permissions used when creating new files, default is 0600. can be string or integer
152
+ // * dirMode: optional, permissions used when creating new directories, default is 0700. can be string or integer
153
+ const local = await mobiletto('local', '/home/ubuntu/tmp', null, {fileMode: 0o0600, dirMode: '0700'})
154
+
155
+ // To use 's3' driver:
156
+ // * key: AWS Access Key ID
157
+ // * secret: AWS Secret Key
158
+ // * opts object:
159
+ // * readOnly: optional, never change anything on the bucket; default is false
160
+ // * bucket: required, name of the S3 bucket
161
+ // * region: optional, the AWS region to communicate with, default is us-east-1
162
+ // * prefix: optional, all read/writes within the S3 bucket will be under this prefix
163
+ // * delimiter: optional, directory delimiter, default is '/' (note: always '/' when encryption is enabled)
164
+ const s3 = await mobiletto('s3', aws_key, aws_secret, {bucket: 'bk', region: 'us-east-1'})
165
+
166
+ // To use 'b2' driver:
167
+ // * key: Backblaze Key ID
168
+ // * secret: Backblaze Application Key
169
+ // * opts object:
170
+ // * readOnly: optional, never change anything on the bucket; default is false
171
+ // * bucket: required, the ID (**not the name**) of the B2 bucket
172
+ // * prefix: optional, all read/writes within the B2 bucket will be under this prefix
173
+ // * delimiter: optional, directory delimiter, default is '/' (note: always '/' when encryption is enabled)
174
+ // * partSize: optional, large files will be split into chunks of this size when uploading
175
+ const b3 = await mobiletto('b2', b2_key_id, b2_app_key, {bucket: 'bk', partSize: 10000000})
176
+
177
+ // List files
178
+ api.list() // --> returns an array of metadata objects
179
+
180
+ // List files recursively
181
+ api.list({ recursive: true })
182
+
183
+ // List files in a directory
184
+ const path = 'some/path'
185
+ api.list(path)
186
+ api.list(path, { recursive: true }) // also supports recursive flag
187
+
188
+ // Visit files in a directory -- visitor function must be async
189
+ api.list(path, { visitor: myAsyncFunc })
190
+ api.list(path, { visitor: myAsyncFunc, recursive: true })
191
+
192
+ // The `list` method throws MobilettoNotFoundError if the path does not exist
193
+ // When you call `safeList` on a non-existent path, it returns an empty array
194
+ api.safeList('/path/that/does/not/exist') // returns []
195
+
196
+ // Read metadata for a file
197
+ api.metadata(path) // returns metadata object
198
+
199
+ // The `metadata` method throws MobilettoNotFoundError if the path does not exist
200
+ // When you call `safeMetadata` on a non-existent path, it returns null
201
+ api.safeMetadata('/tmp/does_not_exist') // returns null
202
+
203
+ // Read a file
204
+ // Provide a callback that writes the data someplace
205
+ const callback = (chunk) => { ... write chunk somewhere ... }
206
+ api.read(path, callback) // returns count of bytes read
207
+
208
+ // Read an entire file at once
209
+ const data = await api.readFile(path) // returns a byte Buffer of the file contents
210
+
211
+ // Read an entire file at once
212
+ // returns null if an exception would otherwise be thrown
213
+ const bufferOrNull = await bucket.safeReadFile('some/path')
214
+
215
+ // Write a file
216
+ // Provide a generator function that yields chunks of data
217
+ const generator = function* () {
218
+ while ( ... more-data-to-return ... ) {
219
+ data = ... load-data ...
220
+ yield data
221
+ }
222
+ }
223
+ local.api(path, generator) // returns count of bytes written
224
+
225
+ // Write an entire file at once (convenience method)
226
+ await api.writeFile(path, bufferOrString) // returns count of bytes written
227
+
228
+ // Delete a file
229
+ // Quiet param is optional (default false), when set errors will not be thrown if the path does not exist
230
+ // Always returns a value or throws an error.
231
+ // Return value may be a single string of the file removed, or an array of all files removed (driver-dependent)
232
+ const quiet = true
233
+ api.remove(path, {quiet}) // returns single path removed
234
+
235
+ // Recursively delete a directory and do it quietly (do not report errors)
236
+ const recursive = true
237
+ const quiet = true
238
+ api.remove(path, {recursive, quiet}) // returns array of paths removed
239
+
240
+ ## Metadata
241
+ Iwo `metadata` murairo unodzosa metadata nezve imwechete filesystem yekupinda.
242
+ Saizvozvowo, kukosha kwekudzoka kubva ku `list` .
243
+
244
+ Chinhu chemetadata chinotaridzika seizvi:
245
+
246
+ {
247
+ "name": "fully/qualified/path/to/file",
248
+ "type": "entry-type",
249
+ "size": size-in-bytes,
250
+ "ctime": creation-time-epoch-millis,
251
+ "mtime": modification-time-epoch-millis
252
+ }
253
+
254
+ The `type` pfuma inogona kuva `file` , `dir` , `link` , kana `special` .
255
+
256
+ Zvichienderana nerudzi rwemutyairi, `list` command inogona kusadzosa nzvimbo dzese. The `name` uye `type` zvivakwa
257
+ inofanira kuvapo nguva dzose. Murairo unotevera `metadata` uchadzosa zvese zviripo.
258
+
259
+ ## Imwe nzira yekupinza
260
+ Ngenisa iyo yakazara-yakakwenenzverwa module uye shandisa iyo `connect` basa:
261
+
262
+ const storage = require('mobiletto')
263
+ const opts = {bucket: 'bk', region: 'us-east-1'}
264
+ const s3 = await storage.connect('s3', aws_key, aws_secret, opts)
265
+ const objectData = await s3.readFile('some/path')
266
+
267
+ ## Kuchengeta
268
+ Mobiletto inoshanda zvakanyanya ne <a href="https://redis.io">redis</a> cache.
269
+
270
+ Mobiletto ichaedza kubatanidza kune redis muenzaniso pa127.0.0.1:6379
271
+
272
+ Iwe unogona kukanganisa chimwe cheizvi:
273
+ * Seta iyo `MOBILETTO_REDIS_HOST` env var, mobiletto batanidza pano pane yemunohost
274
+ * Seta iyo `MOBILETTO_REDIS_PORT` env var, chiteshi ichi chichashandiswa
275
+
276
+ Mobiletto ichachengeta makiyi ayo ese eredis ane prefix `_mobiletto__` . Unogona kushandura izvi
277
+ nekuisa iyo `MOBILETTO_REDIS_PREFIX` env var.
278
+
279
+ Iwe unogona zvakare kuseta yega-yekubatanidza caching `opts.redisConfig` chinhu:
280
+
281
+ const redisConfig = {
282
+ enabled: true, // optional, default is true. if false other props are ignored
283
+ host: '127.0.0.1',
284
+ port: 6379,
285
+ prefix: '_mobiletto__'
286
+ }
287
+ const opts = { redisConfig, bucket: 'bk', region: 'us-east-1' }
288
+ const s3 = await storage.connect('s3', aws_key, aws_secret, opts)
289
+
290
+ ### Hausi kuda redis caching?
291
+ Kudzima: pfuura `enabled: false` chako `opts.redisConfig` chako.
292
+
293
+ Sezvakakurukurwa pazasi, kudzima caching kuchava nemhedzisiro yakaipa pakuita uye kuunza zvimwe zvikumbiro
294
+ kuti uchengete zvaunonyatsoda.
295
+
296
+ ### Caching nhungamiro
297
+ ** Chengetedzo yakavharidzirwa **: kuverenga / kunyora encrypted kuchengetedza kunongo nonoka pane zvakajairika,
298
+ asi kufamba uchitenderedza madhairekitori (anoitwa nezvimwe zvinhu) anodhura. Kushandisa redis cache
299
+ ichakupa kukosha kwekuita kwekusimudzira.
300
+
301
+ Iyo default cache yakachengeteka, asi haina kuita zvakanaka kana uine yakawanda yekunyora/kubvisa maoperation.
302
+ Chero kunyora kana kubvisa mashandiro anoita kuti cache yese isashande, kuve nechokwadi kuti inotevera kuverenga ichaona iyo
303
+ shanduko dzichangoburwa.
304
+
305
+ ### CLI zvishandiso
306
+ Kana uri kushandisa CLI chishandiso senge [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
307
+ iwe zvechokwadi uchada kuti redis cache igoneswe, sezvo inogara mukati mekukumbira kweiyo `mo` murairo.
308
+
309
+ ## Mirroring
310
+
311
+ // Copy a local filesystem mobiletto to S3
312
+ s3.mirror(local)
313
+
314
+ // Mirror a local subdirectory from one mobiletto to an S3 mobiletto, with it's own subdirectory
315
+ local.mirror(s3, 'some/local-folder', 'some/s3-folder')
316
+
317
+ Iwo `mirror` rairo rinoita kopi-yenguva yemafaira ese kubva kune imwe mobiletto kuenda kune imwe.
318
+ Iyo haimhanyi chero nzira yekuchengetedza girazi nekufamba kwenguva. Mhanya iyo `mirror` kuraira zvakare
319
+ kuwiriranisa chero mafaira asipo.
320
+
321
+ Iko kukosha kwekudzoka kubva `mirror` chinhu chiri nyore chine zviverengero zvekuti mangani mafaera akabudirira
322
+ mirrored uye mangani mafaera aive nezvikanganiso:
323
+
324
+ {
325
+ success: count-of-files-mirrored,
326
+ errors: count-of-files-with-errors
327
+ }
328
+
329
+ YAMBIRO: Kuona maseti makuru edata anogona kutora nguva zvakanyanya uye bandwidth-yakanyanya
330
+
331
+ `mirror` yekufona semantics dzimwe nguva zvinogona kuvhiringa kunzwisisa kuti ndiani
332
+ muverengi uye munyori ndiani. Fungidzira kunge chirevo chekugoverwa: iyo "ruboshwe-ruboshwe mobiletto"
333
+ ndicho chinhu chiri kupihwa (yakamisikidzwa data yakanyorwa), uye "kurudyi-kurudyi mobiletto" (the
334
+ nharo kune `mirror` nzira) ndiko kukosha kuri kupihwa (mirrored data inoverengwa).
335
+
336
+ ## Transparent encryption
337
+ Gonesa transparent client-side encryption:
338
+
339
+ // Pass encryption parameters
340
+ const encryption = {
341
+ // key is required, must be >= 16 chars
342
+ key: randomstring.generate(128),
343
+
344
+ // optional, the default is to derive IV from key
345
+ // when set, IV must be >= 16 chars
346
+ iv: randomstring.generate(128),
347
+
348
+ // optional, the default is aes-256-cbc
349
+ algo: 'aes-256-cbc'
350
+ }
351
+ const api = await mobiletto(driverName, key, secret, opts, encryption)
352
+
353
+ // Subsequent write operations will encrypt data (client side) when writing
354
+ // Subsequent read operations will decrypt data (client side) when reading
355
+
356
+ Chii chiri kuitika? Iyo yakaparadzana "dhairekitori yekupinda" (dirent) dhairekitori (yakavharidzirwa) inoteedzera mafaera arimo
357
+ dhairekitori (aka iyo dirent dhairekitori).
358
+ * Iyo `list` yekupinda mafaera, decrypts yega nzira yakanyorwa; wozodzosera metadata yefaira rega rega
359
+ * `list` mirairo haina kunyatso shanda, kunyanya kune madhairekitori ane nhamba huru yemafaira
360
+ * Iwo `write` murairo unonyora dirent mafaera mune yega yega dhairekitori remubereki, achidzokorora; ipapo anonyora faira
361
+ * `write` mirairo ichaunza O (N) inonyora, ine N = kudzika mune dhairekitori hierarchy
362
+ * Murairo `remove` unobvisa faira rinoenderana, uye mubereki waro kana asina chinhu, achidzokorodza; wobva wabvisa faira
363
+ * Isiri-inodzokorodza `remove` mirairo ichaunza O(N) kuverenga uye zvingangoita sekudzima kwakawanda, neN = kudzika mudhairekitori dhairekitori.
364
+ * Recursive `remove` mirairo pane yakakura uye yakadzika mafaera system inogona kudhura
365
+
366
+ Ziva kuti kunyangwe neclient-side encryption yakagoneswa, mhandu ine kuoneka kuzere mune yako encrypted server-side.
367
+ chengetedzo, kunyangwe isina kiyi, ichiri kuona huwandu hwemadhairekitori uye kuti mangani mafaera mune imwe neimwe, uye ane
368
+ kumwe kuedza, tsvaga zvimwe kana zvese zvechimiro chese chedhairekitori hierarchy.
369
+ *Cherechedza: Shandisa chimiro chakati sandara kuti uchengetedze zvirinani.
370
+ Muvengi haaizoziva mazita emadhairekitori / mafaera kunze kwekunge vaizivawo encryption yako
371
+ kiyi kana kuti anga akwanisa kupaza encryption. Mabheti ese adzimwa ipapo!
372
+
373
+ ### Kuita uye caching
374
+ Mashandisiro epa encrypted storage anogona kunonoka. Recursive listings uye kubviswa kunogona kunonoka.
375
+ Kuchengetedza kuburikidza ne redis kunobatsira zvikuru, asi cherechedza kuti cache inoputirwa pane chero inonyora kana kubvisa.
376
+
377
+ ## Kutenderera kwakakosha
378
+ Gadzira mobiletto nekiyi yako nyowani, wobva watarisa iyo yekare data mairi:
379
+
380
+ const storage = require('mobiletto')
381
+
382
+ const oldEncryption = { key: .... }
383
+ const oldStorage = await storage.connect('s3', aws_key, aws_secret, {bucket: 'bk', region: 'us-east-1'}, oldEncryption)
384
+
385
+ const newEncryption = { key: .... }
386
+ const newStorage = await storage.connect('s3', aws_key, aws_secret, {bucket: 'zz', region: 'us-east-1'}, newEncryption)
387
+
388
+ newStorage.mirror(oldStorage) // if oldStorage is very large, this may take a looooooong time...
389
+
390
+ ## Mutyairi interface
391
+ Mutyairi chero JS faira inotumira kunze kwe 'storageClient' basa neichi siginicha:
392
+
393
+ function storageClient (key, secret, opts)
394
+
395
+ * `key` : tambo, kiyi yako `local` iyi ndiyo base dhairekitori)
396
+ * `secret` : tambo, yako API chakavanzika (inogona kusiiwa kune `local` mutyairi)
397
+ * `opts` : chinhu, zvivakwa zvacho ndezvamutyairi wega wega:
398
+ * Kune `local` , iyo `fileMode` uye `dirMode` zvivakwa zvinotarisa kuti matsva ekugadzira mafaera nemadhairekitori anogadzirwa sei.
399
+ * Kune `s3` , iyo `bucket` pfuma inodiwa. Optional properties ndezvi:
400
+ * `region`: the S3 region, default is us-east-1
401
+ * `prefix`: a prefix to prepend to all S3 paths, default is the empty string
402
+ * `delimiter`: the directory delimiter, default is '/'
403
+
404
+ Chinhu icho chekuchengetedzaClient basa rinodzoka chinofanira kutsanangura aya mabasa:
405
+
406
+ // Test the driver before using, ensure proper configuration
407
+ async testConfig ()
408
+
409
+ // List files in path (or from base-directory)
410
+ // If recursive is true, list recursively
411
+ // If visitor is defined, it will be an async function. await the visitor function on each file found
412
+ // Otherwise, perform the listing and return an array of objects
413
+ async list (path, recursive = false, visitor = null) // path may be omitted
414
+
415
+ // Read metadata for a path
416
+ async metadata (path)
417
+
418
+ // Read a file
419
+ // callback receives a chunk of data. endCallback is called at end-of-stream
420
+ async read (path, callback, endCallback = null)
421
+
422
+ // Write a file
423
+ // driver must be able to handle a generator or a stream
424
+ async write (path, generatorOrReadableStream)
425
+
426
+ // Remove a file, or recursively delete a directory
427
+ // returns a string of a single path removed, or an array of multiple paths removed
428
+ async remove (path, recursive = false, quiet = false)
429
+
430
+ ## Kutema
431
+ Mobiletto inoshandisa [winston](https://www.npmjs.com/package/winston) raibhurari yekutema matanda.
432
+
433
+ Logs ** ichave iine mafaera nzira uye mhosho mameseji, asi ** haazombove ** ane makiyi, zvakavanzika,
434
+ kana chero rumwe ruzivo rwekubatanidza gadziriso.
435
+
436
+ ### Log level
437
+ Shandisa `MOBILETTO_LOG_LEVEL` shanduko yenharaunda kuseta irogi, uchishandisa imwe
438
+ ye `npm` mazinga anotsanangurwa mu [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
439
+
440
+ Default level ndeye `error` . Chirevo chezwi chakanyanya ndeche `silly` , kunyangwe parizvino mobiletto
441
+ haipindi pamatanho ari pazasi `debug`
442
+
443
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
444
+
445
+ ### Log file
446
+ Nokusingaperi, murogi anonyora kune console. Kuti utumire magwaro kufaira, isa iyo `MOBILETTO_LOG_FILE`
447
+ environment variable. Paunenge uchipinda mufaira, matanda haachazonyorerwe kune iyo console.
448
+
449
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
450
+
451
+ Kudzima matanda:
452
+
453
+ MOBILETTO_LOG_FILE=/dev/null
454
+
455
+ </pre>