mobiletto 1.1.9 → 1.1.12

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 +82 -4
  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 +24 -6
  112. package/hokey.json +16 -0
  113. package/index.js +32 -16
  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,481 @@
1
+ Mobiletto
2
+ =========
3
+
4
+ Mobiletto er et JavaScript-lagerabstraktionslag med valgfri transparent kryptering på klientsiden.
5
+
6
+ # Indhold
7
+ * [Hvorfor Mobiletto?](#Why-Mobiletto?)
8
+ * [Hurtig start](#Hurtigstart)
9
+ * [Mobiletto CLI](#mobiletto-cli)
10
+ * [Kilde](#Kilde)
11
+ * [Installation](#Installation)
12
+ * [Support and Funding](#Support-and-Funding)
13
+ * [Grundlæggende brug](#Basis-brug)
14
+ * [Metadata](#Metadata)
15
+ * [Alternativ import-stil](#Alternate-import-style)
16
+ * [Caching](#Caching)
17
+ * [Mirroring](#Mirroring)
18
+ * [Transparent kryptering](#Transparent-kryptering)
19
+ * [Nøglerotation](#Nøgle-rotation)
20
+ * [Driver-interface](#Driver-interface)
21
+ * [Logging](#Logging)
22
+
23
+ # Læs dette på et andet sprog
24
+ Dette README.md-dokument er blevet oversat via [hokeylization](https://github.com/cobbzilla/hokeylization), til
25
+ **[alle sprog understøttet af Google Translate](https://cloud.google.com/translate/docs/languages)!**
26
+
27
+ Jeg er sikker på, at det ikke er perfekt, men jeg håber, det er bedre end ingenting!
28
+
29
+ [🇸🇦 arabisk](../ar/README.md)
30
+ [🇧🇩 Bengali](../bn/README.md)
31
+ [🇩🇪 tysk](../de/README.md)
32
+ [🇺🇸 engelsk](../en/README.md)
33
+ [🇪🇸 spansk](../es/README.md)
34
+ [🇫🇷 fransk](../fr/README.md)
35
+ [🇹🇩 Hausa](../ha/README.md)
36
+ [🇮🇳 hindi](../hi/README.md)
37
+ [🇮🇩 indonesisk](../id/README.md)
38
+ [🇮🇹 italiensk](../it/README.md)
39
+ [🇯🇵 japansk](../ja/README.md)
40
+ [🇰🇷 koreansk](../ko/README.md)
41
+ [🇮🇳 Maranthi](../mr/README.md)
42
+ [🇵🇱 polsk](../pl/README.md)
43
+ [🇧🇷 portugisisk](../pt/README.md)
44
+ [🇷🇺 russisk](../ru/README.md)
45
+ [🇰🇪 Swahili](../sw/README.md)
46
+ [🇵🇭 Tagalog](../tl/README.md)
47
+ [🇹🇷 tyrkisk](../tr/README.md)
48
+ [🇵🇰 Urdu](../ur/README.md)
49
+ [🇻🇳 vietnamesisk](../vi/README.md)
50
+ [🇨🇳 kinesisk](../zh/README.md)
51
+
52
+
53
+ **[📚 ... Alle sprog ...](../README.md)**
54
+ ----
55
+
56
+ ### Er der et problem med denne oversættelse af README?
57
+ Denne særlige oversættelse af originalen [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
58
+ kan være defekt -- *rettelser er meget velkomne!* Send venligst en [pull request på GitHub](https://github.com/cobbzilla/mobiletto/pulls),
59
+ eller hvis du ikke er tryg ved at gøre det, [åbn et problem](https://github.com/cobbzilla/mobiletto/issues)
60
+
61
+ Når du opretter et nyt GitHub-problem om en oversættelse, skal du gøre følgende:
62
+ * inkludere sidens URL (kopier/indsæt fra browserens adresselinje)
63
+ * medtag den nøjagtige tekst, der er forkert (kopier/indsæt fra browser)
64
+ * beskriv venligst hvad der er galt -- er oversættelsen forkert? er formateringen brudt på en eller anden måde?
65
+ * kom med et forslag til en bedre oversættelse, eller hvordan teksten skal formateres korrekt
66
+ * **Tak skal du have!**
67
+
68
+ ## Hvorfor Mobiletto?
69
+
70
+ ### Farvel leverandørlåsning!
71
+ De forskellige cloud storage-udbydere har inkompatible API'er. Selv dem, der stræber efter "S3-kompatibilitet"
72
+ har idiosynkratisk adfærd.
73
+
74
+ Når du vælger en bestemt lagerleverandør til din app, hvis du koder direkte til deres API, din app
75
+ er nu afhængig af den service. Efterhånden som tiden går, og koden akkumuleres, bliver det skiftende leverandører
76
+ stadig mere uholdbare. Velkommen til den sjove verden med leverandørlåsning!
77
+
78
+ Mobiletto blev designet til at løse dette problem. Ved at kode din app til mobiletto's API kan du nemt
79
+ skifte lagerudbyder og vide, at din apps lagerlag vil opføre sig identisk.
80
+
81
+ ### Omfattende test
82
+ Alle chauffører testes for identisk adfærd med 60+ tests for hver fører.
83
+ Vi tester alle drivere med hver kombination af:
84
+ * Kryptering: både aktiveret og deaktiveret
85
+ * Redis cache: både aktiveret og deaktiveret
86
+
87
+ Denne tilgang giver os tryghed i, at mobiletto vil opføre sig ens, uanset hvilken driver du bruger,
88
+ og uanset om du aktiverer caching og/eller kryptering.
89
+
90
+ ### Driversupport
91
+ Nuværende Mobiletto-lagerdrivere:
92
+ * `s3` : Amazon S3
93
+ * `b2` : Backblaze B2
94
+ * `local` : lokalt filsystem
95
+
96
+ *Bidrag til at understøtte flere cloud storage-udbydere er meget velkomne!*
97
+
98
+ ## mobiletto-cli
99
+ Mobiletto er beregnet til at blive brugt som et bibliotek af anden JavaScript-kode.
100
+
101
+ For at arbejde med mobiletto på kommandolinjen skal du bruge [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
102
+
103
+ ## Kilde
104
+ * [mobiletto på GitHub](https://github.com/cobbzilla/mobiletto)
105
+ * [mobiletto på npm](https://www.npmjs.com/package/mobiletto)
106
+
107
+ ## Støtte og finansiering
108
+ Jeg forsøger at være en professionel open source softwareudvikler. Jeg har arbejdet i
109
+ softwareindustrien i mange år, har jeg startet succesrige virksomheder og solgt dem til offentlige virksomheder.
110
+ For nylig mistede jeg mit job, og jeg har ikke rigtig noget andet arbejde i kø
111
+
112
+ Så jeg vil prøve at skrive nyttig software og se om det virker
113
+
114
+ Hvis du kan lide at bruge denne software, ville jeg være meget taknemmelig for selv
115
+ mindste [månedligt bidrag via Patreon](https://www.patreon.com/cobbzilla)
116
+
117
+ *Tak skal du have!*
118
+
119
+ ## Installation
120
+ Installer med `npm` eller `yarn` . Du vil sandsynligvis have `lite` versionen, der ikke inkluderer alle
121
+ oversatte README-filer:
122
+
123
+ npm install mobiletto-lite
124
+ yarn add mobiletto-lite
125
+
126
+ Hvis du virkelig vil have README-filerne på alle sprog, skal du installere den fulde version:
127
+
128
+ npm install mobiletto
129
+ yarn add mobiletto
130
+
131
+ ## Hurtig start
132
+ Et kort eksempel ved hjælp af mobiletto `s3` driveren.
133
+
134
+ Denne kode ville køre det samme, hvis driveren var `b2` eller `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
+ ## Grundlæggende brug
165
+ Et meget mere omfattende eksempel, der viser de fleste af de tilbudte funktioner:
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
+ ## Metadata
267
+ Kommandoen `metadata` returnerer metadata om en enkelt filsystemindgang.
268
+ På samme måde er returværdien fra kommandoen `list` en række metadataobjekter.
269
+
270
+ Et metadataobjekt ser sådan ud:
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
+ Egenskaben `type` type` kan være `file` , `dir` , `link` link` eller `special` .
281
+
282
+ Afhængigt af drivertypen returnerer en `list` -kommando muligvis ikke alle felter. Egenskaberne `name` og "type `type` .
283
+ skal altid være til stede. En efterfølgende `metadata` kommando vil returnere alle tilgængelige egenskaber.
284
+
285
+ ## Alternativ importstil
286
+ Importer det fuldt omfangsrige modul og brug funktionen `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
+ ## Caching
294
+ Mobiletto fungerer bedst med en <a href="https://redis.io">redis-</a> cache.
295
+
296
+ Mobiletto vil forsøge at oprette forbindelse til en redis-instans på 127.0.0.1:6379
297
+
298
+ Du kan tilsidesætte en af disse:
299
+ * Indstil `MOBILETTO_REDIS_HOST` env var, mobiletfor at oprette forbindelse her i stedet for localhost
300
+ * Indstil `MOBILETTO_REDIS_PORT` env var, denne port vil blive brugt
301
+
302
+ Mobiletto gemmer alle sine redis-nøgler med præfikset `_mobiletto__` . Du kan ændre dette
303
+ ved at indstille `MOBILETTO_REDIS_PREFIX` env var.
304
+
305
+ Du kan også indstille caching pr. forbindelse med objektet `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
+ ### Vil du ikke have redis caching?
317
+ For at deaktivere: `enabled: false` i dit `opts.redisConfig` objekt, når du etablerer din forbindelse.
318
+
319
+ Som diskuteret nedenfor, vil deaktivering af caching have en negativ effekt på ydeevnen og medføre flere anmodninger
320
+ til opbevaring, som du virkelig har brug for.
321
+
322
+ ### Cachingvejledning
323
+ **Krypteret lagring**: læsning/skrivning af krypteret lagring er kun en smule langsommere end normalt,
324
+ men at navigere rundt i mapper (hvilket nogle ting gør) er ret dyrt. Brug af en redis cache
325
+ vil give dig et markant præstationsløft.
326
+
327
+ Standardcachen er sikker, men fungerer ikke godt, hvis du har mange skrive-/fjernhandlinger.
328
+ Enhver skrive- eller fjernoperation ugyldiggør hele cachen, hvilket sikrer, at efterfølgende læsninger vil se
329
+ seneste ændringer.
330
+
331
+ ### CLI-værktøjer
332
+ Hvis du bruger et CLI-værktøj som [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
333
+ du vil helt sikkert have redis-cachen aktiveret, da den varer på tværs af påkaldelser af `mo` kommandoen.
334
+
335
+ ## Spejling
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
+ Kommandoen `mirror` " udfører en engangskopi af alle filer fra en mobiletto til en anden.
344
+ Det kører ikke nogen proces for at vedligeholde spejlet over tid. Kør kommandoen `mirror` " igen
345
+ for at synkronisere eventuelle manglende filer.
346
+
347
+ Returværdien fra `mirror` er et simpelt objekt med tællere for, hvor mange filer der lykkedes
348
+ spejlet, og hvor mange filer havde fejl:
349
+
350
+ {
351
+ success: count-of-files-mirrored,
352
+ errors: count-of-files-with-errors
353
+ }
354
+
355
+ ADVARSEL: Spejling af store datasæt kan være meget tidskrævende og båndbreddekrævende
356
+
357
+ Med `mirror` kaldet semantik kan det nogle gange være forvirrende at forstå, hvem der er
358
+ læser og hvem der er forfatter. Forestil dig det som en opgaveerklæring: "venstre mobiltto"
359
+ er den ting, der tildeles (spejlet data skrevet), og "højre mobiltto" (den
360
+ argument til `mirror` -metoden) er den værdi, der tildeles (spejlede data læses).
361
+
362
+ ## Gennemsigtig kryptering
363
+ Aktiver gennemsigtig kryptering på klientsiden:
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
+ Hvad sker der? En separat "mappeindgang" (dirent) mappe (krypteret) sporer, hvilke filer der er i den
383
+ bibliotek (alias den dirent-mappe).
384
+ * Kommandoen `list` læser mappeindgangsfilerne, dekrypterer hver sti på listen; returnerer derefter metadata for hver fil
385
+ * `list` kommandoer er mere ineffektive, især for mapper med et stort antal filer
386
+ * Kommandoen `write` skriver dirent-filer i hver forælders dirent-mappe, rekursivt; skriver derefter filen
387
+ * `write` kommandoer vil medføre O(N)-skrivninger, med N = dybde i mappehierarkiet
388
+ * Kommandoen `remove` fjerner den tilsvarende dirent-fil, og dens forælder, hvis den er tom, rekursivt; fjerner derefter filen
389
+ * Ikke-rekursive `remove` -kommandoer vil medføre O(N)-læsninger og potentielt lige så mange sletninger, med N = dybde i mappehierarkiet
390
+ * Rekursive `remove` kommandoer på store og dybe filsystemer kan være dyre
391
+
392
+ Bemærk, at selv med klientsidekryptering aktiveret, er en modstander med fuld synlighed på din krypterede serverside
393
+ opbevaring, selv uden nøglen, kan stadig se det samlede antal mapper og hvor mange filer der er i hver og med
394
+ nogle anstrengelser, opdage noget af eller hele den overordnede struktur af kataloghierarkiet.
395
+ *Bemærk: Brug en relativt flad struktur for bedre sikkerhed.*
396
+ Modstanderen ville ikke kende navnene på mapperne/filerne, medmindre de også kendte din kryptering
397
+ nøgle eller på anden måde havde knækket krypteringen. Så er alle væddemål slået fra!
398
+
399
+ ### Ydeevne og cachelagring
400
+ Operationer på krypteret lager kan være langsomme. Rekursive lister og fjernelser kan være meget langsomme.
401
+ Caching via redis hjælper enormt, men bemærk, at cachen tømmes ved enhver skrivning eller fjernelse.
402
+
403
+ ## Nøglerotation
404
+ Opret en mobiletto med din nye nøgle, og spejle de gamle data ind i den:
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
+ ## Drivergrænseflade
417
+ En driver er enhver JS-fil, der eksporterer en 'storageClient'-funktion med denne signatur:
418
+
419
+ function storageClient (key, secret, opts)
420
+
421
+ * `key` : en streng, din API-nøgle (for den `local` driver er dette basismappen)
422
+ * `secret` : en streng, din API-hemmelighed (kan udelades for den `local` driver)
423
+ * `opts` : et objekt, egenskaberne er pr. driver:
424
+ * For `local` bestemmer egenskaberne `fileMode` og `dirMode` , hvordan nye oprettelsesfiler og mapper oprettes
425
+ * For `s3` er egenskaben `bucket` påkrævet. Valgfri egenskaber er:
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
+ Objektet, som storageClient-funktionen returnerer, skal definere disse funktioner:
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
+ ## Logning
457
+ Mobiletto bruger logbiblioteket [winston](https://www.npmjs.com/package/winston).
458
+
459
+ Logfiler **vil** indeholde filstier og fejlmeddelelser, men vil **aldrig** indeholde nøgler, hemmeligheder,
460
+ eller enhver anden forbindelseskonfigurationsinformation.
461
+
462
+ ### Logniveau
463
+ Brug `MOBILETTO_LOG_LEVEL` til at indstille logniveauet ved at bruge en
464
+ af `npm` -niveauerne defineret i [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
465
+
466
+ Standardniveauet er `error` . Det mest udførlige niveau er `silly` , selvom det i øjeblikket er mobiletto
467
+ logger ikke på niveauer under `debug`
468
+
469
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
470
+
471
+ ### Logfil
472
+ Som standard skriver loggeren til konsollen. For at sende logfiler til en fil skal du indstille `MOBILETTO_LOG_FILE`
473
+ miljøvariabel. Når du logger på en fil, vil der ikke længere blive skrevet logfiler til konsollen.
474
+
475
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
476
+
477
+ Sådan slår du logning fra:
478
+
479
+ MOBILETTO_LOG_FILE=/dev/null
480
+
481
+ </pre>