Skip to content

Commit

Permalink
Updated README.md. Added symlink to Dockerfile.
Browse files Browse the repository at this point in the history
  • Loading branch information
ananthb committed Oct 5, 2021
1 parent 5968917 commit fe4ce16
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
1 change: 1 addition & 0 deletions Dockerfile
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -635,6 +635,35 @@ section with a `basic` parameter, and set one of its options.
| `realm` | `str` | `Lwan` | Realm for authorization. This is usually shown in the user/password UI in browsers |
| `password_file` | `str` | `NULL` | Path for a file containing username and passwords (in clear text). The file format is the same as the configuration file format used by Lwan |

Container Images
----------------
lwan container images are available at [ghcr.io/lperiera/lwan](https://ghcr.io/lperiera/lwan).
Container runtimes like [docker](https://docker.io) or [podman](https://podman.io) may be used to build and run lwan in a container.


### Pull lwan images from GHCR
Container images are tagged with release version numbers, so a specific version of lwan can be pulled.

# latest version
docker pull ghcr.io/lperiera/lwan:latest
# pull a specific version
docker pull ghcr.io/lperiera/lwan:v0.3

### Build images locally
Clone the repository and use Containerfile (Dockerfile) to build lwan with all optional dependencies enabled.

podman build -t lwan .

### Run your image
The image expects to find static content at /wwwroot, so a volume containing your content can be mounted.

docker run --rm -p 8080:8080 -v ./www:/wwwroot lwan

To bring your own own lwan.conf, simply mount it at /lwan.conf.

podman run --rm -p 8080:8080 -v ./lwan.conf:/lwan.conf lwan


Hacking
-------

Expand Down

0 comments on commit fe4ce16

Please sign in to comment.