mobiletto 1.1.10 → 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 (116) hide show
  1. package/README.md +48 -0
  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 +7 -2
  114. package/package.json +1 -1
  115. package/test/api.spec.js +12 -9
  116. package/util/redis.js +1 -1
@@ -0,0 +1,455 @@
1
+ Mobiletto
2
+ =========
3
+
4
+ Mobiletto isteğe bağlı şəffaf müştəri tərəfi şifrələməsi ilə JavaScript yaddaş abstraksiya qatıdır.
5
+
6
+ # Məzmun
7
+ * [Niyə Mobiletto?](#Why-Mobiletto?)
8
+ * [Quick start](#Quick-start)
9
+ * [Mobiletto CLI](#mobiletto-cli)
10
+ * [Mənbə](#Mənbə)
11
+ * [Əsas istifadə](#Basic-istifadə)
12
+ * [Metadata](#Metadata)
13
+ * [Alternativ idxal üslubu](#Alternativ idxal stili)
14
+ * [Keşləmə](#Keşləmə)
15
+ * [Yansıtma](#Aynatma)
16
+ * [Şəffaf şifrələmə](#Şəffaf-şifrələmə)
17
+ * [Açarların fırlanması](#Açarların fırlanması)
18
+ * [Sürücü interfeysi](#Sürücü interfeysi)
19
+ * [Giriş](#Giriş)
20
+
21
+ # Bunu başqa dildə oxuyun
22
+ Bu README.md sənədi [hokeylization](https://github.com/cobbzilla/hokeylization) vasitəsilə tərcümə olunub
23
+ **[Google Translate tərəfindən dəstəklənən bütün dillər](https://cloud.google.com/translate/docs/languages)!**
24
+
25
+ Əminəm ki, mükəmməl deyil, amma ümid edirəm ki, heç nədən yaxşıdır!
26
+
27
+ [🇸🇦 Ərəb](../ar/README.md)
28
+ [🇧🇩 Benqal dili](../bn/README.md)
29
+ [🇩🇪 Almanca](../de/README.md)
30
+ [🇺🇸 İngilis dili](../en/README.md)
31
+ [🇪🇸 İspan](../es/README.md)
32
+ [🇫🇷 Fransızca](../fr/README.md)
33
+ [🇹🇩 Hausa](../ha/README.md)
34
+ [🇮🇳 Hindi](../hi/README.md)
35
+ [🇮🇩 İndoneziya dili](../id/README.md)
36
+ [🇮🇹 İtalyanca](../it/README.md)
37
+ [🇯🇵 Yapon](../ja/README.md)
38
+ [🇰🇷 Koreya](../ko/README.md)
39
+ [🇮🇳 Maranthi](../mr/README.md)
40
+ [🇵🇱 Polyak](../pl/README.md)
41
+ [🇧🇷 Portuqal dili](../pt/README.md)
42
+ [🇷🇺 Rus dili](../ru/README.md)
43
+ [🇰🇪 Suahili](../sw/README.md)
44
+ [🇵🇭 Taqaloq](../tl/README.md)
45
+ [🇹🇷 Türkcə](../tr/README.md)
46
+ [🇵🇰 Urdu](../ur/README.md)
47
+ [🇻🇳 Vyetnam dili](../vi/README.md)
48
+ [🇨🇳 Çin](../zh/README.md)
49
+
50
+
51
+ **[📚 ... Bütün Dillər ...](../README.md)**
52
+ ----
53
+
54
+ ### README-nin bu tərcüməsində problem varmı?
55
+ Orijinalın bu xüsusi tərcüməsi [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
56
+ qüsurlu ola bilər -- *düzəlişlər çox xoşdur!* Lütfən, [GitHub-da çəkmə sorğusu] göndərin (https://github.com/cobbzilla/mobiletto/pulls),
57
+ və ya bunu etməkdə rahat deyilsinizsə, [məsələ açın](https://github.com/cobbzilla/mobiletto/issues)
58
+
59
+ Tərcümə ilə bağlı yeni GitHub məsələsi yaratdığınız zaman, lütfən:
60
+ * səhifənin URL-ni daxil edin (brauzerin ünvan çubuğundan kopyalayın/yapışdırın)
61
+ * səhv olan mətni daxil edin (brauzerdən kopyalayın/yapışdırın)
62
+ * zəhmət olmasa nəyin səhv olduğunu təsvir edin -- tərcümə səhvdir? formatlama birtəhər pozuldu?
63
+ * lütfən daha yaxşı tərcümə təklifi və ya mətnin düzgün formatlaşdırılması ilə bağlı təklif verin
64
+ * **Çox sağ ol!**
65
+
66
+ ## Niyə Mobiletto?
67
+
68
+ ### Əlvida satıcı kilidi!
69
+ Müxtəlif bulud saxlama təminatçıları uyğun olmayan API-lərə malikdir. Hətta "S3 uyğunluğu" üçün səy göstərənlər
70
+ özünəməxsus davranışlara malikdir.
71
+
72
+ Tətbiqiniz üçün xüsusi yaddaş təchizatçısı seçdiyiniz zaman, birbaşa onların API-sinə kodlasanız, tətbiqiniz
73
+ indi həmin xidmətdən asılıdır. Zaman keçdikcə və kod yığıldıqca dəyişən satıcılar olur
74
+ getdikcə dözülməz olur. Satıcı kilidinin əyləncəli dünyasına xoş gəlmisiniz!
75
+
76
+ Mobiletto bu problemi həll etmək üçün hazırlanmışdır. Tətbiqinizi mobiletto-nun API-yə kodlaşdırmaqla siz asanlıqla edə bilərsiniz
77
+ yaddaş provayderlərini dəyişdirin və tətbiqinizin yaddaş təbəqəsinin eyni şəkildə davranacağını bilin.
78
+
79
+ ### Geniş sınaq
80
+ Bütün sürücülər hər bir sürücü üçün 60+ testlə eyni davranış üçün sınaqdan keçirilir.
81
+ Biz bütün sürücüləri hər kombinasiya ilə sınaqdan keçiririk:
82
+ * Şifrələmə: həm aktiv, həm də əlil
83
+ * Redis keşi: həm aktiv, həm də qeyri-aktivdir
84
+
85
+ Bu yanaşma bizə rahatlıq verir ki, hansı sürücüdən istifadə etməyinizdən asılı olmayaraq mobiletto eyni davranacaq.
86
+ və keşləmə və/yaxud şifrələməni aktiv edib etməməyinizdən asılı olmayaraq.
87
+
88
+ ### Sürücü dəstəyi
89
+ Cari Mobiletto yaddaş sürücüləri:
90
+ * `s3` : Amazon S3
91
+ * `b2` : arxa yanma B2
92
+ * `local` : yerli fayl sistemi
93
+
94
+ *Daha çox bulud saxlama təminatçılarını dəstəkləmək üçün töhfələr çox xoşdur!*
95
+
96
+ ## mobiletto-cli
97
+ Mobiletto digər JavaScript kodu ilə kitabxana kimi istifadə olunmaq üçün nəzərdə tutulub.
98
+
99
+ Komanda xəttində mobiletto ilə işləmək üçün [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli) istifadə edin.
100
+
101
+ ## Mənbə
102
+ * [GitHub-da mobiletto](https://github.com/cobbzilla/mobiletto)
103
+ * [npm-də mobiletto](https://www.npmjs.com/package/mobiletto)
104
+
105
+ ## Tez Başlanğıc
106
+ mobiletto `s3` sürücüsündən istifadə edən qısa bir nümunə.
107
+
108
+ Sürücü `b2` və ya `local` olsaydı, bu kod eyni işləyəcəkdi.
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
+ ## Əsas istifadə
139
+ Təklif olunan xüsusiyyətlərin əksəriyyətini göstərən daha geniş bir nümunə:
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
+ ## Metadata
241
+ `metadata` əmri bir fayl sistemi girişi haqqında metadata qaytarır.
242
+ Eynilə, `list` əmrindən qaytarılan dəyər metadata obyektlərinin massividir.
243
+
244
+ Metadata obyekti belə görünür:
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` xüsusiyyəti `file` , `dir` , `link` və ya `special` ola bilər.
255
+
256
+ Sürücünün növündən asılı olaraq, `list` əmri bütün sahələri qaytarmaya bilər. `name` və `type` xassələri
257
+ həmişə mövcud olmalıdır. Sonrakı `metadata` əmri bütün mövcud xassələri qaytaracaq.
258
+
259
+ ## Alternativ idxal üslubu
260
+ Tam əhatəli modulu idxal edin və `connect` funksiyasından istifadə edin:
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
+ ## Keşləmə
268
+ Mobiletto <a href="https://redis.io">redis</a> keşi ilə yaxşı işləyir.
269
+
270
+ Mobiletto 127.0.0.1:6379-da redis instansiyasına qoşulmağa çalışacaq.
271
+
272
+ Bunlardan hər hansı birini ləğv edə bilərsiniz:
273
+ * Localhost əvəzinə buraya qoşulmaq üçün `MOBILETTO_REDIS_HOST` var, mobilet seçin
274
+ * `MOBILETTO_REDIS_PORT` var seçin, bu port istifadə olunacaq
275
+
276
+ Mobiletto bütün redis açarlarını `_mobiletto__` prefiksi ilə saxlayacaq. Bunu dəyişə bilərsiniz
277
+ `MOBILETTO_REDIS_PREFIX` var.
278
+
279
+ Siz həmçinin `opts.redisConfig` obyekti ilə hər qoşulma keşini təyin edə bilərsiniz:
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 caching istəmirsiniz?
291
+ Deaktiv etmək üçün `opts.redisConfig` obyektinizdə `enabled: false` ' düyməsini keçirin.
292
+
293
+ Aşağıda müzakirə edildiyi kimi, keşləşdirməni söndürmək performansa mənfi təsir göstərəcək və daha çox sorğuya səbəb olacaq
294
+ həqiqətən ehtiyacınız olan saxlama üçün.
295
+
296
+ ### Keşləmə təlimatı
297
+ **Şifrələnmiş yaddaş**: şifrələnmiş yaddaşın oxunması/yazılması normaldan bir qədər yavaşdır,
298
+ lakin kataloqlar ətrafında naviqasiya (bəzi şeylər bunu edir) kifayət qədər bahalıdır. Redis keşindən istifadə
299
+ sizə əhəmiyyətli performans təkan verəcək.
300
+
301
+ Defolt keş təhlükəsizdir, lakin çoxlu yazma/silmə əməliyyatlarınız varsa, yaxşı işləmir.
302
+ İstənilən yazma və ya silmə əməliyyatı bütün önbelleği etibarsız edir və sonrakı oxunuşların görəcəyini təmin edir
303
+ son dəyişikliklər.
304
+
305
+ ### CLI alətləri
306
+ Əgər [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli) kimi bir CLI alətindən istifadə edirsinizsə,
307
+ siz mütləq redis keşinin aktiv olmasını istəyəcəksiniz, çünki o, `mo` əmrinin çağırışları arasında davam edir.
308
+
309
+ ## Yansıtma
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` əmri bütün faylların bir mobildən digərinə birdəfəlik surətini çıxarır.
318
+ Zamanla güzgü saxlamaq üçün heç bir proses işlətmir. `mirror` əmrini yenidən yerinə yetirin
319
+ itkin faylları sinxronlaşdırmaq üçün.
320
+
321
+ `mirror` -dən qaytarılan dəyər neçə faylın uğurla alındığını göstərən sayğacları olan sadə obyektdir
322
+ yansıtılmış və neçə faylda xəta var:
323
+
324
+ {
325
+ success: count-of-files-mirrored,
326
+ errors: count-of-files-with-errors
327
+ }
328
+
329
+ XƏBƏRDARLIQ: Böyük məlumat dəstlərinin əks etdirilməsi çox vaxt aparan və bant genişliyi tələb edə bilər
330
+
331
+ `mirror` çağırış semantikası ilə kimin olduğunu anlamaq bəzən çaşqın ola bilər
332
+ oxucu və yazıçı kimdir. Bunu bir tapşırıq bəyanatı kimi təsəvvür edin: "sol əl mobiltto"
333
+ təyin olunan şeydir (yazılan güzgü məlumatı) və "sağ tərəfdən mobiletto" (
334
+ `mirror` metodunun arqumenti) təyin olunan dəyərdir (güzgü məlumatı oxunur).
335
+
336
+ ## Şəffaf şifrələmə
337
+ Müştəri tərəfində şəffaf şifrələməni aktivləşdirin:
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
+ Nə baş verir? Ayrı bir "kataloq girişi" (birbaşa) kataloq (şifrlənmiş) orada hansı faylların olduğunu izləyir
357
+ kataloq (aka dirent kataloq).
358
+ * `list` əmri kataloqa daxil olan faylları oxuyur, sadalanan hər yolun şifrəsini açır; sonra hər bir fayl üçün metadata qaytarır
359
+ * `list` əmrləri xüsusilə çox sayda faylı olan qovluqlar üçün daha səmərəsizdir
360
+ * `write` əmri rekursiv şəkildə hər bir valideynin dirent kataloquna dirent faylları yazır; sonra faylı yazır
361
+ * `write` əmrləri qovluq iyerarxiyasında N = dərinlik ilə O(N) yazılarına səbəb olacaq
362
+ * `remove` əmri müvafiq dirent faylı və onun əsas faylını boşdursa, rekursiv şəkildə silir; sonra faylı silir
363
+ * Qeyri-rekursiv `remove` əmrləri O(N) oxumağa və potensial olaraq bir o qədər çox silməyə səbəb olacaq, N = kataloq iyerarxiyasında dərinlik
364
+ * Böyük və dərin fayl sistemlərində `remove` əmrləri bahalı ola bilər
365
+
366
+ Nəzərə alın ki, hətta müştəri tərəfində şifrələmə aktiv olsa belə, şifrələnmiş server tərəfinizdə tam görünən bir rəqib
367
+ yaddaş, açar olmadan belə, yenə də qovluqların ümumi sayını və hər birində neçə fayl olduğunu görə bilər
368
+ bir az səy göstərin, kataloq iyerarxiyasının ümumi strukturunun bir hissəsini və ya hamısını kəşf edin.
369
+ *Qeyd: Daha yaxşı təhlükəsizlik üçün nisbətən düz strukturdan istifadə edin.*
370
+ Rəqib şifrləmənizi bilməsə, kataloqların/faylların adlarını bilməyəcək
371
+ açarı və ya şifrələməni müvəffəqiyyətlə sındırıb. O zaman bütün mərclər dayandırılır!
372
+
373
+ ### Performans və keşləmə
374
+ Şifrələnmiş yaddaşda əməliyyatlar yavaş ola bilər. Rekursiv siyahılar və silinmələr çox yavaş ola bilər.
375
+ Redis vasitəsilə keşləmə çox kömək edir, lakin qeyd edin ki, hər hansı yazı və ya silinmə zamanı keş silinir.
376
+
377
+ ## Açarın fırlanması
378
+ Yeni açarınızla mobiletto yaradın, sonra köhnə məlumatları ona əks etdirin:
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
+ ## Sürücü interfeysi
391
+ Sürücü bu imza ilə 'storageClient' funksiyasını ixrac edən istənilən JS faylıdır:
392
+
393
+ function storageClient (key, secret, opts)
394
+
395
+ * `key` : sətir, sizin API açarınız ( `local` sürücü üçün bu əsas kataloqdur)
396
+ * `secret` : sətir, sizin API sirriniz ( `local` sürücü üçün buraxıla bilər)
397
+ * `opts` : obyekt, xassələr hər sürücü üçün:
398
+ * `local` üçün `fileMode` və `dirMode` xassələri yeni yaradılan fayl və qovluqların necə yaradıldığını müəyyən edir.
399
+ * `s3` üçün `bucket` xüsusiyyəti tələb olunur. İsteğe bağlı xüsusiyyətlər bunlardır:
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 funksiyasının qaytardığı obyekt bu funksiyaları müəyyən etməlidir:
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
+ ## Giriş
431
+ Mobiletto [winston](https://www.npmjs.com/package/winston) giriş kitabxanasından istifadə edir.
432
+
433
+ Qeydlər **fayl yollarını və səhv mesajlarını ehtiva edəcək, lakin **heç vaxt** açarları, sirləri,
434
+ və ya hər hansı digər əlaqə konfiqurasiyası məlumatı.
435
+
436
+ ### Qeyd səviyyəsi
437
+ Birindən istifadə edərək jurnal səviyyəsini təyin etmək üçün `MOBILETTO_LOG_LEVEL` mühit dəyişənindən istifadə edin
438
+ [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels) saytında müəyyən edilmiş `npm` səviyyələrinin
439
+
440
+ Defolt səviyyə `error` . Hal-hazırda mobiletto olsa da, ən ətraflı səviyyə `silly` '
441
+ `debug` aşağı səviyyələrdə daxil olmur
442
+
443
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
444
+
445
+ ### Günlük faylı
446
+ Varsayılan olaraq, logger konsola yazır. Qeydləri fayla göndərmək üçün `MOBILETTO_LOG_FILE`
447
+ mühit dəyişəni. Fayla daxil olarkən qeydlər artıq konsola yazılmayacaq.
448
+
449
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
450
+
451
+ Girişi söndürmək üçün:
452
+
453
+ MOBILETTO_LOG_FILE=/dev/null
454
+
455
+ </pre>