Skip to content

Commit e991cfd

Browse files
docs: removing obsolete information
1 parent 34c2630 commit e991cfd

3 files changed

Lines changed: 12 additions & 34 deletions

File tree

docs/content/installation/ansible/index.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,7 @@ The playbook is installing (or upgrading):
2323
* password files that can be encrypted using ansible vault. These files are located in `./resticprofile/{{ inventory_hostname }}/keys/*`: they will be decrypted and saved to `/root/resticprofile/`.
2424
* other files (like files needed for `--exclude-file`, `--files-from` or anything else you need) from `./resticprofile/{{ inventory_hostname }}/copy/*` to `/root/resticprofile/`
2525

26-
{{% notice style="note" %}}
2726

28-
This new version (21st Feb 2023) installs the `github3` python packages in a virtual environment. This seems to avoid having to compile the `cryptography` package, which is a huge time saver.
29-
30-
Previously, the playbook wasn't running in a virtual environment. For that matter it needed a whole bunch of packages including `cryptography`, which in turn needed the `libssl-dev` package (on debian) and a `rust` compiler.
31-
32-
{{% /notice %}}
3327

3428
### Requirements
3529

docs/content/installation/source.md

Lines changed: 8 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,14 @@ weight: 16
55

66
## Installation from source
77

8-
You can download the source code and compile it, it's actually very easy! all you need to have on your machine is:
9-
- `git` (with `git-bash` on Windows)
10-
- [go compiler](https://golang.org/dl/)
11-
- `GNU Make` which is installed by default on many unix boxes. On debian based distributions (Ubuntu included) the package is called `build-essential`.
8+
It's very easy to compile from the source code.
129

13-
To compile from sources:
10+
Ensure your machine has the following:
11+
- `git` (use `git-bash` on Windows)
12+
- [Go compiler](https://golang.org/dl/)
13+
- `GNU Make` (preinstalled on many Unix systems). On Debian-based distributions (e.g., Ubuntu), install the `build-essential` package.
14+
15+
Compilation:
1416
```shell
1517
git clone https://github.com/creativeprojects/resticprofile.git
1618
cd resticprofile
@@ -36,16 +38,5 @@ Alternatively, a **go-only** build (without `GNU Make`) is accomplished with:
3638
```shell
3739
git clone https://github.com/creativeprojects/resticprofile.git
3840
cd resticprofile
39-
go mod download
40-
go generate ./...
41-
go build -o resticprofile .
41+
go build -v -o resticprofile .
4242
```
43-
44-
45-
{{% notice style="note" %}}
46-
47-
The build step `go generate ./...` installs additional binaries `github.com/zyedidia/eget` and `github.com/vektra/mockery` into `$GOPATH/bin`.
48-
See `generate.go`, `Makefile` and `go.mod` for details on additional dependencies.
49-
50-
{{% /notice %}}
51-

docs/content/installation/upgrade.md

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,31 +3,24 @@ title: "Upgrade"
33
weight: 20
44
---
55

6-
Once installed, you can easily upgrade resticprofile to the latest release using this command:
6+
After installation, upgrade resticprofile to the latest release with this command:
77

88
```shell
99
resticprofile self-update
1010
```
1111

1212
{{% notice style="note" title="Package Managers" %}}
13-
The `self-update` command is not available when installed via a package manager (homebrew, scoop).
14-
You should use the upgrade built in the package manager instead.
13+
The `self-update` command is generally unavailable when installed through a package manager like Homebrew or Scoop. Use the package manager's upgrade feature instead.
1514
{{% /notice %}}
1615

17-
18-
19-
resticprofile will check for a new version from GitHub releases and asks you if you want to update to the new version. If you add the flag `-q` or `--quiet` to the command line, it will update automatically without asking.
16+
Resticprofile checks for new versions from GitHub releases and prompts you to update. Use the `-q` or `--quiet` flag to update automatically without prompting.
2017

2118
```shell
2219
resticprofile --quiet self-update
2320
```
2421

25-
and since version 0.11.0:
22+
or
2623

2724
```shell
2825
resticprofile self-update --quiet
2926
```
30-
31-
{{% notice style="info" %}}
32-
On versions before 0.10.0, there was an issue with self-updating from linux with ARM processors (like a raspberry pi). This was fixed in version 0.10.0
33-
{{% /notice %}}

0 commit comments

Comments
 (0)