Skip to content

Commit 09f1fad

Browse files
committed
Add installation instructions.
1 parent 31cff59 commit 09f1fad

File tree

2 files changed

+28
-0
lines changed

2 files changed

+28
-0
lines changed

Makefile

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@ totpm-$(VERSION)-1.fc$(FEDORA_RELEASE).$(ARCH).rpm: totpm-$(VERSION)-1.fc$(FEDOR
2121
fedpkg --release f$(FEDORA_RELEASE) mockbuild
2222
cp -a results_totpm/$(VERSION)/1.fc$(FEDORA_RELEASE)/totpm-$(VERSION)-1.fc$(FEDORA_RELEASE).$(ARCH).rpm ./
2323

24+
.PHONY: fedora-package
25+
fedora-package: totpm-$(VERSION)-1.fc$(FEDORA_RELEASE).$(ARCH).rpm
26+
2427
.PHONY: test
2528
test:
2629
cargo test --features=dbus-tests,install

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,31 @@ It uses fingerprint verification via fprintd to ensure that only a user that is
44
can generate one-time codes.
55

66

7+
## Installation
8+
At the time of writing, `totpm` only supports TPM2.0-capable x86-64 Linux systems.
9+
10+
`totpm` is pre-release software, and may be a bit annoying to install before the first official version.
11+
12+
13+
### Fedora
14+
1. Clone the repository.
15+
2. Run `make FEDORA_RELEASE=<version> fedora-package` to build an RPM.
16+
Replace `<version>` with whichever Fedora release you are running. `totpm` has been tested on Fedora 40, 41 and 42.
17+
3. Install the resulting package with `dnf`.
18+
19+
20+
### Other Linux (system install)
21+
1. Clone the repository.
22+
2. Run `cargo build --release --features=install` to build the `totpm` binary.
23+
3. Run `./target/release/totpm init` to install `totpm` for all users on the system.
24+
25+
26+
### Other Linux (local install)
27+
1. Clone the repository.
28+
2. Run `cargo install --release` to build and install the `totpm` binary.
29+
3. Run `totpm init --local` to set up `totpm` for the current user.
30+
31+
732
## Implementation details
833
`totpm` can be used either in system mode or in local mode. System mode highly recommended as it is more secure
934
against local attackars. Local mode is only recommended in cases where the user is not able to install

0 commit comments

Comments
 (0)