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 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
+ * [Grundlæggende brug](#Basis-brug)
12
+ * [Metadata](#Metadata)
13
+ * [Alternativ import-stil](#Alternate-import-style)
14
+ * [Caching](#Caching)
15
+ * [Mirroring](#Mirroring)
16
+ * [Transparent kryptering](#Transparent-kryptering)
17
+ * [Nøglerotation](#Nøgle-rotation)
18
+ * [Driver-interface](#Driver-interface)
19
+ * [Logging](#Logging)
20
+
21
+ # Læs dette på et andet sprog
22
+ Dette README.md-dokument er blevet oversat via [hokeylization](https://github.com/cobbzilla/hokeylization), til
23
+ **[alle sprog understøttet af Google Translate](https://cloud.google.com/translate/docs/languages)!**
24
+
25
+ Jeg er sikker på, at det ikke er perfekt, men jeg håber, det er bedre end ingenting!
26
+
27
+ [🇸🇦 arabisk](../ar/README.md)
28
+ [🇧🇩 Bengali](../bn/README.md)
29
+ [🇩🇪 tysk](../de/README.md)
30
+ [🇺🇸 engelsk](../en/README.md)
31
+ [🇪🇸 spansk](../es/README.md)
32
+ [🇫🇷 fransk](../fr/README.md)
33
+ [🇹🇩 Hausa](../ha/README.md)
34
+ [🇮🇳 hindi](../hi/README.md)
35
+ [🇮🇩 indonesisk](../id/README.md)
36
+ [🇮🇹 italiensk](../it/README.md)
37
+ [🇯🇵 japansk](../ja/README.md)
38
+ [🇰🇷 koreansk](../ko/README.md)
39
+ [🇮🇳 Maranthi](../mr/README.md)
40
+ [🇵🇱 polsk](../pl/README.md)
41
+ [🇧🇷 portugisisk](../pt/README.md)
42
+ [🇷🇺 russisk](../ru/README.md)
43
+ [🇰🇪 Swahili](../sw/README.md)
44
+ [🇵🇭 Tagalog](../tl/README.md)
45
+ [🇹🇷 tyrkisk](../tr/README.md)
46
+ [🇵🇰 Urdu](../ur/README.md)
47
+ [🇻🇳 vietnamesisk](../vi/README.md)
48
+ [🇨🇳 kinesisk](../zh/README.md)
49
+
50
+
51
+ **[📚 ... Alle sprog ...](../README.md)**
52
+ ----
53
+
54
+ ### Er der et problem med denne oversættelse af README?
55
+ Denne særlige oversættelse af originalen [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
56
+ kan være defekt -- *rettelser er meget velkomne!* Send venligst en [pull request på GitHub](https://github.com/cobbzilla/mobiletto/pulls),
57
+ eller hvis du ikke er tryg ved at gøre det, [åbn et problem](https://github.com/cobbzilla/mobiletto/issues)
58
+
59
+ Når du opretter et nyt GitHub-problem om en oversættelse, skal du gøre følgende:
60
+ * inkludere sidens URL (kopier/indsæt fra browserens adresselinje)
61
+ * medtag den nøjagtige tekst, der er forkert (kopier/indsæt fra browser)
62
+ * beskriv venligst hvad der er galt -- er oversættelsen forkert? er formateringen brudt på en eller anden måde?
63
+ * kom med et forslag til en bedre oversættelse, eller hvordan teksten skal formateres korrekt
64
+ * **Tak skal du have!**
65
+
66
+ ## Hvorfor Mobiletto?
67
+
68
+ ### Farvel leverandørlåsning!
69
+ De forskellige cloud storage-udbydere har inkompatible API'er. Selv dem, der stræber efter "S3-kompatibilitet"
70
+ har idiosynkratisk adfærd.
71
+
72
+ Når du vælger en bestemt lagerleverandør til din app, hvis du koder direkte til deres API, din app
73
+ er nu afhængig af den service. Efterhånden som tiden går, og koden akkumuleres, bliver det skiftende leverandører
74
+ stadig mere uholdbare. Velkommen til den sjove verden med leverandørlåsning!
75
+
76
+ Mobiletto blev designet til at løse dette problem. Ved at kode din app til mobiletto's API kan du nemt
77
+ skifte lagerudbyder og vide, at din apps lagerlag vil opføre sig identisk.
78
+
79
+ ### Omfattende test
80
+ Alle chauffører testes for identisk adfærd med 60+ tests for hver fører.
81
+ Vi tester alle drivere med hver kombination af:
82
+ * Kryptering: både aktiveret og deaktiveret
83
+ * Redis cache: både aktiveret og deaktiveret
84
+
85
+ Denne tilgang giver os tryghed i, at mobiletto vil opføre sig ens, uanset hvilken driver du bruger,
86
+ og uanset om du aktiverer caching og/eller kryptering.
87
+
88
+ ### Driversupport
89
+ Nuværende Mobiletto-lagerdrivere:
90
+ * `s3` : Amazon S3
91
+ * `b2` : Backblaze B2
92
+ * `local` : lokalt filsystem
93
+
94
+ *Bidrag til at understøtte flere cloud storage-udbydere er meget velkomne!*
95
+
96
+ ## mobiletto-cli
97
+ Mobiletto er beregnet til at blive brugt som et bibliotek af anden JavaScript-kode.
98
+
99
+ For at arbejde med mobiletto på kommandolinjen skal du bruge [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
100
+
101
+ ## Kilde
102
+ * [mobiletto på GitHub](https://github.com/cobbzilla/mobiletto)
103
+ * [mobiletto på npm](https://www.npmjs.com/package/mobiletto)
104
+
105
+ ## Hurtig start
106
+ Et kort eksempel ved hjælp af mobiletto `s3` driveren.
107
+
108
+ Denne kode ville køre det samme, hvis driveren var `b2` eller `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
+ ## Grundlæggende brug
139
+ Et meget mere omfattende eksempel, der viser de fleste af de tilbudte funktioner:
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
+ Kommandoen `metadata` returnerer metadata om en enkelt filsystemindgang.
242
+ På samme måde er returværdien fra kommandoen `list` en række metadataobjekter.
243
+
244
+ Et metadataobjekt ser sådan ud:
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
+ Egenskaben `type` type` kan være `file` , `dir` , `link` link` eller `special` .
255
+
256
+ Afhængigt af drivertypen returnerer en `list` -kommando muligvis ikke alle felter. Egenskaberne `name` og "type `type` .
257
+ skal altid være til stede. En efterfølgende `metadata` kommando vil returnere alle tilgængelige egenskaber.
258
+
259
+ ## Alternativ importstil
260
+ Importer det fuldt omfangsrige modul og brug funktionen `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
+ Mobiletto fungerer bedst med en <a href="https://redis.io">redis-</a> cache.
269
+
270
+ Mobiletto vil forsøge at oprette forbindelse til en redis-instans på 127.0.0.1:6379
271
+
272
+ Du kan tilsidesætte en af disse:
273
+ * Indstil `MOBILETTO_REDIS_HOST` env var, mobiletfor at oprette forbindelse her i stedet for localhost
274
+ * Indstil `MOBILETTO_REDIS_PORT` env var, denne port vil blive brugt
275
+
276
+ Mobiletto gemmer alle sine redis-nøgler med præfikset `_mobiletto__` . Du kan ændre dette
277
+ ved at indstille `MOBILETTO_REDIS_PREFIX` env var.
278
+
279
+ Du kan også indstille caching pr. forbindelse med objektet `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
+ ### Vil du ikke have redis caching?
291
+ For at deaktivere: `enabled: false` i dit `opts.redisConfig` objekt, når du etablerer din forbindelse.
292
+
293
+ Som diskuteret nedenfor, vil deaktivering af caching have en negativ effekt på ydeevnen og medføre flere anmodninger
294
+ til opbevaring, som du virkelig har brug for.
295
+
296
+ ### Cachingvejledning
297
+ **Krypteret lagring**: læsning/skrivning af krypteret lagring er kun en smule langsommere end normalt,
298
+ men at navigere rundt i mapper (hvilket nogle ting gør) er ret dyrt. Brug af en redis cache
299
+ vil give dig et markant præstationsløft.
300
+
301
+ Standardcachen er sikker, men fungerer ikke godt, hvis du har mange skrive-/fjernhandlinger.
302
+ Enhver skrive- eller fjernoperation ugyldiggør hele cachen, hvilket sikrer, at efterfølgende læsninger vil se
303
+ seneste ændringer.
304
+
305
+ ### CLI-værktøjer
306
+ Hvis du bruger et CLI-værktøj som [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
307
+ du vil helt sikkert have redis-cachen aktiveret, da den varer på tværs af påkaldelser af `mo` kommandoen.
308
+
309
+ ## Spejling
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
+ Kommandoen `mirror` " udfører en engangskopi af alle filer fra en mobiletto til en anden.
318
+ Det kører ikke nogen proces for at vedligeholde spejlet over tid. Kør kommandoen `mirror` " igen
319
+ for at synkronisere eventuelle manglende filer.
320
+
321
+ Returværdien fra `mirror` er et simpelt objekt med tællere for, hvor mange filer der lykkedes
322
+ spejlet, og hvor mange filer havde fejl:
323
+
324
+ {
325
+ success: count-of-files-mirrored,
326
+ errors: count-of-files-with-errors
327
+ }
328
+
329
+ ADVARSEL: Spejling af store datasæt kan være meget tidskrævende og båndbreddekrævende
330
+
331
+ Med `mirror` kaldet semantik kan det nogle gange være forvirrende at forstå, hvem der er
332
+ læser og hvem der er forfatter. Forestil dig det som en opgaveerklæring: "venstre mobiltto"
333
+ er den ting, der tildeles (spejlet data skrevet), og "højre mobiltto" (den
334
+ argument til `mirror` -metoden) er den værdi, der tildeles (spejlede data læses).
335
+
336
+ ## Gennemsigtig kryptering
337
+ Aktiver gennemsigtig kryptering på klientsiden:
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
+ Hvad sker der? En separat "mappeindgang" (dirent) mappe (krypteret) sporer, hvilke filer der er i den
357
+ bibliotek (alias den dirent-mappe).
358
+ * Kommandoen `list` læser mappeindgangsfilerne, dekrypterer hver sti på listen; returnerer derefter metadata for hver fil
359
+ * `list` kommandoer er mere ineffektive, især for mapper med et stort antal filer
360
+ * Kommandoen `write` skriver dirent-filer i hver forælders dirent-mappe, rekursivt; skriver derefter filen
361
+ * `write` kommandoer vil medføre O(N)-skrivninger, med N = dybde i mappehierarkiet
362
+ * Kommandoen `remove` fjerner den tilsvarende dirent-fil, og dens forælder, hvis den er tom, rekursivt; fjerner derefter filen
363
+ * Ikke-rekursive `remove` -kommandoer vil medføre O(N)-læsninger og potentielt lige så mange sletninger, med N = dybde i mappehierarkiet
364
+ * Rekursive `remove` kommandoer på store og dybe filsystemer kan være dyre
365
+
366
+ Bemærk, at selv med klientsidekryptering aktiveret, er en modstander med fuld synlighed på din krypterede serverside
367
+ opbevaring, selv uden nøglen, kan stadig se det samlede antal mapper og hvor mange filer der er i hver og med
368
+ nogle anstrengelser, opdage noget af eller hele den overordnede struktur af kataloghierarkiet.
369
+ *Bemærk: Brug en relativt flad struktur for bedre sikkerhed.*
370
+ Modstanderen ville ikke kende navnene på mapperne/filerne, medmindre de også kendte din kryptering
371
+ nøgle eller på anden måde havde knækket krypteringen. Så er alle væddemål slået fra!
372
+
373
+ ### Ydeevne og cachelagring
374
+ Operationer på krypteret lagring kan være langsomme. Rekursive lister og fjernelser kan være meget langsomme.
375
+ Caching via redis hjælper enormt, men bemærk, at cachen tømmes ved enhver skrivning eller fjernelse.
376
+
377
+ ## Nøglerotation
378
+ Opret en mobiletto med din nye nøgle, og spejle de gamle data ind i den:
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
+ ## Drivergrænseflade
391
+ En driver er enhver JS-fil, der eksporterer en 'storageClient'-funktion med denne signatur:
392
+
393
+ function storageClient (key, secret, opts)
394
+
395
+ * `key` : en streng, din API-nøgle (for den `local` driver er dette basismappen)
396
+ * `secret` : en streng, din API-hemmelighed (kan udelades for den `local` driver)
397
+ * `opts` : et objekt, egenskaberne er pr. driver:
398
+ * For `local` bestemmer egenskaberne `fileMode` og `dirMode` , hvordan nye oprettelsesfiler og mapper oprettes
399
+ * For `s3` er egenskaben `bucket` påkrævet. Valgfri egenskaber er:
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
+ Objektet, som storageClient-funktionen returnerer, skal definere disse funktioner:
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
+ ## Logning
431
+ Mobiletto bruger logbiblioteket [winston](https://www.npmjs.com/package/winston).
432
+
433
+ Logfiler **vil** indeholde filstier og fejlmeddelelser, men vil **aldrig** indeholde nøgler, hemmeligheder,
434
+ eller enhver anden forbindelseskonfigurationsinformation.
435
+
436
+ ### Logniveau
437
+ Brug `MOBILETTO_LOG_LEVEL` til at indstille logniveauet ved at bruge en
438
+ af `npm` -niveauerne defineret i [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
439
+
440
+ Standardniveauet er `error` . Det mest udførlige niveau er `silly` , selvom det i øjeblikket er mobiletto
441
+ logger ikke på niveauer under `debug`
442
+
443
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
444
+
445
+ ### Logfil
446
+ Som standard skriver loggeren til konsollen. For at sende logfiler til en fil skal du indstille `MOBILETTO_LOG_FILE`
447
+ miljøvariabel. Når du logger på en fil, vil der ikke længere blive skrevet logfiler til konsollen.
448
+
449
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
450
+
451
+ Sådan slår du logning fra:
452
+
453
+ MOBILETTO_LOG_FILE=/dev/null
454
+
455
+ </pre>