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
+ Mae Mobiletto yn haen tynnu storio JavaScript, gydag amgryptio ochr y cleient tryloyw dewisol.
5
+
6
+ # Cynnwys
7
+ * [Pam Mobiletto?](#Pam-Mobiletto?)
8
+ * [Cychwyn cyflym](#cychwyn cyflym)
9
+ * [Mobiletto CLI](#mobiletto-cli)
10
+ * [Ffynhonnell](#Ffynhonnell)
11
+ * [Defnydd sylfaenol](#-defnydd sylfaenol)
12
+ * [Metadata](#Metadata)
13
+ * [Arddull mewnforio amgen](# amgen-mewnforio-arddull)
14
+ * [Casio](#Caching)
15
+ * [Drych](#Drych)
16
+ * [Amgryptio tryloyw](# Tryloyw-amgryptio)
17
+ * [Cylchdro allweddol](# Key-cylchdro)
18
+ * [Rhyngwyneb gyrrwr](# rhyngwyneb gyrrwr)
19
+ * [Logio](#Logio)
20
+
21
+ # Darllenwch hwn mewn iaith arall
22
+ Mae'r ddogfen README.md hon wedi'i chyfieithu, trwy [hokeylization](https://github.com/cobbzilla/hokeylization), i mewn i
23
+ **[pob iaith a gefnogir gan Google Translate]( https://cloud.google.com/translate/docs/languages)!**
24
+
25
+ Rwy'n sicr nad yw'n berffaith, ond gobeithio ei fod yn well na dim!
26
+
27
+ [🇸🇦 Arabeg](../ar/README.md)
28
+ [🇧🇩 Bengaleg](../bn/README.md)
29
+ [🇩🇪 Almaeneg](../de/README.md)
30
+ [🇺🇸 Saesneg](../cy/README.md)
31
+ [🇪🇸 Sbaeneg](../es/README.md)
32
+ [🇫🇷 Ffrangeg](../fr/README.md)
33
+ [🇹🇩 Hawsa](../ha/README.md)
34
+ [🇮🇳 Hindi](../hi/README.md)
35
+ [🇮🇩 Indoneseg](../id/README.md)
36
+ [🇮🇹 Eidaleg](../it/README.md)
37
+ [🇯🇵 Japaneaidd](../ja/README.md)
38
+ [🇰🇷 Corea](../ko/README.md)
39
+ [🇮🇳 Maranthi](../mr/README.md)
40
+ [🇵🇱 Pwyleg](../pl/README.md)
41
+ [🇧🇷 Portiwgaleg](../pt/README.md)
42
+ [🇷🇺 Rwsieg](../ru/README.md)
43
+ [🇰🇪 Swahili](../sw/README.md)
44
+ [🇵🇭 Tagalog](../tl/README.md)
45
+ [🇹🇷 Twrceg](../tr/README.md)
46
+ [🇵🇰 Wrdw](../ur/README.md)
47
+ [🇻🇳 Fietnameg](../vi/README.md)
48
+ [🇨🇳 Tsieinëeg](../zh/README.md)
49
+
50
+
51
+ **[📚 ... Pob Iaith ...](../README.md)**
52
+ ----
53
+
54
+ ### A oes problem gyda'r cyfieithiad hwn o'r README?
55
+ Mae'r cyfieithiad penodol hwn o'r [README] gwreiddiol ( https://github.com/cobbzilla/mobiletto/blob/master/README.md)
56
+ gall fod yn ddiffygiol -- *mae croeso mawr i gywiriadau!* Anfonwch [cais tynnu ar GitHub](https://github.com/cobbzilla/mobiletto/pulls),
57
+ neu os nad ydych chi'n gyfforddus yn gwneud hynny, [agorwch broblem]( https://github.com/cobbzilla/mobiletto/issues )
58
+
59
+ Pan fyddwch chi'n creu rhifyn GitHub newydd am gyfieithiad, gwnewch y canlynol:
60
+ * cynnwys URL y dudalen (copïo / pastio o far cyfeiriad y porwr)
61
+ * cynnwys yr union destun sy'n anghywir (copïo / pastio o'r porwr)
62
+ * disgrifiwch beth sy'n bod -- ydy'r cyfieithiad yn anghywir? a yw'r fformatio wedi torri rhywsut?
63
+ * cynigiwch yn garedig awgrym o well cyfieithiad, neu sut y dylid fformatio'r testun yn gywir
64
+ * **Diolch!**
65
+
66
+ ## Pam Mobiletto?
67
+
68
+ ### Hwyl fawr i'r gwerthwr cloi i mewn!
69
+ Mae gan y gwahanol ddarparwyr storio cwmwl APIs anghydnaws. Hyd yn oed y rhai sy'n ymdrechu am "gydnawsedd S3"
70
+ yn meddu ar ymddygiadau idiosyncratig.
71
+
72
+ Pan fyddwch chi'n dewis gwerthwr storio penodol ar gyfer eich app, os ydych chi'n codio'n uniongyrchol i'w API, eich app
73
+ bellach yn ddibynnol ar y gwasanaeth hwnnw. Wrth i amser fynd heibio ac i'r cod gronni, daw gwerthwyr sy'n newid
74
+ yn gynyddol anghynaladwy. Croeso i fyd hwyliog cloi i mewn i werthwyr!
75
+
76
+ Cynlluniwyd Mobiletto i ddatrys y broblem hon. Trwy godio'ch ap i API mobiletto, gallwch chi'n hawdd
77
+ newid darparwyr storio a gwybod y bydd haen storio eich app yn ymddwyn yn union yr un fath.
78
+
79
+ ### Profi helaeth
80
+ Mae pob gyrrwr yn cael ei brofi am yr un ymddygiad gyda 60+ o brofion ar gyfer pob gyrrwr.
81
+ Rydym yn profi pob gyrrwr gyda phob cyfuniad o:
82
+ * Amgryptio: wedi'i alluogi a'i anabl
83
+ * cache Redis: wedi'i alluogi a'i anabl
84
+
85
+ Mae'r dull hwn yn rhoi tawelwch meddwl i ni y bydd mobiletto yn ymddwyn yr un fath ni waeth pa yrrwr rydych chi'n ei ddefnyddio,
86
+ ac ni waeth a ydych yn galluogi caching a/neu amgryptio.
87
+
88
+ ### Cefnogaeth gyrrwr
89
+ Gyrwyr storio Mobiletto cyfredol:
90
+ * `s3` : Amazon S3
91
+ * `b2` : Blaze B2
92
+ * `local` : system ffeiliau leol
93
+
94
+ *Mae croeso mawr i gyfraniadau i gefnogi mwy o ddarparwyr storio cwmwl!*
95
+
96
+ ## symudoltto-cli
97
+ Bwriedir i Mobiletto gael ei ddefnyddio fel llyfrgell gan god JavaScript arall.
98
+
99
+ I weithio gyda mobiletto yn y llinell orchymyn, defnyddiwch [mobiletto-cli]( https://www.npmjs.com/package/mobiletto-cli)
100
+
101
+ ## Ffynhonnell
102
+ * [mobiletto ar GitHub]( https://github.com/cobbzilla/mobiletto)
103
+ * [mobiletto ar npm]( https://www.npmjs.com/package/mobiletto)
104
+
105
+ ## Cychwyn Cyflym
106
+ Enghraifft fer yn defnyddio'r gyrrwr `s3` .
107
+
108
+ Byddai'r cod hwn yn rhedeg yr un peth pe bai'r gyrrwr yn `b2` neu `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
+ ## Defnydd sylfaenol
139
+ Enghraifft llawer mwy helaeth, yn dangos y rhan fwyaf o'r nodweddion a gynigir:
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
+ Mae'r gorchymyn `metadata` yn dychwelyd metadata am un cofnod system ffeiliau.
242
+ Yn yr un modd, mae'r gwerth dychwelyd o'r gorchymyn `list` yn amrywiaeth o wrthrychau metadata.
243
+
244
+ Mae gwrthrych metadata yn edrych fel hyn:
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
+ Gall yr eiddo `type` fod yn `file` , `dir` , `link` , neu `special` .
255
+
256
+ Yn dibynnu ar y math o yrrwr, efallai na fydd gorchymyn `list` yn dychwelyd pob maes. `name` a `type`
257
+ dylai fod yn bresennol bob amser. Bydd gorchymyn `metadata` dilynol yn dychwelyd yr holl briodweddau sydd ar gael.
258
+
259
+ ## Arddull mewnforio amgen
260
+ Mewnforiwch y modiwl â chwmpas llawn a defnyddiwch y swyddogaeth `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
+ ## Caching
268
+ Mae Mobiletto yn gweithio orau gyda storfa <a href="https://redis.io">redis</a> .
269
+
270
+ Bydd Mobiletto yn ceisio cysylltu ag enghraifft redis ar 127.0.0.1:6379
271
+
272
+ Gallwch ddiystyru unrhyw un o'r rhain:
273
+ * Gosodwch yr amg var `MOBILETTO_REDIS_HOST` , mobileto cysylltu yma yn lle localhost
274
+ * Gosodwch yr env var `MOBILETTO_REDIS_PORT` , bydd y porth hwn yn cael ei ddefnyddio
275
+
276
+ Bydd Mobiletto yn storio ei holl allweddi redis gyda'r rhagddodiad `_mobiletto__` . Gallwch chi newid hyn
277
+ trwy osod y `MOBILETTO_REDIS_PREFIX` var.
278
+
279
+ Gallwch hefyd osod caching fesul-cysylltiad gyda'r gwrthrych `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
+ ### Ddim eisiau caching redis?
291
+ I analluogi: pasiwch `enabled: false` yn eich gwrthrych `opts.redisConfig` pan fyddwch yn sefydlu'ch cysylltiad.
292
+
293
+ Fel y trafodir isod, bydd analluogi caching yn cael effaith andwyol ar berfformiad ac yn arwain at fwy o geisiadau
294
+ i storio y mae gwir angen ichi.
295
+
296
+ ### Canllawiau caching
297
+ **Storfa wedi'i hamgryptio**: dim ond ychydig yn arafach na'r arfer y mae storfa wedi'i hamgryptio darllen/ysgrifennu,
298
+ ond mae llywio o gwmpas cyfeirlyfrau (y mae rhai pethau'n ei wneud) yn weddol ddrud. Gan ddefnyddio storfa redis
299
+ yn rhoi hwb perfformiad sylweddol i chi.
300
+
301
+ Mae'r storfa ddiofyn yn ddiogel, ond nid yw'n perfformio'n dda os oes gennych lawer o weithrediadau ysgrifennu / dileu.
302
+ Mae unrhyw weithred ysgrifennu neu ddileu yn annilysu'r storfa gyfan, gan sicrhau y bydd darlleniadau dilynol yn gweld y
303
+ newidiadau diweddaraf.
304
+
305
+ ### offer CLI
306
+ Os ydych chi'n defnyddio teclyn CLI fel [mobiletto-cli]( https://www.npmjs.com/package/mobiletto-cli),
307
+ byddwch yn bendant am i'r storfa redis alluogi, gan ei fod yn para ar draws galwadau o'r gorchymyn `mo` .
308
+
309
+ ## Drychio
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
+ Mae'r gorchymyn `mirror` yn perfformio copi un-amser o'r holl ffeiliau o un ffôn symudol i un arall.
318
+ Nid yw'n rhedeg unrhyw broses i gynnal y drych dros amser. Rhedeg y gorchymyn `mirror` eto
319
+ i gysoni unrhyw ffeiliau coll.
320
+
321
+ Mae'r gwerth dychwelyd o `mirror` yn wrthrych syml gyda rhifyddion ar gyfer faint o ffeiliau oedd yn llwyddiannus
322
+ wedi'i adlewyrchu a faint o ffeiliau oedd â gwallau:
323
+
324
+ {
325
+ success: count-of-files-mirrored,
326
+ errors: count-of-files-with-errors
327
+ }
328
+
329
+ RHYBUDD: Gall adlewyrchu setiau data mawr gymryd llawer iawn o amser a lled band-ddwys
330
+
331
+ Gyda’r alwad `mirror` yn semanteg weithiau gall fod yn ddryslyd deall pwy yw’r
332
+ darllenydd a phwy yw yr ysgrifenydd. Dychmygwch ef fel datganiad aseiniad: y "mobileto llaw chwith"
333
+ yw'r peth sy'n cael ei neilltuo i (drych data ysgrifenedig), a'r "de-law mobiletto" (y
334
+ dadl i'r dull `mirror` ) yw'r gwerth sy'n cael ei neilltuo (darllenir data drych).
335
+
336
+ ## Amgryptio tryloyw
337
+ Galluogi amgryptio ochr cleient tryloyw:
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
+ Beth sy'n Digwydd? Mae cyfeiriadur "mynediad cyfeiriadur" (cyfeirlyfr) ar wahân (wedi'i amgryptio) yn olrhain pa ffeiliau sydd ynddo
357
+ cyfeiriadur (aka y cyfeiriadur uniongyrchol).
358
+ * Mae'r gorchymyn `list` yn darllen y ffeiliau mynediad cyfeiriadur, yn dadgryptio pob llwybr a restrir; yna'n dychwelyd metadata ar gyfer pob ffeil
359
+ * Mae gorchmynion `list` yn fwy aneffeithlon, yn enwedig ar gyfer cyfeiriaduron gyda nifer fawr o ffeiliau
360
+ * Mae'r gorchymyn `write` ysgrifennu` yn ysgrifennu ffeiliau uniongyrchol yng nghyfeirlyfr uniongyrchol pob rhiant, yn rheolaidd; wedyn yn ysgrifennu'r ffeil
361
+ * Bydd gorchmynion `write` yn arwain at O(N) yn ysgrifennu, gydag N = dyfnder yn hierarchaeth y cyfeiriadur
362
+ * Mae'r gorchymyn `remove` yn dileu'r ffeil uniongyrchol gyfatebol, a'i riant os yw'n wag, yn ailadroddus; yna yn tynnu'r ffeil
363
+ * Bydd gorchmynion `remove` nad ydynt yn ailadroddus yn golygu darlleniadau O(N) ac o bosibl cymaint o ddileu, gyda N = dyfnder yn hierarchaeth y cyfeiriadur
364
+ * Gall gorchmynion `remove` ar systemau ffeiliau mawr a dwfn fod yn ddrud
365
+
366
+ Sylwch, hyd yn oed gydag amgryptio ochr cleient wedi'i alluogi, gwrthwynebydd gyda gwelededd llawn i ochr eich gweinydd wedi'i amgryptio
367
+ storio, hyd yn oed heb yr allwedd, yn dal i allu gweld cyfanswm nifer y cyfeiriaduron a faint o ffeiliau sydd ym mhob un, a gyda
368
+ rhywfaint o ymdrech, darganfod rhywfaint neu'r cyfan o strwythur cyffredinol yr hierarchaeth gyfeiriadur.
369
+ *Sylwer: Defnyddiwch strwythur gweddol wastad ar gyfer gwell diogelwch.*
370
+ Ni fyddai'r gwrthwynebydd yn gwybod enwau'r cyfeiriaduron/ffeiliau oni bai ei fod hefyd yn gwybod eich amgryptio
371
+ allweddol neu wedi cracio'r amgryptio yn llwyddiannus fel arall. Mae pob bet i ffwrdd felly!
372
+
373
+ ### Perfformiad a caching
374
+ Gall gweithrediadau ar storfa wedi'i hamgryptio fod yn araf. Gall rhestrau ailadroddus a dileu fod yn araf iawn.
375
+ Mae cadw trwy redis yn help aruthrol, ond sylwch fod y storfa'n cael ei fflysio ar unrhyw beth sy'n cael ei ysgrifennu neu ei ddileu.
376
+
377
+ ## Cylchdro allweddol
378
+ Creu mobiletto gyda'ch allwedd newydd, yna drychwch yr hen ddata ynddo:
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
+ ## rhyngwyneb gyrrwr
391
+ Gyrrwr yw unrhyw ffeil JS sy'n allforio swyddogaeth 'storageClient' gyda'r llofnod hwn:
392
+
393
+ function storageClient (key, secret, opts)
394
+
395
+ * `key` : llinyn, eich allwedd API (ar gyfer y gyrrwr `local` dyma'r cyfeiriadur sylfaenol)
396
+ * `secret` : llinyn, eich cyfrinach API (gellir ei hepgor ar gyfer y gyrrwr `local` )
397
+ * `opts` : gwrthrych, mae'r priodweddau fesul gyrrwr:
398
+ * Ar gyfer `local` , mae'r `fileMode` a `dirMode` yn pennu sut mae ffeiliau a chyfeiriaduron creu newydd yn cael eu creu
399
+ * Ar gyfer `s3` , mae angen yr eiddo `bucket` . Priodweddau dewisol yw:
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
+ Rhaid i'r gwrthrych y mae'r swyddogaeth storageClient yn ei ddychwelyd ddiffinio'r swyddogaethau hyn:
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
+ ## Logio
431
+ Mae Mobiletto yn defnyddio llyfrgell logio [winston](https://www.npmjs.com/package/winston).
432
+
433
+ Bydd logiau ** yn cynnwys llwybrau ffeil a negeseuon gwall, ond ni fydd **byth** yn cynnwys allweddi, cyfrinachau,
434
+ neu unrhyw wybodaeth cyfluniad cysylltiad arall.
435
+
436
+ ### Lefel log
437
+ Defnyddiwch y newidyn amgylchedd `MOBILETTO_LOG_LEVEL` i osod lefel y log, gan ddefnyddio un
438
+ o'r lefelau `npm` a ddiffinnir yn [https://www.npmjs.com/package/winston#logging-levels]( https://www.npmjs.com/package/winston#logging-levels )
439
+
440
+ Y lefel ddiofyn yw `error` . Y lefel fwyaf llafar yw `silly` , er yn mobiletto ar hyn o bryd
441
+ ddim yn mewngofnodi ar lefelau islaw `debug`
442
+
443
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
444
+
445
+ ### Ffeil log
446
+ Yn ddiofyn, mae'r cofnodwr yn ysgrifennu at y consol. I anfon logiau i ffeil, gosodwch y `MOBILETTO_LOG_FILE`
447
+ newidyn amgylchedd. Wrth fewngofnodi i ffeil, ni fydd logiau'n cael eu hysgrifennu i'r consol mwyach.
448
+
449
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
450
+
451
+ I ddiffodd y logio:
452
+
453
+ MOBILETTO_LOG_FILE=/dev/null
454
+
455
+ </pre>