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 on JavaScript-tallennuskerros, jossa on valinnainen läpinäkyvä asiakaspuolen salaus.
|
|
5
|
+
|
|
6
|
+
# Sisältö
|
|
7
|
+
* [Miksi Mobiletto?](#Miksi-Mobiletto?)
|
|
8
|
+
* [Pika-aloitus](#Pika-aloitus)
|
|
9
|
+
* [Mobiletto CLI](#mobiletto-cli)
|
|
10
|
+
* [Lähde](#Source)
|
|
11
|
+
* [Asennus](#Asennus)
|
|
12
|
+
* [Tuki ja rahoitus](#Support-and-Funding)
|
|
13
|
+
* [Peruskäyttö](#Peruskäyttö)
|
|
14
|
+
* [Metatiedot](#Metadata)
|
|
15
|
+
* [Vaihtoehtoinen tuontityyli](#Alternate-import-style)
|
|
16
|
+
* [Välimuisti](#Caching)
|
|
17
|
+
* [peilaus](#peilaus)
|
|
18
|
+
* [Läpinäkyvä salaus](#Transparent-encryption)
|
|
19
|
+
* [Key-rotation](#Key-rotation)
|
|
20
|
+
* [Driver interface](#Driver-interface)
|
|
21
|
+
* [Kirjaus](#Logging)
|
|
22
|
+
|
|
23
|
+
# Lue tämä toisella kielellä
|
|
24
|
+
Tämä README.md-dokumentti on käännetty [hokeylization]:n (https://github.com/cobbzilla/hokeylization) kautta kielelle
|
|
25
|
+
**[kaikki Google-kääntäjän tukemat kielet](https://cloud.google.com/translate/docs/languages)!**
|
|
26
|
+
|
|
27
|
+
Olen varma, että se ei ole täydellinen, mutta toivon, että se on parempi kuin ei mitään!
|
|
28
|
+
|
|
29
|
+
[🇸🇦 arabia](../ar/README.md)
|
|
30
|
+
[🇧🇩 Bengali](../bn/README.md)
|
|
31
|
+
[🇩🇪 saksaksi](../de/README.md)
|
|
32
|
+
[🇺🇸 englanti](../en/README.md)
|
|
33
|
+
[🇪🇸 espanja](../es/README.md)
|
|
34
|
+
[🇫🇷 ranska](../fr/README.md)
|
|
35
|
+
[🇹🇩 Hausa](../ha/README.md)
|
|
36
|
+
[🇮🇳 Hindi](../hi/README.md)
|
|
37
|
+
[🇮🇩 indonesia](../id/README.md)
|
|
38
|
+
[🇮🇹 italia](../it/README.md)
|
|
39
|
+
[🇯🇵 japani](../ja/README.md)
|
|
40
|
+
[🇰🇷 korea](../ko/README.md)
|
|
41
|
+
[🇮🇳 Maranthi](../mr/README.md)
|
|
42
|
+
[🇵🇱 puola](../pl/README.md)
|
|
43
|
+
[🇧🇷 portugali](../pt/README.md)
|
|
44
|
+
[🇷🇺 venäjä](../ru/README.md)
|
|
45
|
+
[🇰🇪 swahili](../sw/README.md)
|
|
46
|
+
[🇵🇭 Tagalog](../tl/README.md)
|
|
47
|
+
[🇹🇷 turkki](../tr/README.md)
|
|
48
|
+
[🇵🇰 Urdu](../ur/README.md)
|
|
49
|
+
[🇻🇳 vietnam](../vi/README.md)
|
|
50
|
+
[🇨🇳 kiina](../zh/README.md)
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
**[📚 ... Kaikki kielet ...](../README.md)**
|
|
54
|
+
----
|
|
55
|
+
|
|
56
|
+
### Onko tässä README-käännöksessä ongelma?
|
|
57
|
+
Tämä käännös alkuperäisestä [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
|
|
58
|
+
voi olla virheellinen -- *korjaukset ovat erittäin tervetulleita!* Lähetä [pull-pyyntö GitHubissa](https://github.com/cobbzilla/mobiletto/pulls),
|
|
59
|
+
tai jos et halua tehdä niin, [avaa ongelma](https://github.com/cobbzilla/mobiletto/issues)
|
|
60
|
+
|
|
61
|
+
Kun luot uuden GitHub-ongelman käännöksestä, toimi seuraavasti:
|
|
62
|
+
* sisällytä sivun URL-osoite (kopioi/liitä selaimen osoiteriviltä)
|
|
63
|
+
* sisällytä täsmällinen virheellinen teksti (kopioi/liitä selaimesta)
|
|
64
|
+
* kuvaile mikä on vialla -- onko käännös virheellinen? onko muotoilu rikki jotenkin?
|
|
65
|
+
* Ehdota ystävällisesti parempaa käännöstä tai tekstin oikeaa muotoilua
|
|
66
|
+
* **Kiitos!**
|
|
67
|
+
|
|
68
|
+
## Miksi Mobiletto?
|
|
69
|
+
|
|
70
|
+
### Hyvästi myyjän lukitus!
|
|
71
|
+
Eri pilvitallennuspalvelujen tarjoajilla on yhteensopimattomia sovellusliittymiä. Jopa ne, jotka tavoittelevat "S3-yhteensopivuutta"
|
|
72
|
+
on omalaatuista käyttäytymistä.
|
|
73
|
+
|
|
74
|
+
Kun valitset sovelluksellesi tietyn tallennustilan toimittajan, jos koodaat suoraan heidän sovellusliittymään, sovelluksesi
|
|
75
|
+
on nyt riippuvainen kyseisestä palvelusta. Ajan myötä ja koodia kertyy, vaihtuvia myyjiä tulee
|
|
76
|
+
yhä kestämättömämpi. Tervetuloa myyjän lukituksen hauskaan maailmaan!
|
|
77
|
+
|
|
78
|
+
Mobiletto on suunniteltu ratkaisemaan tämä ongelma. Koodaamalla sovelluksesi mobiletton sovellusliittymään, voit helposti
|
|
79
|
+
vaihda tallennuspalveluntarjoajaa ja tiedä, että sovelluksesi tallennuskerros toimii samalla tavalla.
|
|
80
|
+
|
|
81
|
+
### Laaja testaus
|
|
82
|
+
Kaikki kuljettajat testataan identtisen käyttäytymisen suhteen yli 60 testillä jokaiselle kuljettajalle.
|
|
83
|
+
Testaamme kaikki ajurit kaikilla seuraavien yhdistelmillä:
|
|
84
|
+
* Salaus: sekä käytössä että poissa käytöstä
|
|
85
|
+
* Redis-välimuisti: sekä käytössä että poissa käytöstä
|
|
86
|
+
|
|
87
|
+
Tämä lähestymistapa antaa meille mielenrauhan, että mobiletto toimii samalla tavalla riippumatta siitä, mitä ajuria käytät,
|
|
88
|
+
ja riippumatta siitä, otatko välimuistin ja/tai salauksen käyttöön.
|
|
89
|
+
|
|
90
|
+
### Ohjaintuki
|
|
91
|
+
Nykyiset Mobiletto-tallennusohjaimet:
|
|
92
|
+
* `s3` : Amazon S3
|
|
93
|
+
* `b2` : Backblaze B2
|
|
94
|
+
* `local` : paikallinen tiedostojärjestelmä
|
|
95
|
+
|
|
96
|
+
*Otamme mielellämme vastaan lisää pilvitallennuspalvelujen tarjoajia!*
|
|
97
|
+
|
|
98
|
+
## mobiletto-cli
|
|
99
|
+
Mobiletto on tarkoitettu käytettäväksi muun JavaScript-koodin kirjastona.
|
|
100
|
+
|
|
101
|
+
Jos haluat työskennellä mobiletton kanssa komentorivillä, käytä [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
|
|
102
|
+
|
|
103
|
+
## Lähde
|
|
104
|
+
* [mobiletto GitHubissa](https://github.com/cobbzilla/mobiletto)
|
|
105
|
+
* [mobiletto on npm](https://www.npmjs.com/package/mobiletto)
|
|
106
|
+
|
|
107
|
+
## Tuki ja rahoitus
|
|
108
|
+
Yritän olla ammattimainen avoimen lähdekoodin ohjelmistokehittäjä. Olen ollut töissä
|
|
109
|
+
Ohjelmistoteollisuudessa useiden vuosien ajan, olen perustanut menestyviä yrityksiä ja myynyt niitä julkisille yrityksille.
|
|
110
|
+
Menetin hiljattain työpaikkani, eikä minulla oikeastaan ole muita töitä
|
|
111
|
+
|
|
112
|
+
Joten yritän kirjoittaa hyödyllisiä ohjelmistoja ja katsoa, toimiiko se
|
|
113
|
+
|
|
114
|
+
Jos pidät tämän ohjelmiston käyttämisestä, olisin erittäin kiitollinen jopa
|
|
115
|
+
pienin [kuukausimaksu Patreonin kautta](https://www.patreon.com/cobbzilla)
|
|
116
|
+
|
|
117
|
+
*Kiitos!*
|
|
118
|
+
|
|
119
|
+
## Asennus
|
|
120
|
+
Asenna käyttämällä `npm` tai `yarn` . Haluat luultavasti `lite` version, joka ei sisällä kaikkia
|
|
121
|
+
käännetyt README-tiedostot:
|
|
122
|
+
|
|
123
|
+
npm install mobiletto-lite
|
|
124
|
+
yarn add mobiletto-lite
|
|
125
|
+
|
|
126
|
+
Jos todella haluat README-tiedostot kaikilla kielillä, asenna täysi versio:
|
|
127
|
+
|
|
128
|
+
npm install mobiletto
|
|
129
|
+
yarn add mobiletto
|
|
130
|
+
|
|
131
|
+
## Pika-aloitus
|
|
132
|
+
Lyhyt esimerkki mobiletto `s3` -ohjaimesta.
|
|
133
|
+
|
|
134
|
+
Tämä koodi toimisi samoin, jos ohjain olisi `b2` tai `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
|
+
## Peruskäyttö
|
|
165
|
+
Paljon laajempi esimerkki, jossa näkyy suurin osa tarjotuista ominaisuuksista:
|
|
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
|
+
## Metatiedot
|
|
267
|
+
`metadata` -komento palauttaa yhden tiedostojärjestelmän merkinnän metatiedot.
|
|
268
|
+
Samoin `list` -komennon palautusarvo on joukko metatieto-objekteja.
|
|
269
|
+
|
|
270
|
+
Metatietoobjekti näyttää tältä:
|
|
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
|
+
Tyyppi-ominaisuus voi olla `type` `file` " , `dir` " , "link `link` tai `special` .
|
|
281
|
+
|
|
282
|
+
Ohjaimen tyypistä riippuen `list` -komento ei välttämättä palauta kaikkia kenttiä. `name` ja "tyyppi `type` .
|
|
283
|
+
tulee aina olla läsnä. Seuraava `metadata` -komento palauttaa kaikki käytettävissä olevat ominaisuudet.
|
|
284
|
+
|
|
285
|
+
## Vaihtoehtoinen tuontityyli
|
|
286
|
+
Tuo täysin kattava moduuli ja käytä `connect` -toimintoa:
|
|
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
|
+
## Välimuisti
|
|
294
|
+
Mobiletto toimii parhaiten <a href="https://redis.io">redis-</a> välimuistin kanssa.
|
|
295
|
+
|
|
296
|
+
Mobiletto yrittää muodostaa yhteyden redis-instanssiin osoitteessa 127.0.0.1:6379
|
|
297
|
+
|
|
298
|
+
Voit ohittaa jommankumman seuraavista:
|
|
299
|
+
* Aseta `MOBILETTO_REDIS_HOST` env var, mobile yhdistämään tähän paikallispalvelimen sijaan
|
|
300
|
+
* Aseta `MOBILETTO_REDIS_PORT` env var, tätä porttia käytetään
|
|
301
|
+
|
|
302
|
+
Mobiletto tallentaa kaikki redis-avaimensa etuliitteellä `_mobiletto__` . Voit muuttaa tätä
|
|
303
|
+
asettamalla `MOBILETTO_REDIS_PREFIX` env var.
|
|
304
|
+
|
|
305
|
+
Voit myös määrittää yhteyskohtaisen välimuistin `opts.redisConfig` -objektilla:
|
|
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
|
+
### Etkö halua tallentaa uudelleen välimuistiin?
|
|
317
|
+
Poistaminen käytöstä `enabled: false` `opts.redisConfig` -objektiin, kun muodostat yhteyden.
|
|
318
|
+
|
|
319
|
+
Kuten alla kerrotaan, välimuistin poistaminen käytöstä vaikuttaa haitallisesti suorituskykyyn ja lisää pyyntöjä
|
|
320
|
+
varastointiin, jota todella tarvitset.
|
|
321
|
+
|
|
322
|
+
### Välimuistin tallennuksen opas
|
|
323
|
+
**Salattu tallennus**: salatun tallennustilan lukeminen/kirjoittaminen on vain hieman normaalia hitaampaa,
|
|
324
|
+
mutta hakemistoissa liikkuminen (jota jotkut asiat tekevät) on melko kallista. Redis-välimuistin käyttäminen
|
|
325
|
+
antaa sinulle merkittävän suorituskyvyn lisäyksen.
|
|
326
|
+
|
|
327
|
+
Oletusvälimuisti on turvallinen, mutta se ei toimi hyvin, jos sinulla on paljon kirjoitus-/poistotoimintoja.
|
|
328
|
+
Mikä tahansa kirjoitus- tai poistotoiminto mitätöi koko välimuistin, mikä varmistaa, että myöhemmissä lukemissa
|
|
329
|
+
viimeisimmät muutokset.
|
|
330
|
+
|
|
331
|
+
### CLI-työkalut
|
|
332
|
+
Jos käytät CLI-työkalua, kuten [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
|
|
333
|
+
Redis-välimuistin tulee ehdottomasti olla käytössä, koska se kestää mo-komennon `mo` .
|
|
334
|
+
|
|
335
|
+
## Peilaus
|
|
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
|
+
`mirror` suorittaa kertakopion kaikista tiedostoista mobiililaitteesta toiseen.
|
|
344
|
+
Se ei suorita mitään prosessia peilin ylläpitämiseksi ajan mittaan. Suorita `mirror` uudelleen
|
|
345
|
+
synkronoidaksesi puuttuvat tiedostot.
|
|
346
|
+
|
|
347
|
+
`mirror` on yksinkertainen objekti, jossa on laskurit siitä, kuinka monta tiedostoa onnistui
|
|
348
|
+
peilattu ja kuinka monessa tiedostossa oli virheitä:
|
|
349
|
+
|
|
350
|
+
{
|
|
351
|
+
success: count-of-files-mirrored,
|
|
352
|
+
errors: count-of-files-with-errors
|
|
353
|
+
}
|
|
354
|
+
|
|
355
|
+
VAROITUS: Suurten tietojoukkojen peilaus voi olla hyvin aikaa vievää ja kaistanleveyttä vaativaa
|
|
356
|
+
|
|
357
|
+
`mirror` semantiikan avulla voi joskus olla hämmentävää ymmärtää, kuka on
|
|
358
|
+
lukija ja kuka on kirjoittaja. Kuvittele se tehtävälausekkeena: "vasen kännykkä"
|
|
359
|
+
on kohde, jolle osoitetaan (kirjoitettu peilattu data) ja "oikea kännykkä" (
|
|
360
|
+
argumentti `mirror` -menetelmälle) on arvo, jota annetaan (peilattua dataa luetaan).
|
|
361
|
+
|
|
362
|
+
## Läpinäkyvä salaus
|
|
363
|
+
Ota läpinäkyvä asiakaspuolen salaus käyttöön:
|
|
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
|
+
Mitä tapahtuu? Erillinen "hakemistomerkintä" (dirent) hakemisto (salattu) seuraa, mitä tiedostoja siinä on
|
|
383
|
+
hakemisto (alias dirent hakemisto).
|
|
384
|
+
* `list` -komento lukee hakemiston syöttötiedostot, purkaa jokaisen luettelossa olevan polun; palauttaa sitten kunkin tiedoston metatiedot
|
|
385
|
+
* `list` -komennot ovat tehottomia, varsinkin hakemistoissa, joissa on paljon tiedostoja
|
|
386
|
+
* `write` komento kirjoittaa eri tiedostot kunkin vanhemman dirent-hakemistoon rekursiivisesti; sitten kirjoittaa tiedoston
|
|
387
|
+
* `write` komennot aiheuttavat O(N) kirjoitusta, jolloin N = syvyys hakemistohierarkiassa
|
|
388
|
+
* `remove` -komento poistaa vastaavan dirent-tiedoston ja sen ylätason, jos se on tyhjä, rekursiivisesti; poistaa sitten tiedoston
|
|
389
|
+
* Ei-rekursiiviset `remove` -komennot vaativat O(N) lukua ja mahdollisesti yhtä monta poistoa, jolloin N = syvyys hakemistohierarkiassa
|
|
390
|
+
* Rekursiiviset `remove` " suurissa ja syvällisissä tiedostojärjestelmissä voivat olla kalliita
|
|
391
|
+
|
|
392
|
+
Huomaa, että vaikka asiakaspuolen salaus olisi käytössä, vastustaja, jolla on täysi näkyvyys salatulle palvelinpuolelle
|
|
393
|
+
tallennustila, jopa ilman avainta, voi silti nähdä hakemistojen kokonaismäärän ja kuinka monta tiedostoa kussakin on
|
|
394
|
+
jonkin verran vaivaa, löytää hakemistohierarkian yleinen rakenne tai osa siitä.
|
|
395
|
+
*Huomaa: Käytä suhteellisen tasaista rakennetta parantaaksesi turvallisuutta.*
|
|
396
|
+
Vastustaja ei tietäisi hakemistojen/tiedostojen nimiä ellei he tietäisi myös salaustasi
|
|
397
|
+
avaimella tai oli muuten onnistuneesti murtanut salauksen. Silloin kaikki vedot ovat poissa!
|
|
398
|
+
|
|
399
|
+
### Suorituskyky ja välimuisti
|
|
400
|
+
Salatun tallennustilan toiminta voi olla hidasta. Rekursiiviset listaukset ja poistot voivat olla hyvin hidasta.
|
|
401
|
+
Välimuistin tallentaminen rediksen kautta auttaa valtavasti, mutta huomaa, että välimuisti tyhjennetään kirjoittamisen tai poistamisen yhteydessä.
|
|
402
|
+
|
|
403
|
+
## Avaimen kierto
|
|
404
|
+
Luo matkapuhelin uudella avaimellasi ja peilaa sitten vanhat tiedot siihen:
|
|
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
|
+
## Ohjaimen käyttöliittymä
|
|
417
|
+
Ohjain on mikä tahansa JS-tiedosto, joka vie "storageClient"-funktion tällä allekirjoituksella:
|
|
418
|
+
|
|
419
|
+
function storageClient (key, secret, opts)
|
|
420
|
+
|
|
421
|
+
* `key` : merkkijono, API-avain (paikalliselle ohjaimelle tämä on `local` )
|
|
422
|
+
* `secret` : merkkijono, API-salaisuus (voidaan jättää pois `local` ohjaimesta)
|
|
423
|
+
* `opts` : objekti, jonka ominaisuudet ovat kuljettajakohtaisia:
|
|
424
|
+
* `local` `fileMode` ja `dirMode` määrittävät kuinka uudet luontitiedostot ja hakemistot luodaan
|
|
425
|
+
* `s3` `bucket` vaaditaan "bucket"-ominaisuus. Valinnaiset ominaisuudet ovat:
|
|
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
|
+
Objektin, jonka storageClient-funktio palauttaa, on määritettävä seuraavat funktiot:
|
|
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
|
+
## Kirjaaminen
|
|
457
|
+
Mobiletto käyttää [winston](https://www.npmjs.com/package/winston) lokikirjastoa.
|
|
458
|
+
|
|
459
|
+
Lokit **sisältävät** tiedostopolut ja virheilmoitukset, mutta **eivät koskaan** sisällä avaimia, salaisuuksia,
|
|
460
|
+
tai muita yhteyden määritystietoja.
|
|
461
|
+
|
|
462
|
+
### Lokin taso
|
|
463
|
+
Käytä `MOBILETTO_LOG_LEVEL` ympäristömuuttujaa lokitason asettamiseen käyttämällä yhtä
|
|
464
|
+
`npm` tasoista, jotka on määritelty osoitteessa [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
|
|
465
|
+
|
|
466
|
+
Oletustaso on `error` . Monisanaisin taso on `silly` , vaikkakin tällä hetkellä mobiletto
|
|
467
|
+
ei kirjaudu `debug` alapuolelle
|
|
468
|
+
|
|
469
|
+
MOBILETTO_LOG_LEVEL=silly # maximum logs!
|
|
470
|
+
|
|
471
|
+
### Loki tiedosto
|
|
472
|
+
Oletusarvoisesti loggeri kirjoittaa konsoliin. Jos haluat lähettää lokit tiedostoon, aseta `MOBILETTO_LOG_FILE`
|
|
473
|
+
ympäristömuuttuja. Kun kirjaudut tiedostoon, lokeja ei enää kirjoiteta konsoliin.
|
|
474
|
+
|
|
475
|
+
MOBILETTO_LOG_FILE=/var/my_mobiletto_log
|
|
476
|
+
|
|
477
|
+
Lokikirjauksen poistaminen käytöstä:
|
|
478
|
+
|
|
479
|
+
MOBILETTO_LOG_FILE=/dev/null
|
|
480
|
+
|
|
481
|
+
</pre>
|