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 бул JavaScript сактагычтын абстракция катмары, кошумча тунук кардар тарабынан шифрлөө.
5
+
6
+ # Мазмуну
7
+ * [Эмне үчүн Mobiletto?](#Why-Mobiletto?)
8
+ * [Ыкчам баштоо](#Тез баштоо)
9
+ * [Mobiletto CLI](#mobiletto-cli)
10
+ * [Булак](#Булак)
11
+ * [Негизги колдонуу](#Негизги колдонуу)
12
+ * [Метадайындар](#Метадайындар)
13
+ * [Импорттун альтернативдүү стили](#Alternate-import-style)
14
+ * [Кэштөө](#Кэштөө)
15
+ * [Мирroring](#Mirroring)
16
+ * [Тунук шифрлөө](#Transparent-шифрлөө)
17
+ * [Ачкычты айландыруу](#Ачкычты айландыруу)
18
+ * [Драйвер интерфейси](#Driver-интерфейс)
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
+ [🇫🇷 French](../fr/README.md)
33
+ [🇹🇩 Hausa](../ha/README.md)
34
+ [🇮🇳 Хинди](../hi/README.md)
35
+ [🇮🇩 Индонезия](../id/README.md)
36
+ [🇮🇹 Италиялык](../it/README.md)
37
+ [🇯🇵 Жапон](../ja/README.md)
38
+ [🇰🇷 Корейче](../ko/README.md)
39
+ [🇮🇳 Maranthi](../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 бул көйгөйдү чечүү үчүн иштелип чыккан. Колдонмоңузду mobiletto'нун API'сине коддоо менен, сиз оңой кыла аласыз
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
+ * [GitHubдагы мобилетто](https://github.com/cobbzilla/mobiletto)
103
+ * [mobiletto on 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">redis</a> кэш менен жакшы иштейт.
269
+
270
+ Mobiletto 127.0.0.1:6379 боюнча redis инстанциясына туташууга аракет кылат
271
+
272
+ Сиз булардын бирин жокко чыгара аласыз:
273
+ * Localhost ордуна бул жерге туташуу үчүн `MOBILETTO_REDIS_HOST` var, mobilet коюңуз
274
+ * `MOBILETTO_REDIS_PORT` var орнотуңуз, бул порт колдонулат
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
+ ### Редис кэштештирүүнү каалабайсызбы?
291
+ Өчүрүү үчүн: туташууну орнотуп жатканда `opts.redisConfig` `enabled: false` ' дегенди өткөрүңүз.
292
+
293
+ Төмөндө талкуулангандай, кэшти өчүрүү аткарууга терс таасирин тийгизип, көбүрөөк суроо-талаптарды жаратат
294
+ сизге чындап керек болгон сактоого.
295
+
296
+ ### Кэштөө боюнча көрсөтмө
297
+ **Шифрленген сактагыч**: шифрленген сактагычты окуу/жазуу кадимкиден бир аз жайыраак,
298
+ бирок каталогдордо чабыттоо (айрым нерселерде) кыйла кымбатка турат. Redis кэшин колдонуу
299
+ сага олуттуу аткарууну берет.
300
+
301
+ Демейки кэш коопсуз, бирок сизде жазуу/алып салуу операциялары көп болсо, жакшы иштебейт.
302
+ Ар кандай жазуу же алып салуу операциясы толугу менен кэшти жараксыз кылып, кийинки окуулар көрүүнү камсыздайт
303
+ акыркы өзгөрүүлөр.
304
+
305
+ ### CLI куралдары
306
+ Эгер сиз [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli) сыяктуу CLI куралын колдонуп жатсаңыз,
307
+ Сиз сөзсүз түрдө redis кэшинин иштетилишин каалайсыз, анткени ал `mo` буйругунун чакырууларында созулат.
308
+
309
+ ## Mirroring
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` буйругу бардык файлдардын бир мобилдик телефондон экинчисине бир жолку көчүрмөсүн аткарат.
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
+ окурман жана жазуучу ким. Аны тапшырма билдирүүсү сыяктуу элестетиңиз: "сол кол мобилдик"
333
+ дайындалган нерсе (жазылган күзгү маалыматтар) жана "оң кол мобилдик" (
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
+ каталог (ака дирент каталогу).
358
+ * `list` буйругу каталогдун файлдарын окуйт, тизмеленген ар бир жолдун шифрин чечет; андан кийин ар бир файл үчүн метадайындарды кайтарат
359
+ * `list` буйруктары өзгөчө файлдардын саны көп каталогдор үчүн натыйжасызыраак
360
+ * `write` командасы dirent файлдарды ар бир ата-эненин дирент каталогуна рекурсивдүү түрдө жазат; анан файлды жазат
361
+ * `write` буйруктары каталогдун иерархиясында N = тереңдик менен O(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
+ Драйвер бул кол тамга менен 'storageClient' функциясын экспорттоочу каалаган JS файлы:
392
+
393
+ function storageClient (key, secret, opts)
394
+
395
+ * `key` : сап, сиздин API ачкычыңыз ( `local` драйвер үчүн бул базалык каталог)
396
+ * `secret` : сап, сиздин API `local` драйвер үчүн калтырылышы мүмкүн)
397
+ * `opts` : объект, касиеттери ар бир драйверге таандык:
398
+ * `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
+ [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels) дарегинде аныкталган `npm` деңгээлдеринин
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>