0
Fork 0
mirror of https://github.com/logto-io/logto.git synced 2024-12-16 20:26:19 -05:00
logto/.changeset/slow-buses-rhyme.md
Charles Zhao 2d0502a427
feat(cli): add cli command to setup custom ui local debugging proxy (#6365)
* feat(cli): add proxy

* refactor(cli): polish code per comments

* refactor(cli): polish code

* refactor(cli): support serving static files

* chore: add changeset

* refactor: polish code

* refactor(cli): polish code

* refactor(cli): make json parse safer
2024-08-01 12:47:24 +08:00

34 lines
1.5 KiB
Markdown

---
"@logto/cli": minor
---
add new cli command to setup proxy for developing and debugging custom ui locally
This command will establish a proxy tunnel between the following 3 entities together: your Logto cloud auth services, your application, and your custom sign-in UI.
Assuming you have a custom sign-in page running on `http://localhost:4000`.
Then you can execute the command this way:
```bash
npm cli proxy --endpoint https://<tenant-id>.logto.app --port 9000 --experience-uri http://localhost:4000
```
Or if you don't have your custom UI pages hosted on a dev server, you can use the `--experience-path` option to specify the path to your static files:
```bash
npm cli proxy --endpoint https://<tenant-id>.logto.app --port 9000 --experience-path /path/to/your/custom/ui
```
This command also works if you have enabled custom domain in your Logto tenant. E.g.:
```bash
npm cli proxy --endpoint https://your-custom-domain.com --port 9000 --experience-path /path/to/your/custom/ui
```
This should set up the proxy and it will be running on your local machine at `http://localhost:9000/`.
Finally, run your application and set its Logto endpoint to the proxy address `http://localhost:9000/` instead.
If all set up correctly, when you click the "sign-in" button in your application, you should be navigated to your custom sign-in page instead of Logto's built-in UI, along with valid session (cookies) that allows you to further interact with Logto experience API.
Happy coding!