-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2187 from keboola/feat-add-apps-proxy-local-devel…
…opment-docs feat: Add apps proxy local development docs
- Loading branch information
Showing
6 changed files
with
84 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -50,3 +50,7 @@ vendor/* | |
|
||
# CPU profiles | ||
/**/*.prof | ||
|
||
# Certificates | ||
/ca | ||
/certs |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
# Apps proxy Architecture Overview | ||
|
||
- Serves for data apps authentication and authorization. | ||
- Typicall usage is to perform OIDC login through some OIDC provider (e.g Microsoft login, Google login etc.) | ||
- Has possibility to add basic authorization which consists of password prompt on a web page. | ||
|
||
|
||
## Entrypoint | ||
|
||
[cmd/apps-proxy/main.go](../../cmd/apps-proxy/main.go) | ||
|
||
## Apps Proxy Options | ||
|
||
## Operations | ||
|
||
In `/etc/hosts` add this: | ||
|
||
``` | ||
127.0.0.1 test.hub.keboola.local | ||
127.0.0.1 hub.keboola.local | ||
``` | ||
In project directory uncommect in [docker-compose.yml](../../docker-compose.yml) the `command` section and fill it with `apps-proxy` service. It should look like this | ||
``` | ||
command: > | ||
sh -c "git config --global --add safe.directory /code | ||
make run-apps-proxy" | ||
``` | ||
|
||
Then launch the dev container | ||
``` | ||
docker compose up -d dev | ||
``` | ||
|
||
There is a sandboxes service mock in place which returns configuration of data app. Simply adjust the [provisioning/apps-proxy/dev/sandboxesMock.json](../../provisioning/apps-proxy/dev/sandboxesMock.json) if you want to change received configuration by local testing. | ||
|
||
Next clone this repository: GitHub - [fsouza/docker-ssl-proxy](https://github.com/fsouza/docker-ssl-proxy) | ||
|
||
In its directory run this: | ||
|
||
``` | ||
docker build -t https-proxy . | ||
``` | ||
|
||
And then go back to the root repository and launch the https-proxy: | ||
|
||
``` | ||
docker compose up https-proxy | ||
``` | ||
|
||
Now the proxy should be available under https://test.hub.keboola.local/. | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters