Skip to content

Commit

Permalink
docs: add newuidmap req (#253)
Browse files Browse the repository at this point in the history
  • Loading branch information
eatyourbaby authored Aug 30, 2024
1 parent 40e589f commit 4b94a18
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,26 @@ git:(mistress) | ▶
- stop using symlinks!!!
- no more dev config files when writing code

## requirements

boxxy requires `newuidmap` to function, which is not included by default in all
distributions. To install:

Alpine:
```sh
$ apk add shadow-uidmap
```

Debian / Ubuntu:
```sh
$ apt install uidmap
```

RHEL / Fedora:
```sh
$ yum install shadow-utils
```

## configuration

The boxxy configuration file lives in `~/.config/boxxy/boxxy.yaml`. If none
Expand Down

0 comments on commit 4b94a18

Please sign in to comment.