mobiletto 1.1.10 → 1.1.13
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 +74 -0
- package/docs/README.md +113 -0
- package/docs/af/README.md +481 -0
- package/docs/am/README.md +481 -0
- package/docs/ar/README.md +481 -0
- package/docs/az/README.md +481 -0
- package/docs/be/README.md +481 -0
- package/docs/bg/README.md +481 -0
- package/docs/bn/README.md +481 -0
- package/docs/bs/README.md +481 -0
- package/docs/ca/README.md +481 -0
- package/docs/ceb/README.md +481 -0
- package/docs/co/README.md +481 -0
- package/docs/cs/README.md +481 -0
- package/docs/cy/README.md +481 -0
- package/docs/da/README.md +481 -0
- package/docs/de/README.md +481 -0
- package/docs/el/README.md +481 -0
- package/docs/eo/README.md +481 -0
- package/docs/es/README.md +481 -0
- package/docs/et/README.md +481 -0
- package/docs/eu/README.md +481 -0
- package/docs/fa/README.md +481 -0
- package/docs/fi/README.md +481 -0
- package/docs/fr/README.md +481 -0
- package/docs/fy/README.md +481 -0
- package/docs/ga/README.md +481 -0
- package/docs/gd/README.md +481 -0
- package/docs/gl/README.md +481 -0
- package/docs/gu/README.md +481 -0
- package/docs/ha/README.md +481 -0
- package/docs/haw/README.md +481 -0
- package/docs/he/README.md +481 -0
- package/docs/hi/README.md +481 -0
- package/docs/hmn/README.md +481 -0
- package/docs/hr/README.md +481 -0
- package/docs/ht/README.md +481 -0
- package/docs/hu/README.md +481 -0
- package/docs/hy/README.md +481 -0
- package/docs/id/README.md +481 -0
- package/docs/ig/README.md +481 -0
- package/docs/is/README.md +481 -0
- package/docs/it/README.md +481 -0
- package/docs/iw/README.md +481 -0
- package/docs/ja/README.md +481 -0
- package/docs/jv/README.md +481 -0
- package/docs/ka/README.md +481 -0
- package/docs/kk/README.md +481 -0
- package/docs/km/README.md +481 -0
- package/docs/kn/README.md +481 -0
- package/docs/ko/README.md +481 -0
- package/docs/ku/README.md +481 -0
- package/docs/ky/README.md +481 -0
- package/docs/la/README.md +481 -0
- package/docs/lb/README.md +481 -0
- package/docs/lo/README.md +481 -0
- package/docs/lt/README.md +481 -0
- package/docs/lv/README.md +481 -0
- package/docs/mg/README.md +481 -0
- package/docs/mi/README.md +481 -0
- package/docs/mk/README.md +481 -0
- package/docs/ml/README.md +481 -0
- package/docs/mn/README.md +481 -0
- package/docs/mr/README.md +481 -0
- package/docs/ms/README.md +481 -0
- package/docs/mt/README.md +481 -0
- package/docs/my/README.md +481 -0
- package/docs/ne/README.md +481 -0
- package/docs/nl/README.md +481 -0
- package/docs/no/README.md +481 -0
- package/docs/ny/README.md +481 -0
- package/docs/or/README.md +481 -0
- package/docs/pa/README.md +481 -0
- package/docs/pl/README.md +481 -0
- package/docs/ps/README.md +481 -0
- package/docs/pt/README.md +481 -0
- package/docs/ro/README.md +481 -0
- package/docs/ru/README.md +481 -0
- package/docs/rw/README.md +481 -0
- package/docs/sd/README.md +481 -0
- package/docs/si/README.md +481 -0
- package/docs/sk/README.md +481 -0
- package/docs/sl/README.md +481 -0
- package/docs/sm/README.md +481 -0
- package/docs/sn/README.md +481 -0
- package/docs/so/README.md +481 -0
- package/docs/sq/README.md +481 -0
- package/docs/sr/README.md +481 -0
- package/docs/st/README.md +481 -0
- package/docs/su/README.md +481 -0
- package/docs/sv/README.md +481 -0
- package/docs/sw/README.md +481 -0
- package/docs/ta/README.md +481 -0
- package/docs/te/README.md +481 -0
- package/docs/tg/README.md +481 -0
- package/docs/th/README.md +481 -0
- package/docs/tk/README.md +481 -0
- package/docs/tl/README.md +481 -0
- package/docs/tr/README.md +481 -0
- package/docs/tt/README.md +481 -0
- package/docs/ug/README.md +481 -0
- package/docs/uk/README.md +481 -0
- package/docs/ur/README.md +481 -0
- package/docs/uz/README.md +481 -0
- package/docs/vi/README.md +481 -0
- package/docs/xh/README.md +481 -0
- package/docs/yi/README.md +481 -0
- package/docs/yo/README.md +481 -0
- package/docs/zh/README.md +481 -0
- package/docs/zu/README.md +481 -0
- package/drivers/b2/index.js +25 -6
- package/hokey.json +16 -0
- package/index.js +7 -2
- package/package.json +1 -1
- package/test/api.spec.js +13 -9
- package/util/redis.js +2 -2
|
@@ -0,0 +1,481 @@
|
|
|
1
|
+
Mobiletto
|
|
2
|
+
=========
|
|
3
|
+
|
|
4
|
+
Mobiletto ir JavaScript krātuves abstrakcijas slānis ar papildu caurspīdīgu klienta puses šifrēšanu.
|
|
5
|
+
|
|
6
|
+
# Saturs
|
|
7
|
+
* [Kāpēc Mobiletto?](#Kāpēc-Mobiletto?)
|
|
8
|
+
* [Ātrais sākums](#Quick-start)
|
|
9
|
+
* [Mobiletto CLI](#mobiletto-cli)
|
|
10
|
+
* [Avots](#Avots)
|
|
11
|
+
* [Instalācija](#Instalācija)
|
|
12
|
+
* [Atbalsts un finansējums](#Support-and-Funding)
|
|
13
|
+
* [Pamata lietojums](#Basic-usage)
|
|
14
|
+
* [Metadati](#Metadata)
|
|
15
|
+
* [Alternatīvais importēšanas stils](#Alternate-import-style)
|
|
16
|
+
* [Kešatmiņa](#Caching)
|
|
17
|
+
* [Spoguļošana](#Spoguļošana)
|
|
18
|
+
* [Caurspīdīga šifrēšana](#Transparent-encryption)
|
|
19
|
+
* [Taustiņu pagriešana](#Key-rotation)
|
|
20
|
+
* [Draivera saskarne](#Driver-interface)
|
|
21
|
+
* [Logging](#Logging)
|
|
22
|
+
|
|
23
|
+
# Lasiet to citā valodā
|
|
24
|
+
Šis README.md dokuments ir tulkots, izmantojot [hokeylization](https://github.com/cobbzilla/hokeylization)
|
|
25
|
+
**[Visas valodas, ko atbalsta Google tulkotājs](https://cloud.google.com/translate/docs/languages)!**
|
|
26
|
+
|
|
27
|
+
Esmu pārliecināts, ka tas nav ideāls, bet es ceru, ka tas ir labāk nekā nekas!
|
|
28
|
+
|
|
29
|
+
[🇸🇦 arābu](../ar/README.md)
|
|
30
|
+
[🇧🇩 bengāļu](../bn/README.md)
|
|
31
|
+
[🇩🇪 vācu valodā](../de/README.md)
|
|
32
|
+
[🇺🇸 angļu valodā](../en/README.md)
|
|
33
|
+
[🇪🇸 spāņu](../es/README.md)
|
|
34
|
+
[🇫🇷 franču valoda](../fr/README.md)
|
|
35
|
+
[🇹🇩 Hausa](../ha/README.md)
|
|
36
|
+
[🇮🇳 Hindi](../hi/README.md)
|
|
37
|
+
[🇮🇩 Indonēziešu](../id/README.md)
|
|
38
|
+
[🇮🇹 itāļu valoda](../it/README.md)
|
|
39
|
+
[🇯🇵 japāņu](../ja/README.md)
|
|
40
|
+
[🇰🇷 korejiešu](../ko/README.md)
|
|
41
|
+
[🇮🇳 Maranthi](../mr/README.md)
|
|
42
|
+
[🇵🇱 poļu](../pl/README.md)
|
|
43
|
+
[🇧🇷 portugāļu](../pt/README.md)
|
|
44
|
+
[🇷🇺 krievu valodā](../ru/README.md)
|
|
45
|
+
[🇰🇪 Svahili](../sw/README.md)
|
|
46
|
+
[🇵🇭 Tagalogs](../tl/README.md)
|
|
47
|
+
[🇹🇷 turku](../tr/README.md)
|
|
48
|
+
[🇵🇰 urdu](../ur/README.md)
|
|
49
|
+
[🇻🇳 vjetnamiešu](../vi/README.md)
|
|
50
|
+
[🇨🇳 ķīniešu](../zh/README.md)
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
**[📚 ... Visas valodas ...](../README.md)**
|
|
54
|
+
----
|
|
55
|
+
|
|
56
|
+
### Vai ir problēma ar šo README tulkojumu?
|
|
57
|
+
Šis konkrētais oriģināla [README] tulkojums (https://github.com/cobbzilla/mobiletto/blob/master/README.md)
|
|
58
|
+
var būt kļūdains — *labojumi ir ļoti apsveicami!* Lūdzu, nosūtiet [izvilkšanas pieprasījumu vietnē GitHub](https://github.com/cobbzilla/mobiletto/pulls),
|
|
59
|
+
vai, ja nevēlaties to darīt, [atveriet problēmu](https://github.com/cobbzilla/mobiletto/issues)
|
|
60
|
+
|
|
61
|
+
Kad veidojat jaunu GitHub problēmu par tulkojumu, lūdzu, rīkojieties šādi:
|
|
62
|
+
* iekļaujiet lapas URL (kopējiet/ielīmējiet no pārlūkprogrammas adreses joslas)
|
|
63
|
+
* iekļaujiet precīzu nepareizo tekstu (kopējiet/ielīmējiet no pārlūkprogrammas)
|
|
64
|
+
* Lūdzu, aprakstiet, kas ir nepareizi — vai tulkojums ir nepareizs? vai formatējums ir kaut kā bojāts?
|
|
65
|
+
* laipni piedāvājiet ieteikumu par labāku tulkojumu vai kā pareizi formatēt tekstu
|
|
66
|
+
* **Paldies!**
|
|
67
|
+
|
|
68
|
+
## Kāpēc Mobiletto?
|
|
69
|
+
|
|
70
|
+
### Ardievu pārdevēja bloķēšana!
|
|
71
|
+
Dažādiem mākoņu krātuves nodrošinātājiem ir nesaderīgas API. Pat tie, kas cenšas panākt "S3 saderību"
|
|
72
|
+
piemīt savdabīga uzvedība.
|
|
73
|
+
|
|
74
|
+
Kad izvēlaties konkrētu krātuves pakalpojumu sniedzēju savai lietotnei, ja kodējat tieši uz viņa API, jūsu lietotni
|
|
75
|
+
tagad ir atkarīgs no šī pakalpojuma. Laikam ejot un kodam uzkrājoties, pārdevēji mainās
|
|
76
|
+
arvien neizturamāks. Laipni lūdzam pārdevēju bloķēšanas jautrajā pasaulē!
|
|
77
|
+
|
|
78
|
+
Mobiletto tika izstrādāts, lai atrisinātu šo problēmu. Kodējot savu lietotni Mobiletto API, varat to viegli izdarīt
|
|
79
|
+
mainiet krātuves nodrošinātājus un ziniet, ka jūsu lietotnes krātuves slānis darbosies identiski.
|
|
80
|
+
|
|
81
|
+
### Plaša pārbaude
|
|
82
|
+
Visiem vadītājiem tiek pārbaudīta identiska uzvedība, katram vadītājam veicot 60+ testus.
|
|
83
|
+
Mēs pārbaudām visus draiverus ar katru kombināciju:
|
|
84
|
+
* Šifrēšana: gan iespējota, gan atspējota
|
|
85
|
+
* Redis kešatmiņu: gan iespējots, gan atspējots
|
|
86
|
+
|
|
87
|
+
Šī pieeja sniedz mums sirdsmieru, ka Mobiletto darbosies vienādi neatkarīgi no tā, kuru draiveri izmantojat,
|
|
88
|
+
un neatkarīgi no tā, vai iespējojat kešatmiņu un/vai šifrēšanu.
|
|
89
|
+
|
|
90
|
+
### Vadītāja atbalsts
|
|
91
|
+
Pašreizējie Mobiletto krātuves draiveri:
|
|
92
|
+
* `s3` : Amazon S3
|
|
93
|
+
* `b2` : Backblaze B2
|
|
94
|
+
* `local` : lokālā failu sistēma
|
|
95
|
+
|
|
96
|
+
*Ieguldījums vairāku mākoņkrātuvju nodrošinātāju atbalstam ir ļoti apsveicams!*
|
|
97
|
+
|
|
98
|
+
## mobiletto-cli
|
|
99
|
+
Mobiletto ir paredzēts izmantot kā bibliotēku ar citu JavaScript kodu.
|
|
100
|
+
|
|
101
|
+
Lai strādātu ar mobiletto komandrindā, izmantojiet [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
|
|
102
|
+
|
|
103
|
+
## Avots
|
|
104
|
+
* [mobiletto vietnē GitHub](https://github.com/cobbzilla/mobiletto)
|
|
105
|
+
* [mobiletto on npm](https://www.npmjs.com/package/mobiletto)
|
|
106
|
+
|
|
107
|
+
## Atbalsts un finansējums
|
|
108
|
+
Es cenšos būt profesionāls atvērtā pirmkoda programmatūras izstrādātājs. Esmu strādājis
|
|
109
|
+
programmatūras industrijā jau daudzus gadus esmu dibinājis veiksmīgus uzņēmumus un pārdevis tos valsts uzņēmumiem.
|
|
110
|
+
Nesen es zaudēju darbu, un man īsti nav citu darbu
|
|
111
|
+
|
|
112
|
+
Tāpēc es mēģināšu uzrakstīt noderīgu programmatūru un pārbaudīt, vai tā darbojas
|
|
113
|
+
|
|
114
|
+
Ja jums patīk izmantot šo programmatūru, es būšu ļoti pateicīgs pat par
|
|
115
|
+
mazākais [ikmēneša ieguldījums, izmantojot Patreon](https://www.patreon.com/cobbzilla)
|
|
116
|
+
|
|
117
|
+
*Paldies!*
|
|
118
|
+
|
|
119
|
+
## Uzstādīšana
|
|
120
|
+
Instalējiet, izmantojot `npm` vai `yarn` . Jūs droši vien vēlaties `lite` versiju, kas neietver visas
|
|
121
|
+
tulkoti README faili:
|
|
122
|
+
|
|
123
|
+
npm install mobiletto-lite
|
|
124
|
+
yarn add mobiletto-lite
|
|
125
|
+
|
|
126
|
+
Ja patiešām vēlaties README failus visās valodās, instalējiet pilno versiju:
|
|
127
|
+
|
|
128
|
+
npm install mobiletto
|
|
129
|
+
yarn add mobiletto
|
|
130
|
+
|
|
131
|
+
## Ātrs sākums
|
|
132
|
+
Īss piemērs, izmantojot mobiletto `s3` draiveri.
|
|
133
|
+
|
|
134
|
+
Šis kods darbotos tāpat, ja draiveris būtu `b2` vai `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
|
+
## Pamata lietošana
|
|
165
|
+
Daudz plašāks piemērs, kurā parādīta lielākā daļa piedāvāto funkciju:
|
|
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
|
+
## Metadati
|
|
267
|
+
Komanda `metadata` atgriež metadatus par vienu failu sistēmas ierakstu.
|
|
268
|
+
Tāpat atgriešanas vērtība no komandas `list` ir metadatu objektu masīvs.
|
|
269
|
+
|
|
270
|
+
Metadatu objekts izskatās šādi:
|
|
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
|
+
Rekvizīts `type` type" var būt `file` " , `dir` " , `link` vai `special` .
|
|
281
|
+
|
|
282
|
+
Atkarībā no draivera veida komanda `list` var neatgriezt visus laukus. `name` ” un “type `type` .
|
|
283
|
+
vienmēr jābūt klāt. Nākamā `metadata` komanda atgriezīs visus pieejamos rekvizītus.
|
|
284
|
+
|
|
285
|
+
## Alternatīvs importēšanas stils
|
|
286
|
+
Importējiet pilnībā aptverto moduli un izmantojiet `connect` funkciju:
|
|
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
|
+
## Kešatmiņa
|
|
294
|
+
Mobiletto vislabāk darbojas ar <a href="https://redis.io">redis</a> kešatmiņu.
|
|
295
|
+
|
|
296
|
+
Mobiletto mēģinās izveidot savienojumu ar redis instanci vietnē 127.0.0.1:6379
|
|
297
|
+
|
|
298
|
+
Varat ignorēt kādu no šiem:
|
|
299
|
+
* Iestatiet `MOBILETTO_REDIS_HOST` env var, mobile lai izveidotu savienojumu šeit, nevis localhost
|
|
300
|
+
* Iestatiet `MOBILETTO_REDIS_PORT` env var, šis ports tiks izmantots
|
|
301
|
+
|
|
302
|
+
Mobiletto saglabās visas savas redis atslēgas ar prefiksu `_mobiletto__` . Jūs varat to mainīt
|
|
303
|
+
iestatot `MOBILETTO_REDIS_PREFIX` env var.
|
|
304
|
+
|
|
305
|
+
Varat arī iestatīt kešatmiņu katram savienojumam, izmantojot objektu `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
|
+
### Vai nevēlaties atkārtotu kešatmiņu?
|
|
317
|
+
Lai atspējotu: izveidojot savienojumu, objektā `opts.redisConfig` `enabled: false` false'.
|
|
318
|
+
|
|
319
|
+
Kā minēts tālāk, kešatmiņas atspējošana negatīvi ietekmēs veiktspēju un radīs vairāk pieprasījumu
|
|
320
|
+
uz krātuvi, kas jums patiešām ir nepieciešama.
|
|
321
|
+
|
|
322
|
+
### Kešatmiņas norādījumi
|
|
323
|
+
**Šifrēta krātuve**: šifrētās atmiņas lasīšana/rakstīšana ir tikai nedaudz lēnāka nekā parasti,
|
|
324
|
+
bet navigācija pa direktorijiem (ko dažas lietas dara) ir diezgan dārga. Redis kešatmiņas izmantošana
|
|
325
|
+
sniegs jums ievērojamu veiktspējas pieaugumu.
|
|
326
|
+
|
|
327
|
+
Noklusējuma kešatmiņa ir droša, taču tā nedarbojas labi, ja jums ir daudz rakstīšanas/noņemšanas darbību.
|
|
328
|
+
Jebkura rakstīšanas vai noņemšanas darbība padara nederīgu visu kešatmiņu, nodrošinot, ka turpmākajos lasījumos tiks parādīta
|
|
329
|
+
jaunākās izmaiņas.
|
|
330
|
+
|
|
331
|
+
### CLI rīki
|
|
332
|
+
Ja izmantojat CLI rīku, piemēram, [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
|
|
333
|
+
noteikti vēlēsities, lai `mo` kešatmiņa būtu iespējota, jo tā ilgst, kad tiek izsaukta komanda “mo”.
|
|
334
|
+
|
|
335
|
+
## Spoguļošana
|
|
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
|
+
Komanda `mirror` veic visu failu vienreizēju kopiju no viena mobilā tālruņa uz citu.
|
|
344
|
+
Tas neveic nekādus procesus, lai laika gaitā uzturētu spoguli. Vēlreiz palaidiet komandu `mirror` .
|
|
345
|
+
lai sinhronizētu visus trūkstošos failus.
|
|
346
|
+
|
|
347
|
+
Atgriešanas vērtība no `mirror` ir vienkāršs objekts ar skaitītājiem, kas norāda, cik daudz failu bija veiksmīgi
|
|
348
|
+
atspoguļots un cik failos bija kļūdas:
|
|
349
|
+
|
|
350
|
+
{
|
|
351
|
+
success: count-of-files-mirrored,
|
|
352
|
+
errors: count-of-files-with-errors
|
|
353
|
+
}
|
|
354
|
+
|
|
355
|
+
BRĪDINĀJUMS: lielu datu kopu spoguļošana var būt ļoti laikietilpīga un joslas platums.
|
|
356
|
+
|
|
357
|
+
Izmantojot `mirror` izsaukuma semantiku, dažreiz var būt mulsinoši saprast, kas ir
|
|
358
|
+
lasītājs un kas ir rakstnieks. Iedomājieties to kā uzdevuma paziņojumu: "kreisās puses mobilais telefons"
|
|
359
|
+
ir lieta, kurai tiek piešķirta (rakstīti atspoguļotie dati), un "labās puses mobilais tālrunis" (
|
|
360
|
+
arguments metodei `mirror` spogulis") ir piešķirtā vērtība (tiek nolasīti spoguļattēlu dati).
|
|
361
|
+
|
|
362
|
+
## Caurspīdīga šifrēšana
|
|
363
|
+
Iespējot caurspīdīgu klienta puses šifrēšanu:
|
|
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
|
+
Kas notiek? Atsevišķs "direktorija ieraksts" (tiešais) direktorijs (šifrēts) izseko tajā esošos failus
|
|
383
|
+
direktorijs (aka dirent direktorijs).
|
|
384
|
+
* Komanda `list` nolasa direktoriju ievades failus, atšifrē katru norādīto ceļu; pēc tam atgriež metadatus katram failam
|
|
385
|
+
* `list` komandas ir neefektīvākas, īpaši direktorijiem ar lielu failu skaitu
|
|
386
|
+
* Komanda `write` ieraksta dirent failus katra vecāka dirent direktorijā; pēc tam raksta failu
|
|
387
|
+
* komandas `write` radīs O(N) ierakstus, kur N = dziļums direktoriju hierarhijā
|
|
388
|
+
* Komanda `remove` noņem atbilstošo dirent failu un tā vecāku, ja tas ir tukšs; pēc tam noņem failu
|
|
389
|
+
* `remove` komandas izraisīs O(N) nolasījumu un, iespējams, tikpat daudz dzēšanas, un N = dziļums direktoriju hierarhijā
|
|
390
|
+
* Rekursīvas `remove` komandas lielās un dziļās failu sistēmās var būt dārgas
|
|
391
|
+
|
|
392
|
+
Ņemiet vērā, ka pat tad, ja ir iespējota klienta puses šifrēšana, pretinieks ar pilnu redzamību jūsu šifrētajā servera pusē
|
|
393
|
+
krātuve, pat bez atslēgas, joprojām var redzēt kopējo direktoriju skaitu un to, cik failu ir katrā, un ar
|
|
394
|
+
dažas pūles, atklājiet daļu vai visu direktoriju hierarhijas vispārējo struktūru.
|
|
395
|
+
*Piezīme. Labākai drošībai izmantojiet salīdzinoši plakanu struktūru.*
|
|
396
|
+
Pretinieks nezinātu direktoriju/failu nosaukumus, ja vien viņi nezinātu arī jūsu šifrēšanu
|
|
397
|
+
atslēgu vai citādi veiksmīgi uzlauzis šifrēšanu. Tad visas likmes ir izslēgtas!
|
|
398
|
+
|
|
399
|
+
### Veiktspēja un kešatmiņa
|
|
400
|
+
Darbības ar šifrētu krātuvi var būt lēnas. Rekursīvi saraksti un noņemšana var būt ļoti lēna.
|
|
401
|
+
Kešatmiņa, izmantojot redis, palīdz ārkārtīgi, taču ņemiet vērā, ka kešatmiņa tiek izskalota pēc rakstīšanas vai noņemšanas.
|
|
402
|
+
|
|
403
|
+
## Taustiņu pagriešana
|
|
404
|
+
Izveidojiet mobilo tālruni ar savu jauno atslēgu un pēc tam atspoguļojiet tajā vecos datus:
|
|
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
|
+
## Draivera interfeiss
|
|
417
|
+
Draiveris ir jebkurš JS fails, kas eksportē funkciju "storageClient" ar šādu parakstu:
|
|
418
|
+
|
|
419
|
+
function storageClient (key, secret, opts)
|
|
420
|
+
|
|
421
|
+
* `key` : virkne, jūsu API atslēga ( `local` draiverim tas ir bāzes direktorijs)
|
|
422
|
+
* `secret` : virkne, jūsu API noslēpums (var izlaist `local` draiverim)
|
|
423
|
+
* `opts` : objekts, rekvizīti ir katram draiverim:
|
|
424
|
+
* `local` rekvizītam `fileMode` un `dirMode` nosaka, kā tiek izveidoti jauni izveides faili un direktoriji.
|
|
425
|
+
* `s3` `bucket` ir nepieciešams. Izvēles rekvizīti ir:
|
|
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
|
+
Objektam, ko atgriež funkcija storageClient, ir jādefinē šādas funkcijas:
|
|
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
|
+
## Mežizstrāde
|
|
457
|
+
Mobiletto izmanto [winston](https://www.npmjs.com/package/winston) reģistrēšanas bibliotēku.
|
|
458
|
+
|
|
459
|
+
Žurnāli **būs** saturēs failu ceļus un kļūdu ziņojumus, bet **nekad** nesaturēs atslēgas, noslēpumus,
|
|
460
|
+
vai jebkura cita savienojuma konfigurācijas informācija.
|
|
461
|
+
|
|
462
|
+
### Žurnāla līmenis
|
|
463
|
+
Izmantojiet vides mainīgo `MOBILETTO_LOG_LEVEL` , lai iestatītu žurnāla līmeni, izmantojot vienu
|
|
464
|
+
no `npm` līmeņiem, kas definēti vietnē [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
|
|
465
|
+
|
|
466
|
+
Noklusējuma līmenis ir `error` . Plašākais līmenis ir `silly` , lai gan pašlaik mobilais
|
|
467
|
+
nereģistrējas zemākā līmenī par `debug`
|
|
468
|
+
|
|
469
|
+
MOBILETTO_LOG_LEVEL=silly # maximum logs!
|
|
470
|
+
|
|
471
|
+
### Žurnāla fails
|
|
472
|
+
Pēc noklusējuma reģistrētājs raksta uz konsoli. Lai nosūtītu žurnālus uz failu, iestatiet `MOBILETTO_LOG_FILE`
|
|
473
|
+
vides mainīgais. Piesakoties failā, žurnāli vairs netiks rakstīti konsolē.
|
|
474
|
+
|
|
475
|
+
MOBILETTO_LOG_FILE=/var/my_mobiletto_log
|
|
476
|
+
|
|
477
|
+
Lai izslēgtu reģistrēšanu:
|
|
478
|
+
|
|
479
|
+
MOBILETTO_LOG_FILE=/dev/null
|
|
480
|
+
|
|
481
|
+
</pre>
|