mobiletto 1.1.10 → 1.1.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (116) hide show
  1. package/README.md +48 -0
  2. package/docs/README.md +113 -0
  3. package/docs/af/README.md +455 -0
  4. package/docs/am/README.md +455 -0
  5. package/docs/ar/README.md +455 -0
  6. package/docs/az/README.md +455 -0
  7. package/docs/be/README.md +455 -0
  8. package/docs/bg/README.md +455 -0
  9. package/docs/bn/README.md +455 -0
  10. package/docs/bs/README.md +455 -0
  11. package/docs/ca/README.md +455 -0
  12. package/docs/ceb/README.md +455 -0
  13. package/docs/co/README.md +455 -0
  14. package/docs/cs/README.md +455 -0
  15. package/docs/cy/README.md +455 -0
  16. package/docs/da/README.md +455 -0
  17. package/docs/de/README.md +455 -0
  18. package/docs/el/README.md +455 -0
  19. package/docs/eo/README.md +455 -0
  20. package/docs/es/README.md +455 -0
  21. package/docs/et/README.md +455 -0
  22. package/docs/eu/README.md +455 -0
  23. package/docs/fa/README.md +455 -0
  24. package/docs/fi/README.md +455 -0
  25. package/docs/fr/README.md +455 -0
  26. package/docs/fy/README.md +455 -0
  27. package/docs/ga/README.md +455 -0
  28. package/docs/gd/README.md +455 -0
  29. package/docs/gl/README.md +455 -0
  30. package/docs/gu/README.md +455 -0
  31. package/docs/ha/README.md +455 -0
  32. package/docs/haw/README.md +455 -0
  33. package/docs/he/README.md +455 -0
  34. package/docs/hi/README.md +455 -0
  35. package/docs/hmn/README.md +455 -0
  36. package/docs/hr/README.md +455 -0
  37. package/docs/ht/README.md +455 -0
  38. package/docs/hu/README.md +455 -0
  39. package/docs/hy/README.md +455 -0
  40. package/docs/id/README.md +455 -0
  41. package/docs/ig/README.md +455 -0
  42. package/docs/is/README.md +455 -0
  43. package/docs/it/README.md +455 -0
  44. package/docs/iw/README.md +455 -0
  45. package/docs/ja/README.md +455 -0
  46. package/docs/jv/README.md +455 -0
  47. package/docs/ka/README.md +455 -0
  48. package/docs/kk/README.md +455 -0
  49. package/docs/km/README.md +455 -0
  50. package/docs/kn/README.md +455 -0
  51. package/docs/ko/README.md +455 -0
  52. package/docs/ku/README.md +455 -0
  53. package/docs/ky/README.md +455 -0
  54. package/docs/la/README.md +455 -0
  55. package/docs/lb/README.md +455 -0
  56. package/docs/lo/README.md +455 -0
  57. package/docs/lt/README.md +455 -0
  58. package/docs/lv/README.md +455 -0
  59. package/docs/mg/README.md +455 -0
  60. package/docs/mi/README.md +455 -0
  61. package/docs/mk/README.md +455 -0
  62. package/docs/ml/README.md +455 -0
  63. package/docs/mn/README.md +455 -0
  64. package/docs/mr/README.md +455 -0
  65. package/docs/ms/README.md +455 -0
  66. package/docs/mt/README.md +455 -0
  67. package/docs/my/README.md +455 -0
  68. package/docs/ne/README.md +455 -0
  69. package/docs/nl/README.md +455 -0
  70. package/docs/no/README.md +455 -0
  71. package/docs/ny/README.md +455 -0
  72. package/docs/or/README.md +455 -0
  73. package/docs/pa/README.md +455 -0
  74. package/docs/pl/README.md +455 -0
  75. package/docs/ps/README.md +455 -0
  76. package/docs/pt/README.md +455 -0
  77. package/docs/ro/README.md +455 -0
  78. package/docs/ru/README.md +455 -0
  79. package/docs/rw/README.md +455 -0
  80. package/docs/sd/README.md +455 -0
  81. package/docs/si/README.md +455 -0
  82. package/docs/sk/README.md +455 -0
  83. package/docs/sl/README.md +455 -0
  84. package/docs/sm/README.md +455 -0
  85. package/docs/sn/README.md +455 -0
  86. package/docs/so/README.md +455 -0
  87. package/docs/sq/README.md +455 -0
  88. package/docs/sr/README.md +455 -0
  89. package/docs/st/README.md +455 -0
  90. package/docs/su/README.md +455 -0
  91. package/docs/sv/README.md +455 -0
  92. package/docs/sw/README.md +455 -0
  93. package/docs/ta/README.md +455 -0
  94. package/docs/te/README.md +455 -0
  95. package/docs/tg/README.md +455 -0
  96. package/docs/th/README.md +455 -0
  97. package/docs/tk/README.md +455 -0
  98. package/docs/tl/README.md +455 -0
  99. package/docs/tr/README.md +455 -0
  100. package/docs/tt/README.md +455 -0
  101. package/docs/ug/README.md +455 -0
  102. package/docs/uk/README.md +455 -0
  103. package/docs/ur/README.md +455 -0
  104. package/docs/uz/README.md +455 -0
  105. package/docs/vi/README.md +455 -0
  106. package/docs/xh/README.md +455 -0
  107. package/docs/yi/README.md +455 -0
  108. package/docs/yo/README.md +455 -0
  109. package/docs/zh/README.md +455 -0
  110. package/docs/zu/README.md +455 -0
  111. package/drivers/b2/index.js +24 -6
  112. package/hokey.json +16 -0
  113. package/index.js +7 -2
  114. package/package.json +1 -1
  115. package/test/api.spec.js +12 -9
  116. package/util/redis.js +1 -1
