mobiletto 1.1.10 → 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 +48 -0
- 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 +7 -2
- package/package.json +1 -1
- package/test/api.spec.js +12 -9
- package/util/redis.js +1 -1
|
@@ -0,0 +1,455 @@
|
|
|
1
|
+
Mobiletto
|
|
2
|
+
=========
|
|
3
|
+
|
|
4
|
+
Mobiletto je vrstva abstrakcie úložiska JavaScript s voliteľným transparentným šifrovaním na strane klienta.
|
|
5
|
+
|
|
6
|
+
# Obsah
|
|
7
|
+
* [Prečo Mobiletto?](#Prečo-Mobiletto?)
|
|
8
|
+
* [Rýchly štart](#Rýchly štart)
|
|
9
|
+
* [Mobiletto CLI](#mobiletto-cli)
|
|
10
|
+
* [Source](#Source)
|
|
11
|
+
* [Základné použitie](#Basic-usage)
|
|
12
|
+
* [Metadáta](#Metadáta)
|
|
13
|
+
* [Alternatívny štýl importu](#Alternate-import-style)
|
|
14
|
+
* [Caching](#Caching)
|
|
15
|
+
* [Mirroring](#Mirroring)
|
|
16
|
+
* [Transparentné šifrovanie](#Transparentné šifrovanie)
|
|
17
|
+
* [Otočenie kľúča](#Otočenie kľúča)
|
|
18
|
+
* [Rozhranie ovládača](#Rozhranie ovládača)
|
|
19
|
+
* [Logging](#Logging)
|
|
20
|
+
|
|
21
|
+
# Prečítajte si to v inom jazyku
|
|
22
|
+
Tento dokument README.md bol preložený prostredníctvom [hokeylizácie](https://github.com/cobbzilla/hokeylization) do
|
|
23
|
+
**[každý jazyk podporovaný Prekladačom Google](https://cloud.google.com/translate/docs/languages)!**
|
|
24
|
+
|
|
25
|
+
Som si istý, že to nie je dokonalé, ale dúfam, že je to lepšie ako nič!
|
|
26
|
+
|
|
27
|
+
[🇸🇦 arabčina](../ar/README.md)
|
|
28
|
+
[🇧🇩 bengálčina](../bn/README.md)
|
|
29
|
+
[🇩🇪 nemčina](../de/README.md)
|
|
30
|
+
[🇺🇸 angličtina](../en/README.md)
|
|
31
|
+
[🇪🇸 španielčina](../es/README.md)
|
|
32
|
+
[🇫🇷 francúzština](../fr/README.md)
|
|
33
|
+
[🇹🇩 Hausa](../ha/README.md)
|
|
34
|
+
[🇮🇳 hindčina](../hi/README.md)
|
|
35
|
+
[🇮🇩 indonézština](../id/README.md)
|
|
36
|
+
[🇮🇹 taliančina](../it/README.md)
|
|
37
|
+
[🇯🇵 japončina](../ja/README.md)
|
|
38
|
+
[🇰🇷 kórejčina](../ko/README.md)
|
|
39
|
+
[🇮🇳 Maranthi](../mr/README.md)
|
|
40
|
+
[🇵🇱 poľština](../pl/README.md)
|
|
41
|
+
[🇧🇷 portugalčina](../pt/README.md)
|
|
42
|
+
[🇷🇺 ruština](../ru/README.md)
|
|
43
|
+
[🇰🇪 svahilčina](../sw/README.md)
|
|
44
|
+
[🇵🇭 tagalčina](../tl/README.md)
|
|
45
|
+
[🇹🇷 turečtina](../tr/README.md)
|
|
46
|
+
[🇵🇰 urdčina](../ur/README.md)
|
|
47
|
+
[🇻🇳 vietnamčina](../vi/README.md)
|
|
48
|
+
[🇨🇳 čínština](../zh/README.md)
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
**[📚 ... Všetky jazyky ...](../README.md)**
|
|
52
|
+
----
|
|
53
|
+
|
|
54
|
+
### Vyskytol sa problém s týmto prekladom súboru README?
|
|
55
|
+
Tento konkrétny preklad originálu [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
|
|
56
|
+
môže byť chybný -- *opravy sú veľmi vítané!* Pošlite [žiadosť o stiahnutie na GitHub](https://github.com/cobbzilla/mobiletto/pulls),
|
|
57
|
+
alebo ak sa vám to nepáči, [otvorte problém](https://github.com/cobbzilla/mobiletto/issues)
|
|
58
|
+
|
|
59
|
+
Keď vytvoríte nový problém na GitHub o preklade, postupujte takto:
|
|
60
|
+
* uveďte adresu URL stránky (skopírujte/prilepte z panela s adresou prehliadača)
|
|
61
|
+
* uveďte presný text, ktorý je nesprávny (skopírujte/prilepte z prehliadača)
|
|
62
|
+
* popíšte, čo je nesprávne - je preklad nesprávny? je formátovanie nejako porušené?
|
|
63
|
+
* láskavo ponúknite návrh na lepší preklad alebo ako by mal byť text správne naformátovaný
|
|
64
|
+
* **Ďakujem!**
|
|
65
|
+
|
|
66
|
+
## Prečo Mobiletto?
|
|
67
|
+
|
|
68
|
+
### Zbohom vendor lock-in!
|
|
69
|
+
Rôzni poskytovatelia cloudových úložísk majú nekompatibilné rozhrania API. Dokonca aj tí, ktorí sa snažia o „kompatibilitu S3“
|
|
70
|
+
majú idiosynkratické správanie.
|
|
71
|
+
|
|
72
|
+
Keď si vyberiete konkrétneho dodávateľa úložiska pre svoju aplikáciu, ak kódujete priamo do ich API, vaša aplikácia
|
|
73
|
+
je teraz závislý od tejto služby. Ako plynie čas a kód sa hromadí, menia sa predajcovia
|
|
74
|
+
čoraz neudržateľnejšie. Vitajte v zábavnom svete blokovania predajcov!
|
|
75
|
+
|
|
76
|
+
Mobiletto bol navrhnutý na vyriešenie tohto problému. Zakódovaním vašej aplikácie do API mobiletto to môžete ľahko
|
|
77
|
+
zmeniť poskytovateľa úložiska a vedieť, že vrstva úložiska vašej aplikácie sa bude správať rovnako.
|
|
78
|
+
|
|
79
|
+
### Rozsiahle testovanie
|
|
80
|
+
Všetci vodiči sú testovaní na rovnaké správanie pomocou 60+ testov pre každého vodiča.
|
|
81
|
+
Testujeme všetky ovládače s každou kombináciou:
|
|
82
|
+
* Šifrovanie: povolené aj zakázané
|
|
83
|
+
* Vyrovnávacia pamäť Redis: povolená aj zakázaná
|
|
84
|
+
|
|
85
|
+
Tento prístup nám dáva istotu, že mobiletto sa bude správať rovnako bez ohľadu na to, aký ovládač používate,
|
|
86
|
+
a bez ohľadu na to, či povolíte ukladanie do vyrovnávacej pamäte a/alebo šifrovanie.
|
|
87
|
+
|
|
88
|
+
### Podpora ovládačov
|
|
89
|
+
Aktuálne ovládače úložiska Mobiletto:
|
|
90
|
+
* `s3` : Amazon S3
|
|
91
|
+
* `b2` : Backblaze B2
|
|
92
|
+
* `local` : lokálny súborový systém
|
|
93
|
+
|
|
94
|
+
*Príspevky na podporu viacerých poskytovateľov cloudových úložísk sú veľmi vítané!*
|
|
95
|
+
|
|
96
|
+
## mobiletto-cli
|
|
97
|
+
Mobiletto je určené na použitie ako knižnica iným kódom JavaScript.
|
|
98
|
+
|
|
99
|
+
Ak chcete pracovať s mobiletto na príkazovom riadku, použite [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
|
|
100
|
+
|
|
101
|
+
## Zdroj
|
|
102
|
+
* [mobiletto na GitHub](https://github.com/cobbzilla/mobiletto)
|
|
103
|
+
* [mobiletto na npm](https://www.npmjs.com/package/mobiletto)
|
|
104
|
+
|
|
105
|
+
## Rýchly štart
|
|
106
|
+
Krátky príklad použitia ovládača mobiletto `s3` .
|
|
107
|
+
|
|
108
|
+
Tento kód by fungoval rovnako, ak by bol ovládač `b2` alebo `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
|
+
## Základné použitie
|
|
139
|
+
Oveľa rozsiahlejší príklad zobrazujúci väčšinu ponúkaných funkcií:
|
|
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
|
+
## Metadáta
|
|
241
|
+
Príkaz `metadata` vracia metadáta o jednej položke súborového systému.
|
|
242
|
+
Podobne návratová hodnota z príkazu `list` je pole objektov metadát.
|
|
243
|
+
|
|
244
|
+
Objekt metadát vyzerá takto:
|
|
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
|
+
Vlastnosť `type` type“ môže byť `file` “, `dir` “, `link` alebo `special` .
|
|
255
|
+
|
|
256
|
+
V závislosti od typu ovládača nemusí príkaz `list` vrátiť všetky polia. Vlastnosti `name` a `type` .
|
|
257
|
+
by mal byť vždy prítomný. Nasledujúci príkaz `metadata` vráti všetky dostupné vlastnosti.
|
|
258
|
+
|
|
259
|
+
## Alternatívny štýl importu
|
|
260
|
+
Importujte modul s úplným rozsahom a použite funkciu `connect` :
|
|
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
|
+
## Ukladanie do vyrovnávacej pamäte
|
|
268
|
+
Mobiletto funguje najlepšie s vyrovnávacou pamäťou <a href="https://redis.io">redis</a> .
|
|
269
|
+
|
|
270
|
+
Mobiletto sa pokúsi pripojiť k inštancii redis na 127.0.0.1:6379
|
|
271
|
+
|
|
272
|
+
Môžete prepísať jednu z týchto možností:
|
|
273
|
+
* Nastavte env var, mobilet `MOBILETTO_REDIS_HOST` , aby ste sa pripojili sem namiesto localhost
|
|
274
|
+
* Nastavte env var `MOBILETTO_REDIS_PORT` , tento port sa použije
|
|
275
|
+
|
|
276
|
+
Mobiletto uloží všetky svoje redis kľúče s predponou `_mobiletto__` . Môžete to zmeniť
|
|
277
|
+
nastavením premennej env `MOBILETTO_REDIS_PREFIX`
|
|
278
|
+
|
|
279
|
+
Môžete tiež nastaviť ukladanie do vyrovnávacej pamäte pre jednotlivé pripojenia pomocou objektu `opts.redisConfig` :
|
|
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
|
+
### Nechcete znovu ukladať do vyrovnávacej pamäte?
|
|
291
|
+
Ak chcete zakázať: pri vytváraní pripojenia odovzdajte `enabled: false` v objekte `opts.redisConfig` .
|
|
292
|
+
|
|
293
|
+
Ako je uvedené nižšie, zakázanie ukladania do vyrovnávacej pamäte bude mať nepriaznivý vplyv na výkon a spôsobí viac požiadaviek
|
|
294
|
+
do úložiska, ktoré skutočne potrebujete.
|
|
295
|
+
|
|
296
|
+
### Pokyny pre ukladanie do vyrovnávacej pamäte
|
|
297
|
+
**Šifrované úložisko**: čítanie/zápis šifrovaného úložiska je len o niečo pomalšie ako normálne,
|
|
298
|
+
ale navigácia v adresároch (čo niektoré veci robia) je pomerne drahá. Použitie vyrovnávacej pamäte redis
|
|
299
|
+
vám poskytne výrazné zvýšenie výkonu.
|
|
300
|
+
|
|
301
|
+
Predvolená vyrovnávacia pamäť je bezpečná, ale nefunguje dobre, ak máte veľa operácií zápisu/odstránenia.
|
|
302
|
+
Akákoľvek operácia zápisu alebo odstránenia znehodnotí celú vyrovnávaciu pamäť, čím sa zabezpečí, že nasledujúce čítania uvidia súbor
|
|
303
|
+
najnovšie zmeny.
|
|
304
|
+
|
|
305
|
+
### Nástroje CLI
|
|
306
|
+
Ak používate nástroj CLI ako [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
|
|
307
|
+
určite budete chcieť povoliť vyrovnávaciu pamäť redis, pretože trvá pri vyvolaní príkazu `mo` .
|
|
308
|
+
|
|
309
|
+
## Zrkadlenie
|
|
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
|
+
Príkaz `mirror` vykoná jednorazovú kópiu všetkých súborov z jedného mobiletto do druhého.
|
|
318
|
+
Nespúšťa žiadny proces na udržiavanie zrkadla v priebehu času. Znova spustite príkaz `mirror`
|
|
319
|
+
na synchronizáciu chýbajúcich súborov.
|
|
320
|
+
|
|
321
|
+
Návratová hodnota z `mirror` je jednoduchý objekt s počítadlami, koľko súborov bolo úspešne dokončených
|
|
322
|
+
zrkadlené a koľko súborov malo chyby:
|
|
323
|
+
|
|
324
|
+
{
|
|
325
|
+
success: count-of-files-mirrored,
|
|
326
|
+
errors: count-of-files-with-errors
|
|
327
|
+
}
|
|
328
|
+
|
|
329
|
+
VAROVANIE: Zrkadlenie veľkých súborov údajov môže byť veľmi časovo náročné a náročné na šírku pásma
|
|
330
|
+
|
|
331
|
+
So sémantikou volania `mirror` môže byť niekedy mätúce pochopiť, kto je
|
|
332
|
+
čitateľ a kto je spisovateľ. Predstavte si to ako príkaz na zadanie: „mobiltto na ľavej strane“
|
|
333
|
+
je vec, ku ktorej sa priraďuje (zapísané zrkadlené dáta) a „pravé mobilné tto“ (
|
|
334
|
+
argument k metóde `mirror` ) je priradená hodnota (čítajú sa zrkadlové dáta).
|
|
335
|
+
|
|
336
|
+
## Transparentné šifrovanie
|
|
337
|
+
Povoliť transparentné šifrovanie na strane klienta:
|
|
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
|
+
Čo sa deje? Samostatný (zašifrovaný) adresár „položka adresára“ (zašifrovaný) sleduje, aké súbory sa v ňom nachádzajú
|
|
357
|
+
adresár (známy ako priamy adresár).
|
|
358
|
+
* Príkaz `list` prečíta vstupné súbory adresára, dešifruje každú uvedenú cestu; potom vráti metadáta pre každý súbor
|
|
359
|
+
* Príkazy `list` sú neefektívnejšie, najmä pre adresáre s veľkým počtom súborov
|
|
360
|
+
* Príkaz `write` zapisuje dirent súbory do adresára dirent každého rodiča rekurzívne; potom zapíše súbor
|
|
361
|
+
* Príkazy `write` budú mať za následok O(N) zápisov, pričom N = hĺbka v hierarchii adresárov
|
|
362
|
+
* Príkaz `remove` odstráni zodpovedajúci dirent súbor a jeho rodič, ak je prázdny; potom súbor odstráni
|
|
363
|
+
* `remove` budú mať za následok O(N) čítaní a potenciálne toľko vymazaní, pričom N = hĺbka v hierarchii adresárov
|
|
364
|
+
* Rekurzívne príkazy `remove` na veľkých a hlbokých súborových systémoch môžu byť drahé
|
|
365
|
+
|
|
366
|
+
Všimnite si, že aj keď je zapnuté šifrovanie na strane klienta, protivník s plnou viditeľnosťou na vašej zašifrovanej strane servera
|
|
367
|
+
úložisko, dokonca aj bez kľúča, stále vidí celkový počet adresárov a koľko súborov je v každom a s
|
|
368
|
+
nejaké úsilie, objaviť časť alebo celú celkovú štruktúru hierarchie adresárov.
|
|
369
|
+
*Poznámka: Pre lepšiu bezpečnosť použite relatívne plochú štruktúru.*
|
|
370
|
+
Protivník by nevedel názvy adresárov/súborov, pokiaľ by nepoznal aj vaše šifrovanie
|
|
371
|
+
kľúč alebo inak úspešne prelomil šifrovanie. Potom sú všetky stávky vypnuté!
|
|
372
|
+
|
|
373
|
+
### Výkon a ukladanie do vyrovnávacej pamäte
|
|
374
|
+
Operácie na šifrovanom úložisku môžu byť pomalé. Rekurzívne zoznamy a odstraňovania môžu byť veľmi pomalé.
|
|
375
|
+
Ukladanie do vyrovnávacej pamäte cez redis nesmierne pomáha, ale nezabudnite, že vyrovnávacia pamäť sa vyprázdni pri každom zápise alebo odstránení.
|
|
376
|
+
|
|
377
|
+
## Rotácia kľúča
|
|
378
|
+
Vytvorte mobiletto s vaším novým kľúčom a potom doň zrkadlite staré údaje:
|
|
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
|
+
## Rozhranie ovládača
|
|
391
|
+
Ovládač je akýkoľvek súbor JS, ktorý exportuje funkciu „storageClient“ s týmto podpisom:
|
|
392
|
+
|
|
393
|
+
function storageClient (key, secret, opts)
|
|
394
|
+
|
|
395
|
+
* `key` : reťazec, váš kľúč API (pre `local` ovládač je to základný adresár)
|
|
396
|
+
* `secret` : reťazec, vaše tajomstvo API (môže byť vynechané pre `local` ovládač)
|
|
397
|
+
* `opts` : objekt, vlastnosti sú pre ovládač:
|
|
398
|
+
* Pre `local` , vlastnosti `fileMode` a `dirMode` určujú, ako sa vytvárajú nové súbory a adresáre
|
|
399
|
+
* Pre `s3` sa vyžaduje vlastnosť `bucket` . Voliteľné vlastnosti sú:
|
|
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
|
+
Objekt, ktorý funkcia storageClient vracia, musí definovať tieto funkcie:
|
|
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
|
+
## Prihlásenie
|
|
431
|
+
Mobiletto používa protokolovaciu knižnicu [winston](https://www.npmjs.com/package/winston).
|
|
432
|
+
|
|
433
|
+
Protokoly **budú** obsahovať cesty k súborom a chybové hlásenia, ale **nikdy** nebudú obsahovať kľúče, tajomstvá,
|
|
434
|
+
alebo akékoľvek iné informácie o konfigurácii pripojenia.
|
|
435
|
+
|
|
436
|
+
### Úroveň denníka
|
|
437
|
+
Na nastavenie úrovne denníka použite premennú prostredia `MOBILETTO_LOG_LEVEL`
|
|
438
|
+
z úrovní `npm` definovaných v [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
|
|
439
|
+
|
|
440
|
+
Predvolená úroveň je `error` . Najpodrobnejšia úroveň je `silly` , aj keď momentálne mobiletto
|
|
441
|
+
neprihlási na úrovniach pod `debug`
|
|
442
|
+
|
|
443
|
+
MOBILETTO_LOG_LEVEL=silly # maximum logs!
|
|
444
|
+
|
|
445
|
+
### Súbor denníka
|
|
446
|
+
V predvolenom nastavení zapisovač zapisuje do konzoly. Ak chcete odoslať protokoly do súboru, nastavte `MOBILETTO_LOG_FILE`
|
|
447
|
+
premenná prostredia. Pri prihlasovaní do súboru sa protokoly už nebudú zapisovať do konzoly.
|
|
448
|
+
|
|
449
|
+
MOBILETTO_LOG_FILE=/var/my_mobiletto_log
|
|
450
|
+
|
|
451
|
+
Ak chcete vypnúť protokolovanie:
|
|
452
|
+
|
|
453
|
+
MOBILETTO_LOG_FILE=/dev/null
|
|
454
|
+
|
|
455
|
+
</pre>
|