Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rafi/ansible-modules-syncthing
Collection of modules for Syncthing management.
https://github.com/rafi/ansible-modules-syncthing
ansible ansible-modules automation filesystem storage syncthing
Last synced: about 5 hours ago
JSON representation
Collection of modules for Syncthing management.
- Host: GitHub
- URL: https://github.com/rafi/ansible-modules-syncthing
- Owner: rafi
- Created: 2018-11-28T19:23:57.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2021-02-19T16:41:40.000Z (over 3 years ago)
- Last Synced: 2023-03-11T01:23:22.712Z (over 1 year ago)
- Topics: ansible, ansible-modules, automation, filesystem, storage, syncthing
- Language: Python
- Size: 4.88 KB
- Stars: 12
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Ansible Modules for Syncthing
Collection of modules for [Syncthing](https://syncthing.net) management.
## Install
Copy the `./library` directory to your Ansible project and ensure your
`ansible.cfg` has this line:
```ini
[defaults]
library = ./library
```
Please note this module was test on:
* Ubuntu 16.04 with Syncthing v0.14.52
Please report successful usage on other platforms/versions.
## Usage
See [example playbooks](./playbooks) for robust feature usage:
* [install_syncthing.yml] - Install Syncthing on Ubuntu (with systemd)
* [manage.yml] - Ensure Syncthing devices and folders across devices
[install_syncthing.yml]: http://
[manage.yml]: http://
## Modules
### Module: `syncthing_device`
Manage synced devices. Add, remove or pause devices using ID.
Examples:
```yml
# Add a device to share with, use auto-configuration
- name: Add syncthing device
syncthing_device:
id: ABCDEFG-ABCDEFG-ABCDEFG-ABCDEFG-ABCDEFG-ABCDEFG-ABCDEFG-ABCDEFG
name: my-device-name
# Add a device to share with
- name: Add syncthing device
syncthing_device:
id: ABCDEFG-ABCDEFG-ABCDEFG-ABCDEFG-ABCDEFG-ABCDEFG-ABCDEFG-ABCDEFG
name: my-other-device
host: http://127.0.0.1:8384
api_key: aBCDeFG1h2IJKlmNopq3rs45uvwxy6Zz
# Pause an existing device
- name: Pause syncthing device
syncthing_device:
id: ABCDEFG-ABCDEFG-ABCDEFG-ABCDEFG-ABCDEFG-ABCDEFG-ABCDEFG-ABCDEFG
name: my-device-name
state: pause
# Remove an existing device
- name: Remove syncthing device
syncthing_device:
id: ABCDEFG-ABCDEFG-ABCDEFG-ABCDEFG-ABCDEFG-ABCDEFG-ABCDEFG-ABCDEFG
name: my-device-name
state: absent
```
### Module: `syncthing_folder`
Manage synced devices. Add, remove or pause devices using ID.
Examples:
```yml
# Add a folder to synchronize with another device, use auto-configuration
- name: Add syncthing folder
syncthing_folder:
path: ~/Documents
id: documents
devices:
- ABCDEFG-ABCDEFG-ABCDEFG-ABCDEFG-ABCDEFG-ABCDEFG-ABCDEFG-ABCDEFG
# Add a folder to share with several devices, specify host and api key
- name: Add syncthing folder
syncthing_folder:
path: ~/Downloads
id: downloads
devices:
- ABCDEFG-ABCDEFG-ABCDEFG-ABCDEFG-ABCDEFG-ABCDEFG-ABCDEFG-ABCDEFG
- GFEDCBA-GFEDCBA-GFEDCBA-GFEDCBA-GFEDCBA-GFEDCBA-GFEDCBA-GFEDCBA
host: http://127.0.0.1:8384
api_key: aBCDeFG1h2IJKlmNopq3rs45uvwxy6Zz
# Pause an existing folder
- name: Pause syncthing folder
syncthing_folder:
id: downloads
state: pause
# Remove an existing folder
- name: Remove syncthing folder
syncthing_folder:
id: downloads
state: absent
```
## License
Copyright: (c) 2018, Rafael Bodill ``
GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)