Skip to content

Commit

Permalink
readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
OBarronCS committed Oct 13, 2024
1 parent 714c7f1 commit 7d58045
Showing 1 changed file with 14 additions and 16 deletions.
30 changes: 14 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,22 +66,6 @@ pwnbox config set --use-slim
pwnbox config set --use-full
```


## Development
### Manually build the image
```sh
# Base image
docker build . --target base -t pwnbox
# Optional build args:
# --build-arg FULL_BUILD=true

# Image build for WSL
docker build . --target wsl -t pwnbox

# To use this local image with `pwnbox create`, run `pwnbox config set --image pwnbox`
```


## Create WSL image from the container
We can extract the root filesystem from the image and use it as a WSL distro! There's a [one line PowerShell command](#automated-install) that will do this for you!

Expand Down Expand Up @@ -127,6 +111,20 @@ iwr https://obarroncs.github.io/pwnbox/wsl.ps1 | iex
The script is being hosted on `GitHub Pages` and can be found [here](https://github.com/OBarronCS/pwnbox/blob/main/wsl.ps1).


## Development
### Manually build the image
```sh
# Base image
docker build . --target base -t pwnbox
# Optional build args:
# --build-arg FULL_BUILD=true

# Image build for WSL
docker build . --target wsl -t pwnbox

# To use this local image with `pwnbox create`, run `pwnbox config set --image pwnbox`
```

### Notes on WSL + Docker Desktop on Windows

Docker Desktop is known to take an unbounded amount of RAM on Windows. If you notice in Task Manager that the Docker daemon is taking an enormous amount of RAM, a reliable way to reclaim it is to go into a terminal and type `wsl --shutdown` (it cannot be stopped in Task Manager). This will end all WSL and Docker processes and reclaim the memory. This will also turn off Docker Desktop - you will need to re-open it to turn it back on.
Expand Down

0 comments on commit 7d58045

Please sign in to comment.