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 on JavaScript-tallennuskerros, jossa on valinnainen läpinäkyvä asiakaspuolen salaus.
5
+
6
+ # Sisältö
7
+ * [Miksi Mobiletto?](#Miksi-Mobiletto?)
8
+ * [Pika-aloitus](#Pika-aloitus)
9
+ * [Mobiletto CLI](#mobiletto-cli)
10
+ * [Lähde](#Source)
11
+ * [Peruskäyttö](#Peruskäyttö)
12
+ * [Metatiedot](#Metadata)
13
+ * [Vaihtoehtoinen tuontityyli](#Alternate-import-style)
14
+ * [Välimuisti](#Caching)
15
+ * [peilaus](#peilaus)
16
+ * [Läpinäkyvä salaus](#Transparent-encryption)
17
+ * [Key-rotation](#Key-rotation)
18
+ * [Driver interface](#Driver-interface)
19
+ * [Kirjaus](#Logging)
20
+
21
+ # Lue tämä toisella kielellä
22
+ Tämä README.md-dokumentti on käännetty [hokeylization]:n (https://github.com/cobbzilla/hokeylization) kautta kielelle
23
+ **[kaikki Google-kääntäjän tukemat kielet](https://cloud.google.com/translate/docs/languages)!**
24
+
25
+ Olen varma, että se ei ole täydellinen, mutta toivon, että se on parempi kuin ei mitään!
26
+
27
+ [🇸🇦 arabia](../ar/README.md)
28
+ [🇧🇩 Bengali](../bn/README.md)
29
+ [🇩🇪 saksaksi](../de/README.md)
30
+ [🇺🇸 englanti](../en/README.md)
31
+ [🇪🇸 espanja](../es/README.md)
32
+ [🇫🇷 ranska](../fr/README.md)
33
+ [🇹🇩 Hausa](../ha/README.md)
34
+ [🇮🇳 Hindi](../hi/README.md)
35
+ [🇮🇩 indonesia](../id/README.md)
36
+ [🇮🇹 italia](../it/README.md)
37
+ [🇯🇵 japani](../ja/README.md)
38
+ [🇰🇷 korea](../ko/README.md)
39
+ [🇮🇳 Maranthi](../mr/README.md)
40
+ [🇵🇱 puola](../pl/README.md)
41
+ [🇧🇷 portugali](../pt/README.md)
42
+ [🇷🇺 venäjä](../ru/README.md)
43
+ [🇰🇪 swahili](../sw/README.md)
44
+ [🇵🇭 Tagalog](../tl/README.md)
45
+ [🇹🇷 turkki](../tr/README.md)
46
+ [🇵🇰 Urdu](../ur/README.md)
47
+ [🇻🇳 vietnam](../vi/README.md)
48
+ [🇨🇳 kiina](../zh/README.md)
49
+
50
+
51
+ **[📚 ... Kaikki kielet ...](../README.md)**
52
+ ----
53
+
54
+ ### Onko tässä README-käännöksessä ongelma?
55
+ Tämä käännös alkuperäisestä [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
56
+ voi olla virheellinen -- *korjaukset ovat erittäin tervetulleita!* Lähetä [pull-pyyntö GitHubissa](https://github.com/cobbzilla/mobiletto/pulls),
57
+ tai jos et halua tehdä niin, [avaa ongelma](https://github.com/cobbzilla/mobiletto/issues)
58
+
59
+ Kun luot uuden GitHub-ongelman käännöksestä, toimi seuraavasti:
60
+ * sisällytä sivun URL-osoite (kopioi/liitä selaimen osoiteriviltä)
61
+ * sisällytä täsmällinen virheellinen teksti (kopioi/liitä selaimesta)
62
+ * kuvaile mikä on vialla -- onko käännös virheellinen? onko muotoilu rikki jotenkin?
63
+ * Ehdota ystävällisesti parempaa käännöstä tai tekstin oikeaa muotoilua
64
+ * **Kiitos!**
65
+
66
+ ## Miksi Mobiletto?
67
+
68
+ ### Hyvästi myyjän lukitus!
69
+ Eri pilvitallennuspalvelujen tarjoajilla on yhteensopimattomia sovellusliittymiä. Jopa ne, jotka tavoittelevat "S3-yhteensopivuutta"
70
+ omaa omituista käyttäytymistä.
71
+
72
+ Kun valitset sovelluksellesi tietyn tallennustilan toimittajan, jos koodaat suoraan heidän sovellusliittymään, sovelluksesi
73
+ on nyt riippuvainen kyseisestä palvelusta. Ajan myötä ja koodia kertyy, vaihtuvia myyjiä tulee
74
+ yhä kestämättömämpi. Tervetuloa myyjän lukituksen hauskaan maailmaan!
75
+
76
+ Mobiletto on suunniteltu ratkaisemaan tämä ongelma. Koodaamalla sovelluksesi mobiletton sovellusliittymään, voit helposti
77
+ vaihda tallennuspalveluntarjoajaa ja tiedä, että sovelluksesi tallennuskerros toimii samalla tavalla.
78
+
79
+ ### Laaja testaus
80
+ Kaikki kuljettajat testataan identtisen käyttäytymisen suhteen yli 60 testillä jokaiselle kuljettajalle.
81
+ Testaamme kaikki ajurit kaikilla seuraavien yhdistelmillä:
82
+ * Salaus: sekä käytössä että poissa käytöstä
83
+ * Redis-välimuisti: sekä käytössä että poissa käytöstä
84
+
85
+ Tämä lähestymistapa antaa meille mielenrauhan, että mobiletto toimii samalla tavalla riippumatta siitä, mitä ajuria käytät,
86
+ ja riippumatta siitä, otatko välimuistin ja/tai salauksen käyttöön.
87
+
88
+ ### Ohjaintuki
89
+ Nykyiset Mobiletto-tallennusohjaimet:
90
+ * `s3` : Amazon S3
91
+ * `b2` : Backblaze B2
92
+ * `local` : paikallinen tiedostojärjestelmä
93
+
94
+ *Otamme mielellämme vastaan lisää pilvitallennuspalvelujen tarjoajia!*
95
+
96
+ ## mobiletto-cli
97
+ Mobiletto on tarkoitettu käytettäväksi muun JavaScript-koodin kirjastona.
98
+
99
+ Jos haluat työskennellä mobiletton kanssa komentorivillä, käytä [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
100
+
101
+ ## Lähde
102
+ * [mobiletto GitHubissa](https://github.com/cobbzilla/mobiletto)
103
+ * [mobiletto on npm](https://www.npmjs.com/package/mobiletto)
104
+
105
+ ## Pika-aloitus
106
+ Lyhyt esimerkki mobiletto `s3` -ohjaimen käytöstä.
107
+
108
+ Tämä koodi toimisi samoin, jos ohjain olisi `b2` tai `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
+ ## Peruskäyttö
139
+ Paljon laajempi esimerkki, jossa näkyy suurin osa tarjotuista ominaisuuksista:
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
+ ## Metatiedot
241
+ `metadata` -komento palauttaa yhden tiedostojärjestelmän merkinnän metatiedot.
242
+ Samoin `list` -komennon palautusarvo on joukko metatieto-objekteja.
243
+
244
+ Metatietoobjekti näyttää tältä:
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
+ Tyyppi-ominaisuus voi olla `type` `file` " , `dir` " , "link `link` tai `special` .
255
+
256
+ Ohjaimen tyypistä riippuen `list` -komento ei välttämättä palauta kaikkia kenttiä. `name` ja "tyyppi `type` .
257
+ tulee aina olla läsnä. Seuraava `metadata` -komento palauttaa kaikki käytettävissä olevat ominaisuudet.
258
+
259
+ ## Vaihtoehtoinen tuontityyli
260
+ Tuo täysin kattava moduuli ja käytä `connect` -toimintoa:
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
+ ## Välimuisti
268
+ Mobiletto toimii parhaiten <a href="https://redis.io">redis-</a> välimuistin kanssa.
269
+
270
+ Mobiletto yrittää muodostaa yhteyden redis-instanssiin osoitteessa 127.0.0.1:6379
271
+
272
+ Voit ohittaa jommankumman seuraavista:
273
+ * Aseta `MOBILETTO_REDIS_HOST` env var, mobile yhdistämään tähän paikallispalvelimen sijaan
274
+ * Aseta `MOBILETTO_REDIS_PORT` env var, tätä porttia käytetään
275
+
276
+ Mobiletto tallentaa kaikki redis-avaimensa etuliitteellä `_mobiletto__` . Voit muuttaa tätä
277
+ asettamalla `MOBILETTO_REDIS_PREFIX` env var.
278
+
279
+ Voit myös määrittää yhteyskohtaisen välimuistin `opts.redisConfig` -objektilla:
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
+ ### Etkö halua tallentaa uudelleen välimuistiin?
291
+ Poistaminen käytöstä `enabled: false` `opts.redisConfig` -objektiin, kun muodostat yhteyden.
292
+
293
+ Kuten alla kerrotaan, välimuistin poistaminen käytöstä vaikuttaa haitallisesti suorituskykyyn ja lisää pyyntöjä
294
+ varastointiin, jota todella tarvitset.
295
+
296
+ ### Välimuistin tallennuksen opas
297
+ **Salattu tallennus**: salatun tallennustilan lukeminen/kirjoittaminen on vain hieman normaalia hitaampaa,
298
+ mutta hakemistoissa liikkuminen (jota jotkut asiat tekevät) on melko kallista. Redis-välimuistin käyttäminen
299
+ antaa sinulle merkittävän suorituskyvyn lisäyksen.
300
+
301
+ Oletusvälimuisti on turvallinen, mutta se ei toimi hyvin, jos sinulla on paljon kirjoitus-/poistotoimintoja.
302
+ Mikä tahansa kirjoitus- tai poistotoiminto mitätöi koko välimuistin, mikä varmistaa, että myöhemmissä lukemissa
303
+ viimeisimmät muutokset.
304
+
305
+ ### CLI-työkalut
306
+ Jos käytät CLI-työkalua, kuten [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
307
+ Redis-välimuistin tulee ehdottomasti olla käytössä, koska se kestää mo-komennon `mo` .
308
+
309
+ ## Peilaus
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` suorittaa kertakopion kaikista tiedostoista mobiililaitteesta toiseen.
318
+ Se ei suorita mitään prosessia peilin ylläpitämiseksi ajan mittaan. Suorita `mirror` uudelleen
319
+ synkronoidaksesi puuttuvat tiedostot.
320
+
321
+ `mirror` on yksinkertainen objekti, jossa on laskurit siitä, kuinka monta tiedostoa onnistui
322
+ peilattu ja kuinka monessa tiedostossa oli virheitä:
323
+
324
+ {
325
+ success: count-of-files-mirrored,
326
+ errors: count-of-files-with-errors
327
+ }
328
+
329
+ VAROITUS: Suurten tietojoukkojen peilaus voi olla hyvin aikaa vievää ja kaistanleveyttä vaativaa
330
+
331
+ `mirror` semantiikan avulla voi joskus olla hämmentävää ymmärtää, kuka on
332
+ lukija ja kuka on kirjoittaja. Kuvittele se tehtävälausekkeena: "vasen kännykkä"
333
+ on kohde, jolle osoitetaan (kirjoitettu peilattu data) ja "oikea kännykkä" (
334
+ argumentti `mirror` -menetelmälle) on arvo, jota annetaan (peilattua dataa luetaan).
335
+
336
+ ## Läpinäkyvä salaus
337
+ Ota läpinäkyvä asiakaspuolen salaus käyttöön:
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
+ Mitä tapahtuu? Erillinen "hakemistomerkintä" (dirent) hakemisto (salattu) seuraa, mitä tiedostoja siinä on
357
+ hakemisto (alias dirent hakemisto).
358
+ * `list` -komento lukee hakemiston syöttötiedostot, purkaa jokaisen luettelossa olevan polun; palauttaa sitten kunkin tiedoston metatiedot
359
+ * `list` -komennot ovat tehottomia, varsinkin hakemistoissa, joissa on paljon tiedostoja
360
+ * `write` komento kirjoittaa eri tiedostot kunkin vanhemman dirent-hakemistoon rekursiivisesti; sitten kirjoittaa tiedoston
361
+ * `write` komennot aiheuttavat O(N) kirjoitusta, jolloin N = syvyys hakemistohierarkiassa
362
+ * `remove` -komento poistaa vastaavan dirent-tiedoston ja sen ylätason, jos se on tyhjä, rekursiivisesti; poistaa sitten tiedoston
363
+ * Ei-rekursiiviset `remove` -komennot vaativat O(N) lukua ja mahdollisesti yhtä monta poistoa, jolloin N = syvyys hakemistohierarkiassa
364
+ * Rekursiiviset `remove` " suurissa ja syvällisissä tiedostojärjestelmissä voivat olla kalliita
365
+
366
+ Huomaa, että vaikka asiakaspuolen salaus olisi käytössä, vastustaja, jolla on täysi näkyvyys salatulle palvelinpuolelle
367
+ tallennustila, jopa ilman avainta, voi silti nähdä hakemistojen kokonaismäärän ja kuinka monta tiedostoa kussakin on
368
+ jonkin verran vaivaa, löytää hakemistohierarkian yleinen rakenne tai osa siitä.
369
+ *Huomaa: Käytä suhteellisen tasaista rakennetta parantaaksesi turvallisuutta.*
370
+ Vastustaja ei tietäisi hakemistojen/tiedostojen nimiä ellei he tietäisi myös salaustasi
371
+ avaimella tai oli muuten onnistuneesti murtanut salauksen. Silloin kaikki vedot ovat poissa!
372
+
373
+ ### Suorituskyky ja välimuisti
374
+ Salatun tallennustilan toiminta voi olla hidasta. Rekursiiviset listaukset ja poistot voivat olla hyvin hidasta.
375
+ Välimuistin tallentaminen rediksen kautta auttaa valtavasti, mutta huomaa, että välimuisti tyhjennetään kirjoittamisen tai poistamisen yhteydessä.
376
+
377
+ ## Avaimen kierto
378
+ Luo matkapuhelin uudella avaimellasi ja peilaa sitten vanhat tiedot siihen:
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
+ ## Ohjaimen käyttöliittymä
391
+ Ohjain on mikä tahansa JS-tiedosto, joka vie "storageClient"-funktion tällä allekirjoituksella:
392
+
393
+ function storageClient (key, secret, opts)
394
+
395
+ * `key` : merkkijono, API-avain (paikalliselle ohjaimelle tämä on `local` )
396
+ * `secret` : merkkijono, API-salaisuus (voidaan jättää pois `local` ohjaimesta)
397
+ * `opts` : objekti, jonka ominaisuudet ovat kuljettajakohtaisia:
398
+ * `local` `fileMode` ja `dirMode` määrittävät kuinka uudet luontitiedostot ja hakemistot luodaan
399
+ * `s3` `bucket` vaaditaan "bucket"-ominaisuus. Valinnaiset ominaisuudet ovat:
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
+ Objektin, jonka storageClient-funktio palauttaa, on määritettävä seuraavat funktiot:
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
+ ## Kirjaaminen
431
+ Mobiletto käyttää [winston](https://www.npmjs.com/package/winston) lokikirjastoa.
432
+
433
+ Lokit **sisältävät** tiedostopolut ja virheilmoitukset, mutta **eivät koskaan** sisällä avaimia, salaisuuksia,
434
+ tai muita yhteyden määritystietoja.
435
+
436
+ ### Lokin taso
437
+ Käytä `MOBILETTO_LOG_LEVEL` ympäristömuuttujaa lokitason asettamiseen käyttämällä yhtä
438
+ `npm` tasoista, jotka on määritelty osoitteessa [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
439
+
440
+ Oletustaso on `error` . Monisanaisin taso on `silly` , vaikkakin tällä hetkellä mobiletto
441
+ ei kirjaudu `debug` alapuolelle
442
+
443
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
444
+
445
+ ### Loki tiedosto
446
+ Oletusarvoisesti loggeri kirjoittaa konsoliin. Jos haluat lähettää lokit tiedostoon, aseta `MOBILETTO_LOG_FILE`
447
+ ympäristömuuttuja. Kun kirjaudut tiedostoon, lokeja ei enää kirjoiteta konsoliin.
448
+
449
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
450
+
451
+ Lokikirjauksen poistaminen käytöstä:
452
+
453
+ MOBILETTO_LOG_FILE=/dev/null
454
+
455
+ </pre>