mobiletto 1.1.8 → 1.1.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +56 -4
- 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 +33 -17
- package/package.json +3 -2
- package/test/api.spec.js +319 -306
- package/util/logger.js +1 -1
- package/util/redis.js +1 -1
|
@@ -0,0 +1,455 @@
|
|
|
1
|
+
Mobiletto
|
|
2
|
+
=========
|
|
3
|
+
|
|
4
|
+
Mobiletto este un strat de abstractizare a stocării JavaScript, cu criptare opțională transparentă pe partea clientului.
|
|
5
|
+
|
|
6
|
+
# Cuprins
|
|
7
|
+
* [De ce Mobiletto?](#De ce-Mobiletto?)
|
|
8
|
+
* [Pornire rapidă](#Pornire rapidă)
|
|
9
|
+
* [Mobiletto CLI](#mobiletto-cli)
|
|
10
|
+
* [Sursa](#Sursa)
|
|
11
|
+
* [Utilizare de bază](#Utilizare de bază)
|
|
12
|
+
* [Metadate](#Metadate)
|
|
13
|
+
* [Stil de import alternativ](#Stil de import alternativ)
|
|
14
|
+
* [Memorizare în cache](#Memorizare în cache)
|
|
15
|
+
* [Oglindire](#Oglindire)
|
|
16
|
+
* [Criptare transparentă](#Transparent-encryption)
|
|
17
|
+
* [Rotire taste](#Rotire taste)
|
|
18
|
+
* [Interfață driver](#Driver-interfață)
|
|
19
|
+
* [Înregistrare](#Înregistrare)
|
|
20
|
+
|
|
21
|
+
# Citiți asta într-o altă limbă
|
|
22
|
+
Acest document README.md a fost tradus, prin [hokeylization](https://github.com/cobbzilla/hokeylization), în
|
|
23
|
+
**[fiecare limbă acceptată de Google Translate](https://cloud.google.com/translate/docs/languages)!**
|
|
24
|
+
|
|
25
|
+
Sunt sigur că nu este perfect, dar sper că este mai bine decât nimic!
|
|
26
|
+
|
|
27
|
+
[🇸🇦 Arabă](../ar/README.md)
|
|
28
|
+
[🇧🇩 Bengali](../bn/README.md)
|
|
29
|
+
[🇩🇪 Germană](../de/README.md)
|
|
30
|
+
[🇺🇸 engleză](../en/README.md)
|
|
31
|
+
[🇪🇸 Spaniolă](../es/README.md)
|
|
32
|
+
[🇫🇷 Franceză](../fr/README.md)
|
|
33
|
+
[🇹🇩 Hausa](../ha/README.md)
|
|
34
|
+
[🇮🇳 Hindi](../hi/README.md)
|
|
35
|
+
[🇮🇩 indoneziană](../id/README.md)
|
|
36
|
+
[🇮🇹 italiană](../it/README.md)
|
|
37
|
+
[🇯🇵 japoneză](../ja/README.md)
|
|
38
|
+
[🇰🇷 coreeană](../ko/README.md)
|
|
39
|
+
[🇮🇳 Maranthi](../mr/README.md)
|
|
40
|
+
[🇵🇱 poloneză](../pl/README.md)
|
|
41
|
+
[🇧🇷 portugheză](../pt/README.md)
|
|
42
|
+
[🇷🇺 rusă](../ru/README.md)
|
|
43
|
+
[🇰🇪 Swahili](../sw/README.md)
|
|
44
|
+
[🇵🇭 Tagalog](../tl/README.md)
|
|
45
|
+
[🇹🇷 Turcă](../tr/README.md)
|
|
46
|
+
[🇵🇰 Urdu](../ur/README.md)
|
|
47
|
+
[🇻🇳 vietnameză](../vi/README.md)
|
|
48
|
+
[🇨🇳 Chineză](../zh/README.md)
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
**[📚 ... Toate limbile ...](../README.md)**
|
|
52
|
+
----
|
|
53
|
+
|
|
54
|
+
### Există o problemă cu această traducere a fișierului README?
|
|
55
|
+
Această traducere specială a originalului [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
|
|
56
|
+
poate fi defecte -- *corecțiile sunt foarte binevenite!* Vă rugăm să trimiteți o [pull request pe GitHub](https://github.com/cobbzilla/mobiletto/pulls),
|
|
57
|
+
sau dacă nu ești confortabil să faci asta, [deschide o problemă](https://github.com/cobbzilla/mobiletto/issues)
|
|
58
|
+
|
|
59
|
+
Când creați o nouă problemă GitHub despre o traducere, faceți:
|
|
60
|
+
* includeți adresa URL a paginii (copiați/lipiți din bara de adrese a browserului)
|
|
61
|
+
* includeți textul exact care este greșit (copiați/lipiți din browser)
|
|
62
|
+
* vă rugăm să descrieți ce este greșit -- traducerea este incorectă? formatarea este stricata cumva?
|
|
63
|
+
* Vă rugăm să oferiți o sugestie pentru o traducere mai bună sau cum ar trebui să fie formatat corect textul
|
|
64
|
+
* **Mulțumesc!**
|
|
65
|
+
|
|
66
|
+
## De ce Mobiletto?
|
|
67
|
+
|
|
68
|
+
### Adio blocare a furnizorului!
|
|
69
|
+
Diferiții furnizori de stocare în cloud au API-uri incompatibile. Chiar și cei care se străduiesc pentru „compatibilitatea S3”
|
|
70
|
+
au comportamente idiosincratice.
|
|
71
|
+
|
|
72
|
+
Când alegeți un anumit furnizor de stocare pentru aplicația dvs., dacă codificați direct în API-ul acestuia, aplicația dvs
|
|
73
|
+
depinde acum de acel serviciu. Pe măsură ce timpul trece și codul se acumulează, se schimbă furnizorii
|
|
74
|
+
din ce în ce mai insuportabil. Bine ați venit în lumea distractivă a blocării vânzătorilor!
|
|
75
|
+
|
|
76
|
+
Mobiletto a fost conceput pentru a rezolva această problemă. Codând aplicația dvs. în API-ul mobiletto, puteți cu ușurință
|
|
77
|
+
schimbați furnizorii de stocare și știți că stratul de stocare al aplicației dvs. se va comporta identic.
|
|
78
|
+
|
|
79
|
+
### Testări ample
|
|
80
|
+
Toți șoferii sunt testați pentru un comportament identic, cu peste 60 de teste pentru fiecare șofer.
|
|
81
|
+
Testăm toți șoferii cu fiecare combinație de:
|
|
82
|
+
* Criptare: atât activată, cât și dezactivată
|
|
83
|
+
* Cache Redis: atât activat, cât și dezactivat
|
|
84
|
+
|
|
85
|
+
Această abordare ne oferă liniște că mobiletto se va comporta la fel, indiferent de driverul pe care îl utilizați,
|
|
86
|
+
și indiferent dacă activați memorarea în cache și/sau criptarea.
|
|
87
|
+
|
|
88
|
+
### Suport pentru șoferi
|
|
89
|
+
Drivere actuale de stocare Mobiletto:
|
|
90
|
+
* `s3` : Amazon S3
|
|
91
|
+
* `b2` : Backblaze B2
|
|
92
|
+
* `local` : sistem de fișiere local
|
|
93
|
+
|
|
94
|
+
*Contribuțiile pentru a sprijini mai mulți furnizori de stocare în cloud sunt foarte binevenite!*
|
|
95
|
+
|
|
96
|
+
## mobiletto-cli
|
|
97
|
+
Mobiletto este destinat să fie utilizat ca bibliotecă de către alt cod JavaScript.
|
|
98
|
+
|
|
99
|
+
Pentru a lucra cu mobiletto la linia de comandă, utilizați [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
|
|
100
|
+
|
|
101
|
+
## Sursă
|
|
102
|
+
* [mobiletto pe GitHub](https://github.com/cobbzilla/mobiletto)
|
|
103
|
+
* [mobiletto pe npm](https://www.npmjs.com/package/mobiletto)
|
|
104
|
+
|
|
105
|
+
## Pornire rapidă
|
|
106
|
+
Un scurt exemplu folosind driverul mobiletto `s3` .
|
|
107
|
+
|
|
108
|
+
Acest cod ar rula la fel dacă driverul ar fi `b2` sau `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
|
+
## Utilizare de bază
|
|
139
|
+
Un exemplu mult mai amplu, care arată majoritatea caracteristicilor oferite:
|
|
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
|
+
## Metadate
|
|
241
|
+
Comanda `metadata` returnează metadate despre o singură intrare în sistemul de fișiere.
|
|
242
|
+
De asemenea, valoarea returnată de la comanda `list` este o matrice de obiecte de metadate.
|
|
243
|
+
|
|
244
|
+
Un obiect de metadate arată astfel:
|
|
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
|
+
Proprietatea `type` poate fi `file` `dir` , `link` sau `special` .
|
|
255
|
+
|
|
256
|
+
În funcție de tipul de driver, o comandă `list` poate să nu returneze toate câmpurile. Proprietățile `name` și `type` .
|
|
257
|
+
ar trebui să fie mereu prezent. O comandă `metadata` ulterioară va returna toate proprietățile disponibile.
|
|
258
|
+
|
|
259
|
+
## Stil de import alternativ
|
|
260
|
+
Importați modulul complet și utilizați funcția `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
|
+
## Memorarea în cache
|
|
268
|
+
Mobiletto funcționează cel mai bine cu un cache <a href="https://redis.io">redis</a> .
|
|
269
|
+
|
|
270
|
+
Mobiletto va încerca să se conecteze la o instanță redis pe 127.0.0.1:6379
|
|
271
|
+
|
|
272
|
+
Puteți trece peste oricare dintre acestea:
|
|
273
|
+
* Setați `MOBILETTO_REDIS_HOST` env var, mobile pentru a vă conecta aici în loc de localhost
|
|
274
|
+
* Setați înv. var `MOBILETTO_REDIS_PORT` , acest port va fi folosit
|
|
275
|
+
|
|
276
|
+
Mobiletto va stoca toate cheile redis cu prefixul `_mobiletto__` . Puteți schimba acest lucru
|
|
277
|
+
prin setarea `MOBILETTO_REDIS_PREFIX` env var.
|
|
278
|
+
|
|
279
|
+
De asemenea, puteți seta memorarea în cache pe conexiune cu obiectul `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
|
+
### Nu vrei redis cache?
|
|
291
|
+
Pentru a dezactiva: trece `enabled: false` în obiectul tău `opts.redisConfig` când stabilești conexiunea.
|
|
292
|
+
|
|
293
|
+
După cum se discută mai jos, dezactivarea memoriei cache va avea un efect negativ asupra performanței și va genera mai multe solicitări
|
|
294
|
+
la stocarea de care aveți cu adevărat nevoie.
|
|
295
|
+
|
|
296
|
+
### Ghid pentru memorarea în cache
|
|
297
|
+
**Stocare criptată**: citirea/scrierea stocării criptate este doar puțin mai lentă decât în mod normal,
|
|
298
|
+
dar navigarea prin directoare (ceea ce fac unele lucruri) este destul de costisitoare. Folosind un cache redis
|
|
299
|
+
vă va oferi un spor semnificativ de performanță.
|
|
300
|
+
|
|
301
|
+
Cache-ul implicit este sigur, dar nu funcționează bine dacă aveți multe operațiuni de scriere/eliminare.
|
|
302
|
+
Orice operație de scriere sau eliminare invalidează întregul cache, asigurându-se că citirile ulterioare vor vedea
|
|
303
|
+
ultimele modificari.
|
|
304
|
+
|
|
305
|
+
### Instrumente CLI
|
|
306
|
+
Dacă utilizați un instrument CLI precum [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
|
|
307
|
+
cu siguranță veți dori cache-ul redis activat, deoarece durează peste invocările comenzii `mo` .
|
|
308
|
+
|
|
309
|
+
## Oglindire
|
|
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
|
+
Comanda `mirror` efectuează o copie unică a tuturor fișierelor de la un mobil la altul.
|
|
318
|
+
Nu rulează niciun proces pentru a menține oglinda în timp. Rulați din nou comanda `mirror`
|
|
319
|
+
pentru a sincroniza orice fișiere lipsă.
|
|
320
|
+
|
|
321
|
+
Valoarea returnată de la `mirror` este un obiect simplu cu contoare pentru câte fișiere au fost cu succes
|
|
322
|
+
oglindit și câte fișiere au avut erori:
|
|
323
|
+
|
|
324
|
+
{
|
|
325
|
+
success: count-of-files-mirrored,
|
|
326
|
+
errors: count-of-files-with-errors
|
|
327
|
+
}
|
|
328
|
+
|
|
329
|
+
AVERTISMENT: Oglindirea seturilor mari de date poate consuma foarte mult timp și poate consuma o lățime de bandă
|
|
330
|
+
|
|
331
|
+
Cu semantica apelului `mirror` , uneori poate fi confuz să înțelegeți cine este
|
|
332
|
+
cititor și cine este scriitorul. Imaginați-vă ca pe o declarație de atribuire: „mobiletto de la mâna stângă”
|
|
333
|
+
este lucrul căruia i se atribuie (date în oglindă scrise) și „mobiletto-ul din dreapta” (the
|
|
334
|
+
argument pentru metoda `mirror` ) este valoarea atribuită (datele în oglindă sunt citite).
|
|
335
|
+
|
|
336
|
+
## Criptare transparentă
|
|
337
|
+
Activați criptarea transparentă pe partea clientului:
|
|
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
|
+
Ce se întâmplă? Un director separat de „intrare în director” (direct) (criptat) urmărește ce fișiere se află în acesta
|
|
357
|
+
directorul (aka directorul dirent).
|
|
358
|
+
* Comanda `list` citește fișierele de intrare în director, decriptează fiecare cale listată; apoi returnează metadate pentru fiecare fișier
|
|
359
|
+
* Comenzile `list` sunt mai ineficiente, mai ales pentru directoarele cu un număr mare de fișiere
|
|
360
|
+
* Comanda `write` scrie fișierele dirent în directorul dirent al fiecărui părinte, recursiv; apoi scrie fisierul
|
|
361
|
+
* Comenzile `write` vor genera O(N) scrieri, cu N = adâncimea în ierarhia directoarelor
|
|
362
|
+
* Comanda `remove` elimină fișierul dirent corespunzător, iar părintele său dacă este gol, recursiv; apoi elimină fișierul
|
|
363
|
+
* Comenzile nerecursive `remove` vor genera citiri O(N) și, potențial, tot atâtea ștergeri, cu N = adâncimea în ierarhia directoarelor
|
|
364
|
+
* Comenzile recursive `remove` pe sistemele de fișiere mari și adânci pot fi costisitoare
|
|
365
|
+
|
|
366
|
+
Rețineți că, chiar și cu criptarea la nivelul clientului activată, un adversar cu vizibilitate deplină asupra serverului dvs. criptat
|
|
367
|
+
stocarea, chiar și fără cheie, poate vedea în continuare numărul total de directoare și câte fișiere sunt în fiecare, și cu
|
|
368
|
+
oarecare efort, descoperiți o parte sau toată structura generală a ierarhiei directoarelor.
|
|
369
|
+
*Notă: utilizați o structură relativ plată pentru o mai bună securitate.*
|
|
370
|
+
Adversarul nu ar ști numele directoarelor/fișierelor decât dacă ar cunoaște și criptarea ta
|
|
371
|
+
cheie sau a spart altfel criptarea cu succes. Toate pariurile sunt oprite atunci!
|
|
372
|
+
|
|
373
|
+
### Performanță și stocare în cache
|
|
374
|
+
Operațiunile de stocare criptată pot fi lente. Listările recursive și eliminările pot fi foarte lente.
|
|
375
|
+
Memorarea în cache prin redis ajută enorm, dar rețineți că memoria cache este golită la orice scriere sau ștergere.
|
|
376
|
+
|
|
377
|
+
## Rotirea tastelor
|
|
378
|
+
Creați un mobiletto cu noua cheie, apoi oglindiți datele vechi în el:
|
|
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
|
+
## Interfață pentru driver
|
|
391
|
+
Un driver este orice fișier JS care exportă o funcție „storageClient” cu această semnătură:
|
|
392
|
+
|
|
393
|
+
function storageClient (key, secret, opts)
|
|
394
|
+
|
|
395
|
+
* `key` : un șir, cheia dvs. API (pentru driverul `local` acesta este directorul de bază)
|
|
396
|
+
* `secret` : un șir, secretul dvs. API (poate fi omis pentru driverul `local` )
|
|
397
|
+
* `opts` : un obiect, proprietățile sunt per-driver:
|
|
398
|
+
* Pentru `local` , proprietățile `fileMode` și `dirMode` determină modul în care sunt create fișiere și directoare noi de creare
|
|
399
|
+
* Pentru `s3` , este necesară proprietatea `bucket` . Proprietățile opționale sunt:
|
|
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
|
+
Obiectul pe care îl returnează funcția storageClient trebuie să definească aceste funcții:
|
|
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
|
+
## Logare
|
|
431
|
+
Mobiletto utilizează biblioteca de înregistrare [winston](https://www.npmjs.com/package/winston).
|
|
432
|
+
|
|
433
|
+
Jurnalele **vor** conține căi de fișiere și mesaje de eroare, dar **nu** vor conține niciodată chei, secrete,
|
|
434
|
+
sau orice altă informație de configurare a conexiunii.
|
|
435
|
+
|
|
436
|
+
### Nivel de jurnal
|
|
437
|
+
Utilizați variabila de mediu `MOBILETTO_LOG_LEVEL` pentru a seta nivelul de jurnal, folosind unul
|
|
438
|
+
dintre nivelurile `npm` definite în [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
|
|
439
|
+
|
|
440
|
+
Nivelul implicit este `error` . Nivelul cel mai pronunțat este `silly` , deși în prezent mobiletto
|
|
441
|
+
nu se înregistrează la niveluri sub `debug`
|
|
442
|
+
|
|
443
|
+
MOBILETTO_LOG_LEVEL=silly # maximum logs!
|
|
444
|
+
|
|
445
|
+
### Fișier jurnal
|
|
446
|
+
În mod implicit, loggerul scrie pe consolă. Pentru a trimite jurnalele la un fișier, setați `MOBILETTO_LOG_FILE`
|
|
447
|
+
variabilă de mediu. Când vă conectați la un fișier, jurnalele nu vor mai fi scrise pe consolă.
|
|
448
|
+
|
|
449
|
+
MOBILETTO_LOG_FILE=/var/my_mobiletto_log
|
|
450
|
+
|
|
451
|
+
Pentru a dezactiva înregistrarea:
|
|
452
|
+
|
|
453
|
+
MOBILETTO_LOG_FILE=/dev/null
|
|
454
|
+
|
|
455
|
+
</pre>
|