You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-4Lines changed: 14 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,8 +39,8 @@ The simplest form of `<store-specs>` is a `url`. the store `url` defines the sto
39
39
-`dir`: dir is a very simple store that is mostly used for testing. A dir store will store the fs blobs in another location defined by the url path. An example of a valid dir url is `dir:///tmp/store`
40
40
-`zdb`: [zdb](https://github.com/threefoldtech/0-db) is a append-only key value store and provides a redis like API. An example zdb url can be something like `zdb://<hostname>[:port][/namespace]`
41
41
-`s3`: aws-s3 is used for storing and retrieving large amounts of data (blobs) in buckets (directories). An example `s3://<username>:<password>@<host>:<port>/<bucket-name>`
42
-
43
-
`region` is an optional param for s3 stores, if you want to provide one you can add it as a query to the url `?region=<region-name>`
42
+
43
+
`region` is an optional param for s3 stores, if you want to provide one you can add it as a query to the url `?region=<region-name>`
44
44
45
45
`<store-specs>` can also be of the form `<start>-<end>=<url>` where `start` and `end` are a hex bytes for partitioning of blob keys. rfs will then store a set of blobs on the defined store if they blob key falls in the `[start:end]` range (inclusive).
46
46
@@ -73,11 +73,21 @@ Arguments:
73
73
Options:
74
74
-m, --meta <META> path to metadata file (flist)
75
75
-s, --store <STORE> store url in the format [xx-xx=]<url>. the range xx-xx is optional and used for sharding. the URL is per store type, please check docs for more information
76
-
--no-strip-password no_strip_password strips password from store url, otherwise password will be stored in the fl
77
-
and then shipped. Some stores like ZDB has a public namespace which means writing requires a password
76
+
--no-strip-password disables automatic password stripping from store url, otherwise password will be stored in the fl.
78
77
-h, --help Print help
79
78
```
80
79
80
+
#### Password stripping
81
+
82
+
During creation of an flist you will probably provide a password in the URL of the store. This is normally needed to allow write operation to the store (say s3 bucket)
83
+
Normally this password is removed from the store info so it's safe to ship the fl to users. A user of the flist then will only have read access, if configured correctly
84
+
in the store
85
+
86
+
For example a `zdb` store has the notion of a public namespace which is password protected for writes, but open for reads. An S3 bucket can have the policy to allow public reads, but protected writes (minio supports that via bucket settings)
87
+
88
+
If you wanna disable the password stripping from the store url, you can provide the `--no-strip-password` flag during creation. This also means someone can extract
89
+
this information from the fl and gain write access to your store, so be careful how u use it.
90
+
81
91
# Mounting an `fl`
82
92
83
93
Once the `fl` is created it can be distributes to other people. Then they can mount the `fl` which will allow them then to traverse the packed filesystem and also access (read-only) the files.
0 commit comments