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/sl/README.md
DELETED
|
@@ -1,481 +0,0 @@
|
|
|
1
|
-
Mobiletto
|
|
2
|
-
=========
|
|
3
|
-
|
|
4
|
-
Mobiletto je abstraktna plast za shranjevanje JavaScript z izbirnim preglednim šifriranjem na strani odjemalca.
|
|
5
|
-
|
|
6
|
-
# Vsebina
|
|
7
|
-
* [Zakaj Mobiletto?](#Zakaj-Mobiletto?)
|
|
8
|
-
* [Hitri začetek](#Hitri začetek)
|
|
9
|
-
* [Mobiletto CLI](#mobiletto-cli)
|
|
10
|
-
* [Vir](#Vir)
|
|
11
|
-
* [Namestitev](#Namestitev)
|
|
12
|
-
* [Podpora in financiranje](#Podpora-in-financiranje)
|
|
13
|
-
* [Osnovna uporaba](#Basic-usage)
|
|
14
|
-
* [Metapodatki](#Metapodatki)
|
|
15
|
-
* [Nadomestni slog uvoza](#Alternate-import-style)
|
|
16
|
-
* [Caching](#Caching)
|
|
17
|
-
* [Zrcaljenje](#Zrcaljenje)
|
|
18
|
-
* [Prozorno šifriranje](#Transparent-encryption)
|
|
19
|
-
* [Vrtenje tipk](#Vrtenje tipk)
|
|
20
|
-
* [Vmesnik gonilnika](#Vmesnik gonilnika)
|
|
21
|
-
* [Beleženje](#Beleženje)
|
|
22
|
-
|
|
23
|
-
# Preberite to v drugem jeziku
|
|
24
|
-
Ta dokument README.md je bil preveden prek [hokeylization](https://github.com/cobbzilla/hokeylization) v
|
|
25
|
-
**[vsak jezik, ki ga podpira Google Prevajalnik](https://cloud.google.com/translate/docs/languages)!**
|
|
26
|
-
|
|
27
|
-
Prepričan sem, da ni popolno, a upam, da je bolje kot nič!
|
|
28
|
-
|
|
29
|
-
[🇸🇦 arabščina](../ar/README.md)
|
|
30
|
-
[🇧🇩 bengalščina](../bn/README.md)
|
|
31
|
-
[🇩🇪 nemščina](../de/README.md)
|
|
32
|
-
[🇺🇸 angleščina](../en/README.md)
|
|
33
|
-
[🇪🇸 španščina](../es/README.md)
|
|
34
|
-
[🇫🇷 francoščina](../fr/README.md)
|
|
35
|
-
[🇹🇩 Hausa](../ha/README.md)
|
|
36
|
-
[🇮🇳 Hindi](../hi/README.md)
|
|
37
|
-
[🇮🇩 indonezijščina](../id/README.md)
|
|
38
|
-
[🇮🇹 italijanščina](../it/README.md)
|
|
39
|
-
[🇯🇵 japonščina](../ja/README.md)
|
|
40
|
-
[🇰🇷 korejščina](../ko/README.md)
|
|
41
|
-
[🇮🇳 Marathi](../mr/README.md)
|
|
42
|
-
[🇵🇱 poljščina](../pl/README.md)
|
|
43
|
-
[🇧🇷 portugalščina](../pt/README.md)
|
|
44
|
-
[🇷🇺 rusko](../ru/README.md)
|
|
45
|
-
[🇰🇪 svahili](../sw/README.md)
|
|
46
|
-
[🇵🇭 Tagalog](../tl/README.md)
|
|
47
|
-
[🇹🇷 turščina](../tr/README.md)
|
|
48
|
-
[🇵🇰 urdu](../ur/README.md)
|
|
49
|
-
[🇻🇳 vietnamščina](../vi/README.md)
|
|
50
|
-
[🇨🇳 kitajščina](../zh/README.md)
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
**[📚 ... Vsi jeziki ...](../README.md)**
|
|
54
|
-
----
|
|
55
|
-
|
|
56
|
-
### Ali obstaja težava s tem prevodom README?
|
|
57
|
-
Ta poseben prevod izvirnika [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
|
|
58
|
-
je lahko pomanjkljivo -- *popravki so zelo dobrodošli!* Prosimo, pošljite [zahtevo za vlečenje na GitHub](https://github.com/cobbzilla/mobiletto/pulls),
|
|
59
|
-
ali če vam to ni všeč, [odprite težavo](https://github.com/cobbzilla/mobiletto/issues)
|
|
60
|
-
|
|
61
|
-
Ko ustvarite novo težavo GitHub o prevodu, naredite naslednje:
|
|
62
|
-
* vključite URL strani (kopirajte/prilepite iz naslovne vrstice brskalnika)
|
|
63
|
-
* vključi točno besedilo, ki je napačno (kopiraj/prilepi iz brskalnika)
|
|
64
|
-
* Prosimo, opišite, kaj je narobe -- ali je prevod napačen? je formatiranje nekako pokvarjeno?
|
|
65
|
-
* vljudno prosim za predlog boljšega prevoda oziroma kako naj bo besedilo pravilno oblikovano
|
|
66
|
-
* **Hvala vam!**
|
|
67
|
-
|
|
68
|
-
## Zakaj Mobiletto?
|
|
69
|
-
|
|
70
|
-
### Adijo zaklepanje prodajalca!
|
|
71
|
-
Različni ponudniki shranjevanja v oblaku imajo nezdružljive API-je. Tudi tisti, ki si prizadevajo za "združljivost S3"
|
|
72
|
-
imajo idiosinkratično vedenje.
|
|
73
|
-
|
|
74
|
-
Ko izberete določenega prodajalca prostora za shranjevanje za svojo aplikacijo, če kodirate neposredno v njihov API, vašo aplikacijo
|
|
75
|
-
je zdaj odvisen od te storitve. Ko čas mineva in se koda kopiči, pride do menjave prodajalcev
|
|
76
|
-
vse bolj nevzdržno. Dobrodošli v zabavnem svetu zaklenjenosti prodajalca!
|
|
77
|
-
|
|
78
|
-
Mobiletto je bil zasnovan za rešitev tega problema. Če svojo aplikacijo kodirate v API mobiletto, lahko enostavno
|
|
79
|
-
spremenite ponudnike shranjevanja in vedite, da se bo plast shranjevanja vaše aplikacije obnašala enako.
|
|
80
|
-
|
|
81
|
-
### Obsežno testiranje
|
|
82
|
-
Vsi vozniki so preizkušeni glede enakega obnašanja s 60+ testi za vsakega voznika.
|
|
83
|
-
Testiramo vse voznike z vsako kombinacijo:
|
|
84
|
-
* Šifriranje: omogočeno in onemogočeno
|
|
85
|
-
* Predpomnilnik Redis: omogočen in onemogočen
|
|
86
|
-
|
|
87
|
-
S tem pristopom smo prepričani, da se bo mobiletto obnašal enako ne glede na to, kateri gonilnik uporabljate,
|
|
88
|
-
in ne glede na to, ali omogočite predpomnjenje in/ali šifriranje.
|
|
89
|
-
|
|
90
|
-
### Podpora za gonilnike
|
|
91
|
-
Trenutni gonilniki za shranjevanje Mobiletto:
|
|
92
|
-
* `s3` : Amazon S3
|
|
93
|
-
* `b2` : Backblaze B2
|
|
94
|
-
* `local` : lokalni datotečni sistem
|
|
95
|
-
|
|
96
|
-
*Prispevki za podporo več ponudnikov shranjevanja v oblaku so zelo dobrodošli!*
|
|
97
|
-
|
|
98
|
-
## mobiletto-cli
|
|
99
|
-
Mobiletto naj bi ga kot knjižnico uporabljala druga koda JavaScript.
|
|
100
|
-
|
|
101
|
-
Za delo z mobiletto v ukazni vrstici uporabite [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
|
|
102
|
-
|
|
103
|
-
## Vir
|
|
104
|
-
* [mobiletto na GitHubu](https://github.com/cobbzilla/mobiletto)
|
|
105
|
-
* [mobiletto na npm](https://www.npmjs.com/package/mobiletto)
|
|
106
|
-
|
|
107
|
-
## Podpora in financiranje
|
|
108
|
-
Poskušam biti profesionalni razvijalec odprtokodne programske opreme. Delal sem v
|
|
109
|
-
v industriji programske opreme že vrsto let ustanavljam uspešna podjetja in jih prodajam javnim podjetjem.
|
|
110
|
-
Pred kratkim sem izgubil službo in pravzaprav nimam nobenega drugega dela
|
|
111
|
-
|
|
112
|
-
Zato bom poskusil napisati uporabno programsko opremo in preveril, ali deluje
|
|
113
|
-
|
|
114
|
-
Če radi uporabljate to programsko opremo, vam bom zelo hvaležen celo za
|
|
115
|
-
najmanjši [mesečni prispevek prek Patreona](https://www.patreon.com/cobbzilla)
|
|
116
|
-
|
|
117
|
-
*Hvala vam!*
|
|
118
|
-
|
|
119
|
-
## Namestitev
|
|
120
|
-
Namestite z uporabo `npm` ali `yarn` . Verjetno želite `lite` različico, ki ne vključuje vseh
|
|
121
|
-
prevedene datoteke README:
|
|
122
|
-
|
|
123
|
-
npm install mobiletto-lite
|
|
124
|
-
yarn add mobiletto-lite
|
|
125
|
-
|
|
126
|
-
Če res želite datoteke README v vseh jezikih, namestite polno različico:
|
|
127
|
-
|
|
128
|
-
npm install mobiletto
|
|
129
|
-
yarn add mobiletto
|
|
130
|
-
|
|
131
|
-
## Hiter začetek
|
|
132
|
-
Kratek primer uporabe gonilnika mobiletto `s3` .
|
|
133
|
-
|
|
134
|
-
Ta koda bi delovala enako, če bi bil gonilnik `b2` ali `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
|
-
## Osnovna uporaba
|
|
165
|
-
Veliko obširnejši primer, ki prikazuje večino ponujenih funkcij:
|
|
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
|
-
## Metapodatki
|
|
267
|
-
Ukaz `metadata` vrne metapodatke o posameznem vnosu datotečnega sistema.
|
|
268
|
-
Podobno je vrnjena vrednost iz ukaza `list` niz metapodatkovnih objektov.
|
|
269
|
-
|
|
270
|
-
Metapodatkovni objekt je videti takole:
|
|
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
|
-
Lastnost `type` type` je lahko `file` file`, `dir` , `link` ali `special` .
|
|
281
|
-
|
|
282
|
-
Odvisno od vrste gonilnika ukaz `list` morda ne vrne vseh polj. Lastnosti `name` in `type`
|
|
283
|
-
mora biti vedno prisoten. Naslednji ukaz `metadata` bo vrnil vse razpoložljive lastnosti.
|
|
284
|
-
|
|
285
|
-
## Nadomestni slog uvoza
|
|
286
|
-
Uvozite modul s polnim obsegom in uporabite funkcijo `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
|
-
## Predpomnilnik
|
|
294
|
-
Mobiletto najbolje deluje s predpomnilnikom <a href="https://redis.io">redis</a> .
|
|
295
|
-
|
|
296
|
-
Mobiletto se bo poskušal povezati z instanco redis na 127.0.0.1:6379
|
|
297
|
-
|
|
298
|
-
Preglasite lahko eno od teh možnosti:
|
|
299
|
-
* Nastavite spremenljivko env `MOBILETTO_REDIS_HOST` MOBILETTO_REDIS_HOST`, mobile naj se poveže tukaj namesto lokalnega gostitelja
|
|
300
|
-
* Nastavite spremenljivko env `MOBILETTO_REDIS_PORT` , ta vrata bodo uporabljena
|
|
301
|
-
|
|
302
|
-
Mobiletto bo vse svoje ključe redis shranil s predpono `_mobiletto__` . To lahko spremenite
|
|
303
|
-
z nastavitvijo `MOBILETTO_REDIS_PREFIX` env var.
|
|
304
|
-
|
|
305
|
-
Predpomnjenje za vsako povezavo lahko nastavite tudi s predmetom `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
|
-
### Ne želite redis predpomnjenja?
|
|
317
|
-
Če želite onemogočiti: `enabled: false` v svoj objekt `opts.redisConfig` , ko vzpostavite povezavo.
|
|
318
|
-
|
|
319
|
-
Kot je razloženo spodaj, bo onemogočanje predpomnjenja negativno vplivalo na zmogljivost in povzročilo več zahtev
|
|
320
|
-
za shranjevanje, ki ga resnično potrebujete.
|
|
321
|
-
|
|
322
|
-
### Navodila za predpomnjenje
|
|
323
|
-
**Šifrirano shranjevanje**: branje/zapisovanje v šifrirano shranjevanje je le malo počasnejše od običajnega,
|
|
324
|
-
vendar je navigacija po imenikih (kar nekatere stvari počnejo) precej draga. Uporaba predpomnilnika redis
|
|
325
|
-
vam bo znatno povečal učinkovitost.
|
|
326
|
-
|
|
327
|
-
Privzeti predpomnilnik je varen, vendar ne deluje dobro, če imate veliko operacij pisanja/odstranjevanja.
|
|
328
|
-
Vsaka operacija zapisovanja ali odstranjevanja razveljavi celoten predpomnilnik, kar zagotavlja, da bodo naslednja branja videla
|
|
329
|
-
zadnje spremembe.
|
|
330
|
-
|
|
331
|
-
### Orodja CLI
|
|
332
|
-
Če uporabljate orodje CLI, kot je [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
|
|
333
|
-
zagotovo boste želeli omogočiti predpomnilnik `mo` .
|
|
334
|
-
|
|
335
|
-
## Zrcaljenje
|
|
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
|
-
Ukaz `mirror` izvede enkratno kopijo vseh datotek z enega mobilnega telefona na drugega.
|
|
344
|
-
Ne izvaja nobenega postopka za vzdrževanje ogledala skozi čas. Znova zaženite ukaz `mirror`
|
|
345
|
-
za sinhronizacijo morebitnih manjkajočih datotek.
|
|
346
|
-
|
|
347
|
-
Vrednost, vrnjena iz `mirror` , je preprost objekt s števci za število uspešno obdelanih datotek
|
|
348
|
-
zrcaljeno in koliko datotek je imelo napake:
|
|
349
|
-
|
|
350
|
-
{
|
|
351
|
-
success: count-of-files-mirrored,
|
|
352
|
-
errors: count-of-files-with-errors
|
|
353
|
-
}
|
|
354
|
-
|
|
355
|
-
OPOZORILO: Zrcaljenje velikih naborov podatkov je lahko zelo zamudno in zahteva pasovno širino
|
|
356
|
-
|
|
357
|
-
S semantiko klica `mirror` je lahko včasih zmedeno razumeti, kdo je
|
|
358
|
-
bralec in kdo je pisec. Predstavljajte si to kot izjavo o dodelitvi: "levi mobiletto"
|
|
359
|
-
je stvar, ki je dodeljena (zapisani zrcaljeni podatki) in "desni mobiletto" (
|
|
360
|
-
argument metode `mirror` ) je vrednost, ki se dodeli (preberejo se zrcalni podatki).
|
|
361
|
-
|
|
362
|
-
## Transparentno šifriranje
|
|
363
|
-
Omogoči pregledno šifriranje na strani odjemalca:
|
|
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
|
-
Kaj se dogaja? Ločen "vnos imenika" (dirent) imenik (šifriran) spremlja, katere datoteke so v njem
|
|
383
|
-
imenik (ali dirent imenik).
|
|
384
|
-
* Ukaz `list` prebere vnosne datoteke imenika in dešifrira vsako navedeno pot; nato vrne metapodatke za vsako datoteko
|
|
385
|
-
* Ukazi `list` so bolj neučinkoviti, še posebej za imenike z velikim številom datotek
|
|
386
|
-
* Ukaz `write` zapiše dirent datoteke v dirent direktorij vsakega starša, rekurzivno; nato zapiše datoteko
|
|
387
|
-
* Ukazi `write` bodo povzročili O(N) zapisov, pri čemer je N = globina v hierarhiji imenika
|
|
388
|
-
* Ukaz `remove` odstrani ustrezno dirent datoteko in njeno nadrejeno datoteko, če je prazna; nato odstrani datoteko
|
|
389
|
-
* Nerekurzivni ukazi `remove` bodo povzročili O(N) branj in potencialno prav toliko brisov, pri čemer je N = globina v hierarhiji imenika
|
|
390
|
-
* Rekurzivni ukazi `remove` v velikih in globokih datotečnih sistemih so lahko dragi
|
|
391
|
-
|
|
392
|
-
Upoštevajte, da tudi z omogočenim šifriranjem na strani odjemalca nasprotnik s popolnim vpogledom v vašo šifrirano stran strežnika
|
|
393
|
-
shranjevanje lahko tudi brez ključa še vedno vidi skupno število imenikov in koliko datotek je v vsakem ter z
|
|
394
|
-
malo truda, odkrijte del ali celotno celotno strukturo hierarhije imenika.
|
|
395
|
-
*Opomba: za večjo varnost uporabite razmeroma ravno strukturo.*
|
|
396
|
-
Nasprotnik ne bi poznal imen imenikov/datotek, razen če bi poznal tudi vaše šifriranje
|
|
397
|
-
ključ ali kako drugače uspešno razbil šifriranje. Potem so vse stave izključene!
|
|
398
|
-
|
|
399
|
-
### Zmogljivost in predpomnjenje
|
|
400
|
-
Operacije v šifriranem pomnilniku so lahko počasne. Rekurzivni seznami in odstranitve so lahko zelo počasni.
|
|
401
|
-
Predpomnjenje prek redisa izjemno pomaga, vendar upoštevajte, da se predpomnilnik izprazni ob kakršnem koli zapisovanju ali odstranjevanju.
|
|
402
|
-
|
|
403
|
-
## Vrtenje ključev
|
|
404
|
-
Ustvarite mobiletto s svojim novim ključem, nato pa vanj zrcaljite stare podatke:
|
|
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
|
-
## Vmesnik gonilnika
|
|
417
|
-
Gonilnik je katera koli datoteka JS, ki izvozi funkcijo 'storageClient' s tem podpisom:
|
|
418
|
-
|
|
419
|
-
function storageClient (key, secret, opts)
|
|
420
|
-
|
|
421
|
-
* `key` : niz, vaš API ključ (za `local` gonilnik je to osnovni imenik)
|
|
422
|
-
* `secret` : niz, vaša skrivnost API-ja (lahko jo izpustite za `local` gonilnik)
|
|
423
|
-
* `opts` : objekt, lastnosti so za vsak gonilnik:
|
|
424
|
-
* Za `local` local` lastnosti `fileMode` in `dirMode` določata, kako se ustvarjajo nove datoteke in imeniki
|
|
425
|
-
* Za `s3` je zahtevana lastnost `bucket` . Izbirne lastnosti so:
|
|
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, ki ga vrne funkcija storageClient, mora definirati te funkcije:
|
|
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
|
-
## Beleženje
|
|
457
|
-
Mobiletto uporablja knjižnico za beleženje [winston](https://www.npmjs.com/package/winston).
|
|
458
|
-
|
|
459
|
-
Dnevniki **bodo** vsebovali poti datotek in sporočila o napakah, vendar **nikoli** ne bodo vsebovali ključev, skrivnosti,
|
|
460
|
-
ali katere koli druge informacije o konfiguraciji povezave.
|
|
461
|
-
|
|
462
|
-
### Nivo dnevnika
|
|
463
|
-
Uporabite spremenljivko okolja `MOBILETTO_LOG_LEVEL` , da nastavite raven dnevnika z eno
|
|
464
|
-
ravni `npm` , opredeljenih v [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
|
|
465
|
-
|
|
466
|
-
Privzeta raven je `error` . Najbolj podrobna raven je `silly` , čeprav trenutno mobiletto
|
|
467
|
-
se ne beleži na ravneh pod `debug`
|
|
468
|
-
|
|
469
|
-
MOBILETTO_LOG_LEVEL=silly # maximum logs!
|
|
470
|
-
|
|
471
|
-
### Dnevniška datoteka
|
|
472
|
-
Privzeto beležnik piše v konzolo. Za pošiljanje dnevnikov v datoteko nastavite `MOBILETTO_LOG_FILE`
|
|
473
|
-
spremenljivka okolja. Ko se prijavite v datoteko, se dnevniki ne bodo več zapisovali v konzolo.
|
|
474
|
-
|
|
475
|
-
MOBILETTO_LOG_FILE=/var/my_mobiletto_log
|
|
476
|
-
|
|
477
|
-
Za izklop beleženja:
|
|
478
|
-
|
|
479
|
-
MOBILETTO_LOG_FILE=/dev/null
|
|
480
|
-
|
|
481
|
-
</pre>
|