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:
Niraj Tolia 2023-09-22 11:45:50 -07:00 committed by GitHub
parent 0545365b12
commit 4263095b2b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -162,11 +162,9 @@ TLS certificates with the `--disable-tls` or `--disable-tls-verification` flags.
## Filesystem Storage
Corso supports creating a repository on a local or network attached filesystem.
:::note
Filesystem repositories aren't S3 compatible. Copying a local repository directly to S3-compatible object storage
or the other way around isn't supported.
Filesystem repositories are only recommended for testing and pre-production use. They aren't recommended for
production.
:::
### 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
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">
<TabItem value="win" label="Powershell">
@ -242,10 +244,3 @@ docker run --env-file $HOME/.corso/corso.env \\
</TabItem>
</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`.