mobiletto 1.2.0 → 2.0.0

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 (127) hide show
  1. package/lib/cjs/index.d.ts +2 -0
  2. package/lib/cjs/index.js +30 -0
  3. package/lib/cjs/package.json +16 -0
  4. package/lib/esm/index.d.ts +2 -0
  5. package/lib/esm/index.js +12 -0
  6. package/package.json +27 -13
  7. package/.babelrc +0 -5
  8. package/.eslintrc.js +0 -14
  9. package/docs/README.md +0 -113
  10. package/docs/af/README.md +0 -481
  11. package/docs/am/README.md +0 -481
  12. package/docs/ar/README.md +0 -481
  13. package/docs/az/README.md +0 -481
  14. package/docs/be/README.md +0 -481
  15. package/docs/bg/README.md +0 -481
  16. package/docs/bn/README.md +0 -481
  17. package/docs/bs/README.md +0 -481
  18. package/docs/ca/README.md +0 -481
  19. package/docs/ceb/README.md +0 -481
  20. package/docs/co/README.md +0 -481
  21. package/docs/cs/README.md +0 -481
  22. package/docs/cy/README.md +0 -481
  23. package/docs/da/README.md +0 -481
  24. package/docs/de/README.md +0 -481
  25. package/docs/el/README.md +0 -481
  26. package/docs/eo/README.md +0 -481
  27. package/docs/es/README.md +0 -481
  28. package/docs/et/README.md +0 -481
  29. package/docs/eu/README.md +0 -481
  30. package/docs/fa/README.md +0 -481
  31. package/docs/fi/README.md +0 -481
  32. package/docs/fr/README.md +0 -481
  33. package/docs/fy/README.md +0 -481
  34. package/docs/ga/README.md +0 -481
  35. package/docs/gd/README.md +0 -481
  36. package/docs/gl/README.md +0 -481
  37. package/docs/gu/README.md +0 -481
  38. package/docs/ha/README.md +0 -481
  39. package/docs/haw/README.md +0 -481
  40. package/docs/he/README.md +0 -481
  41. package/docs/hi/README.md +0 -481
  42. package/docs/hmn/README.md +0 -481
  43. package/docs/hr/README.md +0 -481
  44. package/docs/ht/README.md +0 -481
  45. package/docs/hu/README.md +0 -481
  46. package/docs/hy/README.md +0 -481
  47. package/docs/id/README.md +0 -481
  48. package/docs/ig/README.md +0 -481
  49. package/docs/is/README.md +0 -481
  50. package/docs/it/README.md +0 -481
  51. package/docs/iw/README.md +0 -481
  52. package/docs/ja/README.md +0 -481
  53. package/docs/jv/README.md +0 -481
  54. package/docs/ka/README.md +0 -481
  55. package/docs/kk/README.md +0 -481
  56. package/docs/km/README.md +0 -481
  57. package/docs/kn/README.md +0 -481
  58. package/docs/ko/README.md +0 -481
  59. package/docs/ku/README.md +0 -481
  60. package/docs/ky/README.md +0 -481
  61. package/docs/la/README.md +0 -481
  62. package/docs/lb/README.md +0 -481
  63. package/docs/lo/README.md +0 -481
  64. package/docs/lt/README.md +0 -481
  65. package/docs/lv/README.md +0 -481
  66. package/docs/mg/README.md +0 -481
  67. package/docs/mi/README.md +0 -481
  68. package/docs/mk/README.md +0 -481
  69. package/docs/ml/README.md +0 -481
  70. package/docs/mn/README.md +0 -481
  71. package/docs/mr/README.md +0 -481
  72. package/docs/ms/README.md +0 -481
  73. package/docs/mt/README.md +0 -481
  74. package/docs/my/README.md +0 -481
  75. package/docs/ne/README.md +0 -481
  76. package/docs/nl/README.md +0 -481
  77. package/docs/no/README.md +0 -481
  78. package/docs/ny/README.md +0 -481
  79. package/docs/or/README.md +0 -481
  80. package/docs/pa/README.md +0 -481
  81. package/docs/pl/README.md +0 -481
  82. package/docs/ps/README.md +0 -481
  83. package/docs/pt/README.md +0 -481
  84. package/docs/ro/README.md +0 -481
  85. package/docs/ru/README.md +0 -481
  86. package/docs/rw/README.md +0 -481
  87. package/docs/sd/README.md +0 -481
  88. package/docs/si/README.md +0 -481
  89. package/docs/sk/README.md +0 -481
  90. package/docs/sl/README.md +0 -481
  91. package/docs/sm/README.md +0 -481
  92. package/docs/sn/README.md +0 -481
  93. package/docs/so/README.md +0 -481
  94. package/docs/sq/README.md +0 -481
  95. package/docs/sr/README.md +0 -481
  96. package/docs/st/README.md +0 -481
  97. package/docs/su/README.md +0 -481
  98. package/docs/sv/README.md +0 -481
  99. package/docs/sw/README.md +0 -481
  100. package/docs/ta/README.md +0 -481
  101. package/docs/te/README.md +0 -481
  102. package/docs/tg/README.md +0 -481
  103. package/docs/th/README.md +0 -481
  104. package/docs/tk/README.md +0 -481
  105. package/docs/tl/README.md +0 -481
  106. package/docs/tr/README.md +0 -481
  107. package/docs/tt/README.md +0 -481
  108. package/docs/ug/README.md +0 -481
  109. package/docs/uk/README.md +0 -481
  110. package/docs/ur/README.md +0 -481
  111. package/docs/uz/README.md +0 -481
  112. package/docs/vi/README.md +0 -481
  113. package/docs/xh/README.md +0 -481
  114. package/docs/yi/README.md +0 -481
  115. package/docs/yo/README.md +0 -481
  116. package/docs/zh/README.md +0 -481
  117. package/docs/zu/README.md +0 -481
  118. package/drivers/b2/index.js +0 -451
  119. package/drivers/local/index.js +0 -315
  120. package/drivers/s3/index.js +0 -316
  121. package/hokey.json +0 -16
  122. package/index.js +0 -10
  123. package/test/api.spec.js +0 -512
  124. package/test/crypt.spec.js +0 -67
  125. package/util/crypt.js +0 -80
  126. package/util/logger.js +0 -27
  127. package/util/redis.js +0 -233
