Commit Graph

43 Commits

Author SHA1 Message Date
Myna IT Labs 4e545ada0c
Update INSTALL.md
Fixed bad link to CentOS section.  And clarified that this area is applicable for RHEL family of popular OS distributions:  RHEL/CentOS/AlmaLinux
2024-09-23 14:29:14 -07:00
Jim Salter 19fc237476
Update INSTALL.md 2024-02-01 15:05:08 -05:00
Vitalii Zurian a881d22c85
Update INSTALL.md 2023-08-01 10:05:46 +02:00
Christoph Klaffl fda6b52403
Merge branch 'pr765' into pr-merger 2023-03-20 22:28:15 +01:00
Christoph Klaffl 3b0f28184a
Merge branch 'pr701' into pr-merger 2023-03-20 22:13:34 +01:00
Christoph Klaffl e6f40483eb
Merge branch 'pr690' into pr-merger 2023-03-20 22:07:09 +01:00
Christoph Klaffl d5dba5e3ed
Merge branch 'pr670' into pr-merger 2023-03-20 22:01:43 +01:00
Christoph Klaffl dc0f13268b
Merge branch 'pr657' into pr-merger 2023-03-20 21:55:44 +01:00
Christoph Klaffl d55b29ef04
Merge branch 'pr643' into pr-merger 2023-03-20 21:52:24 +01:00
Christoph Klaffl f2982d9313
Merge branch 'pr592' into pr-merger 2023-03-20 21:33:20 +01:00
Daryl Bennett c408bddab4 Include syncoid remote user requirment
Add requirement for syncoid w/ remote hosts to be able to sudo without a password.
Recommends a least privilege configuration option for enabling `NOPASSWD`
2022-09-05 19:45:10 -07:00
Topslakr 1fcf348001
Update Install.md for Centos 8
Updated the install language, and commands, to better server Centos 8 and it's derivatives. Instead of using CPAN, enabling the 'PowerTools' repo will make those modules available for installation and kept current with normal OS updates.

Updated command to enable _and_ start sanoid.timer, instead of using two commands.
2021-12-06 13:57:18 -05:00
Ryan David Sheasby 864ab7f95b
Update debian installation instructions
Previous instructions couldn't actually be copied and pasted. This will update the instructions to work correctly when copied as-is
2021-11-02 11:36:13 +02:00
Daryl Bennett a9ece1c7bf
Include syncoid remote user requirment
Add requirement for syncoid w/ remote hosts to be able to sudo without a password.
Recommends a least privilege configuration option for enabling `NOPASSWD`
2021-08-23 20:22:35 -04:00
Gerhard Roethlin c125835e44 MacOS Install Information
Installation information for running sanoid on MacOS via launchd.
A launchd example plist file is provided in the same way equivalent
files are created on other platforms.
2021-07-23 17:39:28 +02:00
Alex Haydock e0862dff52
Improve documentation for RHEL-family distros 2021-05-02 15:08:28 +01:00
Jim Salter 2de05798f4
Merge pull request #509 from phreaker0/docs-busybox
added note for busybox based distributions
2020-11-01 17:24:39 -05:00
Jim Salter 2acb3e3fea
Merge pull request #501 from phreaker0/docs-centos
extended install instructions for centos if perl dependencies can't b…
2020-11-01 17:23:33 -05:00
Jim Salter 006f897d74
Merge pull request #500 from phreaker0/docs-cron-example
added cron setup example
2020-11-01 17:23:06 -05:00
Leo Winter d7bf12623d
Add git to apt install on Debian 2020-10-06 13:48:34 +00:00
kr4z33 b31a7ba7d8
Update INSTALL.md
"build-essential" was required for me to complete the Debian/Ubuntu instructions.
2020-08-17 19:16:26 -10:00
Christoph Klaffl 909d3f3765
added note for busybox based distributions 2020-02-14 09:37:38 +01:00
Christoph Klaffl b09d2b66fc
typo 2020-02-13 09:26:15 +01:00
Christoph Klaffl 3a7f468939
extended install instructions for centos if perl dependencies can't be found 2020-02-12 20:20:46 +01:00
Christoph Klaffl a3f242d0d4
added cron setup example 2020-02-12 20:10:28 +01:00
Christoph Klaffl ef38110d69
instruct to use the latest stable release instead of master 2020-02-12 18:35:03 +01:00
Havard 1dc77c20ac
Update INSTALL.md
Removed invalid reference to sanoid.conf.example. Tried to make the last sentence clearer.
2019-12-31 14:36:49 +01:00
Christoph Klaffl 5d7ee40405
fix centos package name 2019-05-24 08:29:54 +02:00
Jim Salter 681820ceab
Merge pull request #370 from g-a-c/patch-1
Update INSTALL.md
2019-05-22 10:33:09 -04:00
Jim Salter 1ca9a6d0c0
Merge pull request #368 from danielewood/patch-1
Added line to enable sanoid-prune.service
2019-05-22 10:32:45 -04:00
Jim Salter 39af643817
Merge pull request #375 from johnramsden/master
Declare that sanoid service 'Wants' sanoid-prune
2019-05-22 10:32:28 -04:00
Jim Salter 2fceef65a3
Merge branch 'master' into patch-1 2019-05-22 10:32:12 -04:00
Christoph Klaffl 83c5e2c29b
added new dependency to all packages and install instructions 2019-05-20 18:31:38 +02:00
Gavin Chappell 67ff4fed77 Update INSTALL.md
`debhelper` is also a pre-requisite for Debian systems
2019-05-15 20:43:32 +01:00
John Ramsden ce93d89ec8
Declare that sanoid service 'Wants' sanoid-prune
Also add --verbose flag for logging as mentioned in readme.

