mobiletto 1.2.1 → 2.0.1

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 (124) hide show
  1. package/lib/cjs/index.d.ts +2 -0
  2. package/lib/cjs/index.js +30 -0
  3. package/lib/cjs/package.json +16 -0
  4. package/lib/esm/index.d.ts +2 -0
  5. package/lib/esm/index.js +12 -0
  6. package/package.json +27 -13
  7. package/.babelrc +0 -5
  8. package/.eslintrc.js +0 -14
  9. package/docs/README.md +0 -113
  10. package/docs/af/README.md +0 -481
  11. package/docs/am/README.md +0 -481
  12. package/docs/ar/README.md +0 -481
  13. package/docs/az/README.md +0 -481
  14. package/docs/be/README.md +0 -481
  15. package/docs/bg/README.md +0 -481
  16. package/docs/bn/README.md +0 -481
  17. package/docs/bs/README.md +0 -481
  18. package/docs/ca/README.md +0 -481
  19. package/docs/ceb/README.md +0 -481
  20. package/docs/co/README.md +0 -481
  21. package/docs/cs/README.md +0 -481
  22. package/docs/cy/README.md +0 -481
  23. package/docs/da/README.md +0 -481
  24. package/docs/de/README.md +0 -481
  25. package/docs/el/README.md +0 -481
  26. package/docs/eo/README.md +0 -481
  27. package/docs/es/README.md +0 -481
  28. package/docs/et/README.md +0 -481
  29. package/docs/eu/README.md +0 -481
  30. package/docs/fa/README.md +0 -481
  31. package/docs/fi/README.md +0 -481
  32. package/docs/fr/README.md +0 -481
  33. package/docs/fy/README.md +0 -481
  34. package/docs/ga/README.md +0 -481
  35. package/docs/gd/README.md +0 -481
  36. package/docs/gl/README.md +0 -481
  37. package/docs/gu/README.md +0 -481
  38. package/docs/ha/README.md +0 -481
  39. package/docs/haw/README.md +0 -481
  40. package/docs/he/README.md +0 -481
  41. package/docs/hi/README.md +0 -481
  42. package/docs/hmn/README.md +0 -481
  43. package/docs/hr/README.md +0 -481
  44. package/docs/ht/README.md +0 -481
  45. package/docs/hu/README.md +0 -481
  46. package/docs/hy/README.md +0 -481
  47. package/docs/id/README.md +0 -481
  48. package/docs/ig/README.md +0 -481
  49. package/docs/is/README.md +0 -481
  50. package/docs/it/README.md +0 -481
  51. package/docs/iw/README.md +0 -481
  52. package/docs/ja/README.md +0 -481
  53. package/docs/jv/README.md +0 -481
  54. package/docs/ka/README.md +0 -481
  55. package/docs/kk/README.md +0 -481
  56. package/docs/km/README.md +0 -481
  57. package/docs/kn/README.md +0 -481
  58. package/docs/ko/README.md +0 -481
  59. package/docs/ku/README.md +0 -481
  60. package/docs/ky/README.md +0 -481
  61. package/docs/la/README.md +0 -481
  62. package/docs/lb/README.md +0 -481
  63. package/docs/lo/README.md +0 -481
  64. package/docs/lt/README.md +0 -481
  65. package/docs/lv/README.md +0 -481
  66. package/docs/mg/README.md +0 -481
  67. package/docs/mi/README.md +0 -481
  68. package/docs/mk/README.md +0 -481
  69. package/docs/ml/README.md +0 -481
  70. package/docs/mn/README.md +0 -481
  71. package/docs/mr/README.md +0 -481
  72. package/docs/ms/README.md +0 -481
  73. package/docs/mt/README.md +0 -481
  74. package/docs/my/README.md +0 -481
  75. package/docs/ne/README.md +0 -481
  76. package/docs/nl/README.md +0 -481
  77. package/docs/no/README.md +0 -481
  78. package/docs/ny/README.md +0 -481
  79. package/docs/or/README.md +0 -481
  80. package/docs/pa/README.md +0 -481
  81. package/docs/pl/README.md +0 -481
  82. package/docs/ps/README.md +0 -481
  83. package/docs/pt/README.md +0 -481
  84. package/docs/ro/README.md +0 -481
  85. package/docs/ru/README.md +0 -481
  86. package/docs/rw/README.md +0 -481
  87. package/docs/sd/README.md +0 -481
  88. package/docs/si/README.md +0 -481
  89. package/docs/sk/README.md +0 -481
  90. package/docs/sl/README.md +0 -481
  91. package/docs/sm/README.md +0 -481
  92. package/docs/sn/README.md +0 -481
  93. package/docs/so/README.md +0 -481
  94. package/docs/sq/README.md +0 -481
  95. package/docs/sr/README.md +0 -481
  96. package/docs/st/README.md +0 -481
  97. package/docs/su/README.md +0 -481
  98. package/docs/sv/README.md +0 -481
  99. package/docs/sw/README.md +0 -481
  100. package/docs/ta/README.md +0 -481
  101. package/docs/te/README.md +0 -481
  102. package/docs/tg/README.md +0 -481
  103. package/docs/th/README.md +0 -481
  104. package/docs/tk/README.md +0 -481
  105. package/docs/tl/README.md +0 -481
  106. package/docs/tr/README.md +0 -481
  107. package/docs/tt/README.md +0 -481
  108. package/docs/ug/README.md +0 -481
  109. package/docs/uk/README.md +0 -481
  110. package/docs/ur/README.md +0 -481
  111. package/docs/uz/README.md +0 -481
  112. package/docs/vi/README.md +0 -481
  113. package/docs/xh/README.md +0 -481
  114. package/docs/yi/README.md +0 -481
  115. package/docs/yo/README.md +0 -481
  116. package/docs/zh/README.md +0 -481
  117. package/docs/zu/README.md +0 -481
  118. package/drivers/b2/index.js +0 -451
  119. package/drivers/local/index.js +0 -315
  120. package/drivers/s3/index.js +0 -316
  121. package/hokey.json +0 -16
  122. package/index.js +0 -29
  123. package/test/api.spec.js +0 -512
  124. package/test/crypt.spec.js +0 -67
