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 je vrstva abstrakce úložiště JavaScript s volitelným transparentním šifrováním na straně klienta.
5
+
6
+ # Obsah
7
+ * [Proč Mobiletto?](#Proč-Mobiletto?)
8
+ * [Rychlý start](#Rychlý start)
9
+ * [Mobiletto CLI](#mobiletto-cli)
10
+ * [Zdroj](#Source)
11
+ * [Základní použití](#Basic-usage)
12
+ * [Metadata](#Metadata)
13
+ * [Alternativní styl importu](#Alternate-import-style)
14
+ * [Caching](#Caching)
15
+ * [Mirroring](#Mirroring)
16
+ * [Transparentní šifrování](#Transparentní šifrování)
17
+ * [Otočení klíče](#Otočení klíče)
18
+ * [Rozhraní ovladače](#Rozhraní ovladače)
19
+ * [Logging](#Logging)
20
+
21
+ # Přečtěte si to v jiném jazyce
22
+ Tento dokument README.md byl přeložen prostřednictvím [hokeylizace](https://github.com/cobbzilla/hokeylization) do
23
+ **[každý jazyk podporovaný Překladačem Google](https://cloud.google.com/translate/docs/languages)!**
24
+
25
+ Jsem si jistý, že to není dokonalé, ale doufám, že je to lepší než nic!
26
+
27
+ [🇸🇦 arabština](../ar/README.md)
28
+ [🇧🇩 bengálština](../bn/README.md)
29
+ [🇩🇪 němčina](../de/README.md)
30
+ [🇺🇸 angličtina](../en/README.md)
31
+ [🇪🇸 španělština](../es/README.md)
32
+ [🇫🇷 francouzština](../fr/README.md)
33
+ [🇹🇩 Hausa](../ha/README.md)
34
+ [🇮🇳 hindština](../hi/README.md)
35
+ [🇮🇩 indonéština](../id/README.md)
36
+ [🇮🇹 italština](../it/README.md)
37
+ [🇯🇵 japonština](../ja/README.md)
38
+ [🇰🇷 korejština](../ko/README.md)
39
+ [🇮🇳 Maranthi](../mr/README.md)
40
+ [🇵🇱 polština](../pl/README.md)
41
+ [🇧🇷 portugalština](../pt/README.md)
42
+ [🇷🇺 ruština](../ru/README.md)
43
+ [🇰🇪 svahilština](../sw/README.md)
44
+ [🇵🇭 tagalština](../tl/README.md)
45
+ [🇹🇷 turečtina](../tr/README.md)
46
+ [🇵🇰 urdština](../ur/README.md)
47
+ [🇻🇳 vietnamština](../vi/README.md)
48
+ [🇨🇳 čínština](../zh/README.md)
49
+
50
+
51
+ **[📚 ... Všechny jazyky ...](../README.md)**
52
+ ----
53
+
54
+ ### Je problém s tímto překladem souboru README?
55
+ Tento konkrétní překlad originálu [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
56
+ může být chyba -- *opravy jsou velmi vítány!* Odešlete [žádost o stažení na GitHubu](https://github.com/cobbzilla/mobiletto/pulls),
57
+ nebo pokud se vám to nelíbí, [otevřete problém](https://github.com/cobbzilla/mobiletto/issues)
58
+
59
+ Když vytvoříte nový problém na GitHubu o překladu, proveďte prosím:
60
+ * zahrňte adresu URL stránky (zkopírujte/vložte z adresního řádku prohlížeče)
61
+ * uveďte přesný text, který je nesprávný (zkopírujte/vložte z prohlížeče)
62
+ * popište prosím, co je špatně - je překlad nesprávný? je formátování nějak narušené?
63
+ * laskavě nabídněte návrh lepšího překladu nebo jak by měl být text správně naformátován
64
+ * **Děkuji!**
65
+
66
+ ## Proč Mobiletto?
67
+
68
+ ### Sbohem vendor lock-in!
69
+ Různí poskytovatelé cloudového úložiště mají nekompatibilní rozhraní API. Dokonce i ti, kteří usilují o "kompatibilitu S3"
70
+ mají idiosynkratické chování.
71
+
72
+ Když si vyberete konkrétního dodavatele úložiště pro svou aplikaci, pokud kódujete přímo do jejich API, vaše aplikace
73
+ je nyní na této službě závislý. Jak čas plyne a kód se hromadí, mění se dodavatelé
74
+ čím dál neudržitelnější. Vítejte v zábavném světě vendor lock-in!
75
+
76
+ Mobiletto bylo navrženo k vyřešení tohoto problému. Nakódováním vaší aplikace do API mobiletto to můžete snadno
77
+ změnit poskytovatele úložiště a vědět, že vrstva úložiště vaší aplikace se bude chovat identicky.
78
+
79
+ ### Rozsáhlé testování
80
+ Všechny ovladače jsou testovány na identické chování s 60+ testy pro každý ovladač.
81
+ Testujeme všechny ovladače s každou kombinací:
82
+ * Šifrování: povoleno i zakázáno
83
+ * Mezipaměť Redis: povolena i zakázána
84
+
85
+ Tento přístup nám dává jistotu, že mobiletto se bude chovat stejně bez ohledu na to, jaký ovladač používáte,
86
+ a bez ohledu na to, zda povolíte ukládání do mezipaměti a/nebo šifrování.
87
+
88
+ ### Podpora ovladačů
89
+ Aktuální ovladače úložiště Mobiletto:
90
+ * `s3` : Amazon S3
91
+ * `b2` : Backblaze B2
92
+ * `local` : místní souborový systém
93
+
94
+ *Příspěvky na podporu více poskytovatelů cloudových úložišť jsou velmi vítány!*
95
+
96
+ ## mobiletto-cli
97
+ Mobiletto je určeno k použití jako knihovna jiným kódem JavaScript.
98
+
99
+ Chcete-li pracovat s mobiletto na příkazovém řádku, použijte [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
100
+
101
+ ## Zdroj
102
+ * [mobiletto na GitHubu](https://github.com/cobbzilla/mobiletto)
103
+ * [mobiletto na npm](https://www.npmjs.com/package/mobiletto)
104
+
105
+ ## Rychlý start
106
+ Krátký příklad použití ovladače mobiletto `s3` .
107
+
108
+ Tento kód by běžel stejně, kdyby byl ovladač `b2` nebo `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
+ ## Základní použití
139
+ Mnohem rozsáhlejší příklad ukazující většinu nabízených funkcí:
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
+ Příkaz `metadata` vrací metadata o jedné položce souborového systému.
242
+ Podobně vrácená hodnota z příkazu `list` je pole objektů metadat.
243
+
244
+ Objekt metadat vypadá takto:
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
+ Vlastnost `type` type` může být `file` , `dir` , `link` nebo `special` .
255
+
256
+ V závislosti na typu ovladače nemusí příkaz `list` vrátit všechna pole. Vlastnosti `name` a `type` type`
257
+ by měl být vždy přítomen. Následující příkaz `metadata` vrátí všechny dostupné vlastnosti.
258
+
259
+ ## Alternativní styl importu
260
+ Importujte modul s plným rozsahem a použijte funkci `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
+ ## Ukládání do mezipaměti
268
+ Mobiletto funguje nejlépe s <a href="https://redis.io">redis</a> cache.
269
+
270
+ Mobiletto se pokusí připojit k instanci redis na 127.0.0.1:6379
271
+
272
+ Můžete přepsat kteroukoli z těchto možností:
273
+ * Nastavte env var `MOBILETTO_REDIS_HOST` , mobilet, abyste se připojili sem místo localhost
274
+ * Nastavte env var `MOBILETTO_REDIS_PORT` , tento port bude použit
275
+
276
+ Mobiletto uloží všechny své redis klíče s předponou `_mobiletto__` . Můžete to změnit
277
+ nastavením `MOBILETTO_REDIS_PREFIX` env var.
278
+
279
+ Můžete také nastavit ukládání do mezipaměti pro jednotlivá připojení pomocí objektu `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
+ ### Nechcete znovu ukládat do mezipaměti?
291
+ Zakázání: předejte `enabled: false` ve vašem objektu `opts.redisConfig` při navazování spojení.
292
+
293
+ Jak je uvedeno níže, zakázání ukládání do mezipaměti bude mít nepříznivý vliv na výkon a vyvolá více požadavků
294
+ úložiště, které opravdu potřebujete.
295
+
296
+ ### Pokyny pro ukládání do mezipaměti
297
+ **Šifrované úložiště**: čtení/zápis šifrovaného úložiště je jen o něco pomalejší než normálně,
298
+ ale procházení adresářů (což některé věci dělají) je poměrně drahé. Použití mezipaměti redis
299
+ vám poskytne výrazné zvýšení výkonu.
300
+
301
+ Výchozí mezipaměť je bezpečná, ale nefunguje dobře, pokud máte mnoho operací zápisu/odebírání.
302
+ Jakákoli operace zápisu nebo odstranění zneplatní celou mezipaměť a zajistí, že následná čtení uvidí soubor
303
+ nejnovější změny.
304
+
305
+ ### Nástroje CLI
306
+ Pokud používáte nástroj CLI, jako je [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
307
+ určitě budete chtít povolenou mezipaměť redis, protože trvá při vyvolání příkazu `mo` .
308
+
309
+ ## Zrcadlení
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
+ Příkaz `mirror` provede jednorázovou kopii všech souborů z jednoho mobiletto do druhého.
318
+ Nespouští žádný proces pro udržování zrcadla v průběhu času. Spusťte znovu příkaz `mirror`
319
+ pro synchronizaci chybějících souborů.
320
+
321
+ Vrácená hodnota z `mirror` je jednoduchý objekt s počítadly, kolik souborů bylo úspěšně dokončeno
322
+ zrcadleno a kolik souborů mělo chyby:
323
+
324
+ {
325
+ success: count-of-files-mirrored,
326
+ errors: count-of-files-with-errors
327
+ }
328
+
329
+ VAROVÁNÍ: Zrcadlení velkých souborů dat může být velmi časově náročné a náročné na šířku pásma
330
+
331
+ Se sémantikou volání `mirror` může být někdy matoucí pochopit, kdo je
332
+ čtenář a kdo je autorem. Představte si to jako příkaz k zadání: „levé mobiltto“
333
+ je věc, které je přiřazena (zapsána zrcadlená data), a "pravé mobilnítto" (
334
+ argument k metodě `mirror` ) je přiřazovaná hodnota (přečtou se zrcadlená data).
335
+
336
+ ## Transparentní šifrování
337
+ Povolit transparentní šifrování na straně klienta:
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
+ Co se děje? Samostatný adresář „položka adresáře“ (přímý) (zašifrovaný) sleduje, jaké soubory se v něm nacházejí
357
+ adresář (neboli dirent adresář).
358
+ * Příkaz `list` čte soubory záznamů adresáře, dešifruje každou uvedenou cestu; pak vrátí metadata pro každý soubor
359
+ * Příkazy `list` jsou neefektivnější, zvláště pro adresáře s velkým počtem souborů
360
+ * Příkaz `write` zapisuje dirent soubory do adresáře dirent každého rodiče rekurzivně; pak zapíše soubor
361
+ * Příkazy `write` budou mít O(N) zápisů, přičemž N = hloubka v hierarchii adresářů
362
+ * Příkaz `remove` odstraní odpovídající soubor dirent a jeho rodič, pokud je prázdný; poté soubor odstraní
363
+ * Nerekurzivní příkazy `remove` způsobí O(N) čtení a potenciálně tolik mazání, přičemž N = hloubka v hierarchii adresářů
364
+ * Rekurzivní příkazy `remove` na velkých a hlubokých souborových systémech mohou být drahé
365
+
366
+ Všimněte si, že i když je povoleno šifrování na straně klienta, protivník s plnou viditelností na vaší šifrované straně serveru
367
+ úložiště, i bez klíče, stále vidí celkový počet adresářů a kolik souborů je v každém a s
368
+ nějaké úsilí, objevit některé nebo všechny celkové struktury hierarchie adresářů.
369
+ *Poznámka: Pro lepší zabezpečení použijte relativně plochou strukturu.*
370
+ Protivník by neznal názvy adresářů/souborů, pokud by neznal také vaše šifrování
371
+ klíč nebo jinak úspěšně prolomil šifrování. Pak jsou všechny sázky pryč!
372
+
373
+ ### Výkon a ukládání do mezipaměti
374
+ Operace na šifrovaném úložišti mohou být pomalé. Rekurzivní výpisy a odstraňování mohou být velmi pomalé.
375
+ Ukládání do mezipaměti přes redis ohromně pomáhá, ale mějte na paměti, že mezipaměť se vyprázdní při každém zápisu nebo odstranění.
376
+
377
+ ## Rotace klíče
378
+ Vytvořte mobiletto se svým novým klíčem a poté do něj zrcadlte stará data:
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
+ ## Rozhraní ovladače
391
+ Ovladač je jakýkoli soubor JS, který exportuje funkci „storageClient“ s tímto podpisem:
392
+
393
+ function storageClient (key, secret, opts)
394
+
395
+ * `key` : řetězec, váš klíč API (pro `local` ovladač je to základní adresář)
396
+ * `secret` : řetězec, vaše tajemství API (může být vynecháno pro `local` ovladač)
397
+ * `opts` : objekt, vlastnosti jsou pro každý ovladač:
398
+ * Pro `local` určují vlastnosti `fileMode` a `dirMode` způsob vytváření nových souborů a adresářů
399
+ * Pro `s3` je vyžadována vlastnost `bucket` . Volitelné vlastnosti jsou:
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
+ Objekt, který funkce storageClient vrací, musí definovat tyto funkce:
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
+ ## Protokolování
431
+ Mobiletto používá protokolovací knihovnu [winston](https://www.npmjs.com/package/winston).
432
+
433
+ Protokoly **budou** obsahovat cesty k souborům a chybové zprávy, ale **nikdy** nebudou obsahovat klíče, tajemství,
434
+ nebo jakékoli jiné informace o konfiguraci připojení.
435
+
436
+ ### Úroveň protokolu
437
+ K nastavení úrovně protokolu použijte proměnnou prostředí `MOBILETTO_LOG_LEVEL`
438
+ z úrovní `npm` definovaných v [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
439
+
440
+ Výchozí úroveň je `error` . Nejpodrobnější úroveň je `silly` , i když momentálně mobiletto
441
+ se nepřihlásí na úrovních pod `debug`
442
+
443
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
444
+
445
+ ### Log soubor
446
+ Ve výchozím nastavení zapisovač zapisuje do konzoly. Chcete-li odeslat protokoly do souboru, nastavte `MOBILETTO_LOG_FILE`
447
+ proměnná prostředí. Při přihlašování do souboru se již protokoly nebudou zapisovat do konzole.
448
+
449
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
450
+
451
+ Postup vypnutí protokolování:
452
+
453
+ MOBILETTO_LOG_FILE=/dev/null
454
+
455
+ </pre>