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-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
+ * [Installasjon](#Installasjon)
12
+ * [Support and Funding](#Support-and-Funding)
13
+ * [Grunnleggende bruk](#Grunnleggende bruk)
14
+ * [Metadata](#Metadata)
15
+ * [Alternativ importstil](#Alternate-import-style)
16
+ * [Caching](#Caching)
17
+ * [Speiling](#Speiling)
18
+ * [Transparent kryptering](#Transparent-kryptering)
19
+ * [Nøkkelrotasjon](#Nøkkelrotasjon)
20
+ * [Drivergrensesnitt](#Driver-grensesnitt)
21
+ * [Logging](#Logging)
22
+
23
+ # Les dette på et annet språk
24
+ Dette README.md-dokumentet har blitt oversatt, via [hokeylization](https://github.com/cobbzilla/hokeylization), til
25
+ **[alle språk som støttes av Google Translate](https://cloud.google.com/translate/docs/languages)!**
26
+
27
+ Jeg er sikker på at det ikke er perfekt, men jeg håper det er bedre enn 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 språk ...](../README.md)**
54
+ ----
55
+
56
+ ### Er det et problem med denne oversettelsen av README?
57
+ Denne spesielle oversettelsen av originalen [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
58
+ kan være feil -- *rettelser er svært velkomne!* Send en [pull request på GitHub](https://github.com/cobbzilla/mobiletto/pulls),
59
+ eller hvis du ikke er komfortabel med å gjøre det, [åpne et problem](https://github.com/cobbzilla/mobiletto/issues)
60
+
61
+ Når du oppretter et nytt GitHub-problem om en oversettelse, vennligst gjør:
62
+ * Ta med sidens URL (kopier/lim inn fra nettleserens adresselinje)
63
+ * Ta med den eksakte teksten som er feil (kopier/lim inn fra nettleseren)
64
+ * beskriv hva som er galt -- er oversettelsen feil? er formateringen ødelagt på en eller annen måte?
65
+ * kom gjerne med et forslag til en bedre oversettelse, eller hvordan teksten bør formateres riktig
66
+ * **Takk skal du ha!**
67
+
68
+ ## Hvorfor Mobiletto?
69
+
70
+ ### Farvel leverandørlåsing!
71
+ De ulike skylagringsleverandørene har inkompatible APIer. Selv de som streber etter "S3-kompatibilitet"
72
+ har idiosynkratisk oppførsel.
73
+
74
+ Når du velger en bestemt lagringsleverandør for appen din, hvis du koder direkte til deres API, appen din
75
+ er nå avhengig av den tjenesten. Etter hvert som tiden går og koden akkumuleres, blir det skiftende leverandører
76
+ stadig mer uholdbar. Velkommen til den morsomme verdenen med leverandørlåsing!
77
+
78
+ Mobiletto ble designet for å løse dette problemet. Ved å kode appen din til mobilettos API kan du enkelt
79
+ endre lagringsleverandør og vite at appens lagringslag vil oppføre seg identisk.
80
+
81
+ ### Omfattende testing
82
+ Alle sjåfører testes for identisk oppførsel med 60+ tester for hver sjåfør.
83
+ Vi tester alle sjåfører med hver kombinasjon av:
84
+ * Kryptering: både aktivert og deaktivert
85
+ * Redis cache: både aktivert og deaktivert
86
+
87
+ Denne tilnærmingen gir oss trygghet om at mobiletto vil oppføre seg likt uavhengig av hvilken driver du bruker,
88
+ og uavhengig av om du aktiverer caching og/eller kryptering.
89
+
90
+ ### Driverstøtte
91
+ Gjeldende Mobiletto-lagringsdrivere:
92
+ * `s3` : Amazon S3
93
+ * `b2` : Backblaze B2
94
+ * `local` : lokalt filsystem
95
+
96
+ *Bidrag for å støtte flere leverandører av nettskylagring er svært velkomne!*
97
+
98
+ ## mobiletto-cli
99
+ Mobiletto er ment å brukes som et bibliotek av annen JavaScript-kode.
100
+
101
+ For å jobbe med mobiletto på kommandolinjen, bruk [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 prøver å være en profesjonell programvareutvikler med åpen kildekode. Jeg har jobbet i
109
+ programvareindustrien i mange år, har jeg startet suksessfulle selskaper og solgt dem til offentlige selskaper.
110
+ Nylig mistet jeg jobben min, og jeg har egentlig ikke noe annet arbeid på rad
111
+
112
+ Så jeg skal prøve å skrive nyttig programvare og se om det fungerer
113
+
114
+ Hvis du liker å bruke denne programvaren, vil jeg være veldig takknemlig for selv
115
+ minste [månedlig bidrag via Patreon](https://www.patreon.com/cobbzilla)
116
+
117
+ *Takk skal du ha!*
118
+
119
+ ## Installasjon
120
+ Installer med `npm` eller `yarn` . Du vil sannsynligvis ha `lite` versjonen som ikke inkluderer alle
121
+ oversatte README-filer:
122
+
123
+ npm install mobiletto-lite
124
+ yarn add mobiletto-lite
125
+
126
+ Hvis du virkelig vil ha README-filene på alle språk, installer fullversjonen:
127
+
128
+ npm install mobiletto
129
+ yarn add mobiletto
130
+
131
+ ## Kjapp start
132
+ Et kort eksempel ved bruk av mobiletto `s3` driveren.
133
+
134
+ Denne koden ville kjø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
+ ## Grunnleggende bruk
165
+ Et mye mer omfattende eksempel som viser de fleste funksjonene som tilbys:
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 filsystemoppføring.
268
+ På samme måte er returverdien fra kommandoen `list` en rekke metadataobjekter.
269
+
270
+ Et metadataobjekt ser slik ut:
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
+ Egenskapen `type` kan være `file` ' , `dir` , `link` ' eller `special` .
281
+
282
+ Avhengig av typen driver kan det hende at en `list` kommando ikke returnerer alle feltene. Egenskapene `name` og `type` .
283
+ skal alltid være tilstede. En påfølgende `metadata` kommando vil returnere alle tilgjengelige egenskaper.
284
+
285
+ ## Alternativ importstil
286
+ Importer den fullstendige modulen og bruk `connect` -funksjonen:
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
+ ## Buffer
294
+ Mobiletto fungerer best med en <a href="https://redis.io">redis-</a> cache.
295
+
296
+ Mobiletto vil forsøke å koble til en redis-forekomst på 127.0.0.1:6379
297
+
298
+ Du kan overstyre en av disse:
299
+ * Angi `MOBILETTO_REDIS_HOST` env var, mobiletfor å koble til her i stedet for localhost
300
+ * Sett `MOBILETTO_REDIS_PORT` env var, denne porten vil bli brukt
301
+
302
+ Mobiletto vil lagre alle redis-nøkler med prefikset `_mobiletto__` . Du kan endre dette
303
+ ved å sette `MOBILETTO_REDIS_PREFIX` env var.
304
+
305
+ Du kan også angi caching per tilkobling med `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 ha redis caching?
317
+ For å deaktivere: pass `enabled: false` i `opts.redisConfig` objektet når du oppretter forbindelsen.
318
+
319
+ Som diskutert nedenfor, vil deaktivering av caching ha en negativ effekt på ytelsen og medføre flere forespørsler
320
+ til lagring som du virkelig trenger.
321
+
322
+ ### Bufferveiledning
323
+ **Kryptert lagring**: lesing/skriving av kryptert lagring er bare litt tregere enn normalt,
324
+ men å navigere rundt i kataloger (som noen ting gjør) er ganske dyrt. Bruke en redis cache
325
+ vil gi deg et betydelig ytelsesløft.
326
+
327
+ Standardbufferen er trygg, men fungerer ikke bra hvis du har mange skrive-/fjernoperasjoner.
328
+ Enhver skrive- eller fjernoperasjon ugyldiggjør hele hurtigbufferen, og sikrer at påfølgende lesninger vil se
329
+ siste endringer.
330
+
331
+ ### CLI-verktøy
332
+ Hvis du bruker et CLI-verktøy som [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
333
+ du vil definitivt ha redis-cachen aktivert, siden den varer på tvers av påkallinger av `mo` kommandoen.
334
+
335
+ ## Speiling
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
+ `mirror` -kommandoen utfører en engangskopi av alle filer fra en mobiletto til en annen.
344
+ Den kjører ingen prosess for å vedlikeholde speilet over tid. Kjør `mirror` -kommandoen på nytt
345
+ for å synkronisere eventuelle manglende filer.
346
+
347
+ Returverdien fra `mirror` er et enkelt objekt med tellere for hvor mange filer som ble vellykket
348
+ speilet og hvor mange filer som hadde feil:
349
+
350
+ {
351
+ success: count-of-files-mirrored,
352
+ errors: count-of-files-with-errors
353
+ }
354
+
355
+ ADVARSEL: Speiling av store datasett kan være svært tidkrevende og båndbreddekrevende
356
+
357
+ Med `mirror` kan det noen ganger være forvirrende å forstå hvem som er
358
+ leser og hvem som er forfatter. Se for deg det som en oppgaveerklæring: "venstre mobiltto"
359
+ er tingen som er tilordnet (speilet data skrevet), og "høyre mobiltto" (den
360
+ argumentet til `mirror` -metoden) er verdien som tildeles (speilet data leses).
361
+
362
+ ## Transparent kryptering
363
+ Aktiver gjennomsiktig 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
+ Hva skjer? En separat "katalogoppføring" (dirent) katalog (kryptert) sporer hvilke filer som er i den
383
+ katalog (alias den direkte katalogen).
384
+ * Kommandoen `list` leser katalogoppføringsfilene, dekrypterer hver bane som er oppført; returnerer deretter metadata for hver fil
385
+ * `list` kommandoer er mer ineffektive, spesielt for kataloger med et stort antall filer
386
+ * `write` kommandoen skriver dirent-filer i hver forelders dirent-katalog, rekursivt; skriver deretter filen
387
+ * `write` kommandoer vil medføre O(N)-skrivinger, med N = dybde i kataloghierarkiet
388
+ * Kommandoen `remove` fjerner den korresponderende dirent-filen, og dens overordnede hvis tom, rekursivt; fjerner deretter filen
389
+ * Ikke-rekursive `remove` -kommandoer vil medføre O(N)-lesninger og potensielt like mange slettinger, med N = dybde i kataloghierarkiet
390
+ * Rekursive `remove` kommandoer på store og dype filsystemer kan være dyrt
391
+
392
+ Vær oppmerksom på at selv med kryptering på klientsiden aktivert, er en motstander med full synlighet til den krypterte serversiden din
393
+ lagring, selv uten nøkkel, kan fortsatt se det totale antallet kataloger og hvor mange filer som er i hver, og med
394
+ litt innsats, oppdage noe eller hele den generelle strukturen til kataloghierarkiet.
395
+ *Merk: Bruk en relativt flat struktur for bedre sikkerhet.*
396
+ Motstanderen ville ikke vite navnene på katalogene/filene med mindre de også kjente krypteringen din
397
+ nøkkel eller på annen måte hadde knekket krypteringen. Da er alle spill av!
398
+
399
+ ### Ytelse og hurtigbufring
400
+ Operasjoner på kryptert lagring kan være treg. Rekursive oppføringer og fjerninger kan være veldig sakte.
401
+ Bufring via redis hjelper enormt, men merk at hurtigbufferen tømmes ved skriving eller fjerning.
402
+
403
+ ## Nøkkelrotasjon
404
+ Lag en mobiletto med den nye nøkkelen, og spei den gamle dataen inn 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
+ ## Drivergrensesnitt
417
+ En driver er en hvilken som helst JS-fil som eksporterer en 'storageClient'-funksjon med denne signaturen:
418
+
419
+ function storageClient (key, secret, opts)
420
+
421
+ * `key` : en streng, API-nøkkelen din (for den `local` driveren er dette basiskatalogen)
422
+ * `secret` : en streng, API-hemmeligheten din (kan utelates for den `local` driveren)
423
+ * `opts` : et objekt, egenskapene er per driver:
424
+ * For `local` bestemmer egenskapene `fileMode` og `dirMode` hvordan nye opprettende filer og kataloger opprettes
425
+ * For `s3` `bucket` egenskapen "bøtte". Valgfrie egenskaper 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-funksjonen returnerer må definere disse funksjonene:
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
+ ## Hogst
457
+ Mobiletto bruker loggingsbiblioteket [winston](https://www.npmjs.com/package/winston).
458
+
459
+ Logger **vil** inneholde filstier og feilmeldinger, men vil **aldri** inneholde nøkler, hemmeligheter,
460
+ eller annen tilkoblingskonfigurasjonsinformasjon.
461
+
462
+ ### Loggnivå
463
+ Bruk `MOBILETTO_LOG_LEVEL` for å angi loggnivået ved å bruke en
464
+ av `npm` definert i [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
465
+
466
+ Standardnivået er `error` . Det mest omfattende nivået er `silly` , men for øyeblikket mobiletto
467
+ logger ikke på nivåer under `debug`
468
+
469
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
470
+
471
+ ### Loggfil
472
+ Som standard skriver loggeren til konsollen. For å sende logger til en fil, sett `MOBILETTO_LOG_FILE`
473
+ miljøvariabel. Når du logger til en fil, vil logger ikke lenger skrives til konsollen.
474
+
475
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
476
+
477
+ Slik slår du av logging:
478
+
479
+ MOBILETTO_LOG_FILE=/dev/null
480
+
481
+ </pre>