mobiletto 1.1.9 → 1.1.12

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 +82 -4
  2. package/docs/README.md +113 -0
  3. package/docs/af/README.md +481 -0
  4. package/docs/am/README.md +481 -0
  5. package/docs/ar/README.md +481 -0
  6. package/docs/az/README.md +481 -0
  7. package/docs/be/README.md +481 -0
  8. package/docs/bg/README.md +481 -0
  9. package/docs/bn/README.md +481 -0
  10. package/docs/bs/README.md +481 -0
  11. package/docs/ca/README.md +481 -0
  12. package/docs/ceb/README.md +481 -0
  13. package/docs/co/README.md +481 -0
  14. package/docs/cs/README.md +481 -0
  15. package/docs/cy/README.md +481 -0
  16. package/docs/da/README.md +481 -0
  17. package/docs/de/README.md +481 -0
  18. package/docs/el/README.md +481 -0
  19. package/docs/eo/README.md +481 -0
  20. package/docs/es/README.md +481 -0
  21. package/docs/et/README.md +481 -0
  22. package/docs/eu/README.md +481 -0
  23. package/docs/fa/README.md +481 -0
  24. package/docs/fi/README.md +481 -0
  25. package/docs/fr/README.md +481 -0
  26. package/docs/fy/README.md +481 -0
  27. package/docs/ga/README.md +481 -0
  28. package/docs/gd/README.md +481 -0
  29. package/docs/gl/README.md +481 -0
  30. package/docs/gu/README.md +481 -0
  31. package/docs/ha/README.md +481 -0
  32. package/docs/haw/README.md +481 -0
  33. package/docs/he/README.md +481 -0
  34. package/docs/hi/README.md +481 -0
  35. package/docs/hmn/README.md +481 -0
  36. package/docs/hr/README.md +481 -0
  37. package/docs/ht/README.md +481 -0
  38. package/docs/hu/README.md +481 -0
  39. package/docs/hy/README.md +481 -0
  40. package/docs/id/README.md +481 -0
  41. package/docs/ig/README.md +481 -0
  42. package/docs/is/README.md +481 -0
  43. package/docs/it/README.md +481 -0
  44. package/docs/iw/README.md +481 -0
  45. package/docs/ja/README.md +481 -0
  46. package/docs/jv/README.md +481 -0
  47. package/docs/ka/README.md +481 -0
  48. package/docs/kk/README.md +481 -0
  49. package/docs/km/README.md +481 -0
  50. package/docs/kn/README.md +481 -0
  51. package/docs/ko/README.md +481 -0
  52. package/docs/ku/README.md +481 -0
  53. package/docs/ky/README.md +481 -0
  54. package/docs/la/README.md +481 -0
  55. package/docs/lb/README.md +481 -0
  56. package/docs/lo/README.md +481 -0
  57. package/docs/lt/README.md +481 -0
  58. package/docs/lv/README.md +481 -0
  59. package/docs/mg/README.md +481 -0
  60. package/docs/mi/README.md +481 -0
  61. package/docs/mk/README.md +481 -0
  62. package/docs/ml/README.md +481 -0
  63. package/docs/mn/README.md +481 -0
  64. package/docs/mr/README.md +481 -0
  65. package/docs/ms/README.md +481 -0
  66. package/docs/mt/README.md +481 -0
  67. package/docs/my/README.md +481 -0
  68. package/docs/ne/README.md +481 -0
  69. package/docs/nl/README.md +481 -0
  70. package/docs/no/README.md +481 -0
  71. package/docs/ny/README.md +481 -0
  72. package/docs/or/README.md +481 -0
  73. package/docs/pa/README.md +481 -0
  74. package/docs/pl/README.md +481 -0
  75. package/docs/ps/README.md +481 -0
  76. package/docs/pt/README.md +481 -0
  77. package/docs/ro/README.md +481 -0
  78. package/docs/ru/README.md +481 -0
  79. package/docs/rw/README.md +481 -0
  80. package/docs/sd/README.md +481 -0
  81. package/docs/si/README.md +481 -0
  82. package/docs/sk/README.md +481 -0
  83. package/docs/sl/README.md +481 -0
  84. package/docs/sm/README.md +481 -0
  85. package/docs/sn/README.md +481 -0
  86. package/docs/so/README.md +481 -0
  87. package/docs/sq/README.md +481 -0
  88. package/docs/sr/README.md +481 -0
  89. package/docs/st/README.md +481 -0
  90. package/docs/su/README.md +481 -0
  91. package/docs/sv/README.md +481 -0
  92. package/docs/sw/README.md +481 -0
  93. package/docs/ta/README.md +481 -0
  94. package/docs/te/README.md +481 -0
  95. package/docs/tg/README.md +481 -0
  96. package/docs/th/README.md +481 -0
  97. package/docs/tk/README.md +481 -0
  98. package/docs/tl/README.md +481 -0
  99. package/docs/tr/README.md +481 -0
  100. package/docs/tt/README.md +481 -0
  101. package/docs/ug/README.md +481 -0
  102. package/docs/uk/README.md +481 -0
  103. package/docs/ur/README.md +481 -0
  104. package/docs/uz/README.md +481 -0
  105. package/docs/vi/README.md +481 -0
  106. package/docs/xh/README.md +481 -0
  107. package/docs/yi/README.md +481 -0
  108. package/docs/yo/README.md +481 -0
  109. package/docs/zh/README.md +481 -0
  110. package/docs/zu/README.md +481 -0
  111. package/drivers/b2/index.js +24 -6
  112. package/hokey.json +16 -0
  113. package/index.js +32 -16
  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,481 @@
