Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/GoogleChromeLabs/telnet-client
https://github.com/GoogleChromeLabs/telnet-client
isolated-web-apps
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/GoogleChromeLabs/telnet-client
- Owner: GoogleChromeLabs
- License: apache-2.0
- Created: 2022-06-09T07:57:08.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-17T17:59:53.000Z (4 months ago)
- Last Synced: 2024-09-17T22:16:25.605Z (4 months ago)
- Topics: isolated-web-apps
- Language: TypeScript
- Homepage:
- Size: 1.43 MB
- Stars: 169
- Watchers: 9
- Forks: 16
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Telnet Demo
This repository contains an
[Isolated Web App](https://github.com/WICG/isolated-web-apps/blob/main/README.md)
that allows the user to connect to a TCP/IP server through an interactive
terminal. In other words, a Telnet client. This provides a demonstration of
the [Direct Sockets API].
## Privacy
This application is served statically and is cached for offline use. No
analytics are collected. All communication is directly between the client and
the remote server specified by the user.
## Building
This project is written in TypeScript and uses npm and Webpack to manage
dependencies and automate the build process. To get started clone the
repository and install dependencies by running,
```sh
npm install
```
Chrome supports two options for Isolated Web App development. In "proxy" mode
you run a local development server as you would for normal web app development
on a URL like `http://localhost:4321`. When the app is installed a random
`isolated-app://` origin is created and the browser proxies requests for this
origin to your local server. This allows you to quickly edit and refresh the
app to see your changes. When developer mode is enabled Chrome also allows you
to self-sign a Web Bundle and load it as it would be for a production app.
These instructions have been tested on Chrome 110.0.5464.2. When developing an
Isolated Web App always make sure you are running the latest version of Chrome
dev-channel as the feature is under active development.
### Running with a local development server
To start a local development server run,
```sh
npm run start
```
The server is listening on `http://localhost:4321`. The next step is to launch
Chrome to install the app in "proxy" mode,
```sh
google-chrome-unstable --enable-features=IsolatedWebApps,IsolatedWebAppDevMode \
--install-isolated-web-app-from-url=http://localhost:4321
```
If you visit `chrome://apps` you will see a new app called "Telnet".
After installation you can remove the `--install-isolated-web-app-from-url`
parameter from the command line.
Note that flags must be provided on the command line when the browser first
starts. Once it is running launching it from the command line will open a new
window but command line flags will not take effect.
Webpack's automatic reloading will not work because it does not support Trusted
Types.
### Building a Signed Web Bundle
Signing a Web Bundle requires generating a private key. This only needs to be
done once; the supported algorithms are Ed25519 and ECDSA P-256 SHA-256.
```sh
openssl genpkey -algorithm ed25519 -out private.pem
```
or
```sh
openssl ecparam -name prime256v1 -genkey -noout -out private.pem
```
To build,
```sh
npm run build
```
This will generate `dist/telnet.swbn`, a Web Bundle signed with the development
key generated above.
To install this bundle as an Isolated Web App, launch Chrome with the following
flags,
```sh
google-chrome-unstable --enable-features=IsolatedWebApps,IsolatedWebAppDevMode \
--install-isolated-web-app-from-file=$PWD/dist/telnet.swbn
```
If you visit `chrome://apps` you will see a new app called "Telnet".
After installation you can remove the `--install-isolated-web-app-from-file`
parameter from the command line.
Note that flags must be provided on the command line when the browser first
starts. Once it is running launching it from the command line will open a new
window but command line flags will not take effect.
[Direct Sockets API]: https://wicg.github.io/direct-sockets/
## Discuss & Help
For discussions related to this repository's content, the telnet client, please
use [GitHub Issues](https://github.com/GoogleChromeLabs/telnet-client/issues).
For discussions related to Isolated Web Apps in general, or Chromium-specific
implementation and development questions, please use the
[[email protected]](https://groups.google.com/a/chromium.org/g/iwa-dev)
mailing list.
If you'd like to discuss the Isolated Web Apps proposal itself, consider opening
an issue in its incubation repository at
https://github.com/WICG/isolated-web-apps.