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.

Sign up for GitHub

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

Jump to bottom

borgbackup: Improve documentation #83529

Merged
merged 1 commit into from
Apr 2, 2020
Merged

borgbackup: Improve documentation #83529

merged 1 commit into from
Apr 2, 2020
+254 −1

Conversation

ngiger
Copy link
Contributor

@ngiger ngiger commented Mar 27, 2020

Added an example on howto create a backup job to
a remote borg server.

Tested with my borgbase.com account.

Motivation for this change
Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS linux)
  • Built on platform(s)
    • NixOS
    • macOS
    • other Linux distributions
  • Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
  • Tested compilation of all pkgs that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • Determined the impact on package closure size (by running nix path-info -S before and after)
  • Ensured that relevant documentation is up to date
  • Fits CONTRIBUTING.md.

Sorry, something went wrong.

@nixos-discourse
Copy link

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/manual-does-not-specify-who-to-cc-when-submitting-a-patch/6449/1

@ofborg ofborg bot added 6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 8.has: module (update) This PR changes an existing module in `nixos/` labels Mar 27, 2020
@rnhmjoj
Copy link
Contributor

rnhmjoj commented Mar 28, 2020 •
edited
Loading

Thank you for contributing!
I think an example with comments and this long would be better suited for the NixOS manual rathen than the option help. It would be really helpful if you could write a (even small) section on bogbackup. In case here's a guide on how to edit the manual.

@ngiger
Copy link
Contributor Author

ngiger commented Mar 31, 2020 •
edited
Loading

Thanks for your suggestion. Please review also my second patch.
As it is my first contribuion I might well miss some common practices for NixOS, but I invested a few hours and looked at the documentation of postgresql and nextcloud and tried to pick the best out of it.

I did run nix-build nixos/release.nix -A manual.x86_64-linux till it did not throw any errors/warnings.

Also it would be nice if @dotlambda could review these changes, too.

rnhmjoj
rnhmjoj requested changes Mar 31, 2020
View reviewed changes
Copy link
Contributor

@rnhmjoj rnhmjoj left a comment

Choose a reason for hiding this comment

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

Wow, excellent work! I left a few comments, besides that it's good to be merged.
Thank you for your work.

@ngiger
Copy link
Contributor Author

ngiger commented Mar 31, 2020

Fixed the typo.
Limited the length of documentation to 80 chars (except a few lines which are output
of bash shell.
Added the warning about the passphrase and used passCommand in all other examples.

@ofborg ofborg bot added 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin 10.rebuild-linux: 1-10 labels Mar 31, 2020
@ngiger
borgbackup: Moved documentation to NixOS manual and added examples for

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode
c027937 
* creating a local backup
* creating a borgbackup server
* backing up to a borgbackup server
* hints about the Vorta graphical desktop application
* Added documentation about Vorta desktop client

Tested the examples locally and with my borgbase.com account.
@Mic92 Mic92 merged commit 61e6520 into NixOS:master Apr 2, 2020
@timokau
Copy link
Member

timokau commented Apr 2, 2020

This broke eval on master because of the '' in the comment being interpreted as the end of the literal example.

@timokau timokau mentioned this pull request Apr 2, 2020
Closed
10 tasks
@timokau
Copy link
Member

timokau commented Apr 2, 2020

#84102

timokau added a commit to timokau/nixpkgs that referenced this pull request Apr 2, 2020
@timokau
borgbackup: fix syntax
e859cda 
The '' is interpreted as the end of the literal example, breaking
evaluation.

Follow-up to NixOS#83529.
@Mic92
Copy link
Member

Mic92 commented Apr 2, 2020

Yes. It is a bit of a problem that ofborg is not working right now.

This was referenced Apr 2, 2020
Merged
Merged
Merged
@timokau
Copy link
Member

timokau commented Apr 2, 2020

What do you mean? It seemed to work fine before: #84096

@Mic92
Copy link
Member

Mic92 commented Apr 2, 2020

@timokau Ok. It was broken yesterday. But looks like it got fixed again.

@rnhmjoj
Copy link
Contributor

rnhmjoj commented Apr 2, 2020

Sorry I wasn't around at the time...
I just want to thank @ngiger again for this great contribution. NixOS really need more documentation like this.

@rnhmjoj rnhmjoj mentioned this pull request Apr 4, 2020
Closed
@Janik-Haag Janik-Haag added the 12. first-time contribution This PR is the author's first one; please be gentle! label Jun 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Mic92 Mic92

@rnhmjoj rnhmjoj

Assignees
No one assigned
Labels
6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 8.has: module (update) This PR changes an existing module in `nixos/` 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin 10.rebuild-linux: 1-10 12. first-time contribution This PR is the author's first one; please be gentle!
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
6 participants
@ngiger @nixos-discourse @rnhmjoj @timokau @Mic92 @Janik-Haag