Skip to content

Commit

Permalink
Expand note about using an env var into README
Browse files Browse the repository at this point in the history
  • Loading branch information
r-ash committed Jan 31, 2024
1 parent e60cbe8 commit cd7abe4
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/<name>/<id>` where `<name>` is the report name and `<id>` 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).

Expand Down

0 comments on commit cd7abe4

Please sign in to comment.