mobiletto 1.1.9 → 1.1.12

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 +82 -4
  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 +24 -6
  112. package/hokey.json +16 -0
  113. package/index.js +32 -16
  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,481 @@
1
+ Mobiletto
2
+ =========
3
+
4
+ Mobiletto JavaScript biltegiratze abstrakzio geruza bat da, aukerako bezeroaren aldeko enkriptazio gardena duena.
5
+
6
+ # Edukiak
7
+ * [Zergatik Mobiletto?](#Zergatik-Mobiletto?)
8
+ * [Hasiera azkarra](#Abiarazte azkarra)
9
+ * [Mobiletto CLI](#mobiletto-cli)
10
+ * [Iturria](#Iturria)
11
+ * [Instalazioa](#Instalazioa)
12
+ * [Laguntza eta finantzaketa](#Support-and-Funding)
13
+ * [Oinarrizko erabilera](#Oinarrizko erabilera)
14
+ * [Metadatuak](#Metadatuak)
15
+ * [Alternate inportazio estiloa](#Alternate-inportazio-estiloa)
16
+ * [Caching](#Caching)
17
+ * [Ispilu](#Ispilu)
18
+ * [Enkriptatzea gardena](#Transparent-encryption)
19
+ * [Teklaren biraketa](#Teklaren biraketa)
20
+ * [Gidari-interfazea](#Driver-interfazea)
21
+ * [Logging](#Logging)
22
+
23
+ # Irakurri hau beste hizkuntza batean
24
+ README.md dokumentu hau [hokeylization](https://github.com/cobbzilla/hokeylization) bidez itzuli da.
25
+ **[Google Translate-k onartzen duen hizkuntza guztietan](https://cloud.google.com/translate/docs/languages)!**
26
+
27
+ Ziur nago ez dela perfektua, baina espero dut ezer baino hobea izatea!
28
+
29
+ [🇸🇦 arabiera](../ar/README.md)
30
+ [🇧🇩 bengalera](../bn/README.md)
31
+ [🇩🇪 alemana](../de/README.md)
32
+ [🇺🇸 Ingelesa](../eu/README.md)
33
+ [🇪🇸 Gaztelania](../es/README.md)
34
+ [🇫🇷 frantsesa](../fr/README.md)
35
+ [🇹🇩 Hausa](../ha/README.md)
36
+ [🇮🇳 Hindi](../hi/README.md)
37
+ [🇮🇩 indonesiera](../id/README.md)
38
+ [🇮🇹 italiera](../it/README.md)
39
+ [🇯🇵 Japoniera](../ja/README.md)
40
+ [🇰🇷 koreera](../ko/README.md)
41
+ [🇮🇳 Maranthi](../mr/README.md)
42
+ [🇵🇱 poloniera](../pl/README.md)
43
+ [🇧🇷 portugesa](../pt/README.md)
44
+ [🇷🇺 errusiera](../ru/README.md)
45
+ [🇰🇪 Swahili](../sw/README.md)
46
+ [🇵🇭 Tagalog](../tl/README.md)
47
+ [🇹🇷 turkiera](../tr/README.md)
48
+ [🇵🇰 Urdu](../ur/README.md)
49
+ [🇻🇳 vietnamera](../vi/README.md)
50
+ [🇨🇳 txinera](../zh/README.md)
51
+
52
+
53
+ **[📚 ... Hizkuntza guztiak ...](../README.md)**
54
+ ----
55
+
56
+ ### Arazorik al dago IRAKURRI-ren itzulpen honekin?
57
+ [README] jatorrizkoaren itzulpen zehatz hau (https://github.com/cobbzilla/mobiletto/blob/master/README.md)
58
+ akatsa izan daiteke -- *zuzenketak oso ongi etorriak dira!* Bidali [pull eskaera GitHub-en](https://github.com/cobbzilla/mobiletto/pulls),
59
+ edo hori egiten eroso ez bazaude, [ireki arazo bat](https://github.com/cobbzilla/mobiletto/issues)
60
+
61
+ Itzulpen bati buruzko GitHub-en arazo berri bat sortzen duzunean, egin:
62
+ * Sartu orriaren URLa (kopiatu/itsatsi arakatzailearen helbide barratik)
63
+ * sartu oker dagoen testu zehatza (kopiatu/itsatsi arakatzailetik)
64
+ * Mesedez, deskribatu zer dagoen gaizki -- itzulpena okerra al da? formatua hautsi al da nolabait?
65
+ * Mesedez, eskaini itzulpen hobeago baten iradokizuna, edo testua nola formateatu behar den
66
+ * **Eskerrik asko!**
67
+
68
+ ## Zergatik Mobiletto?
69
+
70
+ ### Agur saltzaileen blokeoa!
71
+ Hodeiko biltegiratze hornitzaile ezberdinek API bateraezinak dituzte. "S3 bateragarritasuna" bilatzen dutenek ere
72
+ jokabide idiosinkratikoak dituzte.
73
+
74
+ Zure aplikaziorako biltegiratze-saltzaile jakin bat aukeratzen duzunean, zuzenean haien APIan kodetzen baduzu, zure aplikazioan
75
+ zerbitzu horren menpe dago orain. Denbora pasa eta kodea pilatu ahala, saltzaileen aldaketa bihurtzen da
76
+ gero eta jasangaitzagoa. Ongi etorri saltzaileen blokeoaren mundu dibertigarrira!
77
+
78
+ Mobiletto arazo hau konpontzeko diseinatu zen. Zure aplikazioa mobiletto-ren APIra kodetuz, erraz egin dezakezu
79
+ aldatu biltegiratze-hornitzaileak eta jakin zure aplikazioaren biltegiratze-geruzak berdin-berdin jokatuko duela.
80
+
81
+ ### Proba zabalak
82
+ Gidari guztiek portaera berdina duten probak egiten dituzte gidari bakoitzeko 60 proba baino gehiagorekin.
83
+ Gidari guztiak probatzen ditugu honako konbinazio guztiekin:
84
+ * Enkriptatzea: gaituta eta desgaituta
85
+ * Redis cachea: gaituta eta desgaituta
86
+
87
+ Ikuspegi honek lasaitasuna ematen digu mobilettok berdin jokatuko duela erabiltzen duzun gidari edozein dela ere,
88
+ eta cachea eta/edo enkriptatzea gaitzen duzun ala ez.
89
+
90
+ ### Gidariaren laguntza
91
+ Egungo Mobiletto biltegiratze kontrolatzaileak:
92
+ * `s3` : Amazon S3
93
+ * `b2` : Backblaze B2
94
+ * `local` : fitxategi-sistema lokala
95
+
96
+ *Hodeiko biltegiratze hornitzaile gehiago laguntzeko ekarpenak oso ongi etorriak dira!*
97
+
98
+ ## mobiletto-cli
99
+ Mobiletto beste JavaScript kode batzuek liburutegi gisa erabiltzeko pentsatuta dago.
100
+
101
+ Mobiletto-rekin komando lerroan lan egiteko, erabili [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
102
+
103
+ ## Iturria
104
+ * [mobiletto GitHub-en](https://github.com/cobbzilla/mobiletto)
105
+ * [mobiletto npm-n](https://www.npmjs.com/package/mobiletto)
106
+
107
+ ## Laguntza eta finantzaketa
108
+ Kode irekiko software garatzaile profesionala izaten saiatzen ari naiz. lanean aritu naiz
109
+ urte askotan softwarearen industrian, enpresa arrakastatsuak sortu eta enpresa publikoei saldu ditut.
110
+ Duela gutxi lana galdu nuen, eta ez daukat beste lanik prest
111
+
112
+ Beraz, software lagungarria idazten saiatuko naiz eta ea funtzionatzen duen
113
+
114
+ Software hau erabiltzea gustatzen bazaizu, asko eskertuko nuke
115
+ txikiena [Patreon bidezko hileko ekarpena](https://www.patreon.com/cobbzilla)
116
+
117
+ *Eskerrik asko!*
118
+
119
+ ## Instalazioa
120
+ Instalatu `npm` edo `yarn` erabiliz. Seguruenik, `lite` bertsioa nahi duzu guztiak barne hartzen ez dituena
121
+ itzulitako README fitxategiak:
122
+
123
+ npm install mobiletto-lite
124
+ yarn add mobiletto-lite
125
+
126
+ README fitxategiak hizkuntza guztietan nahi badituzu, instalatu bertsio osoa:
127
+
128
+ npm install mobiletto
129
+ yarn add mobiletto
130
+
131
+ ## Hasiera azkarra
132
+ Adibide labur bat mobiletto `s3` kontrolatzailea erabiliz.
133
+
134
+ Kode hau berdin exekutatuko litzateke kontrolatzailea `b2` edo `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
+ ## Oinarrizko erabilera
165
+ Adibide askoz zabalagoa, eskaintzen diren ezaugarri gehienak erakusten dituena:
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
+ ## Metadatuak
267
+ `metadata` komandoak fitxategi-sistemako sarrera bakar bati buruzko metadatuak itzultzen ditu.
268
+ Era berean, `list` komandoaren itzulera-balioa metadatu objektuen array bat da.
269
+
270
+ Metadatu objektu batek itxura hau du:
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
+ `type` propietatea `file` , `dir` , `link` edo `special` .
281
+
282
+ Gidari motaren arabera, `list` komandoak baliteke eremu guztiak ez itzultzea. `name` eta `type` propietateak
283
+ beti egon behar du. Ondorengo `metadata` komando batek erabilgarri dauden propietate guztiak itzuliko ditu.
284
+
285
+ ## Inportazio estilo alternatiboa
286
+ Inportatu eremu osoko modulua eta erabili `connect` funtzioa:
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
+ ## Cachean gordetzea
294
+ Mobiletto-k hobekien funtzionatzen du <a href="https://redis.io">redis</a> cache batekin.
295
+
296
+ Mobiletto redis instantzia batera konektatzen saiatuko da 127.0.0.1:6379
297
+
298
+ Hauetako bat gainidatzi dezakezu:
299
+ * Ezarri `MOBILETTO_REDIS_HOST` env var, mugikorra hemen konektatu tokiko ostalariaren ordez
300
+ * Ezarri `MOBILETTO_REDIS_PORT` env var, ataka hau erabiliko da
301
+
302
+ Mobiletto-k bere redis gako guztiak gordeko ditu `_mobiletto__` aurrizkiarekin. Hau alda dezakezu
303
+ `MOBILETTO_REDIS_PREFIX` env var.
304
+
305
+ Konexio bakoitzeko cachea ere ezar dezakezu `opts.redisConfig` objektuarekin:
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
+ ### Ez duzu nahi redis cachean?
317
+ Desgaitzeko: pasa `enabled: false` zure `opts.redisConfig` objektuan zure konexioa ezartzen duzunean.
318
+
319
+ Jarraian azaltzen den bezala, cachea desgaitzeak eragin kaltegarria izango du errendimenduan eta eskaera gehiago sortuko ditu
320
+ benetan behar duzun biltegiratzera.
321
+
322
+ ### Cachean gordetzeko jarraibideak
323
+ **Biltegiratze enkriptatua**: biltegiratze enkriptatutako irakurketa/idazketa normala baino apur bat motelagoa da,
324
+ baina direktorioetan zehar nabigatzea (gauza batzuk egiten dutena) nahiko garestia da. Redis cachea erabiliz
325
+ errendimenduaren bultzada nabarmena emango dizu.
326
+
327
+ Cache lehenetsia segurua da, baina ez du ondo funtzionatzen idazteko/kentzeko eragiketa asko egiten badituzu.
328
+ Idazteko edo kentzeko eragiketa orok cache osoa baliogabetzen du, ondorengo irakurketak ikusiko duela bermatuz
329
+ azken aldaketak.
330
+
331
+ ### CLI tresnak
332
+ [mobiletto-cli] bezalako CLI tresna bat erabiltzen ari bazara (https://www.npmjs.com/package/mobiletto-cli),
333
+ zalantzarik gabe, redis cachea gaituta nahi izango duzu, `mo` komandoaren deialdietan irauten baitu.
334
+
335
+ ## Ispilua
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` komandoak fitxategi guztien kopia bat egiten du mobiletto batetik bestera.
344
+ Ez du prozesurik exekutatzen ispilua denboran mantentzeko. Exekutatu `mirror` komandoa berriro
345
+ falta diren fitxategiak sinkronizatzeko.
346
+
347
+ `mirror` -ren itzulera-balioa objektu soil bat da, zenbat fitxategi arrakastatsu izan diren kontagailuak dituena
348
+ ispilu eta zenbat fitxategi izan dituzten erroreak:
349
+
350
+ {
351
+ success: count-of-files-mirrored,
352
+ errors: count-of-files-with-errors
353
+ }
354
+
355
+ OHARRA: datu-multzo handiak islatzea oso denbora asko eta banda zabalera handia izan daiteke
356
+
357
+ `mirror` dei semantikarekin batzuetan nahasgarria izan daiteke nor den ulertzea
358
+ irakurlea eta nor den idazlea. Imajinatu esleipen adierazpen bat bezala: "ezkerreko mobiletto"
359
+ esleitzen zaion gauza da (ispilutako datuak idatzita), eta "eskuineko mobiletto" (the
360
+ `mirror` metodoari argumentua) esleitzen ari den balioa da (ispilutako datuak irakurtzen dira).
361
+
362
+ ## Enkriptatzea gardena
363
+ Gaitu bezeroaren aldeko enkriptatzea gardena:
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
+ Zer ari da gertatzen? "Directory sarrera" (zuzeneko) direktorio (zifratuta) bereizi batek zer fitxategi dauden jarraitzen du
383
+ direktorioa (aka dirent direktorioa).
384
+ * `list` komandoak direktorioko sarrera fitxategiak irakurtzen ditu, zerrendatutako bide bakoitza deszifratzen du; ondoren, fitxategi bakoitzaren metadatuak itzultzen ditu
385
+ * `list` komandoak eraginkorragoak dira, batez ere fitxategi kopuru handia duten direktorioetarako
386
+ * `write` komandoak dirent fitxategiak idazten ditu guraso bakoitzaren dirent direktorioan, modu errekurtsiboan; ondoren fitxategia idazten du
387
+ * `write` komandoek O (N) idazketak eragingo dituzte, N = sakontasuna direktorio hierarkian
388
+ * `remove` komandoak dagokion dirent fitxategia kentzen du, eta bere gurasoa hutsik badago, errekurtsiboki; gero fitxategia kentzen du
389
+ * `remove` komando ez-errekurtsiboek O(N) irakurketa eragingo dute eta, agian, beste hainbeste ezabatuko dituzte, N = sakontasuna direktorio hierarkian
390
+ * `remove` komando errekurtsiboak fitxategi-sistema handi eta sakonetan garestiak izan daitezke
391
+
392
+ Kontuan izan bezeroaren alboko enkriptatzea gaituta dagoen arren, zure zerbitzariaren enkriptatutako ikusgarritasun osoa duen arerio bat
393
+ biltegiratzeak, gakorik gabe ere, direktorio-kopuru osoa eta bakoitzean zenbat fitxategi dauden ikus dezake
394
+ ahalegin bat, aurki ezazu direktorio-hierarkiaren egitura orokorraren zati bat edo guztia.
395
+ *Oharra: erabili egitura nahiko laua segurtasun hobea lortzeko.*
396
+ Aurkariak ez luke direktorio/fitxategien izenak jakingo zure enkriptatzea ere ezagutu ezean
397
+ gakoa edo, bestela, enkriptatzea arrakastaz pitzatu izana. Apustu guztiak desaktibatuta daude orduan!
398
+
399
+ ### Errendimendua eta cachea
400
+ Biltegiratze enkriptatutako eragiketak motelak izan daitezke. Zerrenda errekurtsiboak eta kentzeak oso motelak izan daitezke.
401
+ Redis bidez gordetzeak izugarri laguntzen du, baina kontuan izan cachea idazten edo kentzen denean garbitzen dela.
402
+
403
+ ## Teklaren biraketa
404
+ Sortu mobiletto bat zure gako berriarekin, gero datu zaharrak bertan islatu:
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
+ ## Gidariaren interfazea
417
+ Gidatzailea sinadura honekin 'storageClient' funtzio bat esportatzen duen JS fitxategia da:
418
+
419
+ function storageClient (key, secret, opts)
420
+
421
+ * `key` : kate bat, zure API gakoa ( `local` kontrolatzailearentzat hau da oinarrizko direktorioa)
422
+ * `secret` : kate bat, zure API sekretua ( `local` kontrolatzailerako ezaba daiteke)
423
+ * `opts` : objektu bat, propietateak kontrolatzaile bakoitzeko dira:
424
+ * `local` -rako, `fileMode` eta `dirMode` propietateek zehazten dute nola sortzen diren fitxategi eta direktorio berriak sortzeko
425
+ * `s3` -rako, `bucket` propietatea beharrezkoa da. Aukerako propietateak hauek dira:
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
+ StorageClient funtzioak itzultzen duen objektuak funtzio hauek definitu behar ditu:
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
+ ## Erregistroa
457
+ Mobiletto-k [winston](https://www.npmjs.com/package/winston) erregistro-liburutegia erabiltzen du.
458
+
459
+ Erregistroek **fitxategien bideak eta errore-mezuak** izango dituzte, baina **inoiz** ez dituzte izango gakoak, sekretuak,
460
+ edo konexioaren konfigurazioko beste edozein informazio.
461
+
462
+ ### Erregistro-maila
463
+ Erabili `MOBILETTO_LOG_LEVEL` ingurune-aldagaia erregistro-maila ezartzeko, bat erabiliz
464
+ [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels) atalean definitutako `npm` mailen artean
465
+
466
+ Maila lehenetsia `error` da. Maila `silly` da, nahiz eta gaur egun mobiletto
467
+ ez du `debug` azpiko mailetan erregistratzen
468
+
469
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
470
+
471
+ ### Erregistro fitxategia
472
+ Lehenespenez, erregistratzaileak kontsolan idazten du. Fitxategi batera erregistroak bidaltzeko, ezarri `MOBILETTO_LOG_FILE`
473
+ ingurune-aldagaia. Fitxategi batean saioa hastean, erregistroak ez dira gehiago kontsolan idatziko.
474
+
475
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
476
+
477
+ Saioa desaktibatzeko:
478
+
479
+ MOBILETTO_LOG_FILE=/dev/null
480
+
481
+ </pre>