Tweak fs repo docs (#4348)
- Warns about using in production - Moves some of the constraints up before setup - Moves some text around for better flow --- #### Does this PR need a docs update or release note? - [x] ⛔ No #### Type of change - [x] 🗺️ Documentation
This commit is contained in:
parent
0545365b12
commit
4263095b2b
@ -162,11 +162,9 @@ TLS certificates with the `--disable-tls` or `--disable-tls-verification` flags.
|
|||||||
|
|
||||||
## Filesystem Storage
|
## Filesystem Storage
|
||||||
|
|
||||||
Corso supports creating a repository on a local or network attached filesystem.
|
|
||||||
|
|
||||||
:::note
|
:::note
|
||||||
Filesystem repositories aren't S3 compatible. Copying a local repository directly to S3-compatible object storage
|
Filesystem repositories are only recommended for testing and pre-production use. They aren't recommended for
|
||||||
or the other way around isn't supported.
|
production.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
### Initialize a filesystem repository
|
### Initialize a filesystem repository
|
||||||
@ -175,6 +173,10 @@ Before first use, you need to initialize a Corso repository with `corso repo ini
|
|||||||
[here](../../cli/corso-repo-init-filesystem). Corso will create the directory structure if necessary, including any
|
[here](../../cli/corso-repo-init-filesystem). Corso will create the directory structure if necessary, including any
|
||||||
missing parent directories.
|
missing parent directories.
|
||||||
|
|
||||||
|
Filesystem repositories don't support the `--prefix` option but instead use the `--path` option. Repository directories
|
||||||
|
are created with `0700` permission mode and files withing the repository are created with `0600`. Once created, these
|
||||||
|
repositories can't be moved to object storage later.
|
||||||
|
|
||||||
<Tabs groupId="os">
|
<Tabs groupId="os">
|
||||||
<TabItem value="win" label="Powershell">
|
<TabItem value="win" label="Powershell">
|
||||||
|
|
||||||
@ -242,10 +244,3 @@ docker run --env-file $HOME/.corso/corso.env \\
|
|||||||
|
|
||||||
</TabItem>
|
</TabItem>
|
||||||
</Tabs>
|
</Tabs>
|
||||||
|
|
||||||
### Remarks
|
|
||||||
|
|
||||||
* Filesystem repositories can be quickly set up and are well-suited for smaller scale projects or
|
|
||||||
testing environments. However, they don't offer the same level of interoperability as an S3 compatible object storage.
|
|
||||||
* `--prefix` options aren't supported.
|
|
||||||
* Repository directories are created with `0700` permission mode. Files are created with `0600`.
|
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user