phoenix-oss/open-mcp-auth-proxy-upstream
0
0
Fork 1
mirror of https://github.com/wso2/open-mcp-auth-proxy.git synced 2025-06-27 17:13:31 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Move build from source to the end of readme

Browse source
This commit is contained in:
Chiran Fernando 2025-05-18 16:44:10 +05:30
parent be697b5868
commit 9f856c4279
2 changed files with 102 additions and 103 deletions
Download patch file Download diff file Expand all files Collapse all files

2
Makefile
View file

@ -21,7 +21,7 @@ BUILD_OPTS := -v
# Set test options # Set test options
TEST_OPTS := -v -race TEST_OPTS := -v -race
.PHONY: all clean test fmt lint vet coverage help build-windows .PHONY: all clean test fmt lint vet coverage help
# Default target # Default target
all: lint test build-linux build-linux-arm build-darwin build-windows all: lint test build-linux build-linux-arm build-darwin build-windows

203
README.md
View file

@ -101,108 +101,6 @@ asgardeo:
- [Auth0](docs/integrations/Auth0.md) - [Auth0](docs/integrations/Auth0.md)
- [Keycloak](docs/integrations/keycloak.md) - [Keycloak](docs/integrations/keycloak.md)
## Build from Source
### Prerequisites for Building
* Go 1.20 or higher
* Git
* Make (for Linux/macOS builds)
### Building on Linux/macOS
1. Clone the repository:
```bash
git clone https://github.com/wso2/open-mcp-auth-proxy
cd open-mcp-auth-proxy
```
2. Install dependencies:
```bash
go get -v -t -d ./...
```
3. Build for your platform:
```bash
# Build for all platforms
make all
# Or build for a specific platform
make build-linux # For Linux
make build-darwin # For macOS
make build-linux-arm # For ARM-based Linux
make build-windows # For Windows
```
4. Find your build in the `build` directory:
```bash
# For Linux
./build/linux/openmcpauthproxy --demo
# For macOS
./build/darwin/openmcpauthproxy --demo
```
### Building on Windows
1. Clone the repository:
```powershell
git clone https://github.com/wso2/open-mcp-auth-proxy
cd open-mcp-auth-proxy
```
2. Install dependencies:
```powershell
go get -v -t -d ./...
```
3. Option 1: Build using Make if you have it installed:
```powershell
make build-windows
```
Option 2: Build manually without Make:
```powershell
mkdir -p build\windows
go build -o build\windows\openmcpauthproxy.exe .\cmd\proxy
copy config.yaml build\windows\
```
4. Run the built application:
```powershell
cd build\windows
.\openmcpauthproxy.exe --demo
```
### Starting the Proxy on Windows
1. Open Command Prompt or PowerShell
2. Navigate to the build directory:
```powershell
cd build\windows
```
3. Run the executable with your desired options:
```powershell
# Start in demo mode (using Asgardeo sandbox)
openmcpauthproxy.exe --demo
# Start with Asgardeo integration
openmcpauthproxy.exe --asgardeo
# Start in stdio mode
openmcpauthproxy.exe --demo --stdio
# Enable debug logging
openmcpauthproxy.exe --demo --debug
# See all available options
openmcpauthproxy.exe --help
```
4. The proxy will start and display messages indicating it's running
5. To stop the proxy, press `Ctrl+C` in the command window
# Advanced Configuration # Advanced Configuration
### Transport Modes ### Transport Modes
@ -317,3 +215,104 @@ asgardeo:
client_id: "<client_id>" client_id: "<client_id>"
client_secret: "<client_secret>" client_secret: "<client_secret>"
``` ```
## Build from Source
### Prerequisites for Building
* Go 1.20 or higher
* Git
* Make (for Linux/macOS builds)
### Building on Linux/macOS
1. Clone the repository:
```bash
git clone https://github.com/wso2/open-mcp-auth-proxy
cd open-mcp-auth-proxy
```
2. Install dependencies:
```bash
go get -v -t -d ./...
```
3. Build for your platform:
```bash
# Build for all platforms
make all
# Or build for a specific platform
make build-linux # For Linux
make build-darwin # For macOS
make build-linux-arm # For ARM-based Linux
make build-windows # For Windows
```
4. Find your build in the `build` directory:
```bash
# For Linux
./build/linux/openmcpauthproxy --demo
# For macOS
./build/darwin/openmcpauthproxy --demo
```
### Building on Windows
1. Clone the repository:
```powershell
git clone https://github.com/wso2/open-mcp-auth-proxy
cd open-mcp-auth-proxy
```
2. Install dependencies:
```powershell
go get -v -t -d ./...
```
3. Option 1: Build using Make if you have it installed:
```powershell
make build-windows
```
Option 2: Build manually without Make:
```powershell
mkdir -p build\windows
go build -o build\windows\openmcpauthproxy.exe .\cmd\proxy
copy config.yaml build\windows\
```
4. Run the built application:
```powershell
cd build\windows
.\openmcpauthproxy.exe --demo
```
### Starting the Proxy on Windows
1. Open Command Prompt or PowerShell
2. Navigate to the build directory:
```powershell
cd build\windows
```
3. Run the executable with your desired options:
```powershell
# Start in demo mode (using Asgardeo sandbox)
openmcpauthproxy.exe --demo
# Start with Asgardeo integration
openmcpauthproxy.exe --asgardeo
# Start in stdio mode
openmcpauthproxy.exe --demo --stdio
# Enable debug logging
openmcpauthproxy.exe --demo --debug
# See all available options
openmcpauthproxy.exe --help
```
4. The proxy will start and display messages indicating it's running
5. To stop the proxy, press `Ctrl+C` in the command window