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.

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

release: @logto/tunnel:0.1.0 #6513

Merged
merged 1 commit into from
Aug 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
41 changes: 0 additions & 41 deletions .changeset/long-rabbits-roll.md

This file was deleted.

44 changes: 44 additions & 0 deletions packages/tunnel/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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://<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
logto-tunnel --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
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.

2 changes: 1 addition & 1 deletion packages/tunnel/package.json
Original file line number Diff line number Diff line change
@@ -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. <contact@silverhand.io>",
"homepage": "https://github.com/logto-io/logto#readme",
Expand Down
Loading