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 yra „JavaScript“ saugyklos abstrakcijos sluoksnis su pasirenkamu skaidriu kliento šifravimu.
5
+
6
+ # Turinys
7
+ * [Kodėl Mobiletto?](#Why-Mobiletto?)
8
+ * [Greita pradžia](#Greita pradžia)
9
+ * [Mobiletto CLI](#mobiletto-cli)
10
+ * [Šaltinis](#Šaltinis)
11
+ * [Pagrindinis naudojimas](#Basic-usage)
12
+ * [Metaduomenys](#Metadata)
13
+ * [Alternatyvus importavimo stilius](#Alternate-import-style)
14
+ * [Caching](#Caching)
15
+ * [Dubliavimas](# Veidrodis)
16
+ * [Skaidrus šifravimas](#Transparent-encryption)
17
+ * [Key rotation](#Key-rotation)
18
+ * [Vairuotojo sąsaja](#Driver-interface)
19
+ * [Logging](#Logging)
20
+
21
+ # Skaitykite tai kita kalba
22
+ Šis README.md dokumentas per [hokeylization](https://github.com/cobbzilla/hokeylization) buvo išverstas į
23
+ **[Visos kalbos palaikomos „Google“ vertėjo](https://cloud.google.com/translate/docs/languages)!**
24
+
25
+ Esu tikras, kad tai nėra tobula, bet tikiuosi, kad tai geriau nei nieko!
26
+
27
+ [🇸🇦 arabų kalba](../ar/README.md)
28
+ [🇧🇩 Bengalų kalba](../bn/README.md)
29
+ [🇩🇪 Vokiečių kalba](../de/README.md)
30
+ [🇺🇸 Anglų kalba](../en/README.md)
31
+ [🇪🇸 ispanų kalba](../es/README.md)
32
+ [🇫🇷 prancūzų kalba](../fr/README.md)
33
+ [🇹🇩 Hausa](../ha/README.md)
34
+ [🇮🇳 Hindi](../hi/README.md)
35
+ [🇮🇩 Indoneziečių](../id/README.md)
36
+ [🇮🇹 italų kalba](../it/README.md)
37
+ [🇯🇵 japonų kalba](../ja/README.md)
38
+ [🇰🇷 korėjiečių](../ko/README.md)
39
+ [🇮🇳 Maranthi](../mr/README.md)
40
+ [🇵🇱 lenkų kalba](../pl/README.md)
41
+ [🇧🇷 portugalų](../pt/README.md)
42
+ [🇷🇺 rusų kalba](../ru/README.md)
43
+ [🇰🇪 Svahilių kalba](../sw/README.md)
44
+ [🇵🇭 Tagalog](../tl/README.md)
45
+ [🇹🇷 turkų](../tr/README.md)
46
+ [🇵🇰 urdu](../ur/README.md)
47
+ [🇻🇳 vietnamiečių](../vi/README.md)
48
+ [🇨🇳 kinų](../zh/README.md)
49
+
50
+
51
+ **[📚 ... Visos kalbos ...](../README.md)**
52
+ ----
53
+
54
+ ### Ar yra problemų dėl šio README vertimo?
55
+ Šis konkretus originalo [README] vertimas (https://github.com/cobbzilla/mobiletto/blob/master/README.md)
56
+ gali būti su trūkumais – *labai laukiami pataisymai!* Nusiųskite [ištraukimo užklausą „GitHub“](https://github.com/cobbzilla/mobiletto/pulls),
57
+ arba jei nenorite to daryti, [atidarykite problemą](https://github.com/cobbzilla/mobiletto/issues)
58
+
59
+ Kai kuriate naują „GitHub“ problemą apie vertimą, atlikite toliau nurodytus veiksmus.
60
+ * įtraukite puslapio URL (nukopijuokite / įklijuokite iš naršyklės adreso juostos)
61
+ * įtraukite tikslų tekstą, kuris neteisingas (nukopijuokite / įklijuokite iš naršyklės)
62
+ * aprašykite, kas negerai – ar vertimas neteisingas? ar formatavimas kažkaip sugedęs?
63
+ * maloniai pasiūlykite geresnio vertimo pasiūlymą arba kaip tinkamai suformatuoti tekstą
64
+ * **Ačiū!**
65
+
66
+ ## Kodėl Mobiletto?
67
+
68
+ ### Atsisveikink su pardavėju!
69
+ Įvairūs debesų saugyklos teikėjai turi nesuderinamų API. Net tie, kurie siekia „S3 suderinamumo“
70
+ turi savitą elgesį.
71
+
72
+ Kai pasirenkate tam tikrą programos saugyklos tiekėją, koduojate tiesiai į jo API, savo programą
73
+ dabar priklauso nuo šios paslaugos. Laikui bėgant ir kaupiantis kodui, keičiasi pardavėjai
74
+ vis labiau nepakeliamas. Sveiki atvykę į linksmą pardavėjo užrakinimo pasaulį!
75
+
76
+ Mobiletto buvo sukurtas šiai problemai išspręsti. Užkoduodami programą į mobiletto API, galite lengvai
77
+ pakeiskite saugyklos teikėjus ir žinokite, kad jūsų programos saugyklos sluoksnis veiks identiškai.
78
+
79
+ ### Išsamūs bandymai
80
+ Visi vairuotojai yra tikrinami dėl identiško elgesio su 60 ir daugiau testų kiekvienam vairuotojui.
81
+ Mes išbandome visas tvarkykles su visomis kombinacijomis:
82
+ * Šifravimas: įjungtas ir išjungtas
83
+ * Redis cache: įjungta ir išjungta
84
+
85
+ Šis metodas suteikia mums ramybę, kad „mobiletto“ veiks taip pat, nepaisant to, kurią tvarkyklę naudojate,
86
+ ir neatsižvelgiant į tai, ar įgalinate talpyklą ir (arba) šifravimą.
87
+
88
+ ### Vairuotojo palaikymas
89
+ Dabartinės Mobiletto saugyklos tvarkyklės:
90
+ * `s3` : Amazon S3
91
+ * `b2` : Backblaze B2
92
+ * `local` : vietinė failų sistema
93
+
94
+ *Labai laukiame indėlio į daugiau debesies saugyklos teikėjų!*
95
+
96
+ ## mobiletto-cli
97
+ Mobiletto skirtas naudoti kaip biblioteka su kitu JavaScript kodu.
98
+
99
+ Norėdami dirbti su mobiletto komandų eilutėje, naudokite [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
100
+
101
+ ## Šaltinis
102
+ * [mobiletto on GitHub](https://github.com/cobbzilla/mobiletto)
103
+ * [mobiletto on npm](https://www.npmjs.com/package/mobiletto)
104
+
105
+ ## Greita pradžia
106
+ Trumpas pavyzdys naudojant mobiletto `s3` tvarkyklę.
107
+
108
+ Šis kodas veiktų taip pat, jei tvarkyklė būtų `b2` arba `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
+ ## Pagrindinis naudojimas
139
+ Daug platesnis pavyzdys, rodantis daugumą siūlomų funkcijų:
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
+ ## Metaduomenys
241
+ Komanda `metadata` grąžina vieno failų sistemos įrašo metaduomenis.
242
+ Panašiai iš komandos `list` grąžinama reikšmė yra metaduomenų objektų masyvas.
243
+
244
+ Metaduomenų objektas atrodo taip:
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
+ `type` "type" gali būti `file` " , `dir` " , `link` arba `special` .
255
+
256
+ Atsižvelgiant į tvarkyklės tipą, komanda `list` gali nepateikti visų laukų. Savybės `name` ir `type` .
257
+ visada turi būti šalia. Vėlesnė `metadata` komanda grąžins visas galimas ypatybes.
258
+
259
+ ## Alternatyvus importavimo stilius
260
+ Importuokite visą modulį ir naudokite funkciją `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
+ ## Talpykla
268
+ Mobiletto geriausiai veikia su <a href="https://redis.io">redis</a> talpykla.
269
+
270
+ Mobiletto bandys prisijungti prie redis egzemplioriaus 127.0.0.1:6379
271
+
272
+ Galite nepaisyti bet kurio iš šių:
273
+ * Nustatykite `MOBILETTO_REDIS_HOST` env var, mobilusis jungtis čia, o ne localhost
274
+ * Nustatykite `MOBILETTO_REDIS_PORT` env var, šis prievadas bus naudojamas
275
+
276
+ „Mobiletto“ saugos visus savo „redis“ raktus su priešdėliu `_mobiletto__` . Galite tai pakeisti
277
+ nustatydami `MOBILETTO_REDIS_PREFIX` env var.
278
+
279
+ Taip pat galite nustatyti kiekvieno ryšio talpyklą naudodami objektą `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
+ ### Nenorite perrašyti talpyklos?
291
+ Norėdami išjungti: kai užmezgate ryšį, `enabled: false` `opts.redisConfig` .
292
+
293
+ Kaip aptarta toliau, talpyklos išjungimas turės neigiamos įtakos našumui ir sukels daugiau užklausų
294
+ į saugyklą, kurios jums tikrai reikia.
295
+
296
+ ### Talpyklos talpyklos nurodymai
297
+ **Šifruota saugykla**: šifruota saugykla nuskaitoma / rašoma tik šiek tiek lėčiau nei įprasta,
298
+ bet naršymas po katalogus (ką kai kurie dalykai daro) yra gana brangu. Naudojant redis talpyklą
299
+ žymiai padidins našumą.
300
+
301
+ Numatytoji talpykla yra saugi, bet neveikia gerai, jei atliekate daug rašymo / šalinimo operacijų.
302
+ Bet kokia įrašymo ar pašalinimo operacija padaro negaliojančią visą talpyklą, todėl vėlesni skaitymai bus rodomi
303
+ naujausius pakeitimus.
304
+
305
+ ### CLI įrankiai
306
+ Jei naudojate CLI įrankį, pvz., [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
307
+ tikrai norėsite, kad būtų įjungta „redis“ talpykla, nes ji galioja `mo` komandą „mo“.
308
+
309
+ ## Veidrodis
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
+ Komanda `mirror` atlieka vienkartinę visų failų kopiją iš vieno mobiliojo į kitą.
318
+ Jis nevykdo jokio proceso, kad ilgainiui prižiūrėtų veidrodį. Dar kartą paleiskite komandą `mirror` .
319
+ sinchronizuoti trūkstamus failus.
320
+
321
+ Grąžinama vertė iš `mirror` yra paprastas objektas su sėkmingų failų skaitikliais
322
+ veidrodinis ir kiek failų buvo klaidų:
323
+
324
+ {
325
+ success: count-of-files-mirrored,
326
+ errors: count-of-files-with-errors
327
+ }
328
+
329
+ ĮSPĖJIMAS: didelių duomenų rinkinių atspindėjimas gali užtrukti daug laiko ir pralaidumo.
330
+
331
+ Naudojant `mirror` skambučio semantiką, kartais gali būti painu suprasti, kas yra
332
+ skaitytojas ir kas yra rašytojas. Įsivaizduokite tai kaip priskyrimo teiginį: „kairės rankos mobilusis“
333
+ yra daiktas, kuriam priskiriamas (rašomi veidrodiniai duomenys), ir „dešinės pusės mobilusis telefonas“ (
334
+ `mirror` metodo argumentas) yra priskiriama reikšmė (skaitomi veidrodiniai duomenys).
335
+
336
+ ## Skaidrus šifravimas
337
+ Įgalinti skaidrų kliento pusės šifravimą:
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
+ Kas vyksta? Atskiras "katalogo įrašas" (tiesioginis) katalogas (šifruotas) seka, kokie failai yra tame
357
+ katalogas (dar žinomas kaip dirent katalogas).
358
+ * Komanda `list` nuskaito katalogo įvesties failus, iššifruoja kiekvieną nurodytą kelią; tada grąžina kiekvieno failo metaduomenis
359
+ * `list` komandos yra neefektyvesnės, ypač katalogams, kuriuose yra daug failų
360
+ * Komanda `write` įrašo skirtingus failus į kiekvieno iš tėvų dirent katalogą; tada rašo failą
361
+ * `write` komandos sukels O(N) įrašų, o N = gylis katalogų hierarchijoje
362
+ * Komanda `remove` pašalinti" pašalina atitinkamą dirent failą ir jo pirminį failą, jei jis tuščias, rekursyviai; tada pašalina failą
363
+ * `remove` komandos bus nuskaitomos O (N) ir galbūt net tiek pat ištrynimų, o N = gylis katalogų hierarchijoje
364
+ * `remove` komandos didelėse ir giliose failų sistemose gali būti brangios
365
+
366
+ Atminkite, kad net ir įjungus kliento pusės šifravimą, priešas gali visiškai matyti jūsų užšifruotą serverio pusę
367
+ saugykla, net ir be rakto, vis tiek gali matyti bendrą katalogų skaičių ir kiek failų yra kiekviename ir su
368
+ šiek tiek pastangų, atrasti dalį arba visą bendrą katalogų hierarchijos struktūrą.
369
+ *Pastaba: naudokite palyginti plokščią konstrukciją, kad užtikrintumėte didesnį saugumą.*
370
+ Priešas nežinos katalogų/failų pavadinimų, nebent žinotų ir jūsų šifravimą
371
+ raktą arba kitaip sėkmingai nulaužė šifravimą. Tada visi statymai atšaukiami!
372
+
373
+ ### Našumas ir talpyklos kaupimas
374
+ Užšifruotos saugyklos operacijos gali būti lėtos. Rekursyvūs sąrašai ir pašalinimas gali būti labai lėtas.
375
+ Talpyklos kaupimas naudojant „redis“ labai padeda, tačiau atminkite, kad talpykla iškraunama, kai įrašoma ar pašalinama.
376
+
377
+ ## Raktų pasukimas
378
+ Sukurkite mobilųjį telefoną naudodami naują raktą, tada atspindėkite jame senus duomenis:
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
+ ## Vairuotojo sąsaja
391
+ Tvarkyklė yra bet koks JS failas, kuris eksportuoja funkciją „storageClient“ su šiuo parašu:
392
+
393
+ function storageClient (key, secret, opts)
394
+
395
+ * `key` : eilutė, jūsų API raktas ( `local` tvarkyklei tai yra pagrindinis katalogas)
396
+ * `secret` : eilutė, jūsų API paslaptis (galima praleisti `local` tvarkyklėje)
397
+ * `opts` : objektas, ypatybės priklauso nuo tvarkyklės:
398
+ * `local` `fileMode` ir `dirMode` nustato, kaip sukuriami nauji kūrimo failai ir katalogai
399
+ * Jei naudojate `s3` “, būtina savybė `bucket` . Pasirenkamos savybės yra:
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
+ Objektas, kurį grąžina funkcija storageClient, turi apibrėžti šias funkcijas:
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
+ ## Registravimas
431
+ Mobiletto naudoja [winston](https://www.npmjs.com/package/winston) registravimo biblioteką.
432
+
433
+ Žurnaluose **bus** bus failų keliai ir klaidų pranešimai, bet **niekada** nebus raktų, paslapčių,
434
+ arba bet kokia kita ryšio konfigūracijos informacija.
435
+
436
+ ### Žurnalo lygis
437
+ Norėdami nustatyti žurnalo lygį, naudokite aplinkos kintamąjį `MOBILETTO_LOG_LEVEL`
438
+ iš `npm` lygių, apibrėžtų [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
439
+
440
+ Numatytasis lygis yra `error` . Daugiakalbis lygis yra `silly` , nors šiuo metu mobilusis
441
+ neprisiregistruoja žemiau `debug`
442
+
443
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
444
+
445
+ ### Žurnalo failas
446
+ Pagal numatytuosius nustatymus registratorius rašo į konsolę. Norėdami siųsti žurnalus į failą, nustatykite `MOBILETTO_LOG_FILE`
447
+ aplinkos kintamasis. Prisijungus prie failo, žurnalai nebebus įrašomi į konsolę.
448
+
449
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
450
+
451
+ Norėdami išjungti registravimą:
452
+
453
+ MOBILETTO_LOG_FILE=/dev/null
454
+
455
+ </pre>