added docs and container (podman + docker) setup
This commit is contained in:
52
README.md
52
README.md
@@ -39,8 +39,8 @@ go build -o argparse-builder
|
||||
./argparse-builder
|
||||
```
|
||||
|
||||
Server starts on port 8080. Open http://localhost:8080 in your browser.
|
||||
Demo available at: https://pages.git.pynezz.dev/argparse-builder
|
||||
Server starts on port 8080. Open <http://localhost:8080> in your browser.
|
||||
Demo available at: <https://pages.git.pynezz.dev/argparse-builder>
|
||||
|
||||
## Usage
|
||||
|
||||
@@ -89,3 +89,51 @@ Generates a complete bash script with:
|
||||
- No shell execution
|
||||
- Template-based HTML generation
|
||||
- CORS headers not set (localhost only by default)
|
||||
|
||||
## Run in container
|
||||
|
||||
### File Structure
|
||||
|
||||
```
|
||||
.
|
||||
├── assets/
|
||||
│ ├── Containerfile # OCI production (scratch, ~7MB)
|
||||
│ └── Containerfile.alpine # Development (Alpine, ~15MB)
|
||||
│
|
||||
├── docs/
|
||||
│ ├── container.md # Primary Podman guide ⭐
|
||||
│ ├── docker/
|
||||
│ │ ├── DOCKER_GUIDE.md # Complete Docker reference
|
||||
│ │ ├── Dockerfile # Docker production
|
||||
│ │ ├── Dockerfile.alpine # Docker development
|
||||
│ │ ├── docker-compose.yml
|
||||
│ │ ├── docker.md # Docker vs Podman
|
||||
│ │ └── README.md
|
||||
│ └── README.md # Documentation hub
|
||||
│
|
||||
├── Makefile.container # Podman build targets
|
||||
├── podman-compose.yml # OCI compose with SELinux
|
||||
├── CONTAINER_QUICKREF.md # One-page reference
|
||||
├── PODMAN_SUMMARY.md # This summary
|
||||
└── k8s-deployment.yaml # Kubernetes manifest (TODO)
|
||||
```
|
||||
|
||||
### Usage
|
||||
|
||||
```bash
|
||||
# Podman (primary)
|
||||
podman build -f assets/Containerfile -t argparse-builder .
|
||||
podman run -d -p 8080:8080 --security-opt label=type:container_t argparse-builder
|
||||
|
||||
# Docker (compatibility)
|
||||
docker build -f assets/Containerfile -t argparse-builder .
|
||||
docker run -d -p 8080:8080 argparse-builder
|
||||
```
|
||||
|
||||
```
|
||||
|
||||
```
|
||||
|
||||
```
|
||||
|
||||
```
|
||||
|
Reference in New Issue
Block a user