Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add dependencies to readme #97

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Add dependencies to readme #97

wants to merge 3 commits into from

Conversation

brndd
Copy link

@brndd brndd commented Jan 24, 2021

This is probably useful information to have.

The branch is open to edits from maintainers so feel free to change things if it's not formatted like you prefer, or just close the PR and do it manually on the main repo :-)

README.md Outdated
* awk
* util-linux
* sed
* openssh-clients
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isnt this optional?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The only one of these four required is awk.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

actually util-linux is required for findmnt

README.md Show resolved Hide resolved
README.md Outdated
### Optional dependencies:

* pv (for progress bar during backup)
* notify-send (for desktop notifications)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will the app crash, if you dont have notify-send installed, and do not specify --quiet? Looking at the code, it will crash, maybe that should be fixed?

Copy link
Collaborator

@wesbarnett wesbarnett Jan 30, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

libnotify is the optional dependency (which provides notify-send). The app won't crash if it is not present. It will continue as if the user specified --quiet.

README.md Show resolved Hide resolved
@wesbarnett
Copy link
Collaborator

wesbarnett commented Jan 30, 2021

Here's a list of programs called in the script:

  • mkfifo (coreutils package)
  • systemd-cat (systemd package)
  • which
  • notify-send (libnotify package) - optional
  • pv - optional
  • cat (coreutils package)
  • sudo - might not be optional?
  • findmnt (util-linux package)
  • grep
  • awk (gawk package)
  • btrfs
  • snapper
  • rsync - needed to send info.xml to remote hosts - optional
  • cp (coreutils package)
  • sync (coreutils package)
  • ssh (openssh package) - optional

So, at least on Arch Linux this is the list:

btrfs coreutils gawk grep snapper sudo systemd util-linux which

Excluding those in base this is:

btrfs snapper sudo which

And here's the optional list:

libnotify pv rsync openssh ssh

@NicoHood
Copy link
Collaborator

Why is sudo required? Cant you just su as root and then do the operation? I mean I never did that for some pretty obvious reasons, but it should be possible, right?

Which should be installed on every system, right?
By the way: You can check installed packages with command, see an example: https://github.com/NicoHood/gpgit/blob/master/gpgit.sh#L145

Aaaand you forgot the bash dependency ;-D

@wesbarnett
Copy link
Collaborator

Why is sudo required? Cant you just su as root and then do the operation? I mean I never did that for some pretty obvious reasons, but it should be possible, right?

Which should be installed on every system, right?

By the way: You can check installed packages with command, see an example: https://github.com/NicoHood/gpgit/blob/master/gpgit.sh#L145

Aaaand you forgot the bash dependency ;-D

sudo is needed for notifications so it would still be optional https://github.com/wesbarnett/snap-sync/blob/276e17794064ea8f26c4e28a6c5672b5ca00fadb/bin/snap-sync#L163

@brndd
Copy link
Author

brndd commented Jan 31, 2021

OK, I've updated the list as you specified above. I included packages that on Arch would be included in base to make the list easier to adapt for people using other distros (and maybe some weirdos don't have base installed). btrfs send etc. seem to come from btrfs-progs on Arch too rather than btrfs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants