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 huwa saff ta 'estrazzjoni tal-ħażna JavaScript, b'kriptaġġ trasparenti mhux obbligatorju min-naħa tal-klijent.
|
|
5
|
+
|
|
6
|
+
# Kontenut
|
|
7
|
+
* [Għaliex Mobiletto?](#Għaliex-Mobiletto?)
|
|
8
|
+
* [Bidu ta' malajr](#Bidu ta' malajr)
|
|
9
|
+
* [Mobiletto CLI](#mobiletto-cli)
|
|
10
|
+
* [Sors](#Sors)
|
|
11
|
+
* [Użu Bażiku](#Użu Bażiku)
|
|
12
|
+
* [Metadata](#Metadata)
|
|
13
|
+
* [Stil ta' importazzjoni alternattiv](#Stil ta' importazzjoni alternattiv)
|
|
14
|
+
* [Caching](#Caching)
|
|
15
|
+
* [Mirroring](#Mirroring)
|
|
16
|
+
* [Encryption trasparenti](#Transparent-encryption)
|
|
17
|
+
* [Rotazzjoni taċ-ċavetta](#Rotazzjoni taċ-ċavetta)
|
|
18
|
+
* [Interfaċċja tas-sewwieq](#Interface tas-sewwieq)
|
|
19
|
+
* [Logging](#Logging)
|
|
20
|
+
|
|
21
|
+
# Aqra dan b'lingwa oħra
|
|
22
|
+
Dan id-dokument README.md ġie tradott, permezz ta’ [hokeylization](https://github.com/cobbzilla/hokeylization), fi
|
|
23
|
+
**[kull lingwa appoġġjata minn Google Translate](https://cloud.google.com/translate/docs/languages)!**
|
|
24
|
+
|
|
25
|
+
Jien ċert li mhuwiex perfett, imma nispera li huwa aħjar minn xejn!
|
|
26
|
+
|
|
27
|
+
[🇸🇦 Għarbi](../ar/README.md)
|
|
28
|
+
[🇧🇩 Bengali](../bn/README.md)
|
|
29
|
+
[🇩🇪 Ġermaniż](../de/README.md)
|
|
30
|
+
[🇺🇸 Ingliż](../en/README.md)
|
|
31
|
+
[🇪🇸 Spanjol](../es/README.md)
|
|
32
|
+
[🇫🇷 Franċiż](../fr/README.md)
|
|
33
|
+
[🇹🇩 Hausa](../ha/README.md)
|
|
34
|
+
[🇮🇳 Ħindi](../hi/README.md)
|
|
35
|
+
[🇮🇩 Indoneżjan](../id/README.md)
|
|
36
|
+
[🇮🇹 Taljan](../it/README.md)
|
|
37
|
+
[🇯🇵 Ġappuniż](../ja/README.md)
|
|
38
|
+
[🇰🇷 Korean](../ko/README.md)
|
|
39
|
+
[🇮🇳 Maranthi](../mr/README.md)
|
|
40
|
+
[🇵🇱 Pollakk](../pl/README.md)
|
|
41
|
+
[🇧🇷 Portugiż](../pt/README.md)
|
|
42
|
+
[🇷🇺 Russu](../ru/README.md)
|
|
43
|
+
[🇰🇪 Swaħili](../sw/README.md)
|
|
44
|
+
[🇵🇭 Tagalog](../tl/README.md)
|
|
45
|
+
[🇹🇷 Tork](../tr/README.md)
|
|
46
|
+
[🇵🇰 Urdu](../ur/README.md)
|
|
47
|
+
[🇻🇳 Vjetnamiż](../vi/README.md)
|
|
48
|
+
[🇨🇳 Ċiniż](../zh/README.md)
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
**[📚 ... Il-Lingwi kollha ...](../README.md)**
|
|
52
|
+
----
|
|
53
|
+
|
|
54
|
+
### Hemm problema b'din it-traduzzjoni tar-README?
|
|
55
|
+
Din it-traduzzjoni partikolari tal-oriġinal [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
|
|
56
|
+
jista 'jkun difettuż -- *korrezzjonijiet huma milqugħa ħafna!* Jekk jogħġbok ibgħat [pull request fuq GitHub](https://github.com/cobbzilla/mobiletto/pulls),
|
|
57
|
+
jew jekk m'intix komdu tagħmel dan, [iftaħ kwistjoni](https://github.com/cobbzilla/mobiletto/issues)
|
|
58
|
+
|
|
59
|
+
Meta toħloq kwistjoni ġdida ta' GitHub dwar traduzzjoni, jekk jogħġbok agħmel:
|
|
60
|
+
* inkludi l-URL tal-paġna (kopja/pejst mill-bar tal-indirizz tal-browser)
|
|
61
|
+
* inkludi t-test eżatt li huwa ħażin (ikkopja/pejst mill-browser)
|
|
62
|
+
* jekk jogħġbok iddeskrivi x'inhu ħażin -- it-traduzzjoni hija żbaljata? l-ifformattjar huwa miksur b'xi?
|
|
63
|
+
* ġentilment toffri suġġeriment għal traduzzjoni aħjar, jew kif it-test għandu jkun ifformattjat kif suppost
|
|
64
|
+
* **Grazzi!**
|
|
65
|
+
|
|
66
|
+
## Għaliex Mobiletto?
|
|
67
|
+
|
|
68
|
+
### Goodbye lock-in tal-bejjiegħ!
|
|
69
|
+
Id-diversi fornituri tal-ħażna tas-sħab għandhom APIs inkompatibbli. Anke dawk li jistinkaw għal "kompatibilità S3"
|
|
70
|
+
għandhom imġieba idjosinkratika.
|
|
71
|
+
|
|
72
|
+
Meta tagħżel bejjiegħ tal-ħażna partikolari għall-app tiegħek, jekk tikkodifika direttament għall-API tagħhom, l-app tiegħek
|
|
73
|
+
issa hija dipendenti fuq dak is-servizz. Hekk kif jgħaddi ż-żmien u jakkumula l-kodiċi, il-bejjiegħa jinbidlu jsiru
|
|
74
|
+
dejjem aktar insostenibbli. Merħba fid-dinja divertenti tal-lokk tal-bejjiegħ!
|
|
75
|
+
|
|
76
|
+
Mobiletto kien iddisinjat biex isolvi din il-problema. Billi tikkodifika l-app tiegħek għall-API ta' mobiletto, tista' faċilment
|
|
77
|
+
ibdel il-fornituri tal-ħażna u kun af li s-saff tal-ħażna tal-app tiegħek se jġib ruħu b'mod identiku.
|
|
78
|
+
|
|
79
|
+
### Ittestjar estensiv
|
|
80
|
+
Is-sewwieqa kollha huma ttestjati għal imġieba identika b'60+ test għal kull sewwieq.
|
|
81
|
+
Aħna nittestjaw is-sewwieqa kollha b'kull kombinazzjoni ta':
|
|
82
|
+
* Encryption: kemm attivat kif ukoll diżattivat
|
|
83
|
+
* Redis cache: kemm attivat kif ukoll diżattivat
|
|
84
|
+
|
|
85
|
+
Dan l-approċċ jagħtina s-serħan tal-moħħ li mobiletto se jġib ruħu l-istess irrispettivament minn liema sewwieq tuża,
|
|
86
|
+
u irrispettivament minn jekk tippermettix il-caching u/jew l-encryption.
|
|
87
|
+
|
|
88
|
+
### Appoġġ għas-sewwieq
|
|
89
|
+
Is-sewwieqa attwali tal-ħażna tal-Mobiletto:
|
|
90
|
+
* `s3` : Amazon S3
|
|
91
|
+
* `b2` : Backblaze B2
|
|
92
|
+
* `local` : sistema ta' fajls lokali
|
|
93
|
+
|
|
94
|
+
*Kontribuzzjonijiet biex jappoġġjaw aktar fornituri tal-ħażna tas-sħab huma milqugħa ħafna!*
|
|
95
|
+
|
|
96
|
+
## mobiletto-cli
|
|
97
|
+
Mobiletto huwa maħsub biex jintuża bħala librerija minn kodiċi JavaScript ieħor.
|
|
98
|
+
|
|
99
|
+
Biex taħdem ma 'mobiletto fil-linja tal-kmand, uża [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
|
|
100
|
+
|
|
101
|
+
## Sors
|
|
102
|
+
* [mobiletto fuq GitHub](https://github.com/cobbzilla/mobiletto)
|
|
103
|
+
* [mobiletto fuq npm](https://www.npmjs.com/package/mobiletto)
|
|
104
|
+
|
|
105
|
+
## Quick Start
|
|
106
|
+
Eżempju qasir bl-użu tas-sewwieq tal-mobiletto `s3` .
|
|
107
|
+
|
|
108
|
+
Dan il-kodiċi jaħdem bl-istess mod jekk is-sewwieq ikun `b2` " jew `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
|
+
## Użu bażiku
|
|
139
|
+
Eżempju ħafna aktar estensiv, li juri ħafna mill-karatteristiċi offruti:
|
|
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
|
+
Il-kmand tal- `metadata` ' jirritorna metadata dwar dħul wieħed tas-sistema tal-fajls.
|
|
242
|
+
Bl-istess mod, il-valur tar-ritorn mill-kmand tal- `list` huwa firxa ta' oġġetti ta' metadejta.
|
|
243
|
+
|
|
244
|
+
Oġġett tal-metadejta jidher bħal dan:
|
|
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
|
+
Il-proprjetà `type` tista' tkun `file` file", `dir` ", `link` , jew `special` .
|
|
255
|
+
|
|
256
|
+
Skont it-tip ta' sewwieq, kmand `list` jista' ma jirritornax l-oqsma kollha. Il-proprjetajiet `name` u `type` .
|
|
257
|
+
għandhom dejjem ikunu preżenti. Kmand ta `metadata` sussegwenti se jirritorna l-proprjetajiet kollha disponibbli.
|
|
258
|
+
|
|
259
|
+
## Stil ta' importazzjoni alternattiv
|
|
260
|
+
Importa l-modulu b'ambitu sħiħ u uża l-funzjoni `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
|
+
## Caching
|
|
268
|
+
Mobiletto jaħdem l-aħjar <a href="https://redis.io">b'redis</a> cache.
|
|
269
|
+
|
|
270
|
+
Mobiletto se jipprova jikkonnettja ma 'istanza redis fuq 127.0.0.1:6379
|
|
271
|
+
|
|
272
|
+
Tista' tegħleb xi waħda minn dawn:
|
|
273
|
+
* Issettja l-env var `MOBILETTO_REDIS_HOST` , mobiletto tikkonnettja hawn minflok localhost
|
|
274
|
+
* Issettja l-env var `MOBILETTO_REDIS_PORT` , dan il-port se jintuża
|
|
275
|
+
|
|
276
|
+
Mobiletto se jaħżen iċ-ċwievet redis kollha tiegħu bil-prefiss `_mobiletto__` . Tista' tibdel dan
|
|
277
|
+
billi tissettja l-env var `MOBILETTO_REDIS_PREFIX` .
|
|
278
|
+
|
|
279
|
+
Tista' wkoll tissettja caching għal kull konnessjoni bl-oġġett `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
|
+
### Ma tridx redis caching?
|
|
291
|
+
Biex tiddiżattiva: għaddi `enabled: false` fl-oġġett `opts.redisConfig` tiegħek meta tistabbilixxi l-konnessjoni tiegħek.
|
|
292
|
+
|
|
293
|
+
Kif diskuss hawn taħt, id-diżattivazzjoni tal-caching se jkollha effett negattiv fuq il-prestazzjoni u se twassal għal aktar talbiet
|
|
294
|
+
għall-ħażna li int verament bżonn.
|
|
295
|
+
|
|
296
|
+
### Gwida dwar il-caching
|
|
297
|
+
**Ħażna encrypted**: il-qari/kitba tal-ħażna encrypted hija biss ftit aktar bil-mod min-normal,
|
|
298
|
+
iżda n-navigazzjoni madwar id-direttorji (li jagħmlu xi affarijiet) hija pjuttost għalja. Uża redis cache
|
|
299
|
+
jagħtik spinta sinifikanti fil-prestazzjoni.
|
|
300
|
+
|
|
301
|
+
Il-cache default huwa sigur, iżda ma jwettaqx tajjeb jekk għandek ħafna operazzjonijiet ta 'kitba/tneħħija.
|
|
302
|
+
Kwalunkwe operazzjoni ta 'kitba jew tneħħija tinvalida l-cache kollu, u tiżgura li qari sussegwenti se tara l-
|
|
303
|
+
l-aħħar bidliet.
|
|
304
|
+
|
|
305
|
+
### Għodod CLI
|
|
306
|
+
Jekk qed tuża għodda CLI bħal [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
|
|
307
|
+
definittivament trid li l-cache redis tkun attivata, peress li ddum matul invokazzjonijiet tal-kmand `mo` .
|
|
308
|
+
|
|
309
|
+
## Mirroring
|
|
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
|
+
Il-kmand `mirror` jagħmel kopja ta' darba tal-fajls kollha minn mobiletto għal ieħor.
|
|
318
|
+
Ma tmexxi l-ebda proċess biex iżżomm il-mera maż-żmien. Mexxi l-kmand `mirror` mill-ġdid
|
|
319
|
+
biex tissinkronizza kwalunkwe fajl nieqes.
|
|
320
|
+
|
|
321
|
+
Il-valur tar-ritorn minn `mirror` huwa oġġett sempliċi b'counters għal kemm fajls kienu b'suċċess
|
|
322
|
+
riflessi u kemm fajls kellhom żbalji:
|
|
323
|
+
|
|
324
|
+
{
|
|
325
|
+
success: count-of-files-mirrored,
|
|
326
|
+
errors: count-of-files-with-errors
|
|
327
|
+
}
|
|
328
|
+
|
|
329
|
+
TWISSIJA: Il-mirroring ta' settijiet ta' dejta kbar jista' jieħu ħafna ħin u juża ħafna bandwidth
|
|
330
|
+
|
|
331
|
+
Bis-semantika tas-sejħiet `mirror` drabi tista' tkun konfuża biex tifhem min hu
|
|
332
|
+
qarrej u min hu l-kittieb. Immaġinaha bħal dikjarazzjoni ta' assenjazzjoni: il-"mobiletto tax-xellug"
|
|
333
|
+
hija l-ħaġa li qed tiġi assenjata lil (data riflessa bil-miktub), u l-"mobiletto tal-lemin" (il-
|
|
334
|
+
argument għall-metodu `mirror` ) huwa l-valur li qed jiġi assenjat (id-data riflessa tinqara).
|
|
335
|
+
|
|
336
|
+
## Encryption trasparenti
|
|
337
|
+
Ippermetti kodifikazzjoni trasparenti min-naħa tal-klijent:
|
|
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
|
+
X'qiegħed jiġri? Direttorju separat ta' "dħul fid-direttorju" (direttorju) (kodifikat) isegwi liema fajls hemm f'dak
|
|
357
|
+
direttorju (magħruf ukoll bħala d-direttorju dirent).
|
|
358
|
+
* Il-kmand `list` jaqra l-fajls tad-dħul tad-direttorju, jiddeċifra kull mogħdija elenkata; imbagħad jirritorna metadata għal kull fajl
|
|
359
|
+
* Kmandi tal- `list` huma aktar ineffiċjenti, speċjalment għal direttorji b'numru kbir ta' fajls
|
|
360
|
+
* Il-kmand `write` jikteb fajls dirent fid-direttorju dirent ta' kull ġenitur, b'mod rikorsiv; imbagħad jikteb il-fajl
|
|
361
|
+
* `write` se jġibu O(N) writes, b'N = depth fil-ġerarkija tad-direttorju
|
|
362
|
+
* Il-kmand `remove` ineħħi l-fajl dirent korrispondenti, u l-ġenitur tiegħu jekk vojt, b'mod rikorsiv; imbagħad tneħħi l-fajl
|
|
363
|
+
* Kmandi ta `remove` mhux rikursivi se jġarrbu qari O(N) u potenzjalment daqstant tħassir, b'N = fond fil-ġerarkija tad-direttorju
|
|
364
|
+
* `remove` rikursivi fuq sistemi ta' fajls kbar u profondi jistgħu jkunu għaljin
|
|
365
|
+
|
|
366
|
+
Innota li anke bil-kriptaġġ min-naħa tal-klijent attivat, avversarju b'viżibilità sħiħa fin-naħa tas-server kriptat tiegħek
|
|
367
|
+
ħażna, anki mingħajr iċ-ċavetta, xorta jistgħu jaraw in-numru totali ta 'direttorji u kemm fajls huma f'kull wieħed, u ma
|
|
368
|
+
xi sforz, skopri ftit jew l-istruttura ġenerali tal-ġerarkija tad-direttorju.
|
|
369
|
+
*Nota: Uża struttura relattivament ċatta għal sigurtà aħjar.*
|
|
370
|
+
L-avversarju ma jkunx jaf l-ismijiet tad-direttorji/fajls sakemm ma jkunux jafu wkoll l-encryption tiegħek
|
|
371
|
+
ċavetta jew inkella kien ikkrekkjat b'suċċess l-encryption. L-imħatri kollha huma mitfija allura!
|
|
372
|
+
|
|
373
|
+
### Prestazzjoni u caching
|
|
374
|
+
L-operazzjonijiet fuq il-ħażna kriptata jistgħu jkunu bil-mod. Listi u tneħħija rikorsivi jistgħu jkunu bil-mod ħafna.
|
|
375
|
+
Il-caching permezz ta' redis jgħin bil-kbir, iżda innota li l-cache titlaħlaħ fuq kwalunkwe kitba jew tneħħija.
|
|
376
|
+
|
|
377
|
+
## Rotazzjoni taċ-ċavetta
|
|
378
|
+
Oħloq mobiletto biċ-ċavetta l-ġdida tiegħek, imbagħad immarka d-dejta l-antika fiha:
|
|
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ċċja tas-sewwieq
|
|
391
|
+
Driver huwa kwalunkwe fajl JS li jesporta funzjoni 'storageClient' b'din il-firma:
|
|
392
|
+
|
|
393
|
+
function storageClient (key, secret, opts)
|
|
394
|
+
|
|
395
|
+
* `key` : string, iċ-ċavetta API tiegħek (għax-sewwieq `local` dan huwa d-direttorju bażi)
|
|
396
|
+
* `secret` : string, is-sigriet tal-API tiegħek (jista' jitħalla barra għas-sewwieq `local` )
|
|
397
|
+
* `opts` : oġġett, il-proprjetajiet huma għal kull sewwieq:
|
|
398
|
+
* Għal `local` , il- `fileMode` " u `dirMode` jiddeterminaw kif jinħolqu fajls u direttorji ġodda li joħolqu
|
|
399
|
+
* Għal `s3` , il-proprjetà `bucket` hija meħtieġa. Proprjetajiet fakultattivi huma:
|
|
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
|
+
L-oġġett li l-funzjoni storageClient jirritorna għandu jiddefinixxi dawn il-funzjonijiet:
|
|
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
|
+
## Logging
|
|
431
|
+
Mobiletto juża l-librerija tal-illoggjar [winston](https://www.npmjs.com/package/winston).
|
|
432
|
+
|
|
433
|
+
Iz-zkuk **se** ikun fihom mogħdijiet tal-fajls u messaġġi ta' żball, iżda **qatt** se jkun fihom ċwievet, sigrieti,
|
|
434
|
+
jew kwalunkwe informazzjoni oħra dwar il-konfigurazzjoni tal-konnessjoni.
|
|
435
|
+
|
|
436
|
+
### Livell ta’ log
|
|
437
|
+
Uża l-varjabbli tal-ambjent `MOBILETTO_LOG_LEVEL` biex tissettja l-livell tal-log, billi tuża waħda
|
|
438
|
+
tal-livelli `npm` definiti fi [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
|
|
439
|
+
|
|
440
|
+
Il-livell default huwa `error` . L-aktar livell verbose huwa `silly` , għalkemm bħalissa mobiletto
|
|
441
|
+
ma jilloggjax f'livelli taħt `debug`
|
|
442
|
+
|
|
443
|
+
MOBILETTO_LOG_LEVEL=silly # maximum logs!
|
|
444
|
+
|
|
445
|
+
### Log file
|
|
446
|
+
B'mod awtomatiku, il-logger jikteb fuq il-console. Biex tibgħat zkuk għal fajl, issettja l- `MOBILETTO_LOG_FILE`
|
|
447
|
+
varjabbli ambjentali. Meta tilloggja għal fajl, zkuk ma jibqgħux jinkitbu fuq il-console.
|
|
448
|
+
|
|
449
|
+
MOBILETTO_LOG_FILE=/var/my_mobiletto_log
|
|
450
|
+
|
|
451
|
+
Biex itfi l-illoggjar:
|
|
452
|
+
|
|
453
|
+
MOBILETTO_LOG_FILE=/dev/null
|
|
454
|
+
|
|
455
|
+
</pre>
|