mobiletto 1.1.8 → 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.
Files changed (117) hide show
  1. package/README.md +56 -4
  2. package/docs/README.md +113 -0
  3. package/docs/af/README.md +455 -0
  4. package/docs/am/README.md +455 -0
  5. package/docs/ar/README.md +455 -0
  6. package/docs/az/README.md +455 -0
  7. package/docs/be/README.md +455 -0
  8. package/docs/bg/README.md +455 -0
  9. package/docs/bn/README.md +455 -0
  10. package/docs/bs/README.md +455 -0
  11. package/docs/ca/README.md +455 -0
  12. package/docs/ceb/README.md +455 -0
  13. package/docs/co/README.md +455 -0
  14. package/docs/cs/README.md +455 -0
  15. package/docs/cy/README.md +455 -0
  16. package/docs/da/README.md +455 -0
  17. package/docs/de/README.md +455 -0
  18. package/docs/el/README.md +455 -0
  19. package/docs/eo/README.md +455 -0
  20. package/docs/es/README.md +455 -0
  21. package/docs/et/README.md +455 -0
  22. package/docs/eu/README.md +455 -0
  23. package/docs/fa/README.md +455 -0
  24. package/docs/fi/README.md +455 -0
  25. package/docs/fr/README.md +455 -0
  26. package/docs/fy/README.md +455 -0
  27. package/docs/ga/README.md +455 -0
  28. package/docs/gd/README.md +455 -0
  29. package/docs/gl/README.md +455 -0
  30. package/docs/gu/README.md +455 -0
  31. package/docs/ha/README.md +455 -0
  32. package/docs/haw/README.md +455 -0
  33. package/docs/he/README.md +455 -0
  34. package/docs/hi/README.md +455 -0
  35. package/docs/hmn/README.md +455 -0
  36. package/docs/hr/README.md +455 -0
  37. package/docs/ht/README.md +455 -0
  38. package/docs/hu/README.md +455 -0
  39. package/docs/hy/README.md +455 -0
  40. package/docs/id/README.md +455 -0
  41. package/docs/ig/README.md +455 -0
  42. package/docs/is/README.md +455 -0
  43. package/docs/it/README.md +455 -0
  44. package/docs/iw/README.md +455 -0
  45. package/docs/ja/README.md +455 -0
  46. package/docs/jv/README.md +455 -0
  47. package/docs/ka/README.md +455 -0
  48. package/docs/kk/README.md +455 -0
  49. package/docs/km/README.md +455 -0
  50. package/docs/kn/README.md +455 -0
  51. package/docs/ko/README.md +455 -0
  52. package/docs/ku/README.md +455 -0
  53. package/docs/ky/README.md +455 -0
  54. package/docs/la/README.md +455 -0
  55. package/docs/lb/README.md +455 -0
  56. package/docs/lo/README.md +455 -0
  57. package/docs/lt/README.md +455 -0
  58. package/docs/lv/README.md +455 -0
  59. package/docs/mg/README.md +455 -0
  60. package/docs/mi/README.md +455 -0
  61. package/docs/mk/README.md +455 -0
  62. package/docs/ml/README.md +455 -0
  63. package/docs/mn/README.md +455 -0
  64. package/docs/mr/README.md +455 -0
  65. package/docs/ms/README.md +455 -0
  66. package/docs/mt/README.md +455 -0
  67. package/docs/my/README.md +455 -0
  68. package/docs/ne/README.md +455 -0
  69. package/docs/nl/README.md +455 -0
  70. package/docs/no/README.md +455 -0
  71. package/docs/ny/README.md +455 -0
  72. package/docs/or/README.md +455 -0
  73. package/docs/pa/README.md +455 -0
  74. package/docs/pl/README.md +455 -0
  75. package/docs/ps/README.md +455 -0
  76. package/docs/pt/README.md +455 -0
  77. package/docs/ro/README.md +455 -0
  78. package/docs/ru/README.md +455 -0
  79. package/docs/rw/README.md +455 -0
  80. package/docs/sd/README.md +455 -0
  81. package/docs/si/README.md +455 -0
  82. package/docs/sk/README.md +455 -0
  83. package/docs/sl/README.md +455 -0
  84. package/docs/sm/README.md +455 -0
  85. package/docs/sn/README.md +455 -0
  86. package/docs/so/README.md +455 -0
  87. package/docs/sq/README.md +455 -0
  88. package/docs/sr/README.md +455 -0
  89. package/docs/st/README.md +455 -0
  90. package/docs/su/README.md +455 -0
  91. package/docs/sv/README.md +455 -0
  92. package/docs/sw/README.md +455 -0
  93. package/docs/ta/README.md +455 -0
  94. package/docs/te/README.md +455 -0
  95. package/docs/tg/README.md +455 -0
  96. package/docs/th/README.md +455 -0
  97. package/docs/tk/README.md +455 -0
  98. package/docs/tl/README.md +455 -0
  99. package/docs/tr/README.md +455 -0
  100. package/docs/tt/README.md +455 -0
  101. package/docs/ug/README.md +455 -0
  102. package/docs/uk/README.md +455 -0
  103. package/docs/ur/README.md +455 -0
  104. package/docs/uz/README.md +455 -0
  105. package/docs/vi/README.md +455 -0
  106. package/docs/xh/README.md +455 -0
  107. package/docs/yi/README.md +455 -0
  108. package/docs/yo/README.md +455 -0
  109. package/docs/zh/README.md +455 -0
  110. package/docs/zu/README.md +455 -0
  111. package/drivers/b2/index.js +24 -6
  112. package/hokey.json +16 -0
  113. package/index.js +33 -17
  114. package/package.json +3 -2
  115. package/test/api.spec.js +319 -306
  116. package/util/logger.js +1 -1
  117. package/util/redis.js +1 -1
