From 61fb856ccdf0fb3d69dbf01c14a677e0de7f5d56 Mon Sep 17 00:00:00 2001 From: Charles Zhao Date: Fri, 23 Aug 2024 23:40:19 +0800 Subject: [PATCH] release: @logto/tunnel:0.1.0 (#6513) --- .changeset/long-rabbits-roll.md | 41 ------------------------------ packages/tunnel/CHANGELOG.md | 44 +++++++++++++++++++++++++++++++++ packages/tunnel/package.json | 2 +- 3 files changed, 45 insertions(+), 42 deletions(-) delete mode 100644 .changeset/long-rabbits-roll.md create mode 100644 packages/tunnel/CHANGELOG.md diff --git a/.changeset/long-rabbits-roll.md b/.changeset/long-rabbits-roll.md deleted file mode 100644 index ea30e1136..000000000 --- a/.changeset/long-rabbits-roll.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -"@logto/tunnel": minor ---- - -add new cli command to setup Logto tunnel service for developing and debugging custom ui on your local machine - -This command will establish a tunnel service between the following 3 entities: Logto cloud auth services, your application, and your custom sign-in UI. - -#### Installation - -```bash -npm i @logto/tunnel -g -``` - -#### Usage - -Assuming you have a custom sign-in page running on `http://localhost:4000`, then you can execute the command this way: - -```bash -logto-tunnel --endpoint https://.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 -logto-tunnel --endpoint https://.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 -logto-tunnel --endpoint https://your-custom-domain.com --port 9000 --experience-path /path/to/your/custom/ui -``` - -This should set up the tunnel and it will be running on your local machine at `http://localhost:9000/`. - -Finally, run your application and set its endpoint in Logto config to the tunnel 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. - -Refer to [Logto tunnel documentation](https://docs.logto.dev/docs/references/tunnel-cli/) for more details. diff --git a/packages/tunnel/CHANGELOG.md b/packages/tunnel/CHANGELOG.md new file mode 100644 index 000000000..d53d13766 --- /dev/null +++ b/packages/tunnel/CHANGELOG.md @@ -0,0 +1,44 @@ +# @logto/tunnel + +## 0.1.0 + +### Minor Changes + +- 976558af9: add new cli command to setup Logto tunnel service for developing and debugging custom ui on your local machine + + This command will establish a tunnel service between the following 3 entities: Logto cloud auth services, your application, and your custom sign-in UI. + + #### Installation + + ```bash + npm i @logto/tunnel -g + ``` + + #### Usage + + Assuming you have a custom sign-in page running on `http://localhost:4000`, then you can execute the command this way: + + ```bash + logto-tunnel --endpoint https://.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 + logto-tunnel --endpoint https://.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 + logto-tunnel --endpoint https://your-custom-domain.com --port 9000 --experience-path /path/to/your/custom/ui + ``` + + This should set up the tunnel and it will be running on your local machine at `http://localhost:9000/`. + + Finally, run your application and set its endpoint in Logto config to the tunnel 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. + + Refer to [Logto tunnel documentation](https://docs.logto.dev/docs/references/tunnel-cli/) for more details. + \ No newline at end of file diff --git a/packages/tunnel/package.json b/packages/tunnel/package.json index 64c5cd236..ce594c187 100644 --- a/packages/tunnel/package.json +++ b/packages/tunnel/package.json @@ -1,6 +1,6 @@ { "name": "@logto/tunnel", - "version": "0.0.0", + "version": "0.1.0", "description": "A CLI tool that creates tunnel service to Logto Cloud for local development.", "author": "Silverhand Inc. ", "homepage": "https://github.com/logto-io/logto#readme",