mobiletto 1.1.10 → 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.
- package/README.md +48 -0
- package/docs/README.md +113 -0
- package/docs/af/README.md +455 -0
- package/docs/am/README.md +455 -0
- package/docs/ar/README.md +455 -0
- package/docs/az/README.md +455 -0
- package/docs/be/README.md +455 -0
- package/docs/bg/README.md +455 -0
- package/docs/bn/README.md +455 -0
- package/docs/bs/README.md +455 -0
- package/docs/ca/README.md +455 -0
- package/docs/ceb/README.md +455 -0
- package/docs/co/README.md +455 -0
- package/docs/cs/README.md +455 -0
- package/docs/cy/README.md +455 -0
- package/docs/da/README.md +455 -0
- package/docs/de/README.md +455 -0
- package/docs/el/README.md +455 -0
- package/docs/eo/README.md +455 -0
- package/docs/es/README.md +455 -0
- package/docs/et/README.md +455 -0
- package/docs/eu/README.md +455 -0
- package/docs/fa/README.md +455 -0
- package/docs/fi/README.md +455 -0
- package/docs/fr/README.md +455 -0
- package/docs/fy/README.md +455 -0
- package/docs/ga/README.md +455 -0
- package/docs/gd/README.md +455 -0
- package/docs/gl/README.md +455 -0
- package/docs/gu/README.md +455 -0
- package/docs/ha/README.md +455 -0
- package/docs/haw/README.md +455 -0
- package/docs/he/README.md +455 -0
- package/docs/hi/README.md +455 -0
- package/docs/hmn/README.md +455 -0
- package/docs/hr/README.md +455 -0
- package/docs/ht/README.md +455 -0
- package/docs/hu/README.md +455 -0
- package/docs/hy/README.md +455 -0
- package/docs/id/README.md +455 -0
- package/docs/ig/README.md +455 -0
- package/docs/is/README.md +455 -0
- package/docs/it/README.md +455 -0
- package/docs/iw/README.md +455 -0
- package/docs/ja/README.md +455 -0
- package/docs/jv/README.md +455 -0
- package/docs/ka/README.md +455 -0
- package/docs/kk/README.md +455 -0
- package/docs/km/README.md +455 -0
- package/docs/kn/README.md +455 -0
- package/docs/ko/README.md +455 -0
- package/docs/ku/README.md +455 -0
- package/docs/ky/README.md +455 -0
- package/docs/la/README.md +455 -0
- package/docs/lb/README.md +455 -0
- package/docs/lo/README.md +455 -0
- package/docs/lt/README.md +455 -0
- package/docs/lv/README.md +455 -0
- package/docs/mg/README.md +455 -0
- package/docs/mi/README.md +455 -0
- package/docs/mk/README.md +455 -0
- package/docs/ml/README.md +455 -0
- package/docs/mn/README.md +455 -0
- package/docs/mr/README.md +455 -0
- package/docs/ms/README.md +455 -0
- package/docs/mt/README.md +455 -0
- package/docs/my/README.md +455 -0
- package/docs/ne/README.md +455 -0
- package/docs/nl/README.md +455 -0
- package/docs/no/README.md +455 -0
- package/docs/ny/README.md +455 -0
- package/docs/or/README.md +455 -0
- package/docs/pa/README.md +455 -0
- package/docs/pl/README.md +455 -0
- package/docs/ps/README.md +455 -0
- package/docs/pt/README.md +455 -0
- package/docs/ro/README.md +455 -0
- package/docs/ru/README.md +455 -0
- package/docs/rw/README.md +455 -0
- package/docs/sd/README.md +455 -0
- package/docs/si/README.md +455 -0
- package/docs/sk/README.md +455 -0
- package/docs/sl/README.md +455 -0
- package/docs/sm/README.md +455 -0
- package/docs/sn/README.md +455 -0
- package/docs/so/README.md +455 -0
- package/docs/sq/README.md +455 -0
- package/docs/sr/README.md +455 -0
- package/docs/st/README.md +455 -0
- package/docs/su/README.md +455 -0
- package/docs/sv/README.md +455 -0
- package/docs/sw/README.md +455 -0
- package/docs/ta/README.md +455 -0
- package/docs/te/README.md +455 -0
- package/docs/tg/README.md +455 -0
- package/docs/th/README.md +455 -0
- package/docs/tk/README.md +455 -0
- package/docs/tl/README.md +455 -0
- package/docs/tr/README.md +455 -0
- package/docs/tt/README.md +455 -0
- package/docs/ug/README.md +455 -0
- package/docs/uk/README.md +455 -0
- package/docs/ur/README.md +455 -0
- package/docs/uz/README.md +455 -0
- package/docs/vi/README.md +455 -0
- package/docs/xh/README.md +455 -0
- package/docs/yi/README.md +455 -0
- package/docs/yo/README.md +455 -0
- package/docs/zh/README.md +455 -0
- package/docs/zu/README.md +455 -0
- package/drivers/b2/index.js +24 -6
- package/hokey.json +16 -0
- package/index.js +7 -2
- package/package.json +1 -1
- package/test/api.spec.js +12 -9
- 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
|
+
* [Μεταδεδομένα](#Μεταδεδομένα)
|
|
13
|
+
* [Εναλλακτικό στυλ εισαγωγής](#Alternate-import-style)
|
|
14
|
+
* [Αποθήκευση στην κρυφή μνήμη](#Caching)
|
|
15
|
+
* [Mirroring](#Mirroring)
|
|
16
|
+
* [Διαφανής κρυπτογράφηση](#Transparent-encryption)
|
|
17
|
+
* [Περιστροφή κλειδιού](#Κλειδιά περιστροφή)
|
|
18
|
+
* [Διεπαφή προγράμματος οδήγησης](#Διασύνδεση προγράμματος οδήγησης)
|
|
19
|
+
* [Καταγραφή](#Καταγραφή)
|
|
20
|
+
|
|
21
|
+
# Διαβάστε αυτό σε άλλη γλώσσα
|
|
22
|
+
Αυτό το έγγραφο README.md έχει μεταφραστεί, μέσω [hokeylization](https://github.com/cobbzilla/hokeylization), σε
|
|
23
|
+
**[κάθε γλώσσα που υποστηρίζεται από τη Μετάφραση Google](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
|
+
[🇮🇳 Μαράνθη](../mr/README.md)
|
|
40
|
+
[🇵🇱 Πολωνικά](../pl/README.md)
|
|
41
|
+
[🇧🇷 Πορτογαλικά](../pt/README.md)
|
|
42
|
+
[🇷🇺 Ρωσικά](../ru/README.md)
|
|
43
|
+
[🇰🇪 Σουαχίλι](../sw/README.md)
|
|
44
|
+
[🇵🇭 Ταγκαλόγκ](../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
|
+
* συμπεριλάβετε τη διεύθυνση URL της σελίδας (αντιγραφή/επικόλληση από τη γραμμή διευθύνσεων του προγράμματος περιήγησης)
|
|
61
|
+
* συμπεριλάβετε το ακριβές κείμενο που είναι λάθος (αντιγραφή/επικόλληση από το πρόγραμμα περιήγησης)
|
|
62
|
+
* παρακαλώ περιγράψτε τι είναι λάθος -- είναι λάθος η μετάφραση; είναι κάπως χαλασμένη η μορφοποίηση;
|
|
63
|
+
* Προσφέρετε ευγενικά μια πρόταση για καλύτερη μετάφραση ή πώς το κείμενο πρέπει να μορφοποιηθεί σωστά
|
|
64
|
+
* **Ευχαριστώ!**
|
|
65
|
+
|
|
66
|
+
## Γιατί Mobiletto;
|
|
67
|
+
|
|
68
|
+
### Αντίο κλείδωμα πωλητή!
|
|
69
|
+
Οι διάφοροι πάροχοι αποθήκευσης cloud έχουν μη συμβατά API. Ακόμη και εκείνοι που προσπαθούν για "συμβατότητα S3"
|
|
70
|
+
έχουν ιδιοσυγκρασιακές συμπεριφορές.
|
|
71
|
+
|
|
72
|
+
Όταν επιλέγετε έναν συγκεκριμένο προμηθευτή αποθήκευσης για την εφαρμογή σας, εάν κωδικοποιήσετε απευθείας στο API του, την εφαρμογή σας
|
|
73
|
+
εξαρτάται πλέον από αυτήν την υπηρεσία. Καθώς περνά ο καιρός και συσσωρεύεται κώδικας, αλλάζουν προμηθευτές
|
|
74
|
+
όλο και πιο αβάσιμος. Καλώς ήλθατε στον διασκεδαστικό κόσμο του προμηθευτή lock-in!
|
|
75
|
+
|
|
76
|
+
Το Mobiletto σχεδιάστηκε για να λύσει αυτό το πρόβλημα. Κωδικοποιώντας την εφαρμογή σας στο API του mobiletto, μπορείτε εύκολα
|
|
77
|
+
αλλάξτε παρόχους αποθήκευσης και γνωρίζετε ότι το επίπεδο αποθήκευσης της εφαρμογής σας θα συμπεριφέρεται πανομοιότυπα.
|
|
78
|
+
|
|
79
|
+
### Εκτεταμένες δοκιμές
|
|
80
|
+
Όλοι οι οδηγοί ελέγχονται για την ίδια συμπεριφορά με 60+ δοκιμές για κάθε οδηγό.
|
|
81
|
+
Δοκιμάζουμε όλους τους οδηγούς με κάθε συνδυασμό:
|
|
82
|
+
* Κρυπτογράφηση: τόσο ενεργοποιημένη όσο και απενεργοποιημένη
|
|
83
|
+
* Redis cache: τόσο ενεργοποιημένη όσο και απενεργοποιημένη
|
|
84
|
+
|
|
85
|
+
Αυτή η προσέγγιση μας δίνει ήσυχο ότι το mobiletto θα συμπεριφέρεται το ίδιο ανεξάρτητα από το πρόγραμμα οδήγησης που χρησιμοποιείτε,
|
|
86
|
+
και ανεξάρτητα από το αν ενεργοποιείτε την προσωρινή αποθήκευση ή/και την κρυπτογράφηση.
|
|
87
|
+
|
|
88
|
+
### Υποστήριξη προγραμμάτων οδήγησης
|
|
89
|
+
Τρέχοντα προγράμματα οδήγησης αποθήκευσης Mobiletto:
|
|
90
|
+
* `s3` : Amazon S3
|
|
91
|
+
* `b2` : Backblaze B2
|
|
92
|
+
* `local` τοπικό» : τοπικό σύστημα αρχείων
|
|
93
|
+
|
|
94
|
+
*Οι συνεισφορές για την υποστήριξη περισσότερων παρόχων αποθήκευσης cloud είναι πολύ ευπρόσδεκτες!*
|
|
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
|
+
Ένα σύντομο παράδειγμα χρήσης του προγράμματος οδήγησης mobiletto `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, mobile για να συνδεθείτε εδώ αντί για localhost
|
|
274
|
+
* Ορίστε το `MOBILETTO_REDIS_PORT` env var, αυτή η θύρα θα χρησιμοποιηθεί
|
|
275
|
+
|
|
276
|
+
Το Mobiletto θα αποθηκεύσει όλα τα κλειδιά του redis με το πρόθεμα `_mobiletto__` . Μπορείτε να το αλλάξετε αυτό
|
|
277
|
+
ορίζοντας την `MOBILETTO_REDIS_PREFIX`
|
|
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
|
+
### Δεν θέλετε προσωρινή αποθήκευση redis;
|
|
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
|
+
σίγουρα θα θέλετε να είναι ενεργοποιημένη η προσωρινή μνήμη `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` εκτελεί μια εφάπαξ αντιγραφή όλων των αρχείων από το ένα κινητό στο άλλο.
|
|
318
|
+
Δεν εκτελεί καμία διαδικασία για τη διατήρηση του καθρέφτη με την πάροδο του χρόνου. Εκτελέστε ξανά την εντολή `mirror`
|
|
319
|
+
για να συγχρονίσετε τυχόν αρχεία που λείπουν.
|
|
320
|
+
|
|
321
|
+
Η επιστρεφόμενη τιμή από το `mirror` είναι ένα απλό αντικείμενο με μετρητές για το πόσα αρχεία ήταν επιτυχώς
|
|
322
|
+
mirrored και πόσα αρχεία είχαν σφάλματα:
|
|
323
|
+
|
|
324
|
+
{
|
|
325
|
+
success: count-of-files-mirrored,
|
|
326
|
+
errors: count-of-files-with-errors
|
|
327
|
+
}
|
|
328
|
+
|
|
329
|
+
ΠΡΟΕΙΔΟΠΟΙΗΣΗ: Η αντιστοίχιση μεγάλων συνόλων δεδομένων μπορεί να είναι πολύ χρονοβόρα και εντατική σε εύρος ζώνης
|
|
330
|
+
|
|
331
|
+
Με τη σημασιολογία της ονομασίας `mirror` , μπορεί μερικές φορές να προκαλεί σύγχυση η κατανόηση του ποιος είναι
|
|
332
|
+
αναγνώστης και ποιος είναι ο συγγραφέας. Φανταστείτε το σαν μια δήλωση ανάθεσης: το "αριστερό κινητό"
|
|
333
|
+
είναι το πράγμα στο οποίο εκχωρείται (τα δεδομένα αντικατοπτρίζονται γραμμένα) και το "δεξιό κινητό" (το
|
|
334
|
+
όρισμα στη μέθοδο `mirror` 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
|
+
Τι συμβαίνει? Ένας ξεχωριστός κατάλογος "καταχώρησης καταλόγου" (dirent) (κρυπτογραφημένος) παρακολουθεί ποια αρχεία υπάρχουν σε αυτόν
|
|
357
|
+
κατάλογος (γνωστός και ως ο dirent directory).
|
|
358
|
+
* Η εντολή `list` διαβάζει τα αρχεία καταχώρισης καταλόγου, αποκρυπτογραφεί κάθε διαδρομή που παρατίθεται. στη συνέχεια επιστρέφει μεταδεδομένα για κάθε αρχείο
|
|
359
|
+
* Οι εντολές `list` είναι πιο αναποτελεσματικές, ειδικά για καταλόγους με μεγάλο αριθμό αρχείων
|
|
360
|
+
* Η εντολή `write` εγγράφει αρχεία dirent στον κατάλογο dirent κάθε γονέα, αναδρομικά. στη συνέχεια γράφει το αρχείο
|
|
361
|
+
* Οι εντολές `write` θα επιφέρουν εγγραφές O(N), με N = βάθος στην ιεραρχία του καταλόγου
|
|
362
|
+
* Η εντολή "remove" αφαιρεί το αντίστοιχο αρχείο `remove` και το γονικό του αρχείο εάν είναι κενό, αναδρομικά. στη συνέχεια αφαιρεί το αρχείο
|
|
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
|
+
* Για το `fileMode` `local` και `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` , αν και αυτή τη στιγμή είναι κινητό
|
|
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>
|