Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update setup docs #552

Merged
merged 2 commits into from
Jan 21, 2025
Merged

Update setup docs #552

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fe3de8d
Local project is setup on given domain, not project.domain
soapy1 Jan 3, 2025
f6e53ff
Update keycloak adduser commend
soapy1 Jan 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/docs/how-tos/configure-keycloak-howto.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ If you [changed the initial root password for Keycloak](#change-keycloak-root-pa
To make adding users easier for new Nebari deployments, we've created a CLI command to help you.

```shell
nebari keycloak -c nebari-config.yaml adduser <username> <password>
nebari keycloak adduser -c nebari-config.yaml --user <username> <password>
```

This will create a new user `<username>` under the `analyst` group, with the initial password provided. Omit the password completely if you are using GitHub or Auth0. It will also add a placeholder email (i.e. `username@your-domain`) to the **Email** field.
Expand Down
16 changes: 8 additions & 8 deletions docs/docs/how-tos/nebari-local.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,12 +186,12 @@ If the deployment is successful, you will see the following output:
```bash
[terraform]: Nebari deployed successfully
Services:
- argo-workflows -> https://projectname.domain/argo/
- conda_store -> https://projectname.domain/conda-store/
- dask_gateway -> https://projectname.domain/gateway/
- jupyterhub -> https://projectname.domain/
- keycloak -> https://projectname.domain/auth/
- monitoring -> https://projectname.domain/monitoring/
- argo-workflows -> https://domain/argo/
- conda_store -> https://domain/conda-store/
- dask_gateway -> https://domain/gateway/
- jupyterhub -> https://domain/
- keycloak -> https://domain/auth/
- monitoring -> https://domain/monitoring/
Kubernetes kubeconfig located at file:///tmp/NEBARI_KUBECONFIG
Kubecloak master realm username=root *****
...
Expand All @@ -202,10 +202,10 @@ Kubecloak master realm username=root *****
Finally, if everything is set properly you should be able to cURL the JupyterHub Server. Run

```
curl -k https://projectname.domain/hub/login
curl -k https://domain/hub/login
```

It's also possible to visit `https://projectname.domain` in your web browser to select the deployment.
It's also possible to visit `https://domain` in your web browser to select the deployment.
As default for a local deployment the https certificates generated during deployments aren't signed by a recognized [Certificate Authority (CA)](https://en.wikipedia.org/wiki/Certificate_authority) and are self-signed by [Traefik](https://github.com/traefik/traefik) instead.

Several browsers makes it difficult to view a self-signed certificate that are not added to the certificate registry. So, if you do not want to use Let's Encrypt, you can use the following workarounds to properly view the pages:
Expand Down
Loading