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 JavaScript biltegiratze abstrakzio geruza bat da, aukerako bezeroaren aldeko enkriptazio gardena duena.
|
|
5
|
+
|
|
6
|
+
# Edukiak
|
|
7
|
+
* [Zergatik Mobiletto?](#Zergatik-Mobiletto?)
|
|
8
|
+
* [Hasiera azkarra](#Abiarazte azkarra)
|
|
9
|
+
* [Mobiletto CLI](#mobiletto-cli)
|
|
10
|
+
* [Iturria](#Iturria)
|
|
11
|
+
* [Oinarrizko erabilera](#Oinarrizko erabilera)
|
|
12
|
+
* [Metadatuak](#Metadatuak)
|
|
13
|
+
* [Alternate inportazio estiloa](#Alternate-inportazio-estiloa)
|
|
14
|
+
* [Caching](#Caching)
|
|
15
|
+
* [Ispilu](#Ispilu)
|
|
16
|
+
* [Enkriptatzea gardena](#Transparent-encryption)
|
|
17
|
+
* [Teklaren biraketa](#Teklaren biraketa)
|
|
18
|
+
* [Gidari-interfazea](#Driver-interfazea)
|
|
19
|
+
* [Logging](#Logging)
|
|
20
|
+
|
|
21
|
+
# Irakurri hau beste hizkuntza batean
|
|
22
|
+
README.md dokumentu hau [hokeylization](https://github.com/cobbzilla/hokeylization) bidez itzuli da.
|
|
23
|
+
**[Google Translate-k onartzen duen hizkuntza guztietan](https://cloud.google.com/translate/docs/languages)!**
|
|
24
|
+
|
|
25
|
+
Ziur nago ez dela perfektua, baina espero dut ezer baino hobea izatea!
|
|
26
|
+
|
|
27
|
+
[🇸🇦 arabiera](../ar/README.md)
|
|
28
|
+
[🇧🇩 bengalera](../bn/README.md)
|
|
29
|
+
[🇩🇪 alemana](../de/README.md)
|
|
30
|
+
[🇺🇸 Ingelesa](../eu/README.md)
|
|
31
|
+
[🇪🇸 Gaztelania](../es/README.md)
|
|
32
|
+
[🇫🇷 frantsesa](../fr/README.md)
|
|
33
|
+
[🇹🇩 Hausa](../ha/README.md)
|
|
34
|
+
[🇮🇳 Hindi](../hi/README.md)
|
|
35
|
+
[🇮🇩 indonesiera](../id/README.md)
|
|
36
|
+
[🇮🇹 italiera](../it/README.md)
|
|
37
|
+
[🇯🇵 Japoniera](../ja/README.md)
|
|
38
|
+
[🇰🇷 koreera](../ko/README.md)
|
|
39
|
+
[🇮🇳 Maranthi](../mr/README.md)
|
|
40
|
+
[🇵🇱 poloniera](../pl/README.md)
|
|
41
|
+
[🇧🇷 portugesa](../pt/README.md)
|
|
42
|
+
[🇷🇺 errusiera](../ru/README.md)
|
|
43
|
+
[🇰🇪 Swahili](../sw/README.md)
|
|
44
|
+
[🇵🇭 Tagalog](../tl/README.md)
|
|
45
|
+
[🇹🇷 turkiera](../tr/README.md)
|
|
46
|
+
[🇵🇰 Urdu](../ur/README.md)
|
|
47
|
+
[🇻🇳 vietnamera](../vi/README.md)
|
|
48
|
+
[🇨🇳 txinera](../zh/README.md)
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
**[📚 ... Hizkuntza guztiak ...](../README.md)**
|
|
52
|
+
----
|
|
53
|
+
|
|
54
|
+
### Arazorik al dago IRAKURRI-ren itzulpen honekin?
|
|
55
|
+
[README] jatorrizkoaren itzulpen zehatz hau (https://github.com/cobbzilla/mobiletto/blob/master/README.md)
|
|
56
|
+
akatsa izan daiteke -- *zuzenketak oso ongi etorriak dira!* Bidali [pull eskaera GitHub-en](https://github.com/cobbzilla/mobiletto/pulls),
|
|
57
|
+
edo hori egiten eroso ez bazaude, [ireki arazo bat](https://github.com/cobbzilla/mobiletto/issues)
|
|
58
|
+
|
|
59
|
+
Itzulpen bati buruzko GitHub-en arazo berri bat sortzen duzunean, egin:
|
|
60
|
+
* Sartu orriaren URLa (kopiatu/itsatsi arakatzailearen helbide barratik)
|
|
61
|
+
* sartu oker dagoen testu zehatza (kopiatu/itsatsi arakatzailetik)
|
|
62
|
+
* Mesedez, deskribatu zer dagoen gaizki -- itzulpena okerra al da? formatua hautsi al da nolabait?
|
|
63
|
+
* Mesedez, eskaini itzulpen hobeago baten iradokizuna, edo testua nola formateatu behar den
|
|
64
|
+
* **Eskerrik asko!**
|
|
65
|
+
|
|
66
|
+
## Zergatik Mobiletto?
|
|
67
|
+
|
|
68
|
+
### Agur saltzaileen blokeoa!
|
|
69
|
+
Hodeiko biltegiratze hornitzaile ezberdinek API bateraezinak dituzte. "S3 bateragarritasuna" bilatzen dutenek ere
|
|
70
|
+
jokabide idiosinkratikoak dituzte.
|
|
71
|
+
|
|
72
|
+
Zure aplikaziorako biltegiratze-saltzaile jakin bat aukeratzen duzunean, zuzenean haien APIan kodetzen baduzu, zure aplikazioan
|
|
73
|
+
zerbitzu horren menpe dago orain. Denbora pasa eta kodea pilatu ahala, saltzaileen aldaketa bihurtzen da
|
|
74
|
+
gero eta jasangaitzagoa. Ongi etorri saltzaileen blokeoaren mundu dibertigarrira!
|
|
75
|
+
|
|
76
|
+
Mobiletto arazo hau konpontzeko diseinatu zen. Zure aplikazioa mobiletto-ren APIra kodetuz, erraz egin dezakezu
|
|
77
|
+
aldatu biltegiratze-hornitzaileak eta jakin zure aplikazioaren biltegiratze-geruzak berdin-berdin jokatuko duela.
|
|
78
|
+
|
|
79
|
+
### Proba zabalak
|
|
80
|
+
Gidari guztiek portaera berdina duten probak egiten dituzte gidari bakoitzeko 60 proba baino gehiagorekin.
|
|
81
|
+
Gidari guztiak probatzen ditugu honako konbinazio guztiekin:
|
|
82
|
+
* Enkriptatzea: gaituta eta desgaituta
|
|
83
|
+
* Redis cachea: gaituta eta desgaituta
|
|
84
|
+
|
|
85
|
+
Ikuspegi honek lasaitasuna ematen digu mobilettok berdin jokatuko duela erabiltzen duzun gidari edozein dela ere,
|
|
86
|
+
eta cachea eta/edo enkriptatzea gaitzen duzun ala ez.
|
|
87
|
+
|
|
88
|
+
### Gidariaren laguntza
|
|
89
|
+
Egungo Mobiletto biltegiratze kontrolatzaileak:
|
|
90
|
+
* `s3` : Amazon S3
|
|
91
|
+
* `b2` : Backblaze B2
|
|
92
|
+
* `local` : fitxategi-sistema lokala
|
|
93
|
+
|
|
94
|
+
*Hodeiko biltegiratze hornitzaile gehiago laguntzeko ekarpenak oso ongi etorriak dira!*
|
|
95
|
+
|
|
96
|
+
## mobiletto-cli
|
|
97
|
+
Mobiletto beste JavaScript kode batzuek liburutegi gisa erabiltzeko pentsatuta dago.
|
|
98
|
+
|
|
99
|
+
Mobiletto-rekin komando lerroan lan egiteko, erabili [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
|
|
100
|
+
|
|
101
|
+
## Iturria
|
|
102
|
+
* [mobiletto GitHub-en](https://github.com/cobbzilla/mobiletto)
|
|
103
|
+
* [mobiletto npm-n](https://www.npmjs.com/package/mobiletto)
|
|
104
|
+
|
|
105
|
+
## Hasiera azkarra
|
|
106
|
+
Adibide labur bat mobiletto `s3` kontrolatzailea erabiliz.
|
|
107
|
+
|
|
108
|
+
Kode hau berdin exekutatuko litzateke kontrolatzailea `b2` edo `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
|
+
## Oinarrizko erabilera
|
|
139
|
+
Adibide askoz zabalagoa, eskaintzen diren ezaugarri gehienak erakusten dituena:
|
|
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
|
+
## Metadatuak
|
|
241
|
+
`metadata` komandoak fitxategi-sistemako sarrera bakar bati buruzko metadatuak itzultzen ditu.
|
|
242
|
+
Era berean, `list` komandoaren itzulera-balioa metadatu objektuen array bat da.
|
|
243
|
+
|
|
244
|
+
Metadatu objektu batek itxura hau du:
|
|
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
|
+
`type` propietatea `file` , `dir` , `link` edo `special` .
|
|
255
|
+
|
|
256
|
+
Gidari motaren arabera, `list` komandoak baliteke eremu guztiak ez itzultzea. `name` eta `type` propietateak
|
|
257
|
+
beti egon behar du. Ondorengo `metadata` komando batek erabilgarri dauden propietate guztiak itzuliko ditu.
|
|
258
|
+
|
|
259
|
+
## Inportazio estilo alternatiboa
|
|
260
|
+
Inportatu eremu osoko modulua eta erabili `connect` funtzioa:
|
|
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
|
+
## Cachean gordetzea
|
|
268
|
+
Mobiletto-k hobekien funtzionatzen du <a href="https://redis.io">redis</a> cache batekin.
|
|
269
|
+
|
|
270
|
+
Mobiletto redis instantzia batera konektatzen saiatuko da 127.0.0.1:6379
|
|
271
|
+
|
|
272
|
+
Hauetako bat gainidatzi dezakezu:
|
|
273
|
+
* Ezarri `MOBILETTO_REDIS_HOST` env var, mugikorra hemen konektatu tokiko ostalariaren ordez
|
|
274
|
+
* Ezarri `MOBILETTO_REDIS_PORT` env var, ataka hau erabiliko da
|
|
275
|
+
|
|
276
|
+
Mobiletto-k bere redis gako guztiak gordeko ditu `_mobiletto__` aurrizkiarekin. Hau alda dezakezu
|
|
277
|
+
`MOBILETTO_REDIS_PREFIX` env var.
|
|
278
|
+
|
|
279
|
+
Konexio bakoitzeko cachea ere ezar dezakezu `opts.redisConfig` objektuarekin:
|
|
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
|
+
### Ez duzu nahi redis cachean?
|
|
291
|
+
Desgaitzeko: pasa `enabled: false` zure `opts.redisConfig` objektuan zure konexioa ezartzen duzunean.
|
|
292
|
+
|
|
293
|
+
Jarraian azaltzen den bezala, cachea desgaitzeak eragin kaltegarria izango du errendimenduan eta eskaera gehiago sortuko ditu
|
|
294
|
+
benetan behar duzun biltegiratzera.
|
|
295
|
+
|
|
296
|
+
### Cachean gordetzeko jarraibideak
|
|
297
|
+
**Biltegiratze enkriptatua**: biltegiratze enkriptatutako irakurketa/idazketa normala baino apur bat motelagoa da,
|
|
298
|
+
baina direktorioetan zehar nabigatzea (gauza batzuk egiten dutena) nahiko garestia da. Redis cachea erabiliz
|
|
299
|
+
errendimenduaren bultzada nabarmena emango dizu.
|
|
300
|
+
|
|
301
|
+
Cache lehenetsia segurua da, baina ez du ondo funtzionatzen idazteko/kentzeko eragiketa asko egiten badituzu.
|
|
302
|
+
Idazteko edo kentzeko eragiketa orok cache osoa baliogabetzen du, ondorengo irakurketak ikusiko duela bermatuz
|
|
303
|
+
azken aldaketak.
|
|
304
|
+
|
|
305
|
+
### CLI tresnak
|
|
306
|
+
[mobiletto-cli] bezalako CLI tresna bat erabiltzen ari bazara (https://www.npmjs.com/package/mobiletto-cli),
|
|
307
|
+
zalantzarik gabe, redis cachea gaituta nahi izango duzu, `mo` komandoaren deialdietan irauten baitu.
|
|
308
|
+
|
|
309
|
+
## Ispilua
|
|
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` komandoak fitxategi guztien kopia bat egiten du mobiletto batetik bestera.
|
|
318
|
+
Ez du prozesurik exekutatzen ispilua denboran mantentzeko. Exekutatu `mirror` komandoa berriro
|
|
319
|
+
falta diren fitxategiak sinkronizatzeko.
|
|
320
|
+
|
|
321
|
+
`mirror` -ren itzulera-balioa objektu soil bat da, zenbat fitxategi arrakastatsu izan diren kontagailuak dituena
|
|
322
|
+
ispilu eta zenbat fitxategi izan dituzten erroreak:
|
|
323
|
+
|
|
324
|
+
{
|
|
325
|
+
success: count-of-files-mirrored,
|
|
326
|
+
errors: count-of-files-with-errors
|
|
327
|
+
}
|
|
328
|
+
|
|
329
|
+
OHARRA: datu-multzo handiak islatzea oso denbora asko eta banda zabalera handia izan daiteke
|
|
330
|
+
|
|
331
|
+
`mirror` dei semantikarekin batzuetan nahasgarria izan daiteke nor den ulertzea
|
|
332
|
+
irakurlea eta nor den idazlea. Imajinatu esleipen adierazpen bat bezala: "ezkerreko mobiletto"
|
|
333
|
+
esleitzen zaion gauza da (ispilutako datuak idatzita), eta "eskuineko mobiletto" (the
|
|
334
|
+
`mirror` metodoari argumentua) esleitzen ari den balioa da (ispilutako datuak irakurtzen dira).
|
|
335
|
+
|
|
336
|
+
## Enkriptatzea gardena
|
|
337
|
+
Gaitu bezeroaren aldeko enkriptatzea gardena:
|
|
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
|
+
Zer ari da gertatzen? "Directory sarrera" (zuzeneko) direktorio (zifratuta) bereizi batek zer fitxategi dauden jarraitzen du
|
|
357
|
+
direktorioa (aka dirent direktorioa).
|
|
358
|
+
* `list` komandoak direktorioko sarrera fitxategiak irakurtzen ditu, zerrendatutako bide bakoitza deszifratzen du; ondoren, fitxategi bakoitzaren metadatuak itzultzen ditu
|
|
359
|
+
* `list` komandoak eraginkorragoak dira, batez ere fitxategi kopuru handia duten direktorioetarako
|
|
360
|
+
* `write` komandoak dirent fitxategiak idazten ditu guraso bakoitzaren dirent direktorioan, modu errekurtsiboan; ondoren fitxategia idazten du
|
|
361
|
+
* `write` komandoek O (N) idazketak eragingo dituzte, N = sakontasuna direktorio hierarkian
|
|
362
|
+
* `remove` komandoak dagokion dirent fitxategia kentzen du, eta bere gurasoa hutsik badago, errekurtsiboki; gero fitxategia kentzen du
|
|
363
|
+
* `remove` komando ez-errekurtsiboek O(N) irakurketa eragingo dute eta, agian, beste hainbeste ezabatuko dituzte, N = sakontasuna direktorio hierarkian
|
|
364
|
+
* `remove` komando errekurtsiboak fitxategi-sistema handi eta sakonetan garestiak izan daitezke
|
|
365
|
+
|
|
366
|
+
Kontuan izan bezeroaren alboko enkriptatzea gaituta dagoen arren, zure zerbitzariaren enkriptatutako ikusgarritasun osoa duen arerio bat
|
|
367
|
+
biltegiratzeak, gakorik gabe ere, direktorio-kopuru osoa eta bakoitzean zenbat fitxategi dauden ikus dezake
|
|
368
|
+
ahalegin bat, aurki ezazu direktorio-hierarkiaren egitura orokorraren zati bat edo guztia.
|
|
369
|
+
*Oharra: erabili egitura nahiko laua segurtasun hobea lortzeko.*
|
|
370
|
+
Aurkariak ez luke direktorio/fitxategien izenak jakingo zure enkriptatzea ere ezagutu ezean
|
|
371
|
+
gakoa edo, bestela, enkriptatzea arrakastaz pitzatu izana. Apustu guztiak desaktibatuta daude orduan!
|
|
372
|
+
|
|
373
|
+
### Errendimendua eta cachea
|
|
374
|
+
Biltegiratze enkriptatutako eragiketak motelak izan daitezke. Zerrenda errekurtsiboak eta kentzeak oso motelak izan daitezke.
|
|
375
|
+
Redis bidez gordetzeak izugarri laguntzen du, baina kontuan izan cachea idazten edo kentzen denean garbitzen dela.
|
|
376
|
+
|
|
377
|
+
## Teklaren biraketa
|
|
378
|
+
Sortu mobiletto bat zure gako berriarekin, gero datu zaharrak bertan islatu:
|
|
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
|
+
## Gidariaren interfazea
|
|
391
|
+
Gidatzailea sinadura honekin 'storageClient' funtzio bat esportatzen duen JS fitxategia da:
|
|
392
|
+
|
|
393
|
+
function storageClient (key, secret, opts)
|
|
394
|
+
|
|
395
|
+
* `key` : kate bat, zure API gakoa ( `local` kontrolatzailearentzat hau da oinarrizko direktorioa)
|
|
396
|
+
* `secret` : kate bat, zure API sekretua ( `local` kontrolatzailerako ezaba daiteke)
|
|
397
|
+
* `opts` : objektu bat, propietateak kontrolatzaile bakoitzeko dira:
|
|
398
|
+
* `local` -rako, `fileMode` eta `dirMode` propietateek zehazten dute nola sortzen diren fitxategi eta direktorio berriak sortzeko
|
|
399
|
+
* `s3` -rako, `bucket` propietatea beharrezkoa da. Aukerako propietateak hauek dira:
|
|
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
|
+
StorageClient funtzioak itzultzen duen objektuak funtzio hauek definitu behar ditu:
|
|
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
|
+
## Erregistroa
|
|
431
|
+
Mobiletto-k [winston](https://www.npmjs.com/package/winston) erregistro-liburutegia erabiltzen du.
|
|
432
|
+
|
|
433
|
+
Erregistroek **fitxategien bideak eta errore-mezuak** izango dituzte, baina **inoiz** ez dituzte izango gakoak, sekretuak,
|
|
434
|
+
edo konexioaren konfigurazioko beste edozein informazio.
|
|
435
|
+
|
|
436
|
+
### Erregistro maila
|
|
437
|
+
Erabili `MOBILETTO_LOG_LEVEL` ingurune-aldagaia erregistro-maila ezartzeko, bat erabiliz
|
|
438
|
+
[https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels) atalean definitutako `npm` mailen artean
|
|
439
|
+
|
|
440
|
+
Maila lehenetsia `error` da. Maila `silly` da, nahiz eta gaur egun mobiletto
|
|
441
|
+
ez du `debug` azpiko mailetan erregistratzen
|
|
442
|
+
|
|
443
|
+
MOBILETTO_LOG_LEVEL=silly # maximum logs!
|
|
444
|
+
|
|
445
|
+
### Erregistro fitxategia
|
|
446
|
+
Lehenespenez, erregistratzaileak kontsolan idazten du. Fitxategi batera erregistroak bidaltzeko, ezarri `MOBILETTO_LOG_FILE`
|
|
447
|
+
ingurune-aldagaia. Fitxategi batean saioa hastean, erregistroak ez dira gehiago kontsolan idatziko.
|
|
448
|
+
|
|
449
|
+
MOBILETTO_LOG_FILE=/var/my_mobiletto_log
|
|
450
|
+
|
|
451
|
+
Saioa desaktibatzeko:
|
|
452
|
+
|
|
453
|
+
MOBILETTO_LOG_FILE=/dev/null
|
|
454
|
+
|
|
455
|
+
</pre>
|