@@ -0,0 +1,455 @@
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
+ * [Podstawowe zastosowanie](#Podstawowe użycie)
12
+ * [Metadane](#Metadane)
13
+ * [Alternatywny styl importu](#Alternatywny styl importu)
14
+ * [Buforowanie](#Buforowanie)
15
+ * [Odbicie lustrzane](#Odbicie lustrzane)
16
+ * [Przezroczyste szyfrowanie](#Transparent-encryption)
17
+ * [Rotacja klawiszy](# Rotacja klawiszy)
18
+ * [Interfejs sterownika](#Interfejs sterownika)
19
+ * [Logowanie](#Logowanie)
20
+
21
+ # Przeczytaj to w innym języku
22
+ Ten dokument README.md został przetłumaczony przez [hokeylization](https://github.com/cobbzilla/hokeylization) na
23
+ **[każdy język obsługiwany przez Tłumacza Google](https://cloud.google.com/translate/docs/languages)!**
24
+
25
+ Jestem pewien, że nie jest idealny, ale mam nadzieję, że to lepsze niż nic!
26
+
27
+ [🇸🇦 Arabski](../ar/README.md)
28
+ [🇧🇩 bengalski](../bn/README.md)
29
+ [🇩🇪 Niemiecki](../de/README.md)
30
+ [🇺🇸 Polski](../en/README.md)
31
+ [🇪🇸 Hiszpański](../es/README.md)
32
+ [🇫🇷 Francuski](../fr/README.md)
33
+ [🇹🇩 Hausa](../ha/README.md)
34
+ [🇮🇳 hindi](../hi/README.md)
35
+ [🇮🇩 Indonezyjski](../id/README.md)
36
+ [🇮🇹 Włoski](../it/README.md)
37
+ [🇯🇵 Japoński](../ja/README.md)
38
+ [🇰🇷 Koreański](../ko/README.md)
39
+ [🇮🇳 Maranthi](../mr/README.md)
40
+ [🇵🇱 Polski](../pl/README.md)
41
+ [🇧🇷 Portugalski](../pt/README.md)
42
+ [🇷🇺 Rosyjski](../ru/README.md)
43
+ [🇰🇪 Suahili](../sw/README.md)
44
+ [🇵🇭 Tagalog](../tl/README.md)
45
+ [🇹🇷 Turecki](../tr/README.md)
46
+ [🇵🇰 Urdu](../ur/README.md)
47
+ [🇻🇳 Wietnamski](../vi/README.md)
48
+ [🇨🇳 chiński](../zh/README.md)
49
+
50
+
51
+ **[📚 ... Wszystkie języki ...](../README.md)**
52
+ ----
53
+
54
+ ### Czy jest jakiś problem z tym tłumaczeniem README?
55
+ To konkretne tłumaczenie oryginału [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
56
+ może być błędny -- *poprawki są mile widziane!* Wyślij [proszę o ściągnięcie na GitHub](https://github.com/cobbzilla/mobiletto/pulls),
57
+ lub jeśli nie czujesz się z tym komfortowo, [otwórz zgłoszenie](https://github.com/cobbzilla/mobiletto/issues)
58
+
59
+ Tworząc nowy problem na GitHubie dotyczący tłumaczenia, wykonaj następujące czynności:
60
+ * dołącz adres URL strony (skopiuj/wklej z paska adresu przeglądarki)
61
+ * dołącz dokładny tekst, który jest błędny (skopiuj/wklej z przeglądarki)
62
+ * proszę opisać co jest nie tak - czy tłumaczenie jest niepoprawne? czy formatowanie jest jakoś zepsute?
63
+ * uprzejmie zasugeruj lepsze tłumaczenie, czyli jak tekst powinien być odpowiednio sformatowany
64
+ * **Dziękuję Ci!**
65
+
66
+ ## Dlaczego Mobiletto?
67
+
68
+ ### Pożegnaj się z uzależnieniem od dostawcy!
69
+ Różni dostawcy przechowywania w chmurze mają niezgodne interfejsy API. Nawet ci, którzy dążą do „zgodności z S3”
70
+ mieć idiosynkratyczne zachowania.
71
+
72
+ Gdy wybierzesz konkretnego dostawcę pamięci masowej dla swojej aplikacji, jeśli kodujesz bezpośrednio do jego interfejsu API, Twoja aplikacja
73
+ jest teraz zależny od tej usługi. W miarę upływu czasu i kumulacji kodu, zmienianie dostawców staje się
74
+ coraz bardziej nie do utrzymania. Witamy w zabawnym świecie uzależnienia od dostawcy!
75
+
76
+ Mobiletto został zaprojektowany, aby rozwiązać ten problem. Kodując swoją aplikację do API mobiletto, możesz łatwo
77
+ zmień dostawców pamięci masowej i wiedz, że warstwa pamięci Twojej aplikacji będzie zachowywać się identycznie.
78
+
79
+ ### Obszerne testy
80
+ Wszyscy kierowcy są testowani pod kątem identycznego zachowania z 60+ testami dla każdego kierowcy.
81
+ Testujemy wszystkich kierowców z każdą kombinacją:
82
+ * Szyfrowanie: zarówno włączone, jak i wyłączone
83
+ * Pamięć podręczna Redis: zarówno włączona, jak i wyłączona
84
+
85
+ Takie podejście daje nam pewność, że mobiletto będzie zachowywać się tak samo niezależnie od tego, z którego sterownika korzystasz,
86
+ i niezależnie od tego, czy włączysz buforowanie i/lub szyfrowanie.
87
+
88
+ ### Wsparcie kierowcy
89
+ Aktualne sterowniki pamięci masowej Mobileto:
90
+ * `s3` : Amazon S3
91
+ * `b2` : Backblaze B2
92
+ * `local` : lokalny system plików
93
+
94
+ *Wkłady wspierające większą liczbę dostawców pamięci masowej w chmurze są bardzo mile widziane!*
95
+
96
+ ## mobiletto-cli
97
+ Mobiletto ma być używany jako biblioteka przez inny kod JavaScript.
98
+
99
+ Aby pracować z mobiletto w wierszu poleceń, użyj [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
100
+
101
+ ## Źródło
102
+ * [mobiletto na GitHubie](https://github.com/cobbzilla/mobiletto)
103
+ * [mobiletto na npm](https://www.npmjs.com/package/mobiletto)
104
+
105
+ ## Szybki start
106
+ Krótki przykład użycia sterownika `s3` .
107
+
108
+ Ten kod działałby tak samo, gdyby sterownik był `b2` lub `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
+ ## Podstawowe zastosowanie
139
+ O wiele bardziej rozbudowany przykład, pokazujący większość oferowanych funkcji:
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
+ ## Metadane
241
+ Polecenie `metadata` zwraca metadane dotyczące pojedynczego wpisu w systemie plików.
242
+ Podobnie wartość zwracana przez polecenie `list` jest tablicą obiektów metadanych.
243
+
244
+ Obiekt metadanych wygląda tak:
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
+ Właściwość `type` type` może mieć `file` , `dir` , `link` lub `special` .
255
+
256
+ W zależności od typu sterownika, polecenie `list` może nie zwracać wszystkich pól. Właściwości `name` i `type`
257
+ powinien być zawsze obecny. Kolejne polecenie `metadata` zwróci wszystkie dostępne właściwości.
258
+
259
+ ## Alternatywny styl importu
260
+ Zaimportuj moduł o pełnym zakresie i użyj funkcji `connect` :
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
+ ## Buforowanie
268
+ Mobiletto działa najlepiej z pamięcią podręczną <a href="https://redis.io">redis</a> .
269
+
270
+ Mobiletto spróbuje połączyć się z instancją redis na 127.0.0.1:6379
271
+
272
+ Możesz zastąpić jedno z tych:
273
+ * Ustaw `MOBILETTO_REDIS_HOST` env var, mobilet, aby połączyć się tutaj zamiast localhost
274
+ * Ustaw zmienną env `MOBILETTO_REDIS_PORT` , ten port będzie używany
275
+
276
+ Mobiletto będzie przechowywać wszystkie swoje klucze redis z prefiksem `_mobiletto__` . Możesz to zmienić
277
+ ustawiając `MOBILETTO_REDIS_PREFIX` env var.
278
+
279
+ Możesz także ustawić buforowanie dla poszczególnych połączeń za pomocą obiektu `opts.redisConfig` :
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
+ ### Nie chcesz buforować redis?
291
+ Aby wyłączyć: `enabled: false` w swoim obiekcie `opts.redisConfig` podczas nawiązywania połączenia.
292
+
293
+ Jak omówiono poniżej, wyłączenie buforowania będzie miało negatywny wpływ na wydajność i spowoduje zwiększenie liczby żądań
294
+ do przechowywania, którego naprawdę potrzebujesz.
295
+
296
+ ### Wskazówki dotyczące buforowania
297
+ **Zaszyfrowana pamięć**: odczyt/zapis zaszyfrowanej pamięci jest tylko trochę wolniejszy niż normalnie,
298
+ ale poruszanie się po katalogach (co robią niektóre rzeczy) jest dość drogie. Korzystanie z pamięci podręcznej redis
299
+ zapewni Ci znaczny wzrost wydajności.
300
+
301
+ Domyślna pamięć podręczna jest bezpieczna, ale nie działa dobrze, jeśli masz dużo operacji zapisu/usuwania.
302
+ Każda operacja zapisu lub usunięcia unieważnia całą pamięć podręczną, zapewniając, że kolejne odczyty zobaczą
303
+ najnowsze zmiany.
304
+
305
+ ### Narzędzia CLI
306
+ Jeśli używasz narzędzia CLI, takiego jak [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
307
+ na pewno będziesz chciał, aby pamięć podręczna redis była włączona, ponieważ działa ona podczas wywołań polecenia `mo` .
308
+
309
+ ## Dublowanie
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
+ Polecenie `mirror` wykonuje jednorazową kopię wszystkich plików z jednego telefonu komórkowego do drugiego.
318
+ Nie uruchamia żadnego procesu utrzymywania lustra w czasie. Uruchom ponownie polecenie `mirror`
319
+ aby zsynchronizować brakujące pliki.
320
+
321
+ Wartość zwracana z `mirror` to prosty obiekt z licznikami liczby plików pomyślnie
322
+ dublowane i ile plików zawierało błędy:
323
+
324
+ {
325
+ success: count-of-files-mirrored,
326
+ errors: count-of-files-with-errors
327
+ }
328
+
329
+ OSTRZEŻENIE: Dublowanie dużych zestawów danych może być bardzo czasochłonne i wymagające dużej przepustowości
330
+
331
+ W przypadku semantyki wywołania `mirror` czasami może być mylące, aby zrozumieć, kto jest
332
+ czytelnik i kto jest pisarzem. Wyobraź to sobie jak instrukcję przypisania: „lewa ręka mobiletto”
333
+ to rzecz, do której jest przypisywana (zapisywane dane lustrzane), a „prawostronne mobiletto” (
334
+ argumentem metody `mirror` ) jest przypisywana wartość (odczytywane są lustrzane dane).
335
+
336
+ ## Szyfrowanie przejrzyste
337
+ Włącz przezroczyste szyfrowanie po stronie klienta:
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
+ Co się dzieje? Oddzielny "wpis do katalogu" (bezpośredni) (zaszyfrowany) śledzi, jakie pliki się w nim znajdują
357
+ katalog (aka katalog bezpośredni).
358
+ * Polecenie `list` odczytuje pliki wpisów do katalogu, odszyfrowuje każdą z wymienionych ścieżek; następnie zwraca metadane dla każdego pliku
359
+ * Polecenia `list` są bardziej nieefektywne, szczególnie w przypadku katalogów z dużą liczbą plików
360
+ * Polecenie `write` zapisuje rekursywnie pliki dirent w katalogach dirent każdego rodzica; następnie zapisuje plik
361
+ * Polecenia `write` spowodują O(N) zapisów, gdzie N = głębokość w hierarchii katalogów
362
+ * Polecenie `remove` usuwa odpowiedni plik dirent i jego rodzica, jeśli jest pusty, rekursywnie; następnie usuwa plik
363
+ * Nierekurencyjne polecenia `remove` spowodują O(N) odczyty i potencjalnie tyle samo usunięć, przy N = głębokość w hierarchii katalogów
364
+ * Rekurencyjne polecenia `remove` na dużych i głębokich systemach plików mogą być kosztowne
365
+
366
+ Pamiętaj, że nawet przy włączonym szyfrowaniu po stronie klienta przeciwnik ma pełny wgląd w zaszyfrowaną stronę serwera
367
+ pamięć masowa, nawet bez klucza, nadal może zobaczyć łączną liczbę katalogów i liczbę plików w każdym, a także z
368
+ trochę wysiłku, odkryć część lub całość ogólnej struktury hierarchii katalogów.
369
+ *Uwaga: użyj stosunkowo płaskiej konstrukcji, aby zapewnić lepsze bezpieczeństwo.*
370
+ Przeciwnik nie znałby nazw katalogów/plików, chyba że znałby również twoje szyfrowanie
371
+ klucz lub w inny sposób pomyślnie złamał szyfrowanie. W takim razie wszystkie zakłady są przegrane!
372
+
373
+ ### Wydajność i buforowanie
374
+ Operacje na zaszyfrowanym magazynie mogą być powolne. Rekurencyjne aukcje i usunięcia mogą być bardzo powolne.
375
+ Buforowanie przez redis ogromnie pomaga, ale pamiętaj, że pamięć podręczna jest opróżniana po każdym zapisie lub usunięciu.
376
+
377
+ ## Rotacja klawiszy
378
+ Utwórz mobiletto z nowym kluczem, a następnie odtwórz w nim stare dane:
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
+ ## Interfejs sterownika
391
+ Sterownik to dowolny plik JS, który eksportuje funkcję „storageClient” o tej sygnaturze:
392
+
393
+ function storageClient (key, secret, opts)
394
+
395
+ * `key` : ciąg, klucz API (dla sterownika `local` jest to katalog podstawowy)
396
+ * `secret` : ciąg znaków, twój sekret API (może być pominięty dla sterownika `local` )
397
+ * `opts` : obiekt, właściwości są przypisane do sterownika:
398
+ * W przypadku `local` właściwości `fileMode` i `dirMode` określają sposób tworzenia nowych plików i katalogów
399
+ * W przypadku `s3` wymagana jest właściwość `bucket` . Opcjonalne właściwości to:
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
+ Obiekt, który zwraca funkcja storageClient, musi definiować te funkcje:
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
+ ## Logowanie
431
+ Mobiletto korzysta z biblioteki logowania [winston](https://www.npmjs.com/package/winston).
432
+
433
+ Dzienniki **będą** zawierać ścieżki do plików i komunikaty o błędach, ale **nigdy** nie będą zawierać kluczy, sekretów,
434
+ lub jakiekolwiek inne informacje o konfiguracji połączenia.
435
+
436
+ ### Poziom dziennika
437
+ Użyj zmiennej środowiskowej `MOBILETTO_LOG_LEVEL` , aby ustawić poziom rejestrowania, używając jednego
438
+ poziomów `npm` zdefiniowanych w [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
439
+
440
+ Domyślny poziom to `error` . Najbardziej gadatliwym poziomem jest `silly` , chociaż obecnie mobiletto
441
+ nie loguje się na poziomach poniżej `debug`
442
+
443
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
444
+
445
+ ### Plik dziennika
446
+ Rejestrator domyślnie zapisuje w konsoli. Aby wysłać logi do pliku, ustaw `MOBILETTO_LOG_FILE`
447
+ Zmienna środowiskowa. Podczas logowania do pliku dzienniki nie będą już zapisywane w konsoli.
448
+
449
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
450
+
451
+ Aby wyłączyć rejestrowanie:
452
+
453
+ MOBILETTO_LOG_FILE=/dev/null
454
+
455
+ </pre>