Skip to content

Commit

Permalink
Update accounts.md
Browse files Browse the repository at this point in the history
  • Loading branch information
chazlarson authored Oct 20, 2024
1 parent 1ba8ce4 commit a8a9398
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/reference/accounts.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,7 @@ Each tab shows a "section" in the file.
remotes:
- remote: google
settings:
enable_refresh: no
mount: yes
template: google
union: yes
Expand Down Expand Up @@ -210,6 +211,8 @@ Each tab shows a "section" in the file.

`remotes/remote`: The name of the rclone remote for this mount. You can also specify a path to use for the remote. `remote: "google:Media"` or `remote: "my-sftp:/path/to/my/files"` Quotes are important.

`remotes/settings/enable_refresh`: Toggles whether this remote required a refresh service to look for new files [for example, an `sftp` remote].

`remotes/settings/mount`: Toggles whether you want this remote mounted in the file system.

`remotes/settings/template`: The name of the template you want to use for the mount. Currently Saltbox supports 4 options: `google`, `dropbox`, `sftp` and a path to a file ("/opt/mount-templates/remote.j2") containing either jinja2 template or an actual copy of a systemd service file. A [community repo](https://github.com/saltyorg/mount-templates) is maintained of user submitted mount options which can be referenced via path (i.e. `/opt/mount-templates/generic.j2`.) We recommend saving your own custom templates/services in `/opt/mount-templates/custom` to ensure they are backed up and not subject to being overwritten by the repo.
Expand Down

0 comments on commit a8a9398

Please sign in to comment.