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
+ Mobiletto היא שכבת הפשטה לאחסון JavaScript, עם הצפנה שקופה אופציונלית בצד הלקוח.
5
+
6
+ # תוכן
7
+ * [למה Mobiletto?](#Why-Mobiletto?)
8
+ * [התחלה מהירה](#Quick-start)
9
+ * [Mobiletto CLI](#mobiletto-cli)
10
+ * [מקור](#מקור)
11
+ * [שימוש בסיסי](#שימוש בסיסי)
12
+ * [Metadata](#Metadata)
13
+ * [סגנון ייבוא חלופי](#סגנון ייבוא חלופי)
14
+ * [מטמון](#Caching)
15
+ * [שיקוף](#שיקוף)
16
+ * [הצפנה שקופה](#שקופה-הצפנה)
17
+ * [סיבוב מפתח](#Key-rotation)
18
+ * [ממשק מנהל התקן](#ממשק מנהל התקן)
19
+ * [רישום](#לוגינג)
20
+
21
+ # קרא את זה בשפה אחרת
22
+ מסמך README.md זה תורגם, באמצעות [hokeylization](https://github.com/cobbzilla/hokeylization), ל-
23
+ **[בכל שפה נתמכת על ידי Google Translate](https://cloud.google.com/translate/docs/languages)!**
24
+
25
+ אני בטוח שזה לא מושלם, אבל אני מקווה שזה יותר טוב מכלום!
26
+
27
+ [🇸🇦 ערבית](../ar/README.md)
28
+ [🇧🇩 בנגלית](../bn/README.md)
29
+ [🇩🇪 גרמנית](../de/README.md)
30
+ [🇺🇸 אנגלית](../en/README.md)
31
+ [🇪🇸 ספרדית](../es/README.md)
32
+ [🇫🇷 צרפתית](../fr/README.md)
33
+ [🇹🇩 Hausa](../ha/README.md)
34
+ [🇮🇳 הינדי](../hi/README.md)
35
+ [🇮🇩 אינדונזית](../id/README.md)
36
+ [🇮🇹 איטלקית](../it/README.md)
37
+ [🇯🇵 יפנית](../ja/README.md)
38
+ [🇰🇷 קוריאנית](../ko/README.md)
39
+ [🇮🇳 Maranthi](../mr/README.md)
40
+ [🇵🇱 פולנית](../pl/README.md)
41
+ [🇧🇷 פורטוגזית](../pt/README.md)
42
+ [🇷🇺 רוסית](../ru/README.md)
43
+ [🇰🇪 סוואהילי](../sw/README.md)
44
+ [🇵🇭 Tagalog](../tl/README.md)
45
+ [🇹🇷 טורקית](../tr/README.md)
46
+ [🇵🇰 אורדו](../ur/README.md)
47
+ [🇻🇳 וייטנאמית](../vi/README.md)
48
+ [🇨🇳 סינית](../zh/README.md)
49
+
50
+
51
+ **[📚 ... כל השפות ...](../README.md)**
52
+ ----
53
+
54
+ ### האם יש בעיה עם התרגום הזה של README?
55
+ התרגום הספציפי הזה של [README] המקורי (https://github.com/cobbzilla/mobiletto/blob/master/README.md)
56
+ עשוי להיות פגום -- *תיקונים יתקבלו בברכה!* אנא שלח [בקשת משיכה ב-GitHub](https://github.com/cobbzilla/mobiletto/pulls),
57
+ או אם אתה לא מרגיש בנוח לעשות את זה, [פתח בעיה](https://github.com/cobbzilla/mobiletto/issues)
58
+
59
+ כאשר אתה יוצר בעיה חדשה של GitHub על תרגום, אנא עשה:
60
+ * כלול את כתובת האתר של הדף (העתק/הדבק משורת הכתובת של הדפדפן)
61
+ * כלול את הטקסט המדויק השגוי (העתק/הדבק מדפדפן)
62
+ * נא לתאר מה לא בסדר -- האם התרגום שגוי? הפורמט שבור איכשהו?
63
+ * אנא הציעו הצעה לתרגום טוב יותר, או כיצד יש לעצב את הטקסט כראוי
64
+ * **תודה!**
65
+
66
+ ## למה Mobiletto?
67
+
68
+ ### להתראות נעילת ספק!
69
+ לספקי אחסון הענן השונים יש ממשקי API לא תואמים. גם אלה השואפים ל"תאימות S3"
70
+ בעלי התנהגויות ייחודיות.
71
+
72
+ כאשר אתה בוחר ספק אחסון מסוים עבור האפליקציה שלך, אם אתה מקודד ישירות ל-API שלו, האפליקציה שלך
73
+ כעת תלוי בשירות זה. ככל שהזמן עובר והקוד מצטבר, ספקים משתנים הופכים
74
+ יותר ויותר בלתי נסבל. ברוכים הבאים לעולם המהנה של נעילת ספקים!
75
+
76
+ Mobiletto תוכנן לפתור בעיה זו. על ידי קידוד האפליקציה שלך ל-API של mobiletto, אתה יכול בקלות
77
+ להחליף ספקי אחסון ולדעת ששכבת האחסון של האפליקציה שלך תתנהג בצורה זהה.
78
+
79
+ ### בדיקות מקיפות
80
+ כל הנהגים נבדקים להתנהגות זהה עם 60+ בדיקות לכל נהג.
81
+ אנו בודקים את כל הנהגים עם כל שילוב של:
82
+ * הצפנה: מופעלת וגם מושבתת
83
+ * מטמון Redis: מופעל וגם מושבת
84
+
85
+ גישה זו נותנת לנו שקט נפשי ש-mobiltto יתנהג אותו דבר ללא קשר לנהג שאתה משתמש בו,
86
+ ובלי קשר אם אתה מפעיל מטמון ו/או הצפנה.
87
+
88
+ ### תמיכה בנהגים
89
+ מנהלי האחסון הנוכחיים של Mobiletto:
90
+ * `s3` : Amazon S3
91
+ * `b2` : Backblaze B2
92
+ * `local` : מערכת קבצים מקומית
93
+
94
+ *תרומות לתמיכה בספקי אחסון ענן נוספים יתקבלו בברכה!*
95
+
96
+ ## mobiletto-cli
97
+ Mobiletto מיועד לשמש כספרייה על ידי קוד JavaScript אחר.
98
+
99
+ כדי לעבוד עם mobiletto בשורת הפקודה, השתמש ב-[mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
100
+
101
+ ## מקור
102
+ * [mobiletto ב-GitHub](https://github.com/cobbzilla/mobiletto)
103
+ * [mobiletto ב-npm](https://www.npmjs.com/package/mobiletto)
104
+
105
+ ## התחלה מהירה
106
+ דוגמה קצרה באמצעות מנהל ההתקן של `s3` .
107
+
108
+ קוד זה ירוץ אותו הדבר אם מנהל ההתקן היה `b2` ' או `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
+ ## שימוש בסיסי
139
+ דוגמה הרבה יותר נרחבת, המציגה את רוב התכונות המוצעות:
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
+ ## מטא נתונים
241
+ הפקודה `metadata` מחזירה מטא נתונים לגבי ערך מערכת קבצים בודדת.
242
+ באופן דומה, ערך ההחזרה מהפקודה `list` רשימה' הוא מערך של אובייקטי מטא נתונים.
243
+
244
+ אובייקט מטא נתונים נראה כך:
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
+ המאפיין `type` יכול להיות `file` ' , `dir` ' , `link` ' או `special` .
255
+
256
+ בהתאם לסוג מנהל ההתקן, ייתכן שפקודה `list` רשימה' לא תחזיר את כל השדות. המאפיינים `name` שם `type`
257
+ צריך להיות נוכח תמיד. פקודת `metadata` הבאה תחזיר את כל המאפיינים הזמינים.
258
+
259
+ ## סגנון ייבוא חלופי
260
+ ייבא את המודול בהיקף מלא והשתמש בפונקציית `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
+ ## שמירה במטמון
268
+ Mobiletto עובד הכי טוב עם מטמון <a href="https://redis.io">redis</a> .
269
+
270
+ Mobiletto ינסה להתחבר למופע redis ב-127.0.0.1:6379
271
+
272
+ אתה יכול לעקוף אחד מאלה:
273
+ * הגדר את `MOBILETTO_REDIS_HOST` env var, mobiletכדי להתחבר לכאן במקום המארח המקומי
274
+ * הגדר את ה-env var `MOBILETTO_REDIS_PORT` , היציאה הזו תשמש
275
+
276
+ Mobiletto יאחסן את כל מפתחות ה-Redis שלה עם הקידומת `_mobiletto__` . אתה יכול לשנות את זה
277
+ על ידי הגדרת `MOBILETTO_REDIS_PREFIX` env var.
278
+
279
+ אתה יכול גם להגדיר מטמון לכל חיבור עם האובייקט `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
+ ### לא רוצה אחסון מחדש במטמון?
291
+ כדי להשבית: העבר את `enabled: false` ' באובייקט `opts.redisConfig` שלך כשאתה יוצר את החיבור שלך.
292
+
293
+ כפי שנדון להלן, השבתת שמירה במטמון תשפיע לרעה על הביצועים ותגרום לבקשות נוספות
294
+ לאחסון שאתה באמת צריך.
295
+
296
+ ### הדרכה לשמירה במטמון
297
+ **אחסון מוצפן**: קריאה/כתיבה של אחסון מוצפן הוא רק קצת יותר איטי מהרגיל,
298
+ אבל ניווט בין ספריות (מה שעושים דברים מסוימים) הוא די יקר. שימוש במטמון redis
299
+ ייתן לך שיפור משמעותי בביצועים.
300
+
301
+ מטמון ברירת המחדל בטוח, אך אינו פועל היטב אם יש לך הרבה פעולות כתיבה/הסרה.
302
+ כל פעולת כתיבה או הסרה מבטלת את תוקף המטמון כולו, ומבטיחה שהקריאה הבאה תראה את
303
+ השינויים האחרונים.
304
+
305
+ ### כלי CLI
306
+ אם אתה משתמש בכלי CLI כמו [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
307
+ אתה בהחלט רוצה את המטמון של redis מופעל, מכיוון שהוא נמשך לאורך כל פניות של פקודת `mo` .
308
+
309
+ ## שיקוף
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
+ הפקודה `mirror` מבצעת העתקה חד פעמית של כל הקבצים מ-mobiltto אחד לאחר.
318
+ זה לא מפעיל שום תהליך כדי לשמור על המראה לאורך זמן. הפעל שוב את הפקודה `mirror`
319
+ כדי לסנכרן את כל הקבצים החסרים.
320
+
321
+ ערך ההחזרה `mirror` הוא אובייקט פשוט עם מונים למספר הקבצים שהצליחו
322
+ שיקוף ובכמה קבצים היו שגיאות:
323
+
324
+ {
325
+ success: count-of-files-mirrored,
326
+ errors: count-of-files-with-errors
327
+ }
328
+
329
+ אזהרה: שיקוף של ערכות נתונים גדולות עשוי להיות גוזל זמן רב ורוחב פס
330
+
331
+ עם סמנטיקה של הקריאה `mirror` זה לפעמים יכול להיות מבלבל להבין מיהו
332
+ הקורא ומיהו הכותב. דמיינו את זה כמו הצהרת משימה: "הנייד השמאלי"
333
+ הוא הדבר שאליו מוקצה (נכתבים נתוני שיקוף), וה-"mobiltto הימני" (ה
334
+ ארגומנט לשיטת `mirror` ) הוא הערך המוקצה (נתוני שיקוף נקראים).
335
+
336
+ ## הצפנה שקופה
337
+ אפשר הצפנה שקופה בצד הלקוח:
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
+ מה קורה? ספריה נפרדת של "כניסת ספרייה" (דורה) (מוצפנת) עוקבת אחר הקבצים שנמצאים בה
357
+ ספרייה (המכונה גם ספריית ה-Dirent).
358
+ * הפקודה `list` רשימה' קוראת את קבצי הזנת הספריות, מפענחת כל נתיב ברשימה; לאחר מכן מחזיר מטא נתונים עבור כל קובץ
359
+ * פקודות `list` אינן יעילות יותר, במיוחד עבור ספריות עם מספר רב של קבצים
360
+ * הפקודה `write` כותבת קבצי dirent בספריית dirent של כל הורה, באופן רקורסיבי; ואז כותב את הקובץ
361
+ * פקודות `write` O(N), כאשר N = עומק בהיררכיית הספריות
362
+ * הפקודה `remove` מסירה את קובץ ה-dirent המתאים, ואת האב שלו אם ריק, באופן רקורסיבי; לאחר מכן מסיר את הקובץ
363
+ * פקודות `remove` לא רקורסיביות יגרמו לקריאה של O(N) וייתכן כי כמה שיותר מחיקות, כאשר N = עומק בהיררכיית הספריות
364
+ * פקודות `remove` רקורסיביות במערכות קבצים גדולות ועמוקות יכולות להיות יקרות
365
+
366
+ שים לב שגם כשההצפנה בצד הלקוח מופעלת, יריב עם נראות מלאה לצד השרת המוצפן שלך
367
+ אחסון, גם ללא המפתח, עדיין יכול לראות את המספר הכולל של ספריות וכמה קבצים יש בכל אחת, ועם
368
+ קצת מאמץ, גלה חלק מהמבנה הכללי של היררכיית הספריות או את כולו.
369
+ *הערה: השתמשו במבנה שטוח יחסית לאבטחה טובה יותר.*
370
+ היריב לא יידע את שמות הספריות/הקבצים אלא אם כן ידע גם את ההצפנה שלך
371
+ מפתח או פיצח בהצלחה את ההצפנה. אז כל ההימורים מושבתים!
372
+
373
+ ### ביצועים ושמירה במטמון
374
+ הפעולות באחסון מוצפן יכולות להיות איטיות. רשימות והסרות רקורסיביות יכולות להיות איטיות מאוד.
375
+ שמירה במטמון באמצעות redis עוזרת מאוד, אך שימו לב שהמטמון נשטף בכל כתיבה או הסרה.
376
+
377
+ ## סיבוב מפתח
378
+ צור Mobiletto עם המפתח החדש שלך, ולאחר מכן שיקוף את הנתונים הישנים לתוכו:
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
+ ## ממשק מנהל ההתקן
391
+ מנהל התקן הוא כל קובץ JS שמייצא פונקציית 'storageClient' עם החתימה הזו:
392
+
393
+ function storageClient (key, secret, opts)
394
+
395
+ * `key` : מחרוזת, מפתח ה-API שלך (עבור מנהל ההתקן `local` זוהי ספריית הבסיס)
396
+ * `secret` : מחרוזת, סוד ה-API שלך (ניתן להשמיט עבור מנהל ההתקן `local` )
397
+ * `opts` : אובייקט, המאפיינים הם לכל מנהל התקן:
398
+ * עבור `local` , `fileMode` `dirMode` קובעים כיצד נוצרים קבצי יצירה וספריות חדשות
399
+ * עבור `s3` , המאפיין `bucket` נדרש. מאפיינים אופציונליים הם:
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
+ האובייקט שהפונקציה storageClient מחזירה חייב להגדיר את הפונקציות הבאות:
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
+ ## רישום
431
+ Mobiletto משתמש בספריית הרישום של [winston](https://www.npmjs.com/package/winston).
432
+
433
+ יומנים **יכילו** נתיבי קבצים והודעות שגיאה, אך **לעולם לא** יכילו מפתחות, סודות,
434
+ או כל מידע אחר על תצורת החיבור.
435
+
436
+ ### רמת יומן
437
+ השתמש במשתנה הסביבה `MOBILETTO_LOG_LEVEL` כדי להגדיר את רמת היומן, באמצעות אחד
438
+ `npm` המוגדרות ב-[https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
439
+
440
+ רמת ברירת המחדל היא `error` . הרמה המילולית ביותר היא `silly` , אם כי כרגע mobiletto
441
+ לא מתחבר ברמות מתחת `debug`
442
+
443
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
444
+
445
+ ### קובץ לוג
446
+ כברירת מחדל, לוגר כותב למסוף. כדי לשלוח יומנים לקובץ, הגדר את `MOBILETTO_LOG_FILE`
447
+ משתנה הסביבה. בעת כניסה לקובץ, יומנים לא ייכתבו יותר למסוף.
448
+
449
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
450
+
451
+ כדי לכבות את הרישום:
452
+
453
+ MOBILETTO_LOG_FILE=/dev/null
454
+
455
+ </pre>