mobiletto 1.2.1 → 2.0.1
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/nl/README.md
DELETED
|
@@ -1,481 +0,0 @@
|
|
|
1
|
-
Mobiletto
|
|
2
|
-
=========
|
|
3
|
-
|
|
4
|
-
Mobiletto is een JavaScript-opslagabstractielaag, met optionele transparante versleuteling aan de clientzijde.
|
|
5
|
-
|
|
6
|
-
# Inhoud
|
|
7
|
-
* [Waarom Mobiletto?](#Waarom-Mobiletto?)
|
|
8
|
-
* [Snelstart](#Snelstart)
|
|
9
|
-
* [Mobiletto CLI](#mobiletto-cli)
|
|
10
|
-
* [Bron](#Bron)
|
|
11
|
-
* [Installatie](#Installatie)
|
|
12
|
-
* [Ondersteuning en financiering](#Ondersteuning en financiering)
|
|
13
|
-
* [Basisgebruik](#Basic-gebruik)
|
|
14
|
-
* [Metagegevens](#Metagegevens)
|
|
15
|
-
* [Alternatieve importstijl](#Alternatieve-importstijl)
|
|
16
|
-
* [Caching](#Caching)
|
|
17
|
-
* [Spiegelen](#Spiegelen)
|
|
18
|
-
* [Transparante encryptie](#Transparante-encryptie)
|
|
19
|
-
* [Sleutelrotatie](#Sleutelrotatie)
|
|
20
|
-
* [Driver-interface](#Driver-interface)
|
|
21
|
-
* [Logboekregistratie](#logboekregistratie)
|
|
22
|
-
|
|
23
|
-
# Lees dit in een andere taal
|
|
24
|
-
Dit README.md-document is via [hokeylization](https://github.com/cobbzilla/hokeylization) vertaald in
|
|
25
|
-
**[elke taal ondersteund door Google Translate](https://cloud.google.com/translate/docs/languages)!**
|
|
26
|
-
|
|
27
|
-
Ik weet zeker dat het niet perfect is, maar ik hoop dat het beter is dan niets!
|
|
28
|
-
|
|
29
|
-
[🇸🇦 Arabisch](../ar/README.md)
|
|
30
|
-
[🇧🇩 Bengali](../bn/README.md)
|
|
31
|
-
[🇩🇪 Duits](../de/README.md)
|
|
32
|
-
[🇺🇸 Nederlands](../en/README.md)
|
|
33
|
-
[🇪🇸 Spaans](../es/README.md)
|
|
34
|
-
[🇫🇷 Frans](../fr/README.md)
|
|
35
|
-
[🇹🇩 Hausa](../ha/README.md)
|
|
36
|
-
[🇮🇳 Hindi](../hi/README.md)
|
|
37
|
-
[🇮🇩 Indonesisch](../id/README.md)
|
|
38
|
-
[🇮🇹 Italiaans](../it/README.md)
|
|
39
|
-
[🇯🇵 Japans](../ja/README.md)
|
|
40
|
-
[🇰🇷 Koreaans](../ko/README.md)
|
|
41
|
-
[🇮🇳 Marathi](../mr/README.md)
|
|
42
|
-
[🇵🇱 Pools](../pl/README.md)
|
|
43
|
-
[🇧🇷 Portugees](../pt/README.md)
|
|
44
|
-
[🇷🇺 Russisch](../ru/README.md)
|
|
45
|
-
[🇰🇪 Swahili](../sw/README.md)
|
|
46
|
-
[🇵🇭 Tagalog](../tl/README.md)
|
|
47
|
-
[🇹🇷 Turks](../tr/README.md)
|
|
48
|
-
[🇵🇰 Urdu](../ur/README.md)
|
|
49
|
-
[🇻🇳 Vietnamees](../vi/README.md)
|
|
50
|
-
[🇨🇳 Chinees](../zh/README.md)
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
**[📚 ... Alle talen ...](../README.md)**
|
|
54
|
-
----
|
|
55
|
-
|
|
56
|
-
### Is er een probleem met deze vertaling van de README?
|
|
57
|
-
Deze specifieke vertaling van het origineel [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
|
|
58
|
-
kan gebrekkig zijn -- *correcties zijn zeer welkom!* Stuur een [pull-verzoek op GitHub](https://github.com/cobbzilla/mobiletto/pulls),
|
|
59
|
-
of als u zich daar niet prettig bij voelt, [open een probleem](https://github.com/cobbzilla/mobiletto/issues)
|
|
60
|
-
|
|
61
|
-
Wanneer u een nieuw GitHub-probleem maakt over een vertaling, doet u het volgende:
|
|
62
|
-
* inclusief de pagina-URL (kopiëren/plakken uit de adresbalk van de browser)
|
|
63
|
-
* voeg de exacte tekst toe die fout is (kopiëren/plakken vanuit browser)
|
|
64
|
-
* beschrijf a.u.b. wat er mis is -- is de vertaling onjuist? is de opmaak op de een of andere manier kapot?
|
|
65
|
-
* graag een suggestie voor een betere vertaling, of hoe de tekst correct moet worden opgemaakt
|
|
66
|
-
* **Dank je!**
|
|
67
|
-
|
|
68
|
-
## Waarom Mobiletto?
|
|
69
|
-
|
|
70
|
-
### Vaarwel vendor lock-in!
|
|
71
|
-
De verschillende cloudopslagproviders hebben incompatibele API's. Zelfs degenen die streven naar "S3-compatibiliteit"
|
|
72
|
-
eigenzinnig gedrag hebben.
|
|
73
|
-
|
|
74
|
-
Wanneer u een bepaalde opslagleverancier voor uw app kiest en u rechtstreeks codeert naar hun API, uw app
|
|
75
|
-
is nu afhankelijk van die dienst. Naarmate de tijd verstrijkt en de code zich opstapelt, wordt het veranderen van leverancier
|
|
76
|
-
steeds onhoudbaarder. Welkom in de leuke wereld van vendor lock-in!
|
|
77
|
-
|
|
78
|
-
Mobiletto is ontworpen om dit probleem op te lossen. Door uw app te coderen naar de API van mobiletto, kunt u gemakkelijk
|
|
79
|
-
verander opslagproviders en weet dat de opslaglaag van uw app zich identiek zal gedragen.
|
|
80
|
-
|
|
81
|
-
### Uitgebreid testen
|
|
82
|
-
Alle chauffeurs worden getest op identiek gedrag met 60+ tests voor elke chauffeur.
|
|
83
|
-
We testen alle chauffeurs met elke combinatie van:
|
|
84
|
-
* Encryptie: zowel ingeschakeld als uitgeschakeld
|
|
85
|
-
* Redis-cache: zowel ingeschakeld als uitgeschakeld
|
|
86
|
-
|
|
87
|
-
Deze aanpak geeft ons gemoedsrust dat mobiletto zich hetzelfde zal gedragen, ongeacht welke driver je gebruikt,
|
|
88
|
-
en ongeacht of u caching en/of encryptie inschakelt.
|
|
89
|
-
|
|
90
|
-
### Bestuurdersondersteuning
|
|
91
|
-
Huidige Mobiletto-opslagstuurprogramma's:
|
|
92
|
-
* `s3` : Amazon S3
|
|
93
|
-
* `b2` : Backblaze B2
|
|
94
|
-
* `local` : lokaal bestandssysteem
|
|
95
|
-
|
|
96
|
-
*Bijdragen om meer cloudopslagproviders te ondersteunen zijn van harte welkom!*
|
|
97
|
-
|
|
98
|
-
## mobiletto-cli
|
|
99
|
-
Mobiletto is bedoeld om te worden gebruikt als bibliotheek door andere JavaScript-code.
|
|
100
|
-
|
|
101
|
-
Gebruik [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli) om met mobiletto op de opdrachtregel te werken
|
|
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 financiering
|
|
108
|
-
Ik probeer een professionele open source softwareontwikkelaar te worden. ik heb gewerkt in
|
|
109
|
-
jarenlang in de software-industrie, heb ik succesvolle bedrijven gestart en verkocht aan openbare bedrijven.
|
|
110
|
-
Onlangs verloor ik mijn baan, en ik heb niet echt ander werk op de planning
|
|
111
|
-
|
|
112
|
-
Dus ik ga proberen nuttige software te schrijven en kijken of dat werkt
|
|
113
|
-
|
|
114
|
-
Als u deze software graag gebruikt, zou ik u zeer dankbaar zijn, zelfs voor de
|
|
115
|
-
kleinste [maandelijkse bijdrage via Patreon](https://www.patreon.com/cobbzilla)
|
|
116
|
-
|
|
117
|
-
*Dank je!*
|
|
118
|
-
|
|
119
|
-
## Installatie
|
|
120
|
-
Installeer met `npm` of `yarn` . U wilt waarschijnlijk de `lite` versie die niet alle
|
|
121
|
-
vertaalde README-bestanden:
|
|
122
|
-
|
|
123
|
-
npm install mobiletto-lite
|
|
124
|
-
yarn add mobiletto-lite
|
|
125
|
-
|
|
126
|
-
Als je echt de README-bestanden in elke taal wilt, installeer dan de volledige versie:
|
|
127
|
-
|
|
128
|
-
npm install mobiletto
|
|
129
|
-
yarn add mobiletto
|
|
130
|
-
|
|
131
|
-
## Snelle start
|
|
132
|
-
Een kort voorbeeld met de mobiletto `s3` driver.
|
|
133
|
-
|
|
134
|
-
Deze code zou hetzelfde werken als het stuurprogramma `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
|
-
## Basisgebruik
|
|
165
|
-
Een veel uitgebreider voorbeeld dat de meeste aangeboden functies laat zien:
|
|
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
|
-
## Metagegevens
|
|
267
|
-
De opdracht `metadata` retourneert metadata over een enkele invoer in het bestandssysteem.
|
|
268
|
-
Evenzo is de retourwaarde van de opdracht `list` een array van metadata-objecten.
|
|
269
|
-
|
|
270
|
-
Een metadata-object ziet er als volgt uit:
|
|
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
|
-
De eigenschap `type` kan `file` , `dir` , `link` of `special` .
|
|
281
|
-
|
|
282
|
-
Afhankelijk van het type stuurprogramma, kan het zijn dat een `list` opdracht niet alle velden retourneert. De eigenschappen `name` en `type`
|
|
283
|
-
moet altijd aanwezig zijn. Een volgend `metadata` commando retourneert alle beschikbare eigenschappen.
|
|
284
|
-
|
|
285
|
-
## Alternatieve importstijl
|
|
286
|
-
Importeer de full-scoped module en gebruik de `connect` functie:
|
|
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
|
-
## Caching
|
|
294
|
-
Mobiletto werkt het beste met een <a href="https://redis.io">redis-</a> cache.
|
|
295
|
-
|
|
296
|
-
Mobiletto zal proberen verbinding te maken met een redis-instantie op 127.0.0.1:6379
|
|
297
|
-
|
|
298
|
-
U kunt een van deze overschrijven:
|
|
299
|
-
* Stel de `MOBILETTO_REDIS_HOST` env var, mobiletto hier verbinden in plaats van localhost
|
|
300
|
-
* Stel de `MOBILETTO_REDIS_PORT` env var in, deze poort zal worden gebruikt
|
|
301
|
-
|
|
302
|
-
Mobiletto slaat al zijn redis-sleutels op met het voorvoegsel `_mobiletto__` . Je kunt dit veranderen
|
|
303
|
-
door de `MOBILETTO_REDIS_PREFIX` env var.
|
|
304
|
-
|
|
305
|
-
U kunt caching per verbinding ook instellen met het object `opts.redisConfig` :
|
|
306
|
-
|
|
307
|
-
const redisConfig = {
|
|
308
|
-
enabled: true, // optional, default is true. if false other props are ignored
|
|
309
|
-
host: '127.0.0.1',
|
|
310
|
-
port: 6379,
|
|
311
|
-
prefix: '_mobiletto__'
|
|
312
|
-
}
|
|
313
|
-
const opts = { redisConfig, bucket: 'bk', region: 'us-east-1' }
|
|
314
|
-
const s3 = await storage.connect('s3', aws_key, aws_secret, opts)
|
|
315
|
-
|
|
316
|
-
### Wil je geen redis-caching?
|
|
317
|
-
Om uit te schakelen: geef `enabled: false` in uw `opts.redisConfig` object wanneer u uw verbinding tot stand brengt.
|
|
318
|
-
|
|
319
|
-
Zoals hieronder wordt besproken, zal het uitschakelen van caching een negatief effect hebben op de prestaties en meer verzoeken veroorzaken
|
|
320
|
-
tot opslag die u echt nodig heeft.
|
|
321
|
-
|
|
322
|
-
### Caching-begeleiding
|
|
323
|
-
**Versleutelde opslag**: lezen/schrijven van versleutelde opslag gaat maar iets langzamer dan normaal,
|
|
324
|
-
maar navigeren door mappen (wat sommige dingen doen) is vrij duur. Een redis-cache gebruiken
|
|
325
|
-
geeft u een aanzienlijke prestatieverbetering.
|
|
326
|
-
|
|
327
|
-
De standaardcache is veilig, maar werkt niet goed als u veel schrijf-/verwijderbewerkingen uitvoert.
|
|
328
|
-
Elke schrijf- of verwijderbewerking maakt de hele cache ongeldig, zodat bij volgende leesbewerkingen de
|
|
329
|
-
laatste wijzigingen.
|
|
330
|
-
|
|
331
|
-
### CLI-tools
|
|
332
|
-
Als u een CLI-tool zoals [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli) gebruikt,
|
|
333
|
-
je wilt zeker dat de redis-cache is ingeschakeld, omdat deze blijft bestaan bij het aanroepen van het `mo` commando.
|
|
334
|
-
|
|
335
|
-
## Spiegelen
|
|
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
|
-
Het `mirror` commando voert een eenmalige kopie uit van alle bestanden van de ene mobiletto naar de andere.
|
|
344
|
-
Er wordt geen proces uitgevoerd om de spiegel in de loop van de tijd te onderhouden. Voer de opdracht `mirror` opnieuw uit
|
|
345
|
-
om ontbrekende bestanden te synchroniseren.
|
|
346
|
-
|
|
347
|
-
De retourwaarde van `mirror` is een eenvoudig object met tellers voor het aantal bestanden dat met succes is uitgevoerd
|
|
348
|
-
gespiegeld en hoeveel bestanden fouten bevatten:
|
|
349
|
-
|
|
350
|
-
{
|
|
351
|
-
success: count-of-files-mirrored,
|
|
352
|
-
errors: count-of-files-with-errors
|
|
353
|
-
}
|
|
354
|
-
|
|
355
|
-
WAARSCHUWING: Het spiegelen van grote datasets kan erg tijdrovend en bandbreedte-intensief zijn
|
|
356
|
-
|
|
357
|
-
Met de `mirror` -oproepsemantiek kan het soms verwarrend zijn om te begrijpen wie de
|
|
358
|
-
lezer en wie is de schrijver. Stel je het voor als een opdrachtverklaring: de "linkse mobiletto"
|
|
359
|
-
is het ding dat wordt toegewezen aan (gespiegelde gegevens geschreven), en de "right-hand mobiletto" (de
|
|
360
|
-
argument voor de `mirror` methode) is de waarde die wordt toegewezen (gespiegelde gegevens worden gelezen).
|
|
361
|
-
|
|
362
|
-
## Transparante encryptie
|
|
363
|
-
Schakel transparante versleuteling aan de clientzijde in:
|
|
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 er gaande? Een aparte "directory entry" (dirent) directory (gecodeerd) houdt bij welke bestanden daarin staan
|
|
383
|
-
directory (ook wel de dirent directory genoemd).
|
|
384
|
-
* Het `list` commando leest de directory-invoerbestanden, decodeert elk vermeld pad; retourneert vervolgens metadata voor elk bestand
|
|
385
|
-
* `list` commando's zijn inefficiënter, vooral voor mappen met een groot aantal bestanden
|
|
386
|
-
* Het `write` commando schrijft recursief dirent-bestanden in de dirent-directory van elke ouder; schrijft vervolgens het bestand
|
|
387
|
-
* `write` commando's zullen O(N) schrijfacties veroorzaken, met N = diepte in de directoryhiërarchie
|
|
388
|
-
* Het `remove` commando verwijdert het corresponderende dirent-bestand, en zijn ouder indien leeg, recursief; verwijdert vervolgens het bestand
|
|
389
|
-
* Niet-recursieve `remove` -commando's leiden tot O(N)-leesbewerkingen en mogelijk evenveel verwijderingen, met N = diepte in de directoryhiërarchie
|
|
390
|
-
* Recursieve `remove` commando's op grote en diepe bestandssystemen kunnen duur zijn
|
|
391
|
-
|
|
392
|
-
Merk op dat zelfs als versleuteling aan de clientzijde is ingeschakeld, een tegenstander volledig inzicht heeft in uw versleutelde server-side
|
|
393
|
-
opslag, zelfs zonder de sleutel, kan nog steeds het totale aantal mappen zien en hoeveel bestanden zich in elke map bevinden, en met
|
|
394
|
-
enige moeite, ontdek dan een deel of de hele algemene structuur van de directoryhiërarchie.
|
|
395
|
-
*Opmerking: gebruik een relatief platte structuur voor een betere beveiliging.*
|
|
396
|
-
De tegenstander zou de namen van de mappen/bestanden niet kennen, tenzij ze ook uw encryptie kenden
|
|
397
|
-
sleutel of de codering op een andere manier succesvol had gekraakt. Alle weddenschappen zijn dan af!
|
|
398
|
-
|
|
399
|
-
### Prestaties en caching
|
|
400
|
-
Bewerkingen op versleutelde opslag kunnen traag zijn. Recursieve vermeldingen en verwijderingen kunnen erg traag zijn.
|
|
401
|
-
Caching via redis helpt enorm, maar houd er rekening mee dat de cache wordt leeggemaakt bij elke schrijf- of verwijderingsactie.
|
|
402
|
-
|
|
403
|
-
## Sleutelrotatie
|
|
404
|
-
Maak een mobiletto met uw nieuwe sleutel en spiegel de oude gegevens erin:
|
|
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
|
-
## Driver-interface
|
|
417
|
-
Een stuurprogramma is elk JS-bestand dat een 'storageClient'-functie exporteert met deze handtekening:
|
|
418
|
-
|
|
419
|
-
function storageClient (key, secret, opts)
|
|
420
|
-
|
|
421
|
-
* `key` : een string, je API-sleutel (voor de `local` driver is dit de basisdirectory)
|
|
422
|
-
* `secret` : een string, uw API-geheim (kan worden weggelaten voor de `local` driver)
|
|
423
|
-
* `opts` : een object, de eigenschappen zijn per driver:
|
|
424
|
-
* Voor `local` bepalen de eigenschappen `fileMode` en `dirMode` hoe nieuwe bestanden en mappen worden aangemaakt
|
|
425
|
-
* Voor `s3` is de eigenschap `bucket` vereist. Optionele eigenschappen zijn:
|
|
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
|
-
Het object dat de functie storageClient retourneert, moet deze functies definiëren:
|
|
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
|
-
## Loggen
|
|
457
|
-
Mobiletto gebruikt de logbibliotheek van [winston](https://www.npmjs.com/package/winston).
|
|
458
|
-
|
|
459
|
-
Logboeken **zal** bestandspaden en foutmeldingen bevatten, maar **nooit** sleutels, geheimen,
|
|
460
|
-
of andere informatie over de verbindingsconfiguratie.
|
|
461
|
-
|
|
462
|
-
### Log niveau
|
|
463
|
-
Gebruik de `MOBILETTO_LOG_LEVEL` omgevingsvariabele om het logniveau in te stellen, met één
|
|
464
|
-
van de `npm` niveaus gedefinieerd in [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
|
|
465
|
-
|
|
466
|
-
Het standaardniveau is `error` . Het meest uitgebreide niveau is `silly` , hoewel momenteel mobiletto
|
|
467
|
-
logt niet in op niveaus onder `debug`
|
|
468
|
-
|
|
469
|
-
MOBILETTO_LOG_LEVEL=silly # maximum logs!
|
|
470
|
-
|
|
471
|
-
### Logbestand
|
|
472
|
-
Standaard schrijft de logger naar de console. Om logs naar een bestand te sturen, stelt u de `MOBILETTO_LOG_FILE`
|
|
473
|
-
omgevingsvariabele. Wanneer u zich aanmeldt bij een bestand, worden er geen logboeken meer naar de console geschreven.
|
|
474
|
-
|
|
475
|
-
MOBILETTO_LOG_FILE=/var/my_mobiletto_log
|
|
476
|
-
|
|
477
|
-
Logboekregistratie uitschakelen:
|
|
478
|
-
|
|
479
|
-
MOBILETTO_LOG_FILE=/dev/null
|
|
480
|
-
|
|
481
|
-
</pre>
|