You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
chore: remove mentions of hc-launch from docs; instruct to remove in 0.6 upgrade guide (#621)
* chore: remove mentions of hc-launch from docs; instruct to remove in 0.6 upgrade guide
* fix: correct where hc-spin comes from
* chore: improve language about hc-spin
Copy file name to clipboardExpand all lines: src/pages/build/connecting-a-front-end.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ This interface is **only exposed to processes on the local device**, not to exte
14
14
15
15
Some Holochain runtimes bundle the conductor and a front end host that serves your HTML/JavaScript-based runtimes. Take a look at the [Packaging and Distribution](/get-started/4-packaging-and-distribution/) page from the Get Started guide for the choices.
16
16
17
-
The Holonix dev environment comes with a runtime called `hc-launch`, which starts Holochain, installs your hApp, and displays a UI for you. The scaffolding tool generates an NPM script that compiles and bundles your back end into a [`.happ` file](/build/happs/#package-a-happ-for-distribution) and starts two instances of the hApp with `hc-launch`. In the root of your project folder, enter:
17
+
Scaffolded hApps come with a runtime called `hc-spin`, which starts a Holochain conductor, installs your hApp into it, and displays a UI for you. The scaffolding tool generates an NPM script that compiles and bundles your back end into a [`.happ` file](/build/happs/#package-a-happ-for-distribution) and starts two instances of the hApp with `hc-spin`. In the root of your project folder, enter:
Copy file name to clipboardExpand all lines: src/pages/get-started/index.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -42,10 +42,10 @@ For Windows users, please note that the Nix package manager, which is used to in
42
42
43
43
Holochain is supported in WSL2 via the Ubuntu distribution.
44
44
45
-
You'll also need to install a few packages if you want to run two dev tools, `hc spin` and `hc launch`, which start your app's back end and open its GUI in Electron or Tauri webviews:
45
+
You'll also need to install a few packages if you want to run a dev tool, `hc spin`, which starts your app's back end and opens its GUI in an Electron webview:
@@ -130,7 +129,7 @@ The full suite of Nix tooling is broad and deep. There's even a dedicated progra
130
129
131
130
## Fixing the SUID sandbox error in Ubuntu 24.04 and later
132
131
133
-
Ubuntu 24.04 [introduced an AppArmor security policy](https://discourse.ubuntu.com/t/ubuntu-24-04-lts-noble-numbat-release-notes/39890#p-99950-unprivileged-user-namespace-restrictions-15) that causes `hcspin`, which is used to test applications and their UIs, to fail with a fatal error. If you have a `package.json` that lists `@holochain/hc-spin`as a dev dependency, you may see this error message:
132
+
Ubuntu 24.04 [introduced an AppArmor security policy](https://discourse.ubuntu.com/t/ubuntu-24-04-lts-noble-numbat-release-notes/39890#p-99950-unprivileged-user-namespace-restrictions-15) that causes `hc-spin`, which is used to test applications and their UIs, to fail with a fatal error. If you try to run `hc-spin` (or `npm run start`/`npm run launch:happ` with a scaffolded hApp, which uses `hc-spin`under the hood), you may see this error message:
134
133
135
134
::: output-block
136
135
```
@@ -144,7 +143,7 @@ You can fix the issue by entering the following command in your project's root d
You'll have to do this for every hApp project that uses `@holochain/hc-spin`.
146
+
You'll have to do this for every hApp project that uses `hc-spin`.
148
147
149
148
There are other fixes [outlined in the Ubuntu 24.04 release notes](https://discourse.ubuntu.com/t/ubuntu-24-04-lts-noble-numbat-release-notes/39890#p-99950-unprivileged-user-namespace-restrictions-15) that can solve the problem; if you'd like to learn more, read through them all and choose the one that feels most appropriate for you.
150
149
@@ -154,15 +153,7 @@ Because the template repo `holochain-kangaroo-electron` also bundles Electron's
154
153
155
154
## Opening your hApp's GUI in Ubuntu on WSL2 (Windows Subsystem for Linux) {#opening-your-happs-gui-in-ubuntu-on-wsl2}
156
155
157
-
There are two dev tools, `hc spin` and `hc launch`, which start your app's back end and open its GUI in [Electron](https://www.electronjs.org/) or [Tauri](https://tauri.app/) webview containers, respectively. Because the Ubuntu OS installed from the Microsoft Store doesn't come with GUI packages by default, you'll need to install just a few in order to get these tools to work.
158
-
159
-
If you're only using `hc launch`, which uses the Tauri webview, install this package, which resolves a GDK error about cursors:
160
-
161
-
```shell
162
-
sudo apt install -y adwaita-icon-theme
163
-
```
164
-
165
-
If you're only using the more modern `hc spin`, which uses the Electron webview, install these missing packages that are needed by the `chrome-sandbox` binary:
156
+
There is one dev tool, `hc spin`, which starts your app's back end and opens its GUI in an [Electron](https://www.electronjs.org/) webview containers. Because the Ubuntu OS installed from the Microsoft Store doesn't come with GUI packages by default, you'll need to install just a few in order to get this tool to work:
Copy file name to clipboardExpand all lines: src/pages/resources/compatibility/index.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@ We use [SemVer](https://semver.org/) to indicate component version compatibility
18
18
* When we talk about Holochain versions in general, we're referring to the [`holochain` core library](https://github.com/holochain/holochain). Its most significant number is the reference point for the rest of the components' compatibility, and the versions of the conductor binary, [`hc` CLI](https://github.com/holochain/holochain/tree/develop/crates/hc), and [`hcterm` CLI](https://github.com/holochain/holochain/tree/develop/crates/holochain_terminal) follow it.
19
19
* Compatible [`hdk`](https://crates.io/crates/hdk/) library versions share a most significant number with the core library.
20
20
* The [`hdi`](https://crates.io/crates/hdi/) library's most significant number is one higher than the core library (e.g., for `holochain` 0.6, compatible `hdi` versions are 0.7.x).
21
-
* From Holochain 0.5 onwards, the most significant number of the [scaffolding](https://github.com/holochain/scaffolding/), [`hc-spin`](https://github.com/holochain/hc-spin), [playground](https://github.com/darksoil-studio/holochain-playground), and [`hc-launch`](https://github.com/holochain/hc-launch) CLI tools is the same as that of the core library, but multiplied by 100. For instance, for Holochain 0.6, use version 0.600.x of these tools.
21
+
* From Holochain 0.5 onwards, the most significant number of the [scaffolding](https://github.com/holochain/scaffolding/), [`hc-spin`](https://github.com/holochain/hc-spin), and [playground](https://github.com/darksoil-studio/holochain-playground) CLI tools is the same as that of the core library, but multiplied by 100. For instance, for Holochain 0.6, use version 0.600.x of these tools.
22
22
* The [lair keystore](https://github.com/holochain/lair), [Kitsune2 bootstrap server](https://github.com/holochain/kitsune2/tree/main/crates/bootstrap_srv), [Rust](https://github.com/holochain/holochain/tree/main/crates/client) and [JavaScript](https://github.com/holochain/holochain-client-js) clients, [Tryorama library](https://github.com/holochain/tryorama), and [`kangaroo-electron` app template repo](https://github.com/holochain/kangaroo-electron) have their own version number sequences, but almost always advance by one for every new Holochain release series. For example, if JavaScript client 0.19.x is compatible with Holochain 0.5, then JavaScript client 0.20.x will be compatible with Holochain 0.6.
23
23
24
24
To check the versions you're currently using in a scaffolded project, use the [`hn-introspect`](/get-started/install-advanced/#holonix-inspection-commands) command from within your project's Nix dev shell.
2. Update your root `package.json` file with the new package versions, and update the `build:zomes` script to accommodate a change in the way one of the HDK's dependencies needs to be built: <!-- TODO: get the right version numbers --> {#update-package-json}
53
+
2. Update your root `package.json` file with the new package versions, remove the deprecated `*:tauri` scripts, and update the `build:zomes` script to accommodate a change in the way one of the HDK's dependencies needs to be built: <!-- TODO: get the right version numbers --> {#update-package-json}
54
54
55
55
```diff:json
56
56
{
@@ -65,9 +65,9 @@ To upgrade your hApp written for Holochain 0.5, follow these steps:
65
65
"network": "hc sandbox clean && npm run build:happ && UI_PORT=$(get-port) concurrently \"npm run start --workspace ui\" \"npm run launch:happ\" \"hc playground\"",
66
66
"test": "npm run build:zomes && hc app pack workdir --recursive && npm run test --workspace tests",
0 commit comments