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.
- package/README.md +48 -0
- package/docs/README.md +113 -0
- package/docs/af/README.md +455 -0
- package/docs/am/README.md +455 -0
- package/docs/ar/README.md +455 -0
- package/docs/az/README.md +455 -0
- package/docs/be/README.md +455 -0
- package/docs/bg/README.md +455 -0
- package/docs/bn/README.md +455 -0
- package/docs/bs/README.md +455 -0
- package/docs/ca/README.md +455 -0
- package/docs/ceb/README.md +455 -0
- package/docs/co/README.md +455 -0
- package/docs/cs/README.md +455 -0
- package/docs/cy/README.md +455 -0
- package/docs/da/README.md +455 -0
- package/docs/de/README.md +455 -0
- package/docs/el/README.md +455 -0
- package/docs/eo/README.md +455 -0
- package/docs/es/README.md +455 -0
- package/docs/et/README.md +455 -0
- package/docs/eu/README.md +455 -0
- package/docs/fa/README.md +455 -0
- package/docs/fi/README.md +455 -0
- package/docs/fr/README.md +455 -0
- package/docs/fy/README.md +455 -0
- package/docs/ga/README.md +455 -0
- package/docs/gd/README.md +455 -0
- package/docs/gl/README.md +455 -0
- package/docs/gu/README.md +455 -0
- package/docs/ha/README.md +455 -0
- package/docs/haw/README.md +455 -0
- package/docs/he/README.md +455 -0
- package/docs/hi/README.md +455 -0
- package/docs/hmn/README.md +455 -0
- package/docs/hr/README.md +455 -0
- package/docs/ht/README.md +455 -0
- package/docs/hu/README.md +455 -0
- package/docs/hy/README.md +455 -0
- package/docs/id/README.md +455 -0
- package/docs/ig/README.md +455 -0
- package/docs/is/README.md +455 -0
- package/docs/it/README.md +455 -0
- package/docs/iw/README.md +455 -0
- package/docs/ja/README.md +455 -0
- package/docs/jv/README.md +455 -0
- package/docs/ka/README.md +455 -0
- package/docs/kk/README.md +455 -0
- package/docs/km/README.md +455 -0
- package/docs/kn/README.md +455 -0
- package/docs/ko/README.md +455 -0
- package/docs/ku/README.md +455 -0
- package/docs/ky/README.md +455 -0
- package/docs/la/README.md +455 -0
- package/docs/lb/README.md +455 -0
- package/docs/lo/README.md +455 -0
- package/docs/lt/README.md +455 -0
- package/docs/lv/README.md +455 -0
- package/docs/mg/README.md +455 -0
- package/docs/mi/README.md +455 -0
- package/docs/mk/README.md +455 -0
- package/docs/ml/README.md +455 -0
- package/docs/mn/README.md +455 -0
- package/docs/mr/README.md +455 -0
- package/docs/ms/README.md +455 -0
- package/docs/mt/README.md +455 -0
- package/docs/my/README.md +455 -0
- package/docs/ne/README.md +455 -0
- package/docs/nl/README.md +455 -0
- package/docs/no/README.md +455 -0
- package/docs/ny/README.md +455 -0
- package/docs/or/README.md +455 -0
- package/docs/pa/README.md +455 -0
- package/docs/pl/README.md +455 -0
- package/docs/ps/README.md +455 -0
- package/docs/pt/README.md +455 -0
- package/docs/ro/README.md +455 -0
- package/docs/ru/README.md +455 -0
- package/docs/rw/README.md +455 -0
- package/docs/sd/README.md +455 -0
- package/docs/si/README.md +455 -0
- package/docs/sk/README.md +455 -0
- package/docs/sl/README.md +455 -0
- package/docs/sm/README.md +455 -0
- package/docs/sn/README.md +455 -0
- package/docs/so/README.md +455 -0
- package/docs/sq/README.md +455 -0
- package/docs/sr/README.md +455 -0
- package/docs/st/README.md +455 -0
- package/docs/su/README.md +455 -0
- package/docs/sv/README.md +455 -0
- package/docs/sw/README.md +455 -0
- package/docs/ta/README.md +455 -0
- package/docs/te/README.md +455 -0
- package/docs/tg/README.md +455 -0
- package/docs/th/README.md +455 -0
- package/docs/tk/README.md +455 -0
- package/docs/tl/README.md +455 -0
- package/docs/tr/README.md +455 -0
- package/docs/tt/README.md +455 -0
- package/docs/ug/README.md +455 -0
- package/docs/uk/README.md +455 -0
- package/docs/ur/README.md +455 -0
- package/docs/uz/README.md +455 -0
- package/docs/vi/README.md +455 -0
- package/docs/xh/README.md +455 -0
- package/docs/yi/README.md +455 -0
- package/docs/yo/README.md +455 -0
- package/docs/zh/README.md +455 -0
- package/docs/zu/README.md +455 -0
- package/drivers/b2/index.js +24 -6
- package/hokey.json +16 -0
- package/index.js +7 -2
- package/package.json +1 -1
- package/test/api.spec.js +12 -9
- package/util/redis.js +1 -1
|
@@ -0,0 +1,455 @@
|
|
|
1
|
+
Mobiletto
|
|
2
|
+
=========
|
|
3
|
+
|
|
4
|
+
Mobiletto-ն JavaScript-ի պահեստավորման աբստրակցիոն շերտ է՝ հաճախորդի կողմից ընտրովի թափանցիկ գաղտնագրմամբ:
|
|
5
|
+
|
|
6
|
+
# Բովանդակություն
|
|
7
|
+
* [Ինչու Mobiletto?](#Ինչու-Mobiletto?)
|
|
8
|
+
* [Արագ մեկնարկ](#Quick-start)
|
|
9
|
+
* [Mobiletto CLI](#mobiletto-cli)
|
|
10
|
+
* [Աղբյուր](#Աղբյուր)
|
|
11
|
+
* [Հիմնական օգտագործում](#Հիմնական-օգտագործում)
|
|
12
|
+
* [Մետտվյալներ](#Մետտվյալներ)
|
|
13
|
+
* [Այլընտրանքային ներմուծման ոճ](#Alternate-import-style)
|
|
14
|
+
* [Caching](#Caching)
|
|
15
|
+
* [Mirroring](#Mirroring)
|
|
16
|
+
* [Թափանցիկ կոդավորում](#Transparent-encryption)
|
|
17
|
+
* [Բանալինների ռոտացիա](#Բանալին-պտտում)
|
|
18
|
+
* [Driver ինտերֆեյս](#Driver-interface)
|
|
19
|
+
* [Գրանցում](#Գրանցում)
|
|
20
|
+
|
|
21
|
+
# Կարդացեք սա այլ լեզվով
|
|
22
|
+
Այս README.md փաստաթուղթը թարգմանվել է [hokeylization](https://github.com/cobbzilla/hokeylization) միջոցով
|
|
23
|
+
**[Google Translate-ի կողմից աջակցվող յուրաքանչյուր լեզու](https://cloud.google.com/translate/docs/languages)!**
|
|
24
|
+
|
|
25
|
+
Ես վստահ եմ, որ դա կատարյալ չէ, բայց հուսով եմ, որ ավելի լավ է, քան ոչինչ:
|
|
26
|
+
|
|
27
|
+
[🇸🇦 արաբերեն](../ar/README.md)
|
|
28
|
+
[🇧🇩 բենգալերեն](../bn/README.md)
|
|
29
|
+
[🇩🇪 գերմաներեն](../de/README.md)
|
|
30
|
+
[🇺🇸 Անգլերեն](../en/README.md)
|
|
31
|
+
[🇪🇸 իսպաներեն](../es/README.md)
|
|
32
|
+
[🇫🇷 ֆրանսերեն](../fr/README.md)
|
|
33
|
+
[🇹🇩 Հաուսա](../ha/README.md)
|
|
34
|
+
[🇮🇳 հինդի](../hi/README.md)
|
|
35
|
+
[🇮🇩 ինդոնեզերեն](../id/README.md)
|
|
36
|
+
[🇮🇹 Իտալերեն](../it/README.md)
|
|
37
|
+
[🇯🇵 ճապոներեն](../ja/README.md)
|
|
38
|
+
[🇰🇷 կորեերեն](../ko/README.md)
|
|
39
|
+
[🇮🇳 Մարանտի](../mr/README.md)
|
|
40
|
+
[🇵🇱 լեհերեն](../pl/README.md)
|
|
41
|
+
[🇧🇷 պորտուգալերեն](../pt/README.md)
|
|
42
|
+
[🇷🇺 ռուսերեն](../ru/README.md)
|
|
43
|
+
[🇰🇪 Սուահիլի](../sw/README.md)
|
|
44
|
+
[🇵🇭 Տագալերեն](../tl/README.md)
|
|
45
|
+
[🇹🇷 թուրքերեն](../tr/README.md)
|
|
46
|
+
[🇵🇰 ուրդու](../ur/README.md)
|
|
47
|
+
[🇻🇳 Վիետնամերեն](../vi/README.md)
|
|
48
|
+
[🇨🇳 չինարեն](../zh/README.md)
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
**[📚 ... Բոլոր լեզուները ...](../README.md)**
|
|
52
|
+
----
|
|
53
|
+
|
|
54
|
+
### Խնդիր կա՞ README-ի այս թարգմանության հետ:
|
|
55
|
+
Բնօրինակի այս հատուկ թարգմանությունը [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
|
|
56
|
+
կարող է թերի լինել.
|
|
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 cache. և՛ միացված, և՛ անջատված
|
|
84
|
+
|
|
85
|
+
Այս մոտեցումը մեզ հանգիստ է տալիս, որ mobiletto-ն կվարվի նույն կերպ՝ անկախ նրանից, թե որ վարորդից եք դուք օգտագործում,
|
|
86
|
+
և անկախ նրանից՝ միացնու՞մ եք քեշավորումը և/կամ կոդավորումը:
|
|
87
|
+
|
|
88
|
+
### Վարորդի աջակցություն
|
|
89
|
+
Ընթացիկ Mobiletto պահեստավորման դրայվերներ.
|
|
90
|
+
* `s3` : Amazon S3
|
|
91
|
+
* `b2` : Backblaze B2
|
|
92
|
+
* `local` տեղական»՝ տեղական ֆայլային համակարգ
|
|
93
|
+
|
|
94
|
+
*Ավելի շատ ամպային պահեստավորման մատակարարներին աջակցելու ներդրումները շատ ողջունելի են:*
|
|
95
|
+
|
|
96
|
+
## mobiletto-cli
|
|
97
|
+
Mobiletto-ն նախատեսված է որպես գրադարան օգտագործելու այլ JavaScript կոդով:
|
|
98
|
+
|
|
99
|
+
Mobiletto-ի հետ հրամանի տողում աշխատելու համար օգտագործեք [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
|
|
100
|
+
|
|
101
|
+
## Աղբյուր
|
|
102
|
+
* [mobiletto GitHub-ում](https://github.com/cobbzilla/mobiletto)
|
|
103
|
+
* [mobiletto 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` 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> cache-ով:
|
|
269
|
+
|
|
270
|
+
Mobiletto-ն կփորձի միանալ redis օրինակին 127.0.0.1:6379
|
|
271
|
+
|
|
272
|
+
Դուք կարող եք վերացնել հետևյալներից որևէ մեկը.
|
|
273
|
+
* Սահմանեք `MOBILETTO_REDIS_HOST` env var, mobile-ը, որպեսզի միանաք այստեղ՝ localhost-ի փոխարեն
|
|
274
|
+
* Սահմանեք `MOBILETTO_REDIS_PORT` env var, այս պորտը կօգտագործվի
|
|
275
|
+
|
|
276
|
+
Mobiletto-ն կպահի իր բոլոր redis ստեղները `_mobiletto__` » նախածանցով: Դուք կարող եք փոխել սա
|
|
277
|
+
սահմանելով `MOBILETTO_REDIS_PREFIX` env var.
|
|
278
|
+
|
|
279
|
+
Դուք կարող եք նաև սահմանել յուրաքանչյուր կապի քեշավորում `opts.redisConfig` օբյեկտի միջոցով.
|
|
280
|
+
|
|
281
|
+
const redisConfig = {
|
|
282
|
+
enabled: true, // optional, default is true. if false other props are ignored
|
|
283
|
+
host: '127.0.0.1',
|
|
284
|
+
port: 6379,
|
|
285
|
+
prefix: '_mobiletto__'
|
|
286
|
+
}
|
|
287
|
+
const opts = { redisConfig, bucket: 'bk', region: 'us-east-1' }
|
|
288
|
+
const s3 = await storage.connect('s3', aws_key, aws_secret, opts)
|
|
289
|
+
|
|
290
|
+
### Չե՞ք ուզում redis caching:
|
|
291
|
+
Անջատելու համար անցեք « `enabled: false` : false» ձեր `opts.redisConfig` օբյեկտում, երբ հաստատում եք ձեր կապը:
|
|
292
|
+
|
|
293
|
+
Ինչպես քննարկվում է ստորև, քեշավորման անջատումն անբարենպաստ ազդեցություն կունենա կատարողականի վրա և կառաջացնի ավելի շատ հարցումներ
|
|
294
|
+
պահեստ, որն իսկապես անհրաժեշտ է:
|
|
295
|
+
|
|
296
|
+
### Քեշավորման ուղեցույց
|
|
297
|
+
**Կոդավորված պահեստավորում**. գաղտնագրված պահեստը կարդալը/գրելը սովորականից մի փոքր ավելի դանդաղ է,
|
|
298
|
+
բայց գրացուցակներում նավարկելը (ինչը որոշ բաներ անում են) բավականին թանկ է: Օգտագործելով redis քեշ
|
|
299
|
+
ձեզ կտա կատարողականության զգալի խթան:
|
|
300
|
+
|
|
301
|
+
Լռելյայն քեշը անվտանգ է, բայց լավ չի աշխատում, եթե դուք ունեք բազմաթիվ գրելու/հեռացնելու գործողություններ:
|
|
302
|
+
Գրելու կամ հեռացնելու ցանկացած գործողություն անվավեր է դարձնում ամբողջ քեշը, ապահովելով, որ հետագա ընթերցումները կտեսնեն այն
|
|
303
|
+
վերջին փոփոխությունները.
|
|
304
|
+
|
|
305
|
+
### CLI գործիքներ
|
|
306
|
+
Եթե դուք օգտագործում եք CLI գործիք, ինչպիսին է [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
|
|
307
|
+
դուք անպայման կցանկանաք, որ redis `mo` հրամանի կանչերի ընթացքում:
|
|
308
|
+
|
|
309
|
+
## Հայելի
|
|
310
|
+
|
|
311
|
+
// Copy a local filesystem mobiletto to S3
|
|
312
|
+
s3.mirror(local)
|
|
313
|
+
|
|
314
|
+
// Mirror a local subdirectory from one mobiletto to an S3 mobiletto, with it's own subdirectory
|
|
315
|
+
local.mirror(s3, 'some/local-folder', 'some/s3-folder')
|
|
316
|
+
|
|
317
|
+
`mirror` հրամանը կատարում է բոլոր ֆայլերի մեկանգամյա պատճենումը մի բջջայինից մյուսը:
|
|
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
|
+
Ինչ է կատարվում? Առանձին «տեղեկատու մուտք» (dirent) գրացուցակ (գաղտնագրված) հետևում է, թե ինչ ֆայլեր կան դրանում
|
|
357
|
+
գրացուցակ (aka dirent directory):
|
|
358
|
+
* `list` հրամանը կարդում է գրացուցակի մուտքագրման ֆայլերը, վերծանում նշված յուրաքանչյուր ուղի; այնուհետև վերադարձնում է մետատվյալներ յուրաքանչյուր ֆայլի համար
|
|
359
|
+
* `list` հրամաններն ավելի անարդյունավետ են, հատկապես մեծ թվով ֆայլեր ունեցող դիրեկտորիաների համար
|
|
360
|
+
* `write` » հրամանը գրում է dirent ֆայլեր յուրաքանչյուր ծնողի dirent գրացուցակում, ռեկուրսիվ կերպով; ապա գրում է ֆայլը
|
|
361
|
+
* `write` հրամանները կառաջացնեն O(N) գրություններ՝ N = խորությունը գրացուցակի հիերարխիայում
|
|
362
|
+
* `remove` հրամանը հեռացնում է համապատասխան dirent ֆայլը, իսկ դրա մայրը, եթե դատարկ է, ռեկուրսիվ կերպով; ապա հեռացնում է ֆայլը
|
|
363
|
+
* Ոչ ռեկուրսիվ `remove` հրամանները կունենան O(N) ընթերցումներ և հնարավոր է նույնքան ջնջումներ՝ N = խորությունը գրացուցակի հիերարխիայում:
|
|
364
|
+
* Մեծ և խորը ֆայլային համակարգերի ռեկուրսիվ `remove` հրամանները կարող են թանկ լինել
|
|
365
|
+
|
|
366
|
+
Նկատի ունեցեք, որ նույնիսկ հաճախորդի կողմից գաղտնագրումը միացված լինելու դեպքում հակառակորդը լիովին տեսանելի է ձեր գաղտնագրված սերվերի կողմից
|
|
367
|
+
պահեստավորումը, նույնիսկ առանց բանալիի, դեռ կարող է տեսնել դիրեկտորիաների ընդհանուր թիվը և քանի ֆայլ կա յուրաքանչյուրում և դրանցով
|
|
368
|
+
որոշ ջանքեր, հայտնաբերեք գրացուցակի հիերարխիայի ընդհանուր կառուցվածքի մի մասը կամ ամբողջը:
|
|
369
|
+
*Նշում. Ավելի լավ անվտանգության համար օգտագործեք համեմատաբար հարթ կառուցվածք:*
|
|
370
|
+
Հակառակորդը չի իմանա դիրեկտորիաների/ֆայլերի անունները, եթե նրանք նաև իմանան ձեր գաղտնագրումը
|
|
371
|
+
բանալին կամ այլ կերպ հաջողությամբ կոտրել է կոդավորումը: Այդ դեպքում բոլոր խաղադրույքներն անջատված են:
|
|
372
|
+
|
|
373
|
+
### Կատարում և քեշավորում
|
|
374
|
+
Գաղտնագրված պահեստում գործողությունները կարող են դանդաղ լինել: Ռեկուրսիվ ցուցակները և հեռացումները կարող են շատ դանդաղ լինել:
|
|
375
|
+
Redis-ի միջոցով քեշավորումն անչափ օգնում է, բայց նկատի ունեցեք, որ քեշը մաքրվում է ցանկացած գրառման կամ հեռացման դեպքում:
|
|
376
|
+
|
|
377
|
+
## Ստեղների ռոտացիա
|
|
378
|
+
Ստեղծեք բջջային հեռախոս ձեր նոր բանալիով, այնուհետև դրա մեջ արտացոլեք հին տվյալները.
|
|
379
|
+
|
|
380
|
+
const storage = require('mobiletto')
|
|
381
|
+
|
|
382
|
+
const oldEncryption = { key: .... }
|
|
383
|
+
const oldStorage = await storage.connect('s3', aws_key, aws_secret, {bucket: 'bk', region: 'us-east-1'}, oldEncryption)
|
|
384
|
+
|
|
385
|
+
const newEncryption = { key: .... }
|
|
386
|
+
const newStorage = await storage.connect('s3', aws_key, aws_secret, {bucket: 'zz', region: 'us-east-1'}, newEncryption)
|
|
387
|
+
|
|
388
|
+
newStorage.mirror(oldStorage) // if oldStorage is very large, this may take a looooooong time...
|
|
389
|
+
|
|
390
|
+
## Վարորդի ինտերֆեյս
|
|
391
|
+
Վարորդը ցանկացած JS ֆայլ է, որն արտահանում է «storageClient» ֆունկցիա այս ստորագրությամբ.
|
|
392
|
+
|
|
393
|
+
function storageClient (key, secret, opts)
|
|
394
|
+
|
|
395
|
+
* `key` »՝ տող, ձեր API ստեղնը ( `local` վարորդի համար սա բազային գրացուցակն է)
|
|
396
|
+
* `secret` »՝ տող, ձեր API գաղտնիքը (կարելի է բաց թողնել `local` վարորդի համար)
|
|
397
|
+
* `opts` . օբյեկտ, հատկությունները յուրաքանչյուր վարորդի համար են.
|
|
398
|
+
* `local` » -ի համար `fileMode` և `dirMode` հատկությունները որոշում են, թե ինչպես են ստեղծվում նոր ֆայլեր և գրացուցակներ:
|
|
399
|
+
* `s3` »-ի համար պահանջվում է `bucket` հատկությունը: Ընտրովի հատկություններն են.
|
|
400
|
+
* `region`: the S3 region, default is us-east-1
|
|
401
|
+
* `prefix`: a prefix to prepend to all S3 paths, default is the empty string
|
|
402
|
+
* `delimiter`: the directory delimiter, default is '/'
|
|
403
|
+
|
|
404
|
+
Օբյեկտը, որը վերադարձնում է storageClient ֆունկցիան, պետք է սահմանի այս գործառույթները.
|
|
405
|
+
|
|
406
|
+
// Test the driver before using, ensure proper configuration
|
|
407
|
+
async testConfig ()
|
|
408
|
+
|
|
409
|
+
// List files in path (or from base-directory)
|
|
410
|
+
// If recursive is true, list recursively
|
|
411
|
+
// If visitor is defined, it will be an async function. await the visitor function on each file found
|
|
412
|
+
// Otherwise, perform the listing and return an array of objects
|
|
413
|
+
async list (path, recursive = false, visitor = null) // path may be omitted
|
|
414
|
+
|
|
415
|
+
// Read metadata for a path
|
|
416
|
+
async metadata (path)
|
|
417
|
+
|
|
418
|
+
// Read a file
|
|
419
|
+
// callback receives a chunk of data. endCallback is called at end-of-stream
|
|
420
|
+
async read (path, callback, endCallback = null)
|
|
421
|
+
|
|
422
|
+
// Write a file
|
|
423
|
+
// driver must be able to handle a generator or a stream
|
|
424
|
+
async write (path, generatorOrReadableStream)
|
|
425
|
+
|
|
426
|
+
// Remove a file, or recursively delete a directory
|
|
427
|
+
// returns a string of a single path removed, or an array of multiple paths removed
|
|
428
|
+
async remove (path, recursive = false, quiet = false)
|
|
429
|
+
|
|
430
|
+
## անտառահատումներ
|
|
431
|
+
Mobiletto-ն օգտագործում է [winston](https://www.npmjs.com/package/winston) գրանցման գրադարանը:
|
|
432
|
+
|
|
433
|
+
Գրանցամատյանները **** կպարունակեն ֆայլի ուղիներ և սխալի հաղորդագրություններ, բայց **երբեք** չեն պարունակի բանալիներ, գաղտնիքներ,
|
|
434
|
+
կամ կապի կազմաձևման որևէ այլ տեղեկատվություն:
|
|
435
|
+
|
|
436
|
+
### Մատյան մակարդակ
|
|
437
|
+
Օգտագործեք `MOBILETTO_LOG_LEVEL` միջավայրի փոփոխականը՝ գրանցամատյանի մակարդակը սահմանելու համար՝ օգտագործելով մեկը
|
|
438
|
+
`npm` մակարդակներից, որոնք սահմանված են [https://www.npmjs.com/package/winston#logging-levels]-ում (https://www.npmjs.com/package/winston#logging-levels)
|
|
439
|
+
|
|
440
|
+
Նախնական մակարդակը `error` է: Առավել խոսուն մակարդակը `silly` է, թեև ներկայումս շարժական է
|
|
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>
|