Skip to content

Update README.md #164

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Pysis868 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md #164

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,25 @@ fetched transparently from configurable upstream mirrors.

## Run the code

Build and run the code locally for testing:
Install and use the tool directly:
```shell
go install github.com/ganto/pkgproxy@latest
pkgproxy --config 'pkgproxy.yaml' --cachedir 'cache' serve
```
Fetching the config file from the repository, if needed.

or build and run the code locally for testing:
```shell
PKGPROXY_CONFIG=./configs/pkgproxy.yaml go run github.com/ganto/pkgproxy serve
```

Run the application via a container engine (e.g. [Podman](https://podman.io/)):
or run the application via a container engine (e.g. [Podman](https://podman.io/)):

```shell
podman run --rm -p 8080:8080 -e PKGPROXY_HOST=0.0.0.0 --volume ./cache:/ko-app/cache:z ghcr.io/ganto/pkgproxy
```

To use a custom `pkgproxy.yaml`, bind-mount it into the container:
Or use a custom `pkgproxy.yaml`, bind-mount it into the container:
```shell
podman run --rm -p 8080:8080 -e PKGPROXY_HOST=0.0.0.0 --volume ./cache:/ko-app/cache:z --volume ./pkgproxy.yaml:/ko-app/pkgproxy.yaml ghcr.io/ganto/pkgproxy
```
Expand Down
Loading