mobiletto 1.1.10 → 1.1.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +74 -0
- package/docs/README.md +113 -0
- package/docs/af/README.md +481 -0
- package/docs/am/README.md +481 -0
- package/docs/ar/README.md +481 -0
- package/docs/az/README.md +481 -0
- package/docs/be/README.md +481 -0
- package/docs/bg/README.md +481 -0
- package/docs/bn/README.md +481 -0
- package/docs/bs/README.md +481 -0
- package/docs/ca/README.md +481 -0
- package/docs/ceb/README.md +481 -0
- package/docs/co/README.md +481 -0
- package/docs/cs/README.md +481 -0
- package/docs/cy/README.md +481 -0
- package/docs/da/README.md +481 -0
- package/docs/de/README.md +481 -0
- package/docs/el/README.md +481 -0
- package/docs/eo/README.md +481 -0
- package/docs/es/README.md +481 -0
- package/docs/et/README.md +481 -0
- package/docs/eu/README.md +481 -0
- package/docs/fa/README.md +481 -0
- package/docs/fi/README.md +481 -0
- package/docs/fr/README.md +481 -0
- package/docs/fy/README.md +481 -0
- package/docs/ga/README.md +481 -0
- package/docs/gd/README.md +481 -0
- package/docs/gl/README.md +481 -0
- package/docs/gu/README.md +481 -0
- package/docs/ha/README.md +481 -0
- package/docs/haw/README.md +481 -0
- package/docs/he/README.md +481 -0
- package/docs/hi/README.md +481 -0
- package/docs/hmn/README.md +481 -0
- package/docs/hr/README.md +481 -0
- package/docs/ht/README.md +481 -0
- package/docs/hu/README.md +481 -0
- package/docs/hy/README.md +481 -0
- package/docs/id/README.md +481 -0
- package/docs/ig/README.md +481 -0
- package/docs/is/README.md +481 -0
- package/docs/it/README.md +481 -0
- package/docs/iw/README.md +481 -0
- package/docs/ja/README.md +481 -0
- package/docs/jv/README.md +481 -0
- package/docs/ka/README.md +481 -0
- package/docs/kk/README.md +481 -0
- package/docs/km/README.md +481 -0
- package/docs/kn/README.md +481 -0
- package/docs/ko/README.md +481 -0
- package/docs/ku/README.md +481 -0
- package/docs/ky/README.md +481 -0
- package/docs/la/README.md +481 -0
- package/docs/lb/README.md +481 -0
- package/docs/lo/README.md +481 -0
- package/docs/lt/README.md +481 -0
- package/docs/lv/README.md +481 -0
- package/docs/mg/README.md +481 -0
- package/docs/mi/README.md +481 -0
- package/docs/mk/README.md +481 -0
- package/docs/ml/README.md +481 -0
- package/docs/mn/README.md +481 -0
- package/docs/mr/README.md +481 -0
- package/docs/ms/README.md +481 -0
- package/docs/mt/README.md +481 -0
- package/docs/my/README.md +481 -0
- package/docs/ne/README.md +481 -0
- package/docs/nl/README.md +481 -0
- package/docs/no/README.md +481 -0
- package/docs/ny/README.md +481 -0
- package/docs/or/README.md +481 -0
- package/docs/pa/README.md +481 -0
- package/docs/pl/README.md +481 -0
- package/docs/ps/README.md +481 -0
- package/docs/pt/README.md +481 -0
- package/docs/ro/README.md +481 -0
- package/docs/ru/README.md +481 -0
- package/docs/rw/README.md +481 -0
- package/docs/sd/README.md +481 -0
- package/docs/si/README.md +481 -0
- package/docs/sk/README.md +481 -0
- package/docs/sl/README.md +481 -0
- package/docs/sm/README.md +481 -0
- package/docs/sn/README.md +481 -0
- package/docs/so/README.md +481 -0
- package/docs/sq/README.md +481 -0
- package/docs/sr/README.md +481 -0
- package/docs/st/README.md +481 -0
- package/docs/su/README.md +481 -0
- package/docs/sv/README.md +481 -0
- package/docs/sw/README.md +481 -0
- package/docs/ta/README.md +481 -0
- package/docs/te/README.md +481 -0
- package/docs/tg/README.md +481 -0
- package/docs/th/README.md +481 -0
- package/docs/tk/README.md +481 -0
- package/docs/tl/README.md +481 -0
- package/docs/tr/README.md +481 -0
- package/docs/tt/README.md +481 -0
- package/docs/ug/README.md +481 -0
- package/docs/uk/README.md +481 -0
- package/docs/ur/README.md +481 -0
- package/docs/uz/README.md +481 -0
- package/docs/vi/README.md +481 -0
- package/docs/xh/README.md +481 -0
- package/docs/yi/README.md +481 -0
- package/docs/yo/README.md +481 -0
- package/docs/zh/README.md +481 -0
- package/docs/zu/README.md +481 -0
- package/drivers/b2/index.js +25 -6
- package/hokey.json +16 -0
- package/index.js +7 -2
- package/package.json +1 -1
- package/test/api.spec.js +13 -9
- package/util/redis.js +2 -2
|
@@ -0,0 +1,481 @@
|
|
|
1
|
+
Mobiletto
|
|
2
|
+
=========
|
|
3
|
+
|
|
4
|
+
Mobiletto on JavaScripti salvestamise abstraktsioonikiht, millel on valikuline läbipaistev kliendipoolne krüptimine.
|
|
5
|
+
|
|
6
|
+
# Sisu
|
|
7
|
+
* [Miks Mobiletto?](#Why-Mobiletto?)
|
|
8
|
+
* [Kiire algus](#Quick-start)
|
|
9
|
+
* [Mobiletto CLI](#mobiletto-cli)
|
|
10
|
+
* [Allikas](#Allikas)
|
|
11
|
+
* [Paigaldamine](#Installatsioon)
|
|
12
|
+
* [Toetus ja rahastamine](#Support-and-Funding)
|
|
13
|
+
* [Põhikasutus](#Põhikasutus)
|
|
14
|
+
* [Metaandmed](#Metadata)
|
|
15
|
+
* [Alternatiivne impordi stiil](#Alternate-import-style)
|
|
16
|
+
* [vahemällu salvestamine](#vahemällu salvestamine)
|
|
17
|
+
* [Peegeldamine](#Peegeldamine)
|
|
18
|
+
* [Läbipaistev krüptimine](#Transparent-encryption)
|
|
19
|
+
* [Key rotation](#Key-rotation)
|
|
20
|
+
* [Draiveri liides](#Driver-interface)
|
|
21
|
+
* [Logimine](#Logging)
|
|
22
|
+
|
|
23
|
+
# Lugege seda teises keeles
|
|
24
|
+
See README.md dokument on [hokeylization](https://github.com/cobbzilla/hokeylization) kaudu tõlgitud keelde
|
|
25
|
+
**[Google'i tõlge toetab kõiki keeli](https://cloud.google.com/translate/docs/languages)!**
|
|
26
|
+
|
|
27
|
+
Olen kindel, et see pole täiuslik, aga ma loodan, et see on parem kui mitte midagi!
|
|
28
|
+
|
|
29
|
+
[🇸🇦 araabia](../ar/README.md)
|
|
30
|
+
[🇧🇩 Bengali](../bn/README.md)
|
|
31
|
+
[🇩🇪 saksa keel](../de/README.md)
|
|
32
|
+
[🇺🇸 inglise keel](../en/README.md)
|
|
33
|
+
[🇪🇸 hispaania](../es/README.md)
|
|
34
|
+
[🇫🇷 prantsuse keel](../fr/README.md)
|
|
35
|
+
[🇹🇩 Hausa](../ha/README.md)
|
|
36
|
+
[🇮🇳 Hindi](../hi/README.md)
|
|
37
|
+
[🇮🇩 Indoneesia](../id/README.md)
|
|
38
|
+
[🇮🇹 itaalia](../it/README.md)
|
|
39
|
+
[🇯🇵 jaapani](../ja/README.md)
|
|
40
|
+
[🇰🇷 korea](../ko/README.md)
|
|
41
|
+
[🇮🇳 Maranthi](../mr/README.md)
|
|
42
|
+
[🇵🇱 Poola](../pl/README.md)
|
|
43
|
+
[🇧🇷 portugali](../pt/README.md)
|
|
44
|
+
[🇷🇺 vene keel](../ru/README.md)
|
|
45
|
+
[🇰🇪 suahiili](../sw/README.md)
|
|
46
|
+
[🇵🇭 Tagalog](../tl/README.md)
|
|
47
|
+
[🇹🇷 türgi](../tr/README.md)
|
|
48
|
+
[🇵🇰 Urdu](../ur/README.md)
|
|
49
|
+
[🇻🇳 vietnami](../vi/README.md)
|
|
50
|
+
[🇨🇳 hiina](../zh/README.md)
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
**[📚 ... Kõik keeled ...](../README.md)**
|
|
54
|
+
----
|
|
55
|
+
|
|
56
|
+
### Kas selle README tõlkega on probleeme?
|
|
57
|
+
See konkreetne originaali [README] tõlge (https://github.com/cobbzilla/mobiletto/blob/master/README.md)
|
|
58
|
+
võib olla vigane -- *parandused on väga teretulnud!* Saatke [tõmbetaotlus GitHubis](https://github.com/cobbzilla/mobiletto/pulls),
|
|
59
|
+
või kui te ei soovi seda teha, [avage probleem](https://github.com/cobbzilla/mobiletto/issues)
|
|
60
|
+
|
|
61
|
+
Kui loote tõlke kohta uue GitHubi probleemi, tehke järgmist.
|
|
62
|
+
* lisage lehe URL (kopeerige/kleepige brauseri aadressiribalt)
|
|
63
|
+
* lisage täpne tekst, mis on vale (kopeeri/kleebi brauserist)
|
|
64
|
+
* palun kirjeldage, mis on valesti – kas tõlge on vale? kas vormindus on kuidagi katki?
|
|
65
|
+
* pakkuge lahkelt ettepanekut parema tõlke kohta või kuidas tekst tuleks õigesti vormistada
|
|
66
|
+
* **Aitäh!**
|
|
67
|
+
|
|
68
|
+
## Miks just Mobiletto?
|
|
69
|
+
|
|
70
|
+
### Hüvasti müüja lukustus!
|
|
71
|
+
Erinevatel pilvesalvestuse pakkujatel on ühildumatud API-d. Isegi need, mis püüdlevad "S3-ühilduvuse poole"
|
|
72
|
+
on omapärane käitumine.
|
|
73
|
+
|
|
74
|
+
Kui valite oma rakendusele konkreetse salvestusruumi tarnija, kui kodeerite otse nende API-sse, oma rakendusse
|
|
75
|
+
sõltub nüüd sellest teenusest. Aja möödudes ja koodi kogunedes muutuvad tarnijad
|
|
76
|
+
üha talumatumaks. Tere tulemast müüja lukustamise lõbusasse maailma!
|
|
77
|
+
|
|
78
|
+
Mobiletto loodi selle probleemi lahendamiseks. Kodeerides oma rakenduse mobiletto API-sse, saate seda hõlpsalt teha
|
|
79
|
+
muutke salvestusruumi pakkujat ja teadke, et teie rakenduse salvestuskiht käitub identselt.
|
|
80
|
+
|
|
81
|
+
### Ulatuslikud testid
|
|
82
|
+
Kõiki juhte testitakse identse käitumise suhtes, iga juhi kohta tehakse 60+ testi.
|
|
83
|
+
Testime kõiki draivereid kõigi järgmiste kombinatsioonidega:
|
|
84
|
+
* Krüpteerimine: nii lubatud kui ka keelatud
|
|
85
|
+
* Redis vahemälu: nii lubatud kui ka keelatud
|
|
86
|
+
|
|
87
|
+
See lähenemine annab meile meelerahu, et mobiletto käitub samamoodi, olenemata sellest, millist draiverit kasutate,
|
|
88
|
+
ja olenemata sellest, kas lubate vahemällu salvestamise ja/või krüptimise.
|
|
89
|
+
|
|
90
|
+
### Juhi tugi
|
|
91
|
+
Praegused Mobiletto salvestusdraiverid:
|
|
92
|
+
* `s3` : Amazon S3
|
|
93
|
+
* `b2` : Backblaze B2
|
|
94
|
+
* `local` : kohalik failisüsteem
|
|
95
|
+
|
|
96
|
+
*Kaastööd rohkemate pilvesalvestuse pakkujate toetamiseks on väga teretulnud!*
|
|
97
|
+
|
|
98
|
+
## mobiletto-cli
|
|
99
|
+
Mobiletto on mõeldud kasutamiseks muu JavaScripti koodi raamatukoguna.
|
|
100
|
+
|
|
101
|
+
Käsureal mobilettoga töötamiseks kasutage [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
|
|
102
|
+
|
|
103
|
+
## Allikas
|
|
104
|
+
* [mobiletto GitHubis](https://github.com/cobbzilla/mobiletto)
|
|
105
|
+
* [mobiletto on npm](https://www.npmjs.com/package/mobiletto)
|
|
106
|
+
|
|
107
|
+
## Toetus ja rahastamine
|
|
108
|
+
Üritan olla professionaalne avatud lähtekoodiga tarkvaraarendaja. Olen töötanud
|
|
109
|
+
tarkvaratööstuses aastaid, olen loonud edukaid ettevõtteid ja müünud neid riigiettevõtetele.
|
|
110
|
+
Hiljuti kaotasin töö ja muud tööd mul tegelikult ei ole
|
|
111
|
+
|
|
112
|
+
Nii et proovin kirjutada kasulikku tarkvara ja vaadata, kas see töötab
|
|
113
|
+
|
|
114
|
+
Kui teile meeldib seda tarkvara kasutada, oleksin isegi selle eest väga tänulik
|
|
115
|
+
väikseim [igakuine sissemakse Patreoni kaudu](https://www.patreon.com/cobbzilla)
|
|
116
|
+
|
|
117
|
+
*Aitäh!*
|
|
118
|
+
|
|
119
|
+
## Paigaldamine
|
|
120
|
+
Installige, kasutades `npm` `yarn` " või "lõng". Tõenäoliselt soovite `lite` versiooni, mis ei sisalda kõiki
|
|
121
|
+
tõlgitud README failid:
|
|
122
|
+
|
|
123
|
+
npm install mobiletto-lite
|
|
124
|
+
yarn add mobiletto-lite
|
|
125
|
+
|
|
126
|
+
Kui soovite tõesti README-faile igas keeles, installige täisversioon:
|
|
127
|
+
|
|
128
|
+
npm install mobiletto
|
|
129
|
+
yarn add mobiletto
|
|
130
|
+
|
|
131
|
+
## Kiire algus
|
|
132
|
+
Lühike näide mobiletto `s3` draiveri kasutamisest.
|
|
133
|
+
|
|
134
|
+
See kood töötaks sama, kui draiver oleks `b2` või `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
|
+
## Põhikasutus
|
|
165
|
+
Palju ulatuslikum näide, mis näitab enamikku pakutavatest funktsioonidest:
|
|
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
|
+
## Metaandmed
|
|
267
|
+
Käsk `metadata` tagastab metaandmed ühe failisüsteemi kirje kohta.
|
|
268
|
+
Samamoodi on käsu `list` metaandmeobjektide massiiv.
|
|
269
|
+
|
|
270
|
+
Metaandmete objekt näeb välja selline:
|
|
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
|
+
Atribuut `type` type" võib olla `file` " , `link` `dir` " , "link" või `special` .
|
|
281
|
+
|
|
282
|
+
Olenevalt draiveri tüübist ei pruugi käsk `list` kõiki välju tagastada. `name` ja `type`
|
|
283
|
+
peaks alati kohal olema. Järgnev `metadata` käsk tagastab kõik saadaolevad atribuudid.
|
|
284
|
+
|
|
285
|
+
## Alternatiivne impordi stiil
|
|
286
|
+
Importige täieliku ulatusega moodul ja kasutage funktsiooni `connect` .
|
|
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
|
+
## Vahemälu
|
|
294
|
+
Mobiletto töötab kõige paremini <a href="https://redis.io">redis</a> -vahemäluga.
|
|
295
|
+
|
|
296
|
+
Mobiletto proovib luua ühenduse redis-eksemplariga aadressil 127.0.0.1:6379
|
|
297
|
+
|
|
298
|
+
Saate alistada ühe järgmistest:
|
|
299
|
+
* Seadke `MOBILETTO_REDIS_HOST` env var, mobile loob siin ühenduse kohaliku hosti asemel
|
|
300
|
+
* Määra `MOBILETTO_REDIS_PORT` env var, seda porti kasutatakse
|
|
301
|
+
|
|
302
|
+
Mobiletto salvestab kõik oma redis-võtmed eesliitega `_mobiletto__` . Saate seda muuta
|
|
303
|
+
määrates `MOBILETTO_REDIS_PREFIX` env var.
|
|
304
|
+
|
|
305
|
+
Ühendusepõhise vahemällu saate määrata ka objektiga `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
|
+
### Kas te ei soovi uuesti vahemällu salvestada?
|
|
317
|
+
Keelamiseks edastage ühenduse loomisel objektile `opts.redisConfig` `enabled: false` false".
|
|
318
|
+
|
|
319
|
+
Nagu allpool kirjeldatud, avaldab vahemällu salvestamise keelamine jõudlust negatiivselt ja toob kaasa rohkem taotlusi
|
|
320
|
+
salvestusruumi, mida te tõesti vajate.
|
|
321
|
+
|
|
322
|
+
### Vahemällu salvestamise juhised
|
|
323
|
+
**Krüpteeritud salvestusruum**: krüptitud salvestusruumi lugemine/kirjutamine on tavalisest veidi aeglasem,
|
|
324
|
+
kuid kataloogides navigeerimine (mida mõned asjad teevad) on üsna kulukas. Redis vahemälu kasutamine
|
|
325
|
+
annab teile märkimisväärse jõudluse tõuke.
|
|
326
|
+
|
|
327
|
+
Vaikevahemälu on turvaline, kuid ei tööta hästi, kui teil on palju kirjutamis-/eemaldustoiminguid.
|
|
328
|
+
Iga kirjutamis- või eemaldamisoperatsioon muudab kogu vahemälu kehtetuks, tagades, et järgnevad lugemised näevad
|
|
329
|
+
viimased muudatused.
|
|
330
|
+
|
|
331
|
+
### CLI tööriistad
|
|
332
|
+
Kui kasutate CLI-tööriista, nagu [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
|
|
333
|
+
kindlasti soovite redis-vahemälu lubada, kuna see kestab kogu käsu `mo` väljakutsumise ajal.
|
|
334
|
+
|
|
335
|
+
## Peegeldamine
|
|
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
|
+
Käsk `mirror` teeb kõigist failidest ühekordse koopia ühest mobiilist teise.
|
|
344
|
+
See ei käivita peegli aja jooksul hooldamiseks ühtegi protsessi. Käivitage käsk `mirror` uuesti
|
|
345
|
+
puuduvate failide sünkroonimiseks.
|
|
346
|
+
|
|
347
|
+
`mirror` on lihtne objekt, millel on loendurid selle kohta, kui palju faile õnnestus
|
|
348
|
+
peegeldatud ja kui paljudes failides oli vigu:
|
|
349
|
+
|
|
350
|
+
{
|
|
351
|
+
success: count-of-files-mirrored,
|
|
352
|
+
errors: count-of-files-with-errors
|
|
353
|
+
}
|
|
354
|
+
|
|
355
|
+
HOIATUS: suurte andmekogumite peegeldamine võib olla väga aeganõudev ja ribalaiusmahukas
|
|
356
|
+
|
|
357
|
+
`mirror` semantika puhul võib mõnikord olla segane aru saada, kes on
|
|
358
|
+
lugeja ja kes on kirjutaja. Kujutage ette seda nagu ülesandelause: "vasakpoolne mobiiltelefon"
|
|
359
|
+
on asi, millele määratakse (kirjutatud peegelandmed) ja "parempoolne mobiiltelefon" (
|
|
360
|
+
`mirror` argument) on omistatav väärtus (loetakse peegeldatud andmeid).
|
|
361
|
+
|
|
362
|
+
## Läbipaistev krüptimine
|
|
363
|
+
Luba läbipaistev kliendipoolne krüptimine:
|
|
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
|
+
Mis toimub? Eraldi "kataloogi kirje" (dirent) kataloog (krüpteeritud) jälgib, millised failid selles on
|
|
383
|
+
kataloog (teise nimega dirent kataloog).
|
|
384
|
+
* Käsk `list` loeb kataloogikirje failid, dekrüpteerib iga loetletud tee; seejärel tagastab iga faili metaandmed
|
|
385
|
+
* Käsud `list` on ebaefektiivsemad, eriti suure hulga failidega kataloogide puhul
|
|
386
|
+
* Käsk `write` kirjutab dirent failid iga vanema dirent kataloogi, rekursiivselt; siis kirjutab faili
|
|
387
|
+
* `write` käsud nõuavad O(N) kirjutamist, kusjuures N = sügavus kataloogihierarhias
|
|
388
|
+
* Käsk `remove` eemalda" eemaldab rekursiivselt vastava dirent-faili ja selle vanema, kui see on tühi; seejärel eemaldab faili
|
|
389
|
+
* `remove` O(N) lugemist ja potentsiaalselt sama palju kustutamisi, kusjuures N = sügavus kataloogihierarhias
|
|
390
|
+
* Rekursiivsed `remove` suurtes ja sügavates failisüsteemides võivad olla kulukad
|
|
391
|
+
|
|
392
|
+
Pange tähele, et isegi kui kliendipoolne krüptimine on lubatud, on vastane, kellel on täielik nähtavus teie krüptitud serveri poolel
|
|
393
|
+
salvestusruum, isegi ilma võtmeta, näeb siiski kataloogide koguarvu ja seda, kui palju faile igas ja koos on
|
|
394
|
+
mõningaid jõupingutusi, avastage osa või kogu kataloogihierarhia üldine struktuur.
|
|
395
|
+
*Märkus. Parema turvalisuse tagamiseks kasutage suhteliselt tasast konstruktsiooni.*
|
|
396
|
+
Vastane ei tea kataloogide/failide nimesid, kui ta ei tea ka sinu krüptimist
|
|
397
|
+
võti või oli krüpteering muul viisil edukalt lahti murdnud. Kõik ennustused on siis välja lülitatud!
|
|
398
|
+
|
|
399
|
+
### Jõudlus ja vahemälu
|
|
400
|
+
Krüpteeritud salvestusruumi toimingud võivad olla aeglased. Rekursiivsed loendid ja eemaldamised võivad olla väga aeglased.
|
|
401
|
+
Vahemällu salvestamine redise kaudu aitab tohutult, kuid pange tähele, et vahemälu tühjeneb iga kirjutamise või eemaldamise korral.
|
|
402
|
+
|
|
403
|
+
## Võtme pöörlemine
|
|
404
|
+
Looge oma uue võtmega mobiiltelefon, seejärel peegeldage sellesse vanu andmeid:
|
|
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
|
+
## Draiveri liides
|
|
417
|
+
Draiver on mis tahes JS-fail, mis ekspordib funktsiooni „storageClient” järgmise allkirjaga:
|
|
418
|
+
|
|
419
|
+
function storageClient (key, secret, opts)
|
|
420
|
+
|
|
421
|
+
* `key` : string, teie API võti ( `local` draiveri jaoks on see baaskataloog)
|
|
422
|
+
* `secret` : string, teie API saladus (saab `local` draiveri puhul ära jätta)
|
|
423
|
+
* `opts` : objekt, atribuudid on juhipõhised:
|
|
424
|
+
* `local` ” puhul määravad atribuudid `fileMode` ja `dirMode` , kuidas luuakse uusi loovaid faile ja katalooge
|
|
425
|
+
* `s3` `bucket` on atribuut „bucket” nõutav. Valikulised omadused on:
|
|
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
|
+
Objekt, mille funktsioon storageClient tagastab, peab määratlema järgmised funktsioonid:
|
|
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
|
+
## Logimine
|
|
457
|
+
Mobiletto kasutab [winstoni](https://www.npmjs.com/package/winston) logimise teeki.
|
|
458
|
+
|
|
459
|
+
Logid **sisaldavad** failiteid ja veateateid, kuid **mitte kunagi** ei sisalda võtmeid, saladusi,
|
|
460
|
+
või muud ühenduse konfiguratsiooniteavet.
|
|
461
|
+
|
|
462
|
+
### Logi tase
|
|
463
|
+
Logitaseme määramiseks kasutage keskkonnamuutujat `MOBILETTO_LOG_LEVEL` , kasutades ühte
|
|
464
|
+
`npm` tasemetest, mis on määratletud saidil [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
|
|
465
|
+
|
|
466
|
+
`error` . Kõige sõnasõnalisem tase on `silly` , kuigi praegu on mobiletto
|
|
467
|
+
ei logi sisse `debug`
|
|
468
|
+
|
|
469
|
+
MOBILETTO_LOG_LEVEL=silly # maximum logs!
|
|
470
|
+
|
|
471
|
+
### Logifail
|
|
472
|
+
Vaikimisi kirjutab logija konsooli. Logide faili saatmiseks määrake `MOBILETTO_LOG_FILE`
|
|
473
|
+
keskkonna muutuja. Faili logides logisid enam konsooli ei kirjutata.
|
|
474
|
+
|
|
475
|
+
MOBILETTO_LOG_FILE=/var/my_mobiletto_log
|
|
476
|
+
|
|
477
|
+
Logimise väljalülitamiseks toimige järgmiselt.
|
|
478
|
+
|
|
479
|
+
MOBILETTO_LOG_FILE=/dev/null
|
|
480
|
+
|
|
481
|
+
</pre>
|