Skip to content
Snippets Groups Projects
Commit a5480b98 authored by Maarten de Waard's avatar Maarten de Waard :angel: Committed by Arie Peterson
Browse files

Improve wording in docs

parent 8b6effdc
No related branches found
No related tags found
1 merge request!65Resolve "Dockerize local frontend development"
Pipeline #31541 passed with stages
in 4 minutes and 16 seconds
......@@ -52,12 +52,12 @@ it is based on traditional Bootstrap + JQuery.
## Development environment
After this process is finished, the following will run locally:
After this process is finished, the following will run in local docker containers:
- the dashboard frontend
- the dashboard backend
The following will be available locally through a proxy and port-forwards:
The following will be available through proxies running in local docker containers and port-forwards:
- Hydra admin API
- Kratos admin API and public API
......@@ -77,8 +77,8 @@ To develop the Dashboard, you need a Stackspin cluster that is set up as a
development environment. Follow the instructions [in the
dashboard-dev-overrides
repository](https://open.greenhost.net/stackspin/dashboard-dev-overrides#dashboard-dev-overrides)
in order to set up a development-capable cluster. The end-points for the
Dashboard, as well as Kratos and Hydra, will point to
in order to set up a development-capable cluster. The Dashboard, as well as
Kratos and Hydra, will be configured to point their endpoints to
`http://stackspin_proxy:8081` in that cluster. As a result, you can run
components using the `docker-compose.yml` file in this repository, and still log
into Stackspin applications that run on the cluster.
......@@ -106,7 +106,7 @@ The application will run on `http://stackspin_proxy`. Add the following line to
The script needs you to have access to the Kubernetes cluster that runs
Stackspin. Point the `KUBECONFIG` environment variable to a kubectl config. Attention points:
* that kubeconfig will be mounted inside docker containers, so also make sure
* The kubeconfig will be mounted inside docker containers, so also make sure
your Docker user can read it.
* The bind-mount done by docker might not work if the file pointed to is
part of a filesystem such as sshfs. In that case, copy the file to a local
......@@ -114,10 +114,10 @@ Stackspin. Point the `KUBECONFIG` environment variable to a kubectl config. Atte
### Build and run
After you've finished all setup steps, you can now run everything using
After you've finished all setup steps, you can run everything using
./run_app.sh
This will sets a few environment variables based on what is in your cluster
This sets a few environment variables based on what is in your cluster
secrets, and run `docker compose up` to build and run all necessary components,
including a reverse proxy as well as the backend flask application.
including a reverse proxy and the backend flask application.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment