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 se yon kouch abstraksyon depo JavaScript, ak si ou vle chifreman transparan bò kliyan.
|
|
5
|
+
|
|
6
|
+
# Kontni
|
|
7
|
+
* [Poukisa Mobiletto?](#Poukisa-Mobiletto?)
|
|
8
|
+
* [Kòmanse rapid](#Kòmanse rapid)
|
|
9
|
+
* [Mobiletto CLI](#mobiletto-cli)
|
|
10
|
+
* [Sous](#Sous)
|
|
11
|
+
* [Itilizasyon debaz](#Itilizasyon debaz)
|
|
12
|
+
* [Metadone](#Metadone)
|
|
13
|
+
* [Altènatif enpòte style](#Altènatif-enpòte-style)
|
|
14
|
+
* [Caching](#Caching)
|
|
15
|
+
* [Mirroring](#Mirroring)
|
|
16
|
+
* [Transparan chifreman](#Transparent-chiffrement)
|
|
17
|
+
* [Wotasyon kle](#Kle-wotasyon)
|
|
18
|
+
* [Koòdone chofè](#Driver-koòdone)
|
|
19
|
+
* [Logging](#Logging)
|
|
20
|
+
|
|
21
|
+
# Li sa nan yon lòt lang
|
|
22
|
+
Dokiman README.md sa a te tradui, atravè [hokeylization](https://github.com/cobbzilla/hokeylization), nan
|
|
23
|
+
**[chak lang Google Translate sipòte](https://cloud.google.com/translate/docs/languages)!**
|
|
24
|
+
|
|
25
|
+
Mwen sèten li pa pafè, men mwen espere ke li pi bon pase anyen!
|
|
26
|
+
|
|
27
|
+
[🇸🇦 Arabe](../ar/README.md)
|
|
28
|
+
[🇧🇩 Bengali](../bn/README.md)
|
|
29
|
+
[🇩🇪 Alman](../de/README.md)
|
|
30
|
+
[🇺🇸 Angle](../en/README.md)
|
|
31
|
+
[🇪🇸 Panyòl](../es/README.md)
|
|
32
|
+
[🇫🇷 Franse](../fr/README.md)
|
|
33
|
+
[🇹🇩 Hausa](../ha/README.md)
|
|
34
|
+
[🇮🇳 Hindi](../hi/README.md)
|
|
35
|
+
[🇮🇩 Endonezyen](../id/README.md)
|
|
36
|
+
[🇮🇹 Italyen](../it/README.md)
|
|
37
|
+
[🇯🇵 Japonè](../ja/README.md)
|
|
38
|
+
[🇰🇷 Koreyen](../ko/README.md)
|
|
39
|
+
[🇮🇳 Maranthi](../mr/README.md)
|
|
40
|
+
[🇵🇱 Polonè](../pl/README.md)
|
|
41
|
+
[🇧🇷 Pòtigè](../pt/README.md)
|
|
42
|
+
[🇷🇺 Ris](../ru/README.md)
|
|
43
|
+
[🇰🇪 Swahili](../sw/README.md)
|
|
44
|
+
[🇵🇭 Tagalog](../tl/README.md)
|
|
45
|
+
[🇹🇷 Tik](../tr/README.md)
|
|
46
|
+
[🇵🇰 Oudou](../ur/README.md)
|
|
47
|
+
[🇻🇳 Vyetnamyen](../vi/README.md)
|
|
48
|
+
[🇨🇳 Chinwa](../zh/README.md)
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
**[📚 ... Tout Lang ...](../README.md)**
|
|
52
|
+
----
|
|
53
|
+
|
|
54
|
+
### Èske gen yon pwoblèm ak tradiksyon README sa a?
|
|
55
|
+
Tradiksyon patikilye sa a orijinal [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
|
|
56
|
+
ka gen defo -- *koreksyon yo trè akeyi!* Tanpri voye yon [pull demand sou GitHub](https://github.com/cobbzilla/mobiletto/pulls),
|
|
57
|
+
oswa si w pa konfòtab pou w fè sa, [louvri yon pwoblèm](https://github.com/cobbzilla/mobiletto/issues)
|
|
58
|
+
|
|
59
|
+
Lè ou kreye yon nouvo pwoblèm GitHub sou yon tradiksyon, tanpri fè:
|
|
60
|
+
* enkli URL paj la (kopi/kole nan ba adrès navigatè a)
|
|
61
|
+
* enkli tèks egzak ki mal (kopi/kole nan navigatè a)
|
|
62
|
+
* Tanpri dekri sa ki mal -- èske tradiksyon an pa kòrèk? se fòma a kase yon jan kanmenm?
|
|
63
|
+
* Tanpri ofri yon sijesyon pou yon pi bon tradiksyon, oswa ki jan tèks la ta dwe byen fòma
|
|
64
|
+
* **Mèsi!**
|
|
65
|
+
|
|
66
|
+
## Poukisa Mobiletto?
|
|
67
|
+
|
|
68
|
+
### Orevwa machann lock-in!
|
|
69
|
+
Divès kalite founisè depo nwaj yo gen API enkonpatib. Menm moun ki fè efò pou "S3 konpatibilite"
|
|
70
|
+
gen konpòtman idiosinkratik.
|
|
71
|
+
|
|
72
|
+
Lè w chwazi yon machann depo patikilye pou aplikasyon w lan, si w kode dirèkteman nan API yo, aplikasyon w lan
|
|
73
|
+
se kounye a depann sou sèvis sa a. Kòm tan ap pase ak kòd akimile, chanje fournisseurs vin
|
|
74
|
+
de pli zan pli insoutenab. Byenveni nan mond lan amizan nan fèmen vandè!
|
|
75
|
+
|
|
76
|
+
Mobiletto te fèt pou rezoud pwoblèm sa a. Lè w kode aplikasyon w lan nan API mobiletto a, ou ka fasilman
|
|
77
|
+
chanje founisè depo epi konnen ke kouch depo app ou a ap konpòte menm jan an.
|
|
78
|
+
|
|
79
|
+
### Tès vaste
|
|
80
|
+
Tout chofè yo teste pou konpòtman ki idantik ak plis pase 60 tès pou chak chofè.
|
|
81
|
+
Nou teste tout chofè ak tout konbinezon de:
|
|
82
|
+
* Chifre: tou de aktive ak enfim
|
|
83
|
+
* Redis kachèt: tou de aktive ak enfim
|
|
84
|
+
|
|
85
|
+
Apwòch sa a ban nou lapè-of-espri ke mobiletto pral konpòte menm jan kèlkeswa chofè ou itilize,
|
|
86
|
+
ak kèlkeswa si ou pèmèt kachèt ak/oswa chifreman.
|
|
87
|
+
|
|
88
|
+
### Sipò chofè
|
|
89
|
+
Chofè depo Mobiletto aktyèl yo:
|
|
90
|
+
* `s3` : Amazon S3
|
|
91
|
+
* `b2` : Backblaze B2
|
|
92
|
+
* `local` : sistèm dosye lokal
|
|
93
|
+
|
|
94
|
+
*Kontribisyon pou sipòte plis founisè depo nwaj yo trè akeyi!*
|
|
95
|
+
|
|
96
|
+
## mobiletto-cli
|
|
97
|
+
Mobiletto fèt pou itilize kòm yon bibliyotèk pa lòt kòd JavaScript.
|
|
98
|
+
|
|
99
|
+
Pou travay ak mobiletto nan liy lòd la, sèvi ak [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
|
|
100
|
+
|
|
101
|
+
## Sous
|
|
102
|
+
* [mobiletto sou GitHub](https://github.com/cobbzilla/mobiletto)
|
|
103
|
+
* [mobiletto sou npm](https://www.npmjs.com/package/mobiletto)
|
|
104
|
+
|
|
105
|
+
## Kòmanse rapid
|
|
106
|
+
Yon egzanp kout lè l sèvi avèk chofè mobiletto `s3` .
|
|
107
|
+
|
|
108
|
+
Kòd sa a ta kouri menm si chofè a te `b2` oswa `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
|
+
## Itilizasyon debaz
|
|
139
|
+
Yon egzanp pi plis vaste, ki montre pi fò nan karakteristik yo ofri:
|
|
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
|
+
Kòmand `metadata` la retounen metadata sou yon sèl antre sistèm fichye.
|
|
242
|
+
Menm jan an tou, valè retounen nan lòd `list` la se yon etalaj de objè metadata.
|
|
243
|
+
|
|
244
|
+
Yon objè metadata sanble sa a:
|
|
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
|
+
Pwopriyete `type` a kapab `file` , `dir` , `link` , oswa `special` .
|
|
255
|
+
|
|
256
|
+
Tou depan de kalite chofè a, yon lòd `list` ka pa retounen tout jaden yo. Pwopriyete `name` ak `type`
|
|
257
|
+
ta dwe toujou prezan. Yon lòd `metadata` ki vin apre ap retounen tout pwopriyete ki disponib yo.
|
|
258
|
+
|
|
259
|
+
## Altène style enpòte
|
|
260
|
+
Enpòte modil totalman an epi sèvi ak fonksyon `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
|
+
## Cache
|
|
268
|
+
Mobiletto travay pi byen ak yon kachèt <a href="https://redis.io">redis</a> .
|
|
269
|
+
|
|
270
|
+
Mobiletto pral eseye konekte ak yon egzanp redis sou 127.0.0.1:6379
|
|
271
|
+
|
|
272
|
+
Ou ka depase youn nan sa yo:
|
|
273
|
+
* Mete `MOBILETTO_REDIS_HOST` env var, mobiletto konekte isit la olye de localhost
|
|
274
|
+
* Mete `MOBILETTO_REDIS_PORT` env var, pò sa a pral itilize
|
|
275
|
+
|
|
276
|
+
Mobiletto pral estoke tout kle redis li yo ak prefiks `_mobiletto__` . Ou ka chanje sa
|
|
277
|
+
pa mete `MOBILETTO_REDIS_PREFIX` env var.
|
|
278
|
+
|
|
279
|
+
Ou kapab tou mete kach pou chak koneksyon ak objè `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
|
+
### Ou pa vle redis kachèt?
|
|
291
|
+
Pou enfim: pase `enabled: false` nan objè `opts.redisConfig` ou lè ou etabli koneksyon ou.
|
|
292
|
+
|
|
293
|
+
Jan yo diskite pi ba a, enfimite kachèt pral gen yon efè negatif sou pèfòmans ak antrene plis demann
|
|
294
|
+
nan depo ke ou reyèlman bezwen.
|
|
295
|
+
|
|
296
|
+
### Kache konsèy
|
|
297
|
+
**Depo kode**: lekti/ekri depo kode se sèlman yon ti kras pi dousman pase nòmal,
|
|
298
|
+
men navige nan repèrtwar (ki kèk bagay fè) se jistis chè. Sèvi ak yon kachèt redis
|
|
299
|
+
pral ba ou yon ogmantasyon siyifikatif pèfòmans.
|
|
300
|
+
|
|
301
|
+
Kachèt default la an sekirite, men li pa fè byen si ou gen anpil operasyon ekri/retire.
|
|
302
|
+
Nenpòt operasyon ekri oswa retire invalid kachèt la tout antye, asire lekti ki vin apre yo pral wè
|
|
303
|
+
dènye chanjman.
|
|
304
|
+
|
|
305
|
+
### CLI zouti
|
|
306
|
+
Si w ap itilize yon zouti CLI tankou [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
|
|
307
|
+
ou pral definitivman vle redis kachèt la aktive, kòm li dire atravè envokasyon nan lòd `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
|
+
`mirror` la fè yon kopi yon sèl fwa nan tout dosye soti nan yon mobiltto nan yon lòt.
|
|
318
|
+
Li pa kouri okenn pwosesis pou kenbe glas la sou tan. Kouri kòmand `mirror` ankò
|
|
319
|
+
pou senkronize nenpòt ki dosye ki manke.
|
|
320
|
+
|
|
321
|
+
Valè retounen nan `mirror` se yon objè senp ak kontè pou konbyen dosye yo te reyisi
|
|
322
|
+
reflete ak konbyen dosye ki te gen erè:
|
|
323
|
+
|
|
324
|
+
{
|
|
325
|
+
success: count-of-files-mirrored,
|
|
326
|
+
errors: count-of-files-with-errors
|
|
327
|
+
}
|
|
328
|
+
|
|
329
|
+
AVÈTISMAN: Reflete seri gwo done yo ka pran anpil tan ak Pleasant-entansif
|
|
330
|
+
|
|
331
|
+
Avèk semantik apèl `mirror` li pafwa kapab konfizyon pou w konprann kiyès ki la
|
|
332
|
+
lektè ak ki moun ki ekriven an. Imajine li tankou yon deklarasyon devwa: "mobiletto nan men gòch"
|
|
333
|
+
se bagay yo te plase nan (replike done ekri), ak "mobiletto adwat" (la
|
|
334
|
+
agiman nan metòd `mirror` ) se valè yo te bay (done yo miroir li).
|
|
335
|
+
|
|
336
|
+
## Chifre transparan
|
|
337
|
+
Pèmèt transparan chifreman bò kliyan:
|
|
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
|
+
Sak ap pase? Yon separe "antre anyè" (direksyon) anyè (chiffre) swiv ki fichye yo nan sa
|
|
357
|
+
anyè (aka anyè dirent).
|
|
358
|
+
* `list` la li dosye yo antre anyè, dekripte chak chemen ki nan lis la; Lè sa a, retounen metadata pou chak dosye
|
|
359
|
+
* `list` yo pi efikas, espesyalman pou anyè ki gen yon gwo kantite fichye
|
|
360
|
+
* `write` ekri fichye dirent nan anyè diret chak paran, yon fason rekursif; Lè sa a, ekri fichye a
|
|
361
|
+
* `write` yo pral fè O(N) ekri, ak N = pwofondè nan yerachi anyè a.
|
|
362
|
+
* `remove` retire fichye dirent ki koresponn lan, ak paran li si li vid, yon fason repetitif; Lè sa a, retire dosye a
|
|
363
|
+
* `remove` ki pa rekursif yo pral fè lekti O(N) ak potansyèlman anpil efase, ak N = pwofondè nan yerachi anyè a.
|
|
364
|
+
* `remove` repetitif sou sistèm fichye gwo ak gwo twou san fon ka chè
|
|
365
|
+
|
|
366
|
+
Remake byen ke menm avèk chifreman bò kliyan pèmèt, yon advèsè ki gen yon vizibilite konplè sou bò sèvè chiffres ou.
|
|
367
|
+
depo, menm san kle a, ka toujou wè kantite total anyè ak konbyen fichye yo nan chak, ak
|
|
368
|
+
kèk efò, dekouvri kèk oswa tout estrikti an jeneral nan yerachi anyè a.
|
|
369
|
+
*Remak: Sèvi ak yon estrikti relativman plat pou pi bon sekirite.*
|
|
370
|
+
Advèsè a pa ta konnen non anyè / fichye yo sof si yo te konnen tou chifreman ou
|
|
371
|
+
kle oswa te gen otreman avèk siksè fann chifreman an. Lè sa a, tout parye yo koupe!
|
|
372
|
+
|
|
373
|
+
### Pèfòmans ak kachèt
|
|
374
|
+
Operasyon sou depo chiffres kapab dousman. Lis rekursif ak retire ka trè dousman.
|
|
375
|
+
Cache atravè redis ede anpil, men sonje ke kachèt la vide sou nenpòt ki ekri oswa retire.
|
|
376
|
+
|
|
377
|
+
## Wotasyon kle
|
|
378
|
+
Kreye yon mobiletto ak nouvo kle ou a, epi reflete ansyen done yo nan li:
|
|
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
|
+
## Koòdone chofè
|
|
391
|
+
Yon chofè se nenpòt fichye JS ki ekspòte yon fonksyon 'storageClient' ak siyati sa a:
|
|
392
|
+
|
|
393
|
+
function storageClient (key, secret, opts)
|
|
394
|
+
|
|
395
|
+
* `key` : yon kòd, kle API ou (pou chofè `local` sa a se anyè debaz la)
|
|
396
|
+
* `secret` : yon kòd, sekrè API ou (yo ka omisyon pou chofè `local` )
|
|
397
|
+
* `opts` : yon objè, pwopriyete yo se pou chak chofè:
|
|
398
|
+
* Pou `local` , pwopriyete `fileMode` ak `dirMode` detèmine fason yo kreye nouvo fichye ak anyè.
|
|
399
|
+
* Pou `s3` , pwopriyete a `bucket` obligatwa. Pwopriyete opsyonèl yo se:
|
|
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
|
+
Objè ke fonksyon storageClient retounen dwe defini fonksyon sa yo:
|
|
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
|
+
## Enregistrement
|
|
431
|
+
Mobiletto sèvi ak bibliyotèk ki anrejistre [winston](https://www.npmjs.com/package/winston).
|
|
432
|
+
|
|
433
|
+
Jounal yo **ap** gen ladann chemen fichye yo ak mesaj erè, men yo p ap **pa janm** genyen kle, sekrè,
|
|
434
|
+
oswa nenpòt lòt enfòmasyon konfigirasyon koneksyon.
|
|
435
|
+
|
|
436
|
+
### Log nivo
|
|
437
|
+
Sèvi ak varyab anviwònman `MOBILETTO_LOG_LEVEL` pou mete nivo mòso a, lè l sèvi avèk youn
|
|
438
|
+
nan nivo `npm` yo defini nan [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
|
|
439
|
+
|
|
440
|
+
Nivo default la se `error` . Nivo ki pi pwolib la se `silly` , byenke kounye a mobiletto
|
|
441
|
+
pa konekte nan nivo anba a `debug`
|
|
442
|
+
|
|
443
|
+
MOBILETTO_LOG_LEVEL=silly # maximum logs!
|
|
444
|
+
|
|
445
|
+
### Log dosye
|
|
446
|
+
Pa default, logger la ekri nan konsole a. Pou voye mòso bwa nan yon dosye, mete `MOBILETTO_LOG_FILE`
|
|
447
|
+
anviwònman varyab. Lè w ap antre nan yon dosye, mòso bwa yo p ap ekri sou konsole a ankò.
|
|
448
|
+
|
|
449
|
+
MOBILETTO_LOG_FILE=/var/my_mobiletto_log
|
|
450
|
+
|
|
451
|
+
Pou fèmen enregistrement:
|
|
452
|
+
|
|
453
|
+
MOBILETTO_LOG_FILE=/dev/null
|
|
454
|
+
|
|
455
|
+
</pre>
|