package/docs/be/README.md DELETED
@@ -1,481 +0,0 @@
1
- Мабілета
2
- =========
3
-
4
- Mobiletto - гэта ўзровень абстракцыі сховішча JavaScript з дадатковым празрыстым шыфраваннем на баку кліента.
5
-
6
- # Змест
7
- * [Чаму Mobiletto?](#Чаму Mobiletto?)
8
- * [Хуткі старт](#Хуткі старт)
9
- * [Mobiletto CLI](#mobiletto-cli)
10
- * [Крыніца](#Крыніца)
11
- * [Устаноўка](#Устаноўка)
12
- * [Падтрымка і фінансаванне](#Support-and-Funding)
13
- * [Асноўнае выкарыстанне](#Basic-usage)
14
- * [Метададзеныя](#Метададзеныя)
15
- * [Альтэрнатыўны стыль імпарту](#Alternate-import-style)
16
- * [Кэшаванне](#Кэшаванне)
17
- * [Адлюстраванне](#Адлюстраванне)
18
- * [Празрыстае шыфраванне](#Transparent-encryption)
19
- * [Паварот клавіш](#Паварот клавіш)
20
- * [Інтэрфейс драйвера](#Інтэрфейс драйвера)
21
- * [Вядзенне журнала](#Вядзенне журнала)
22
-
23
- # Прачытайце гэта на іншай мове
24
- Гэты дакумент README.md быў перакладзены праз [hokeylization](https://github.com/cobbzilla/hokeylization) на
25
- **[усе мовы, якія падтрымліваюцца Google Translate](https://cloud.google.com/translate/docs/languages)!**
26
-
27
- Я ўпэўнены, што гэта не ідэальна, але я спадзяюся, што гэта лепш, чым нічога!
28
-
29
- [🇸🇦 арабская](../ar/README.md)
30
- [🇧🇩 бенгальская](../bn/README.md)
31
- [🇩🇪 нямецкая](../de/README.md)
32
- [🇺🇸 англійская](../en/README.md)
33
- [🇪🇸 Іспанская](../es/README.md)
34
- [🇫🇷 французская](../fr/README.md)
35
- [🇹🇩 Хаўса](../ha/README.md)
36
- [🇮🇳 хіндзі](../hi/README.md)
37
- [🇮🇩 Інданезійская](../id/README.md)
38
- [🇮🇹 Італьянская](../it/README.md)
39
- [🇯🇵 японская](../ja/README.md)
40
- [🇰🇷 карэйская](../ko/README.md)
41
- [🇮🇳 маранты](../mr/README.md)
42
- [🇵🇱 польская](../pl/README.md)
43
- [🇧🇷 партугальская](../pt/README.md)
44
- [🇷🇺 руская](../ru/README.md)
45
- [🇰🇪 суахілі](../sw/README.md)
46
- [🇵🇭 Тагалог](../tl/README.md)
47
- [🇹🇷 турэцкая](../tr/README.md)
48
- [🇵🇰 урду](../ur/README.md)
49
- [🇻🇳 в'етнамская](../vi/README.md)
50
- [🇨🇳 кітайская](../zh/README.md)
51
-
52
-
53
- **[📚 ... Усе мовы ...](../README.md)**
54
- ----
55
-
56
- ### Ці ёсць праблемы з гэтым перакладам README?
57
- Гэты канкрэтны пераклад арыгінала [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
58
- можа мець недахопы -- *выпраўленні вельмі вітаюцца!* Адпраўце [запыт на выцягванне на GitHub](https://github.com/cobbzilla/mobiletto/pulls),
59
- або, калі вам гэта не зручна, [адкрыйце пытанне](https://github.com/cobbzilla/mobiletto/issues)
60
-
61
- Калі вы ствараеце новую праблему GitHub аб перакладзе, зрабіце:
62
- * уключыце URL старонкі (скапіруйце/устаўце з адраснага радка браўзера)
63
- * уключыце дакладны няправільны тэкст (скапіруйце/устаўце з браўзера)
64
- * калі ласка, апішыце, што не так -- пераклад няправільны? фарматаванне неяк парушана?
65
- * калі ласка, прапануйце лепшы пераклад ці тое, як правільна афармляць тэкст
66
- * **Дзякуй!**
67
-
68
- ## Чаму Mobiletto?
69
-
70
- ### Бывай, блакаванне пастаўшчыка!
71
- Розныя пастаўшчыкі воблачных сховішчаў маюць несумяшчальныя API. Нават тыя, якія імкнуцца да "сумяшчальнасці S3"
72
- маюць ідыясінкратычныя паводзіны.
73
-
74
- Калі вы выбіраеце пэўнага пастаўшчыка сховішча для вашага прыкладання, калі вы кодуеце непасрэдна яго API, ваша прыкладанне
75
- зараз залежыць ад гэтай службы. Час ідзе і код назапашваецца, пастаўшчыкі мяняюцца
76
- усё больш невыносным. Сардэчна запрашаем у вясёлы свет блакіроўкі пастаўшчыкоў!
77
-
78
- Mobiletto быў распрацаваны, каб вырашыць гэтую праблему. Закадзіраваўшы сваю праграму ў API mobiletto, вы можаце лёгка
79
- зменіце пастаўшчыка сховішча і ведайце, што ўзровень сховішча вашага прыкладання будзе паводзіць сябе аднолькава.
80
-
81
- ### Шырокае тэставанне
82
- Усе драйверы правяраюцца на аднолькавыя паводзіны з больш чым 60 тэстамі для кожнага драйвера.
83
- Мы тэстуем усе драйверы з кожнай камбінацыяй:
84
- * Шыфраванне: як уключана, так і адключана
85
- * Кэш Redis: уключаны і адключаны
86
-
87
- Такі падыход дае нам спакой, што mobiletto будзе паводзіць сябе аднолькава незалежна ад таго, які драйвер вы выкарыстоўваеце,
88
- і незалежна ад таго, уключылі вы кэшаванне і/або шыфраванне.
89
-
90
- ### Падтрымка драйвераў
91
- Актуальныя драйверы захоўвання Mobiletto:
92
- * `s3` : Amazon S3
93
- * `b2` : Backblaze B2
94
- * `local` : лакальная файлавая сістэма
95
-
96
- *Уклад у падтрымку большай колькасці пастаўшчыкоў воблачных сховішчаў вельмі вітаецца!*
97
-
98
- ## mobiletto-cli
99
- Mobiletto прызначаны для выкарыстання іншым кодам JavaScript у якасці бібліятэкі.
100
-
101
- Каб працаваць з mobiletto ў камандным радку, выкарыстоўвайце [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
102
-
103
- ## Крыніца
104
- * [mobiletto на GitHub](https://github.com/cobbzilla/mobiletto)
105
- * [mobiletto на npm](https://www.npmjs.com/package/mobiletto)
106
-
107
- ## Падтрымка і фінансаванне
108
- Я спрабую быць прафесійным распрацоўшчыкам праграмнага забеспячэння з адкрытым зыходным кодам. Я працаваў у
109
- У індустрыі праграмнага забеспячэння на працягу многіх гадоў я ствараў паспяховыя кампаніі і прадаваў іх публічным кампаніям.
110
- Нядаўна я страціў працу, і ў мяне няма іншай працы
111
-
112
- Таму я паспрабую напісаць карыснае праграмнае забеспячэнне і пагляджу, ці спрацуе гэта
113
-
114
- Калі вам падабаецца карыстацца гэтай праграмай, я быў бы вельмі ўдзячны нават за
115
- найменшы [штомесячны ўзнос праз Patreon](https://www.patreon.com/cobbzilla)
116
-
117
- *Дзякуй!*
118
-
119
- ## Устаноўка
120
- Усталюйце з дапамогай `npm` або `yarn` . Верагодна, вам патрэбна `lite` версія, якая не ўключае ўсе
121
- перакладзеныя файлы README:
122
-
123
- npm install mobiletto-lite
124
- yarn add mobiletto-lite
125
-
126
- Калі вы сапраўды хочаце файлы README на ўсіх мовах, усталюйце поўную версію:
127
-
128
- npm install mobiletto
129
- yarn add mobiletto
130
-
131
- ## Хуткі старт
132
- Кароткі прыклад выкарыстання драйвера mobiletto `s3` .
133
-
134
- Гэты код працаваў бы аднолькава, калі б драйвер быў `b2` або `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
- ## Асноўнае выкарыстанне
165
- Значна больш шырокі прыклад, які паказвае большасць прапанаваных функцый:
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
- ## Метададзеныя
267
- Каманда `metadata` вяртае метаданыя аб адным запісе файлавай сістэмы.
268
- Падобным чынам значэнне, якое вяртае каманда `list` , з'яўляецца масівам аб'ектаў метададзеных.
269
-
270
- Аб'ект метададзеных выглядае так:
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
- `type` можа быць `file` , `dir` , `link` або `special` .
281
-
282
- У залежнасці ад тыпу драйвера, каманда `list` можа не вяртаць усе палі. `name` і `type`
283
- заўсёды павінна прысутнічаць. Наступная каманда `metadata` верне ўсе даступныя ўласцівасці.
284
-
285
- ## Альтэрнатыўны стыль імпарту
286
- Імпартуйце поўны модуль і выкарыстоўвайце функцыю `connect` :
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
- ## Кэшаванне
294
- Mobiletto лепш за ўсё працуе з <a href="https://redis.io">кэшам</a> Redis.
295
-
296
- Mobiletto паспрабуе падключыцца да асобніка Redis на 127.0.0.1:6379
297
-
298
- Вы можаце перавызначыць любы з наступных варыянтаў:
299
- * Усталюйце `MOBILETTO_REDIS_HOST` , мабільнае падключэнне тут замест лакальнага
300
- * Усталюйце `MOBILETTO_REDIS_PORT` , гэты порт будзе выкарыстоўвацца
301
-
302
- Mobiletto будзе захоўваць усе свае ключы Redis з прэфіксам `_mobiletto__` . Вы можаце змяніць гэта
303
- шляхам усталявання `MOBILETTO_REDIS_PREFIX` var.
304
-
305
- Вы таксама можаце ўсталяваць кэшаванне кожнага злучэння з дапамогай аб'екта `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
- ### Не хочаце кэшаваць Redis?
317
- Каб адключыць: перадайце `enabled: false` у вашым аб'екце `opts.redisConfig` пры ўсталяванні злучэння.
318
-
319
- Як сказана ніжэй, адключэнне кэшавання негатыўна паўплывае на прадукцыйнасць і пацягне за сабой больш запытаў
320
- у сховішча, якое вам сапраўды трэба.
321
-
322
- ### Кіраўніцтва па кэшаванні
323
- **Зашыфраванае сховішча**: чытанне/запіс зашыфраванага сховішча толькі крыху павольней звычайнага,
324
- але навігацыя па каталогах (што некаторыя рэчы робяць) даволі дарагая. Выкарыстанне кэша Redis
325
- дасць вам значны прырост прадукцыйнасці.
326
-
327
- Кэш па змаўчанні бяспечны, але не працуе добра, калі ў вас шмат аперацый запісу/выдалення.
328
- Любая аперацыя запісу або выдалення робіць увесь кэш несапраўдным, гарантуючы, што наступныя чытанні будуць бачыць
329
- апошнія змены.
330
-
331
- ### Інструменты CLI
332
- Калі вы выкарыстоўваеце інструмент CLI, напрыклад [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
333
- вы абавязкова захочаце ўключыць кэш Redis, бо ён захоўваецца пры выкананні каманды `mo` .
334
-
335
- ## Люстраное адлюстраванне
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` выконвае аднаразовае капіраванне ўсіх файлаў з аднаго mobiletto на іншы.
344
- Ён не запускае ніякага працэсу для падтрымання люстэрка з цягам часу. Запусціце каманду `mirror` яшчэ раз
345
- для сінхранізацыі адсутных файлаў.
346
-
347
- Значэнне, якое вяртае `mirror` , - гэта просты аб'ект са лічыльнікамі колькасці файлаў, якія былі паспяхова перададзены
348
- адлюстравана і колькі файлаў было з памылкамі:
349
-
350
- {
351
- success: count-of-files-mirrored,
352
- errors: count-of-files-with-errors
353
- }
354
-
355
- ПАПЯРЭДЖАННЕ: адлюстраванне вялікіх набораў даных можа заняць вельмі шмат часу і паласы прапускання
356
-
357
- З `mirror` часам бывае складана зразумець, хто з'яўляецца
358
- чытач і хто пісьменнік. Уявіце сабе гэта як заяву аб прысваенні: "левае mobiletto"
359
- гэта рэч, якой прызначаецца (запісаныя люстраныя даныя), і "правы mobiletto" (the
360
- аргумент метаду `mirror` ) — гэта значэнне, якое прысвойваецца (люстраваныя даныя чытаюцца).
361
-
362
- ## Празрыстае шыфраванне
363
- Уключыць празрыстае шыфраванне на баку кліента:
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
- Што адбываецца? Асобны "запіс каталога" (дырэнт) каталог (зашыфраваны) адсочвае, якія файлы знаходзяцца ў ім
383
- каталог (ён жа каталог dirent).
384
- * Каманда `list` чытае файлы запісу каталога, расшыфроўвае кожны пералічаны шлях; затым вяртае метададзеныя для кожнага файла
385
- * Каманды `list` больш неэфектыўныя, асабліва для каталогаў з вялікай колькасцю файлаў
386
- * Каманда `write` запісвае dirent-файлы ў dirent-каталог кожнага з бацькоў рэкурсіўна; затым запісвае файл
387
- * Каманды `write` прывядуць да O(N) запісаў, прычым N = глыбіня ў іерархіі каталогаў
388
- * Каманда `remove` выдаляе адпаведны файл dirent і яго бацькоўскі файл, калі ён пусты; затым выдаляе файл
389
- * Нерэкурсіўныя каманды `remove` прывядуць да O(N) чытанняў і патэнцыйна столькі ж выдаленняў, з N = глыбінёй у іерархіі каталогаў
390
- * Рэкурсіўныя каманды `remove` на вялікіх і глыбокіх файлавых сістэмах могуць быць дарагімі
391
-
392
- Звярніце ўвагу, што нават пры ўключаным шыфраванні на баку кліента, праціўнік з поўнай бачнасцю вашага зашыфраванага боку сервера
393
- сховішча, нават без ключа, можа па-ранейшаму бачыць агульную колькасць каталогаў і колькасць файлаў у кожным, а таксама з
394
- некаторыя намаганні, выявіць частку або ўсю агульную структуру іерархіі каталогаў.
395
- *Заўвага: выкарыстоўвайце адносна плоскую структуру для лепшай бяспекі.*
396
- Праціўнік не будзе ведаць імёны каталогаў/файлаў, калі ён таксама не будзе ведаць ваша шыфраванне
397
- ключ або іншым чынам паспяхова ўзламаў шыфраванне. Тады ўсе стаўкі адключаны!
398
-
399
- ### Прадукцыйнасць і кэшаванне
400
- Аперацыі ў зашыфраваным сховішчы могуць быць павольнымі. Рэкурсіўныя спісы і выдаленні могуць быць вельмі павольнымі.
401
- Кэшаванне праз redis надзвычай дапамагае, але звярніце ўвагу, што кэш ачышчаецца пры любой запісе або выдаленні.
402
-
403
- ## Кручэнне ключоў
404
- Стварыце mobiletto з вашым новым ключом, затым адлюстравайце ў ім старыя дадзеныя:
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
- ## Інтэрфейс драйвера
417
- Драйвер - гэта любы файл JS, які экспартуе функцыю "storageClient" з такой сігнатурай:
418
-
419
- function storageClient (key, secret, opts)
420
-
421
- * `key` : радок, ваш ключ API (для `local` драйвера гэта базавы каталог)
422
- * `secret` : радок, ваш сакрэт API (можна апусціць для `local` драйвера)
423
- * `opts` : аб'ект, уласцівасці кожнага драйвера:
424
- * Для `local` local` ўласцівасці `fileMode` і `dirMode` вызначаюць, як ствараюцца новыя файлы і каталогі
425
- * Для `s3` патрабуецца ўласцівасць `bucket` . Дадатковыя ўласцівасці:
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
- Аб'ект, які вяртае функцыя storageClient, павінен вызначаць наступныя функцыі:
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
- ## Журнал
457
- Mobiletto выкарыстоўвае бібліятэку запісу [winston](https://www.npmjs.com/package/winston).
458
-
459
- Журналы **будуць** утрымліваць шляхі да файлаў і паведамленні пра памылкі, але **ніколі** не будуць утрымліваць ключы, сакрэты,
460
- або любую іншую інфармацыю аб канфігурацыі злучэння.
461
-
462
- ### Узровень часопіса
463
- Выкарыстоўвайце зменную асяроддзя `MOBILETTO_LOG_LEVEL` , каб усталяваць узровень часопіса, выкарыстоўваючы адзін
464
- узроўняў `npm` , вызначаных у [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
465
-
466
- Узровень па змаўчанні - `error` . Найбольш шматслоўным узроўнем з'яўляецца `silly` , хоць у цяперашні час mobiletto
467
- не рэгіструецца на ўзроўнях, ніжэйшых за `debug`
468
-
469
- MOBILETTO_LOG_LEVEL=silly # maximum logs!
470
-
471
- ### Файл часопіса
472
- Па змаўчанні рэгістратар запісвае ў кансоль. Каб адправіць журналы ў файл, усталюйце `MOBILETTO_LOG_FILE`
473
- зменная асяроддзя. Пры ўваходзе ў файл журналы больш не будуць запісвацца ў кансоль.
474
-
475
- MOBILETTO_LOG_FILE=/var/my_mobiletto_log
476
-
477
- Каб адключыць запіс:
478
-
479
- MOBILETTO_LOG_FILE=/dev/null
480
-
481
- </pre>