netinvent/npbackup
1
1
Fork 0
mirror of https://github.com/netinvent/npbackup.git synced 2025-12-18 14:09:23 +08:00
Code Issues Projects Releases Packages Wiki Activity

Update README.md

Browse source
This commit is contained in:
Orsiris de Jong 2023-03-20 14:00:24 +01:00
parent bff14b7399
commit 37242a9fd1
1 changed files with 14 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -60,10 +60,21 @@ So, a new backup solution out of nowhere, packed with too much features for it's
NPBackup relies on the well known [restic](https://restic.net) backup program, which has been battle proven for years.
While restic is a fanstastic program, NPBackup tries to complete restic in order to offer a broader user experience.
## Quickstart CLI
## Quickstart
On Windows, use `NPBackupInstaller.exe` to install NPBackup into program files.
On Linux, just copy `npbackup` to `/usr/local/bin` or use `pip install npbackup`
You may install npbackup via PyPI or use the pre-built executables.
### Prebuilt executables
On linux, copy `npbackup` executable to `/usr/local/bin` and make it executable via `chmod +x /usr/local/bin/npbackup`
On Windows, you can directly execute `npbackup.exe` or use `NPBackupInstaller.exe` to install NPBackup into program files.
### PyPI installation
If you don't want to use the pre-built executables, you can install via pip with `pip install npbackup`
Note that if you want to use the GUI, you'll also need to install tkinter via `yum install python-tkinter` or `apt install python3-tk`.
### Setup
Copy the example config from model `examples/npbackup.conf.dist` into the directory where npbackup is installed.