mobiletto 1.1.8 → 1.1.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (117) hide show
  1. package/README.md +56 -4
  2. package/docs/README.md +113 -0
  3. package/docs/af/README.md +455 -0
  4. package/docs/am/README.md +455 -0
  5. package/docs/ar/README.md +455 -0
  6. package/docs/az/README.md +455 -0
  7. package/docs/be/README.md +455 -0
  8. package/docs/bg/README.md +455 -0
  9. package/docs/bn/README.md +455 -0
  10. package/docs/bs/README.md +455 -0
  11. package/docs/ca/README.md +455 -0
  12. package/docs/ceb/README.md +455 -0
  13. package/docs/co/README.md +455 -0
  14. package/docs/cs/README.md +455 -0
  15. package/docs/cy/README.md +455 -0
  16. package/docs/da/README.md +455 -0
  17. package/docs/de/README.md +455 -0
  18. package/docs/el/README.md +455 -0
  19. package/docs/eo/README.md +455 -0
  20. package/docs/es/README.md +455 -0
  21. package/docs/et/README.md +455 -0
  22. package/docs/eu/README.md +455 -0
  23. package/docs/fa/README.md +455 -0
  24. package/docs/fi/README.md +455 -0
  25. package/docs/fr/README.md +455 -0
  26. package/docs/fy/README.md +455 -0
  27. package/docs/ga/README.md +455 -0
  28. package/docs/gd/README.md +455 -0
  29. package/docs/gl/README.md +455 -0
  30. package/docs/gu/README.md +455 -0
  31. package/docs/ha/README.md +455 -0
  32. package/docs/haw/README.md +455 -0
  33. package/docs/he/README.md +455 -0
  34. package/docs/hi/README.md +455 -0
  35. package/docs/hmn/README.md +455 -0
  36. package/docs/hr/README.md +455 -0
  37. package/docs/ht/README.md +455 -0
  38. package/docs/hu/README.md +455 -0
  39. package/docs/hy/README.md +455 -0
  40. package/docs/id/README.md +455 -0
  41. package/docs/ig/README.md +455 -0
  42. package/docs/is/README.md +455 -0
  43. package/docs/it/README.md +455 -0
  44. package/docs/iw/README.md +455 -0
  45. package/docs/ja/README.md +455 -0
  46. package/docs/jv/README.md +455 -0
  47. package/docs/ka/README.md +455 -0
  48. package/docs/kk/README.md +455 -0
  49. package/docs/km/README.md +455 -0
  50. package/docs/kn/README.md +455 -0
  51. package/docs/ko/README.md +455 -0
  52. package/docs/ku/README.md +455 -0
  53. package/docs/ky/README.md +455 -0
  54. package/docs/la/README.md +455 -0
  55. package/docs/lb/README.md +455 -0
  56. package/docs/lo/README.md +455 -0
  57. package/docs/lt/README.md +455 -0
  58. package/docs/lv/README.md +455 -0
  59. package/docs/mg/README.md +455 -0
  60. package/docs/mi/README.md +455 -0
  61. package/docs/mk/README.md +455 -0
  62. package/docs/ml/README.md +455 -0
  63. package/docs/mn/README.md +455 -0
  64. package/docs/mr/README.md +455 -0
  65. package/docs/ms/README.md +455 -0
  66. package/docs/mt/README.md +455 -0
  67. package/docs/my/README.md +455 -0
  68. package/docs/ne/README.md +455 -0
  69. package/docs/nl/README.md +455 -0
  70. package/docs/no/README.md +455 -0
  71. package/docs/ny/README.md +455 -0
  72. package/docs/or/README.md +455 -0
  73. package/docs/pa/README.md +455 -0
  74. package/docs/pl/README.md +455 -0
  75. package/docs/ps/README.md +455 -0
  76. package/docs/pt/README.md +455 -0
  77. package/docs/ro/README.md +455 -0
  78. package/docs/ru/README.md +455 -0
  79. package/docs/rw/README.md +455 -0
  80. package/docs/sd/README.md +455 -0
  81. package/docs/si/README.md +455 -0
  82. package/docs/sk/README.md +455 -0
  83. package/docs/sl/README.md +455 -0
  84. package/docs/sm/README.md +455 -0
  85. package/docs/sn/README.md +455 -0
  86. package/docs/so/README.md +455 -0
  87. package/docs/sq/README.md +455 -0
  88. package/docs/sr/README.md +455 -0
  89. package/docs/st/README.md +455 -0
  90. package/docs/su/README.md +455 -0
  91. package/docs/sv/README.md +455 -0
  92. package/docs/sw/README.md +455 -0
  93. package/docs/ta/README.md +455 -0
  94. package/docs/te/README.md +455 -0
  95. package/docs/tg/README.md +455 -0
  96. package/docs/th/README.md +455 -0
  97. package/docs/tk/README.md +455 -0
  98. package/docs/tl/README.md +455 -0
  99. package/docs/tr/README.md +455 -0
  100. package/docs/tt/README.md +455 -0
  101. package/docs/ug/README.md +455 -0
  102. package/docs/uk/README.md +455 -0
  103. package/docs/ur/README.md +455 -0
  104. package/docs/uz/README.md +455 -0
  105. package/docs/vi/README.md +455 -0
  106. package/docs/xh/README.md +455 -0
  107. package/docs/yi/README.md +455 -0
  108. package/docs/yo/README.md +455 -0
  109. package/docs/zh/README.md +455 -0
  110. package/docs/zu/README.md +455 -0
  111. package/drivers/b2/index.js +24 -6
  112. package/hokey.json +16 -0
  113. package/index.js +33 -17
  114. package/package.json +3 -2
  115. package/test/api.spec.js +319 -306
  116. package/util/logger.js +1 -1
  117. package/util/redis.js +1 -1
