Skip to content

Commit

Permalink
CID-2744: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mohamedlajmileanix committed Jul 23, 2024
1 parent dfe956f commit f50762f
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 2 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ SAP LeanIX agent to discover self built software in self-hosted GitHub Enterpris
- `GITHUB_ENTERPRISE_BASE_URL`: The base URL of your GitHub Enterprise Server instance.
- `GITHUB_APP_ID`: The ID of your GitHub App.
- `PEM_FILE`: The path to your GitHub App's PEM file inside the Docker container.
- `MANIFEST_FILE_DIRECTORY`: The directory path where the manifest files are located in every repository. For more details on the manifest file: [Microservice Discovery Through a Manifest File](https://docs-eam.leanix.net/reference/microservice-discovery-manifest-file)

5. **Start the Agent**: Run the Docker command to start the agent. Replace `<variable>` with your actual values:

Expand All @@ -36,6 +37,7 @@ SAP LeanIX agent to discover self built software in self-hosted GitHub Enterpris
-e GITHUB_ENTERPRISE_BASE_URL=<github_enterprise_base_url> \
-e GITHUB_APP_ID=<github_app_id> \
-e PEM_FILE=/privateKey.pem \
-e MANIFEST_FILE_DIRECTORY=<manifest_file_directory> \
leanix-github-agent
```

Expand Down
2 changes: 1 addition & 1 deletion src/main/resources/application.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ github-enterprise:
baseUrl: ${GITHUB_ENTERPRISE_BASE_URL:}
githubAppId: ${GITHUB_APP_ID:}
pemFile: ${PEM_FILE:}
manifestFilePath: ${MANIFEST_FILE_PATH:}
manifestFilePath: ${MANIFEST_FILE_DIRECTORY:}
leanix:
base-url: https://${LEANIX_DOMAIN}/services
ws-base-url: wss://${LEANIX_DOMAIN}/services
Expand Down
2 changes: 1 addition & 1 deletion src/test/resources/application.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ github-enterprise:
baseUrl: ${GITHUB_ENTERPRISE_BASE_URL:dummy}
githubAppId: ${GITHUB_APP_ID:dummy}
pemFile: ${PEM_FILE:dummy}
manifestFilePath: ${MANIFEST_FILE_PATH:}
manifestFilePath: ${MANIFEST_FILE_DIRECTORY:}
leanix:
base-url: https://${LEANIX_DOMAIN:dummy}/services
ws-base-url: wss://${LEANIX_DOMAIN:dummy}/services
Expand Down

0 comments on commit f50762f

Please sign in to comment.