Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
rumpelsepp committed Oct 30, 2024
1 parent 49d9a84 commit 1aa0cf4
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,24 @@
# devman

A tool for **dev**elopment using pod**man**.
Create simple development containers with easy access to the host filesystem using a correct user id mapping.
Features such as sharing SSH config (e.g. SSH agent) or starting GUI applications from the container are supported.

## Install

On the system level, the [`podman`](https://podman.io/) tool is required.
It is available and packaged for a large number of systems.
Please refer to the official manual containing [install instructions](https://podman.io/docs/installation).

For performance reason you could consider using native overlay mounts.
Make sure that the following is included in your storage configuration.

```
$ cat ~/.config/containers/storage.conf
[storage]
driver = "overlay"
```

### pipx

```
Expand All @@ -21,3 +32,25 @@ $ pipx install devman
```
$ uvx devman
```

## Quickstart

Ready to use containers with a lot of pre-installed development tools are provided by the Github container registry associated with this repo.

Pull the default Debian container (the `Containerfile` is located in this repository in `containers/debian/`):

```
$ devman pull
```

Start a `fish` shell in a container:

```
$ devman run fish
```

The current directory `DIR` from the host is mounted in the container at `/home/dev/CWD/DIR`.
The user `dev` corresponds to the user that invoked `devman`.

If you would like to share your SSH config with the container, add `--ssh`.
If you want to be able to start GUI applications from the container, add `--gui`.

0 comments on commit 1aa0cf4

Please sign in to comment.