@@ -0,0 +1,455 @@
1
+ Mobiletto
2
+ ==========
3
+
4
+ Mobiletto ass eng JavaScript Späicherabstraktiounsschicht, mat optionalem transparenter Client-Säit Verschlësselung.
5
+
6
+ # Inhalter
7
+ * [Firwat Mobiletto?](#Why-Mobiletto?)
8
+ * [Quickstart](#Quickstart)
9
+ * [Mobiletto CLI](#mobiletto-cli)
10
+ * [Source](#Source)
11
+ * [Basis Benotzung](#Basis Benotzung)
12
+ * [Metadaten](#Metadaten)
13
+ * [Alternativ Importstil](#Alternate-Import-Style)
14
+ * [Caching](#Caching)
15
+ * [Spigel](#Spigel)
16
+ * [Transparent Verschlësselung](#Transparent Verschlësselung)
17
+ * [Schlësselrotatioun](#Schlësselrotatioun)
18
+ * [Driver Interface](#Driver-Interface)
19
+ * [Logging](#Logging)
20
+
21
+ # Liest dëst an enger anerer Sprooch
22
+ Dëst README.md Dokument gouf iwwersat, iwwer [hokeylization](https://github.com/cobbzilla/hokeylization), an
23
+ **[all Sprooch ënnerstëtzt vu Google Translate](https://cloud.google.com/translate/docs/languages)!**
24
+
25
+ Ech si sécher datt et net perfekt ass, awer ech hoffen et ass besser wéi näischt!
26
+
27
+ [🇸🇦 Arabesch](../ar/README.md)
28
+ [🇧🇩 Bengalesch](../bn/README.md)
29
+ [🇩🇪 Däitsch](../de/README.md)
30
+ [🇺🇸 Englesch](../en/README.md)
31
+ [🇪🇸 Spuenesch](../es/README.md)
32
+ [🇫🇷 Franséisch](../fr/README.md)
33
+ [🇹🇩 Hausa](../ha/README.md)
34
+ [🇮🇳 Hindi](../hi/README.md)
35
+ [🇮🇩 indonesesch](../id/README.md)
36
+ [🇮🇹 Italienesch](../it/README.md)
37
+ [🇯🇵 Japanesch](../ja/README.md)
38
+ [🇰🇷 Koreanesch](../ko/README.md)
39
+ [🇮🇳 Maranthi](../mr/README.md)
40
+ [🇵🇱 Polnesch](../pl/README.md)
41
+ [🇧🇷 Portugisesch](../pt/README.md)
42
+ [🇷🇺 Russesch](../ru/README.md)
43
+ [🇰🇪 Swahili](../sw/README.md)
44
+ [🇵🇭 Tagalog](../tl/README.md)
45
+ [🇹🇷 tierkesch](../tr/README.md)
46
+ [🇵🇰 Urdu](../ur/README.md)
47
+ [🇻🇳 Vietnamesesch](../vi/README.md)
48
+ [🇨🇳 Chinesesch](../zh/README.md)
49
+
50
+
51
+ **[📚 ... All Sproochen ...](../README.md)**
52
+ ----
53
+
54
+ ### Gëtt et e Problem mat dëser Iwwersetzung vum README?
55
+ Dës speziell Iwwersetzung vum Original [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
56
+ kann fehlerhaft sinn -- *Korrekturen si ganz wëllkomm!* Schéckt w.e.g. eng [Pull Ufro op GitHub](https://github.com/cobbzilla/mobiletto/pulls),
57
+ oder wann Dir net bequem sidd dat ze maachen, [maacht en Thema op](https://github.com/cobbzilla/mobiletto/issues)
58
+
59
+ Wann Dir en neit GitHub Thema iwwer eng Iwwersetzung erstellt, maacht w.e.g.:
60
+ * enthält d'Säit URL (Kopie / Paste vun der Adressbar vum Browser)
61
+ * enthält den exakten Text dee falsch ass (copy/paste vum Browser)
62
+ * beschreiw w.e.g. wat falsch ass - ass d'Iwwersetzung falsch? ass d'Formatéierung iergendwéi gebrach?
63
+ * bitt frëndlech e Virschlag fir eng besser Iwwersetzung un, oder wéi den Text richteg formatéiert soll sinn
64
+ * **Merci!**
65
+
66
+ ## Firwat Mobiletto?
67
+
68
+ ### Äddi Verkeefer Spär!
69
+ Déi verschidde Cloud Storage Ubidder hunn inkompatibel APIen. Och déi, déi no "S3 Kompatibilitéit" striewen
70
+ hunn idiosynkratesch Verhalen.
71
+
72
+ Wann Dir e bestëmmte Stockage Verkeefer fir Är App wielt, wann Dir direkt op hir API, Är App codéiert
73
+ ass elo vun deem Service ofhängeg. Wéi d'Zäit vergaang ass a Code accumuléiert, verännert Verkeefer
74
+ ëmmer méi onhaltbar. Wëllkomm op der lëschter Welt vum Verkeefer Lock-in!
75
+
76
+ Mobiletto gouf entwéckelt fir dëse Problem ze léisen. Andeems Dir Är App op Mobiletto's API kodéiert, kënnt Dir einfach
77
+ Ännere Späicherprovider a wësst datt d'Späicherschicht vun Ärer App identesch behuelen.
78
+
79
+ ### Extensiv Testen
80
+ All Chauffeuren gi fir identesch Verhalen getest mat 60+ Tester fir all Chauffeur.
81
+ Mir testen all Chauffeuren mat all Kombinatioun vun:
82
+ * Verschlësselung: souwuel aktivéiert wéi behënnert
83
+ * Redis Cache: souwuel aktivéiert wéi behënnert
84
+
85
+ Dës Approche gëtt eis Fridden vum Geescht datt den mobiletto d'selwecht wäert behuelen egal wéi ee Chauffer Dir benotzt,
86
+ an egal ob Dir Caching an / oder Verschlësselung aktivéiert.
87
+
88
+ ### Driver Ënnerstëtzung
89
+ Aktuelle Mobiletto Späichertreiber:
90
+ * `s3` : Amazon S3
91
+ * `b2` : Backblaze B2
92
+ * `local` : lokal Dateiesystem
93
+
94
+ * Bäiträg fir méi Cloud Storage Ubidder z'ënnerstëtzen si ganz wëllkomm!*
95
+
96
+ ## mobiletto-cli
97
+ Mobiletto soll als Bibliothéik vun anere JavaScript Code benotzt ginn.
98
+
99
+ Fir mat mobiletto op der Kommandozeil ze schaffen, benotzt [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
100
+
101
+ ## Quell
102
+ * [mobiletto op GitHub](https://github.com/cobbzilla/mobiletto)
103
+ * [mobiletto op npm](https://www.npmjs.com/package/mobiletto)
104
+
105
+ ## Schnellstart
106
+ E kuerzt Beispill mat dem mobiletto `s3` Chauffer.
107
+
108
+ Dëse Code géif d'selwecht lafen wann de Chauffeur `b2` oder `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
+ ## Basis Benotzung
139
+ E vill méi extensiv Beispill, deen déi meescht vun de ugebueden Features weist:
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
+ ## Metadaten
241
+ De Kommando `metadata` Metadaten iwwer eng eenzeg Dateiesystementrée zréck.
242
+ Och de `list` Kommando "Lëscht" ass eng Array vu Metadatenobjekter.
243
+
244
+ E Metadatenobjekt gesäit esou aus:
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
+ D'Eegeschaft `type` ' kann `file` ' , `dir` , `link` oder `special` .
255
+
256
+ Ofhängeg vun der Aart vum Chauffer, kann e `list` Kommando net all Felder zréckginn. Den `name` an `type` Eegeschaften
257
+ soll ëmmer präsent sinn. E spéideren `metadata` Kommando wäert all verfügbare Properties zréckginn.
258
+
259
+ ## Alternativ Importstil
260
+ Importéiert de komplett-scoped Modul a benotzt d' `connect` Funktioun:
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
+ Mobiletto funktionnéiert am Beschten mat engem <a href="https://redis.io">Redis</a> Cache.
269
+
270
+ Mobiletto wäert probéieren mat enger Redis Instanz op 127.0.0.1:6379 ze verbannen
271
+
272
+ Dir kënnt entweder vun dësen iwwerschreiden:
273
+ * Setzt den `MOBILETTO_REDIS_HOST` env var, mobiletto fir hei ze verbannen amplaz vum localhost
274
+ * Setzt den `MOBILETTO_REDIS_PORT` env var, dësen Hafen gëtt benotzt
275
+
276
+ Mobiletto späichert all seng Redis Schlësselen mam Präfix `_mobiletto__` . Dir kënnt dëst änneren
277
+ andeems Dir den `MOBILETTO_REDIS_PREFIX` env var.
278
+
279
+ Dir kënnt och Per-Connection Caching mat dem `opts.redisConfig` Objet setzen:
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
+ ### Wëllt Dir kee Redis Caching?
291
+ Fir auszeschalten: pass `enabled: false` an Ärem `opts.redisConfig` Objet wann Dir Är Verbindung opstellt.
292
+
293
+ Wéi hei ënnendrënner diskutéiert, wäert d'Caching auszeschalten en negativen Effekt op d'Performance hunn a méi Ufroe maachen
294
+ zu Stockage datt Dir wierklech muss.
295
+
296
+ ### Caching Leedung
297
+ **Verschlësselte Späichere**: d'Verschlësselungslagerung liesen / schreiwen ass nëmmen e bësse méi lues wéi normal,
298
+ mee navigéieren ronderëm Verzeechnes (wat e puer Saache maachen) ass zimlech deier. Benotzt e Redis Cache
299
+ ginn Iech eng bedeitend Leeschtung Schwong.
300
+
301
+ De Standard-Cache ass sécher, awer funktionnéiert net gutt wann Dir vill Schreif- / Ewechaarbechten hutt.
302
+ All Schreif- oder Entfernungsoperatioun ongëlteg de ganze Cache, a garantéiert datt spéider Liesungen de
303
+ lescht Ännerungen.
304
+
305
+ ### CLI Tools
306
+ Wann Dir e CLI Tool benotzt wéi [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
307
+ Dir wëllt definitiv de Redis Cache aktivéieren, well et dauert iwwer Uruff vum `mo` Kommando.
308
+
309
+ ## Spigelen
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
+ De Kommando `mirror` mécht eng eemoleg Kopie vun all Dateie vun engem Mobiletto op en aneren.
318
+ Et leeft kee Prozess fir de Spigel iwwer Zäit z'erhalen. Run de Kommando `mirror` erëm
319
+ fir fehlend Dateien ze synchroniséieren.
320
+
321
+ De `mirror` vum 'Spigel' ass en einfachen Objet mat Zähler fir wéi vill Dateien erfollegräich waren
322
+ gespigelt a wéi vill Dateie Feeler haten:
323
+
324
+ {
325
+ success: count-of-files-mirrored,
326
+ errors: count-of-files-with-errors
327
+ }
328
+
329
+ OPGEPASST: Mirroréiere vu groussen Datesets ka ganz Zäitopwendeg a Bandbreedintensiv sinn
330
+
331
+ Mat der `mirror` ' Call Semantik kann et heiansdo duerchernee sinn ze verstoen wien ass
332
+ Lieser a wien de Schrëftsteller ass. Stellt Iech vir wéi eng Uerderungserklärung: de "lénkse Mobiletto"
333
+ ass d'Saach déi zougewisen gëtt (Spigeldaten geschriwwen), an de "riets Mobiletto" (den
334
+ Argument fir d' `mirror` Methode) ass de Wäert deen zougewisen gëtt (Spigeldaten gi gelies).
335
+
336
+ ## Transparent Verschlësselung
337
+ Aktivéiert transparent Client-Säit Verschlësselung:
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
+ Waat leeft? Eng separat "Verzeechnesentrée" (dirent) Verzeechnes (verschlësselte) verfollegt wéi eng Dateien an deem sinn
357
+ Verzeechnes (alias den dirent Verzeechnes).
358
+ * De Kommando `list` liest d'Verzeechnesentrée Dateien, entschlësselt all opgelëscht Wee; gitt dann Metadaten fir all Fichier zréck
359
+ * `list` Kommandoe si méi ineffizient, besonnesch fir Verzeichnisser mat enger grousser Zuel vu Dateien
360
+ * De Kommando "schreiwen" schreift `write` Dateien an all Elterendeel hir dirent Verzeechnes, rekursiv; da schreift de Fichier
361
+ * `write` Kommandoen wäerten O(N) Schreift entstoen, mat N = Déift an der Verzeechneshierarchie
362
+ * De Kommando "läschen" läscht déi entspriechend `remove` Datei, a seng Elterendeel wann eidel, rekursiv; läscht dann d'Datei
363
+ * Net-rekursiv `remove` Befehle wäerten O(N) liesen a potenziell sou vill Läschen, mat N = Déift an der Verzeechneshierarchie
364
+ * Rekursiv `remove` Kommandoen op grouss an déif Dateiesystemer kënnen deier sinn
365
+
366
+ Notéiert datt och mat Client-Säit Verschlësselung aktivéiert, e Géigner mat voller Visibilitéit op Är verschlësselte Serversäit
367
+ Stockage, och ouni de Schlëssel, kann nach d'total Zuel vun Verzeechnes gesinn a wéivill Fichieren sinn an all, a mat
368
+ puer Efforten , Entdeckt e puer oder all vun der Gesamtstruktur vun der directory Hierarchie.
369
+ *Notiz: Benotzt eng relativ flaach Struktur fir besser Sécherheet.*
370
+ De Géigner géif d'Nimm vun den Verzeichnisser/Dateien net kennen, ausser si woussten och Är Verschlësselung
371
+ Schlëssel oder soss erfollegräich d'Verschlësselung geknackt. All Spillwette sinn dann aus!
372
+
373
+ ### Leeschtung a Cache
374
+ Operatiounen op verschlësselte Späichere kënne lues sinn. Rekursiv Oplëschtungen an Entfernunge kënne ganz lues sinn.
375
+ Caching iwwer Redis hëlleft enorm, awer bemierkt datt de Cache bei all Schreiwen oder ewechgeholl gëtt.
376
+
377
+ ## Schlëssel Rotatioun
378
+ Erstellt e Mobiletto mat Ärem neie Schlëssel, spigelt dann déi al Daten an et:
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
+ ## Driver Interface
391
+ E Chauffer ass all JS-Datei déi eng 'storageClient' Funktioun mat dëser Ënnerschrëft exportéiert:
392
+
393
+ function storageClient (key, secret, opts)
394
+
395
+ * `key` : eng String, Ären API Schlëssel (fir de `local` Chauffer ass dëst de Basisverzeechnes)
396
+ * `secret` : eng String, Äert API Geheimnis (kann fir de `local` Chauffer ewechgelooss ginn)
397
+ * `opts` : en Objet, d'Eegeschafte si pro Chauffer:
398
+ * Fir 'lokal' bestëmmen d'Eegeschafte `fileMode` `local` `dirMode` wéi nei Dateien a Verzeichnisser erstallt ginn
399
+ * Fir `s3` ' ass d'Eigenschaft `bucket` erfuerderlech. Optional Eegeschafte sinn:
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
+ Den Objet deen d'StorageClient Funktioun zréckkënnt muss dës Funktiounen definéieren:
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
+ ## Logged
431
+ Mobiletto benotzt d'[winston](https://www.npmjs.com/package/winston) Logbibliothéik.
432
+
433
+ Logbicher **wäerten** Dateiweeër a Fehlermeldungen enthalen, awer wäerten **ni** Schlësselen, Geheimnisser,
434
+ oder all aner Verbindung Configuratioun Informatiounen.
435
+
436
+ ### Logniveau
437
+ Benotzt d' `MOBILETTO_LOG_LEVEL` Ëmfeld Variabel fir de Logniveau ze setzen, mat engem
438
+ vun den `npm` Niveauen definéiert an [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
439
+
440
+ De Standardniveau ass `error` . Dee verboseste Niveau ass `silly` , obwuel de Moment Mobiletto
441
+ loggt net op Niveauen ënner `debug`
442
+
443
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
444
+
445
+ ### Log Datei
446
+ Par défaut schreift de Logger op d'Konsole. Fir Logbicher op eng Datei ze schécken, set de `MOBILETTO_LOG_FILE`
447
+ Ëmfeld Variabel. Wann Dir op eng Datei loggt, ginn d'Logbicher net méi op d'Konsole geschriwwe ginn.
448
+
449
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
450
+
451
+ Fir de Logbuch auszeschalten:
452
+
453
+ MOBILETTO_LOG_FILE=/dev/null
454
+
455
+ </pre>