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
+ Мабілета
2
+ =========
3
+
4
+ Mobiletto - гэта ўзровень абстракцыі сховішча JavaScript з дадатковым празрыстым шыфраваннем на баку кліента.
5
+
6
+ # Змест
7
+ * [Чаму Mobiletto?](#Чаму Mobiletto?)
8
+ * [Хуткі старт](#Хуткі старт)
9
+ * [Mobiletto CLI](#mobiletto-cli)
10
+ * [Крыніца](#Крыніца)
11
+ * [Асноўнае выкарыстанне](#Basic-usage)
12
+ * [Метададзеныя](#Метададзеныя)
13
+ * [Альтэрнатыўны стыль імпарту](#Alternate-import-style)
14
+ * [Кэшаванне](#Кэшаванне)
15
+ * [Адлюстраванне](#Адлюстраванне)
16
+ * [Празрыстае шыфраванне](#Transparent-encryption)
17
+ * [Паварот клавіш](#Паварот клавіш)
18
+ * [Інтэрфейс драйвера](#Інтэрфейс драйвера)
19
+ * [Вядзенне журнала](#Вядзенне журнала)
20
+
21
+ # Прачытайце гэта на іншай мове
22
+ Гэты дакумент README.md быў перакладзены праз [hokeylization](https://github.com/cobbzilla/hokeylization) на
23
+ **[усе мовы, якія падтрымліваюцца Google Translate](https://cloud.google.com/translate/docs/languages)!**
24
+
25
+ Я ўпэўнены, што гэта не ідэальна, але я спадзяюся, што гэта лепш, чым нічога!
26
+
27
+ [🇸🇦 арабская](../ar/README.md)
28
+ [🇧🇩 бенгальская](../bn/README.md)
29
+ [🇩🇪 нямецкая](../de/README.md)
30
+ [🇺🇸 англійская](../en/README.md)
31
+ [🇪🇸 Іспанская](../es/README.md)
32
+ [🇫🇷 французская](../fr/README.md)
33
+ [🇹🇩 Хаўса](../ha/README.md)
34
+ [🇮🇳 хіндзі](../hi/README.md)
35
+ [🇮🇩 Інданезійская](../id/README.md)
36
+ [🇮🇹 Італьянская](../it/README.md)
37
+ [🇯🇵 японская](../ja/README.md)
38
+ [🇰🇷 карэйская](../ko/README.md)
39
+ [🇮🇳 маранты](../mr/README.md)
40
+ [🇵🇱 польская](../pl/README.md)
41
+ [🇧🇷 партугальская](../pt/README.md)
42
+ [🇷🇺 руская](../ru/README.md)
43
+ [🇰🇪 суахілі](../sw/README.md)
44
+ [🇵🇭 Тагалог](../tl/README.md)
45
+ [🇹🇷 турэцкая](../tr/README.md)
46
+ [🇵🇰 урду](../ur/README.md)
47
+ [🇻🇳 в'етнамская](../vi/README.md)
48
+ [🇨🇳 кітайская](../zh/README.md)
49
+
50
+
51
+ **[📚 ... Усе мовы ...](../README.md)**
52
+ ----
53
+
54
+ ### Ці ёсць праблемы з гэтым перакладам README?
55
+ Гэты канкрэтны пераклад арыгінала [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
56
+ можа мець недахопы -- *выпраўленні вельмі вітаюцца!* Адпраўце [запыт на выцягванне на GitHub](https://github.com/cobbzilla/mobiletto/pulls),
57
+ або, калі вам гэта не зручна, [адкрыйце пытанне](https://github.com/cobbzilla/mobiletto/issues)
58
+
59
+ Калі вы ствараеце новую праблему GitHub аб перакладзе, зрабіце:
60
+ * уключыце URL старонкі (скапіруйце/устаўце з адраснага радка браўзера)
61
+ * уключыце дакладны няправільны тэкст (скапіруйце/устаўце з браўзера)
62
+ * калі ласка, апішыце, што не так -- пераклад няправільны? фарматаванне неяк парушана?
63
+ * калі ласка, прапануйце лепшы пераклад ці тое, як правільна афармляць тэкст
64
+ * **Дзякуй!**
65
+
66
+ ## Чаму Mobiletto?
67
+
68
+ ### Бывай, блакаванне пастаўшчыка!
69
+ Розныя пастаўшчыкі воблачных сховішчаў маюць несумяшчальныя API. Нават тыя, якія імкнуцца да "сумяшчальнасці S3"
70
+ маюць ідыясінкратычныя паводзіны.
71
+
72
+ Калі вы выбіраеце пэўнага пастаўшчыка сховішча для вашага прыкладання, калі вы кодуеце непасрэдна яго API, ваша прыкладанне
73
+ зараз залежыць ад гэтай службы. Час ідзе і код назапашваецца, пастаўшчыкі мяняюцца
74
+ усё больш невыносным. Сардэчна запрашаем у вясёлы свет блакіроўкі пастаўшчыкоў!
75
+
76
+ Mobiletto быў распрацаваны, каб вырашыць гэтую праблему. Закадзіраваўшы сваю праграму ў API mobiletto, вы можаце лёгка
77
+ зменіце пастаўшчыка сховішча і ведайце, што ўзровень сховішча вашага прыкладання будзе паводзіць сябе аднолькава.
78
+
79
+ ### Шырокае тэставанне
80
+ Усе драйверы правяраюцца на аднолькавыя паводзіны з больш чым 60 тэстамі для кожнага драйвера.
81
+ Мы тэстуем усе драйверы з кожнай камбінацыяй:
82
+ * Шыфраванне: як уключана, так і адключана
83
+ * Кэш Redis: уключаны і адключаны
84
+
85
+ Такі падыход дае нам спакой, што mobiletto будзе паводзіць сябе аднолькава незалежна ад таго, які драйвер вы выкарыстоўваеце,
86
+ і незалежна ад таго, уключылі вы кэшаванне і/або шыфраванне.
87
+
88
+ ### Падтрымка драйвераў
89
+ Актуальныя драйверы захоўвання Mobiletto:
90
+ * `s3` : Amazon S3
91
+ * `b2` : Backblaze B2
92
+ * `local` : лакальная файлавая сістэма
93
+
94
+ *Уклад у падтрымку большай колькасці пастаўшчыкоў воблачных сховішчаў вельмі вітаецца!*
95
+
96
+ ## mobiletto-cli
97
+ Mobiletto прызначаны для выкарыстання іншым кодам JavaScript у якасці бібліятэкі.
98
+
99
+ Каб працаваць з mobiletto ў камандным радку, выкарыстоўвайце [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
100
+
101
+ ## Крыніца
102
+ * [mobiletto на GitHub](https://github.com/cobbzilla/mobiletto)
103
+ * [mobiletto на npm](https://www.npmjs.com/package/mobiletto)
104
+
105
+ ## Хуткі старт
106
+ Кароткі прыклад выкарыстання драйвера mobiletto `s3` .
107
+
108
+ Гэты код працаваў бы аднолькава, калі б драйвер быў `b2` або `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
+ ## Асноўнае выкарыстанне
139
+ Значна больш шырокі прыклад, які паказвае большасць прапанаваных функцый:
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
+ ## Метададзеныя
241
+ Каманда `metadata` вяртае метаданыя аб адным запісе файлавай сістэмы.
242
+ Падобным чынам значэнне, якое вяртае каманда `list` , з'яўляецца масівам аб'ектаў метададзеных.
243
+
244
+ Аб'ект метададзеных выглядае так:
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
+ `type` можа быць `file` , `dir` , `link` або `special` .
255
+
256
+ У залежнасці ад тыпу драйвера, каманда `list` можа не вяртаць усе палі. `name` і `type`
257
+ заўсёды павінна прысутнічаць. Наступная каманда `metadata` верне ўсе даступныя ўласцівасці.
258
+
259
+ ## Альтэрнатыўны стыль імпарту
260
+ Імпартуйце поўны модуль і выкарыстоўвайце функцыю `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
+ ## Кэшаванне
268
+ Mobiletto лепш за ўсё працуе з <a href="https://redis.io">кэшам</a> Redis.
269
+
270
+ Mobiletto паспрабуе падключыцца да асобніка Redis на 127.0.0.1:6379
271
+
272
+ Вы можаце перавызначыць любы з наступных варыянтаў:
273
+ * Усталюйце `MOBILETTO_REDIS_HOST` , мабільнае падключэнне тут замест лакальнага
274
+ * Усталюйце `MOBILETTO_REDIS_PORT` , гэты порт будзе выкарыстоўвацца
275
+
276
+ Mobiletto будзе захоўваць усе свае ключы Redis з прэфіксам `_mobiletto__` . Вы можаце змяніць гэта
277
+ шляхам усталявання `MOBILETTO_REDIS_PREFIX` var.
278
+
279
+ Вы таксама можаце ўсталяваць кэшаванне кожнага злучэння з дапамогай аб'екта `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
+ ### Не хочаце кэшаваць Redis?
291
+ Каб адключыць: перадайце `enabled: false` у вашым аб'екце `opts.redisConfig` пры ўсталяванні злучэння.
292
+
293
+ Як сказана ніжэй, адключэнне кэшавання негатыўна паўплывае на прадукцыйнасць і пацягне за сабой больш запытаў
294
+ у сховішча, якое вам сапраўды трэба.
295
+
296
+ ### Кіраўніцтва па кэшаванні
297
+ **Зашыфраванае сховішча**: чытанне/запіс зашыфраванага сховішча толькі крыху павольней звычайнага,
298
+ але навігацыя па каталогах (што некаторыя рэчы робяць) даволі дарагая. Выкарыстанне кэша Redis
299
+ дасць вам значны прырост прадукцыйнасці.
300
+
301
+ Кэш па змаўчанні бяспечны, але не працуе добра, калі ў вас шмат аперацый запісу/выдалення.
302
+ Любая аперацыя запісу або выдалення робіць увесь кэш несапраўдным, гарантуючы, што наступныя чытанні будуць бачыць
303
+ апошнія змены.
304
+
305
+ ### Інструменты CLI
306
+ Калі вы выкарыстоўваеце інструмент CLI, напрыклад [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
307
+ вы абавязкова захочаце ўключыць кэш Redis, бо ён захоўваецца пры выкананні каманды `mo` .
308
+
309
+ ## Люстраное адлюстраванне
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` выконвае аднаразовае капіраванне ўсіх файлаў з аднаго mobiletto на іншы.
318
+ Ён не запускае ніякага працэсу для падтрымання люстэрка з цягам часу. Запусціце каманду `mirror` яшчэ раз
319
+ для сінхранізацыі адсутных файлаў.
320
+
321
+ Значэнне, якое вяртае `mirror` , - гэта просты аб'ект са лічыльнікамі колькасці файлаў, якія былі паспяхова перададзены
322
+ адлюстравана і колькі файлаў было з памылкамі:
323
+
324
+ {
325
+ success: count-of-files-mirrored,
326
+ errors: count-of-files-with-errors
327
+ }
328
+
329
+ ПАПЯРЭДЖАННЕ: адлюстраванне вялікіх набораў даных можа заняць вельмі шмат часу і паласы прапускання
330
+
331
+ З `mirror` часам бывае складана зразумець, хто з'яўляецца
332
+ чытач і хто пісьменнік. Уявіце сабе гэта як заяву аб прысваенні: "левае mobiletto"
333
+ гэта рэч, якой прызначаецца (запісаныя люстраныя даныя), і "правы mobiletto" (the
334
+ аргумент метаду `mirror` ) — гэта значэнне, якое прысвойваецца (люстраваныя даныя чытаюцца).
335
+
336
+ ## Празрыстае шыфраванне
337
+ Уключыць празрыстае шыфраванне на баку кліента:
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
+ Што адбываецца? Асобны "запіс каталога" (дырэнт) каталог (зашыфраваны) адсочвае, якія файлы знаходзяцца ў ім
357
+ каталог (ён жа каталог dirent).
358
+ * Каманда `list` чытае файлы запісу каталога, расшыфроўвае кожны пералічаны шлях; затым вяртае метададзеныя для кожнага файла
359
+ * Каманды `list` больш неэфектыўныя, асабліва для каталогаў з вялікай колькасцю файлаў
360
+ * Каманда `write` запісвае dirent-файлы ў dirent-каталог кожнага з бацькоў рэкурсіўна; затым запісвае файл
361
+ * Каманды `write` прывядуць да O(N) запісаў, прычым N = глыбіня ў іерархіі каталогаў
362
+ * Каманда `remove` выдаляе адпаведны файл dirent і яго бацькоўскі файл, калі ён пусты; затым выдаляе файл
363
+ * Нерэкурсіўныя каманды `remove` прывядуць да O(N) чытанняў і патэнцыйна столькі ж выдаленняў, з N = глыбінёй у іерархіі каталогаў
364
+ * Рэкурсіўныя каманды `remove` на вялікіх і глыбокіх файлавых сістэмах могуць быць дарагімі
365
+
366
+ Звярніце ўвагу, што нават пры ўключаным шыфраванні на баку кліента, праціўнік з поўнай бачнасцю вашага зашыфраванага боку сервера
367
+ сховішча, нават без ключа, можа па-ранейшаму бачыць агульную колькасць каталогаў і колькасць файлаў у кожным, а таксама з
368
+ некаторыя намаганні, выявіць частку або ўсю агульную структуру іерархіі каталогаў.
369
+ *Заўвага: выкарыстоўвайце адносна плоскую структуру для лепшай бяспекі.*
370
+ Праціўнік не будзе ведаць імёны каталогаў/файлаў, калі ён таксама не будзе ведаць ваша шыфраванне
371
+ ключ або іншым чынам паспяхова ўзламаў шыфраванне. Тады ўсе стаўкі адключаны!
372
+
373
+ ### Прадукцыйнасць і кэшаванне
374
+ Аперацыі ў зашыфраваным сховішчы могуць быць павольнымі. Рэкурсіўныя спісы і выдаленні могуць быць вельмі павольнымі.
375
+ Кэшаванне праз redis надзвычай дапамагае, але звярніце ўвагу, што кэш ачышчаецца пры любой запісе або выдаленні.
376
+
377
+ ## Кручэнне ключоў
378
+ Стварыце mobiletto з вашым новым ключом, затым адлюстравайце ў ім старыя дадзеныя:
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
+ ## Інтэрфейс драйвера
391
+ Драйвер - гэта любы файл JS, які экспартуе функцыю "storageClient" з такой сігнатурай:
392
+
393
+ function storageClient (key, secret, opts)
394
+
395
+ * `key` : радок, ваш ключ API (для `local` драйвера гэта базавы каталог)
396
+ * `secret` : радок, ваш сакрэт API (можна апусціць для `local` драйвера)
397
+ * `opts` : аб'ект, уласцівасці кожнага драйвера:
398
+ * Для `local` local` ўласцівасці `fileMode` і `dirMode` вызначаюць, як ствараюцца новыя файлы і каталогі
399
+ * Для `s3` патрабуецца ўласцівасць `bucket` . Дадатковыя ўласцівасці:
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
+ Аб'ект, які вяртае функцыя storageClient, павінен вызначаць наступныя функцыі:
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
+ ## Журнал
431
+ Mobiletto выкарыстоўвае бібліятэку запісу [winston](https://www.npmjs.com/package/winston).
432
+
433
+ Журналы **будуць** утрымліваць шляхі да файлаў і паведамленні пра памылкі, але **ніколі** не будуць утрымліваць ключы, сакрэты,
434
+ або любую іншую інфармацыю аб канфігурацыі злучэння.
435
+
436
+ ### Узровень часопіса
437
+ Выкарыстоўвайце зменную асяроддзя `MOBILETTO_LOG_LEVEL` , каб усталяваць узровень журнала, выкарыстоўваючы адзін
438
+ узроўняў `npm` , вызначаных у [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
439
+
440
+ Узровень па змаўчанні - `error` . Самы шматслоўны ўзровень - `silly` , хоць у цяперашні час mobiletto
441
+ не рэгіструе на ўзроўнях, ніжэйшых за `debug`
442
+
443
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
444
+
445
+ ### Файл часопіса
446
+ Па змаўчанні рэгістратар запісвае ў кансоль. Каб адправіць журналы ў файл, усталюйце `MOBILETTO_LOG_FILE`
447
+ зменная асяроддзя. Пры ўваходзе ў файл журналы больш не будуць запісвацца ў кансоль.
448
+
449
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
450
+
451
+ Каб адключыць запіс:
452
+
453
+ MOBILETTO_LOG_FILE=/dev/null
454
+
455
+ </pre>