Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
nicholasdille committed Dec 15, 2023
1 parent e73ddd0 commit 9bb0e6e
Show file tree
Hide file tree
Showing 5 changed files with 52 additions and 12 deletions.
9 changes: 9 additions & 0 deletions docs/chroot.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# chroot

You can also use `uniget` to install under an arbitrary directory. This is useful for creating chroot environments.

Specifying `--prefix` will install the tools under the given directory:

- `PREFIX/usr/local` for tools
- `PREFIX/var/lib/uniget` for state
- `PREFIX/var/cache/uniget` for cached data
33 changes: 33 additions & 0 deletions docs/context.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Context

`uniget` was primarily written to install tools with root permissions. Since version [0.11.0-beta.1](https://github.com/uniget-org/cli/releases/tag/v0.11.0-beta.1) to install in user context.

## Global context

Installation in global context requires root permissions or `sudo` to work. This will install the tools in the following directories:

- `/usr/local` for tools
- `/var/lib/uniget` for state
- `/var/cache/uniget` for cached data

You can modify these directories with the `--target`, `--lib-root` and `--cache-root` flags.

### Example

XXX

## User context

If root permissions are not available or not desired, add the `--user` flag to install in user context. This will install the tools in the user's home directory using the following paths:

- `~/.local` for tools
- `~/.local/var/lib/uniget` for state
- `~/.cache/uniget` for cached data

Please make sure that `~/.local/bin` (and similar) is in your `PATH` environment variable.

You cannot use `--prefix` or `--target` in user context. But the state and cache directories can be changed with the `--lib-root` and `--cache-root` flags.

### Example

XXX
3 changes: 0 additions & 3 deletions docs/impressum.md

This file was deleted.

13 changes: 7 additions & 6 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
# Welcome to uniget

XXX
The universal installer and updater for (container) tools

XXX [CLI](https://github.com/uniget-org/cli)
And the last binary you will ever need to install :-)

XXX [tools](https://github.com/uniget-org/tools)
Apart from this documentation, check out the following links:

XXX [tools](https://github.com/uniget-org/uniget-action)

XXX [tools index](https://tools.uniget.dev)
- The source code of the CLI is available [here](https://github.com/uniget-org/cli)
- All tools available to uniget are defined [here](https://github.com/uniget-org/tools)
- The GitHub action is available [here](https://github.com/uniget-org/uniget-action)
- All tools available to uniget are listed [here](https://tools.uniget.dev)
6 changes: 3 additions & 3 deletions mkdocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ nav:
- Usage:
- Installation: installation.md
- Quickstart: quickstart.md
- Context: context.md
- chroot: chroot.md
- Concepts:
- Overview: concepts.md
- Manifest: manifest.md
- Docker: docker.md
- Renovate: renovate.md
- Air-Gapped: air-gapped.md
- XXX:
- Impressum: impressum.md
- Air-Gapped: air-gapped.md

0 comments on commit 9bb0e6e

Please sign in to comment.