Skip to content

Commit

Permalink
Updated README file to be more descriptive (#141)
Browse files Browse the repository at this point in the history
* Group 12 added cat command after container is created

* making README more descriptive

---------

Co-authored-by: bmsmcgee <98934884+bmsmcgee@users.noreply.github.com>
Co-authored-by: Garth Johnson <growlf@thenetyeti.com>
  • Loading branch information
3 people committed Feb 25, 2024
1 parent 9786dfd commit 4565532
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
4 changes: 2 additions & 2 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
// "forwardPorts": [],
"forwardPorts": [
8000
]
],

// Uncomment the next line if you want start specific services in your Docker Compose config.
// "runServices": [],
Expand All @@ -50,7 +50,7 @@
// "shutdownAction": "none",

// Uncomment the next line to run commands after the container is created.
// "postCreateCommand": "cat /etc/os-release",
"postCreateCommand": "cat /etc/os-release"

// Configure tool-specific properties.
// "customizations": {},
Expand Down
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ You can find more at:

## Batteries included

### Custom Shell
### Custom Shell

Using the `docker-compose.yml` file (included) makes certain tasks easier. For example, opening a self-removing ZShell instance can be done lke so:

Expand All @@ -41,13 +41,13 @@ Using `tcpdump` can either be done from within a shell of the toolbox container,

docker run --rm -it --net=host ghcr.io/growlf/toolbox sudo tcpdump

### Running scripts and commands
### Running scripts and commands

You can also run arbitrary commands and scripts directly from the commandline like so:

docker compose run --rm -it app1 ./test_net.sh

## Invoke
## Using the Invoke Command

This image implements [Python Invoke](https://www.pyinvoke.org/), for managing shell-oriented subprocesses and organizing executable Python code into CLI-invokable tasks. There are a few basic tasks defined as examples already.

Expand Down Expand Up @@ -86,3 +86,4 @@ Use the `portainer-compose.yml` file and modify to your hearts content.
- https://pypi.org/project/portscan/
- https://docs.pyinvoke.org/en/stable/
- https://docker-py.readthedocs.io/en/stable/

0 comments on commit 4565532

Please sign in to comment.