From 4263095b2bff0a07fa677c7e1df0ce8495ba768f Mon Sep 17 00:00:00 2001 From: Niraj Tolia Date: Fri, 22 Sep 2023 11:45:50 -0700 Subject: [PATCH] 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_entry: No #### Type of change - [x] :world_map: Documentation --- website/docs/setup/repos.md | 17 ++++++----------- 1 file changed, 6 insertions(+), 11 deletions(-) diff --git a/website/docs/setup/repos.md b/website/docs/setup/repos.md index bd23d285f..d76834d3e 100644 --- a/website/docs/setup/repos.md +++ b/website/docs/setup/repos.md @@ -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. + @@ -242,10 +244,3 @@ docker run --env-file $HOME/.corso/corso.env \\ - -### 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`.