Skip to content

An iocage plugin for Syncthing, a continuous file synchronization program which synchronizes files between two or more computers in real time, safely protected from prying eyes.

License

Notifications You must be signed in to change notification settings

fnichol/iocage-plugin-syncthing

Repository files navigation

iocage-plugin-syncthing

An iocage plugin for Syncthing, a continuous file synchronization program which synchronizes files between two or more computers in real time, safely protected from prying eyes.

CI CI Status
License License

Table of Contents

Installation

This plugin can be installed via the fnichol/iocage-plugin-index plugin collection which is not installed on FreeNAS or TrueOS by default. For example, to install the plugin with a name of st and a dedicated IP address:

$ jail=st
$ ip_addr=10.200.0.110

$ sudo iocage fetch \
  -g https://github.com/fnichol/iocage-plugin-index \
  -P syncthing \
  --name $jail \
  ip4_addr="vnet0|$ip_addr"

Usage

Persisting Data

Configuration

User Serviceable Configuration

The following configuration is intended to be modified by a plugin user.

System Configuration

The following configuration is used to configure and setup the services during post installation and is therefore not intended to be changed or modified by a plugin user.

Code of Conduct

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

Issues

If you have any problems with or questions about this project, please contact us through a GitHub issue.

Contributing

You are invited to contribute to new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.

Before you start to code, we recommend discussing your plans through a GitHub issue, especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.

Release History

This project uses a "deployable master" strategy, meaning that the master branch is assumed to be working and production ready. As such there is no formal versioning process and therefore also no formal changelog documentation.

Authors

Created and maintained by Fletcher Nichol ([email protected]).

License

Licensed under the Mozilla Public License Version 2.0 (LICENSE.txt).

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the MPL-2.0 license, shall be licensed as above, without any additional terms or conditions.

About

An iocage plugin for Syncthing, a continuous file synchronization program which synchronizes files between two or more computers in real time, safely protected from prying eyes.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published