mobiletto 1.1.8 → 1.1.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +56 -4
- package/docs/README.md +113 -0
- package/docs/af/README.md +455 -0
- package/docs/am/README.md +455 -0
- package/docs/ar/README.md +455 -0
- package/docs/az/README.md +455 -0
- package/docs/be/README.md +455 -0
- package/docs/bg/README.md +455 -0
- package/docs/bn/README.md +455 -0
- package/docs/bs/README.md +455 -0
- package/docs/ca/README.md +455 -0
- package/docs/ceb/README.md +455 -0
- package/docs/co/README.md +455 -0
- package/docs/cs/README.md +455 -0
- package/docs/cy/README.md +455 -0
- package/docs/da/README.md +455 -0
- package/docs/de/README.md +455 -0
- package/docs/el/README.md +455 -0
- package/docs/eo/README.md +455 -0
- package/docs/es/README.md +455 -0
- package/docs/et/README.md +455 -0
- package/docs/eu/README.md +455 -0
- package/docs/fa/README.md +455 -0
- package/docs/fi/README.md +455 -0
- package/docs/fr/README.md +455 -0
- package/docs/fy/README.md +455 -0
- package/docs/ga/README.md +455 -0
- package/docs/gd/README.md +455 -0
- package/docs/gl/README.md +455 -0
- package/docs/gu/README.md +455 -0
- package/docs/ha/README.md +455 -0
- package/docs/haw/README.md +455 -0
- package/docs/he/README.md +455 -0
- package/docs/hi/README.md +455 -0
- package/docs/hmn/README.md +455 -0
- package/docs/hr/README.md +455 -0
- package/docs/ht/README.md +455 -0
- package/docs/hu/README.md +455 -0
- package/docs/hy/README.md +455 -0
- package/docs/id/README.md +455 -0
- package/docs/ig/README.md +455 -0
- package/docs/is/README.md +455 -0
- package/docs/it/README.md +455 -0
- package/docs/iw/README.md +455 -0
- package/docs/ja/README.md +455 -0
- package/docs/jv/README.md +455 -0
- package/docs/ka/README.md +455 -0
- package/docs/kk/README.md +455 -0
- package/docs/km/README.md +455 -0
- package/docs/kn/README.md +455 -0
- package/docs/ko/README.md +455 -0
- package/docs/ku/README.md +455 -0
- package/docs/ky/README.md +455 -0
- package/docs/la/README.md +455 -0
- package/docs/lb/README.md +455 -0
- package/docs/lo/README.md +455 -0
- package/docs/lt/README.md +455 -0
- package/docs/lv/README.md +455 -0
- package/docs/mg/README.md +455 -0
- package/docs/mi/README.md +455 -0
- package/docs/mk/README.md +455 -0
- package/docs/ml/README.md +455 -0
- package/docs/mn/README.md +455 -0
- package/docs/mr/README.md +455 -0
- package/docs/ms/README.md +455 -0
- package/docs/mt/README.md +455 -0
- package/docs/my/README.md +455 -0
- package/docs/ne/README.md +455 -0
- package/docs/nl/README.md +455 -0
- package/docs/no/README.md +455 -0
- package/docs/ny/README.md +455 -0
- package/docs/or/README.md +455 -0
- package/docs/pa/README.md +455 -0
- package/docs/pl/README.md +455 -0
- package/docs/ps/README.md +455 -0
- package/docs/pt/README.md +455 -0
- package/docs/ro/README.md +455 -0
- package/docs/ru/README.md +455 -0
- package/docs/rw/README.md +455 -0
- package/docs/sd/README.md +455 -0
- package/docs/si/README.md +455 -0
- package/docs/sk/README.md +455 -0
- package/docs/sl/README.md +455 -0
- package/docs/sm/README.md +455 -0
- package/docs/sn/README.md +455 -0
- package/docs/so/README.md +455 -0
- package/docs/sq/README.md +455 -0
- package/docs/sr/README.md +455 -0
- package/docs/st/README.md +455 -0
- package/docs/su/README.md +455 -0
- package/docs/sv/README.md +455 -0
- package/docs/sw/README.md +455 -0
- package/docs/ta/README.md +455 -0
- package/docs/te/README.md +455 -0
- package/docs/tg/README.md +455 -0
- package/docs/th/README.md +455 -0
- package/docs/tk/README.md +455 -0
- package/docs/tl/README.md +455 -0
- package/docs/tr/README.md +455 -0
- package/docs/tt/README.md +455 -0
- package/docs/ug/README.md +455 -0
- package/docs/uk/README.md +455 -0
- package/docs/ur/README.md +455 -0
- package/docs/uz/README.md +455 -0
- package/docs/vi/README.md +455 -0
- package/docs/xh/README.md +455 -0
- package/docs/yi/README.md +455 -0
- package/docs/yo/README.md +455 -0
- package/docs/zh/README.md +455 -0
- package/docs/zu/README.md +455 -0
- package/drivers/b2/index.js +24 -6
- package/hokey.json +16 -0
- package/index.js +33 -17
- package/package.json +3 -2
- package/test/api.spec.js +319 -306
- package/util/logger.js +1 -1
- package/util/redis.js +1 -1
|
@@ -0,0 +1,455 @@
|
|
|
1
|
+
Mobiletto
|
|
2
|
+
==========
|
|
3
|
+
|
|
4
|
+
Mobiletto er JavaScript geymsluádráttarlag, með valfrjálsum gagnsæjum dulkóðun viðskiptavinarhliðar.
|
|
5
|
+
|
|
6
|
+
# Innihald
|
|
7
|
+
* [Af hverju Mobiletto?](#Why-Mobiletto?)
|
|
8
|
+
* [Fljót byrjun](#Fljótbyrjun)
|
|
9
|
+
* [Mobiletto CLI](#mobiletto-cli)
|
|
10
|
+
* [Heimild](#Heimild)
|
|
11
|
+
* [Grunnnotkun](#Grunnnotkun)
|
|
12
|
+
* [Lýsigögn](#Lýsigögn)
|
|
13
|
+
* [Vari innflutningsstíll](#Alternate-import-style)
|
|
14
|
+
* [Caching](#Caching)
|
|
15
|
+
* [speglun](#speglun)
|
|
16
|
+
* [Gegnsæ dulkóðun](#Gegnsæ dulkóðun)
|
|
17
|
+
* [Snúningur lykla](#snúningur lykla)
|
|
18
|
+
* [ökumannsviðmót](#ökumannsviðmót)
|
|
19
|
+
* [Logging](#Logging)
|
|
20
|
+
|
|
21
|
+
# Lestu þetta á öðru tungumáli
|
|
22
|
+
Þetta README.md skjal hefur verið þýtt, með [hokeylization](https://github.com/cobbzilla/hokeylization), yfir á
|
|
23
|
+
**[öll tungumál studd af Google Translate](https://cloud.google.com/translate/docs/languages)!**
|
|
24
|
+
|
|
25
|
+
Ég er viss um að það er ekki fullkomið, en ég vona að það sé betra en ekkert!
|
|
26
|
+
|
|
27
|
+
[🇸🇦 arabíska](../ar/README.md)
|
|
28
|
+
[🇧🇩 bengalska](../bn/README.md)
|
|
29
|
+
[🇩🇪 þýska](../de/README.md)
|
|
30
|
+
[🇺🇸 enska](../en/README.md)
|
|
31
|
+
[🇪🇸 spænska](../es/README.md)
|
|
32
|
+
[🇫🇷 franska](../fr/README.md)
|
|
33
|
+
[🇹🇩 Hausa](../ha/README.md)
|
|
34
|
+
[🇮🇳 hindí](../hi/README.md)
|
|
35
|
+
[🇮🇩 indónesíska](../id/README.md)
|
|
36
|
+
[🇮🇹 ítalska](../it/README.md)
|
|
37
|
+
[🇯🇵 japanska](../ja/README.md)
|
|
38
|
+
[🇰🇷 kóreska](../ko/README.md)
|
|
39
|
+
[🇮🇳 Maranthi](../mr/README.md)
|
|
40
|
+
[🇵🇱 pólska](../pl/README.md)
|
|
41
|
+
[🇧🇷 portúgalska](../pt/README.md)
|
|
42
|
+
[🇷🇺 rússneska](../ru/README.md)
|
|
43
|
+
[🇰🇪 svahílí](../sw/README.md)
|
|
44
|
+
[🇵🇭 Tagalog](../tl/README.md)
|
|
45
|
+
[🇹🇷 tyrkneska](../tr/README.md)
|
|
46
|
+
[🇵🇰 Úrdú](../ur/README.md)
|
|
47
|
+
[🇻🇳 víetnamska](../vi/README.md)
|
|
48
|
+
[🇨🇳 kínverska](../zh/README.md)
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
**[📚 ... Öll tungumál ...](../README.md)**
|
|
52
|
+
----
|
|
53
|
+
|
|
54
|
+
### Er vandamál með þessa þýðingu á README?
|
|
55
|
+
Þessi tiltekna þýðing á upprunalegu [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
|
|
56
|
+
gæti verið gölluð -- *leiðréttingar eru mjög vel þegnar!* Vinsamlegast sendu [dragbeiðni á GitHub](https://github.com/cobbzilla/mobiletto/pulls),
|
|
57
|
+
eða ef þú ert ekki sátt við að gera það, [opnaðu mál](https://github.com/cobbzilla/mobiletto/issues)
|
|
58
|
+
|
|
59
|
+
Þegar þú býrð til nýtt GitHub tölublað um þýðingu, vinsamlegast gerðu:
|
|
60
|
+
* láttu vefslóð síðunnar fylgja (afritaðu/límdu af veffangastiku vafrans)
|
|
61
|
+
* láttu nákvæmlega texta sem er rangur fylgja með (afrita/líma úr vafra)
|
|
62
|
+
* vinsamlegast lýstu hvað er rangt -- er þýðingin röng? er sniðið eitthvað bilað?
|
|
63
|
+
* komdu með tillögu um betri þýðingu eða hvernig textinn ætti að vera rétt sniðinn
|
|
64
|
+
* **Þakka þér fyrir!**
|
|
65
|
+
|
|
66
|
+
## Hvers vegna Mobiletto?
|
|
67
|
+
|
|
68
|
+
### Bless söluaðili lokun!
|
|
69
|
+
Hinar ýmsu skýjageymsluveitur eru með ósamrýmanleg API. Jafnvel þeir sem leitast við „S3 samhæfni“
|
|
70
|
+
hafa sérkennilega hegðun.
|
|
71
|
+
|
|
72
|
+
Þegar þú velur tiltekinn geymslusöluaðila fyrir appið þitt, ef þú kóðar beint í API þeirra, appið þitt
|
|
73
|
+
er nú háð þeirri þjónustu. Eftir því sem tíminn líður og kóði safnast upp, breytast framleiðendur
|
|
74
|
+
sífellt óviðunandi. Velkomin í skemmtilegan heim innláns söluaðila!
|
|
75
|
+
|
|
76
|
+
Mobiletto var hannað til að leysa þetta vandamál. Með því að kóða forritið þitt í API fyrir mobiletto geturðu auðveldlega
|
|
77
|
+
skiptu um geymsluþjónustu og veistu að geymslulag appsins þíns mun hegða sér eins.
|
|
78
|
+
|
|
79
|
+
### Umfangsmiklar prófanir
|
|
80
|
+
Allir ökumenn eru prófaðir fyrir eins hegðun með 60+ prófum fyrir hvern ökumann.
|
|
81
|
+
Við prófum alla ökumenn með hverri samsetningu af:
|
|
82
|
+
* Dulkóðun: bæði virkt og óvirkt
|
|
83
|
+
* Redis skyndiminni: bæði virkt og óvirkt
|
|
84
|
+
|
|
85
|
+
Þessi nálgun veitir okkur hugarró að mobiletto hegðar sér eins óháð því hvaða bílstjóri þú notar,
|
|
86
|
+
og óháð því hvort þú virkjar skyndiminni og/eða dulkóðun.
|
|
87
|
+
|
|
88
|
+
### Stuðningur við ökumenn
|
|
89
|
+
Núverandi Mobiletto geymslureklar:
|
|
90
|
+
* `s3` : Amazon S3
|
|
91
|
+
* `b2` : Bakslag B2
|
|
92
|
+
* `local` : staðbundið skráarkerfi
|
|
93
|
+
|
|
94
|
+
*Framlög til að styðja við fleiri skýjageymsluveitur eru mjög vel þegnar!*
|
|
95
|
+
|
|
96
|
+
## mobiletto-cli
|
|
97
|
+
Mobiletto er ætlað að vera notað sem bókasafn með öðrum JavaScript kóða.
|
|
98
|
+
|
|
99
|
+
Til að vinna með mobiletto á skipanalínunni, notaðu [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
|
|
100
|
+
|
|
101
|
+
## Heimild
|
|
102
|
+
* [mobiletto á GitHub](https://github.com/cobbzilla/mobiletto)
|
|
103
|
+
* [mobiletto á npm](https://www.npmjs.com/package/mobiletto)
|
|
104
|
+
|
|
105
|
+
## Fljót byrjun
|
|
106
|
+
Stutt dæmi um að nota mobiletto `s3` bílstjórann.
|
|
107
|
+
|
|
108
|
+
Þessi kóði myndi keyra eins ef ökumaðurinn væri `b2` eða `local` .
|
|
109
|
+
|
|
110
|
+
const storage = require('mobiletto')
|
|
111
|
+
const bucket = await storage.connect('s3', aws_key, aws_secret, {bucket: 'bk'})
|
|
112
|
+
|
|
113
|
+
// list objects: returns array of metadata objects
|
|
114
|
+
const listing = await bucket.list()
|
|
115
|
+
const dirList = await bucket.list('some/dir/')
|
|
116
|
+
const everything = await bucket.list('', {recursive: true})
|
|
117
|
+
|
|
118
|
+
// write an entire file
|
|
119
|
+
let bytesWritten = await bucket.writeFile('some/path', someBufferOfData)
|
|
120
|
+
|
|
121
|
+
// write a file from a stream/generator
|
|
122
|
+
bytesWritten = await bucket.write('some/path', streamOrGenerator)
|
|
123
|
+
|
|
124
|
+
// read an entire file
|
|
125
|
+
// returns null if an exception would otherwise be thrown
|
|
126
|
+
const bufferOrNull = await bucket.safeReadFile('some/path')
|
|
127
|
+
|
|
128
|
+
// stream-read a file, passing data to callback
|
|
129
|
+
const bytesRead = await bucket.read('some/path', (chunk) => { ...do something with chunk... } )
|
|
130
|
+
|
|
131
|
+
// remove a file, returns the path removed
|
|
132
|
+
let removed = await bucket.remove('some/path') // removed is a string
|
|
133
|
+
|
|
134
|
+
// remove a directory, returns array of paths removed
|
|
135
|
+
removed = await bucket.remove('some/directory', {recursive: true}) // removed is now an array!
|
|
136
|
+
|
|
137
|
+
----
|
|
138
|
+
## Grunnnotkun
|
|
139
|
+
Miklu víðtækara dæmi sem sýnir flesta eiginleika sem í boði eru:
|
|
140
|
+
|
|
141
|
+
const { mobiletto } = require('mobiletto')
|
|
142
|
+
|
|
143
|
+
// General usage
|
|
144
|
+
const api = await mobiletto(driverName, key, secret, opts)
|
|
145
|
+
|
|
146
|
+
// To use 'local' driver:
|
|
147
|
+
// * key: base directory
|
|
148
|
+
// * secret: ignored, can be null
|
|
149
|
+
// * opts object:
|
|
150
|
+
// * readOnly: optional, never change anything on the filesystem; default is false
|
|
151
|
+
// * fileMode: optional, permissions used when creating new files, default is 0600. can be string or integer
|
|
152
|
+
// * dirMode: optional, permissions used when creating new directories, default is 0700. can be string or integer
|
|
153
|
+
const local = await mobiletto('local', '/home/ubuntu/tmp', null, {fileMode: 0o0600, dirMode: '0700'})
|
|
154
|
+
|
|
155
|
+
// To use 's3' driver:
|
|
156
|
+
// * key: AWS Access Key ID
|
|
157
|
+
// * secret: AWS Secret Key
|
|
158
|
+
// * opts object:
|
|
159
|
+
// * readOnly: optional, never change anything on the bucket; default is false
|
|
160
|
+
// * bucket: required, name of the S3 bucket
|
|
161
|
+
// * region: optional, the AWS region to communicate with, default is us-east-1
|
|
162
|
+
// * prefix: optional, all read/writes within the S3 bucket will be under this prefix
|
|
163
|
+
// * delimiter: optional, directory delimiter, default is '/' (note: always '/' when encryption is enabled)
|
|
164
|
+
const s3 = await mobiletto('s3', aws_key, aws_secret, {bucket: 'bk', region: 'us-east-1'})
|
|
165
|
+
|
|
166
|
+
// To use 'b2' driver:
|
|
167
|
+
// * key: Backblaze Key ID
|
|
168
|
+
// * secret: Backblaze Application Key
|
|
169
|
+
// * opts object:
|
|
170
|
+
// * readOnly: optional, never change anything on the bucket; default is false
|
|
171
|
+
// * bucket: required, the ID (**not the name**) of the B2 bucket
|
|
172
|
+
// * prefix: optional, all read/writes within the B2 bucket will be under this prefix
|
|
173
|
+
// * delimiter: optional, directory delimiter, default is '/' (note: always '/' when encryption is enabled)
|
|
174
|
+
// * partSize: optional, large files will be split into chunks of this size when uploading
|
|
175
|
+
const b3 = await mobiletto('b2', b2_key_id, b2_app_key, {bucket: 'bk', partSize: 10000000})
|
|
176
|
+
|
|
177
|
+
// List files
|
|
178
|
+
api.list() // --> returns an array of metadata objects
|
|
179
|
+
|
|
180
|
+
// List files recursively
|
|
181
|
+
api.list({ recursive: true })
|
|
182
|
+
|
|
183
|
+
// List files in a directory
|
|
184
|
+
const path = 'some/path'
|
|
185
|
+
api.list(path)
|
|
186
|
+
api.list(path, { recursive: true }) // also supports recursive flag
|
|
187
|
+
|
|
188
|
+
// Visit files in a directory -- visitor function must be async
|
|
189
|
+
api.list(path, { visitor: myAsyncFunc })
|
|
190
|
+
api.list(path, { visitor: myAsyncFunc, recursive: true })
|
|
191
|
+
|
|
192
|
+
// The `list` method throws MobilettoNotFoundError if the path does not exist
|
|
193
|
+
// When you call `safeList` on a non-existent path, it returns an empty array
|
|
194
|
+
api.safeList('/path/that/does/not/exist') // returns []
|
|
195
|
+
|
|
196
|
+
// Read metadata for a file
|
|
197
|
+
api.metadata(path) // returns metadata object
|
|
198
|
+
|
|
199
|
+
// The `metadata` method throws MobilettoNotFoundError if the path does not exist
|
|
200
|
+
// When you call `safeMetadata` on a non-existent path, it returns null
|
|
201
|
+
api.safeMetadata('/tmp/does_not_exist') // returns null
|
|
202
|
+
|
|
203
|
+
// Read a file
|
|
204
|
+
// Provide a callback that writes the data someplace
|
|
205
|
+
const callback = (chunk) => { ... write chunk somewhere ... }
|
|
206
|
+
api.read(path, callback) // returns count of bytes read
|
|
207
|
+
|
|
208
|
+
// Read an entire file at once
|
|
209
|
+
const data = await api.readFile(path) // returns a byte Buffer of the file contents
|
|
210
|
+
|
|
211
|
+
// Read an entire file at once
|
|
212
|
+
// returns null if an exception would otherwise be thrown
|
|
213
|
+
const bufferOrNull = await bucket.safeReadFile('some/path')
|
|
214
|
+
|
|
215
|
+
// Write a file
|
|
216
|
+
// Provide a generator function that yields chunks of data
|
|
217
|
+
const generator = function* () {
|
|
218
|
+
while ( ... more-data-to-return ... ) {
|
|
219
|
+
data = ... load-data ...
|
|
220
|
+
yield data
|
|
221
|
+
}
|
|
222
|
+
}
|
|
223
|
+
local.api(path, generator) // returns count of bytes written
|
|
224
|
+
|
|
225
|
+
// Write an entire file at once (convenience method)
|
|
226
|
+
await api.writeFile(path, bufferOrString) // returns count of bytes written
|
|
227
|
+
|
|
228
|
+
// Delete a file
|
|
229
|
+
// Quiet param is optional (default false), when set errors will not be thrown if the path does not exist
|
|
230
|
+
// Always returns a value or throws an error.
|
|
231
|
+
// Return value may be a single string of the file removed, or an array of all files removed (driver-dependent)
|
|
232
|
+
const quiet = true
|
|
233
|
+
api.remove(path, {quiet}) // returns single path removed
|
|
234
|
+
|
|
235
|
+
// Recursively delete a directory and do it quietly (do not report errors)
|
|
236
|
+
const recursive = true
|
|
237
|
+
const quiet = true
|
|
238
|
+
api.remove(path, {recursive, quiet}) // returns array of paths removed
|
|
239
|
+
|
|
240
|
+
## Lýsigögn
|
|
241
|
+
Skipunin `metadata` skilar lýsigögnum um eina skráakerfisfærslu.
|
|
242
|
+
Sömuleiðis er skilgildið frá skipuninni `list` fylki lýsigagnahluta.
|
|
243
|
+
|
|
244
|
+
Lýsigagnahlutur lítur svona út:
|
|
245
|
+
|
|
246
|
+
{
|
|
247
|
+
"name": "fully/qualified/path/to/file",
|
|
248
|
+
"type": "entry-type",
|
|
249
|
+
"size": size-in-bytes,
|
|
250
|
+
"ctime": creation-time-epoch-millis,
|
|
251
|
+
"mtime": modification-time-epoch-millis
|
|
252
|
+
}
|
|
253
|
+
|
|
254
|
+
Eiginleikinn `type` type` getur verið `file` , `dir` , `link` eða `special` .
|
|
255
|
+
|
|
256
|
+
Það fer eftir tegund ökumanns, `list` skipun getur ekki skilað öllum reitum. Eiginleikar `name` og `type` gerð“
|
|
257
|
+
ætti alltaf að vera til staðar. Síðari `metadata` skipun mun skila öllum tiltækum eiginleikum.
|
|
258
|
+
|
|
259
|
+
## Annar innflutningsstíll
|
|
260
|
+
Flyttu inn fullkomna eininguna og notaðu `connect` aðgerðina:
|
|
261
|
+
|
|
262
|
+
const storage = require('mobiletto')
|
|
263
|
+
const opts = {bucket: 'bk', region: 'us-east-1'}
|
|
264
|
+
const s3 = await storage.connect('s3', aws_key, aws_secret, opts)
|
|
265
|
+
const objectData = await s3.readFile('some/path')
|
|
266
|
+
|
|
267
|
+
## Skyndiminni
|
|
268
|
+
Mobiletto virkar best með <a href="https://redis.io">redis</a> skyndiminni.
|
|
269
|
+
|
|
270
|
+
Mobiletto mun reyna að tengjast redis dæmi á 127.0.0.1:6379
|
|
271
|
+
|
|
272
|
+
Þú getur hnekið öðru hvoru af þessu:
|
|
273
|
+
* Stilltu `MOBILETTO_REDIS_HOST` env var, mobiletto tengja hér í stað staðbundinnar gestgjafa
|
|
274
|
+
* Stilltu `MOBILETTO_REDIS_PORT` env var, þetta port verður notað
|
|
275
|
+
|
|
276
|
+
Mobiletto mun geyma alla endurupptökulykla sína með forskeytinu `_mobiletto__` . Þú getur breytt þessu
|
|
277
|
+
með því að stilla `MOBILETTO_REDIS_PREFIX` env var.
|
|
278
|
+
|
|
279
|
+
Þú getur líka stillt skyndiminni fyrir hverja tengingu með `opts.redisConfig` hlutnum:
|
|
280
|
+
|
|
281
|
+
const redisConfig = {
|
|
282
|
+
enabled: true, // optional, default is true. if false other props are ignored
|
|
283
|
+
host: '127.0.0.1',
|
|
284
|
+
port: 6379,
|
|
285
|
+
prefix: '_mobiletto__'
|
|
286
|
+
}
|
|
287
|
+
const opts = { redisConfig, bucket: 'bk', region: 'us-east-1' }
|
|
288
|
+
const s3 = await storage.connect('s3', aws_key, aws_secret, opts)
|
|
289
|
+
|
|
290
|
+
### Viltu ekki endurupptöku skyndiminni?
|
|
291
|
+
Til að slökkva á: `enabled: false` í `opts.redisConfig` hlutnum þínum þegar þú kemur á tengingu þinni.
|
|
292
|
+
|
|
293
|
+
Eins og fjallað er um hér að neðan mun slökkva á skyndiminni hafa slæm áhrif á frammistöðu og fá fleiri beiðnir
|
|
294
|
+
til geymslu sem þú þarft virkilega á að halda.
|
|
295
|
+
|
|
296
|
+
### Leiðbeiningar um skyndiminni
|
|
297
|
+
**Dulkóðuð geymsla**: að lesa/skrifa dulkóðuð geymsla er aðeins hægari en venjulega,
|
|
298
|
+
en að fletta um möppur (sem sumir hlutir gera) er frekar dýrt. Að nota redis skyndiminni
|
|
299
|
+
mun gefa þér verulegan árangur.
|
|
300
|
+
|
|
301
|
+
Sjálfgefið skyndiminni er öruggt, en virkar ekki vel ef þú ert með mikið af skrif-/fjarlægingaraðgerðum.
|
|
302
|
+
Sérhver skrif- eða fjarlægðaraðgerð ógildir allt skyndiminni og tryggir að síðari lestur sjái
|
|
303
|
+
nýjustu breytingar.
|
|
304
|
+
|
|
305
|
+
### CLI verkfæri
|
|
306
|
+
Ef þú ert að nota CLI tól eins og [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
|
|
307
|
+
þú munt örugglega vilja að redis skyndiminni sé virkt, þar sem það endist yfir ákall um `mo` skipunina.
|
|
308
|
+
|
|
309
|
+
## Speglun
|
|
310
|
+
|
|
311
|
+
// Copy a local filesystem mobiletto to S3
|
|
312
|
+
s3.mirror(local)
|
|
313
|
+
|
|
314
|
+
// Mirror a local subdirectory from one mobiletto to an S3 mobiletto, with it's own subdirectory
|
|
315
|
+
local.mirror(s3, 'some/local-folder', 'some/s3-folder')
|
|
316
|
+
|
|
317
|
+
`mirror` framkvæmir einu sinni afrit af öllum skrám frá einum farsíma til annars.
|
|
318
|
+
Það keyrir ekkert ferli til að viðhalda speglinum með tímanum. Keyrðu aftur `mirror` skipunina
|
|
319
|
+
til að samstilla allar skrár sem vantar.
|
|
320
|
+
|
|
321
|
+
Skilagildið frá `mirror` er einfaldur hlutur með teljara fyrir hversu margar skrár tókst
|
|
322
|
+
speglaðar og hversu margar skrár voru með villur:
|
|
323
|
+
|
|
324
|
+
{
|
|
325
|
+
success: count-of-files-mirrored,
|
|
326
|
+
errors: count-of-files-with-errors
|
|
327
|
+
}
|
|
328
|
+
|
|
329
|
+
VIÐVÖRUN: Það getur verið mjög tímafrekt og bandbreidd að spegla stór gagnasöfn
|
|
330
|
+
|
|
331
|
+
Með merkingarfræði `mirror` kalla getur það stundum verið ruglingslegt að skilja hver er
|
|
332
|
+
lesanda og hver er rithöfundurinn. Ímyndaðu þér það eins og verkefnayfirlýsingu: „vinstri farsímann“
|
|
333
|
+
er hluturinn sem verið er að úthluta til (speglað gögn skrifuð), og "hægri hönd farsíma" (the
|
|
334
|
+
rök fyrir `mirror` aðferðina) er gildið sem verið er að úthluta (speglað gögn eru lesin).
|
|
335
|
+
|
|
336
|
+
## Gegnsætt dulkóðun
|
|
337
|
+
Virkja gagnsæja dulkóðun viðskiptavinarhliðar:
|
|
338
|
+
|
|
339
|
+
// Pass encryption parameters
|
|
340
|
+
const encryption = {
|
|
341
|
+
// key is required, must be >= 16 chars
|
|
342
|
+
key: randomstring.generate(128),
|
|
343
|
+
|
|
344
|
+
// optional, the default is to derive IV from key
|
|
345
|
+
// when set, IV must be >= 16 chars
|
|
346
|
+
iv: randomstring.generate(128),
|
|
347
|
+
|
|
348
|
+
// optional, the default is aes-256-cbc
|
|
349
|
+
algo: 'aes-256-cbc'
|
|
350
|
+
}
|
|
351
|
+
const api = await mobiletto(driverName, key, secret, opts, encryption)
|
|
352
|
+
|
|
353
|
+
// Subsequent write operations will encrypt data (client side) when writing
|
|
354
|
+
// Subsequent read operations will decrypt data (client side) when reading
|
|
355
|
+
|
|
356
|
+
Hvað er að gerast? Sérstök „skráafærsla“ (dirent) möppu (dulkóðuð) rekur hvaða skrár eru í henni
|
|
357
|
+
möppu (aka beina skráin).
|
|
358
|
+
* `list` skipunin les möppuskrárnar, afkóðar hverja slóð sem skráð er; skilar síðan lýsigögnum fyrir hverja skrá
|
|
359
|
+
* `list` skipanir eru óhagkvæmari, sérstaklega fyrir möppur með miklum fjölda skráa
|
|
360
|
+
* `write` skipunin skrifar óhreinar skrár í leiðbeiningaskrá hvers foreldris, endurkvæmt; skrifar síðan skrána
|
|
361
|
+
* `write`
|
|
362
|
+
* `remove` skipunin fjarlægir samsvarandi dirent skrá, og foreldri hennar ef tóm, endurkvæmt; fjarlægir síðan skrána
|
|
363
|
+
* `remove` skipanir munu hafa O(N) lestur og hugsanlega eins margar eyðingar, með N = dýpt í möppustigveldinu
|
|
364
|
+
* Endurkvæmar `remove` skipanir á stórum og djúpum skráarkerfum geta verið dýrar
|
|
365
|
+
|
|
366
|
+
Athugaðu að jafnvel með dulkóðun viðskiptavinarhliðar virkt, andstæðingur með fullan sýnileika á dulkóðuðu miðlarahliðinni þinni
|
|
367
|
+
geymsla, jafnvel án lykils, getur samt séð heildarfjölda möppum og hversu margar skrár eru í hverri, og með
|
|
368
|
+
smá viðleitni, uppgötva að hluta eða öllu heildarskipulagi möppustigveldisins.
|
|
369
|
+
*Athugið: Notaðu tiltölulega flata uppbyggingu fyrir betra öryggi.*
|
|
370
|
+
Andstæðingurinn myndi ekki vita nöfnin á möppunum/skránum nema þeir vissu líka um dulkóðunina þína
|
|
371
|
+
lykil eða hafði á annan hátt brotið dulkóðunina. Þá eru öll veðmál slökkt!
|
|
372
|
+
|
|
373
|
+
### Afköst og skyndiminni
|
|
374
|
+
Aðgerðir á dulkóðuðu geymslurými geta verið hægar. Endurkvæmar skráningar og fjarlægingar geta verið mjög hægar.
|
|
375
|
+
Skyndiminni í gegnum Redis hjálpar gríðarlega, en athugaðu að skyndiminni er tæmt við skrif eða fjarlægingu.
|
|
376
|
+
|
|
377
|
+
## Snúningur lykla
|
|
378
|
+
Búðu til mobiletto með nýja lyklinum þínum og speglaðu síðan gömlu gögnin inn í hann:
|
|
379
|
+
|
|
380
|
+
const storage = require('mobiletto')
|
|
381
|
+
|
|
382
|
+
const oldEncryption = { key: .... }
|
|
383
|
+
const oldStorage = await storage.connect('s3', aws_key, aws_secret, {bucket: 'bk', region: 'us-east-1'}, oldEncryption)
|
|
384
|
+
|
|
385
|
+
const newEncryption = { key: .... }
|
|
386
|
+
const newStorage = await storage.connect('s3', aws_key, aws_secret, {bucket: 'zz', region: 'us-east-1'}, newEncryption)
|
|
387
|
+
|
|
388
|
+
newStorage.mirror(oldStorage) // if oldStorage is very large, this may take a looooooong time...
|
|
389
|
+
|
|
390
|
+
## Bílstjóri tengi
|
|
391
|
+
Bílstjóri er hvaða JS skrá sem er sem flytur út 'storageClient' aðgerð með þessari undirskrift:
|
|
392
|
+
|
|
393
|
+
function storageClient (key, secret, opts)
|
|
394
|
+
|
|
395
|
+
* `key` : strengur, API lykillinn þinn (fyrir `local` er þetta grunnskráin)
|
|
396
|
+
* `secret` leyndarmál`: strengur, API leyndarmálið þitt (hægt að sleppa fyrir `local` rekla)
|
|
397
|
+
* `opts` : hlutur, eiginleikarnir eru fyrir hvern ökumann:
|
|
398
|
+
* Fyrir `local` `fileMode` og `dirMode` eiginleikar hvernig nýjar skrár og möppur eru búnar til
|
|
399
|
+
* Fyrir `s3` “ er `bucket` eignin nauðsynleg. Valfrjálsir eiginleikar eru:
|
|
400
|
+
* `region`: the S3 region, default is us-east-1
|
|
401
|
+
* `prefix`: a prefix to prepend to all S3 paths, default is the empty string
|
|
402
|
+
* `delimiter`: the directory delimiter, default is '/'
|
|
403
|
+
|
|
404
|
+
Hluturinn sem storageClient aðgerðin skilar verður að skilgreina þessar aðgerðir:
|
|
405
|
+
|
|
406
|
+
// Test the driver before using, ensure proper configuration
|
|
407
|
+
async testConfig ()
|
|
408
|
+
|
|
409
|
+
// List files in path (or from base-directory)
|
|
410
|
+
// If recursive is true, list recursively
|
|
411
|
+
// If visitor is defined, it will be an async function. await the visitor function on each file found
|
|
412
|
+
// Otherwise, perform the listing and return an array of objects
|
|
413
|
+
async list (path, recursive = false, visitor = null) // path may be omitted
|
|
414
|
+
|
|
415
|
+
// Read metadata for a path
|
|
416
|
+
async metadata (path)
|
|
417
|
+
|
|
418
|
+
// Read a file
|
|
419
|
+
// callback receives a chunk of data. endCallback is called at end-of-stream
|
|
420
|
+
async read (path, callback, endCallback = null)
|
|
421
|
+
|
|
422
|
+
// Write a file
|
|
423
|
+
// driver must be able to handle a generator or a stream
|
|
424
|
+
async write (path, generatorOrReadableStream)
|
|
425
|
+
|
|
426
|
+
// Remove a file, or recursively delete a directory
|
|
427
|
+
// returns a string of a single path removed, or an array of multiple paths removed
|
|
428
|
+
async remove (path, recursive = false, quiet = false)
|
|
429
|
+
|
|
430
|
+
## Skráning
|
|
431
|
+
Mobiletto notar [winston](https://www.npmjs.com/package/winston) skráningarsafnið.
|
|
432
|
+
|
|
433
|
+
Dagskrár **mun** innihalda skráarslóðir og villuskilaboð, en munu **aldrei** innihalda lykla, leyndarmál,
|
|
434
|
+
eða aðrar upplýsingar um tengingarstillingar.
|
|
435
|
+
|
|
436
|
+
### Log stig
|
|
437
|
+
Notaðu `MOBILETTO_LOG_LEVEL` umhverfisbreytuna til að stilla logstigið með því að nota eina
|
|
438
|
+
af `npm` sem eru skilgreind í [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
|
|
439
|
+
|
|
440
|
+
Sjálfgefið stig er `error` . `silly` , þó að það sé nú mobiletto
|
|
441
|
+
skráir sig ekki á stigum fyrir neðan `debug`
|
|
442
|
+
|
|
443
|
+
MOBILETTO_LOG_LEVEL=silly # maximum logs!
|
|
444
|
+
|
|
445
|
+
### Notkunarskrá
|
|
446
|
+
Sjálfgefið er að skógarhöggsmaðurinn skrifar á stjórnborðið. Til að senda logs í skrá skaltu stilla `MOBILETTO_LOG_FILE`
|
|
447
|
+
umhverfisbreytu. Þegar þú skráir þig inn í skrá verða annálar ekki lengur skrifaðar á stjórnborðið.
|
|
448
|
+
|
|
449
|
+
MOBILETTO_LOG_FILE=/var/my_mobiletto_log
|
|
450
|
+
|
|
451
|
+
Til að slökkva á skráningu:
|
|
452
|
+
|
|
453
|
+
MOBILETTO_LOG_FILE=/dev/null
|
|
454
|
+
|
|
455
|
+
</pre>
|