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
+ A Mobiletto egy JavaScript tárolási absztrakciós réteg, opcionális transzparens kliensoldali titkosítással.
5
+
6
+ # Tartalom
7
+ * [Miért Mobiletto?](#Miért-Mobiletto?)
8
+ * [Gyors indítás](#Gyorsindítás)
9
+ * [Mobiletto CLI](#mobiletto-cli)
10
+ * [Forrás](#Forrás)
11
+ * [Alaphasználat](#Basic-usage)
12
+ * [Metaadatok](#Metadata)
13
+ * [Alternatív importstílus](#Alternate-import-style)
14
+ * [Gyorsítótárazás](#Caching)
15
+ * [Tükrözés](#Tükrözés)
16
+ * [Átlátszó titkosítás](#Transparent-encryption)
17
+ * [Key-rotation](#Key-rotation)
18
+ * [Illesztőprogram-felület](#Driver-interface)
19
+ * [Naplózás](#naplózás)
20
+
21
+ # Olvassa el ezt egy másik nyelven
22
+ Ezt a README.md dokumentumot a [hokeylization](https://github.com/cobbzilla/hokeylization) segítségével lefordították nyelvre
23
+ **[a Google Fordító által támogatott minden nyelv](https://cloud.google.com/translate/docs/languages)!**
24
+
25
+ Biztos vagyok benne, hogy nem tökéletes, de remélem, jobb a semminél!
26
+
27
+ [🇸🇦 arab](../ar/README.md)
28
+ [🇧🇩 bengáli](../bn/README.md)
29
+ [🇩🇪 német](../de/README.md)
30
+ [🇺🇸 angol](../en/README.md)
31
+ [🇪🇸 spanyol](../es/README.md)
32
+ [🇫🇷 francia](../fr/README.md)
33
+ [🇹🇩 Hausa](../ha/README.md)
34
+ [🇮🇳 hindi](../hi/README.md)
35
+ [🇮🇩 indonéz](../id/README.md)
36
+ [🇮🇹 olasz](../it/README.md)
37
+ [🇯🇵 japán](../ja/README.md)
38
+ [🇰🇷 koreai](../ko/README.md)
39
+ [🇮🇳 Maranthi](../mr/README.md)
40
+ [🇵🇱 lengyel](../pl/README.md)
41
+ [🇧🇷 portugál](../pt/README.md)
42
+ [🇷🇺 orosz](../ru/README.md)
43
+ [🇰🇪 szuahéli](../sw/README.md)
44
+ [🇵🇭 Tagalog](../tl/README.md)
45
+ [🇹🇷 török](../tr/README.md)
46
+ [🇵🇰 urdu](../ur/README.md)
47
+ [🇻🇳 vietnami](../vi/README.md)
48
+ [🇨🇳 kínai](../zh/README.md)
49
+
50
+
51
+ **[📚 ... Minden nyelv ...](../README.md)**
52
+ ----
53
+
54
+ ### Probléma van a README fordításával?
55
+ Ez a konkrét fordítás az eredeti [README]-nek (https://github.com/cobbzilla/mobiletto/blob/master/README.md)
56
+ hibás lehet -- *a javításokat nagyon szívesen fogadjuk!* Kérjük, küldjön [lehívási kérelmet a GitHubon](https://github.com/cobbzilla/mobiletto/pulls),
57
+ vagy ha nem érzi jól magát, [nyisson meg egy problémát](https://github.com/cobbzilla/mobiletto/issues)
58
+
59
+ Amikor új GitHub-kiadást hoz létre egy fordítással kapcsolatban, tegye a következőket:
60
+ * tartalmazza az oldal URL-jét (másolás/beillesztés a böngésző címsorából)
61
+ * Pontosan adja meg a hibás szöveget (másolás/beillesztés a böngészőből)
62
+ * Kérem írja le, mi a hiba -- hibás a fordítás? elromlott valahogy a formázás?
63
+ * Kérem, tegyen javaslatot jobb fordításra, vagy a szöveg helyes formázására
64
+ * **Köszönöm!**
65
+
66
+ ## Miért a Mobiletto?
67
+
68
+ ### Viszlát szállítói bezárás!
69
+ A különböző felhőalapú tárolási szolgáltatók nem kompatibilis API-kkal rendelkeznek. Még azok is, amelyek "S3-kompatibilitásra" törekszenek
70
+ sajátos viselkedésük van.
71
+
72
+ Amikor kiválaszt egy adott tárhelyszolgáltatót az alkalmazáshoz, ha közvetlenül az API-jába, az alkalmazásába kódol
73
+ most ettől a szolgáltatástól függ. Ahogy telik az idő, és a kód felhalmozódik, úgy válik a változó szállítókká
74
+ egyre tarthatatlanabb. Üdvözöljük a szállítói bezárás szórakoztató világában!
75
+
76
+ A Mobiletto-t ennek a problémának a megoldására tervezték. Ha az alkalmazást a mobiletto API-jába kódolja, egyszerűen megteheti
77
+ váltson tárhelyszolgáltatót, és tudja, hogy az alkalmazás tárhelyrétege azonos módon fog viselkedni.
78
+
79
+ ### Kiterjedt tesztelés
80
+ Minden illesztőprogram azonos viselkedését tesztelik, minden vezetőnél több mint 60 tesztet végeznek.
81
+ Minden illesztőprogramot tesztelünk a következők minden kombinációjával:
82
+ * Titkosítás: engedélyezett és letiltott
83
+ * Redis cache: engedélyezett és letiltott
84
+
85
+ Ez a megközelítés nyugalmat biztosít számunkra, hogy a mobiletto ugyanúgy fog viselkedni, függetlenül attól, hogy melyik illesztőprogramot használja,
86
+ és függetlenül attól, hogy engedélyezi-e a gyorsítótárazást és/vagy a titkosítást.
87
+
88
+ ### Illesztőprogram-támogatás
89
+ Jelenlegi Mobiletto tároló-illesztőprogramok:
90
+ * `s3` : Amazon S3
91
+ * `b2` : Backblaze B2
92
+ * `local` : helyi fájlrendszer
93
+
94
+ *Nagyon szívesen fogadjuk a további felhőalapú tárolási szolgáltatók támogatását!*
95
+
96
+ ## mobiletto-cli
97
+ A Mobiletto-t más JavaScript-kódok könyvtárként kívánják használni.
98
+
99
+ A mobiletto parancssori használatához használja a [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli) parancsot.
100
+
101
+ ## Forrás
102
+ * [mobiletto a GitHubon](https://github.com/cobbzilla/mobiletto)
103
+ * [mobiletto on npm](https://www.npmjs.com/package/mobiletto)
104
+
105
+ ## Gyors indítás
106
+ Egy rövid példa a mobiletto `s3` illesztőprogram használatára.
107
+
108
+ Ez a kód ugyanúgy futna, ha az illesztőprogram `b2` vagy `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
+ ## Alapvető használat
139
+ Egy sokkal kiterjedtebb példa, amely bemutatja a legtöbb kínált szolgáltatást:
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
+ ## Metaadatok
241
+ A `metadata` parancs egyetlen fájlrendszer-bejegyzés metaadatait adja vissza.
242
+ Hasonlóképpen, a `list` parancs visszatérési értéke metaadat-objektumok tömbje.
243
+
244
+ Egy metaadat objektum így néz ki:
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
+ A `type` type" tulajdonság lehet `file` " , `link` `dir` " , "link" vagy `special` .
255
+
256
+ Az illesztőprogram típusától függően előfordulhat, hogy a `list` parancs nem adja vissza az összes mezőt. A `name` és a `type` tulajdonságok
257
+ mindig jelen kell lennie. A következő `metadata` parancs minden elérhető tulajdonságot visszaad.
258
+
259
+ ## Alternatív importálási stílus
260
+ Importálja a teljes körű modult, és használja a `connect` funkciót:
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
+ ## Gyorsítótár
268
+ A Mobiletto a <a href="https://redis.io">redis</a> gyorsítótárral működik a legjobban.
269
+
270
+ A Mobiletto megpróbál csatlakozni egy redis példányhoz a 127.0.0.1:6379 címen
271
+
272
+ A következők bármelyikét felülbírálhatja:
273
+ * Állítsa be a `MOBILETTO_REDIS_HOST` env var-t, a mobilhoz itt csatlakozzon a localhost helyett
274
+ * Állítsa be a `MOBILETTO_REDIS_PORT` env var értékét, ez a port lesz használatban
275
+
276
+ A Mobiletto az összes redis kulcsát a `_mobiletto__` előtaggal fogja tárolni. Ezt megváltoztathatod
277
+ a `MOBILETTO_REDIS_PREFIX` env var.
278
+
279
+ A kapcsolatonkénti gyorsítótárat is beállíthatja az `opts.redisConfig` objektummal:
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
+ ### Nem akarja, hogy az újbóli gyorsítótár legyen?
291
+ A letiltáshoz adja meg az `enabled: false` ' értéket az `opts.redisConfig` objektumban a kapcsolat létrehozásakor.
292
+
293
+ Az alábbiakban tárgyaltak szerint a gyorsítótárazás letiltása kedvezőtlenül hat a teljesítményre, és több kérést von maga után
294
+ tárolóhelyre, amire valóban szüksége van.
295
+
296
+ ### Gyorsítótárazási útmutató
297
+ **Titkosított tárhely**: a titkosított tárhely olvasása/írása csak egy kicsit lassabb a normálnál,
298
+ de a könyvtárakban való navigálás (amit egyes dolgok igen) meglehetősen drága. Redis gyorsítótár használata
299
+ jelentős teljesítménynövekedést ad.
300
+
301
+ Az alapértelmezett gyorsítótár biztonságos, de nem működik jól, ha sok írási/eltávolítási műveletet végez.
302
+ Bármilyen írási vagy eltávolítási művelet érvényteleníti a teljes gyorsítótárat, így a későbbi olvasások látni fogják a
303
+ legújabb változások.
304
+
305
+ ### CLI eszközök
306
+ Ha olyan CLI-eszközt használ, mint a [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
307
+ mindenképpen engedélyezni kell a redis gyorsítótárat, mivel az a `mo` parancs meghívásain át tart.
308
+
309
+ ## Tükrözés
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
+ A `mirror` parancs az összes fájl egyszeri átmásolását hajtja végre egyik mobilról a másikra.
318
+ Nem futtat semmilyen folyamatot a tükör időbeli karbantartására. Futtassa újra a `mirror` parancsot
319
+ a hiányzó fájlok szinkronizálásához.
320
+
321
+ A `mirror` visszatérési értéke egy egyszerű objektum, amely számlálja, hogy hány fájl volt sikeres
322
+ tükrözve, és hány fájlban volt hiba:
323
+
324
+ {
325
+ success: count-of-files-mirrored,
326
+ errors: count-of-files-with-errors
327
+ }
328
+
329
+ FIGYELMEZTETÉS: A nagy adatkészletek tükrözése nagyon idő- és sávszélesség-igényes lehet.
330
+
331
+ A `mirror` hívás szemantikával néha zavaró lehet megérteni, hogy ki az
332
+ olvasó és ki az író. Képzeld el, mint egy hozzárendelési utasítást: a "bal oldali mobilt"
333
+ a hozzárendelt dolog (tükrözött adatok írva), és a "jobb oldali mobiltto" (a
334
+ argumentum a `mirror` tükrözés" metódushoz) a hozzárendelt érték (a tükrözött adatok beolvasása).
335
+
336
+ ## Átlátszó titkosítás
337
+ Átlátszó kliensoldali titkosítás engedélyezése:
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
+ Mi történik? Egy külön "könyvtárbejegyzés" (dirent) könyvtár (titkosítva) követi, hogy milyen fájlok vannak abban
357
+ könyvtárat (más néven dirent könyvtárat).
358
+ * A `list` parancs beolvassa a könyvtárbejegyzés fájljait, dekódolja az egyes felsorolt elérési útvonalakat; majd minden fájl metaadatait adja vissza
359
+ * A `list` parancsok nem hatékonyak, különösen a sok fájlt tartalmazó könyvtárak esetében
360
+ * A `write` parancs rekurzívan ír dirent fájlokat minden szülő dirent könyvtárába; majd megírja a fájlt
361
+ * `write` parancsok O(N) írást vonnak maguk után, ahol N = mélység a könyvtárhierarchiában
362
+ * A `remove` parancs rekurzív módon eltávolítja a megfelelő dirent fájlt, és ha üres, a szülőjét; majd eltávolítja a fájlt
363
+ * A nem rekurzív `remove` parancsok O(N) olvasást és potenciálisan annyi törlést vonnak maguk után, ahol N = mélység a könyvtárhierarchiában
364
+ * A rekurzív `remove` parancsok nagy és mély fájlrendszereken drágák lehetnek
365
+
366
+ Ne feledje, hogy még akkor is, ha a kliensoldali titkosítás engedélyezve van, az ellenfél teljes rálátással rendelkezik a titkosított szerveroldalra
367
+ A tárhely még a kulcs nélkül is láthatja a könyvtárak teljes számát, valamint azt, hogy hány fájl van az egyes mappákban, és együtt
368
+ némi erőfeszítéssel fedezze fel a címtárhierarchia általános szerkezetének egy részét vagy egészét.
369
+ *Megjegyzés: A nagyobb biztonság érdekében használjon viszonylag lapos szerkezetet.*
370
+ Az ellenfél nem ismeri a könyvtárak/fájlok nevét, hacsak nem ismeri a titkosításodat is
371
+ kulcsot, vagy más módon sikeresen feltörte a titkosítást. Akkor minden fogadás lejár!
372
+
373
+ ### Teljesítmény és gyorsítótár
374
+ A titkosított tárhelyen végzett műveletek lassúak lehetnek. A rekurzív listázás és eltávolítás nagyon lassú lehet.
375
+ A redis-en keresztüli gyorsítótár rendkívül sokat segít, de vegye figyelembe, hogy a gyorsítótár kiürül minden íráskor vagy eltávolításkor.
376
+
377
+ ## Kulcsforgatás
378
+ Hozzon létre egy mobilt az új kulccsal, majd tükrözze bele a régi adatokat:
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
+ ## Illesztőprogram felület
391
+ Az illesztőprogram bármely JS-fájl, amely a következő aláírással exportál egy „storageClient” függvényt:
392
+
393
+ function storageClient (key, secret, opts)
394
+
395
+ * `key` : egy karakterlánc, az API-kulcs (a `local` illesztőprogramnál ez az alapkönyvtár)
396
+ * `secret` : egy karakterlánc, az API titkos kódja (elhagyható a `local` illesztőprogramnál)
397
+ * `opts` : egy objektum, a tulajdonságok illesztőprogramonként:
398
+ * A `local` esetén a `fileMode` és a " `dirMode` tulajdonságok határozzák meg az új létrehozó fájlok és könyvtárak létrehozásának módját
399
+ * Az `s3` esetén a `bucket` tulajdonság kötelező. Az opcionális tulajdonságok a következők:
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
+ A storageClient függvény által visszaadott objektumnak meg kell határoznia a következő függvényeket:
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
+ ## Naplózás
431
+ A Mobiletto a [winston](https://www.npmjs.com/package/winston) naplózási könyvtárat használja.
432
+
433
+ A naplók **tartalmaznak** fájl elérési utat és hibaüzeneteket, de **soha** nem tartalmaznak kulcsokat, titkokat,
434
+ vagy bármilyen más kapcsolat konfigurációs információ.
435
+
436
+ ### Naplószint
437
+ Használja a `MOBILETTO_LOG_LEVEL` környezeti változót a naplózási szint beállításához, egyet használva
438
+ a [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels) helyen meghatározott `npm` szintek közül
439
+
440
+ Az alapértelmezett szint a `error` . A legbőbeszédesebb szint a `silly` , bár jelenleg mobiltto
441
+ nem jelentkezik be a `debug` alatti szinteken
442
+
443
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
444
+
445
+ ### Log fájl
446
+ Alapértelmezés szerint a naplózó ír a konzolra. A naplók fájlba küldéséhez állítsa be a `MOBILETTO_LOG_FILE`
447
+ környezeti változó. Amikor bejelentkezik egy fájlba, a naplók többé nem kerülnek a konzolra.
448
+
449
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
450
+
451
+ A naplózás kikapcsolása:
452
+
453
+ MOBILETTO_LOG_FILE=/dev/null
454
+
455
+ </pre>