mobiletto 1.1.10 → 1.1.13

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 +74 -0
  2. package/docs/README.md +113 -0
  3. package/docs/af/README.md +481 -0
  4. package/docs/am/README.md +481 -0
  5. package/docs/ar/README.md +481 -0
  6. package/docs/az/README.md +481 -0
  7. package/docs/be/README.md +481 -0
  8. package/docs/bg/README.md +481 -0
  9. package/docs/bn/README.md +481 -0
  10. package/docs/bs/README.md +481 -0
  11. package/docs/ca/README.md +481 -0
  12. package/docs/ceb/README.md +481 -0
  13. package/docs/co/README.md +481 -0
  14. package/docs/cs/README.md +481 -0
  15. package/docs/cy/README.md +481 -0
  16. package/docs/da/README.md +481 -0
  17. package/docs/de/README.md +481 -0
  18. package/docs/el/README.md +481 -0
  19. package/docs/eo/README.md +481 -0
  20. package/docs/es/README.md +481 -0
  21. package/docs/et/README.md +481 -0
  22. package/docs/eu/README.md +481 -0
  23. package/docs/fa/README.md +481 -0
  24. package/docs/fi/README.md +481 -0
  25. package/docs/fr/README.md +481 -0
  26. package/docs/fy/README.md +481 -0
  27. package/docs/ga/README.md +481 -0
  28. package/docs/gd/README.md +481 -0
  29. package/docs/gl/README.md +481 -0
  30. package/docs/gu/README.md +481 -0
  31. package/docs/ha/README.md +481 -0
  32. package/docs/haw/README.md +481 -0
  33. package/docs/he/README.md +481 -0
  34. package/docs/hi/README.md +481 -0
  35. package/docs/hmn/README.md +481 -0
  36. package/docs/hr/README.md +481 -0
  37. package/docs/ht/README.md +481 -0
  38. package/docs/hu/README.md +481 -0
  39. package/docs/hy/README.md +481 -0
  40. package/docs/id/README.md +481 -0
  41. package/docs/ig/README.md +481 -0
  42. package/docs/is/README.md +481 -0
  43. package/docs/it/README.md +481 -0
  44. package/docs/iw/README.md +481 -0
  45. package/docs/ja/README.md +481 -0
  46. package/docs/jv/README.md +481 -0
  47. package/docs/ka/README.md +481 -0
  48. package/docs/kk/README.md +481 -0
  49. package/docs/km/README.md +481 -0
  50. package/docs/kn/README.md +481 -0
  51. package/docs/ko/README.md +481 -0
  52. package/docs/ku/README.md +481 -0
  53. package/docs/ky/README.md +481 -0
  54. package/docs/la/README.md +481 -0
  55. package/docs/lb/README.md +481 -0
  56. package/docs/lo/README.md +481 -0
  57. package/docs/lt/README.md +481 -0
  58. package/docs/lv/README.md +481 -0
  59. package/docs/mg/README.md +481 -0
  60. package/docs/mi/README.md +481 -0
  61. package/docs/mk/README.md +481 -0
  62. package/docs/ml/README.md +481 -0
  63. package/docs/mn/README.md +481 -0
  64. package/docs/mr/README.md +481 -0
  65. package/docs/ms/README.md +481 -0
  66. package/docs/mt/README.md +481 -0
  67. package/docs/my/README.md +481 -0
  68. package/docs/ne/README.md +481 -0
  69. package/docs/nl/README.md +481 -0
  70. package/docs/no/README.md +481 -0
  71. package/docs/ny/README.md +481 -0
  72. package/docs/or/README.md +481 -0
  73. package/docs/pa/README.md +481 -0
  74. package/docs/pl/README.md +481 -0
  75. package/docs/ps/README.md +481 -0
  76. package/docs/pt/README.md +481 -0
  77. package/docs/ro/README.md +481 -0
  78. package/docs/ru/README.md +481 -0
  79. package/docs/rw/README.md +481 -0
  80. package/docs/sd/README.md +481 -0
  81. package/docs/si/README.md +481 -0
  82. package/docs/sk/README.md +481 -0
  83. package/docs/sl/README.md +481 -0
  84. package/docs/sm/README.md +481 -0
  85. package/docs/sn/README.md +481 -0
  86. package/docs/so/README.md +481 -0
  87. package/docs/sq/README.md +481 -0
  88. package/docs/sr/README.md +481 -0
  89. package/docs/st/README.md +481 -0
  90. package/docs/su/README.md +481 -0
  91. package/docs/sv/README.md +481 -0
  92. package/docs/sw/README.md +481 -0
  93. package/docs/ta/README.md +481 -0
  94. package/docs/te/README.md +481 -0
  95. package/docs/tg/README.md +481 -0
  96. package/docs/th/README.md +481 -0
  97. package/docs/tk/README.md +481 -0
  98. package/docs/tl/README.md +481 -0
  99. package/docs/tr/README.md +481 -0
  100. package/docs/tt/README.md +481 -0
  101. package/docs/ug/README.md +481 -0
  102. package/docs/uk/README.md +481 -0
  103. package/docs/ur/README.md +481 -0
  104. package/docs/uz/README.md +481 -0
  105. package/docs/vi/README.md +481 -0
  106. package/docs/xh/README.md +481 -0
  107. package/docs/yi/README.md +481 -0
  108. package/docs/yo/README.md +481 -0
  109. package/docs/zh/README.md +481 -0
  110. package/docs/zu/README.md +481 -0
  111. package/drivers/b2/index.js +25 -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 +13 -9
  116. package/util/redis.js +2 -2
