mobiletto 1.1.10 → 1.1.13
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 +74 -0
- package/docs/README.md +113 -0
- package/docs/af/README.md +481 -0
- package/docs/am/README.md +481 -0
- package/docs/ar/README.md +481 -0
- package/docs/az/README.md +481 -0
- package/docs/be/README.md +481 -0
- package/docs/bg/README.md +481 -0
- package/docs/bn/README.md +481 -0
- package/docs/bs/README.md +481 -0
- package/docs/ca/README.md +481 -0
- package/docs/ceb/README.md +481 -0
- package/docs/co/README.md +481 -0
- package/docs/cs/README.md +481 -0
- package/docs/cy/README.md +481 -0
- package/docs/da/README.md +481 -0
- package/docs/de/README.md +481 -0
- package/docs/el/README.md +481 -0
- package/docs/eo/README.md +481 -0
- package/docs/es/README.md +481 -0
- package/docs/et/README.md +481 -0
- package/docs/eu/README.md +481 -0
- package/docs/fa/README.md +481 -0
- package/docs/fi/README.md +481 -0
- package/docs/fr/README.md +481 -0
- package/docs/fy/README.md +481 -0
- package/docs/ga/README.md +481 -0
- package/docs/gd/README.md +481 -0
- package/docs/gl/README.md +481 -0
- package/docs/gu/README.md +481 -0
- package/docs/ha/README.md +481 -0
- package/docs/haw/README.md +481 -0
- package/docs/he/README.md +481 -0
- package/docs/hi/README.md +481 -0
- package/docs/hmn/README.md +481 -0
- package/docs/hr/README.md +481 -0
- package/docs/ht/README.md +481 -0
- package/docs/hu/README.md +481 -0
- package/docs/hy/README.md +481 -0
- package/docs/id/README.md +481 -0
- package/docs/ig/README.md +481 -0
- package/docs/is/README.md +481 -0
- package/docs/it/README.md +481 -0
- package/docs/iw/README.md +481 -0
- package/docs/ja/README.md +481 -0
- package/docs/jv/README.md +481 -0
- package/docs/ka/README.md +481 -0
- package/docs/kk/README.md +481 -0
- package/docs/km/README.md +481 -0
- package/docs/kn/README.md +481 -0
- package/docs/ko/README.md +481 -0
- package/docs/ku/README.md +481 -0
- package/docs/ky/README.md +481 -0
- package/docs/la/README.md +481 -0
- package/docs/lb/README.md +481 -0
- package/docs/lo/README.md +481 -0
- package/docs/lt/README.md +481 -0
- package/docs/lv/README.md +481 -0
- package/docs/mg/README.md +481 -0
- package/docs/mi/README.md +481 -0
- package/docs/mk/README.md +481 -0
- package/docs/ml/README.md +481 -0
- package/docs/mn/README.md +481 -0
- package/docs/mr/README.md +481 -0
- package/docs/ms/README.md +481 -0
- package/docs/mt/README.md +481 -0
- package/docs/my/README.md +481 -0
- package/docs/ne/README.md +481 -0
- package/docs/nl/README.md +481 -0
- package/docs/no/README.md +481 -0
- package/docs/ny/README.md +481 -0
- package/docs/or/README.md +481 -0
- package/docs/pa/README.md +481 -0
- package/docs/pl/README.md +481 -0
- package/docs/ps/README.md +481 -0
- package/docs/pt/README.md +481 -0
- package/docs/ro/README.md +481 -0
- package/docs/ru/README.md +481 -0
- package/docs/rw/README.md +481 -0
- package/docs/sd/README.md +481 -0
- package/docs/si/README.md +481 -0
- package/docs/sk/README.md +481 -0
- package/docs/sl/README.md +481 -0
- package/docs/sm/README.md +481 -0
- package/docs/sn/README.md +481 -0
- package/docs/so/README.md +481 -0
- package/docs/sq/README.md +481 -0
- package/docs/sr/README.md +481 -0
- package/docs/st/README.md +481 -0
- package/docs/su/README.md +481 -0
- package/docs/sv/README.md +481 -0
- package/docs/sw/README.md +481 -0
- package/docs/ta/README.md +481 -0
- package/docs/te/README.md +481 -0
- package/docs/tg/README.md +481 -0
- package/docs/th/README.md +481 -0
- package/docs/tk/README.md +481 -0
- package/docs/tl/README.md +481 -0
- package/docs/tr/README.md +481 -0
- package/docs/tt/README.md +481 -0
- package/docs/ug/README.md +481 -0
- package/docs/uk/README.md +481 -0
- package/docs/ur/README.md +481 -0
- package/docs/uz/README.md +481 -0
- package/docs/vi/README.md +481 -0
- package/docs/xh/README.md +481 -0
- package/docs/yi/README.md +481 -0
- package/docs/yo/README.md +481 -0
- package/docs/zh/README.md +481 -0
- package/docs/zu/README.md +481 -0
- package/drivers/b2/index.js +25 -6
- package/hokey.json +16 -0
- package/index.js +7 -2
- package/package.json +1 -1
- package/test/api.spec.js +13 -9
- package/util/redis.js +2 -2
|
@@ -0,0 +1,481 @@
|
|
|
1
|
+
Mobiletto
|
|
2
|
+
=========
|
|
3
|
+
|
|
4
|
+
Mobiletto ndi gawo la JavaScript losungirako, lomwe lili ndi kubisa kwapambali kwa kasitomala.
|
|
5
|
+
|
|
6
|
+
# Zamkatimu
|
|
7
|
+
* [Chifukwa Chiyani Mobiletto?](#Why-Mobiletto?)
|
|
8
|
+
* [Kuyambira mwachangu](#Kuyambira mwachangu)
|
|
9
|
+
* [Mobiletto CLI](#mobiletto-cli)
|
|
10
|
+
* [Gwero](#Source)
|
|
11
|
+
* [Kuyika](#Kuyika)
|
|
12
|
+
* [Thandizo ndi Ndalama](#Thandizo-ndi-ndandalama)
|
|
13
|
+
* [Kagwiritsidwe ntchito kake](#Kagwiritsidwe koyambira)
|
|
14
|
+
* [Metadata](#Metadata)
|
|
15
|
+
* [Mtundu wina wolowetsa](#Mtundu wina wolowetsa)
|
|
16
|
+
* [Kusunga](#Caching)
|
|
17
|
+
* [Mirroring](#Mirroring)
|
|
18
|
+
* [Transparent encryption](# Transparent-encryption)
|
|
19
|
+
* [Kutembenuza kiyi](#Kutembenuza-makiyi)
|
|
20
|
+
* [Mawonekedwe a Dalaivala](#Mawonekedwe Oyendetsa)
|
|
21
|
+
* [Kudula mitengo](#Logging)
|
|
22
|
+
|
|
23
|
+
# Werengani izi muchilankhulo china
|
|
24
|
+
Chikalata cha README.md chamasuliridwa, kudzera pa [hokeylization](https://github.com/cobbzilla/hokeylization), ku
|
|
25
|
+
**[chinenero chilichonse chimathandizidwa ndi Zomasulira za Google](https://cloud.google.com/translate/docs/languages)!**
|
|
26
|
+
|
|
27
|
+
Ndikutsimikiza kuti sizabwino, koma ndikukhulupirira kuti nzabwino kuposa chilichonse!
|
|
28
|
+
|
|
29
|
+
[🇸🇦 Chiarabu](../ar/README.md)
|
|
30
|
+
[🇧🇩 Bengali](../bn/README.md)
|
|
31
|
+
[🇩🇪 Chijeremani](../de/README.md)
|
|
32
|
+
[🇺🇸 Chingerezi](../en/README.md)
|
|
33
|
+
[🇪🇸 Chisipanishi](../es/README.md)
|
|
34
|
+
[🇫🇷 Chifulenchi](../fr/README.md)
|
|
35
|
+
[🇹🇩 Hausa](../ha/README.md)
|
|
36
|
+
[🇮🇳 Chihindi](../hi/README.md)
|
|
37
|
+
[🇮🇩 Chiindoneziya](../id/README.md)
|
|
38
|
+
[🇮🇹 Chiitaliya](../it/README.md)
|
|
39
|
+
[🇯🇵 Japanese](../ja/README.md)
|
|
40
|
+
[🇰🇷 Chikorea](../ko/README.md)
|
|
41
|
+
[🇮🇳 Maranthi](../mr/README.md)
|
|
42
|
+
[🇵🇱 Chipolishi](../pl/README.md)
|
|
43
|
+
[🇧🇷 Chipwitikizi](../pt/README.md)
|
|
44
|
+
[🇷🇺 Russian](../ru/README.md)
|
|
45
|
+
[🇰🇪 Swahili](../sw/README.md)
|
|
46
|
+
[🇵🇭 Tagalog](../tl/README.md)
|
|
47
|
+
[🇹🇷 Turkish](../tr/README.md)
|
|
48
|
+
[🇵🇰 Urdu](../ur/README.md)
|
|
49
|
+
[🇻🇳 Vietnamese](../vi/README.md)
|
|
50
|
+
[🇨🇳 Chinese](../zh/README.md)
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
**[📚 ... Zinenero Zonse ...](../README.md)**
|
|
54
|
+
----
|
|
55
|
+
|
|
56
|
+
### Kodi pali vuto ndi kumasulira kumeneku kwa README?
|
|
57
|
+
Kumasulira kwenikweniku [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
|
|
58
|
+
zitha kukhala zolakwika -- *zokonza ndizolandilidwa kwambiri!* Chonde tumizani [kukoka pempho pa GitHub](https://github.com/cobbzilla/mobiletto/pulls),
|
|
59
|
+
kapena ngati simumasuka kuchita zimenezo, [tsegulani nkhani](https://github.com/cobbzilla/mobiletto/issues)
|
|
60
|
+
|
|
61
|
+
Mukapanga nkhani yatsopano ya GitHub yokhudza kumasulira, chonde chitani:
|
|
62
|
+
* Phatikizani ulalo watsamba (koperani / kumata kuchokera pa adilesi ya msakatuli)
|
|
63
|
+
* Phatikizani zomwe zili zolakwika (koperani/mata kuchokera pa msakatuli)
|
|
64
|
+
* chonde fotokozani chomwe chalakwika -- kodi kumasulira kwake ndikolakwika? Kodi masanjidwewo awonongeka mwanjira ina?
|
|
65
|
+
* perekani mokoma mtima lingaliro la kumasulira kwabwinoko, kapena mmene malembawo ayenera kusanjidwira bwino
|
|
66
|
+
* **Zikomo!**
|
|
67
|
+
|
|
68
|
+
## Chifukwa Mobiletto?
|
|
69
|
+
|
|
70
|
+
### Tatsala pang'ono kutseka mavenda!
|
|
71
|
+
Othandizira osiyanasiyana osungira mitambo ali ndi ma API osagwirizana. Ngakhale omwe amayesetsa "kufanana kwa S3"
|
|
72
|
+
kukhala ndi makhalidwe osadziwika bwino.
|
|
73
|
+
|
|
74
|
+
Mukasankha wogulitsa wina wosungira pulogalamu yanu, ngati mumalembera mwachindunji ku API yawo, pulogalamu yanu
|
|
75
|
+
tsopano amadalira utumiki umenewo. Pamene nthawi ikupita ndipo code ikuwonjezeka, kusintha ogulitsa kumakhala
|
|
76
|
+
osavomerezeka. Takulandilani kudziko losangalatsa la mavenda lock-in!
|
|
77
|
+
|
|
78
|
+
Mobiletto idapangidwa kuti ithetse vutoli. Mwa kukopera pulogalamu yanu ku mobiletto's API, mungathe mosavuta
|
|
79
|
+
sinthani osungira ndikudziwa kuti malo osungira a pulogalamu yanu azichita chimodzimodzi.
|
|
80
|
+
|
|
81
|
+
### Kuyesa kwakukulu
|
|
82
|
+
Madalaivala onse amayesedwa kuti akhale ndi machitidwe ofanana ndi mayeso 60+ pa driver aliyense.
|
|
83
|
+
Timayesa madalaivala onse ndi kuphatikiza kulikonse:
|
|
84
|
+
* Kubisa: zonse zimathandizidwa komanso zolephereka
|
|
85
|
+
* Redis cache: zonse zimayatsidwa komanso zolephereka
|
|
86
|
+
|
|
87
|
+
Njirayi imatipatsa mtendere wamumtima kuti mobiletto izichita chimodzimodzi mosasamala kanthu kuti mumagwiritsa ntchito dalaivala wotani,
|
|
88
|
+
ndipo mosasamala kanthu kuti mutsegula caching ndi/kapena kubisa.
|
|
89
|
+
|
|
90
|
+
### Chithandizo cha oyendetsa
|
|
91
|
+
Madalaivala apano a Mobiletto:
|
|
92
|
+
* `s3` : Amazon S3
|
|
93
|
+
* `b2` : Backblaze B2
|
|
94
|
+
* `local` : file system yakomweko
|
|
95
|
+
|
|
96
|
+
*Zopereka zothandizira othandizira ambiri osungira mitambo ndizolandiridwa kwambiri!*
|
|
97
|
+
|
|
98
|
+
## mobiletto-cli
|
|
99
|
+
Mobiletto idapangidwa kuti igwiritsidwe ntchito ngati laibulale ndi ma code ena a JavaScript.
|
|
100
|
+
|
|
101
|
+
Kuti mugwire ntchito ndi mobiletto pamzere wolamula, gwiritsani ntchito [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
|
|
102
|
+
|
|
103
|
+
## Gwero
|
|
104
|
+
* [mobiletto pa GitHub](https://github.com/cobbzilla/mobiletto)
|
|
105
|
+
* [mobiletto pa npm](https://www.npmjs.com/package/mobiletto)
|
|
106
|
+
|
|
107
|
+
# Thandizo ndi Ndalama
|
|
108
|
+
Ndikuyesera kukhala katswiri wopanga mapulogalamu otseguka. Ndakhala ndikugwira ntchito ku
|
|
109
|
+
makampani opanga mapulogalamu kwa zaka zambiri, ndayambitsa makampani opambana ndikugulitsa kumakampani aboma.
|
|
110
|
+
Posachedwapa ndinachotsedwa ntchito, ndipo ndilibe ntchito ina iliyonse yotsatizana
|
|
111
|
+
|
|
112
|
+
Chifukwa chake ndiyesera kulemba mapulogalamu othandiza ndikuwona ngati izi zikugwira ntchito
|
|
113
|
+
|
|
114
|
+
Ngati mumakonda kugwiritsa ntchito pulogalamuyo, ndingayamikire kwambiri ngakhale
|
|
115
|
+
zing'onozing'ono [zopereka pamwezi kudzera pa Patreon](https://www.patreon.com/cobbzilla)
|
|
116
|
+
|
|
117
|
+
*Zikomo!*
|
|
118
|
+
|
|
119
|
+
## Kukhazikitsa
|
|
120
|
+
Ikani pogwiritsa ntchito `npm` kapena `yarn` . Mwina mukufuna mtundu wa `lite` womwe suphatikiza zonse
|
|
121
|
+
mafayilo omasulira a README:
|
|
122
|
+
|
|
123
|
+
npm install mobiletto-lite
|
|
124
|
+
yarn add mobiletto-lite
|
|
125
|
+
|
|
126
|
+
Ngati mukufunadi mafayilo a README m'zilankhulo zonse, yikani mtundu wonse:
|
|
127
|
+
|
|
128
|
+
npm install mobiletto
|
|
129
|
+
yarn add mobiletto
|
|
130
|
+
|
|
131
|
+
## Yambani Mwachangu
|
|
132
|
+
Chitsanzo chachidule chogwiritsa ntchito mobiletto `s3` driver.
|
|
133
|
+
|
|
134
|
+
Khodi iyi ingayende chimodzimodzi ngati dalaivala anali `b2` kapena `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
|
+
## Kugwiritsa ntchito Basic
|
|
165
|
+
Chitsanzo chowonjezereka, chosonyeza zambiri zomwe zimaperekedwa:
|
|
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
|
+
## Metadata
|
|
267
|
+
Lamulo la `metadata` limabweretsanso metadata yokhudza kulowa kwa fayilo imodzi.
|
|
268
|
+
Momwemonso, mtengo wobwerera kuchokera ku lamulo la `list` ndi mndandanda wazinthu za metadata.
|
|
269
|
+
|
|
270
|
+
Chinthu cha metadata chikuwoneka motere:
|
|
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
|
+
Katundu wa `type` ukhoza kukhala `file` , `dir` , `link` , kapena `special` .
|
|
281
|
+
|
|
282
|
+
Kutengera mtundu wa dalaivala, lamulo la `list` onse. The `name` ndi `type` katundu
|
|
283
|
+
ayenera kukhalapo nthawi zonse. Lamulo lotsatira la `metadata` lidzabwezera zonse zomwe zilipo.
|
|
284
|
+
|
|
285
|
+
## Njira ina yolowera
|
|
286
|
+
Lowetsani gawo lokhala ndi mawonekedwe onse ndikugwiritsa ntchito `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
|
+
##Kusunga
|
|
294
|
+
Mobiletto imagwira ntchito bwino ndi <a href="https://redis.io">redis</a> cache.
|
|
295
|
+
|
|
296
|
+
Mobiletto ayesa kulumikizana ndi chitsanzo cha redis pa 127.0.0.1:6379
|
|
297
|
+
|
|
298
|
+
Mutha kuchotsera chimodzi mwa izi:
|
|
299
|
+
* Khazikitsani env var ya `MOBILETTO_REDIS_HOST` , lumikizani pano m'malo mwa localhost
|
|
300
|
+
* Khazikitsani env var ya `MOBILETTO_REDIS_PORT` , dokoli lidzagwiritsidwa ntchito
|
|
301
|
+
|
|
302
|
+
Mobiletto idzasunga makiyi ake onse a redis ndi mawu oyamba `_mobiletto__` . Mutha kusintha izi
|
|
303
|
+
pokhazikitsa `MOBILETTO_REDIS_PREFIX` env var.
|
|
304
|
+
|
|
305
|
+
Mukhozanso kukhazikitsa posungira polumikizana ndi chinthu cha `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
|
+
### Simukufuna redis caching?
|
|
317
|
+
Kuti muyimitse: dutsani `othandizira `enabled: false` mu chinthu chanu cha `opts.redisConfig` kulumikizana kwanu.
|
|
318
|
+
|
|
319
|
+
Monga tafotokozera m'munsimu, kuletsa caching kumakhala ndi zotsatira zoyipa pakuchita bwino komanso kumabweretsa zopempha zambiri
|
|
320
|
+
posungira zomwe mukufunikiradi.
|
|
321
|
+
|
|
322
|
+
### Chitsogozo cha caching
|
|
323
|
+
**Kusungirako mwachinsinsi**: kuwerenga/kulemba kusungitsa kosungika kumachedwa pang'ono kusiyana ndi nthawi zonse,
|
|
324
|
+
koma kuyendayenda mozungulira (zomwe zinthu zina zimachita) ndizokwera mtengo. Kugwiritsa ntchito redis cache
|
|
325
|
+
zidzakupatsani chiwongola dzanja chachikulu.
|
|
326
|
+
|
|
327
|
+
Chosungira chosasinthika ndi chotetezeka, koma sichikuyenda bwino ngati muli ndi zambiri zolembera / kuchotsa.
|
|
328
|
+
Kulemba kapena kuchotsa ntchito kulikonse kumalepheretsa cache yonse, kuwonetsetsa kuti zowerenga zotsatila ziziwona
|
|
329
|
+
zosintha zaposachedwa.
|
|
330
|
+
|
|
331
|
+
### CLI zida
|
|
332
|
+
Ngati mukugwiritsa ntchito chida cha CLI ngati [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
|
|
333
|
+
mudzafuna kuti cache ya redis iyambike, chifukwa imapitilira kuyitanitsa kwa lamulo la `mo` .
|
|
334
|
+
|
|
335
|
+
##Kuwonetsa
|
|
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
|
+
Lamulo la `mirror` limapanga kukopera kamodzi kwamafayilo onse kuchokera pa mobiletto kupita kwina.
|
|
344
|
+
Sichiyendetsa njira iliyonse yosungira galasi pakapita nthawi. Thamangani lamulo la `mirror` kachiwiri
|
|
345
|
+
kulunzanitsa mafayilo aliwonse omwe akusowa.
|
|
346
|
+
|
|
347
|
+
Mtengo wobwerera kuchokera ku `mirror` ndi chinthu chosavuta chokhala ndi zowerengera za kuchuluka kwa mafayilo omwe adachita bwino
|
|
348
|
+
mirrored ndi kuchuluka kwa mafayilo omwe anali ndi zolakwika:
|
|
349
|
+
|
|
350
|
+
{
|
|
351
|
+
success: count-of-files-mirrored,
|
|
352
|
+
errors: count-of-files-with-errors
|
|
353
|
+
}
|
|
354
|
+
|
|
355
|
+
CHENJEZO: Kuyang'anira ma data akuluakulu kumatha kutenga nthawi komanso bandwidth
|
|
356
|
+
|
|
357
|
+
Ndi ma semantics oyimba a `mirror` nthawi zina zimakhala zosokoneza kumvetsetsa kuti ndani
|
|
358
|
+
wowerenga ndi amene analemba. Ingoganizirani ngati mawu a ntchito: "mobiletto yamanzere"
|
|
359
|
+
ndi chinthu chomwe chikuperekedwa (zojambula zojambulidwa), ndi "mobiletto yamanja" (the
|
|
360
|
+
Mtsutso wa njira ya `mirror` ) ndi mtengo womwe ukuperekedwa (zowerengera zawerengedwa).
|
|
361
|
+
|
|
362
|
+
## Transparent encryption
|
|
363
|
+
Yambitsani kubisa kwapambali kwa kasitomala:
|
|
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
|
+
Chikuchitikandi chiyani? Chikwatu chosiyana cha "directory entry" (dirent) (chobisika) chimatsata mafayilo omwe ali mmenemo
|
|
383
|
+
directory (aka dirent directory).
|
|
384
|
+
* Lamulo la `list` limawerenga mafayilo olowera, kutsitsa njira iliyonse yomwe yatchulidwa; kenako amabwezeretsa metadata pa fayilo iliyonse
|
|
385
|
+
* Malamulo a `list` , makamaka pamakanema okhala ndi mafayilo ambiri
|
|
386
|
+
* Lamulo la `write` limalemba mafayilo achinsinsi mu bukhu la kholo lililonse, mobwerezabwereza; kenako amalemba fayilo
|
|
387
|
+
* Malamulo `write` kuti O (N) alembe, ndi N = kuya muzowongolera
|
|
388
|
+
* Lamulo la `remove` limachotsa fayilo yofananira, ndipo kholo lake ngati ilibe kanthu, mobwerezabwereza; kenako amachotsa fayilo
|
|
389
|
+
* Malamulo osabwereza a `remove` kuti O(N) awerengedwe ndikuchotsa zambiri, ndi N = kuya muzowongolera
|
|
390
|
+
* Malamulo `remove` akulu ndi akuya amatha kukhala okwera mtengo
|
|
391
|
+
|
|
392
|
+
Zindikirani kuti ngakhale kubisa kwamakasitomala kumayatsidwa, mdani yemwe amawoneka bwino pa seva yanu yosungidwa
|
|
393
|
+
yosungirako, ngakhale popanda kiyi, amatha kuwona kuchuluka kwa maupangiri ndi kuchuluka kwa mafayilo omwe ali mumtundu uliwonse, komanso ndi
|
|
394
|
+
kuyesetsa pang'ono, pezani zina kapena zonse zadongosolo lachikwatu.
|
|
395
|
+
*Zindikirani: Gwiritsani ntchito mawonekedwe athyathyathya kuti mutetezeke bwino.
|
|
396
|
+
Mdaniyo sangadziwe mayina a zolemba / mafayilo pokhapokha atadziwanso kubisa kwanu
|
|
397
|
+
key kapena adasokoneza bwino kubisa. Mabetcha onse atha ndiye!
|
|
398
|
+
|
|
399
|
+
### Magwiridwe ndi caching
|
|
400
|
+
Ntchito zosungirako encrypted zitha kuchedwa. Zolemba zobwerezabwereza ndi zochotsa zimatha kuchedwa kwambiri.
|
|
401
|
+
Kusungirako kudzera pa redis kumathandiza kwambiri, koma dziwani kuti posungirayo imasinthidwa pazolemba zilizonse kapena kuchotsa.
|
|
402
|
+
|
|
403
|
+
## Kusintha kofunikira
|
|
404
|
+
Pangani mobiletto ndi kiyi yanu yatsopano, kenako ndikuwonetsa zomwe zilimo kale:
|
|
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
|
+
## Mawonekedwe oyendetsa
|
|
417
|
+
Dalaivala ndi fayilo iliyonse ya JS yomwe imatumiza ntchito ya 'storageClient' ndi siginecha iyi:
|
|
418
|
+
|
|
419
|
+
function storageClient (key, secret, opts)
|
|
420
|
+
|
|
421
|
+
* `key` : chingwe, kiyi yanu ya API (kwa oyendetsa `local` iyi ndiye chikwatu choyambira)
|
|
422
|
+
* `secret` : chingwe, chinsinsi cha API (chikhoza kusiyidwa kwa woyendetsa `local` )
|
|
423
|
+
* `opts` : chinthu, katundu ndi woyendetsa:
|
|
424
|
+
* Kwa `local` , katundu wa `fileMode` ndi `dirMode` zimatsimikizira momwe mafayilo atsopano ndi zolemba zimapangidwira
|
|
425
|
+
* Kwa `s3` , katundu wa `bucket` amafunikira. Zosankha zomwe mungasankhe ndi:
|
|
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
|
+
Chinthu chomwe ntchito yosungiraClient imabwerera iyenera kutanthauzira izi:
|
|
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
|
+
##Kudula mitengo
|
|
457
|
+
Mobiletto amagwiritsa ntchito laibulale yodula mitengo ya [winston](https://www.npmjs.com/package/winston).
|
|
458
|
+
|
|
459
|
+
Logs ** idzakhala ** idzakhala ndi njira zamafayilo ndi mauthenga olakwika, koma ** sichidzakhala ** ndi makiyi, zinsinsi,
|
|
460
|
+
kapena chidziwitso china chilichonse cholumikizira.
|
|
461
|
+
|
|
462
|
+
### Log level
|
|
463
|
+
Gwiritsani ntchito `MOBILETTO_LOG_LEVEL` kusintha kwa chilengedwe kuti muyike mulingo wa chipika, pogwiritsa ntchito imodzi
|
|
464
|
+
za milingo ya `npm` yofotokozedwa mu [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
|
|
465
|
+
|
|
466
|
+
Mulingo wokhazikika ndi `error` . Mulingo wa verbose kwambiri ndi `silly` , ngakhale pakali pano mobiletto
|
|
467
|
+
sichilowa m'munsimu `debug`
|
|
468
|
+
|
|
469
|
+
MOBILETTO_LOG_LEVEL=silly # maximum logs!
|
|
470
|
+
|
|
471
|
+
### Fayilo yaulere
|
|
472
|
+
Mwachikhazikitso, wodula mitengoyo amalembera ku console. Kuti mutumize malogo ku fayilo, ikani `MOBILETTO_LOG_FILE`
|
|
473
|
+
kusintha kwa chilengedwe. Mukalowa mufayilo, zipika sizidzalembedwanso ku console.
|
|
474
|
+
|
|
475
|
+
MOBILETTO_LOG_FILE=/var/my_mobiletto_log
|
|
476
|
+
|
|
477
|
+
Kuti muzimitsa kudula mitengo:
|
|
478
|
+
|
|
479
|
+
MOBILETTO_LOG_FILE=/dev/null
|
|
480
|
+
|
|
481
|
+
</pre>
|