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