package/docs/id/README.md DELETED
@@ -1,481 +0,0 @@
1
- Mobiletto
2
- =========
3
-
4
- Mobiletto adalah lapisan abstraksi penyimpanan JavaScript, dengan enkripsi sisi klien transparan opsional.
5
-
6
- # Isi
7
- * [Mengapa Mobiletto?](#Mengapa-Mobiletto?)
8
- * [Mulai cepat](#Mulai cepat)
9
- * [Mobiletto CLI](#mobileto-cli)
10
- * [Sumber](#Sumber)
11
- * [Pemasangan](#Pemasangan)
12
- * [Dukungan dan Pendanaan](#Dukungan-dan-Pendanaan)
13
- * [Penggunaan dasar](#Penggunaan dasar)
14
- * [Metadata](#Metadata)
15
- * [Gaya impor alternatif](#Gaya impor alternatif)
16
- * [Caching](#Caching)
17
- * [Pencerminan](#Pencerminan)
18
- * [Enkripsi transparan](#Enkripsi-transparan)
19
- * [Rotasi tombol](#Rotasi tombol)
20
- * [Antarmuka driver](#Driver-antarmuka)
21
- * [Logging](#Logging)
22
-
23
- # Baca ini dalam bahasa lain
24
- Dokumen README.md ini telah diterjemahkan, melalui [hokeylization](https://github.com/cobbzilla/hokeylization), ke
25
- **[setiap bahasa didukung oleh Google Terjemahan](https://cloud.google.com/translate/docs/languages)!**
26
-
27
- Saya yakin itu tidak sempurna, tapi saya harap ini lebih baik daripada tidak sama sekali!
28
-
29
- [🇸🇦 Bahasa Arab](../ar/README.md)
30
- [🇧🇩 Bengali](../bn/README.md)
31
- [🇩🇪 Jerman](../de/README.md)
32
- [🇺🇸 Bahasa Inggris](../id/README.md)
33
- [🇪🇸 Spanyol](../es/README.md)
34
- [🇫🇷 Prancis](../fr/README.md)
35
- [🇹🇩 Hausa](../ha/README.md)
36
- [🇮🇳 Hindi](../hi/README.md)
37
- [🇮🇩 Bahasa Indonesia](../id/README.md)
38
- [🇮🇹 Italia](../it/README.md)
39
- [🇯🇵 Bahasa Jepang](../ja/README.md)
40
- [🇰🇷 Bahasa Korea](../ko/README.md)
41
- [🇮🇳 Marathi](../mr/README.md)
42
- [🇵🇱 Bahasa Polandia](../pl/README.md)
43
- [🇧🇷 Portugis](../pt/README.md)
44
- [🇷🇺 Rusia](../ru/README.md)
45
- [🇰🇪 Swahili](../sw/README.md)
46
- [🇵🇭 Tagalog](../tl/README.md)
47
- [🇹🇷 Turki](../tr/README.md)
48
- [🇵🇰 Urdu](../ur/README.md)
49
- [🇻🇳 Vietnam](../vi/README.md)
50
- [🇨🇳 Cina](../zh/README.md)
51
-
52
-
53
- **[📚 ... Semua Bahasa ...](../README.md)**
54
- ----
55
-
56
- ### Apakah ada masalah dengan terjemahan README ini?
57
- Terjemahan khusus dari [README] asli ini(https://github.com/cobbzilla/mobiletto/blob/master/README.md)
58
- mungkin salah -- *koreksi sangat diharapkan!* Silakan kirim [permintaan tarik di GitHub](https://github.com/cobbzilla/mobiletto/pulls),
59
- atau jika Anda tidak nyaman melakukannya, [buka masalah](https://github.com/cobbzilla/mobiletto/issues)
60
-
61
- Saat Anda membuat masalah GitHub baru tentang terjemahan, lakukan:
62
- * sertakan URL halaman (salin/tempel dari bilah alamat browser)
63
- * sertakan teks persis yang salah (salin/tempel dari browser)
64
- * tolong jelaskan apa yang salah -- apakah terjemahannya salah? apakah formatnya rusak entah bagaimana?
65
- * mohon menawarkan saran terjemahan yang lebih baik, atau bagaimana teks harus diformat dengan benar
66
- * **Terima kasih!**
67
-
68
- ## Mengapa Mobiletto?
69
-
70
- ### Selamat tinggal vendor lock-in!
71
- Berbagai penyedia penyimpanan cloud memiliki API yang tidak kompatibel. Bahkan mereka yang berusaha keras untuk "kompatibilitas S3"
72
- memiliki perilaku idiosinkratik.
73
-
74
- Saat Anda memilih vendor penyimpanan tertentu untuk aplikasi Anda, jika Anda membuat kode langsung ke API mereka, aplikasi Anda
75
- sekarang tergantung pada layanan itu. Seiring berjalannya waktu dan kode terakumulasi, mengubah vendor menjadi
76
- semakin tidak dapat dipertahankan. Selamat datang di dunia penguncian vendor yang menyenangkan!
77
-
78
- Mobiletto dirancang untuk memecahkan masalah ini. Dengan mengkodekan aplikasi Anda ke API selulerto, Anda dapat dengan mudah
79
- ubah penyedia penyimpanan dan ketahui bahwa lapisan penyimpanan aplikasi Anda akan berperilaku sama.
80
-
81
- ### Pengujian ekstensif
82
- Semua driver diuji untuk perilaku yang identik dengan 60+ tes untuk setiap driver.
83
- Kami menguji semua driver dengan setiap kombinasi:
84
- * Enkripsi: diaktifkan dan dinonaktifkan
85
- * Cache redis: diaktifkan dan dinonaktifkan
86
-
87
- Pendekatan ini memberi kami ketenangan pikiran bahwa mobiletto akan berperilaku sama terlepas dari driver mana yang Anda gunakan,
88
- dan terlepas dari apakah Anda mengaktifkan caching dan/atau enkripsi.
89
-
90
- ### Dukungan pengemudi
91
- Driver penyimpanan Mobileto saat ini:
92
- * `s3` : Amazon S3
93
- * `b2` : Backblaze B2
94
- * `local` : sistem file lokal
95
-
96
- *Kontribusi untuk mendukung lebih banyak penyedia penyimpanan cloud sangat diharapkan!*
97
-
98
- ## mobiletto-cli
99
- Mobiletto dimaksudkan untuk digunakan sebagai perpustakaan oleh kode JavaScript lainnya.
100
-
101
- Untuk bekerja dengan mobiletto di baris perintah, gunakan [mobiletto-cli](https://www.npmjs.com/package/mobileto-cli)
102
-
103
- ## Sumber
104
- * [mobiletto di GitHub](https://github.com/cobbzilla/mobileto)
105
- * [mobiletto di npm](https://www.npmjs.com/package/mobileto)
106
-
107
- ## Dukungan dan Pendanaan
108
- Saya mencoba menjadi pengembang perangkat lunak sumber terbuka profesional. Saya telah bekerja di
109
- industri perangkat lunak selama bertahun-tahun, saya telah memulai perusahaan yang sukses dan menjualnya ke perusahaan publik.
110
- Baru-baru ini saya kehilangan pekerjaan saya, dan saya tidak memiliki pekerjaan lain yang menunggu
111
-
112
- Jadi saya akan mencoba menulis perangkat lunak yang bermanfaat dan melihat apakah itu berhasil
113
-
114
- Jika Anda menikmati menggunakan perangkat lunak ini, saya akan sangat berterima kasih bahkan untuk
115
- terkecil [kontribusi bulanan melalui Patreon](https://www.patreon.com/cobbzilla)
116
-
117
- *Terima kasih!*
118
-
119
- ## Instalasi
120
- Instal menggunakan `npm` atau `yarn` . Anda mungkin menginginkan versi `lite` yang tidak menyertakan semua
121
- file README yang diterjemahkan:
122
-
123
- npm install mobiletto-lite
124
- yarn add mobiletto-lite
125
-
126
- Jika Anda benar-benar menginginkan file README dalam setiap bahasa, instal versi lengkapnya:
127
-
128
- npm install mobiletto
129
- yarn add mobiletto
130
-
131
- ## Mulai cepat
132
- Contoh singkat menggunakan driver `s3` .
133
-
134
- Kode ini akan berjalan sama jika drivernya adalah `b2` atau `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
- ## Penggunaan dasar
165
- Contoh yang jauh lebih luas, menunjukkan sebagian besar fitur yang ditawarkan:
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
- Perintah `metadata` mengembalikan metadata tentang satu entri sistem file.
268
- Demikian juga, nilai kembalian dari perintah `list` adalah larik objek metadata.
269
-
270
- Objek metadata terlihat seperti ini:
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
- Properti `type` dapat berupa `file` , `dir` , `link` , atau `special` .
281
-
282
- Tergantung pada tipe driver, perintah `list` mungkin tidak mengembalikan semua kolom. Properti `name` dan `type`
283
- harus selalu hadir. Perintah `metadata` berikutnya akan mengembalikan semua properti yang tersedia.
284
-
285
- ## Gaya impor alternatif
286
- Impor modul cakupan penuh dan gunakan fungsi `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
- ## Caching
294
- Mobiletto bekerja paling baik dengan cache <a href="https://redis.io">redis</a> .
295
-
296
- Mobileetto akan mencoba menyambung ke instance redis pada 127.0.0.1:6379
297
-
298
- Anda dapat mengganti salah satu dari ini:
299
- * Setel env var `MOBILETTO_REDIS_HOST` , hubungkan mobiletto di sini alih-alih localhost
300
- * Atur env var `MOBILETTO_REDIS_PORT` , port ini akan digunakan
301
-
302
- Mobiletto akan menyimpan semua kunci redisnya dengan awalan `_mobiletto__` . Anda dapat mengubah ini
303
- dengan mengatur `MOBILETTO_REDIS_PREFIX` env var.
304
-
305
- Anda juga dapat menyetel caching per koneksi dengan objek `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
- ### Tidak ingin cache redis?
317
- Untuk menonaktifkan: teruskan `enabled: false` false` di objek `opts.redisConfig` saat Anda membuat koneksi.
318
-
319
- Seperti yang dibahas di bawah, menonaktifkan caching akan berdampak buruk pada kinerja dan menimbulkan lebih banyak permintaan
320
- untuk penyimpanan yang Anda benar-benar perlu.
321
-
322
- ### Panduan cache
323
- **Penyimpanan terenkripsi**: membaca/menulis penyimpanan terenkripsi hanya sedikit lebih lambat dari biasanya,
324
- tetapi menavigasi di sekitar direktori (yang dilakukan beberapa hal) cukup mahal. Menggunakan cache redis
325
- akan memberi Anda peningkatan kinerja yang signifikan.
326
-
327
- Cache default aman, tetapi tidak berfungsi dengan baik jika Anda memiliki banyak operasi tulis/hapus.
328
- Setiap operasi tulis atau hapus akan membatalkan seluruh cache, memastikan pembacaan selanjutnya akan melihat
329
- perubahan terbaru.
330
-
331
- ### alat CLI
332
- Jika Anda menggunakan alat CLI seperti [mobileto-cli](https://www.npmjs.com/package/mobileto-cli),
333
- Anda pasti ingin cache redis diaktifkan, karena ini berlangsung di seluruh pemanggilan perintah `mo` .
334
-
335
- ## Mencerminkan
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
- Perintah `mirror` melakukan salinan satu kali semua file dari satu mobiletto ke mobil lainnya.
344
- Itu tidak menjalankan proses apa pun untuk mempertahankan cermin dari waktu ke waktu. Jalankan kembali perintah `mirror`
345
- untuk menyinkronkan file yang hilang.
346
-
347
- Nilai kembalian dari `mirror` adalah objek sederhana dengan penghitung untuk berapa banyak file yang berhasil
348
- dicerminkan dan berapa banyak file yang memiliki kesalahan:
349
-
350
- {
351
- success: count-of-files-mirrored,
352
- errors: count-of-files-with-errors
353
- }
354
-
355
- PERINGATAN: Mencerminkan kumpulan data besar bisa sangat memakan waktu dan bandwidth-intensif
356
-
357
- Dengan semantik panggilan `mirror` terkadang membingungkan untuk memahami siapa yang
358
- pembaca dan siapa penulisnya. Bayangkan itu seperti pernyataan tugas: "mobiletto kiri"
359
- adalah benda yang ditugaskan (data cermin ditulis), dan "mobiletto kanan" (
360
- argumen ke metode `mirror` ) adalah nilai yang diberikan (data yang dicerminkan dibaca).
361
-
362
- ## Enkripsi transparan
363
- Aktifkan enkripsi sisi klien transparan:
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
- Apa yang terjadi? Sebuah "entri direktori" terpisah (dirent) direktori (terenkripsi) melacak file apa yang ada di dalamnya
383
- direktori (alias direktori dirent).
384
- * Perintah `list` membaca file entri direktori, mendekripsi setiap jalur yang terdaftar; kemudian mengembalikan metadata untuk setiap file
385
- * Perintah `list` lebih tidak efisien, terutama untuk direktori dengan banyak file
386
- * Perintah `write` menulis file dirent di direktori dirent masing-masing induk, secara rekursif; kemudian menulis file
387
- * Perintah `write` akan dikenakan O(N) menulis, dengan N = kedalaman dalam hierarki direktori
388
- * Perintah `remove` menghapus file dirent yang sesuai, dan induknya jika kosong, secara rekursif; lalu hapus file
389
- * Perintah `remove` non-rekursif akan menyebabkan O(N) membaca dan berpotensi menghapus sebanyak mungkin, dengan N = kedalaman dalam hierarki direktori
390
- * Perintah `remove` rekursif pada sistem file besar dan dalam bisa mahal
391
-
392
- Perhatikan bahwa bahkan dengan enkripsi sisi klien diaktifkan, musuh dengan visibilitas penuh ke sisi server terenkripsi Anda
393
- penyimpanan, bahkan tanpa kunci, masih dapat melihat jumlah total direktori dan berapa banyak file di masing-masing, dan dengan
394
- beberapa upaya, temukan beberapa atau semua struktur keseluruhan dari hierarki direktori.
395
- *Catatan: Gunakan struktur yang relatif datar untuk keamanan yang lebih baik.*
396
- Musuh tidak akan mengetahui nama direktori/file kecuali mereka juga mengetahui enkripsi Anda
397
- kunci atau telah berhasil memecahkan enkripsi. Semua taruhan dibatalkan!
398
-
399
- ### Performa dan cache
400
- Operasi pada penyimpanan terenkripsi bisa lambat. Daftar dan penghapusan rekursif bisa sangat lambat.
401
- Caching melalui redis sangat membantu, tetapi perhatikan bahwa cache dihapus pada setiap penulisan atau penghapusan.
402
-
403
- ## Rotasi kunci
404
- Buat mobiletto dengan kunci baru Anda, lalu cerminkan data lama ke dalamnya:
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
- ## Antarmuka pengemudi
417
- Driver adalah file JS apa pun yang mengekspor fungsi 'storageClient' dengan tanda tangan ini:
418
-
419
- function storageClient (key, secret, opts)
420
-
421
- * `key` : string, kunci API Anda (untuk driver `local` ini adalah direktori dasar)
422
- * `secret` : string, rahasia API Anda (dapat dihilangkan untuk driver `local` )
423
- * `opts` : sebuah objek, propertinya adalah per-driver:
424
- * Untuk `local` , properti `fileMode` dan `dirMode` menentukan cara pembuatan file dan direktori baru
425
- * Untuk `s3` , properti `bucket` diperlukan. Properti opsional adalah:
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
- Objek yang dikembalikan oleh fungsi storageClient harus mendefinisikan fungsi-fungsi ini:
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
- ## Masuk
457
- Mobiletto menggunakan perpustakaan logging [winston](https://www.npmjs.com/package/winston).
458
-
459
- Log **akan** berisi jalur file dan pesan kesalahan, tetapi **tidak akan pernah** berisi kunci, rahasia,
460
- atau informasi konfigurasi koneksi lainnya.
461
-
462
- ### Tingkat log
463
- Gunakan variabel lingkungan `MOBILETTO_LOG_LEVEL` untuk menyetel level log, menggunakan satu
464
- level `npm` yang ditentukan di [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
465
-
466
- Tingkat default adalah `error` . Level yang paling bertele-tele adalah `silly` , meskipun saat ini mobiletto
467
- tidak masuk pada level di bawah `debug`
468
-
469
- MOBILETTO_LOG_LEVEL=silly # maximum logs!
470
-
471
- ### Berkas log
472
- Secara default, logger menulis ke konsol. Untuk mengirim log ke file, setel `MOBILETTO_LOG_FILE`
473
- variabel lingkungan. Saat masuk ke file, log tidak akan lagi ditulis ke konsol.
474
-
475
- MOBILETTO_LOG_FILE=/var/my_mobiletto_log
476
-
477
- Untuk mematikan pencatatan:
478
-
479
- MOBILETTO_LOG_FILE=/dev/null
480
-
481
- </pre>