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 estas JavaScript-stoka abstrakta tavolo, kun laŭvola travidebla klientflanka ĉifrado.
5
+
6
+ # Enhavo
7
+ * [Kial Mobiletto?](#Kial-Mobiletto?)
8
+ * [Rapida komenco](#Rapida komenco)
9
+ * [Mobiletto CLI](#mobiletto-cli)
10
+ * [Fonto](#Fonto)
11
+ * [Baza uzado](#Baza uzado)
12
+ * [Metadatumoj](#Metadatumoj)
13
+ * [Alterna importa stilo](#Alternate-import-stilo)
14
+ * [Kaŝmemoro](#Kaŝmemoro)
15
+ * [Spegulado](#Spegulado)
16
+ * [Travidebla ĉifrado](#Travidebla-ĉifrado)
17
+ * [Ŝlosilrotacio](#Ŝlosilo-rotacio)
18
+ * [ŝofora interfaco](#Driver-interfaco)
19
+ * [Logging](#Logging)
20
+
21
+ # Legu ĉi tion en alia lingvo
22
+ Ĉi tiu dokumento README.md estis tradukita, per [hokeylization](https://github.com/cobbzilla/hokeylization), en
23
+ **[ĉiu lingvo subtenata de Google Translate](https://cloud.google.com/translate/docs/languages)!**
24
+
25
+ Mi certas, ke ĝi ne estas perfekta, sed mi esperas, ke ĝi estas pli bona ol nenio!
26
+
27
+ [🇸🇦 araba](../ar/README.md)
28
+ [🇧🇩 bengala](../bn/README.md)
29
+ [🇩🇪 germana](../de/README.md)
30
+ [🇺🇸 angla](../eo/README.md)
31
+ [🇪🇸 Hispana](../es/README.md)
32
+ [🇫🇷 Franca](../fr/README.md)
33
+ [🇹🇩 Hausa](../ha/README.md)
34
+ [🇮🇳 Hindia](../hi/README.md)
35
+ [🇮🇩 indonezia](../id/README.md)
36
+ [🇮🇹 itala](../it/README.md)
37
+ [🇯🇵 japana](../ja/README.md)
38
+ [🇰🇷 Korea](../ko/README.md)
39
+ [🇮🇳 Maranthi](../mr/README.md)
40
+ [🇵🇱 Pola](../pl/README.md)
41
+ [🇧🇷 portugala](../pt/README.md)
42
+ [🇷🇺 Rusa](../ru/README.md)
43
+ [🇰🇪 Svahila](../sw/README.md)
44
+ [🇵🇭 Tagaloga](../tl/README.md)
45
+ [🇹🇷 Turka](../tr/README.md)
46
+ [🇵🇰 Urdua](../ur/README.md)
47
+ [🇻🇳 vjetnama](../vi/README.md)
48
+ [🇨🇳 Ĉina](../zh/README.md)
49
+
50
+
51
+ **[📚 ... Ĉiuj lingvoj ...](../README.md)**
52
+ ----
53
+
54
+ ### Ĉu estas problemo kun ĉi tiu traduko de la README?
55
+ Ĉi tiu aparta traduko de la originalo [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
56
+ povas esti misa -- *korektoj estas tre bonvenaj!* Bonvolu sendi [tiropeton sur GitHub](https://github.com/cobbzilla/mobiletto/pulls),
57
+ aŭ se vi ne komfortas fari tion, [malfermu temon](https://github.com/cobbzilla/mobiletto/issues)
58
+
59
+ Kiam vi kreas novan GitHub-an numeron pri traduko, bonvolu fari:
60
+ * inkluzivu la paĝon URL (kopiu/gluu el retumila adresbreto)
61
+ * inkluzivu la ĝustan tekston malĝustan (kopiu/gluu el retumilo)
62
+ * bonvolu priskribi kio estas malĝusta -- ĉu la traduko estas malĝusta? ĉu la formatado estas rompita iel?
63
+ * bonvolu proponi sugeston pri pli bona traduko, aŭ kiel la teksto estu taŭge formatita
64
+ * **Dankon!**
65
+
66
+ ## Kial Mobiletto?
67
+
68
+ ### Adiaŭ enŝlosado de vendisto!
69
+ La diversaj provizantoj de nuba stokado havas malkongruajn API-ojn. Eĉ tiuj, kiuj strebas al "S3-kongruo"
70
+ havas idiosinkraziajn kondutojn.
71
+
72
+ Kiam vi elektas apartan stokan vendiston por via programo, se vi kodas rekte al ilia API, via programo
73
+ nun dependas de tiu servo. Dum tempo pasas kaj kodo akumuliĝas, ŝanĝiĝas vendistoj
74
+ ĉiam pli netenebla. Bonvenon al la amuza mondo de vendoŝlosado!
75
+
76
+ Mobiletto estis dizajnita por solvi ĉi tiun problemon. Kodigante vian apon al la API de mobiletto, vi povas facile
77
+ ŝanĝu provizantojn de stokado kaj sciu, ke la stokatavolo de via programo kondutos idente.
78
+
79
+ ### Ampleksa testado
80
+ Ĉiuj ŝoforoj estas testitaj pri identa konduto kun 60+ testoj por ĉiu ŝoforo.
81
+ Ni testas ĉiujn ŝoforojn kun ĉiu kombinaĵo de:
82
+ * Ĉifrado: kaj ebligita kaj malŝaltita
83
+ * Redis kaŝmemoro: ambaŭ ebligita kaj malŝaltita
84
+
85
+ Ĉi tiu aliro donas al ni trankvilon, ke mobiletto kondutos same sendepende de kiu ŝoforo vi uzas,
86
+ kaj sendepende de ĉu vi ebligas kaŝmemoron kaj/aŭ ĉifradon.
87
+
88
+ ### Ŝoforsubteno
89
+ Nunaj Mobiletto-stokaj ŝoforoj:
90
+ * `s3` : Amazon S3
91
+ * `b2` : Malantaŭbrilo B2
92
+ * `local` : loka dosiersistemo
93
+
94
+ *Kontribuoj por subteni pli da nuba stokado provizantoj estas tre bonvenaj!*
95
+
96
+ ## mobiletto-cli
97
+ Mobiletto estas celita esti uzata kiel biblioteko per alia JavaScript-kodo.
98
+
99
+ Por labori kun mobiletto ĉe la komandlinio, uzu [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
100
+
101
+ ## Fonto
102
+ * [mobiletto sur GitHub](https://github.com/cobbzilla/mobiletto)
103
+ * [mobiletto sur npm](https://www.npmjs.com/package/mobiletto)
104
+
105
+ ## Rapida Komenco
106
+ Mallonga ekzemplo uzante la ŝoforon mobiletto `s3` .
107
+
108
+ Ĉi tiu kodo rulus same se la ŝoforo estus `b2` aŭ `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
+ ## Baza uzado
139
+ Multe pli ampleksa ekzemplo, montranta la plej multajn el la ofertitaj funkcioj:
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
+ ## Metadatumoj
241
+ La komando `metadata` resendas metadatenojn pri ununura dosiersistem-eniro.
242
+ Same, la revenvaloro de la komando `list` estas tabelo de metadatumaj objektoj.
243
+
244
+ Metadatuma objekto aspektas jene:
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
+ La `type` posedaĵo povas esti `file` , `dir` , `link` , aŭ `special` .
255
+
256
+ Depende de la tipo de ŝoforo, komando `list` eble ne resendas ĉiujn kampojn. La `name` kaj `type`
257
+ devus ĉiam ĉeesti. Posta `metadata` komando resendos ĉiujn disponeblajn ecojn.
258
+
259
+ ## Alterna importa stilo
260
+ Importu la plene-skopitan modulon kaj uzu la funkcion `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
+ ## Kaŝmemoro
268
+ Mobiletto funkcias plej bone kun <a href="https://redis.io">redis-</a> kaŝmemoro.
269
+
270
+ Mobiletto provos konektiĝi al redis-instanco sur 127.0.0.1:6379
271
+
272
+ Vi povas anstataŭi iun el ĉi tiuj:
273
+ * Agordu la env var `MOBILETTO_REDIS_HOST` , mobilepor konekti ĉi tie anstataŭ lokagastiganto
274
+ * Agordu la env `MOBILETTO_REDIS_PORT` , ĉi tiu pordo estos uzata
275
+
276
+ Mobiletto stokos ĉiujn ĝiajn redis-ŝlosilojn kun la prefikso `_mobiletto__` . Vi povas ŝanĝi ĉi tion
277
+ per agordo de la `MOBILETTO_REDIS_PREFIX` var.
278
+
279
+ Vi ankaŭ povas agordi pokonektan kaŝmemoron per la objekto `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
+ ### Ne volas redis-kaŝmemoron?
291
+ Por malŝalti: pasu `enabled: false` en via `opts.redisConfig` objekto kiam vi establas vian konekton.
292
+
293
+ Kiel diskutite malsupre, malŝalti kaŝmemoron havos malfavoran efikon al rendimento kaj ricevos pli da petoj
294
+ al stokado, kiun vi vere bezonas.
295
+
296
+ ### Gvidlibro pri kaŝmemoro
297
+ **Ĉifrita stokado**: legado/skribado de ĉifrita stokado estas nur iom pli malrapida ol normale,
298
+ sed navigi tra dosierujoj (kion faras iuj aferoj) estas sufiĉe multekosta. Uzante redis-kaŝmemoron
299
+ donos al vi signifan rendimentan akcelon.
300
+
301
+ La defaŭlta kaŝmemoro estas sekura, sed ne funkcias bone se vi havas multajn skribi/forigi operaciojn.
302
+ Ajna operacio de skribo aŭ forigo malvalidigas la tutan kaŝmemoron, certigante ke postaj legoj vidos la
303
+ lastaj ŝanĝoj.
304
+
305
+ ### CLI-iloj
306
+ Se vi uzas CLI-ilon kiel [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
307
+ vi certe volos la redis-kaŝmemoron ebligita, ĉar ĝi daŭras tra alvokoj de la komando `mo` .
308
+
309
+ ## Spegulado
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
+ La komando `mirror` faras unufojan kopion de ĉiuj dosieroj de unu mobiletto al alia.
318
+ Ĝi ne funkciigas ajnan procezon por konservi la spegulon laŭlonge de la tempo. Rulu la komandon `mirror` denove
319
+ por sinkronigi ajnajn mankantajn dosierojn.
320
+
321
+ La revena valoro de `mirror` estas simpla objekto kun nombriloj por kiom da dosieroj estis sukcese
322
+ spegulita kaj kiom da dosieroj havis erarojn:
323
+
324
+ {
325
+ success: count-of-files-mirrored,
326
+ errors: count-of-files-with-errors
327
+ }
328
+
329
+ AVERTO: Speguli grandajn datumajn arojn povas esti tre temporaba kaj bendolarĝo-intensa
330
+
331
+ Kun la `mirror` voka semantiko foje povas esti konfuze kompreni kiu estas la
332
+ leganto kaj kiu estas la verkisto. Imagu ĝin kiel asigno deklaro: la "maldekstra mano mobiletto"
333
+ estas la aĵo asignita al (spegulaj datumoj skribitaj), kaj la "dekstra mano" (la
334
+ argumento al la metodo `mirror` ) estas la valoro asignita (spegulita datumo estas legata).
335
+
336
+ ## Travidebla ĉifrado
337
+ Ebligu travideblan klientflankan ĉifradon:
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
+ Kio okazas? Aparta "dosierujo eniro" (direkta) dosierujo (ĉifrita) spuras kiajn dosierojn estas en tio
357
+ dosierujo (alinome la dosierujo dirent).
358
+ * La komando `list` legas la dosierujojn enirdosierojn, malĉifras ĉiun listigitan vojon; tiam resendas metadatenojn por ĉiu dosiero
359
+ * `list` komandoj estas pli malefikaj, precipe por dosierujoj kun granda nombro da dosieroj
360
+ * La komando `write` skribas dirent-dosierojn en la dosierujo de ĉiu gepatro, rekursie; poste skribas la dosieron
361
+ * `write` komandoj provos O(N) skribojn, kun N = profundo en la dosierujo-hierarkio
362
+ * La komando `remove` forigas la respondan dirent-dosieron, kaj ĝian gepatron se malplena, rekursie; tiam forigas la dosieron
363
+ * Ne- `remove` komandoj ricevos O(N) legadojn kaj eble tiom da forigoj, kun N = profundo en la dosierujo-hierarkio
364
+ * Rekursivaj `remove` komandoj sur grandaj kaj profundaj dosiersistemoj povas esti multekostaj
365
+
366
+ Notu, ke eĉ kun klientflanka ĉifrado ebligita, kontraŭulo kun plena videbleco en vian ĉifritan servilflankon
367
+ stokado, eĉ sen la ŝlosilo, ankoraŭ povas vidi la totalan nombron da dosierujoj kaj kiom da dosieroj estas en ĉiu, kaj kun
368
+ iom da peno, malkovru iujn aŭ ĉion el la ĝenerala strukturo de la dosierujo-hierarkio.
369
+ *Noto: Uzu relative platan strukturon por pli bona sekureco.*
370
+ La kontraŭulo ne scius la nomojn de la dosierujoj/dosieroj krom se ili ankaŭ scius vian ĉifradon
371
+ ŝlosilo aŭ alie sukcese fendis la ĉifradon. Ĉiuj vetoj estas forigitaj tiam!
372
+
373
+ ### Rendimento kaj kaŝmemoro
374
+ Operacioj pri ĉifrita stokado povas esti malrapidaj. Rekursivaj listoj kaj forigoj povas esti tre malrapidaj.
375
+ Kaŝmemoro per redis helpas ege, sed notu, ke la kaŝmemoro estas purigita post iuj skriboj aŭ forigoj.
376
+
377
+ ## Ŝlosila rotacio
378
+ Kreu mobiletto per via nova ŝlosilo, tiam spegulu la malnovajn datumojn en ĝi:
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
+ ## Ŝoforinterfaco
391
+ Ŝoforo estas ajna JS-dosiero, kiu eksportas funkcion 'storageClient' kun ĉi tiu subskribo:
392
+
393
+ function storageClient (key, secret, opts)
394
+
395
+ * `key` : ĉeno, via API-ŝlosilo (por la `local` ŝoforo ĉi tio estas la baza dosierujo)
396
+ * `secret` : ĉeno, via API-sekreto (povas esti preterlasita por la `local` ŝoforo)
397
+ * `opts` : objekto, la propraĵoj estas po-ŝoforoj:
398
+ * Por `local` , la `fileMode` kaj `dirMode` determinas kiel novaj kreaj dosieroj kaj dosierujoj estas kreitaj
399
+ * Por `s3` , la posedaĵo `bucket` estas bezonata. Laŭvolaj propraĵoj estas:
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
+ La objekto, kiun resendas la funkcio storageClient, devas difini ĉi tiujn funkciojn:
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
+ ## Registrado
431
+ Mobiletto uzas la [winston](https://www.npmjs.com/package/winston) registran bibliotekon.
432
+
433
+ Registroj **enhavos dosiervojojn kaj erarmesaĝojn, sed **neniam** enhavos ŝlosilojn, sekretojn,
434
+ aŭ ajna alia koneksa agorda informo.
435
+
436
+ ### Lognivelo
437
+ Uzu la `MOBILETTO_LOG_LEVEL` por agordi la protokolnivelon, uzante unu
438
+ de la `npm` niveloj difinitaj en [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
439
+
440
+ La defaŭlta nivelo estas `error` . La plej vorta nivelo estas `silly` , kvankam nuntempe mobiletto
441
+ ne ensalutas je niveloj sub `debug`
442
+
443
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
444
+
445
+ ### Logdosiero
446
+ Defaŭlte, la registrilo skribas al la konzolo. Por sendi protokolojn al dosiero, agordu la `MOBILETTO_LOG_FILE`
447
+ mediovariablo. Dum ensalutado al dosiero, protokoloj ne plu estos skribitaj al la konzolo.
448
+
449
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
450
+
451
+ Por malŝalti registradon:
452
+
453
+ MOBILETTO_LOG_FILE=/dev/null
454
+
455
+ </pre>