mobiletto 1.2.1 → 2.0.0
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/lib/cjs/index.d.ts +2 -0
- package/lib/cjs/index.js +30 -0
- package/lib/cjs/package.json +16 -0
- package/lib/esm/index.d.ts +2 -0
- package/lib/esm/index.js +12 -0
- package/package.json +27 -13
- package/.babelrc +0 -5
- package/.eslintrc.js +0 -14
- package/docs/README.md +0 -113
- package/docs/af/README.md +0 -481
- package/docs/am/README.md +0 -481
- package/docs/ar/README.md +0 -481
- package/docs/az/README.md +0 -481
- package/docs/be/README.md +0 -481
- package/docs/bg/README.md +0 -481
- package/docs/bn/README.md +0 -481
- package/docs/bs/README.md +0 -481
- package/docs/ca/README.md +0 -481
- package/docs/ceb/README.md +0 -481
- package/docs/co/README.md +0 -481
- package/docs/cs/README.md +0 -481
- package/docs/cy/README.md +0 -481
- package/docs/da/README.md +0 -481
- package/docs/de/README.md +0 -481
- package/docs/el/README.md +0 -481
- package/docs/eo/README.md +0 -481
- package/docs/es/README.md +0 -481
- package/docs/et/README.md +0 -481
- package/docs/eu/README.md +0 -481
- package/docs/fa/README.md +0 -481
- package/docs/fi/README.md +0 -481
- package/docs/fr/README.md +0 -481
- package/docs/fy/README.md +0 -481
- package/docs/ga/README.md +0 -481
- package/docs/gd/README.md +0 -481
- package/docs/gl/README.md +0 -481
- package/docs/gu/README.md +0 -481
- package/docs/ha/README.md +0 -481
- package/docs/haw/README.md +0 -481
- package/docs/he/README.md +0 -481
- package/docs/hi/README.md +0 -481
- package/docs/hmn/README.md +0 -481
- package/docs/hr/README.md +0 -481
- package/docs/ht/README.md +0 -481
- package/docs/hu/README.md +0 -481
- package/docs/hy/README.md +0 -481
- package/docs/id/README.md +0 -481
- package/docs/ig/README.md +0 -481
- package/docs/is/README.md +0 -481
- package/docs/it/README.md +0 -481
- package/docs/iw/README.md +0 -481
- package/docs/ja/README.md +0 -481
- package/docs/jv/README.md +0 -481
- package/docs/ka/README.md +0 -481
- package/docs/kk/README.md +0 -481
- package/docs/km/README.md +0 -481
- package/docs/kn/README.md +0 -481
- package/docs/ko/README.md +0 -481
- package/docs/ku/README.md +0 -481
- package/docs/ky/README.md +0 -481
- package/docs/la/README.md +0 -481
- package/docs/lb/README.md +0 -481
- package/docs/lo/README.md +0 -481
- package/docs/lt/README.md +0 -481
- package/docs/lv/README.md +0 -481
- package/docs/mg/README.md +0 -481
- package/docs/mi/README.md +0 -481
- package/docs/mk/README.md +0 -481
- package/docs/ml/README.md +0 -481
- package/docs/mn/README.md +0 -481
- package/docs/mr/README.md +0 -481
- package/docs/ms/README.md +0 -481
- package/docs/mt/README.md +0 -481
- package/docs/my/README.md +0 -481
- package/docs/ne/README.md +0 -481
- package/docs/nl/README.md +0 -481
- package/docs/no/README.md +0 -481
- package/docs/ny/README.md +0 -481
- package/docs/or/README.md +0 -481
- package/docs/pa/README.md +0 -481
- package/docs/pl/README.md +0 -481
- package/docs/ps/README.md +0 -481
- package/docs/pt/README.md +0 -481
- package/docs/ro/README.md +0 -481
- package/docs/ru/README.md +0 -481
- package/docs/rw/README.md +0 -481
- package/docs/sd/README.md +0 -481
- package/docs/si/README.md +0 -481
- package/docs/sk/README.md +0 -481
- package/docs/sl/README.md +0 -481
- package/docs/sm/README.md +0 -481
- package/docs/sn/README.md +0 -481
- package/docs/so/README.md +0 -481
- package/docs/sq/README.md +0 -481
- package/docs/sr/README.md +0 -481
- package/docs/st/README.md +0 -481
- package/docs/su/README.md +0 -481
- package/docs/sv/README.md +0 -481
- package/docs/sw/README.md +0 -481
- package/docs/ta/README.md +0 -481
- package/docs/te/README.md +0 -481
- package/docs/tg/README.md +0 -481
- package/docs/th/README.md +0 -481
- package/docs/tk/README.md +0 -481
- package/docs/tl/README.md +0 -481
- package/docs/tr/README.md +0 -481
- package/docs/tt/README.md +0 -481
- package/docs/ug/README.md +0 -481
- package/docs/uk/README.md +0 -481
- package/docs/ur/README.md +0 -481
- package/docs/uz/README.md +0 -481
- package/docs/vi/README.md +0 -481
- package/docs/xh/README.md +0 -481
- package/docs/yi/README.md +0 -481
- package/docs/yo/README.md +0 -481
- package/docs/zh/README.md +0 -481
- package/docs/zu/README.md +0 -481
- package/drivers/b2/index.js +0 -451
- package/drivers/local/index.js +0 -315
- package/drivers/s3/index.js +0 -316
- package/hokey.json +0 -16
- package/index.js +0 -29
- package/test/api.spec.js +0 -512
- package/test/crypt.spec.js +0 -67
package/docs/af/README.md
DELETED
|
@@ -1,481 +0,0 @@
|
|
|
1
|
-
Mobiletto
|
|
2
|
-
=========
|
|
3
|
-
|
|
4
|
-
Mobiletto is 'n JavaScript berging abstraksie laag, met opsionele deursigtige kliënt-kant enkripsie.
|
|
5
|
-
|
|
6
|
-
# Inhoud
|
|
7
|
-
* [Hoekom Mobiletto?](#Why-Mobiletto?)
|
|
8
|
-
* [Vinnige begin](#Vinnige begin)
|
|
9
|
-
* [Mobiletto CLI](#mobiletto-cli)
|
|
10
|
-
* [Bron](#Bron)
|
|
11
|
-
* [Installasie](#Installasie)
|
|
12
|
-
* [Ondersteuning en befondsing](#Ondersteuning-en-befondsing)
|
|
13
|
-
* [Basiese gebruik](#Basiese gebruik)
|
|
14
|
-
* [Metadata](#Metadata)
|
|
15
|
-
* [Alternatiewe invoerstyl](#Alternatiewe invoerstyl)
|
|
16
|
-
* [Caching](#Caching)
|
|
17
|
-
* [Mirroring](#Mirroring)
|
|
18
|
-
* [Deursigtige enkripsie](#Deursigtige-enkripsie)
|
|
19
|
-
* [Sleutelrotasie](#Sleutelrotasie)
|
|
20
|
-
* [Drywer-koppelvlak](#Drywer-koppelvlak)
|
|
21
|
-
* [Logging](#Logging)
|
|
22
|
-
|
|
23
|
-
# Lees dit in 'n ander taal
|
|
24
|
-
Hierdie README.md-dokument is vertaal, via [hokeylization](https://github.com/cobbzilla/hokeylization), in
|
|
25
|
-
**[elke taal wat deur Google Translate ondersteun word](https://cloud.google.com/translate/docs/languages)!**
|
|
26
|
-
|
|
27
|
-
Ek is seker dit is nie perfek nie, maar ek hoop dit is beter as niks!
|
|
28
|
-
|
|
29
|
-
[🇸🇦 Arabies](../ar/README.md)
|
|
30
|
-
[🇧🇩 Bengaals](../bn/README.md)
|
|
31
|
-
[🇩🇪 Duits](../de/README.md)
|
|
32
|
-
[🇺🇸 Engels](../en/README.md)
|
|
33
|
-
[🇪🇸 Spaans](../es/README.md)
|
|
34
|
-
[🇫🇷 Frans](../fr/README.md)
|
|
35
|
-
[🇹🇩 Hausa](../ha/README.md)
|
|
36
|
-
[🇮🇳 Hindi](../hi/README.md)
|
|
37
|
-
[🇮🇩 Indonesies](../id/README.md)
|
|
38
|
-
[🇮🇹 Italiaans](../it/README.md)
|
|
39
|
-
[🇯🇵 Japannees](../ja/README.md)
|
|
40
|
-
[🇰🇷 Koreaans](../ko/README.md)
|
|
41
|
-
[🇮🇳 Marathi](../mr/README.md)
|
|
42
|
-
[🇵🇱 Pools](../pl/README.md)
|
|
43
|
-
[🇧🇷 Portugees](../pt/README.md)
|
|
44
|
-
[🇷🇺 Russies](../ru/README.md)
|
|
45
|
-
[🇰🇪 Swahili](../sw/README.md)
|
|
46
|
-
[🇵🇭 Tagalog](../tl/README.md)
|
|
47
|
-
[🇹🇷 Turks](../tr/README.md)
|
|
48
|
-
[🇵🇰 Oerdoe](../ur/README.md)
|
|
49
|
-
[🇻🇳 Viëtnamees](../vi/README.md)
|
|
50
|
-
[🇨🇳 Chinees](../zh/README.md)
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
**[📚 ... Alle tale ...](../README.md)**
|
|
54
|
-
----
|
|
55
|
-
|
|
56
|
-
### Is daar 'n probleem met hierdie vertaling van die README?
|
|
57
|
-
Hierdie spesifieke vertaling van die oorspronklike [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
|
|
58
|
-
mag gebrekkig wees -- *regstellings is baie welkom!* Stuur asseblief 'n [trekversoek op GitHub](https://github.com/cobbzilla/mobiletto/pulls),
|
|
59
|
-
of as jy nie gemaklik is om dit te doen nie, [maak 'n kwessie oop](https://github.com/cobbzilla/mobiletto/issues)
|
|
60
|
-
|
|
61
|
-
Wanneer jy 'n nuwe GitHub-uitgawe oor 'n vertaling skep, doen asseblief:
|
|
62
|
-
* sluit die bladsy-URL in (kopieer/plak vanaf blaaieradresbalk)
|
|
63
|
-
* sluit die presiese teks in wat verkeerd is (kopieer/plak vanaf blaaier)
|
|
64
|
-
* Beskryf asseblief wat fout is -- is die vertaling verkeerd? is die formatering op een of ander manier gebreek?
|
|
65
|
-
* Bied asseblief 'n voorstel van 'n beter vertaling, of hoe die teks behoorlik geformateer moet word
|
|
66
|
-
* **Dankie!**
|
|
67
|
-
|
|
68
|
-
## Hoekom Mobiletto?
|
|
69
|
-
|
|
70
|
-
### Totsiens verkoper toesluit!
|
|
71
|
-
Die verskillende wolkbergingsverskaffers het onversoenbare API's. Selfs diegene wat streef na "S3-versoenbaarheid"
|
|
72
|
-
idiosinkratiese gedrag het.
|
|
73
|
-
|
|
74
|
-
As jy 'n spesifieke bergingverskaffer vir jou program kies, as jy direk na hul API, jou program, kodeer
|
|
75
|
-
is nou van daardie diens afhanklik. Soos die tyd verbygaan en kode ophoop, word veranderende verskaffers
|
|
76
|
-
toenemend onhoudbaar. Welkom by die prettige wêreld van verskaffer-toesluit!
|
|
77
|
-
|
|
78
|
-
Mobiletto is ontwerp om hierdie probleem op te los. Deur jou toepassing na Mobiletto se API te kodeer, kan jy maklik
|
|
79
|
-
verander bergingverskaffers en weet dat jou toepassing se berginglaag identies sal optree.
|
|
80
|
-
|
|
81
|
-
### Uitgebreide toetsing
|
|
82
|
-
Alle bestuurders word getoets vir identiese gedrag met 60+ toetse vir elke bestuurder.
|
|
83
|
-
Ons toets alle bestuurders met elke kombinasie van:
|
|
84
|
-
* Enkripsie: beide geaktiveer en gedeaktiveer
|
|
85
|
-
* Redis-kas: beide geaktiveer en gedeaktiveer
|
|
86
|
-
|
|
87
|
-
Hierdie benadering gee ons gemoedsrus dat mobiletto dieselfde sal optree, ongeag watter bestuurder jy gebruik,
|
|
88
|
-
en ongeag of jy caching en/of enkripsie aktiveer.
|
|
89
|
-
|
|
90
|
-
### Bestuurderondersteuning
|
|
91
|
-
Huidige Mobiletto-bergingbestuurders:
|
|
92
|
-
* `s3` : Amazon S3
|
|
93
|
-
* `b2` : Backblaze B2
|
|
94
|
-
* `local` : plaaslike lêerstelsel
|
|
95
|
-
|
|
96
|
-
*Bydraes om meer wolkbergingverskaffers te ondersteun is baie welkom!*
|
|
97
|
-
|
|
98
|
-
## mobiletto-cli
|
|
99
|
-
Mobiletto is bedoel om as 'n biblioteek deur ander JavaScript-kode gebruik te word.
|
|
100
|
-
|
|
101
|
-
Om met mobiletto by die opdragreël te werk, gebruik [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
|
|
102
|
-
|
|
103
|
-
## Bron
|
|
104
|
-
* [mobiletto op GitHub](https://github.com/cobbzilla/mobiletto)
|
|
105
|
-
* [mobiletto op npm](https://www.npmjs.com/package/mobiletto)
|
|
106
|
-
|
|
107
|
-
## Ondersteuning en befondsing
|
|
108
|
-
Ek probeer om 'n professionele oopbron sagteware-ontwikkelaar te wees. Ek het gewerk in
|
|
109
|
-
die sagteware-industrie vir baie jare, het ek suksesvolle maatskappye begin en dit aan openbare maatskappye verkoop.
|
|
110
|
-
Onlangs het ek my werk verloor, en ek het nie regtig enige ander werk in die ry nie
|
|
111
|
-
|
|
112
|
-
So ek gaan probeer om nuttige sagteware te skryf en kyk of dit werk
|
|
113
|
-
|
|
114
|
-
As jy dit geniet om hierdie sagteware te gebruik, sal ek baie dankbaar wees vir selfs die
|
|
115
|
-
kleinste [maandelikse bydrae via Patreon](https://www.patreon.com/cobbzilla)
|
|
116
|
-
|
|
117
|
-
*Dankie!*
|
|
118
|
-
|
|
119
|
-
## Installasie
|
|
120
|
-
Installeer met `npm` of `yarn` . Jy wil waarskynlik die `lite` weergawe hê wat nie al die
|
|
121
|
-
vertaalde README-lêers:
|
|
122
|
-
|
|
123
|
-
npm install mobiletto-lite
|
|
124
|
-
yarn add mobiletto-lite
|
|
125
|
-
|
|
126
|
-
As jy regtig die README-lêers in elke taal wil hê, installeer die volledige weergawe:
|
|
127
|
-
|
|
128
|
-
npm install mobiletto
|
|
129
|
-
yarn add mobiletto
|
|
130
|
-
|
|
131
|
-
## Vinnige begin
|
|
132
|
-
'n Kort voorbeeld wat die mobiletto `s3` bestuurder gebruik.
|
|
133
|
-
|
|
134
|
-
Hierdie kode sal dieselfde loop as die bestuurder `b2` of `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
|
-
## Basiese gebruik
|
|
165
|
-
'N Veel meer uitgebreide voorbeeld, wat die meeste van die kenmerke wat aangebied word, toon:
|
|
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
|
-
## Metadata
|
|
267
|
-
Die `metadata` -opdrag gee metadata oor 'n enkele lêerstelsel-inskrywing terug.
|
|
268
|
-
Net so is die terugkeerwaarde van die `list` -opdrag 'n verskeidenheid metadata-objekte.
|
|
269
|
-
|
|
270
|
-
'n Metadata-objek lyk soos volg:
|
|
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
|
-
Die `type` eienskap kan `file` , `dir` , `link` of `special` .
|
|
281
|
-
|
|
282
|
-
Afhangende van die tipe bestuurder, sal 'n `list` -opdrag dalk nie alle velde terugstuur nie. Die `name` en `type` eienskappe
|
|
283
|
-
moet altyd teenwoordig wees. 'n Volgende `metadata` -opdrag sal alle beskikbare eienskappe terugstuur.
|
|
284
|
-
|
|
285
|
-
## Alternatiewe invoerstyl
|
|
286
|
-
Voer die volledig-omvang module in en gebruik die `connect` funksie:
|
|
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
|
-
## Kas
|
|
294
|
-
Mobiletto werk die beste met 'n <a href="https://redis.io">herdis-</a> kas.
|
|
295
|
-
|
|
296
|
-
Mobiletto sal probeer om aan 'n herdis-instansie te koppel op 127.0.0.1:6379
|
|
297
|
-
|
|
298
|
-
Jy kan enige van hierdie ignoreer:
|
|
299
|
-
* Stel die `MOBILETTO_REDIS_HOST` env var, mobiletto om hier te koppel in plaas van localhost
|
|
300
|
-
* Stel die `MOBILETTO_REDIS_PORT` env var, hierdie poort sal gebruik word
|
|
301
|
-
|
|
302
|
-
Mobiletto sal al sy herdissleutels met die voorvoegsel `_mobiletto__` . Jy kan dit verander
|
|
303
|
-
deur die `MOBILETTO_REDIS_PREFIX` env var.
|
|
304
|
-
|
|
305
|
-
Jy kan ook per-verbinding caching stel met die `opts.redisConfig` voorwerp:
|
|
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
|
-
### Wil jy nie herdis-cache hê nie?
|
|
317
|
-
Om te deaktiveer: gee `enabled: false` in jou `opts.redisConfig` voorwerp deur wanneer jy jou verbinding tot stand bring.
|
|
318
|
-
|
|
319
|
-
Soos hieronder bespreek, sal die deaktivering van cache 'n nadelige uitwerking op werkverrigting hê en meer versoeke aangaan
|
|
320
|
-
tot berging wat jy regtig nodig het.
|
|
321
|
-
|
|
322
|
-
### Kas leiding
|
|
323
|
-
**Geënkripteerde berging**: lees/skryf van geënkripteerde berging is net 'n bietjie stadiger as normaal,
|
|
324
|
-
maar om deur gidse te navigeer (wat sommige dinge doen) is redelik duur. Gebruik 'n herdis-kas
|
|
325
|
-
sal jou 'n aansienlike prestasie hupstoot gee.
|
|
326
|
-
|
|
327
|
-
Die verstekkas is veilig, maar werk nie goed as jy baie skryf/verwyder-bewerkings het nie.
|
|
328
|
-
Enige skryf- of verwyderbewerking maak die hele kas ongeldig, om te verseker dat daaropvolgende lees die
|
|
329
|
-
jongste veranderinge.
|
|
330
|
-
|
|
331
|
-
### CLI-gereedskap
|
|
332
|
-
As jy 'n CLI-nutsding soos [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli) gebruik),
|
|
333
|
-
jy sal beslis die redis-kas geaktiveer wil hê, want dit duur oor die oproepe van die `mo` opdrag.
|
|
334
|
-
|
|
335
|
-
## Spieëling
|
|
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
|
-
Die `mirror` -opdrag voer 'n eenmalige kopie van alle lêers van een mobiletto na 'n ander uit.
|
|
344
|
-
Dit voer geen proses uit om die spieël oor tyd in stand te hou nie. Voer die `mirror` opdrag weer uit
|
|
345
|
-
om enige ontbrekende lêers te sinchroniseer.
|
|
346
|
-
|
|
347
|
-
Die terugkeerwaarde van `mirror` is 'n eenvoudige voorwerp met tellers vir hoeveel lêers suksesvol was
|
|
348
|
-
weerspieël en hoeveel lêers het foute gehad:
|
|
349
|
-
|
|
350
|
-
{
|
|
351
|
-
success: count-of-files-mirrored,
|
|
352
|
-
errors: count-of-files-with-errors
|
|
353
|
-
}
|
|
354
|
-
|
|
355
|
-
WAARSKUWING: Die spieël van groot datastelle kan baie tydrowend en bandwydte-intensief wees
|
|
356
|
-
|
|
357
|
-
Met die `mirror` oproep semantiek kan dit soms verwarrend wees om te verstaan wie die is
|
|
358
|
-
leser en wie die skrywer is. Stel jou dit voor soos 'n opdragstelling: die "linkerhandse mobiletto"
|
|
359
|
-
is die ding waaraan toegewys word (weerspieël data geskryf), en die "regterhand mobiletto" (die
|
|
360
|
-
argument aan die `mirror` metode) is die waarde wat toegeken word (gespieëlde data word gelees).
|
|
361
|
-
|
|
362
|
-
## Deursigtige enkripsie
|
|
363
|
-
Aktiveer deursigtige kliënt-kant-enkripsie:
|
|
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
|
-
Wat is besig om te gebeur? 'n Aparte "gidsinskrywing" (dirent) gids (geïnkripteer) spoor watter lêers daarin is
|
|
383
|
-
gids (ook bekend as die dirent gids).
|
|
384
|
-
* Die `list` -opdrag lees die gidsinskrywingslêers, dekripteer elke pad wat gelys is; gee dan metadata vir elke lêer terug
|
|
385
|
-
* `list` -opdragte is meer ondoeltreffend, veral vir dopgehou met 'n groot aantal lêers
|
|
386
|
-
* Die `write` opdrag skryf dirent lêers in elke ouer se dirent gids, rekursief; skryf dan die lêer
|
|
387
|
-
* `write` opdragte sal O(N) skryfwerk aangaan, met N = diepte in die gidshiërargie
|
|
388
|
-
* Die `remove` opdrag verwyder die ooreenstemmende dirent lêer, en sy ouer indien leeg, rekursief; verwyder dan die lêer
|
|
389
|
-
* Nie-rekursiewe `remove` en moontlik soveel verwyderings aangaan, met N = diepte in die gidshiërargie
|
|
390
|
-
* Rekursiewe `remove` opdragte op groot en diep lêerstelsels kan duur wees
|
|
391
|
-
|
|
392
|
-
Let daarop dat selfs met kliënt-kant-enkripsie geaktiveer, 'n teëstander met volle sigbaarheid in jou geënkripteerde bedienerkant
|
|
393
|
-
berging, selfs sonder die sleutel, kan steeds die totale aantal dopgehou sien en hoeveel lêers in elk is, en met
|
|
394
|
-
'n bietjie moeite, ontdek sommige of al die algehele struktuur van die gidshiërargie.
|
|
395
|
-
*Let wel: Gebruik 'n relatief plat struktuur vir beter sekuriteit.*
|
|
396
|
-
Die teëstander sal nie die name van die gidse/lêers ken nie, tensy hulle ook jou enkripsie ken
|
|
397
|
-
sleutel of andersins die enkripsie suksesvol gekraak het. Alle weddenskappe is dan af!
|
|
398
|
-
|
|
399
|
-
### Prestasie en kas
|
|
400
|
-
Bewerkings op geënkripteerde berging kan stadig wees. Rekursiewe lyste en verwyderings kan baie stadig wees.
|
|
401
|
-
Cache via redis help geweldig, maar let daarop dat die kas gespoel word met enige skryf of verwydering.
|
|
402
|
-
|
|
403
|
-
## Sleutelrotasie
|
|
404
|
-
Skep 'n mobiletto met jou nuwe sleutel en spieël dan die ou data daarin:
|
|
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
|
-
## Bestuurder-koppelvlak
|
|
417
|
-
'n Bestuurder is enige JS-lêer wat 'n 'storageClient'-funksie uitvoer met hierdie handtekening:
|
|
418
|
-
|
|
419
|
-
function storageClient (key, secret, opts)
|
|
420
|
-
|
|
421
|
-
* `key` : 'n string, jou API-sleutel (vir die `local` drywer is dit die basisgids)
|
|
422
|
-
* `secret` : 'n string, jou API-geheim (kan weggelaat word vir die `local` drywer)
|
|
423
|
-
* `opts` : 'n voorwerp, die eienskappe is per bestuurder:
|
|
424
|
-
* Vir `local` die `fileMode` en `dirMode` eienskappe hoe nuwe skeplêers en dopgehou geskep word
|
|
425
|
-
* Vir `s3` word die `bucket` eienskap vereis. Opsionele eienskappe is:
|
|
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
|
-
Die objek wat die storageClient-funksie terugstuur, moet hierdie funksies definieer:
|
|
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
|
-
## Teken
|
|
457
|
-
Mobiletto gebruik die [winston](https://www.npmjs.com/package/winston) aantekenbiblioteek.
|
|
458
|
-
|
|
459
|
-
Logs **sal** lêerpaaie en foutboodskappe bevat, maar sal **nooit** sleutels, geheime,
|
|
460
|
-
of enige ander verbinding konfigurasie inligting.
|
|
461
|
-
|
|
462
|
-
### Log vlak
|
|
463
|
-
Gebruik die `MOBILETTO_LOG_LEVEL` omgewingsveranderlike om die logvlak te stel deur een te gebruik
|
|
464
|
-
van die `npm` vlakke gedefinieer in [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
|
|
465
|
-
|
|
466
|
-
Die verstekvlak is `error` . Die mees verbose vlak is `silly` , hoewel tans mobiletto
|
|
467
|
-
teken nie aan op vlakke onder `debug`
|
|
468
|
-
|
|
469
|
-
MOBILETTO_LOG_LEVEL=silly # maximum logs!
|
|
470
|
-
|
|
471
|
-
### Loglêer
|
|
472
|
-
By verstek skryf die logger na die konsole. Om logs na 'n lêer te stuur, stel die `MOBILETTO_LOG_FILE`
|
|
473
|
-
omgewingsveranderlike. Wanneer u by 'n lêer aanteken, sal logs nie meer na die konsole geskryf word nie.
|
|
474
|
-
|
|
475
|
-
MOBILETTO_LOG_FILE=/var/my_mobiletto_log
|
|
476
|
-
|
|
477
|
-
Om aantekening af te skakel:
|
|
478
|
-
|
|
479
|
-
MOBILETTO_LOG_FILE=/dev/null
|
|
480
|
-
|
|
481
|
-
</pre>
|