@@ -0,0 +1,455 @@
1
+ Mobiletto
2
+ =========
3
+
4
+ Mobiletto er et JavaScript-lagringsabstraksjonslag, med valgfri transparent kryptering på klientsiden.
5
+
6
+ # Innhold
7
+ * [Hvorfor Mobiletto?](#Why-Mobiletto?)
8
+ * [Hurtigstart](#Hurtigstart)
9
+ * [Mobiletto CLI](#mobiletto-cli)
10
+ * [Kilde](#Kilde)
11
+ * [Grunnleggende bruk](#Grunnleggende bruk)
12
+ * [Metadata](#Metadata)
13
+ * [Alternativ importstil](#Alternate-import-style)
14
+ * [Caching](#Caching)
15
+ * [Speiling](#Speiling)
16
+ * [Transparent kryptering](#Transparent-kryptering)
17
+ * [Nøkkelrotasjon](#Nøkkelrotasjon)
18
+ * [Drivergrensesnitt](#Driver-grensesnitt)
19
+ * [Logging](#Logging)
20
+
21
+ # Les dette på et annet språk
22
+ Dette README.md-dokumentet har blitt oversatt, via [hokeylization](https://github.com/cobbzilla/hokeylization), til
23
+ **[alle språk som støttes av Google Translate](https://cloud.google.com/translate/docs/languages)!**
24
+
25
+ Jeg er sikker på at det ikke er perfekt, men jeg håper det er bedre enn 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 språk ...](../README.md)**
52
+ ----
53
+
54
+ ### Er det et problem med denne oversettelsen av README?
55
+ Denne spesielle oversettelsen av originalen [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
56
+ kan være feil -- *rettelser er svært velkomne!* Send en [pull request på GitHub](https://github.com/cobbzilla/mobiletto/pulls),
57
+ eller hvis du ikke er komfortabel med å gjøre det, [åpne et problem](https://github.com/cobbzilla/mobiletto/issues)
58
+
59
+ Når du oppretter et nytt GitHub-problem om en oversettelse, vennligst gjør:
60
+ * Ta med sidens URL (kopier/lim inn fra nettleserens adresselinje)
61
+ * Ta med den eksakte teksten som er feil (kopier/lim inn fra nettleseren)
62
+ * beskriv hva som er galt -- er oversettelsen feil? er formateringen ødelagt på en eller annen måte?
63
+ * kom gjerne med et forslag til en bedre oversettelse, eller hvordan teksten bør formateres riktig
64
+ * **Takk skal du ha!**
65
+
66
+ ## Hvorfor Mobiletto?
67
+
68
+ ### Farvel leverandørlåsing!
69
+ De ulike skylagringsleverandørene har inkompatible APIer. Selv de som streber etter "S3-kompatibilitet"
70
+ har idiosynkratisk oppførsel.
71
+
72
+ Når du velger en bestemt lagringsleverandør for appen din, hvis du koder direkte til deres API, appen din
73
+ er nå avhengig av den tjenesten. Etter hvert som tiden går og koden akkumuleres, blir det skiftende leverandører
74
+ stadig mer uholdbar. Velkommen til den morsomme verdenen med leverandørlåsing!
75
+
76
+ Mobiletto ble designet for å løse dette problemet. Ved å kode appen din til mobilettos API kan du enkelt
77
+ endre lagringsleverandør og vite at appens lagringslag vil oppføre seg identisk.
78
+
79
+ ### Omfattende testing
80
+ Alle sjåfører testes for identisk oppførsel med 60+ tester for hver sjåfør.
81
+ Vi tester alle sjåfører med hver kombinasjon av:
82
+ * Kryptering: både aktivert og deaktivert
83
+ * Redis cache: både aktivert og deaktivert
84
+
85
+ Denne tilnærmingen gir oss trygghet om at mobiletto vil oppføre seg likt uavhengig av hvilken driver du bruker,
86
+ og uavhengig av om du aktiverer caching og/eller kryptering.
87
+
88
+ ### Driverstøtte
89
+ Gjeldende Mobiletto-lagringsdrivere:
90
+ * `s3` : Amazon S3
91
+ * `b2` : Backblaze B2
92
+ * `local` : lokalt filsystem
93
+
94
+ *Bidrag for å støtte flere leverandører av nettskylagring er svært velkomne!*
95
+
96
+ ## mobiletto-cli
97
+ Mobiletto er ment å brukes som et bibliotek av annen JavaScript-kode.
98
+
99
+ For å jobbe med mobiletto på kommandolinjen, bruk [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
+ ## Kjapp start
106
+ Et kort eksempel ved bruk av mobiletto `s3` driveren.
107
+
108
+ Denne koden ville kjø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
+ ## Grunnleggende bruk
139
+ Et mye mer omfattende eksempel som viser de fleste funksjonene som tilbys:
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 filsystemoppføring.
242
+ På samme måte er returverdien fra kommandoen `list` en rekke metadataobjekter.
243
+
244
+ Et metadataobjekt ser slik ut:
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
+ Egenskapen `type` kan være `file` ' , `dir` , `link` ' eller `special` .
255
+
256
+ Avhengig av typen driver kan det hende at en `list` kommando ikke returnerer alle feltene. Egenskapene `name` og `type` .
257
+ skal alltid være tilstede. En påfølgende `metadata` kommando vil returnere alle tilgjengelige egenskaper.
258
+
259
+ ## Alternativ importstil
260
+ Importer den fullstendige modulen og bruk `connect` -funksjonen:
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
+ ## Buffer
268
+ Mobiletto fungerer best med en <a href="https://redis.io">redis-</a> cache.
269
+
270
+ Mobiletto vil forsøke å koble til en redis-forekomst på 127.0.0.1:6379
271
+
272
+ Du kan overstyre en av disse:
273
+ * Angi `MOBILETTO_REDIS_HOST` env var, mobiletfor å koble til her i stedet for localhost
274
+ * Sett `MOBILETTO_REDIS_PORT` env var, denne porten vil bli brukt
275
+
276
+ Mobiletto vil lagre alle redis-nøkler med prefikset `_mobiletto__` . Du kan endre dette
277
+ ved å sette `MOBILETTO_REDIS_PREFIX` env var.
278
+
279
+ Du kan også angi caching per tilkobling med `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 ha redis caching?
291
+ For å deaktivere: pass `enabled: false` i `opts.redisConfig` objektet når du oppretter forbindelsen.
292
+
293
+ Som diskutert nedenfor, vil deaktivering av caching ha en negativ effekt på ytelsen og medføre flere forespørsler
294
+ til lagring som du virkelig trenger.
295
+
296
+ ### Bufferveiledning
297
+ **Kryptert lagring**: lesing/skriving av kryptert lagring er bare litt tregere enn normalt,
298
+ men å navigere rundt i kataloger (som noen ting gjør) er ganske dyrt. Bruke en redis cache
299
+ vil gi deg et betydelig ytelsesløft.
300
+
301
+ Standardbufferen er trygg, men fungerer ikke bra hvis du har mange skrive-/fjernoperasjoner.
302
+ Enhver skrive- eller fjernoperasjon ugyldiggjør hele hurtigbufferen, og sikrer at påfølgende lesninger vil se
303
+ siste endringer.
304
+
305
+ ### CLI-verktøy
306
+ Hvis du bruker et CLI-verktøy som [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
307
+ du vil definitivt ha redis-cachen aktivert, siden den varer på tvers av påkallinger av `mo` kommandoen.
308
+
309
+ ## Speiling
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
+ `mirror` -kommandoen utfører en engangskopi av alle filer fra en mobiletto til en annen.
318
+ Den kjører ingen prosess for å vedlikeholde speilet over tid. Kjør `mirror` -kommandoen på nytt
319
+ for å synkronisere eventuelle manglende filer.
320
+
321
+ Returverdien fra `mirror` er et enkelt objekt med tellere for hvor mange filer som ble vellykket
322
+ speilet og hvor mange filer som hadde feil:
323
+
324
+ {
325
+ success: count-of-files-mirrored,
326
+ errors: count-of-files-with-errors
327
+ }
328
+
329
+ ADVARSEL: Speiling av store datasett kan være svært tidkrevende og båndbreddekrevende
330
+
331
+ Med `mirror` kan det noen ganger være forvirrende å forstå hvem som er
332
+ leser og hvem som er forfatter. Se for deg det som en oppgaveerklæring: "venstre mobiltto"
333
+ er tingen som er tilordnet (speilet data skrevet), og "høyre mobiltto" (den
334
+ argumentet til `mirror` -metoden) er verdien som tildeles (speilet data leses).
335
+
336
+ ## Transparent kryptering
337
+ Aktiver gjennomsiktig 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
+ Hva skjer? En separat "katalogoppføring" (dirent) katalog (kryptert) sporer hvilke filer som er i den
357
+ katalog (alias den direkte katalogen).
358
+ * Kommandoen `list` leser katalogoppføringsfilene, dekrypterer hver bane som er oppført; returnerer deretter metadata for hver fil
359
+ * `list` kommandoer er mer ineffektive, spesielt for kataloger med et stort antall filer
360
+ * `write` kommandoen skriver dirent-filer i hver forelders dirent-katalog, rekursivt; skriver deretter filen
361
+ * `write` kommandoer vil medføre O(N)-skrivinger, med N = dybde i kataloghierarkiet
362
+ * Kommandoen `remove` fjerner den korresponderende dirent-filen, og dens overordnede hvis tom, rekursivt; fjerner deretter filen
363
+ * Ikke-rekursive `remove` -kommandoer vil medføre O(N)-lesninger og potensielt like mange slettinger, med N = dybde i kataloghierarkiet
364
+ * Rekursive `remove` kommandoer på store og dype filsystemer kan være dyrt
365
+
366
+ Vær oppmerksom på at selv med kryptering på klientsiden aktivert, er en motstander med full synlighet til den krypterte serversiden din
367
+ lagring, selv uten nøkkel, kan fortsatt se det totale antallet kataloger og hvor mange filer som er i hver, og med
368
+ litt innsats, oppdage noe eller hele den generelle strukturen til kataloghierarkiet.
369
+ *Merk: Bruk en relativt flat struktur for bedre sikkerhet.*
370
+ Motstanderen ville ikke vite navnene på katalogene/filene med mindre de også kjente krypteringen din
371
+ nøkkel eller på annen måte hadde knekket krypteringen. Da er alle spill av!
372
+
373
+ ### Ytelse og hurtigbufring
374
+ Operasjoner på kryptert lagring kan være treg. Rekursive oppføringer og fjerninger kan være veldig sakte.
375
+ Bufring via redis hjelper enormt, men merk at hurtigbufferen tømmes ved skriving eller fjerning.
376
+
377
+ ## Nøkkelrotasjon
378
+ Lag en mobiletto med den nye nøkkelen, og spei den gamle dataen inn 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
+ ## Drivergrensesnitt
391
+ En driver er en hvilken som helst JS-fil som eksporterer en 'storageClient'-funksjon med denne signaturen:
392
+
393
+ function storageClient (key, secret, opts)
394
+
395
+ * `key` : en streng, API-nøkkelen din (for den `local` driveren er dette basiskatalogen)
396
+ * `secret` : en streng, API-hemmeligheten din (kan utelates for den `local` driveren)
397
+ * `opts` : et objekt, egenskapene er per driver:
398
+ * For `local` bestemmer egenskapene `fileMode` og `dirMode` hvordan nye opprettende filer og kataloger opprettes
399
+ * For `s3` `bucket` egenskapen "bøtte". Valgfrie egenskaper 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-funksjonen returnerer må definere disse funksjonene:
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
+ ## Hogst
431
+ Mobiletto bruker loggingsbiblioteket [winston](https://www.npmjs.com/package/winston).
432
+
433
+ Logger **vil** inneholde filstier og feilmeldinger, men vil **aldri** inneholde nøkler, hemmeligheter,
434
+ eller annen tilkoblingskonfigurasjonsinformasjon.
435
+
436
+ ### Loggnivå
437
+ Bruk `MOBILETTO_LOG_LEVEL` for å angi loggnivået ved å bruke en
438
+ av `npm` definert i [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
439
+
440
+ Standardnivået er `error` . Det mest omfattende nivået er `silly` , men for øyeblikket mobiletto
441
+ logger ikke på nivåer under `debug`
442
+
443
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
444
+
445
+ ### Loggfil
446
+ Som standard skriver loggeren til konsollen. For å sende logger til en fil, sett `MOBILETTO_LOG_FILE`
447
+ miljøvariabel. Når du logger til en fil, vil logger ikke lenger skrives til konsollen.
448
+
449
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
450
+
451
+ Slik slår du av logging:
452
+
453
+ MOBILETTO_LOG_FILE=/dev/null
454
+
455
+ </pre>