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 nububiko bwa JavaScript ububiko, hamwe nubushake bwabakiriya-kuruhande rwibanga.
5
+
6
+ # Ibirimo
7
+ * [Kuki Mobiletto?](# Kuki-Mobiletto?)
8
+ * [Gutangira vuba](# Byihuse-gutangira)
9
+ * [Mobiletto CLI](# mobiletto-umukiriya)
10
+ * [Inkomoko](# Inkomoko)
11
+ * [Ikoreshwa ryibanze](# Shingiro-imikoreshereze)
12
+ * [Metadata](# Metadata)
13
+ * [Ubundi buryo bwo gutumiza mu mahanga](# Ubundi buryo-bwo gutumiza mu mahanga)
14
+ * [Cishing](# Cishing)
15
+ * [Indorerwamo](# Indorerwamo)
16
+ * [Gucisha mu mucyo](# Transparent-encryption)
17
+ * [Urufunguzo ruzunguruka](# Urufunguzo-ruzunguruka)
18
+ * [Imigaragarire yumushoferi](# Umushoferi-Imigaragarire)
19
+ * [Kwinjira](# Kwinjira)
20
+
21
+ # Soma ibi mu rundi rurimi
22
+ Iyi nyandiko README.md yarahinduwe, binyuze kuri [hokeylisation](https://github.com/cobbzilla/hokeylization), muri
23
+ ** [ururimi rwose rushyigikiwe na Google Translate](https://cloud.google.com/translate/docs/ururimi)! **
24
+
25
+ Nzi neza ko bidatunganye, ariko nizere ko biruta ubusa!
26
+
27
+ [🇸🇦 Icyarabu](docs / ar / README.md)
28
+ [🇧🇩 Ikibengali](docs / bn / README.md)
29
+ [🇩🇪 Ikidage](docs / de / README.md)
30
+ [🇺🇸 Icyongereza](docs / en / README.md)
31
+ [🇪🇸 Icyesipanyoli](docs / es / README.md)
32
+ [🇫🇷 Igifaransa](docs / fr / README.md)
33
+ [🇹🇩 Hausa](docs / ha / README.md)
34
+ [🇮🇳 Hindi](docs / hi / README.md)
35
+ [🇮🇩 Indoneziya](docs / id / README.md)
36
+ [🇮🇹 Umutaliyani](docs / it / README.md)
37
+ [🇯🇵 Ikiyapani](docs / ja / README.md)
38
+ [🇰🇷 Igikoreya](docs / ko / README.md)
39
+ [🇮🇳 Maranthi](docs / mr / README.md)
40
+ [Ish Igipolonye](docs / pl / README.md)
41
+ [🇧🇷 Igiporutugali](docs / pt / README.md)
42
+ [🇷🇺 Ikirusiya](docs / ru / README.md)
43
+ [Wa Igiswahiri](docs / sw / README.md)
44
+ [🇵🇭 Tagalog](docs / tl / README.md)
45
+ [🇹🇷 Turukiya](docs / tr / README.md)
46
+ [🇵🇰 Urdu](docs / ur / README.md)
47
+ [🇻🇳 Abanya Viyetinamu](docs / vi / README.md)
48
+ [🇨🇳 Igishinwa](docs / zh / README.md)
49
+
50
+
51
+ ** [📚 ... Indimi zose ...](docs / README.md) **
52
+ ----
53
+
54
+ ### Hari ikibazo cyubu busobanuro bwa README?
55
+ Ubu busobanuro bwihariye bwumwimerere [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
56
+ irashobora kuba ifite inenge - * gukosora biremewe cyane! * Nyamuneka ohereza [gukurura icyifuzo kuri GitHub](https://github.com/cobbzilla/mobiletto/pulls),
57
+ cyangwa niba utishimiye gukora ibyo, [fungura ikibazo](https://github.com/cobbzilla/mobiletto/issues)
58
+
59
+ Mugihe uremye ikibazo gishya cya GitHub kubyerekeye ubusobanuro, nyamuneka kora:
60
+ * shyiramo urupapuro rwa URL (kopi / komatanya uhereye kuri aderesi ya aderesi)
61
+ * shyiramo inyandiko nyayo itariyo (kopi / komatanya kuri mushakisha)
62
+ * nyamuneka sobanura ibitagenda neza - ubusobanuro ntabwo aribwo? imiterere yacitse kuburyo runaka?
63
+ * mutange igitekerezo cyo gusobanura neza, cyangwa uburyo inyandiko igomba guhindurwa neza
64
+ * ** Urakoze! **
65
+
66
+ ## Kuki Mobiletto?
67
+
68
+ ### Muraho neza umucuruzi ufunguye!
69
+ Abatanga ibicu bitandukanye bitandukanye bafite API zidahuye. Ndetse nabaharanira "S3 guhuza"
70
+ kugira imyitwarire idasanzwe.
71
+
72
+ Iyo uhisemo umucuruzi wububiko runaka kuri porogaramu yawe, niba wanditse kode kuri API yabo, porogaramu yawe
73
+ ubu biterwa na serivisi. Mugihe cyigihe kandi code ikarundanya, guhindura abacuruzi biba
74
+ bigenda bidashoboka. Murakaza neza ku isi ishimishije y'abacuruzi gufunga!
75
+
76
+ Mobiletto yagenewe gukemura iki kibazo. Ukoresheje porogaramu yawe kuri API ya mobiletto, urashobora byoroshye
77
+ hindura abatanga ububiko kandi umenye ko ububiko bwa porogaramu yawe izitwara kimwe.
78
+
79
+ ### Ikizamini kinini
80
+ Abashoferi bose bapimwe imyitwarire imwe hamwe na 60+ ibizamini kuri buri shoferi.
81
+ Turagerageza abashoferi bose hamwe nibihuza byose:
82
+ * Encryption: byombi birashoboka kandi byahagaritswe
83
+ * Redis cache: byombi birashoboka kandi birahagarikwa
84
+
85
+ Ubu buryo buduha amahoro-yumutima ko mobiletto izitwara kimwe utitaye kumushoferi ukoresha,
86
+ kandi utitaye ko ushobora gukora cishing na / cyangwa encryption.
87
+
88
+ ### Inkunga yabatwara
89
+ Abashoferi ba mobiletto y'ubu:
90
+ * `s3` : Amazon S3
91
+ * `b2` : Gusubira inyuma B2
92
+ * `local` : sisitemu yimikorere
93
+
94
+ * Umusanzu wo gushyigikira abatanga ibicu byinshi murakaza neza! *
95
+
96
+ ## mobiletto-umukiriya
97
+ Mobiletto igenewe gukoreshwa nkisomero nizindi code ya JavaScript.
98
+
99
+ Gukorana na mobiletto kumurongo wumurongo, koresha [mobiletto-umukiriya](https://www.npmjs.com/package/mobiletto-cli)
100
+
101
+ ## Inkomoko
102
+ * [mobiletto kuri GitHub](https://github.com/cobbzilla/mobiletto)
103
+ * [mobiletto kuri npm](https://www.npmjs.com/package/mobiletto)
104
+
105
+ ## Tangira vuba
106
+ Urugero rugufi ukoresheje mobiletto `s3` .
107
+
108
+ Iyi code yakora kimwe niba umushoferi yari `b2` `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
+ ## Ikoreshwa ryibanze
139
+ Urugero runini cyane, rwerekana byinshi mubiranga byatanzwe:
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
+ Itegeko rya " `metadata` " risubiza metadata kubyerekeye kwinjiza dosiye imwe.
242
+ Mu buryo nk'ubwo, kugaruka agaciro kuva kuri `list` command ni umurongo wibintu bya metadata.
243
+
244
+ Ikintu cya metadata gisa nkiki:
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
+ Umutungo wa `type` urashobora kuba `file` , `dir` , `link` , cyangwa `special` .
255
+
256
+ Ukurikije ubwoko bwa shoferi, itegeko rya " `list` " ntirishobora gusubiza imirima yose. `type` `name`
257
+ igomba guhora ihari. Ibikurikira `metadata` itegeko rizasubiza ibintu byose biboneka.
258
+
259
+ ## Ubundi buryo bwo gutumiza mu mahanga
260
+ Kuzana module yuzuye kandi ukoreshe imikorere ya `connect` :
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
+ ## Cishing
268
+ <a href="https://redis.io">Mobiletto</a> ikora neza hamwe na cache itukura.
269
+
270
+ Mobiletto izagerageza guhuza nurugero rwa redis kuri 127.0.0.1:6379
271
+
272
+ Urashobora guhisha kimwe muribi:
273
+ * Shiraho `MOBILETTO_REDIS_HOST` env var, mobiletto ihuza hano aho kubahost
274
+ * Shiraho `MOBILETTO_REDIS_PORT` env var, iki cyambu kizakoreshwa
275
+
276
+ Mobiletto izabika imfunguzo zayo zose za redis hamwe `_mobiletto__` . Urashobora guhindura ibi
277
+ mugushiraho `MOBILETTO_REDIS_PREFIX` env var.
278
+
279
+ Urashobora kandi gushiraho kuri buri guhuza cashe hamwe na `opts.redisConfig` ikintu:
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
+ ### Ntushaka gufunga redis?
291
+ Kugirango uhagarike: pass `enabled: false` mubintu `opts.redisConfig` mugihe ushizeho isano yawe.
292
+
293
+ Nkuko byaganiriweho hepfo, guhagarika cishing bizagira ingaruka mbi kumikorere no gutanga ibyifuzo byinshi
294
+ kubika ukeneye rwose.
295
+
296
+ ### Cishing ubuyobozi
297
+ ** Ububiko bwabitswe **: gusoma / kwandika ububiko bwabitswe ni buhoro buhoro kurenza ibisanzwe,
298
+ ariko kugendagenda mububiko (ibyo ibintu bimwe bikora) bihenze rwose. Gukoresha cache
299
+ bizaguha imbaraga zingirakamaro.
300
+
301
+ Ubusanzwe cache ifite umutekano, ariko ntabwo ikora neza niba ufite byinshi byo kwandika / gukuraho ibikorwa.
302
+ Kwandika cyangwa gukuraho ibikorwa byose bitesha agaciro cache yose, kwemeza ko ibisomwa bizakurikiraho bizabona
303
+ impinduka ziheruka.
304
+
305
+ ### ibikoresho bya CLI
306
+ Niba ukoresha igikoresho cya CLI nka [mobiletto-umukiriya](https://www.npmjs.com/package/mobiletto-cli),
307
+ uzashaka rwose redis cache ishoboye, nkuko imara igihe cyo gutabaza kwa `mo` .
308
+
309
+ ## Indorerwamo
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
+ Itegeko rya `mirror` rikora kopi yigihe kimwe cya dosiye zose kuva mobiletto kugeza kurindi.
318
+ Ntabwo ikora inzira iyo ari yo yose yo kubungabunga indorerwamo mugihe. Ongera ukoreshe itegeko rya `mirror`
319
+ guhuza dosiye zose zabuze.
320
+
321
+ Garuka agaciro kiva muri `mirror` cyoroshye hamwe na compte yama dosiye menshi yagenze neza
322
+ indorerwamo nangahe dosiye zagize amakosa:
323
+
324
+ {
325
+ success: count-of-files-mirrored,
326
+ errors: count-of-files-with-errors
327
+ }
328
+
329
+ UMUBURO: Kwerekana amakuru manini yamakuru birashobora kugutwara igihe kandi bikaguka cyane
330
+
331
+ Hamwe na `mirror` call semantics birashobora rimwe na rimwe kwitiranya kumva uwariwe
332
+ umusomyi ninde wanditse. Tekereza nkibisobanuro byatanzwe: "ibumoso-mobiletto"
333
+ ni ikintu gihabwa (amakuru yindorerwamo yanditse), na "iburyo-mobiletto" (the
334
+ impaka kuri `mirror` method) nigiciro gihabwa (amakuru yindorerwamo arasomwa).
335
+
336
+ ## Igenzura risobanutse
337
+ Gushoboza umukiriya kuruhande rwibanga:
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
+ Bigenda bite? Ububiko bwihariye "ububiko bwinjira" (dirent) ububiko (encrypted) bukurikirana dosiye zirimo
357
+ ububiko (bita dirent diregiteri).
358
+ * "Urutonde" itegeko risoma ububiko `list` yinjira, yandika buri nzira yanditse; hanyuma asubize metadata kuri buri dosiye
359
+ * `list` amategeko ntagikora cyane cyane kububiko bufite umubare munini wamadosiye
360
+ * Itegeko rya "andika" ryandika dosiye ya `write` muri diregiteri ya buri mubyeyi, inshuro nyinshi; hanyuma wandike dosiye
361
+ * `write` amategeko azashyiramo O (N) yanditse, hamwe na N = ubujyakuzimu mubuyobozi bukurikirana
362
+ * ' `remove` itegeko rikuraho dosiye ya dirent ijyanye, hamwe nababyeyi niba ari ubusa, byongeye; hanyuma ikuraho dosiye
363
+ * Kudasubiramo `remove` amategeko bizatera O (N) gusoma kandi birashoboka nkibisiba byinshi, hamwe na N = ubujyakuzimu mubuyobozi bukurikirana
364
+ * Gusubiramo `remove` amategeko kuri sisitemu nini kandi yimbitse ya dosiye irashobora kubahenze
365
+
366
+ Menya ko nubwo hamwe nabakiriya kuruhande rwibanga rushoboye, umwanzi ufite igaragara ryuzuye muri seriveri yawe-ibanga
367
+ ububiko, nubwo nta rufunguzo, burashobora kubona umubare wububiko hamwe nangahe dosiye ziri muri buri, hamwe na
368
+ imbaraga, kuvumbura bimwe cyangwa byose muburyo rusange bwububiko bukurikirana.
369
+ * Icyitonderwa: Koresha imiterere isa neza kugirango umutekano urusheho kuba mwiza. *
370
+ Umwanzi ntabwo yamenya amazina yububiko / dosiye keretse niba nabo bari bazi encryption yawe
371
+ urufunguzo cyangwa ubundi buryo bwatsinze neza ibanga. Bets zose zirahari noneho!
372
+
373
+ ### Imikorere na cishing
374
+ Ibikorwa kububiko bwabitswe birashobora gutinda. Urutonde rusubirwamo no kuvanaho birashobora gutinda cyane.
375
+ Gufata ukoresheje redis bifasha cyane, ariko menya ko cache ihindurwamo inyandiko zose cyangwa ikuraho.
376
+
377
+ ## Kuzenguruka urufunguzo
378
+ Kora mobiletto hamwe nurufunguzo rwawe rushya, hanyuma indorerwamo amakuru ashaje muri yo:
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
+ ## Imigaragarire yabatwara
391
+ Umushoferi ni dosiye iyo ari yo yose ya JS yohereza hanze 'ububikoClient' imikorere hamwe nuyu mukono:
392
+
393
+ function storageClient (key, secret, opts)
394
+
395
+ * `key` : umugozi, urufunguzo rwa API ( `local` bubiko bwibanze)
396
+ * `secret` : umugozi, ibanga rya API yawe (rishobora gusibwa `local` shoferi)
397
+ * `opts` : ikintu, imitungo ni kuri buri shoferi:
398
+ * Kuri `local` , imitungo ya ' `fileMode` `dirMode` igena uburyo bushya bwo gukora dosiye nububiko byakozwe
399
+ * Kuri `s3` , umutungo wa ' `bucket` urakenewe. Ibintu bidahitamo ni:
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
+ Ikintu ububiko bwibikorwa bigaruka bigomba gusobanura iyi mirimo:
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
+ ## Kwinjira
431
+ Mobiletto ikoresha isomero ryibiti bya [winston](https://www.npmjs.com/package/winston).
432
+
433
+ Ibiti ** bizaba ** birimo inzira za dosiye nubutumwa bwamakosa, ariko ntibizigera ** birimo urufunguzo, amabanga,
434
+ cyangwa andi makuru yose yo guhuza amakuru.
435
+
436
+ ### Urwego Urwego
437
+ Koresha ibidukikije bya `MOBILETTO_LOG_LEVEL` kugirango ushireho urwego rwinjira, ukoresheje imwe
438
+ urwego rwa `npm` rwasobanuwe muri [https://www.npmjs.com/package/winston#logging-levels Igihugu (http:
439
+
440
+ Urwego rusanzwe ni `error` . Urwego rwinshinga cyane ni `silly` , nubwo kuri ubu mobiletto
441
+ ntabwo yinjira kurwego munsi `debug`
442
+
443
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
444
+
445
+ ### Injira dosiye
446
+ Mburabuzi, uwandika yinjira kuri konsole. Kohereza ibiti muri dosiye, shiraho `MOBILETTO_LOG_FILE`
447
+ ibidukikije birahinduka. Iyo winjiye muri dosiye, ibiti ntibizongera kwandikwa kuri konsole.
448
+
449
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
450
+
451
+ Kuzimya ibiti:
452
+
453
+ MOBILETTO_LOG_FILE=/dev/null
454
+
455
+ </pre>