@@ -0,0 +1,481 @@
1
+ Mobiletto
2
+ =========
3
+
4
+ Mobileto ist eine JavaScript-Speicherabstraktionsschicht mit optionaler transparenter clientseitiger Verschlüsselung.
5
+
6
+ # Inhalt
7
+ * [Warum Mobiletto?](#Warum-Mobiletto?)
8
+ * [Schnellstart](#Schnellstart)
9
+ * [Mobiletto-CLI](#mobiletto-cli)
10
+ * [Quelle](#Quelle)
11
+ * [Installation](#Installation)
12
+ * [Unterstützung und Finanzierung](#Unterstützung-und-Finanzierung)
13
+ * [Basisnutzung](#Basic-use)
14
+ * [Metadaten](#Metadaten)
15
+ * [Alternativer Importstil](#Alternativer-Importstil)
16
+ * [Zwischenspeichern](#Zwischenspeichern)
17
+ * [Spiegelung](#Spiegelung)
18
+ * [Transparente Verschlüsselung](#Transparent-Verschlüsselung)
19
+ * [Schlüsselrotation](#Schlüsselrotation)
20
+ * [Treiberschnittstelle](#Driver-interface)
21
+ * [Protokollierung](#Protokollierung)
22
+
23
+ # Lesen Sie dies in einer anderen Sprache
24
+ Dieses README.md-Dokument wurde über [hokeylization](https://github.com/cobbzilla/hokeylization) übersetzt in
25
+ **[jede von Google Übersetzer unterstützte Sprache](https://cloud.google.com/translate/docs/languages)!**
26
+
27
+ Ich bin sicher, es ist nicht perfekt, aber ich hoffe, es ist besser als nichts!
28
+
29
+ [🇸🇦 Arabisch](../ar/README.md)
30
+ [🇧🇩 Bengali](../bn/README.md)
31
+ [🇩🇪 Deutsch](../de/README.md)
32
+ [🇺🇸 Englisch](../en/README.md)
33
+ [🇪🇸 Spanisch](../es/README.md)
34
+ [🇫🇷 Französisch](../fr/README.md)
35
+ [🇹🇩 Hausa](../ha/README.md)
36
+ [🇮🇳 Hindi](../hi/README.md)
37
+ [🇮🇩 Indonesisch](../id/README.md)
38
+ [🇮🇹 Italienisch](../it/README.md)
39
+ [🇯🇵 Japanisch](../ja/README.md)
40
+ [🇰🇷 Koreanisch](../ko/README.md)
41
+ [🇮🇳 Maranthi](../mr/README.md)
42
+ [🇵🇱 Polnisch](../pl/README.md)
43
+ [🇧🇷 Portugiesisch](../pt/README.md)
44
+ [🇷🇺 Russisch](../ru/README.md)
45
+ [🇰🇪 Suaheli](../sw/README.md)
46
+ [🇵🇭 Tagalog](../tl/README.md)
47
+ [🇹🇷 Türkisch](../tr/README.md)
48
+ [🇵🇰 Urdu](../ur/README.md)
49
+ [🇻🇳 Vietnamesisch](../vi/README.md)
50
+ [🇨🇳 Chinesisch](../zh/README.md)
51
+
52
+
53
+ **[📚 ... Alle Sprachen ...](../README.md)**
54
+ ----
55
+
56
+ ### Gibt es ein Problem mit dieser Übersetzung der README?
57
+ Diese spezielle Übersetzung der ursprünglichen [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
58
+ kann fehlerhaft sein -- *Korrekturen sind sehr willkommen!* Bitte senden Sie eine [Pull-Anfrage auf GitHub](https://github.com/cobbzilla/mobiletto/pulls),
59
+ oder wenn Sie sich dabei nicht wohlfühlen, [öffnen Sie ein Problem](https://github.com/cobbzilla/mobiletto/issues)
60
+
61
+ Wenn Sie ein neues GitHub-Problem zu einer Übersetzung erstellen, gehen Sie bitte wie folgt vor:
62
+ * Fügen Sie die Seiten-URL hinzu (Kopieren/Einfügen aus der Adressleiste des Browsers)
63
+ * Geben Sie genau den falschen Text ein (Kopieren/Einfügen aus dem Browser)
64
+ * Bitte beschreiben Sie, was falsch ist -- ist die Übersetzung falsch? ist die Formatierung irgendwie kaputt?
65
+ * Machen Sie bitte einen Vorschlag für eine bessere Übersetzung oder wie der Text richtig formatiert werden sollte
66
+ * **Vielen Dank!**
67
+
68
+ ## Warum Mobiletto?
69
+
70
+ ### Auf Wiedersehen Vendor Lock-in!
71
+ Die verschiedenen Cloud-Speicheranbieter haben inkompatible APIs. Auch die, die nach „S3-Kompatibilität“ streben
72
+ idiosynkratische Verhaltensweisen haben.
73
+
74
+ Wenn Sie einen bestimmten Speicheranbieter für Ihre App auswählen, wenn Sie direkt in dessen API codieren, wird Ihre App
75
+ ist nun auf diesen Dienst angewiesen. Wenn die Zeit vergeht und sich Code ansammelt, werden wechselnde Anbieter zu einer Herausforderung
76
+ zunehmend unhaltbar. Willkommen in der unterhaltsamen Welt des Vendor Lock-in!
77
+
78
+ Mobiletto wurde entwickelt, um dieses Problem zu lösen. Indem Sie Ihre App in die API von Mobiletto codieren, können Sie ganz einfach
79
+ Wechseln Sie den Speicheranbieter und wissen Sie, dass sich die Speicherebene Ihrer App identisch verhält.
80
+
81
+ ### Umfangreiche Tests
82
+ Alle Treiber werden mit über 60 Tests für jeden Treiber auf identisches Verhalten getestet.
83
+ Wir testen alle Treiber mit jeder Kombination aus:
84
+ * Verschlüsselung: sowohl aktiviert als auch deaktiviert
85
+ * Redis-Cache: sowohl aktiviert als auch deaktiviert
86
+
87
+ Dieser Ansatz gibt uns die Gewissheit, dass sich mobiletto unabhängig vom verwendeten Treiber gleich verhält.
88
+ und unabhängig davon, ob Sie Caching und/oder Verschlüsselung aktivieren.
89
+
90
+ ### Treiberunterstützung
91
+ Aktuelle Mobiletto-Speichertreiber:
92
+ * `s3` : Amazon S3
93
+ * `b2` : Backblaze B2
94
+ * `local` : lokales Dateisystem
95
+
96
+ *Beiträge zur Unterstützung weiterer Cloud-Speicheranbieter sind sehr willkommen!*
97
+
98
+ ##mobiletto-cli
99
+ Mobiletto soll von anderem JavaScript-Code als Bibliothek verwendet werden.
100
+
101
+ Um mit Mobiletto in der Befehlszeile zu arbeiten, verwenden Sie [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
102
+
103
+ ## Quelle
104
+ * [mobiletto auf GitHub](https://github.com/cobbzilla/mobiletto)
105
+ * [mobiletto auf npm](https://www.npmjs.com/package/mobiletto)
106
+
107
+ ## Unterstützung und Finanzierung
108
+ Ich versuche, ein professioneller Open-Source-Softwareentwickler zu werden. Ich habe in gearbeitet
109
+ Ich arbeite seit vielen Jahren in der Softwarebranche, habe erfolgreiche Unternehmen gegründet und an Aktiengesellschaften verkauft.
110
+ Kürzlich habe ich meinen Job verloren, und ich habe eigentlich keine andere Arbeit vor mir
111
+
112
+ Also werde ich versuchen, hilfreiche Software zu schreiben und sehen, ob das funktioniert
113
+
114
+ Wenn Sie diese Software gerne verwenden, wäre ich Ihnen sehr dankbar dafür
115
+ kleinster [monatlicher Beitrag über Patreon](https://www.patreon.com/cobbzilla)
116
+
117
+ *Vielen Dank!*
118
+
119
+ ## Installation
120
+ Installieren Sie mit `npm` oder `yarn` . Sie möchten wahrscheinlich die `lite` Version, die nicht alle enthält
121
+ übersetzte README-Dateien:
122
+
123
+ npm install mobiletto-lite
124
+ yarn add mobiletto-lite
125
+
126
+ Wenn Sie die README-Dateien wirklich in jeder Sprache haben möchten, installieren Sie die Vollversion:
127
+
128
+ npm install mobiletto
129
+ yarn add mobiletto
130
+
131
+ ## Schnellstart
132
+ Ein kurzes Beispiel mit dem Mobiletto `s3` Treiber.
133
+
134
+ Dieser Code würde genauso laufen, wenn der Treiber `b2` oder `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
+ ## Grundlegende Verwendung
165
+ Ein viel umfangreicheres Beispiel, das die meisten der angebotenen Funktionen zeigt:
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
+ ## Metadaten
267
+ Der Befehl `metadata` gibt Metadaten über einen einzelnen Dateisystemeintrag zurück.
268
+ Ebenso ist der Rückgabewert des `list` ein Array von Metadatenobjekten.
269
+
270
+ Ein Metadatenobjekt sieht folgendermaßen aus:
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
+ Die Eigenschaft `type` kann `file` , `dir` , `link` oder `special` .
281
+
282
+ Je nach Treibertyp gibt ein `list` -Befehl möglicherweise nicht alle Felder zurück. Die Eigenschaften `name` und `type`
283
+ sollte immer dabei sein. Ein nachfolgender `metadata` -Befehl gibt alle verfügbaren Eigenschaften zurück.
284
+
285
+ ## Alternativer Importstil
286
+ Importieren Sie das Modul mit vollem Umfang und verwenden Sie die Funktion `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
+ ## Zwischenspeichern
294
+ Mobiletto funktioniert am besten mit einem <a href="https://redis.io">Redis-</a> Cache.
295
+
296
+ Mobiletto versucht, eine Verbindung zu einer Redis-Instanz unter 127.0.0.1:6379 herzustellen
297
+
298
+ Sie können beides überschreiben:
299
+ * Setzen Sie die `MOBILETTO_REDIS_HOST` -Umgebungsvariable, mobiletto, um sich hier anstelle von localhost zu verbinden
300
+ * Legen Sie die `MOBILETTO_REDIS_PORT` , dieser Port wird verwendet
301
+
302
+ Mobiletto speichert alle seine Redis-Schlüssel mit dem Präfix `_mobiletto__` . Sie können dies ändern
303
+ durch Setzen der `MOBILETTO_REDIS_PREFIX` env var.
304
+
305
+ Sie können das Caching pro Verbindung auch mit dem 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
+ ### Sie möchten kein Redis-Caching?
317
+ Deaktivieren: Übergeben Sie „ `enabled: false` “ in Ihrem `opts.redisConfig` , wenn Sie Ihre Verbindung herstellen.
318
+
319
+ Wie unten besprochen, wirkt sich das Deaktivieren des Cachings negativ auf die Leistung aus und zieht mehr Anforderungen nach sich
320
+ zu speichern, die Sie wirklich brauchen.
321
+
322
+ ### Caching-Anleitung
323
+ **Verschlüsselter Speicher**: Das Lesen/Schreiben von verschlüsseltem Speicher ist nur etwas langsamer als normal,
324
+ aber das Navigieren in Verzeichnissen (was einige Dinge tun) ist ziemlich teuer. Verwendung eines Redis-Cache
325
+ wird Ihnen einen deutlichen Leistungsschub geben.
326
+
327
+ Der Standardcache ist sicher, funktioniert aber nicht gut, wenn Sie viele Schreib-/Entfernungsvorgänge haben.
328
+ Jeder Schreib- oder Löschvorgang macht den gesamten Cache ungültig und stellt sicher, dass nachfolgende Lesevorgänge die sehen
329
+ neuste Änderungen.
330
+
331
+ ### CLI-Tools
332
+ Wenn Sie ein CLI-Tool wie [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli) verwenden,
333
+ Sie möchten auf jeden Fall, dass der Redis-Cache aktiviert ist, da er über Aufrufe des `mo` Befehls hinweg bestehen bleibt.
334
+
335
+ ## Spiegelung
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
+ Der `mirror` -Befehl führt eine einmalige Kopie aller Dateien von einem mobiletto zu einem anderen durch.
344
+ Es führt keinen Prozess aus, um den Spiegel im Laufe der Zeit zu warten. Führen Sie den `mirror` Befehl erneut aus
345
+ fehlende Dateien zu synchronisieren.
346
+
347
+ Der Rückgabewert von `mirror` ist ein einfaches Objekt mit Zählern dafür, wie viele Dateien erfolgreich waren
348
+ gespiegelt und wie viele Dateien hatten Fehler:
349
+
350
+ {
351
+ success: count-of-files-mirrored,
352
+ errors: count-of-files-with-errors
353
+ }
354
+
355
+ WARNUNG: Das Spiegeln großer Datensätze kann sehr zeitaufwändig und bandbreitenintensiv sein
356
+
357
+ Bei der `mirror` kann es manchmal verwirrend sein, zu verstehen, wer das ist
358
+ Leser und wer der Autor ist. Stellen Sie es sich wie eine Auftragsbestätigung vor: das „linke Mobiletto“
359
+ ist das zugewiesene Ding (gespiegelte Daten geschrieben) und das "rechte Mobiletto" (das
360
+ Argument für die `mirror` Methode) ist der zugewiesene Wert (gespiegelte Daten werden gelesen).
361
+
362
+ ## Transparente Verschlüsselung
363
+ Transparente clientseitige Verschlüsselung aktivieren:
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
+ Was ist los? Ein separater "Verzeichniseintrag" (dirent) Verzeichnis (verschlüsselt) verfolgt, welche Dateien sich darin befinden
383
+ Verzeichnis (auch bekannt als dirent-Verzeichnis).
384
+ * Der `list` Befehl liest die Verzeichniseintragsdateien, entschlüsselt jeden aufgelisteten Pfad; gibt dann Metadaten für jede Datei zurück
385
+ * `list` Befehle sind ineffizienter, besonders für Verzeichnisse mit einer großen Anzahl von Dateien
386
+ * Der `write` Befehl schreibt dirent-Dateien rekursiv in das dirent-Verzeichnis jedes Elternteils; schreibt dann die Datei
387
+ * `write` -Befehle verursachen O(N) Schreibvorgänge, wobei N = Tiefe in der Verzeichnishierarchie ist
388
+ * Der `remove` Befehl entfernt rekursiv die entsprechende Dirent-Datei und ihre Elterndatei, falls diese leer ist; entfernt dann die Datei
389
+ * Nicht-rekursive `remove` -Befehle verursachen O(N) Lesevorgänge und möglicherweise ebenso viele Löschvorgänge, wobei N = Tiefe in der Verzeichnishierarchie ist
390
+ * Rekursive `remove` Befehle auf großen und tiefen Dateisystemen können teuer werden
391
+
392
+ Beachten Sie, dass selbst bei aktivierter clientseitiger Verschlüsselung ein Gegner mit vollständiger Einsicht in Ihre verschlüsselte Serverseite vorhanden ist
393
+ Speicher, auch ohne den Schlüssel, kann immer noch die Gesamtzahl der Verzeichnisse sehen und wie viele Dateien sich in jedem befinden, und mit
394
+ einige Mühe, entdecken Sie einige oder alle der Gesamtstruktur der Verzeichnishierarchie.
395
+ *Hinweis: Verwenden Sie für mehr Sicherheit eine relativ flache Struktur.*
396
+ Der Angreifer würde die Namen der Verzeichnisse/Dateien nicht kennen, es sei denn, er wüsste auch Ihre Verschlüsselung
397
+ oder die Verschlüsselung auf andere Weise erfolgreich geknackt hatte. Dann sind alle Wetten abgeschlossen!
398
+
399
+ ### Leistung und Caching
400
+ Vorgänge auf verschlüsseltem Speicher können langsam sein. Rekursive Auflistungen und Entfernungen können sehr langsam sein.
401
+ Das Caching über Redis hilft enorm, aber beachten Sie, dass der Cache bei jedem Schreiben oder Entfernen geleert wird.
402
+
403
+ ## Schlüsselrotation
404
+ Erstellen Sie ein Mobiletto mit Ihrem neuen Schlüssel und spiegeln Sie dann die alten Daten hinein:
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
+ ## Treiberschnittstelle
417
+ Ein Treiber ist eine beliebige JS-Datei, die eine „storageClient“-Funktion mit dieser Signatur exportiert:
418
+
419
+ function storageClient (key, secret, opts)
420
+
421
+ * `key` : eine Zeichenfolge, Ihr API-Schlüssel (für den `local` Treiber ist dies das Basisverzeichnis)
422
+ * `secret` : ein String, Ihr API-Secret (kann für den `local` Treiber weggelassen werden)
423
+ * `opts` : ein Objekt, die Eigenschaften sind pro Treiber:
424
+ * Für „local“ bestimmen die Eigenschaften `fileMode` `local` `dirMode` , wie neu erstellte Dateien und Verzeichnisse erstellt werden
425
+ * Für `s3` ist die Eigenschaft `bucket` erforderlich. Optionale Eigenschaften sind:
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
+ Das Objekt, das die Funktion storageClient zurückgibt, muss diese Funktionen definieren:
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
+ ## Protokollierung
457
+ Mobiletto verwendet die Protokollierungsbibliothek [winston](https://www.npmjs.com/package/winston).
458
+
459
+ Protokolle **enthalten** Dateipfade und Fehlermeldungen, enthalten aber **niemals** Schlüssel, Geheimnisse,
460
+ oder andere Informationen zur Verbindungskonfiguration.
461
+
462
+ ### Protokollebene
463
+ Verwenden Sie die Umgebungsvariable `MOBILETTO_LOG_LEVEL` , um die Protokollebene festzulegen, indem Sie eins verwenden
464
+ der `npm` Ebenen, die in [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels) definiert sind
465
+
466
+ Die Standardstufe ist `error` . Die ausführlichste Stufe ist `silly` , obwohl derzeit mobiletto
467
+ protokolliert nicht auf Ebenen unterhalb `debug`
468
+
469
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
470
+
471
+ ### Logdatei
472
+ Standardmäßig schreibt der Logger in die Konsole. Um Protokolle an eine Datei zu senden, setzen Sie die `MOBILETTO_LOG_FILE`
473
+ Umgebungsvariable. Beim Protokollieren in eine Datei werden keine Protokolle mehr in die Konsole geschrieben.
474
+
475
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
476
+
477
+ So deaktivieren Sie die Protokollierung:
478
+
479
+ MOBILETTO_LOG_FILE=/dev/null
480
+
481
+ </pre>