update docs

This commit is contained in:
Swapnil 2024-05-08 01:28:49 +05:30
parent cb6a2ca328
commit 78eb1641ec
Signed by: swapnil
GPG Key ID: 58029C48BB100574
1 changed files with 15 additions and 7 deletions

View File

@ -37,7 +37,7 @@ options:
required: false required: false
devices: devices:
description: description:
- List of devices to share folder with - List of device ids to share folder with. Always share with self.
required: false required: false
fs_watcher: fs_watcher:
description: description:
@ -65,12 +65,20 @@ author:
EXAMPLES = ''' EXAMPLES = '''
# Add a folder to synchronize with another device # Add a folder to synchronize with another device
- name: Add syncthing folder - name: Create folder
community.syncthing.folder: become: yes
id: box become_user: syncthing
path: ~/box community.syncthing.folder:
devices: host: http://localhost
- 1234-1234-1234-1234 unix_socket: /run/syncthing/syncthing.sock
config_file: /var/lib/syncthing/.config/syncthing/config.xml
id: 'my-folder-1'
label: 'my folder 1'
path: '/root/test-folder-1'
devices:
- '1234-1234-1234'
- '5678-5678-5678'
register: folder
''' '''
RETURN = ''' RETURN = '''