sanoid-prune.service never runs. Declare a 'Wants' dependency,
and 'Before' condition in the sanoid unit, and prune is run
after 'sanoid.service'.
2019-04-20 15:34:49 -07:00
Daniel Wood faf268b3b2
Added line to enable sanoid-prune.service
@phreaker0,
I found that on my systems, sanoid-pune.service did nothing until I enabled it, then it was called by sanoid.service.
2019-04-01 21:50:29 -07:00
Christoph Klaffl 1900ecaf32
added verbose cmd line flags for journald logging 2019-03-31 15:25:30 +02:00
Christoph Klaffl 90b8c92ec6
sanoid-prune.service is indeed referenced and run after the sanoid.service
Revert "Fix systemd service definitions."

This reverts commit 17e15c2f54.
2019-03-31 15:21:19 +02:00
Daniel Wood 17e15c2f54
Fix systemd service definitions.
`sanoid-prune.service` is not referenced by a timer, so I have removed it.

I also modified the behavior of sanoid.service so it will take and prune snapshots according to the config file:
 - `--cron` switch is required for it to take action as a service
 - `--verbose` is there so that useful logs appear under `journalctl -t sanoid` (I personally run `--debug`)
2019-03-29 09:37:28 -07:00
Jim Salter 68cc59a41c
Update INSTALL.md 2019-03-29 11:53:56 -04:00
Christoph Klaffl eefc659c03
update the install instruction with recent changes 2019-02-20 08:15:45 +01:00
Andrew Bobulsky 0f669a304a
Cleaned up Configuration section to match the rest of the document 2018-03-26 03:54:28 -04:00
Andrew Bobulsky 429da3a131
Add comprehensive installation instructions
Converts the old INSTALL file to a markdown-formatted INSTALL.md file
that contains comprehensive installation instructions for supported
operating systems, and an outline that can be used on others where
Sanoid/Syncoid ought to work.

The Installation section is complete for CentOS/RHEL, and has been
"dressed up" for FreeBSD/Ubuntu. Those ones still need to be completed.
I don't cover the topic of running Syncoid periodically or how to do it
because I don't know. It's probably out of scope for the Installation
guide anyway.

The Configuration sections is intended to walk through some common
setups for sanoid.conf. I suggest just cleaning up the existing conf
file examples and putting them into that section.
2018-03-26 03:44:00 -04:00