edward/cloudflare-ddns
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

More docs

Browse source
This commit is contained in:
Edward Shen 2024-12-04 23:55:11 -08:00
parent 23ceeffcfa
commit fc2361614e
Signed by: edward
GPG key ID: 0A400FFE10097C30
2 changed files with 26 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
Cargo.toml
View file

@ -30,5 +30,8 @@ strip = "symbols"
lto = "thin" lto = "thin"
codegen-units = 1 codegen-units = 1
[package.metadata.deb]
name = "cloudflare-ddns-rs"
[package.metadata.deb.systemd-units] [package.metadata.deb.systemd-units]
unit-scripts = "systemd/" unit-scripts = "systemd/"

26
README.md
View file

@ -29,8 +29,15 @@ different IP address.
## Installation ## Installation
First, create an initial file at `/etc/cloudflare-ddns.toml`. Populate it with First, create an initial file at `/etc/cloudflare-ddns.toml`. Set the permissions
the following: so that it is readable and writable by `root` only:
```
# sudo touch /etc/cloudflare-ddns.toml
# chmod 600 /etc/cloudflare-ddns.toml
```
Populate it with the following:
```toml ```toml
[account] [account]
@ -128,4 +135,17 @@ successful, installation is complete.
A `.deb` package is created via [`cargo-deb`]. A `.deb` package is created via [`cargo-deb`].
[`cargo-deb`]: https://github.com/kornelski/cargo-deb [`cargo-deb`]: https://github.com/kornelski/cargo-deb
## Security
This project attempts to take security seriously. Please note the following
hardening notes applied by default.
### Hardened `systemd` service configuration
In principle, this service needs very little access to a host, and needs access
to the internet. As a result, the default `systemd` service configuration
aggressively restricts the capabilities of the binary to a minimum set of
features, namely access to the internet and dependency to do so. If you believe
more directives could be provided, please create a PR.