mobiletto 1.2.0 → 2.0.0

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 (127) hide show
  1. package/lib/cjs/index.d.ts +2 -0
  2. package/lib/cjs/index.js +30 -0
  3. package/lib/cjs/package.json +16 -0
  4. package/lib/esm/index.d.ts +2 -0
  5. package/lib/esm/index.js +12 -0
  6. package/package.json +27 -13
  7. package/.babelrc +0 -5
  8. package/.eslintrc.js +0 -14
  9. package/docs/README.md +0 -113
  10. package/docs/af/README.md +0 -481
  11. package/docs/am/README.md +0 -481
  12. package/docs/ar/README.md +0 -481
  13. package/docs/az/README.md +0 -481
  14. package/docs/be/README.md +0 -481
  15. package/docs/bg/README.md +0 -481
  16. package/docs/bn/README.md +0 -481
  17. package/docs/bs/README.md +0 -481
  18. package/docs/ca/README.md +0 -481
  19. package/docs/ceb/README.md +0 -481
  20. package/docs/co/README.md +0 -481
  21. package/docs/cs/README.md +0 -481
  22. package/docs/cy/README.md +0 -481
  23. package/docs/da/README.md +0 -481
  24. package/docs/de/README.md +0 -481
  25. package/docs/el/README.md +0 -481
  26. package/docs/eo/README.md +0 -481
  27. package/docs/es/README.md +0 -481
  28. package/docs/et/README.md +0 -481
  29. package/docs/eu/README.md +0 -481
  30. package/docs/fa/README.md +0 -481
  31. package/docs/fi/README.md +0 -481
  32. package/docs/fr/README.md +0 -481
  33. package/docs/fy/README.md +0 -481
  34. package/docs/ga/README.md +0 -481
  35. package/docs/gd/README.md +0 -481
  36. package/docs/gl/README.md +0 -481
  37. package/docs/gu/README.md +0 -481
  38. package/docs/ha/README.md +0 -481
  39. package/docs/haw/README.md +0 -481
  40. package/docs/he/README.md +0 -481
  41. package/docs/hi/README.md +0 -481
  42. package/docs/hmn/README.md +0 -481
  43. package/docs/hr/README.md +0 -481
  44. package/docs/ht/README.md +0 -481
  45. package/docs/hu/README.md +0 -481
  46. package/docs/hy/README.md +0 -481
  47. package/docs/id/README.md +0 -481
  48. package/docs/ig/README.md +0 -481
  49. package/docs/is/README.md +0 -481
  50. package/docs/it/README.md +0 -481
  51. package/docs/iw/README.md +0 -481
  52. package/docs/ja/README.md +0 -481
  53. package/docs/jv/README.md +0 -481
  54. package/docs/ka/README.md +0 -481
  55. package/docs/kk/README.md +0 -481
  56. package/docs/km/README.md +0 -481
  57. package/docs/kn/README.md +0 -481
  58. package/docs/ko/README.md +0 -481
  59. package/docs/ku/README.md +0 -481
  60. package/docs/ky/README.md +0 -481
  61. package/docs/la/README.md +0 -481
  62. package/docs/lb/README.md +0 -481
  63. package/docs/lo/README.md +0 -481
  64. package/docs/lt/README.md +0 -481
  65. package/docs/lv/README.md +0 -481
  66. package/docs/mg/README.md +0 -481
  67. package/docs/mi/README.md +0 -481
  68. package/docs/mk/README.md +0 -481
  69. package/docs/ml/README.md +0 -481
  70. package/docs/mn/README.md +0 -481
  71. package/docs/mr/README.md +0 -481
  72. package/docs/ms/README.md +0 -481
  73. package/docs/mt/README.md +0 -481
  74. package/docs/my/README.md +0 -481
  75. package/docs/ne/README.md +0 -481
  76. package/docs/nl/README.md +0 -481
  77. package/docs/no/README.md +0 -481
  78. package/docs/ny/README.md +0 -481
  79. package/docs/or/README.md +0 -481
  80. package/docs/pa/README.md +0 -481
  81. package/docs/pl/README.md +0 -481
  82. package/docs/ps/README.md +0 -481
  83. package/docs/pt/README.md +0 -481
  84. package/docs/ro/README.md +0 -481
  85. package/docs/ru/README.md +0 -481
  86. package/docs/rw/README.md +0 -481
  87. package/docs/sd/README.md +0 -481
  88. package/docs/si/README.md +0 -481
  89. package/docs/sk/README.md +0 -481
  90. package/docs/sl/README.md +0 -481
  91. package/docs/sm/README.md +0 -481
  92. package/docs/sn/README.md +0 -481
  93. package/docs/so/README.md +0 -481
  94. package/docs/sq/README.md +0 -481
  95. package/docs/sr/README.md +0 -481
  96. package/docs/st/README.md +0 -481
  97. package/docs/su/README.md +0 -481
  98. package/docs/sv/README.md +0 -481
  99. package/docs/sw/README.md +0 -481
  100. package/docs/ta/README.md +0 -481
  101. package/docs/te/README.md +0 -481
  102. package/docs/tg/README.md +0 -481
  103. package/docs/th/README.md +0 -481
  104. package/docs/tk/README.md +0 -481
  105. package/docs/tl/README.md +0 -481
  106. package/docs/tr/README.md +0 -481
  107. package/docs/tt/README.md +0 -481
  108. package/docs/ug/README.md +0 -481
  109. package/docs/uk/README.md +0 -481
  110. package/docs/ur/README.md +0 -481
  111. package/docs/uz/README.md +0 -481
  112. package/docs/vi/README.md +0 -481
  113. package/docs/xh/README.md +0 -481
  114. package/docs/yi/README.md +0 -481
  115. package/docs/yo/README.md +0 -481
  116. package/docs/zh/README.md +0 -481
  117. package/docs/zu/README.md +0 -481
  118. package/drivers/b2/index.js +0 -451
  119. package/drivers/local/index.js +0 -315
  120. package/drivers/s3/index.js +0 -316
  121. package/hokey.json +0 -16
  122. package/index.js +0 -10
  123. package/test/api.spec.js +0 -512
  124. package/test/crypt.spec.js +0 -67
  125. package/util/crypt.js +0 -80
  126. package/util/logger.js +0 -27
  127. package/util/redis.js +0 -233
