mobiletto 1.1.8 → 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 (117) hide show
  1. package/README.md +56 -4
  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 +33 -17
  114. package/package.json +3 -2
  115. package/test/api.spec.js +319 -306
  116. package/util/logger.js +1 -1
  117. package/util/redis.js +1 -1
@@ -0,0 +1,455 @@
1
+ Mobiletto
2
+ =========
3
+
4
+ Ang Mobiletto ay isang JavaScript storage abstraction layer, na may opsyonal na transparent na client-side encryption.
5
+
6
+ # Nilalaman
7
+ * [Bakit Mobiletto?](#Why-Mobiletto?)
8
+ * [Quick start](#Quick-start)
9
+ * [Mobiletto CLI](#mobiletto-cli)
10
+ * [Source](#Source)
11
+ * [Basic na paggamit](#Basic-usage)
12
+ * [Metadata](#Metadata)
13
+ * [Alternate import style](#Alternate-import-style)
14
+ * [Caching](#Caching)
15
+ * [Mirroring](#Mirroring)
16
+ * [Transparent na pag-encrypt](#Transparent-encryption)
17
+ * [Pag-ikot ng key](#Pag-ikot ng key)
18
+ * [Driver interface](#Driver-interface)
19
+ * [Logging](#Logging)
20
+
21
+ # Basahin ito sa ibang wika
22
+ Itong README.md na dokumento ay isinalin, sa pamamagitan ng [hokeylization](https://github.com/cobbzilla/hokeylization), sa
23
+ **[bawat wikang sinusuportahan ng Google Translate](https://cloud.google.com/translate/docs/languages)!**
24
+
25
+ Natitiyak kong hindi ito perpekto, ngunit umaasa ako na ito ay mas mahusay kaysa sa wala!
26
+
27
+ [🇸🇦 Arabic](../ar/README.md)
28
+ [🇧🇩 Bengali](../bn/README.md)
29
+ [🇩🇪 German](../de/README.md)
30
+ [🇺🇸 English](../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
+ [🇮🇹 Italyano](../it/README.md)
37
+ [🇯🇵 Japanese](../ja/README.md)
38
+ [🇰🇷 Korean](../ko/README.md)
39
+ [🇮🇳 Maranthi](../mr/README.md)
40
+ [🇵🇱 Polish](../pl/README.md)
41
+ [🇧🇷 Portuguese](../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
+ **[📚 ... Lahat ng Wika ...](../README.md)**
52
+ ----
53
+
54
+ ### May problema ba sa pagsasaling ito ng README?
55
+ Ang partikular na pagsasaling ito ng orihinal na [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
56
+ maaaring may depekto -- *ang mga pagwawasto ay malugod na tinatanggap!* Mangyaring magpadala ng [pull request sa GitHub](https://github.com/cobbzilla/mobiletto/pulls),
57
+ o kung hindi ka komportableng gawin iyon, [magbukas ng isyu](https://github.com/cobbzilla/mobiletto/issues)
58
+
59
+ Kapag gumawa ka ng bagong isyu sa GitHub tungkol sa isang pagsasalin, mangyaring gawin ang:
60
+ * isama ang URL ng pahina (kopyahin/i-paste mula sa address bar ng browser)
61
+ * isama ang eksaktong text na mali (kopyahin/i-paste mula sa browser)
62
+ * mangyaring ilarawan kung ano ang mali -- mali ba ang pagsasalin? sira ba ang formatting kahit papaano?
63
+ * mabait na mag-alok ng isang mungkahi ng isang mas mahusay na pagsasalin, o kung paano ang teksto ay dapat na maayos na na-format
64
+ * **Salamat!**
65
+
66
+ ## Bakit Mobiletto?
67
+
68
+ ### Paalam vendor lock-in!
69
+ Ang iba't ibang mga provider ng cloud storage ay may mga hindi tugmang API. Kahit na ang mga nagsusumikap para sa "S3 compatibility"
70
+ may idiosyncratic na pag-uugali.
71
+
72
+ Kapag pumili ka ng partikular na vendor ng storage para sa iyong app, kung direkta kang magko-code sa kanilang API, ang iyong app
73
+ ay nakadepende na ngayon sa serbisyong iyon. Habang lumilipas ang panahon at naiipon ang code, nagiging nagbabago ang mga vendor
74
+ lalong hindi matitiis. Maligayang pagdating sa masayang mundo ng vendor lock-in!
75
+
76
+ Ang Mobiletto ay idinisenyo upang malutas ang problemang ito. Sa pamamagitan ng pag-coding sa iyong app sa mobiletto's API, madali mong magagawa
77
+ baguhin ang mga provider ng storage at alamin na ang layer ng storage ng iyong app ay magiging magkapareho.
78
+
79
+ ### Malawak na pagsubok
80
+ Ang lahat ng mga driver ay sinubok para sa magkatulad na pag-uugali na may 60+ na pagsubok para sa bawat driver.
81
+ Sinusubukan namin ang lahat ng mga driver sa bawat kumbinasyon ng:
82
+ * Encryption: parehong pinagana at hindi pinagana
83
+ * Redis cache: parehong pinagana at hindi pinagana
84
+
85
+ Ang diskarte na ito ay nagbibigay sa amin ng kapayapaan ng isip na ang mobiletto ay magiging pareho ang kilos anuman ang ginagamit mong driver,
86
+ at hindi alintana kung pinagana mo ang pag-cache at/o pag-encrypt.
87
+
88
+ ### Suporta sa driver
89
+ Kasalukuyang mga driver ng imbakan ng Mobiletto:
90
+ * `s3` : Amazon S3
91
+ * `b2` : Backblaze B2
92
+ * `local` : lokal na filesystem
93
+
94
+ *Ang mga kontribusyon upang suportahan ang higit pang mga provider ng cloud storage ay malugod na tinatanggap!*
95
+
96
+ ## mobiletto-cli
97
+ Ang Mobiletto ay inilaan na gamitin bilang isang library ng ibang JavaScript code.
98
+
99
+ Upang gumana sa mobiletto sa command-line, gamitin ang [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
100
+
101
+ ## Pinagmulan
102
+ * [mobiletto sa GitHub](https://github.com/cobbzilla/mobiletto)
103
+ * [mobiletto sa npm](https://www.npmjs.com/package/mobiletto)
104
+
105
+ ## Mabilis na Pagsisimula
106
+ Isang maikling halimbawa gamit ang mobiletto `s3` driver.
107
+
108
+ Ang code na ito ay tatakbo nang pareho kung ang driver ay `b2` o `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
+ ## Pangunahing paggamit
139
+ Isang mas malawak na halimbawa, na nagpapakita ng karamihan sa mga tampok na inaalok:
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
+ Ang utos `metadata` ay nagbabalik ng metadata tungkol sa isang entry ng filesystem.
242
+ Gayundin, ang return value mula sa command na `list` ay isang hanay ng mga metadata object.
243
+
244
+ Mukhang ganito ang metadata object:
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
+ Ang property na ` `type` ay maaaring `file` , `dir` , `link` , o `special` .
255
+
256
+ Depende sa uri ng driver, maaaring hindi ibalik ng `list` command ang lahat ng field. Ang mga katangian ng `name` at `type`
257
+ dapat laging naroroon. Ibabalik ng kasunod na command `metadata` ang lahat ng available na property.
258
+
259
+ ## Kahaliling istilo ng pag-import
260
+ I-import ang fully-scoped module at gamitin ang `connect` function:
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
+ ## Pag-cache
268
+ Pinakamahusay na gumagana ang Mobiletto sa isang <a href="https://redis.io">redis</a> cache.
269
+
270
+ Susubukan ng Mobiletto na kumonekta sa isang redis instance sa 127.0.0.1:6379
271
+
272
+ Maaari mong i-override ang alinman sa mga ito:
273
+ * Itakda ang `MOBILETTO_REDIS_HOST` env var, mobiletto kumonekta dito sa halip na localhost
274
+ * Itakda ang `MOBILETTO_REDIS_PORT` env var, ang port na ito ang gagamitin
275
+
276
+ Iimbak ng Mobiletto ang lahat ng redis key nito na may prefix `_mobiletto__` . Maaari mong baguhin ito
277
+ sa pamamagitan ng pagtatakda ng `MOBILETTO_REDIS_PREFIX` env var.
278
+
279
+ Maaari ka ring magtakda ng per-connection caching gamit ang object na `opts.redisConfig` :
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
+ ### Ayaw ng redis caching?
291
+ Upang i-disable: ipasa `enabled: false` sa iyong object `opts.redisConfig` kapag itinatag mo ang iyong koneksyon.
292
+
293
+ Tulad ng tinalakay sa ibaba, ang hindi pagpapagana ng caching ay magkakaroon ng masamang epekto sa pagganap at magkakaroon ng higit pang mga kahilingan
294
+ sa imbakan na talagang kailangan mo.
295
+
296
+ ### Gabay sa pag-cache
297
+ **Naka-encrypt na storage**: ang pagbabasa/pagsusulat ng naka-encrypt na storage ay mas mabagal lang ng kaunti kaysa sa karaniwan,
298
+ ngunit ang pag-navigate sa mga direktoryo (na ginagawa ng ilang bagay) ay medyo mahal. Paggamit ng redis cache
299
+ ay magbibigay sa iyo ng makabuluhang pagpapalakas ng pagganap.
300
+
301
+ Ang default na cache ay ligtas, ngunit hindi gumaganap nang maayos kung mayroon kang maraming mga operasyon sa pagsulat/pag-alis.
302
+ Ang anumang operasyon sa pagsulat o pag-alis ay nagpapawalang-bisa sa buong cache, na tinitiyak na makikita ng mga kasunod na pagbabasa ang
303
+ pinakabagong pagbabago.
304
+
305
+ ### CLI tool
306
+ Kung gumagamit ka ng CLI tool tulad ng [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
307
+ tiyak na gugustuhin mong paganahin ang redis cache, dahil tumatagal ito sa mga invocation ng utos na `mo` .
308
+
309
+ ## Pagsasalamin
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
+ Ang utos `mirror` ay nagsasagawa ng isang beses na kopya ng lahat ng mga file mula sa isang mobiletto patungo sa isa pa.
318
+ Hindi ito nagpapatakbo ng anumang proseso upang mapanatili ang salamin sa paglipas ng panahon. Patakbuhin muli ang utos na `mirror`
319
+ upang i-synchronize ang anumang nawawalang mga file.
320
+
321
+ Ang return value mula sa `mirror` ay isang simpleng bagay na may mga counter para sa kung gaano karaming mga file ang matagumpay
322
+ na-mirror at kung gaano karaming mga file ang may mga error:
323
+
324
+ {
325
+ success: count-of-files-mirrored,
326
+ errors: count-of-files-with-errors
327
+ }
328
+
329
+ BABALA: Ang pag-mirror ng malalaking set ng data ay maaaring masyadong nakakaubos ng oras at bandwidth-intensive
330
+
331
+ Sa `mirror` call semantics, minsan ay nakakalito kung sino ang
332
+ mambabasa at sino ang manunulat. Isipin ito tulad ng isang pahayag ng pagtatalaga: ang "kaliwang kamay na mobiletto"
333
+ ay ang bagay na itinatalaga sa (naka-mirror na data na nakasulat), at ang "right-hand mobiletto" (ang
334
+ argumento sa `mirror` method) ay ang value na itinalaga (nabasa ang naka-mirror na data).
335
+
336
+ ## Transparent na pag-encrypt
337
+ Paganahin ang transparent na 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
+ Anong nangyayari? Sinusubaybayan ng isang hiwalay na "pagpasok ng direktoryo" (dirent) na direktoryo (naka-encrypt) kung anong mga file ang naroroon
357
+ direktoryo (aka ang direktang direktoryo).
358
+ * Ang utos `list` nagbabasa ng mga file ng entry sa direktoryo, nagde-decrypt sa bawat landas na nakalista; pagkatapos ay nagbabalik ng metadata para sa bawat file
359
+ * Ang mga utos `list` ay mas hindi epektibo, lalo na para sa mga direktoryo na may malaking bilang ng mga file
360
+ * Ang utos `write` nagsusulat ng mga dirent na file sa direktoryo ng bawat magulang, nang paulit-ulit; pagkatapos ay isinusulat ang file
361
+ * Ang mga command `write` ay magkakaroon ng O(N) writes, na may N = depth sa hierarchy ng direktoryo
362
+ * Tinatanggal ng utos `remove` ang kaukulang dirent file, at ang magulang nito kung walang laman, recursively; pagkatapos ay tanggalin ang file
363
+ * Ang mga non-recursive na `remove` command ay magkakaroon ng O(N) reads at posibleng kasing dami ng delete, na may N = depth sa directory hierarchy
364
+ * `remove` command sa malaki at malalalim na filesystem ay maaaring magastos
365
+
366
+ Tandaan na kahit na naka-enable ang client-side encryption, isang kalaban na may ganap na visibility sa iyong naka-encrypt na server-side
367
+ imbakan, kahit na wala ang susi, ay makikita pa rin ang kabuuang bilang ng mga direktoryo at kung gaano karaming mga file ang nasa bawat isa, at kasama
368
+ ilang pagsisikap, tuklasin ang ilan o lahat ng pangkalahatang istraktura ng hierarchy ng direktoryo.
369
+ *Tandaan: Gumamit ng medyo patag na istraktura para sa mas mahusay na seguridad.*
370
+ Hindi malalaman ng kalaban ang mga pangalan ng mga direktoryo/file maliban kung alam din nila ang iyong encryption
371
+ key o kung hindi man ay matagumpay na na-crack ang encryption. Tapos na lahat ng taya!
372
+
373
+ ### Pagganap at pag-cache
374
+ Maaaring mabagal ang mga operasyon sa naka-encrypt na storage. Ang mga recursive na listahan at pag-alis ay maaaring maging napakabagal.
375
+ Ang pag-cache sa pamamagitan ng redis ay nakakatulong nang malaki, ngunit tandaan na ang cache ay namumula sa anumang pagsusulat o pag-alis.
376
+
377
+ ## Pag-ikot ng key
378
+ Gumawa ng mobiletto gamit ang iyong bagong key, pagkatapos ay i-mirror ang lumang data dito:
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
+ ## Interface ng driver
391
+ Ang driver ay anumang JS file na nag-e-export ng function na 'storageClient' na may ganitong lagda:
392
+
393
+ function storageClient (key, secret, opts)
394
+
395
+ * `key` : isang string, ang iyong API key (para sa `local` driver ito ang base directory)
396
+ * `secret` : isang string, ang iyong API secret (maaaring tanggalin para sa `local` driver)
397
+ * `opts` : isang object, ang mga katangian ay per-driver:
398
+ * Para sa `local` , tinutukoy ng `fileMode` at `dirMode` properties kung paano nilikha ang mga bagong file at direktoryo
399
+ * Para sa `s3` , ang `bucket` property ay kinakailangan. Ang mga opsyonal na katangian ay:
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
+ Ang bagay na ibinalik ng storageClient function ay dapat tukuyin ang mga function na ito:
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
+ ## Pagtotroso
431
+ Ginagamit ng Mobiletto ang [winston](https://www.npmjs.com/package/winston) logging library.
432
+
433
+ Ang mga log **ay** maglalaman ng mga landas ng file at mga mensahe ng error, ngunit **hindi** maglalaman ng mga susi, lihim,
434
+ o anumang iba pang impormasyon sa pagsasaayos ng koneksyon.
435
+
436
+ ### Antas ng log
437
+ Gamitin ang `MOBILETTO_LOG_LEVEL` environment variable upang itakda ang antas ng log, gamit ang isa
438
+ ng mga antas ng `npm` tinukoy sa [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
439
+
440
+ Ang default na antas ay `error` . Ang pinaka-verbose na antas ay `silly` , bagama't kasalukuyang mobiletto
441
+ ay hindi nagla-log sa mga antas sa ibaba `debug`
442
+
443
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
444
+
445
+ ### Log file
446
+ Bilang default, nagsusulat ang logger sa console. Upang magpadala ng mga log sa isang file, itakda ang `MOBILETTO_LOG_FILE`
447
+ variable ng kapaligiran. Kapag nagla-log sa isang file, hindi na isusulat ang mga log sa console.
448
+
449
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
450
+
451
+ Upang i-off ang pag-log:
452
+
453
+ MOBILETTO_LOG_FILE=/dev/null
454
+
455
+ </pre>