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/bs/README.md
DELETED
|
@@ -1,481 +0,0 @@
|
|
|
1
|
-
Mobiletto
|
|
2
|
-
=========
|
|
3
|
-
|
|
4
|
-
Mobiletto je sloj apstrakcije za JavaScript skladištenje, sa opcionim transparentnim šifrovanjem na strani klijenta.
|
|
5
|
-
|
|
6
|
-
# Sadržaj
|
|
7
|
-
* [Zašto Mobiletto?](#Zašto-Mobiletto?)
|
|
8
|
-
* [Brzi početak](#Brzi početak)
|
|
9
|
-
* [Mobiletto CLI](#mobiletto-cli)
|
|
10
|
-
* [Izvor](#Izvor)
|
|
11
|
-
* [Instalacija](#Instalacija)
|
|
12
|
-
* [Podrška i finansiranje](#Support-and-Funding)
|
|
13
|
-
* [Osnovna upotreba](#Basic-usage)
|
|
14
|
-
* [Metapodaci](#Metapodaci)
|
|
15
|
-
* [Alternativni stil uvoza](#Alternate-import-style)
|
|
16
|
-
* [Caching](#Caching)
|
|
17
|
-
* [Mirroring](#Mirroring)
|
|
18
|
-
* [Transparentno šifriranje](#Transparent-encryption)
|
|
19
|
-
* [Rotacija tipke](#Rotacija tipke)
|
|
20
|
-
* [Driver interface](#Driver-interface)
|
|
21
|
-
* [Logging](#Logging)
|
|
22
|
-
|
|
23
|
-
# Pročitajte ovo na drugom jeziku
|
|
24
|
-
Ovaj README.md dokument je preveden, putem [hokeylization](https://github.com/cobbzilla/hokeylization), na
|
|
25
|
-
**[svaki jezik podržan od strane Google prevodioca](https://cloud.google.com/translate/docs/languages)!**
|
|
26
|
-
|
|
27
|
-
Siguran sam da nije savršeno, ali nadam se da je bolje nego ništa!
|
|
28
|
-
|
|
29
|
-
[🇸🇦 arapski](../ar/README.md)
|
|
30
|
-
[🇧🇩 bengalski](../bn/README.md)
|
|
31
|
-
[🇩🇪 njemački](../de/README.md)
|
|
32
|
-
[🇺🇸 engleski](../en/README.md)
|
|
33
|
-
[🇪🇸 španski](../es/README.md)
|
|
34
|
-
[🇫🇷 francuski](../fr/README.md)
|
|
35
|
-
[🇹🇩 Hausa](../ha/README.md)
|
|
36
|
-
[🇮🇳 hindi](../hi/README.md)
|
|
37
|
-
[🇮🇩 indonezijski](../id/README.md)
|
|
38
|
-
[🇮🇹 talijanski](../it/README.md)
|
|
39
|
-
[🇯🇵 japanski](../ja/README.md)
|
|
40
|
-
[🇰🇷 korejski](../ko/README.md)
|
|
41
|
-
[🇮🇳 Marathi](../mr/README.md)
|
|
42
|
-
[🇵🇱 poljski](../pl/README.md)
|
|
43
|
-
[🇧🇷 portugalski](../pt/README.md)
|
|
44
|
-
[🇷🇺 ruski](../ru/README.md)
|
|
45
|
-
[🇰🇪 svahili](../sw/README.md)
|
|
46
|
-
[🇵🇭 Tagalog](../tl/README.md)
|
|
47
|
-
[🇹🇷 turski](../tr/README.md)
|
|
48
|
-
[🇵🇰 urdu](../ur/README.md)
|
|
49
|
-
[🇻🇳 vijetnamski](../vi/README.md)
|
|
50
|
-
[🇨🇳 kineski](../zh/README.md)
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
**[📚 ... Svi jezici ...](../README.md)**
|
|
54
|
-
----
|
|
55
|
-
|
|
56
|
-
### Postoji li problem sa ovim prijevodom README-a?
|
|
57
|
-
Ovaj konkretni prijevod originalnog [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
|
|
58
|
-
može biti manjkav -- *ispravke su dobrodošle!* Molimo pošaljite [zahtjev za povlačenje na GitHub](https://github.com/cobbzilla/mobiletto/pulls),
|
|
59
|
-
ili ako vam to nije ugodno, [otvorite problem](https://github.com/cobbzilla/mobiletto/issues)
|
|
60
|
-
|
|
61
|
-
Kada kreirate novi GitHub problem o prijevodu, učinite:
|
|
62
|
-
* uključite URL stranice (kopirajte/zalijepite iz adresne trake pretraživača)
|
|
63
|
-
* uključite tačan tekst koji je pogrešan (kopirajte/zalijepite iz pretraživača)
|
|
64
|
-
* opišite šta nije u redu -- da li je prevod netačan? da li je formatiranje nekako pokvareno?
|
|
65
|
-
* ljubazno ponudite prijedlog boljeg prijevoda, odnosno kako bi tekst trebao biti pravilno formatiran
|
|
66
|
-
* **Hvala ti!**
|
|
67
|
-
|
|
68
|
-
## Zašto Mobiletto?
|
|
69
|
-
|
|
70
|
-
### Zbogom zaključavanje dobavljača!
|
|
71
|
-
Različiti dobavljači pohrane u oblaku imaju nekompatibilne API-je. Čak i oni koji teže "S3 kompatibilnosti"
|
|
72
|
-
imaju idiosinkratična ponašanja.
|
|
73
|
-
|
|
74
|
-
Kada odaberete određenog dobavljača pohrane za svoju aplikaciju, ako kodirate direktno na njihov API, svoju aplikaciju
|
|
75
|
-
sada zavisi od te usluge. Kako vrijeme prolazi i kod se akumulira, mijenjaju se dobavljači
|
|
76
|
-
sve neodrživiji. Dobrodošli u zabavni svijet zaključavanja dobavljača!
|
|
77
|
-
|
|
78
|
-
Mobiletto je dizajniran da riješi ovaj problem. Kodiranjem vaše aplikacije na mobiletto API, možete jednostavno
|
|
79
|
-
promijenite dobavljače pohrane i znajte da će se sloj pohrane vaše aplikacije ponašati identično.
|
|
80
|
-
|
|
81
|
-
### Opsežno testiranje
|
|
82
|
-
Svi vozači su testirani na identično ponašanje sa 60+ testova za svakog vozača.
|
|
83
|
-
Testiramo sve vozače sa svakom kombinacijom:
|
|
84
|
-
* Šifriranje: omogućeno i onemogućeno
|
|
85
|
-
* Redis keš memorija: omogućeno i onemogućeno
|
|
86
|
-
|
|
87
|
-
Ovaj pristup nam daje bezbrižnost da će se mobiletto ponašati isto bez obzira koji drajver koristite,
|
|
88
|
-
i bez obzira da li ste omogućili keširanje i/ili enkripciju.
|
|
89
|
-
|
|
90
|
-
### Podrška za vozače
|
|
91
|
-
Trenutni Mobiletto drajveri za pohranu:
|
|
92
|
-
* `s3` : Amazon S3
|
|
93
|
-
* `b2` : Backblaze B2
|
|
94
|
-
* `local` : lokalni sistem datoteka
|
|
95
|
-
|
|
96
|
-
*Doprinosi za podršku većem broju provajdera za pohranu u oblaku su dobrodošli!*
|
|
97
|
-
|
|
98
|
-
## mobiletto-cli
|
|
99
|
-
Mobiletto je namijenjen da se koristi kao biblioteka drugim JavaScript kodom.
|
|
100
|
-
|
|
101
|
-
Za rad sa mobiletto na komandnoj liniji, koristite [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
|
|
102
|
-
|
|
103
|
-
## Izvor
|
|
104
|
-
* [mobiletto na GitHubu](https://github.com/cobbzilla/mobiletto)
|
|
105
|
-
* [mobiletto na npm](https://www.npmjs.com/package/mobiletto)
|
|
106
|
-
|
|
107
|
-
## Podrška i finansiranje
|
|
108
|
-
Pokušavam biti profesionalni programer otvorenog koda. Ja sam radio u
|
|
109
|
-
softverskoj industriji dugi niz godina, pokrenuo sam uspješne kompanije i prodao ih javnim preduzećima.
|
|
110
|
-
Nedavno sam izgubio posao i nemam nikakav drugi posao u redu
|
|
111
|
-
|
|
112
|
-
Zato ću pokušati da napišem koristan softver i da vidim da li radi
|
|
113
|
-
|
|
114
|
-
Ako uživate u korištenju ovog softvera, bio bih vam vrlo zahvalan čak i za
|
|
115
|
-
najmanji [mjesečni doprinos putem Patreona](https://www.patreon.com/cobbzilla)
|
|
116
|
-
|
|
117
|
-
*Hvala ti!*
|
|
118
|
-
|
|
119
|
-
## Instalacija
|
|
120
|
-
Instalirajte koristeći `npm` ili `yarn` . Vjerovatno želite `lite` verziju koja ne uključuje sve
|
|
121
|
-
prevedeni README fajlovi:
|
|
122
|
-
|
|
123
|
-
npm install mobiletto-lite
|
|
124
|
-
yarn add mobiletto-lite
|
|
125
|
-
|
|
126
|
-
Ako zaista želite README datoteke na svim jezicima, instalirajte punu verziju:
|
|
127
|
-
|
|
128
|
-
npm install mobiletto
|
|
129
|
-
yarn add mobiletto
|
|
130
|
-
|
|
131
|
-
## Brzi početak
|
|
132
|
-
Kratak primjer korištenja drajvera mobiletto `s3` .
|
|
133
|
-
|
|
134
|
-
Ovaj kod bi radio isto da je drajver `b2` ili `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 upotreba
|
|
165
|
-
Mnogo opsežniji primjer, koji pokazuje većinu ponuđenih funkcija:
|
|
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
|
-
## Metapodaci
|
|
267
|
-
Komanda `metadata` vraća metapodatke o jednom unosu sistema datoteka.
|
|
268
|
-
Isto tako, povratna vrijednost iz naredbe `list` je niz metapodataka objekata.
|
|
269
|
-
|
|
270
|
-
Objekt metapodataka izgleda ovako:
|
|
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
|
-
Svojstvo `type` može biti `file` , `dir` , `link` ili `special` .
|
|
281
|
-
|
|
282
|
-
U zavisnosti od tipa drajvera, komanda `list` možda neće vratiti sva polja. `name` i `type`
|
|
283
|
-
treba uvek biti prisutan. Naredna naredba `metadata` će vratiti sva dostupna svojstva.
|
|
284
|
-
|
|
285
|
-
## Alternativni stil uvoza
|
|
286
|
-
Uvezite modul potpunog opsega i koristite funkciju `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
|
-
## Keširanje
|
|
294
|
-
Mobiletto najbolje radi sa <a href="https://redis.io">redis</a> keš memorijom.
|
|
295
|
-
|
|
296
|
-
Mobiletto će pokušati da se poveže na redis instancu na 127.0.0.1:6379
|
|
297
|
-
|
|
298
|
-
Možete nadjačati bilo koje od ovih:
|
|
299
|
-
* Postavite `MOBILETTO_REDIS_HOST` env var, mobiletto da se povežete ovdje umjesto lokalnog hosta
|
|
300
|
-
* Postavite env var `MOBILETTO_REDIS_PORT` , ovaj port će se koristiti
|
|
301
|
-
|
|
302
|
-
Mobiletto će pohraniti sve svoje redis ključeve s prefiksom `_mobiletto__` . Možete promijeniti ovo
|
|
303
|
-
postavljanjem `MOBILETTO_REDIS_PREFIX` env var.
|
|
304
|
-
|
|
305
|
-
Također možete postaviti keširanje po konekciji s objektom `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 keširanje?
|
|
317
|
-
Da biste onemogućili: proslijedite `enabled: false` u svoj objekt `opts.redisConfig` kada uspostavite svoju vezu.
|
|
318
|
-
|
|
319
|
-
Kao što je objašnjeno u nastavku, onemogućavanje keširanja će imati negativan učinak na performanse i izazvati više zahtjeva
|
|
320
|
-
do skladišta koje vam je zaista potrebno.
|
|
321
|
-
|
|
322
|
-
### Smjernice za keširanje
|
|
323
|
-
**Šifrovana pohrana**: čitanje/pisanje šifrovane memorije je samo malo sporije od uobičajenog,
|
|
324
|
-
ali navigacija po direktorijima (što neke stvari rade) je prilično skupa. Korištenje redis keša
|
|
325
|
-
će vam dati značajno povećanje performansi.
|
|
326
|
-
|
|
327
|
-
Zadana keš memorija je sigurna, ali ne radi dobro ako imate puno operacija pisanja/uklanjanja.
|
|
328
|
-
Svaka operacija pisanja ili uklanjanja poništava čitavu keš memoriju, osiguravajući da će naredna čitanja vidjeti
|
|
329
|
-
najnovije promjene.
|
|
330
|
-
|
|
331
|
-
### CLI alati
|
|
332
|
-
Ako koristite CLI alat kao što je [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
|
|
333
|
-
definitivno ćete htjeti da se redis keš memorija omogući, jer ona traje tijekom pozivanja naredbe `mo` .
|
|
334
|
-
|
|
335
|
-
## Mirroring
|
|
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
|
-
Komanda `mirror` izvodi jednokratnu kopiju svih datoteka s jednog mobitela na drugi.
|
|
344
|
-
Ne pokreće nikakav proces za održavanje ogledala tokom vremena. Ponovo pokrenite naredbu `mirror`
|
|
345
|
-
da sinhronizujete sve datoteke koje nedostaju.
|
|
346
|
-
|
|
347
|
-
Povratna vrijednost iz `mirror` je jednostavan objekt sa brojačima koliko je datoteka uspješno
|
|
348
|
-
preslikano i koliko fajlova ima grešaka:
|
|
349
|
-
|
|
350
|
-
{
|
|
351
|
-
success: count-of-files-mirrored,
|
|
352
|
-
errors: count-of-files-with-errors
|
|
353
|
-
}
|
|
354
|
-
|
|
355
|
-
UPOZORENJE: Zrcaljenje velikih skupova podataka može oduzeti mnogo vremena i propusnog opsega
|
|
356
|
-
|
|
357
|
-
Sa semantikom poziva `mirror` ponekad može biti zbunjujuće shvatiti ko je
|
|
358
|
-
čitalac i ko je pisac. Zamislite to kao izjavu o zadatku: "lijevi mobilni telefon"
|
|
359
|
-
je stvar kojoj se dodjeljuje (preslikani podaci upisani) i "desni mobilni telefon" (
|
|
360
|
-
argument metodi `mirror` ) je vrijednost koja se dodjeljuje (preslikani podaci se čitaju).
|
|
361
|
-
|
|
362
|
-
## Transparentna enkripcija
|
|
363
|
-
Omogućite transparentno šifriranje na strani klijenta:
|
|
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
|
-
Šta se dešava? Odvojeni direktorij (dirent) (šifrirani) prati koje se datoteke nalaze u njemu
|
|
383
|
-
direktorij (aka dirent direktorij).
|
|
384
|
-
* Komanda `list` čita datoteke unosa direktorija, dešifruje svaku navedenu putanju; zatim vraća metapodatke za svaki fajl
|
|
385
|
-
* Naredbe `list` su neefikasnije, posebno za direktorije s velikim brojem datoteka
|
|
386
|
-
* Komanda `write` upisuje dirent datoteke u dirent direktorij svakog roditelja; zatim upisuje datoteku
|
|
387
|
-
* Naredbe `write` će uzrokovati O(N) upisivanja, s N = dubinom u hijerarhiji direktorija
|
|
388
|
-
* Komanda `remove` uklanja odgovarajući dirent fajl i njegov roditelj ako je prazan; zatim uklanja fajl
|
|
389
|
-
* Nerekurzivne naredbe `remove` će izazvati O(N) čitanja i potencijalno isto toliko brisanja, sa N = dubinom u hijerarhiji direktorija
|
|
390
|
-
* Rekurzivne naredbe `remove` na velikim i dubokim sistemima datoteka mogu biti skupe
|
|
391
|
-
|
|
392
|
-
Imajte na umu da čak i sa omogućenom enkripcijom na strani klijenta, protivnik sa potpunom vidljivošću na vašoj šifriranoj strani servera
|
|
393
|
-
skladište, čak i bez ključa, i dalje može vidjeti ukupan broj direktorija i koliko datoteka se nalazi u svakom i sa
|
|
394
|
-
malo truda, otkrijte dio ili cijelu cjelokupnu strukturu hijerarhije direktorija.
|
|
395
|
-
*Napomena: Koristite relativno ravnu strukturu za bolju sigurnost.*
|
|
396
|
-
Protivnik ne bi znao imena direktorija/fajlova osim ako ne zna i vašu enkripciju
|
|
397
|
-
ključ ili na neki drugi način uspješno provalio enkripciju. Tada su sve opklade isključene!
|
|
398
|
-
|
|
399
|
-
### Performanse i keširanje
|
|
400
|
-
Operacije na šifriranoj memoriji mogu biti spore. Rekurzivni popisi i uklanjanja mogu biti vrlo spori.
|
|
401
|
-
Keširanje putem redis-a izuzetno pomaže, ali imajte na umu da se predmemorija ispire nakon svakog upisivanja ili uklanjanja.
|
|
402
|
-
|
|
403
|
-
## Rotacija tastera
|
|
404
|
-
Kreirajte mobiletto sa svojim novim ključem, a zatim preslikajte stare podatke u njega:
|
|
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
|
-
## Interfejs drajvera
|
|
417
|
-
Drajver je bilo koja JS datoteka koja izvozi funkciju 'storageClient' sa ovim potpisom:
|
|
418
|
-
|
|
419
|
-
function storageClient (key, secret, opts)
|
|
420
|
-
|
|
421
|
-
* `key` : string, vaš API ključ (za `local` drajver ovo je osnovni direktorij)
|
|
422
|
-
* `secret` : string, vaša tajna API-ja (može se izostaviti za `local` drajver)
|
|
423
|
-
* `opts` : objekt, svojstva su po vozaču:
|
|
424
|
-
* Za `local` , svojstva `fileMode` i `dirMode` određuju kako se kreiraju novi kreirani fajlovi i direktoriji
|
|
425
|
-
* Za `s3` , svojstvo `bucket` je potrebno. Opciona svojstva su:
|
|
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 koji funkcija storageClient vraća mora definirati ove 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
|
-
## Logging
|
|
457
|
-
Mobiletto koristi biblioteku za evidentiranje [winston](https://www.npmjs.com/package/winston).
|
|
458
|
-
|
|
459
|
-
Dnevnici **će** sadržavati putanje datoteka i poruke o greškama, ali **nikada** neće sadržavati ključeve, tajne,
|
|
460
|
-
ili bilo koje druge informacije o konfiguraciji veze.
|
|
461
|
-
|
|
462
|
-
### Nivo dnevnika
|
|
463
|
-
Koristite varijablu okruženja `MOBILETTO_LOG_LEVEL` da postavite nivo dnevnika, koristeći jedan
|
|
464
|
-
nivoa `npm` definiranih u [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
|
|
465
|
-
|
|
466
|
-
Podrazumevani nivo je `error` . Najopširniji nivo je `silly` , iako trenutno mobiletto
|
|
467
|
-
ne logova na nivoima ispod `debug`
|
|
468
|
-
|
|
469
|
-
MOBILETTO_LOG_LEVEL=silly # maximum logs!
|
|
470
|
-
|
|
471
|
-
### Dnevnik
|
|
472
|
-
Podrazumevano, loger piše u konzolu. Za slanje dnevnika u datoteku, postavite `MOBILETTO_LOG_FILE`
|
|
473
|
-
varijabla okruženja. Kada se evidentirate u datoteku, dnevnici više neće biti upisani u konzolu.
|
|
474
|
-
|
|
475
|
-
MOBILETTO_LOG_FILE=/var/my_mobiletto_log
|
|
476
|
-
|
|
477
|
-
Da isključite bilježenje:
|
|
478
|
-
|
|
479
|
-
MOBILETTO_LOG_FILE=/dev/null
|
|
480
|
-
|
|
481
|
-
</pre>
|