mobiletto 1.2.1 → 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 -29
- package/test/api.spec.js +0 -512
- package/test/crypt.spec.js +0 -67
package/docs/pl/README.md
DELETED
|
@@ -1,481 +0,0 @@
|
|
|
1
|
-
Mobiletto
|
|
2
|
-
==========
|
|
3
|
-
|
|
4
|
-
Mobileetto to warstwa abstrakcji pamięci masowej JavaScript z opcjonalnym przezroczystym szyfrowaniem po stronie klienta.
|
|
5
|
-
|
|
6
|
-
# Zawartość
|
|
7
|
-
* [Dlaczego Mobiletto?](#Dlaczego Mobiletto?)
|
|
8
|
-
* [Szybki start](#Szybki start)
|
|
9
|
-
* [Mobiletto CLI](#mobiletto-cli)
|
|
10
|
-
* [Źródło](#Źródło)
|
|
11
|
-
* [Instalacja](#Instalacja)
|
|
12
|
-
* [Wsparcie i finansowanie](#Wsparcie i finansowanie)
|
|
13
|
-
* [Podstawowe zastosowanie](#Podstawowe użycie)
|
|
14
|
-
* [Metadane](#Metadane)
|
|
15
|
-
* [Alternatywny styl importu](#Alternatywny styl importu)
|
|
16
|
-
* [Buforowanie](#Buforowanie)
|
|
17
|
-
* [Odbicie lustrzane](#Odbicie lustrzane)
|
|
18
|
-
* [Przezroczyste szyfrowanie](#Transparent-encryption)
|
|
19
|
-
* [Rotacja klawiszy](# Rotacja klawiszy)
|
|
20
|
-
* [Interfejs sterownika](#Interfejs sterownika)
|
|
21
|
-
* [Logowanie](#Logowanie)
|
|
22
|
-
|
|
23
|
-
# Przeczytaj to w innym języku
|
|
24
|
-
Ten dokument README.md został przetłumaczony przez [hokeylization](https://github.com/cobbzilla/hokeylization) na
|
|
25
|
-
**[każdy język obsługiwany przez Tłumacza Google](https://cloud.google.com/translate/docs/languages)!**
|
|
26
|
-
|
|
27
|
-
Jestem pewien, że nie jest idealny, ale mam nadzieję, że to lepsze niż nic!
|
|
28
|
-
|
|
29
|
-
[🇸🇦 Arabski](../ar/README.md)
|
|
30
|
-
[🇧🇩 bengalski](../bn/README.md)
|
|
31
|
-
[🇩🇪 Niemiecki](../de/README.md)
|
|
32
|
-
[🇺🇸 Polski](../en/README.md)
|
|
33
|
-
[🇪🇸 Hiszpański](../es/README.md)
|
|
34
|
-
[🇫🇷 Francuski](../fr/README.md)
|
|
35
|
-
[🇹🇩 Hausa](../ha/README.md)
|
|
36
|
-
[🇮🇳 hindi](../hi/README.md)
|
|
37
|
-
[🇮🇩 Indonezyjski](../id/README.md)
|
|
38
|
-
[🇮🇹 Włoski](../it/README.md)
|
|
39
|
-
[🇯🇵 Japoński](../ja/README.md)
|
|
40
|
-
[🇰🇷 Koreański](../ko/README.md)
|
|
41
|
-
[🇮🇳 Marathi](../mr/README.md)
|
|
42
|
-
[🇵🇱 Polski](../pl/README.md)
|
|
43
|
-
[🇧🇷 Portugalski](../pt/README.md)
|
|
44
|
-
[🇷🇺 Rosyjski](../ru/README.md)
|
|
45
|
-
[🇰🇪 Suahili](../sw/README.md)
|
|
46
|
-
[🇵🇭 Tagalog](../tl/README.md)
|
|
47
|
-
[🇹🇷 Turecki](../tr/README.md)
|
|
48
|
-
[🇵🇰 Urdu](../ur/README.md)
|
|
49
|
-
[🇻🇳 Wietnamski](../vi/README.md)
|
|
50
|
-
[🇨🇳 chiński](../zh/README.md)
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
**[📚 ... Wszystkie języki ...](../README.md)**
|
|
54
|
-
----
|
|
55
|
-
|
|
56
|
-
### Czy jest jakiś problem z tym tłumaczeniem README?
|
|
57
|
-
To konkretne tłumaczenie oryginału [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
|
|
58
|
-
może być błędny -- *poprawki są mile widziane!* Wyślij [proszę o ściągnięcie na GitHub](https://github.com/cobbzilla/mobiletto/pulls),
|
|
59
|
-
lub jeśli nie czujesz się z tym komfortowo, [otwórz zgłoszenie](https://github.com/cobbzilla/mobiletto/issues)
|
|
60
|
-
|
|
61
|
-
Tworząc nowy problem na GitHubie dotyczący tłumaczenia, wykonaj następujące czynności:
|
|
62
|
-
* dołącz adres URL strony (skopiuj/wklej z paska adresu przeglądarki)
|
|
63
|
-
* dołącz dokładny tekst, który jest błędny (skopiuj/wklej z przeglądarki)
|
|
64
|
-
* proszę opisać co jest nie tak - czy tłumaczenie jest niepoprawne? czy formatowanie jest jakoś zepsute?
|
|
65
|
-
* uprzejmie zasugeruj lepsze tłumaczenie, czyli jak tekst powinien być odpowiednio sformatowany
|
|
66
|
-
* **Dziękuję Ci!**
|
|
67
|
-
|
|
68
|
-
## Dlaczego Mobiletto?
|
|
69
|
-
|
|
70
|
-
### Pożegnaj się z uzależnieniem od dostawcy!
|
|
71
|
-
Różni dostawcy przechowywania w chmurze mają niezgodne interfejsy API. Nawet ci, którzy dążą do „zgodności z S3”
|
|
72
|
-
mieć idiosynkratyczne zachowania.
|
|
73
|
-
|
|
74
|
-
Gdy wybierzesz konkretnego dostawcę pamięci masowej dla swojej aplikacji, jeśli kodujesz bezpośrednio do jego interfejsu API, Twoja aplikacja
|
|
75
|
-
jest teraz zależny od tej usługi. W miarę upływu czasu i kumulacji kodu, zmienianie dostawców staje się
|
|
76
|
-
coraz bardziej nie do utrzymania. Witamy w zabawnym świecie uzależnienia od dostawcy!
|
|
77
|
-
|
|
78
|
-
Mobiletto został zaprojektowany, aby rozwiązać ten problem. Kodując swoją aplikację do API mobiletto, możesz łatwo
|
|
79
|
-
zmień dostawców pamięci masowej i wiedz, że warstwa pamięci Twojej aplikacji będzie zachowywać się identycznie.
|
|
80
|
-
|
|
81
|
-
### Obszerne testy
|
|
82
|
-
Wszyscy kierowcy są testowani pod kątem identycznego zachowania z 60+ testami dla każdego kierowcy.
|
|
83
|
-
Testujemy wszystkich kierowców z każdą kombinacją:
|
|
84
|
-
* Szyfrowanie: zarówno włączone, jak i wyłączone
|
|
85
|
-
* Pamięć podręczna Redis: zarówno włączona, jak i wyłączona
|
|
86
|
-
|
|
87
|
-
Takie podejście daje nam pewność, że mobiletto będzie zachowywać się tak samo niezależnie od tego, z którego sterownika korzystasz,
|
|
88
|
-
i niezależnie od tego, czy włączysz buforowanie i/lub szyfrowanie.
|
|
89
|
-
|
|
90
|
-
### Wsparcie kierowcy
|
|
91
|
-
Aktualne sterowniki pamięci masowej Mobileto:
|
|
92
|
-
* `s3` : Amazon S3
|
|
93
|
-
* `b2` : Backblaze B2
|
|
94
|
-
* `local` : lokalny system plików
|
|
95
|
-
|
|
96
|
-
*Wkłady wspierające większą liczbę dostawców pamięci masowej w chmurze są bardzo mile widziane!*
|
|
97
|
-
|
|
98
|
-
## mobiletto-cli
|
|
99
|
-
Mobiletto ma być używany jako biblioteka przez inny kod JavaScript.
|
|
100
|
-
|
|
101
|
-
Aby pracować z mobiletto w wierszu poleceń, użyj [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
|
|
102
|
-
|
|
103
|
-
## Źródło
|
|
104
|
-
* [mobiletto na GitHubie](https://github.com/cobbzilla/mobiletto)
|
|
105
|
-
* [mobiletto na npm](https://www.npmjs.com/package/mobiletto)
|
|
106
|
-
|
|
107
|
-
## Wsparcie i finansowanie
|
|
108
|
-
Próbuję zostać profesjonalnym programistą open source. pracowałem w
|
|
109
|
-
od wielu lat w branży oprogramowania, zakładałem odnoszące sukcesy firmy i sprzedawałem je spółkom publicznym.
|
|
110
|
-
Ostatnio straciłam pracę i właściwie nie mam żadnej innej pracy w kolejce
|
|
111
|
-
|
|
112
|
-
Więc spróbuję napisać pomocne oprogramowanie i zobaczę, czy to działa
|
|
113
|
-
|
|
114
|
-
Jeśli lubisz korzystać z tego oprogramowania, byłbym bardzo wdzięczny nawet za
|
|
115
|
-
najmniejsza [miesięczna składka przez Patreon](https://www.patreon.com/cobbzilla)
|
|
116
|
-
|
|
117
|
-
*Dziękuję Ci!*
|
|
118
|
-
|
|
119
|
-
## Instalacja
|
|
120
|
-
Zainstaluj za pomocą `npm` lub `yarn` . Prawdopodobnie chcesz wersję `lite` , która nie zawiera wszystkich
|
|
121
|
-
przetłumaczone pliki README:
|
|
122
|
-
|
|
123
|
-
npm install mobiletto-lite
|
|
124
|
-
yarn add mobiletto-lite
|
|
125
|
-
|
|
126
|
-
Jeśli naprawdę chcesz mieć pliki README w każdym języku, zainstaluj pełną wersję:
|
|
127
|
-
|
|
128
|
-
npm install mobiletto
|
|
129
|
-
yarn add mobiletto
|
|
130
|
-
|
|
131
|
-
## Szybki start
|
|
132
|
-
Krótki przykład użycia sterownika `s3` .
|
|
133
|
-
|
|
134
|
-
Ten kod działałby tak samo, gdyby sterownik był `b2` lub `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
|
-
## Podstawowe zastosowanie
|
|
165
|
-
O wiele bardziej rozbudowany przykład, pokazujący większość oferowanych funkcji:
|
|
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
|
-
## Metadane
|
|
267
|
-
Polecenie `metadata` zwraca metadane dotyczące pojedynczego wpisu w systemie plików.
|
|
268
|
-
Podobnie wartość zwracana przez polecenie `list` jest tablicą obiektów metadanych.
|
|
269
|
-
|
|
270
|
-
Obiekt metadanych wygląda tak:
|
|
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
|
-
Właściwość `type` type` może mieć `file` , `dir` , `link` lub `special` .
|
|
281
|
-
|
|
282
|
-
W zależności od typu sterownika, polecenie `list` może nie zwracać wszystkich pól. Właściwości `name` i `type`
|
|
283
|
-
powinien być zawsze obecny. Kolejne polecenie `metadata` zwróci wszystkie dostępne właściwości.
|
|
284
|
-
|
|
285
|
-
## Alternatywny styl importu
|
|
286
|
-
Zaimportuj moduł o pełnym zakresie i użyj funkcji `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
|
-
## Buforowanie
|
|
294
|
-
Mobiletto działa najlepiej z pamięcią podręczną <a href="https://redis.io">redis</a> .
|
|
295
|
-
|
|
296
|
-
Mobiletto spróbuje połączyć się z instancją redis na 127.0.0.1:6379
|
|
297
|
-
|
|
298
|
-
Możesz zastąpić jedno z tych:
|
|
299
|
-
* Ustaw `MOBILETTO_REDIS_HOST` env var, mobilet, aby połączyć się tutaj zamiast localhost
|
|
300
|
-
* Ustaw zmienną env `MOBILETTO_REDIS_PORT` , ten port będzie używany
|
|
301
|
-
|
|
302
|
-
Mobiletto będzie przechowywać wszystkie swoje klucze redis z prefiksem `_mobiletto__` . Możesz to zmienić
|
|
303
|
-
ustawiając `MOBILETTO_REDIS_PREFIX` env var.
|
|
304
|
-
|
|
305
|
-
Możesz także ustawić buforowanie dla poszczególnych połączeń za pomocą obiektu `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
|
-
### Nie chcesz buforować redis?
|
|
317
|
-
Aby wyłączyć: `enabled: false` w swoim obiekcie `opts.redisConfig` podczas nawiązywania połączenia.
|
|
318
|
-
|
|
319
|
-
Jak omówiono poniżej, wyłączenie buforowania będzie miało negatywny wpływ na wydajność i spowoduje zwiększenie liczby żądań
|
|
320
|
-
do przechowywania, którego naprawdę potrzebujesz.
|
|
321
|
-
|
|
322
|
-
### Wskazówki dotyczące buforowania
|
|
323
|
-
**Zaszyfrowana pamięć**: odczyt/zapis zaszyfrowanej pamięci jest tylko trochę wolniejszy niż normalnie,
|
|
324
|
-
ale poruszanie się po katalogach (co robią niektóre rzeczy) jest dość drogie. Korzystanie z pamięci podręcznej redis
|
|
325
|
-
zapewni Ci znaczny wzrost wydajności.
|
|
326
|
-
|
|
327
|
-
Domyślna pamięć podręczna jest bezpieczna, ale nie działa dobrze, jeśli masz dużo operacji zapisu/usuwania.
|
|
328
|
-
Każda operacja zapisu lub usunięcia unieważnia całą pamięć podręczną, zapewniając, że kolejne odczyty zobaczą
|
|
329
|
-
najnowsze zmiany.
|
|
330
|
-
|
|
331
|
-
### Narzędzia CLI
|
|
332
|
-
Jeśli używasz narzędzia CLI, takiego jak [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
|
|
333
|
-
na pewno będziesz chciał, aby pamięć podręczna redis była włączona, ponieważ działa ona podczas wywołań polecenia `mo` .
|
|
334
|
-
|
|
335
|
-
## Dublowanie
|
|
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
|
-
Polecenie `mirror` wykonuje jednorazową kopię wszystkich plików z jednego telefonu komórkowego do drugiego.
|
|
344
|
-
Nie uruchamia żadnego procesu utrzymywania lustra w czasie. Uruchom ponownie polecenie `mirror`
|
|
345
|
-
aby zsynchronizować brakujące pliki.
|
|
346
|
-
|
|
347
|
-
Wartość zwracana z `mirror` to prosty obiekt z licznikami liczby plików pomyślnie
|
|
348
|
-
dublowane i ile plików zawierało błędy:
|
|
349
|
-
|
|
350
|
-
{
|
|
351
|
-
success: count-of-files-mirrored,
|
|
352
|
-
errors: count-of-files-with-errors
|
|
353
|
-
}
|
|
354
|
-
|
|
355
|
-
OSTRZEŻENIE: Dublowanie dużych zestawów danych może być bardzo czasochłonne i wymagające dużej przepustowości
|
|
356
|
-
|
|
357
|
-
W przypadku semantyki wywołania `mirror` czasami może być mylące, aby zrozumieć, kto jest
|
|
358
|
-
czytelnik i kto jest pisarzem. Wyobraź to sobie jak instrukcję przypisania: „lewa ręka mobiletto”
|
|
359
|
-
to rzecz, do której jest przypisywana (zapisywane dane lustrzane), a „prawostronne mobiletto” (
|
|
360
|
-
argumentem metody `mirror` ) jest przypisywana wartość (odczytywane są lustrzane dane).
|
|
361
|
-
|
|
362
|
-
## Szyfrowanie przejrzyste
|
|
363
|
-
Włącz przezroczyste szyfrowanie po stronie klienta:
|
|
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
|
-
Co się dzieje? Oddzielny "wpis do katalogu" (bezpośredni) (zaszyfrowany) śledzi, jakie pliki się w nim znajdują
|
|
383
|
-
katalog (aka katalog bezpośredni).
|
|
384
|
-
* Polecenie `list` odczytuje pliki wpisów do katalogu, odszyfrowuje każdą z wymienionych ścieżek; następnie zwraca metadane dla każdego pliku
|
|
385
|
-
* Polecenia `list` są bardziej nieefektywne, szczególnie w przypadku katalogów z dużą liczbą plików
|
|
386
|
-
* Polecenie `write` zapisuje rekursywnie pliki dirent w katalogach dirent każdego rodzica; następnie zapisuje plik
|
|
387
|
-
* Polecenia `write` spowodują O(N) zapisów, gdzie N = głębokość w hierarchii katalogów
|
|
388
|
-
* Polecenie `remove` usuwa odpowiedni plik dirent i jego rodzica, jeśli jest pusty, rekursywnie; następnie usuwa plik
|
|
389
|
-
* Nierekurencyjne polecenia `remove` spowodują O(N) odczyty i potencjalnie tyle samo usunięć, przy N = głębokość w hierarchii katalogów
|
|
390
|
-
* Rekurencyjne polecenia `remove` na dużych i głębokich systemach plików mogą być kosztowne
|
|
391
|
-
|
|
392
|
-
Pamiętaj, że nawet przy włączonym szyfrowaniu po stronie klienta przeciwnik ma pełny wgląd w zaszyfrowaną stronę serwera
|
|
393
|
-
pamięć masowa, nawet bez klucza, nadal może zobaczyć łączną liczbę katalogów i liczbę plików w każdym, a także z
|
|
394
|
-
trochę wysiłku, odkryć część lub całość ogólnej struktury hierarchii katalogów.
|
|
395
|
-
*Uwaga: użyj stosunkowo płaskiej konstrukcji, aby zapewnić lepsze bezpieczeństwo.*
|
|
396
|
-
Przeciwnik nie znałby nazw katalogów/plików, chyba że znałby również twoje szyfrowanie
|
|
397
|
-
klucz lub w inny sposób pomyślnie złamał szyfrowanie. W takim razie wszystkie zakłady są przegrane!
|
|
398
|
-
|
|
399
|
-
### Wydajność i buforowanie
|
|
400
|
-
Operacje na zaszyfrowanym magazynie mogą być powolne. Rekursywne aukcje i usuwanie mogą być bardzo powolne.
|
|
401
|
-
Buforowanie przez redis ogromnie pomaga, ale pamiętaj, że pamięć podręczna jest opróżniana po każdym zapisie lub usunięciu.
|
|
402
|
-
|
|
403
|
-
## Rotacja klawiszy
|
|
404
|
-
Utwórz mobiletto z nowym kluczem, a następnie odtwórz w nim stare dane:
|
|
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 sterownika
|
|
417
|
-
Sterownik to dowolny plik JS, który eksportuje funkcję „storageClient” o tej sygnaturze:
|
|
418
|
-
|
|
419
|
-
function storageClient (key, secret, opts)
|
|
420
|
-
|
|
421
|
-
* `key` : ciąg, klucz API (dla sterownika `local` jest to katalog podstawowy)
|
|
422
|
-
* `secret` : ciąg znaków, twój sekret API (może być pominięty dla sterownika `local` )
|
|
423
|
-
* `opts` : obiekt, właściwości są przypisane do sterownika:
|
|
424
|
-
* W przypadku `local` właściwości `fileMode` i `dirMode` określają sposób tworzenia nowych plików i katalogów
|
|
425
|
-
* W przypadku `s3` wymagana jest właściwość `bucket` . Opcjonalne właściwości to:
|
|
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
|
-
Obiekt, który zwraca funkcja storageClient, musi definiować te funkcje:
|
|
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
|
-
## Logowanie
|
|
457
|
-
Mobiletto korzysta z biblioteki logowania [winston](https://www.npmjs.com/package/winston).
|
|
458
|
-
|
|
459
|
-
Dzienniki **będą** zawierać ścieżki do plików i komunikaty o błędach, ale **nigdy** nie będą zawierać kluczy, sekretów,
|
|
460
|
-
lub jakiekolwiek inne informacje o konfiguracji połączenia.
|
|
461
|
-
|
|
462
|
-
### Poziom dziennika
|
|
463
|
-
Użyj zmiennej środowiskowej `MOBILETTO_LOG_LEVEL` , aby ustawić poziom rejestrowania, używając jednego
|
|
464
|
-
poziomów `npm` zdefiniowanych w [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
|
|
465
|
-
|
|
466
|
-
Domyślny poziom to `error` . Najbardziej gadatliwym poziomem jest `silly` , chociaż obecnie mobiletto
|
|
467
|
-
nie loguje się na poziomach poniżej `debug`
|
|
468
|
-
|
|
469
|
-
MOBILETTO_LOG_LEVEL=silly # maximum logs!
|
|
470
|
-
|
|
471
|
-
### Plik dziennika
|
|
472
|
-
Rejestrator domyślnie zapisuje w konsoli. Aby wysłać logi do pliku, ustaw `MOBILETTO_LOG_FILE`
|
|
473
|
-
Zmienna środowiskowa. Podczas logowania do pliku dzienniki nie będą już zapisywane w konsoli.
|
|
474
|
-
|
|
475
|
-
MOBILETTO_LOG_FILE=/var/my_mobiletto_log
|
|
476
|
-
|
|
477
|
-
Aby wyłączyć rejestrowanie:
|
|
478
|
-
|
|
479
|
-
MOBILETTO_LOG_FILE=/dev/null
|
|
480
|
-
|
|
481
|
-
</pre>
|