1
+ Mobiletto
2
+ =========
3
+
4
+ Mobiletto е слој за апстракција на складирање JavaScript, со опционално транспарентно шифрирање од страна на клиентот.
5
+
6
+ # Содржини
7
+ * [Зошто Mobiletto?](#Зошто-Mobiletto?)
8
+ * [Брз почеток](#Брз почеток)
9
+ * [Mobiletto CLI](#mobiletto-cli)
10
+ * [Извор](#Извор)
11
+ * [Инсталација](#Инсталација)
12
+ * [Поддршка и финансирање](#Support-and-Funding)
13
+ * [Основна употреба](#Основна употреба)
14
+ * [Метаподатоци](#Метаподатоци)
15
+ * [Стил на алтернативен увоз](#Алтернативен стил на увоз)
16
+ * [Кеширање](#Кеширање)
17
+ * [Rirroring](# Mirroring)
18
+ * [Транспарентно шифрирање](#Transparent-енкрипција)
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
+ * Редис кеш: и овозможено и оневозможено
86
+
87
+ Овој пристап ни дава мир на умот дека mobiletto ќе се однесува исто без оглед на тоа кој драјвер го користите.
88
+ и без разлика дали ќе овозможите кеширање и/или шифрирање.
89
+
90
+ ### Поддршка за возачот
91
+ Тековни драјвери за складирање на Mobiletto:
92
+ * `s3` : Amazon S3
93
+ * `b2` : Backblaze B2
94
+ * `local` : локален датотечен систем
95
+
96
+ *Придонесите за поддршка на повеќе даватели на складирање облак се многу добредојдени!*
97
+
98
+ ## мобилен за-кли
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">redis</a> .
295
+
296
+ Mobiletto ќе се обиде да се поврзе со примерок од redis на 127.0.0.1:6379
297
+
298
+ Можете да отфрлите било кое од овие:
299
+ * Поставете го `MOBILETTO_REDIS_HOST` env var, mobile за да се поврзете овде наместо локален хост
300
+ * Поставете го `MOBILETTO_REDIS_PORT` env var, оваа порта ќе се користи
301
+
302
+ Mobiletto ќе ги складира сите свои копчиња за редиис со префиксот `_mobiletto__` . Можете да го промените ова
303
+ со поставување на `MOBILETTO_REDIS_PREFIX` env 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
+ ### Не сакате редиза кеширање?
317
+ За да се оневозможи: поминете `enabled: false` “ во вашиот објект `opts.redisConfig` кога ќе ја воспоставите вашата врска.
318
+
319
+ Како што беше дискутирано подолу, оневозможувањето на кеширањето ќе има негативен ефект врз перформансите и ќе предизвика повеќе барања
320
+ за складирање што навистина ви треба.
321
+
322
+ ### Насоки за кеширање
323
+ **Шифрирано складирање**: читањето/пишувањето шифрирана меморија е само малку побавно од нормалното,
324
+ но навигацијата низ директориуми (што некои работи го прават) е прилично скапо. Користење на кеш на редиза
325
+ ќе ви даде значително зголемување на перформансите.
326
+
327
+ Стандардниот кеш е безбеден, но не функционира добро ако имате многу операции за пишување/отстранување.
328
+ Секоја операција за запишување или отстранување го поништува целиот кеш, осигурувајќи дека следните читања ќе го видат
329
+ најновите промени.
330
+
331
+ ### CLI алатки
332
+ Ако користите CLI алатка како [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
333
+ дефинитивно ќе сакате да е овозможен кешот за редиис, бидејќи трае низ повикувањата на командата `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` врши еднократна копија на сите датотеки од еден мобилен на друг.
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
+ читателот и кој е писателот. Замислете го како изјава за задача: „мобилното лево“
359
+ е она на кое му е доделено (напишани се огледални податоци), и „десниот мобилен телефон“ (на
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
+ директориум (познат како дирент директориум).
384
+ * Командата `list` чита датотеките за влез во директориумот, ја дешифрира секоја наведена патека; потоа враќа метаподатоци за секоја датотека
385
+ * `list` се понеефикасни, особено за директориуми со голем број датотеки
386
+ * Командата `write` запишува дирентни датотеки во дирент директориумот на секој родител, рекурзивно; потоа ја пишува датотеката
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
+ Создадете мобилно со вашиот нов клуч, а потоа пресликувајте ги старите податоци во него:
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` “ , својствата `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` , иако моментално е мобилно
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>