From cd7abe4d6e54b7a1357eed71c9157af41f0cf61f Mon Sep 17 00:00:00 2001 From: Robert Ashton Date: Wed, 31 Jan 2024 15:26:44 +0000 Subject: [PATCH] Expand note about using an env var into README --- README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6e62051..b1df43b 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,26 @@ remote: Where -* `path` is the path to your shared drive or the name of an environment variable. If you are working with other people we recommend you use an environment variable with the value set in `orderly_envir.yml`. +* `path` is the path to your shared drive or the name of an environment variable. + +If you are working with other people we recommend you use an environment variable with the value set in `orderly_envir.yml`. To do so, create or add to a file `orderly_envir.yml` at the root of your orderly project. + +``` +SHAREPOINT_PATH: /home/me/path/to/sharepoint/drive +``` + +And then in your `orderly_config.yml` set + +``` +remote: + real: + driver: orderly.sharedrive::orderly_remote_sharedrive + args: + path: $SHAREPOINT_PATH + +``` + +Add `orderly_envir.yml` to your gitignore, then each user of your repo can set it as appropriate for their machine. `orderly.sharedrive` will store files as `archive//` where `` is the report name and `` is a zip archive of the report contents. These must be treated as read-only and must not be modified (they do not have a file extension to help this).