Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
leneffets authored Dec 2, 2024
1 parent c14a0ec commit 9418a6f
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,14 @@ The server exposes two main endpoints: `/ssm` and `/s3`.
- AWS CLI configured with necessary permissions
- Git installed

## Container Image

Get the Container Image:
```sh
docker pull ghcr.io/leneffets/ssmserver:v1.0.0 #check for releases
docker pull ghcr.io/leneffets/ssmserver:latest
```

## Setup

1. **Clone the repository:**
Expand All @@ -38,9 +46,11 @@ The server exposes two main endpoints: `/ssm` and `/s3`.
## Running the Server

To start the HTTP server locally on port 3000, run the following command:
```sh
# Port may be changed via Environment, default 3000
export PORT=3000
go run cmd/server/main.go
```

## Endpoints

Expand Down

0 comments on commit 9418a6f

Please sign in to comment.