package/docs/sk/README.md DELETED
@@ -1,481 +0,0 @@
1
- Mobiletto
2
- =========
3
-
4
- Mobiletto je vrstva abstrakcie úložiska JavaScript s voliteľným transparentným šifrovaním na strane klienta.
5
-
6
- # Obsah
7
- * [Prečo Mobiletto?](#Prečo-Mobiletto?)
8
- * [Rýchly štart](#Rýchly štart)
9
- * [Mobiletto CLI](#mobiletto-cli)
10
- * [Source](#Source)
11
- * [Inštalácia](#Inštalácia)
12
- * [Support and Funding](#Support-and-Funding)
13
- * [Základné použitie](#Basic-usage)
14
- * [Metadáta](#Metadáta)
15
- * [Alternatívny štýl importu](#Alternate-import-style)
16
- * [Caching](#Caching)
17
- * [Mirroring](#Mirroring)
18
- * [Transparentné šifrovanie](#Transparentné šifrovanie)
19
- * [Otočenie kľúča](#Otočenie kľúča)
20
- * [Rozhranie ovládača](#Rozhranie ovládača)
21
- * [Logging](#Logging)
22
-
23
- # Prečítajte si to v inom jazyku
24
- Tento dokument README.md bol preložený prostredníctvom [hokeylizácie](https://github.com/cobbzilla/hokeylization) do
25
- **[každý jazyk podporovaný Prekladačom Google](https://cloud.google.com/translate/docs/languages)!**
26
-
27
- Som si istý, že to nie je dokonalé, ale dúfam, že je to lepšie ako nič!
28
-
29
- [🇸🇦 arabčina](../ar/README.md)
30
- [🇧🇩 bengálčina](../bn/README.md)
31
- [🇩🇪 nemčina](../de/README.md)
32
- [🇺🇸 angličtina](../en/README.md)
33
- [🇪🇸 španielčina](../es/README.md)
34
- [🇫🇷 francúzština](../fr/README.md)
35
- [🇹🇩 Hausa](../ha/README.md)
36
- [🇮🇳 hindčina](../hi/README.md)
37
- [🇮🇩 indonézština](../id/README.md)
38
- [🇮🇹 taliančina](../it/README.md)
39
- [🇯🇵 japončina](../ja/README.md)
40
- [🇰🇷 kórejčina](../ko/README.md)
41
- [🇮🇳 Marathi](../mr/README.md)
42
- [🇵🇱 poľština](../pl/README.md)
43
- [🇧🇷 portugalčina](../pt/README.md)
44
- [🇷🇺 ruština](../ru/README.md)
45
- [🇰🇪 svahilčina](../sw/README.md)
46
- [🇵🇭 tagalčina](../tl/README.md)
47
- [🇹🇷 turečtina](../tr/README.md)
48
- [🇵🇰 urdčina](../ur/README.md)
49
- [🇻🇳 vietnamčina](../vi/README.md)
50
- [🇨🇳 čínština](../zh/README.md)
51
-
52
-
53
- **[📚 ... Všetky jazyky ...](../README.md)**
54
- ----
55
-
56
- ### Vyskytol sa problém s týmto prekladom súboru README?
57
- Tento konkrétny preklad originálu [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
58
- môže byť chybný -- *opravy sú veľmi vítané!* Pošlite [žiadosť o stiahnutie na GitHub](https://github.com/cobbzilla/mobiletto/pulls),
59
- alebo ak sa vám to nepáči, [otvorte problém](https://github.com/cobbzilla/mobiletto/issues)
60
-
61
- Keď vytvoríte nový problém na GitHub o preklade, postupujte takto:
62
- * uveďte adresu URL stránky (skopírujte/prilepte z panela s adresou prehliadača)
63
- * uveďte presný text, ktorý je nesprávny (skopírujte/prilepte z prehliadača)
64
- * popíšte, čo je nesprávne - je preklad nesprávny? je formátovanie nejako porušené?
65
- * láskavo ponúknite návrh na lepší preklad alebo ako by mal byť text správne naformátovaný
66
- * **Ďakujem!**
67
-
68
- ## Prečo Mobiletto?
69
-
70
- ### Zbohom vendor lock-in!
71
- Rôzni poskytovatelia cloudových úložísk majú nekompatibilné rozhrania API. Dokonca aj tí, ktorí sa snažia o „kompatibilitu S3“
72
- majú idiosynkratické správanie.
73
-
74
- Keď si vyberiete konkrétneho dodávateľa úložiska pre svoju aplikáciu, ak kódujete priamo do ich API, vaša aplikácia
75
- je teraz závislý od tejto služby. Ako plynie čas a kód sa hromadí, menia sa predajcovia
76
- čoraz neudržateľnejšie. Vitajte v zábavnom svete blokovania predajcov!
77
-
78
- Mobiletto bol navrhnutý na vyriešenie tohto problému. Zakódovaním vašej aplikácie do API mobiletto to môžete ľahko
79
- zmeniť poskytovateľa úložiska a vedieť, že vrstva úložiska vašej aplikácie sa bude správať rovnako.
80
-
81
- ### Rozsiahle testovanie
82
- Všetci vodiči sú testovaní na rovnaké správanie pomocou 60+ testov pre každého vodiča.
83
- Testujeme všetky ovládače s každou kombináciou:
84
- * Šifrovanie: povolené aj zakázané
85
- * Vyrovnávacia pamäť Redis: povolená aj zakázaná
86
-
87
- Tento prístup nám dáva istotu, že mobiletto sa bude správať rovnako bez ohľadu na to, aký ovládač používate,
88
- a bez ohľadu na to, či povolíte ukladanie do vyrovnávacej pamäte a/alebo šifrovanie.
89
-
90
- ### Podpora ovládačov
91
- Aktuálne ovládače úložiska Mobiletto:
92
- * `s3` : Amazon S3
93
- * `b2` : Backblaze B2
94
- * `local` : lokálny súborový systém
95
-
96
- *Príspevky na podporu viacerých poskytovateľov cloudových úložísk sú veľmi vítané!*
97
-
98
- ## mobiletto-cli
99
- Mobiletto je určené na použitie ako knižnica iným kódom JavaScript.
100
-
101
- Ak chcete pracovať s mobiletto na príkazovom riadku, použite [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
102
-
103
- ## Zdroj
104
- * [mobiletto na GitHub](https://github.com/cobbzilla/mobiletto)
105
- * [mobiletto na npm](https://www.npmjs.com/package/mobiletto)
106
-
107
- ## Podpora a financovanie
108
- Snažím sa byť profesionálnym vývojárom open source softvéru. Pracoval som v
109
- v softvérovom priemysle som zakladal úspešné spoločnosti a predal ich verejným spoločnostiam.
110
- Nedávno som prišiel o prácu a vlastne nemám žiadnu inú prácu
111
-
112
- Takže skúsim napísať užitočný softvér a uvidím, či to funguje
113
-
114
- Ak radi používate tento softvér, bol by som veľmi vďačný aj za to
115
- najmenší [mesačný príspevok cez Patreon](https://www.patreon.com/cobbzilla)
116
-
117
- *Ďakujem!*
118
-
119
- ## Inštalácia
120
- Nainštalujte pomocou `npm` alebo `yarn` . Pravdepodobne budete chcieť `lite` verziu, ktorá neobsahuje všetky
121
- preložené súbory README:
122
-
123
- npm install mobiletto-lite
124
- yarn add mobiletto-lite
125
-
126
- Ak naozaj chcete súbory README v každom jazyku, nainštalujte si plnú verziu:
127
-
128
- npm install mobiletto
129
- yarn add mobiletto
130
-
131
- ## Rýchly štart
132
- Krátky príklad použitia ovládača mobiletto `s3` .
133
-
134
- Tento kód by fungoval rovnako, ak by bol ovládač `b2` alebo `local` .
135
-
136
- const storage = require('mobiletto')
137
- const bucket = await storage.connect('s3', aws_key, aws_secret, {bucket: 'bk'})
138
-
139
- // list objects: returns array of metadata objects
140
- const listing = await bucket.list()
141
- const dirList = await bucket.list('some/dir/')
142
- const everything = await bucket.list('', {recursive: true})
143
-
144
- // write an entire file
145
- let bytesWritten = await bucket.writeFile('some/path', someBufferOfData)
146
-
147
- // write a file from a stream/generator
148
- bytesWritten = await bucket.write('some/path', streamOrGenerator)
149
-
150
- // read an entire file
151
- // returns null if an exception would otherwise be thrown
152
- const bufferOrNull = await bucket.safeReadFile('some/path')
153
-
154
- // stream-read a file, passing data to callback
155
- const bytesRead = await bucket.read('some/path', (chunk) => { ...do something with chunk... } )
156
-
157
- // remove a file, returns the path removed
158
- let removed = await bucket.remove('some/path') // removed is a string
159
-
160
- // remove a directory, returns array of paths removed
161
- removed = await bucket.remove('some/directory', {recursive: true}) // removed is now an array!
162
-
163
- ----
164
- ## Základné použitie
165
- Oveľa rozsiahlejší príklad zobrazujúci väčšinu ponúkaných funkcií:
166
-
167
- const { mobiletto } = require('mobiletto')
168
-
169
- // General usage
170
- const api = await mobiletto(driverName, key, secret, opts)
171
-
172
- // To use 'local' driver:
173
- // * key: base directory
174
- // * secret: ignored, can be null
175
- // * opts object:
176
- // * readOnly: optional, never change anything on the filesystem; default is false
177
- // * fileMode: optional, permissions used when creating new files, default is 0600. can be string or integer
178
- // * dirMode: optional, permissions used when creating new directories, default is 0700. can be string or integer
179
- const local = await mobiletto('local', '/home/ubuntu/tmp', null, {fileMode: 0o0600, dirMode: '0700'})
180
-
181
- // To use 's3' driver:
182
- // * key: AWS Access Key ID
183
- // * secret: AWS Secret Key
184
- // * opts object:
185
- // * readOnly: optional, never change anything on the bucket; default is false
186
- // * bucket: required, name of the S3 bucket
187
- // * region: optional, the AWS region to communicate with, default is us-east-1
188
- // * prefix: optional, all read/writes within the S3 bucket will be under this prefix
189
- // * delimiter: optional, directory delimiter, default is '/' (note: always '/' when encryption is enabled)
190
- const s3 = await mobiletto('s3', aws_key, aws_secret, {bucket: 'bk', region: 'us-east-1'})
191
-
192
- // To use 'b2' driver:
193
- // * key: Backblaze Key ID
194
- // * secret: Backblaze Application Key
195
- // * opts object:
196
- // * readOnly: optional, never change anything on the bucket; default is false
197
- // * bucket: required, the ID (**not the name**) of the B2 bucket
198
- // * prefix: optional, all read/writes within the B2 bucket will be under this prefix
199
- // * delimiter: optional, directory delimiter, default is '/' (note: always '/' when encryption is enabled)
200
- // * partSize: optional, large files will be split into chunks of this size when uploading
201
- const b3 = await mobiletto('b2', b2_key_id, b2_app_key, {bucket: 'bk', partSize: 10000000})
202
-
203
- // List files
204
- api.list() // --> returns an array of metadata objects
205
-
206
- // List files recursively
207
- api.list({ recursive: true })
208
-
209
- // List files in a directory
210
- const path = 'some/path'
211
- api.list(path)
212
- api.list(path, { recursive: true }) // also supports recursive flag
213
-
214
- // Visit files in a directory -- visitor function must be async
215
- api.list(path, { visitor: myAsyncFunc })
216
- api.list(path, { visitor: myAsyncFunc, recursive: true })
217
-
218
- // The `list` method throws MobilettoNotFoundError if the path does not exist
219
- // When you call `safeList` on a non-existent path, it returns an empty array
220
- api.safeList('/path/that/does/not/exist') // returns []
221
-
222
- // Read metadata for a file
223
- api.metadata(path) // returns metadata object
224
-
225
- // The `metadata` method throws MobilettoNotFoundError if the path does not exist
226
- // When you call `safeMetadata` on a non-existent path, it returns null
227
- api.safeMetadata('/tmp/does_not_exist') // returns null
228
-
229
- // Read a file
230
- // Provide a callback that writes the data someplace
231
- const callback = (chunk) => { ... write chunk somewhere ... }
232
- api.read(path, callback) // returns count of bytes read
233
-
234
- // Read an entire file at once
235
- const data = await api.readFile(path) // returns a byte Buffer of the file contents
236
-
237
- // Read an entire file at once
238
- // returns null if an exception would otherwise be thrown
239
- const bufferOrNull = await bucket.safeReadFile('some/path')
240
-
241
- // Write a file
242
- // Provide a generator function that yields chunks of data
243
- const generator = function* () {
244
- while ( ... more-data-to-return ... ) {
245
- data = ... load-data ...
246
- yield data
247
- }
248
- }
249
- local.api(path, generator) // returns count of bytes written
250
-
251
- // Write an entire file at once (convenience method)
252
- await api.writeFile(path, bufferOrString) // returns count of bytes written
253
-
254
- // Delete a file
255
- // Quiet param is optional (default false), when set errors will not be thrown if the path does not exist
256
- // Always returns a value or throws an error.
257
- // Return value may be a single string of the file removed, or an array of all files removed (driver-dependent)
258
- const quiet = true
259
- api.remove(path, {quiet}) // returns single path removed
260
-
261
- // Recursively delete a directory and do it quietly (do not report errors)
262
- const recursive = true
263
- const quiet = true
264
- api.remove(path, {recursive, quiet}) // returns array of paths removed
265
-
266
- ## Metadáta
267
- Príkaz `metadata` vracia metadáta o jednej položke súborového systému.
268
- Podobne návratová hodnota z príkazu `list` je pole objektov metadát.
269
-
270
- Objekt metadát vyzerá takto:
271
-
272
- {
273
- "name": "fully/qualified/path/to/file",
274
- "type": "entry-type",
275
- "size": size-in-bytes,
276
- "ctime": creation-time-epoch-millis,
277
- "mtime": modification-time-epoch-millis
278
- }
279
-
280
- Vlastnosť `type` type“ môže byť `file` “, `dir` “, `link` alebo `special` .
281
-
282
- V závislosti od typu ovládača nemusí príkaz `list` vrátiť všetky polia. Vlastnosti `name` a `type` .
283
- by mal byť vždy prítomný. Nasledujúci príkaz `metadata` vráti všetky dostupné vlastnosti.
284
-
285
- ## Alternatívny štýl importu
286
- Importujte modul s úplným rozsahom a použite funkciu `connect` :
287
-
288
- const storage = require('mobiletto')
289
- const opts = {bucket: 'bk', region: 'us-east-1'}
290
- const s3 = await storage.connect('s3', aws_key, aws_secret, opts)
291
- const objectData = await s3.readFile('some/path')
292
-
293
- ## Ukladanie do vyrovnávacej pamäte
294
- Mobiletto funguje najlepšie s vyrovnávacou pamäťou <a href="https://redis.io">redis</a> .
295
-
296
- Mobiletto sa pokúsi pripojiť k inštancii redis na 127.0.0.1:6379
297
-
298
- Môžete prepísať jednu z týchto možností:
299
- * Nastavte env var, mobilet `MOBILETTO_REDIS_HOST` , aby ste sa pripojili sem namiesto localhost
300
- * Nastavte env var `MOBILETTO_REDIS_PORT` , tento port sa použije
301
-
302
- Mobiletto uloží všetky svoje redis kľúče s predponou `_mobiletto__` . Môžete to zmeniť
303
- nastavením premennej env `MOBILETTO_REDIS_PREFIX`
304
-
305
- Môžete tiež nastaviť ukladanie do vyrovnávacej pamäte pre jednotlivé pripojenia pomocou objektu `opts.redisConfig` :
306
-
307
- const redisConfig = {
308
- enabled: true, // optional, default is true. if false other props are ignored
309
- host: '127.0.0.1',
310
- port: 6379,
311
- prefix: '_mobiletto__'
312
- }
313
- const opts = { redisConfig, bucket: 'bk', region: 'us-east-1' }
314
- const s3 = await storage.connect('s3', aws_key, aws_secret, opts)
315
-
316
- ### Nechcete znovu ukladať do vyrovnávacej pamäte?
317
- Ak chcete zakázať: pri vytváraní pripojenia odovzdajte `enabled: false` v objekte `opts.redisConfig` .
318
-
319
- Ako je uvedené nižšie, zakázanie ukladania do vyrovnávacej pamäte bude mať nepriaznivý vplyv na výkon a spôsobí viac požiadaviek
320
- do úložiska, ktoré skutočne potrebujete.
321
-
322
- ### Pokyny pre ukladanie do vyrovnávacej pamäte
323
- **Šifrované úložisko**: čítanie/zápis šifrovaného úložiska je len o niečo pomalšie ako normálne,
324
- ale navigácia v adresároch (čo niektoré veci robia) je pomerne drahá. Použitie vyrovnávacej pamäte redis
325
- vám poskytne výrazné zvýšenie výkonu.
326
-
327
- Predvolená vyrovnávacia pamäť je bezpečná, ale nefunguje dobre, ak máte veľa operácií zápisu/odstránenia.
328
- Akákoľvek operácia zápisu alebo odstránenia znehodnotí celú vyrovnávaciu pamäť, čím sa zabezpečí, že nasledujúce čítania uvidia súbor
329
- najnovšie zmeny.
330
-
331
- ### Nástroje CLI
332
- Ak používate nástroj CLI ako [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
333
- určite budete chcieť povoliť vyrovnávaciu pamäť redis, pretože trvá pri vyvolaní príkazu `mo` .
334
-
335
- ## Zrkadlenie
336
-
337
- // Copy a local filesystem mobiletto to S3
338
- s3.mirror(local)
339
-
340
- // Mirror a local subdirectory from one mobiletto to an S3 mobiletto, with it's own subdirectory
341
- local.mirror(s3, 'some/local-folder', 'some/s3-folder')
342
-
343
- Príkaz `mirror` vykoná jednorazovú kópiu všetkých súborov z jedného mobiletto do druhého.
344
- Nespúšťa žiadny proces na udržiavanie zrkadla v priebehu času. Znova spustite príkaz `mirror`
345
- na synchronizáciu chýbajúcich súborov.
346
-
347
- Návratová hodnota z `mirror` je jednoduchý objekt s počítadlami, koľko súborov bolo úspešne dokončených
348
- zrkadlené a koľko súborov malo chyby:
349
-
350
- {
351
- success: count-of-files-mirrored,
352
- errors: count-of-files-with-errors
353
- }
354
-
355
- VAROVANIE: Zrkadlenie veľkých súborov údajov môže byť veľmi časovo náročné a náročné na šírku pásma
356
-
357
- So sémantikou volania `mirror` môže byť niekedy mätúce pochopiť, kto je
358
- čitateľ a kto je spisovateľ. Predstavte si to ako príkaz na zadanie: „mobiltto na ľavej strane“
359
- je vec, ku ktorej sa priraďuje (zapísané zrkadlené dáta) a „pravé mobilné tto“ (
360
- argument k metóde `mirror` ) je priradená hodnota (čítajú sa zrkadlové dáta).
361
-
362
- ## Transparentné šifrovanie
363
- Povoliť transparentné šifrovanie na strane klienta:
364
-
365
- // Pass encryption parameters
366
- const encryption = {
367
- // key is required, must be >= 16 chars
368
- key: randomstring.generate(128),
369
-
370
- // optional, the default is to derive IV from key
371
- // when set, IV must be >= 16 chars
372
- iv: randomstring.generate(128),
373
-
374
- // optional, the default is aes-256-cbc
375
- algo: 'aes-256-cbc'
376
- }
377
- const api = await mobiletto(driverName, key, secret, opts, encryption)
378
-
379
- // Subsequent write operations will encrypt data (client side) when writing
380
- // Subsequent read operations will decrypt data (client side) when reading
381
-
382
- Čo sa deje? Samostatný (zašifrovaný) adresár „položka adresára“ (zašifrovaný) sleduje, aké súbory sa v ňom nachádzajú
383
- adresár (známy ako priamy adresár).
384
- * Príkaz `list` prečíta vstupné súbory adresára, dešifruje každú uvedenú cestu; potom vráti metadáta pre každý súbor
385
- * Príkazy `list` sú neefektívnejšie, najmä pre adresáre s veľkým počtom súborov
386
- * Príkaz `write` zapisuje dirent súbory do adresára dirent každého rodiča rekurzívne; potom zapíše súbor
387
- * Príkazy `write` budú mať za následok O(N) zápisov, pričom N = hĺbka v hierarchii adresárov
388
- * Príkaz `remove` odstráni zodpovedajúci dirent súbor a jeho rodič, ak je prázdny; potom súbor odstráni
389
- * `remove` budú mať za následok O(N) čítaní a potenciálne toľko vymazaní, pričom N = hĺbka v hierarchii adresárov
390
- * Rekurzívne príkazy `remove` na veľkých a hlbokých súborových systémoch môžu byť drahé
391
-
392
- Všimnite si, že aj keď je zapnuté šifrovanie na strane klienta, protivník s plnou viditeľnosťou na vašej zašifrovanej strane servera
393
- úložisko, dokonca aj bez kľúča, stále vidí celkový počet adresárov a koľko súborov je v každom a s
394
- nejaké úsilie, objaviť časť alebo celú celkovú štruktúru hierarchie adresárov.
395
- *Poznámka: Pre lepšiu bezpečnosť použite relatívne plochú štruktúru.*
396
- Protivník by nevedel názvy adresárov/súborov, pokiaľ by nepoznal aj vaše šifrovanie
397
- kľúč alebo inak úspešne prelomil šifrovanie. Potom sú všetky stávky vypnuté!
398
-
399
- ### Výkon a ukladanie do vyrovnávacej pamäte
400
- Operácie na šifrovanom úložisku môžu byť pomalé. Rekurzívne zoznamy a odstraňovania môžu byť veľmi pomalé.
401
- Ukladanie do vyrovnávacej pamäte cez redis nesmierne pomáha, ale nezabudnite, že vyrovnávacia pamäť sa vyprázdni pri každom zápise alebo odstránení.
402
-
403
- ## Rotácia kľúča
404
- Vytvorte mobiletto s vaším novým kľúčom a potom doň zrkadlite staré údaje:
405
-
406
- const storage = require('mobiletto')
407
-
408
- const oldEncryption = { key: .... }
409
- const oldStorage = await storage.connect('s3', aws_key, aws_secret, {bucket: 'bk', region: 'us-east-1'}, oldEncryption)
410
-
411
- const newEncryption = { key: .... }
412
- const newStorage = await storage.connect('s3', aws_key, aws_secret, {bucket: 'zz', region: 'us-east-1'}, newEncryption)
413
-
414
- newStorage.mirror(oldStorage) // if oldStorage is very large, this may take a looooooong time...
415
-
416
- ## Rozhranie ovládača
417
- Ovládač je akýkoľvek súbor JS, ktorý exportuje funkciu „storageClient“ s týmto podpisom:
418
-
419
- function storageClient (key, secret, opts)
420
-
421
- * `key` : reťazec, váš kľúč API (pre `local` ovládač je to základný adresár)
422
- * `secret` : reťazec, vaše tajomstvo API (môže byť vynechané pre `local` ovládač)
423
- * `opts` : objekt, vlastnosti sú pre ovládač:
424
- * Pre `local` , vlastnosti `fileMode` a `dirMode` určujú, ako sa vytvárajú nové súbory a adresáre
425
- * Pre `s3` sa vyžaduje vlastnosť `bucket` . Voliteľné vlastnosti sú:
426
- * `region`: the S3 region, default is us-east-1
427
- * `prefix`: a prefix to prepend to all S3 paths, default is the empty string
428
- * `delimiter`: the directory delimiter, default is '/'
429
-
430
- Objekt, ktorý funkcia storageClient vracia, musí definovať tieto funkcie:
431
-
432
- // Test the driver before using, ensure proper configuration
433
- async testConfig ()
434
-
435
- // List files in path (or from base-directory)
436
- // If recursive is true, list recursively
437
- // If visitor is defined, it will be an async function. await the visitor function on each file found
438
- // Otherwise, perform the listing and return an array of objects
439
- async list (path, recursive = false, visitor = null) // path may be omitted
440
-
441
- // Read metadata for a path
442
- async metadata (path)
443
-
444
- // Read a file
445
- // callback receives a chunk of data. endCallback is called at end-of-stream
446
- async read (path, callback, endCallback = null)
447
-
448
- // Write a file
449
- // driver must be able to handle a generator or a stream
450
- async write (path, generatorOrReadableStream)
451
-
452
- // Remove a file, or recursively delete a directory
453
- // returns a string of a single path removed, or an array of multiple paths removed
454
- async remove (path, recursive = false, quiet = false)
455
-
456
- ## Prihlásenie
457
- Mobiletto používa protokolovaciu knižnicu [winston](https://www.npmjs.com/package/winston).
458
-
459
- Protokoly **budú** obsahovať cesty k súborom a chybové hlásenia, ale **nikdy** nebudú obsahovať kľúče, tajomstvá,
460
- alebo akékoľvek iné informácie o konfigurácii pripojenia.
461
-
462
- ### Úroveň denníka
463
- Na nastavenie úrovne denníka použite premennú prostredia `MOBILETTO_LOG_LEVEL`
464
- z úrovní `npm` definovaných v [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
465
-
466
- Predvolená úroveň je `error` . Najpodrobnejšia úroveň je `silly` , aj keď momentálne mobiletto
467
- neprihlási na úrovniach pod `debug`
468
-
469
- MOBILETTO_LOG_LEVEL=silly # maximum logs!
470
-
471
- ### Súbor denníka
472
- V predvolenom nastavení zapisovač zapisuje do konzoly. Ak chcete odoslať protokoly do súboru, nastavte `MOBILETTO_LOG_FILE`
473
- premenná prostredia. Pri prihlasovaní do súboru sa už protokoly nebudú zapisovať do konzoly.
474
-
475
- MOBILETTO_LOG_FILE=/var/my_mobiletto_log
476
-
477
- Ak chcete vypnúť protokolovanie:
478
-
479
- MOBILETTO_LOG_FILE=/dev/null
480
-
481
- </pre>