mobiletto 1.2.0 → 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 -10
- package/test/api.spec.js +0 -512
- package/test/crypt.spec.js +0 -67
- package/util/crypt.js +0 -80
- package/util/logger.js +0 -27
- package/util/redis.js +0 -233
package/docs/lb/README.md
DELETED
|
@@ -1,481 +0,0 @@
|
|
|
1
|
-
Mobiletto
|
|
2
|
-
==========
|
|
3
|
-
|
|
4
|
-
Mobiletto ass eng JavaScript Späicherabstraktiounsschicht, mat optionalem transparenter Client-Säit Verschlësselung.
|
|
5
|
-
|
|
6
|
-
# Inhalter
|
|
7
|
-
* [Firwat Mobiletto?](#Why-Mobiletto?)
|
|
8
|
-
* [Quickstart](#Quickstart)
|
|
9
|
-
* [Mobiletto CLI](#mobiletto-cli)
|
|
10
|
-
* [Source](#Source)
|
|
11
|
-
* [Installatioun](#Installatioun)
|
|
12
|
-
* [Support a Finanzéierung](#Support-a-Finanzéierung)
|
|
13
|
-
* [Basis Benotzung](#Basis Benotzung)
|
|
14
|
-
* [Metadaten](#Metadaten)
|
|
15
|
-
* [Alternativ Importstil](#Alternate-Import-Style)
|
|
16
|
-
* [Caching](#Caching)
|
|
17
|
-
* [Spigel](#Spigel)
|
|
18
|
-
* [Transparent Verschlësselung](#Transparent Verschlësselung)
|
|
19
|
-
* [Schlësselrotatioun](#Schlësselrotatioun)
|
|
20
|
-
* [Driver Interface](#Driver-Interface)
|
|
21
|
-
* [Logging](#Logging)
|
|
22
|
-
|
|
23
|
-
# Liest dëst an enger anerer Sprooch
|
|
24
|
-
Dëst README.md Dokument gouf iwwersat, iwwer [hokeylization](https://github.com/cobbzilla/hokeylization), an
|
|
25
|
-
**[all Sprooch ënnerstëtzt vu Google Translate](https://cloud.google.com/translate/docs/languages)!**
|
|
26
|
-
|
|
27
|
-
Ech si sécher datt et net perfekt ass, awer ech hoffen et ass besser wéi näischt!
|
|
28
|
-
|
|
29
|
-
[🇸🇦 Arabesch](../ar/README.md)
|
|
30
|
-
[🇧🇩 Bengalesch](../bn/README.md)
|
|
31
|
-
[🇩🇪 Däitsch](../de/README.md)
|
|
32
|
-
[🇺🇸 Englesch](../en/README.md)
|
|
33
|
-
[🇪🇸 Spuenesch](../es/README.md)
|
|
34
|
-
[🇫🇷 Franséisch](../fr/README.md)
|
|
35
|
-
[🇹🇩 Hausa](../ha/README.md)
|
|
36
|
-
[🇮🇳 Hindi](../hi/README.md)
|
|
37
|
-
[🇮🇩 indonesesch](../id/README.md)
|
|
38
|
-
[🇮🇹 Italienesch](../it/README.md)
|
|
39
|
-
[🇯🇵 Japanesch](../ja/README.md)
|
|
40
|
-
[🇰🇷 Koreanesch](../ko/README.md)
|
|
41
|
-
[🇮🇳 Marathi](../mr/README.md)
|
|
42
|
-
[🇵🇱 Polnesch](../pl/README.md)
|
|
43
|
-
[🇧🇷 Portugisesch](../pt/README.md)
|
|
44
|
-
[🇷🇺 Russesch](../ru/README.md)
|
|
45
|
-
[🇰🇪 Swahili](../sw/README.md)
|
|
46
|
-
[🇵🇭 Tagalog](../tl/README.md)
|
|
47
|
-
[🇹🇷 tierkesch](../tr/README.md)
|
|
48
|
-
[🇵🇰 Urdu](../ur/README.md)
|
|
49
|
-
[🇻🇳 Vietnamesesch](../vi/README.md)
|
|
50
|
-
[🇨🇳 Chinesesch](../zh/README.md)
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
**[📚 ... All Sproochen ...](../README.md)**
|
|
54
|
-
----
|
|
55
|
-
|
|
56
|
-
### Gëtt et e Problem mat dëser Iwwersetzung vum README?
|
|
57
|
-
Dës speziell Iwwersetzung vum Original [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
|
|
58
|
-
kann fehlerhaft sinn -- *Korrekturen si ganz wëllkomm!* Schéckt w.e.g. eng [Pull Ufro op GitHub](https://github.com/cobbzilla/mobiletto/pulls),
|
|
59
|
-
oder wann Dir net bequem sidd dat ze maachen, [maacht en Thema op](https://github.com/cobbzilla/mobiletto/issues)
|
|
60
|
-
|
|
61
|
-
Wann Dir en neit GitHub Thema iwwer eng Iwwersetzung erstellt, maacht w.e.g.:
|
|
62
|
-
* enthält d'Säit URL (Kopie / Paste vun der Adressbar vum Browser)
|
|
63
|
-
* enthält den exakten Text dee falsch ass (copy/paste vum Browser)
|
|
64
|
-
* beschreiw w.e.g. wat falsch ass - ass d'Iwwersetzung falsch? ass d'Formatéierung iergendwéi gebrach?
|
|
65
|
-
* bitt frëndlech e Virschlag fir eng besser Iwwersetzung un, oder wéi den Text richteg formatéiert soll sinn
|
|
66
|
-
* **Merci!**
|
|
67
|
-
|
|
68
|
-
## Firwat Mobiletto?
|
|
69
|
-
|
|
70
|
-
### Äddi Verkeefer Spär!
|
|
71
|
-
Déi verschidde Cloud Storage Ubidder hunn inkompatibel APIen. Och déi, déi no "S3 Kompatibilitéit" striewen
|
|
72
|
-
hunn idiosynkratesch Verhalen.
|
|
73
|
-
|
|
74
|
-
Wann Dir e bestëmmte Stockage Verkeefer fir Är App wielt, wann Dir direkt op hir API, Är App codéiert
|
|
75
|
-
ass elo vun deem Service ofhängeg. Wéi d'Zäit vergaang ass a Code accumuléiert, verännert Verkeefer
|
|
76
|
-
ëmmer méi onhaltbar. Wëllkomm op der lëschter Welt vum Verkeefer Lock-in!
|
|
77
|
-
|
|
78
|
-
Mobiletto gouf entwéckelt fir dëse Problem ze léisen. Andeems Dir Är App op Mobiletto's API kodéiert, kënnt Dir einfach
|
|
79
|
-
Ännere Späicherprovider a wësst datt d'Späicherschicht vun Ärer App identesch behuelen.
|
|
80
|
-
|
|
81
|
-
### Extensiv Testen
|
|
82
|
-
All Chauffeuren gi fir identesch Verhalen getest mat 60+ Tester fir all Chauffeur.
|
|
83
|
-
Mir testen all Chauffeuren mat all Kombinatioun vun:
|
|
84
|
-
* Verschlësselung: souwuel aktivéiert wéi behënnert
|
|
85
|
-
* Redis Cache: souwuel aktivéiert wéi behënnert
|
|
86
|
-
|
|
87
|
-
Dës Approche gëtt eis Fridden vum Geescht datt den mobiletto d'selwecht wäert behuelen egal wéi ee Chauffer Dir benotzt,
|
|
88
|
-
an egal ob Dir Caching an / oder Verschlësselung aktivéiert.
|
|
89
|
-
|
|
90
|
-
### Driver Ënnerstëtzung
|
|
91
|
-
Aktuelle Mobiletto Späichertreiber:
|
|
92
|
-
* `s3` : Amazon S3
|
|
93
|
-
* `b2` : Backblaze B2
|
|
94
|
-
* `local` : lokal Dateiesystem
|
|
95
|
-
|
|
96
|
-
* Bäiträg fir méi Cloud Storage Ubidder z'ënnerstëtzen si ganz wëllkomm!*
|
|
97
|
-
|
|
98
|
-
## mobiletto-cli
|
|
99
|
-
Mobiletto soll als Bibliothéik vun anere JavaScript Code benotzt ginn.
|
|
100
|
-
|
|
101
|
-
Fir mat mobiletto op der Kommandozeil ze schaffen, benotzt [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
|
|
102
|
-
|
|
103
|
-
## Quell
|
|
104
|
-
* [mobiletto op GitHub](https://github.com/cobbzilla/mobiletto)
|
|
105
|
-
* [mobiletto op npm](https://www.npmjs.com/package/mobiletto)
|
|
106
|
-
|
|
107
|
-
## Ënnerstëtzung a Finanzéierung
|
|
108
|
-
Ech probéieren e professionnelle Open Source Software Entwéckler ze sinn. Ech hu geschafft an
|
|
109
|
-
der Software Industrie fir vill Joren, Ech hunn erfollegräich Betriber ugefaangen a verkaf hinnen un ëffentlech Firmen.
|
|
110
|
-
Viru kuerzem hunn ech meng Aarbecht verluer, an ech hu wierklech keng aner Aarbecht opgestallt
|
|
111
|
-
|
|
112
|
-
Also ech probéieren hëllefräich Software ze schreiwen a kucken ob dat funktionnéiert
|
|
113
|
-
|
|
114
|
-
Wann Dir genéisst dës Software ze benotzen, Ech wier ganz dankbar fir souguer de
|
|
115
|
-
klengste [monatlecht Bäitrag iwwer Patreon](https://www.patreon.com/cobbzilla)
|
|
116
|
-
|
|
117
|
-
*Merci!*
|
|
118
|
-
|
|
119
|
-
## Installatioun
|
|
120
|
-
Installéiere mat `npm` oder `yarn` . Dir wëllt wahrscheinlech d' `lite` Versioun déi net all
|
|
121
|
-
iwwersat README Dateien:
|
|
122
|
-
|
|
123
|
-
npm install mobiletto-lite
|
|
124
|
-
yarn add mobiletto-lite
|
|
125
|
-
|
|
126
|
-
Wann Dir wierklech d'README Dateien an all Sprooch wëllt, installéiert déi komplett Versioun:
|
|
127
|
-
|
|
128
|
-
npm install mobiletto
|
|
129
|
-
yarn add mobiletto
|
|
130
|
-
|
|
131
|
-
## Schnellstart
|
|
132
|
-
E kuerzt Beispill mat dem mobiletto `s3` Chauffer.
|
|
133
|
-
|
|
134
|
-
Dëse Code géif d'selwecht lafen wann de Chauffeur `b2` oder `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
|
-
## Basis Benotzung
|
|
165
|
-
E vill méi extensiv Beispill, deen déi meescht vun de ugebueden Features weist:
|
|
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
|
-
## Metadaten
|
|
267
|
-
De Kommando `metadata` Metadaten iwwer eng eenzeg Dateiesystementrée zréck.
|
|
268
|
-
Och de `list` Kommando "Lëscht" ass eng Array vu Metadatenobjekter.
|
|
269
|
-
|
|
270
|
-
E Metadatenobjekt gesäit esou aus:
|
|
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
|
-
D'Eegeschaft `type` ' kann `file` ' , `dir` , `link` oder `special` .
|
|
281
|
-
|
|
282
|
-
Ofhängeg vun der Aart vum Chauffer, kann e `list` Kommando net all Felder zréckginn. Den `name` an `type` Eegeschaften
|
|
283
|
-
soll ëmmer präsent sinn. E spéideren `metadata` Kommando wäert all verfügbare Properties zréckginn.
|
|
284
|
-
|
|
285
|
-
## Alternativ Importstil
|
|
286
|
-
Importéiert de komplett-scoped Modul a benotzt d' `connect` Funktioun:
|
|
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 funktionnéiert am Beschten mat engem <a href="https://redis.io">Redis</a> Cache.
|
|
295
|
-
|
|
296
|
-
Mobiletto wäert probéieren mat enger Redis Instanz op 127.0.0.1:6379 ze verbannen
|
|
297
|
-
|
|
298
|
-
Dir kënnt entweder vun dësen iwwerschreiden:
|
|
299
|
-
* Setzt den `MOBILETTO_REDIS_HOST` env var, mobiletto fir hei ze verbannen amplaz vum localhost
|
|
300
|
-
* Setzt den `MOBILETTO_REDIS_PORT` env var, dësen Hafen gëtt benotzt
|
|
301
|
-
|
|
302
|
-
Mobiletto späichert all seng Redis Schlësselen mam Präfix `_mobiletto__` . Dir kënnt dëst änneren
|
|
303
|
-
andeems Dir den `MOBILETTO_REDIS_PREFIX` env var.
|
|
304
|
-
|
|
305
|
-
Dir kënnt och Per-Connection Caching mat dem `opts.redisConfig` Objet setzen:
|
|
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
|
-
### Wëllt Dir kee Redis Caching?
|
|
317
|
-
Fir auszeschalten: pass `enabled: false` an Ärem `opts.redisConfig` Objet wann Dir Är Verbindung opstellt.
|
|
318
|
-
|
|
319
|
-
Wéi hei ënnendrënner diskutéiert, wäert d'Caching auszeschalten en negativen Effekt op d'Performance hunn a méi Ufroe maachen
|
|
320
|
-
zu Stockage datt Dir wierklech muss.
|
|
321
|
-
|
|
322
|
-
### Caching Leedung
|
|
323
|
-
**Verschlësselte Späichere**: d'Verschlësselungslagerung liesen / schreiwen ass nëmmen e bësse méi lues wéi normal,
|
|
324
|
-
mee navigéieren ronderëm Verzeechnes (wat e puer Saache maachen) ass zimlech deier. Benotzt e Redis Cache
|
|
325
|
-
ginn Iech eng bedeitend Leeschtung Schwong.
|
|
326
|
-
|
|
327
|
-
De Standard-Cache ass sécher, awer funktionnéiert net gutt wann Dir vill Schreif- / Ewechaarbechten hutt.
|
|
328
|
-
All Schreif- oder Entfernungsoperatioun ongëlteg de ganze Cache, a garantéiert datt spéider Liesungen de
|
|
329
|
-
lescht Ännerungen.
|
|
330
|
-
|
|
331
|
-
### CLI Tools
|
|
332
|
-
Wann Dir e CLI Tool benotzt wéi [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
|
|
333
|
-
Dir wëllt definitiv de Redis Cache aktivéieren, well et dauert iwwer Uruff vum `mo` Kommando.
|
|
334
|
-
|
|
335
|
-
## Spigelen
|
|
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
|
-
De Kommando `mirror` mécht eng eemoleg Kopie vun all Dateie vun engem Mobiletto op en aneren.
|
|
344
|
-
Et leeft kee Prozess fir de Spigel iwwer Zäit z'erhalen. Run de Kommando `mirror` erëm
|
|
345
|
-
fir fehlend Dateien ze synchroniséieren.
|
|
346
|
-
|
|
347
|
-
De `mirror` vum 'Spigel' ass en einfachen Objet mat Zähler fir wéi vill Dateien erfollegräich waren
|
|
348
|
-
gespigelt a wéi vill Dateie Feeler haten:
|
|
349
|
-
|
|
350
|
-
{
|
|
351
|
-
success: count-of-files-mirrored,
|
|
352
|
-
errors: count-of-files-with-errors
|
|
353
|
-
}
|
|
354
|
-
|
|
355
|
-
OPGEPASST: Mirroréiere vu groussen Datesets ka ganz Zäitopwendeg a Bandbreedintensiv sinn
|
|
356
|
-
|
|
357
|
-
Mat der `mirror` ' Call Semantik kann et heiansdo duerchernee sinn ze verstoen wien ass
|
|
358
|
-
Lieser a wien de Schrëftsteller ass. Stellt Iech vir wéi eng Uerderungserklärung: de "lénkse Mobiletto"
|
|
359
|
-
ass d'Saach déi zougewisen gëtt (Spigeldaten geschriwwen), an de "riets Mobiletto" (den
|
|
360
|
-
Argument fir d' `mirror` Methode) ass de Wäert deen zougewisen gëtt (Spigeldaten gi gelies).
|
|
361
|
-
|
|
362
|
-
## Transparent Verschlësselung
|
|
363
|
-
Aktivéiert transparent Client-Säit Verschlësselung:
|
|
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
|
-
Waat leeft? Eng separat "Verzeechnesentrée" (dirent) Verzeechnes (verschlësselte) verfollegt wéi eng Dateien an deem sinn
|
|
383
|
-
Verzeechnes (alias den dirent Verzeechnes).
|
|
384
|
-
* De Kommando `list` liest d'Verzeechnesentrée Dateien, entschlësselt all opgelëscht Wee; gitt dann Metadaten fir all Fichier zréck
|
|
385
|
-
* `list` Kommandoe si méi ineffizient, besonnesch fir Verzeichnisser mat enger grousser Zuel vu Dateien
|
|
386
|
-
* De Kommando "schreiwen" schreift `write` Dateien an all Elterendeel hir dirent Verzeechnes, rekursiv; da schreift de Fichier
|
|
387
|
-
* `write` Kommandoen wäerten O(N) Schreift entstoen, mat N = Déift an der Verzeechneshierarchie
|
|
388
|
-
* De Kommando "läschen" läscht déi entspriechend `remove` Datei, a seng Elterendeel wann eidel, rekursiv; läscht dann d'Datei
|
|
389
|
-
* Net-rekursiv `remove` Befehle wäerten O(N) liesen a potenziell sou vill Läschen, mat N = Déift an der Verzeechneshierarchie
|
|
390
|
-
* Rekursiv `remove` Kommandoen op grouss an déif Dateiesystemer kënnen deier sinn
|
|
391
|
-
|
|
392
|
-
Notéiert datt och mat Client-Säit Verschlësselung aktivéiert, e Géigner mat voller Visibilitéit op Är verschlësselte Serversäit
|
|
393
|
-
Stockage, och ouni de Schlëssel, kann nach d'total Zuel vun Verzeechnes gesinn a wéivill Fichieren sinn an all, a mat
|
|
394
|
-
puer Efforten , Entdeckt e puer oder all vun der Gesamtstruktur vun der directory Hierarchie.
|
|
395
|
-
*Notiz: Benotzt eng relativ flaach Struktur fir besser Sécherheet.*
|
|
396
|
-
De Géigner géif d'Nimm vun den Verzeichnisser/Dateien net kennen, ausser si woussten och Är Verschlësselung
|
|
397
|
-
Schlëssel oder soss erfollegräich d'Verschlësselung geknackt. All Spillwette sinn dann aus!
|
|
398
|
-
|
|
399
|
-
### Leeschtung an Cache
|
|
400
|
-
Operatiounen op verschlësselte Späichere kënne lues sinn. Rekursiv Oplëschtungen an Entfernunge kënne ganz lues sinn.
|
|
401
|
-
Caching iwwer Redis hëlleft enorm, awer bemierkt datt de Cache bei all Schreiwen oder ewechgeholl gëtt.
|
|
402
|
-
|
|
403
|
-
## Schlëssel Rotatioun
|
|
404
|
-
Erstellt e Mobiletto mat Ärem neie Schlëssel, spigelt dann déi al Daten an et:
|
|
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
|
-
E Chauffer ass all JS-Datei déi eng 'storageClient' Funktioun mat dëser Ënnerschrëft exportéiert:
|
|
418
|
-
|
|
419
|
-
function storageClient (key, secret, opts)
|
|
420
|
-
|
|
421
|
-
* `key` : eng String, Ären API Schlëssel (fir de `local` Chauffer ass dëst de Basisverzeechnes)
|
|
422
|
-
* `secret` : eng String, Äert API Geheimnis (kann fir de `local` Chauffer ewechgelooss ginn)
|
|
423
|
-
* `opts` : en Objet, d'Eegeschafte si pro Chauffer:
|
|
424
|
-
* Fir 'lokal' bestëmmen d'Eegeschafte `fileMode` `local` `dirMode` wéi nei Dateien a Verzeichnisser erstallt ginn
|
|
425
|
-
* Fir `s3` ' ass d'Eigenschaft `bucket` erfuerderlech. Optional Eegeschafte sinn:
|
|
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
|
-
Den Objet deen d'StorageClient Funktioun zréckkënnt muss dës Funktiounen definéieren:
|
|
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
|
-
## Logged
|
|
457
|
-
Mobiletto benotzt d'[winston](https://www.npmjs.com/package/winston) Logbibliothéik.
|
|
458
|
-
|
|
459
|
-
Logbicher **wäerten** Dateiweeër a Fehlermeldungen enthalen, awer wäerten **ni** Schlësselen, Geheimnisser,
|
|
460
|
-
oder all aner Verbindung Configuratioun Informatiounen.
|
|
461
|
-
|
|
462
|
-
### Logniveau
|
|
463
|
-
Benotzt d' `MOBILETTO_LOG_LEVEL` Ëmfeld Variabel fir de Logniveau ze setzen, mat engem
|
|
464
|
-
vun den `npm` Niveauen definéiert an [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
|
|
465
|
-
|
|
466
|
-
De Standardniveau ass `error` . Dee verboseste Niveau ass `silly` , obwuel de Moment Mobiletto
|
|
467
|
-
loggt net op Niveauen ënner `debug`
|
|
468
|
-
|
|
469
|
-
MOBILETTO_LOG_LEVEL=silly # maximum logs!
|
|
470
|
-
|
|
471
|
-
### Log Datei
|
|
472
|
-
Par défaut schreift de Logger op d'Konsole. Fir Logbicher op eng Datei ze schécken, set de `MOBILETTO_LOG_FILE`
|
|
473
|
-
Ëmfeld Variabel. Wann Dir op eng Datei loggt, ginn d'Logbicher net méi op d'Konsole geschriwwe ginn.
|
|
474
|
-
|
|
475
|
-
MOBILETTO_LOG_FILE=/var/my_mobiletto_log
|
|
476
|
-
|
|
477
|
-
Fir de Logbuch auszeschalten:
|
|
478
|
-
|
|
479
|
-
MOBILETTO_LOG_FILE=/dev/null
|
|
480
|
-
|
|
481
|
-
</pre>
|