Skip to content

Commit

Permalink
add note about installing ubuntu packages for WSL2
Browse files Browse the repository at this point in the history
  • Loading branch information
pdaoust committed Jun 24, 2024
1 parent 7f7ec5e commit 0c3159f
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 0 deletions.
6 changes: 6 additions & 0 deletions src/pages/get-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,12 @@ For Windows users, please note that the Nix package manager, which is used to in

Holochain is supported in WSL2 via the Ubuntu distribution.

You'll also need to install a few packages if you want to run two dev tools, `hc launch` and `hc spin`, which start your app's back end and open its GUI in Tauri or Electron webviews:

Check warning on line 50 in src/pages/get-started/index.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (webviews)

Check warning on line 50 in src/pages/get-started/index.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (webviews)

```shell
sudo apt install -y libnss3 libatk1.0-0 libatk-bridge2.0-0 libcups2 libgtk-3-dev libasound2 adwaita-icon-theme

Check warning on line 53 in src/pages/get-started/index.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (libnss)

Check warning on line 53 in src/pages/get-started/index.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (libatk)

Check warning on line 53 in src/pages/get-started/index.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (libatk)

Check warning on line 53 in src/pages/get-started/index.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (libcups)

Check warning on line 53 in src/pages/get-started/index.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (libgtk)

Check warning on line 53 in src/pages/get-started/index.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (libasound)

Check warning on line 53 in src/pages/get-started/index.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (adwaita)

Check warning on line 53 in src/pages/get-started/index.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (libnss)

Check warning on line 53 in src/pages/get-started/index.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (libatk)

Check warning on line 53 in src/pages/get-started/index.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (libatk)

Check warning on line 53 in src/pages/get-started/index.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (libcups)

Check warning on line 53 in src/pages/get-started/index.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (libgtk)

Check warning on line 53 in src/pages/get-started/index.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (libasound)

Check warning on line 53 in src/pages/get-started/index.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (adwaita)
```

### 2.3. Set up development environment

Once you've ensured that your system meets the hardware requirements and set up WSL2 on Windows or a dual-boot Linux OS (if applicable), you can proceed with the installation of the Nix package manager and the binary package cache for Holochain.
Expand Down
8 changes: 8 additions & 0 deletions src/pages/get-started/install-advanced.md
Original file line number Diff line number Diff line change
Expand Up @@ -290,3 +290,11 @@ There are other fixes [outlined in the Ubuntu 24.04 release notes](https://disco
### Redistributable applications created with [`holochain-kangaroo-electron`](https://github.com/holochain-apps/holochain-kangaroo-electron) are also affected

Because the template repo `holochain-kangaroo-electron` also bundles Electron's chrome-sandbox in the binary that you'd distribute, your users will see the same error message when they try to run your application if you've used this repo. We're still researching the best solution, but since Ubuntu is recommending it, we recommend applying the first solution in the release notes, which involves creating an AppArmor profile for your app. This profile could then be distributed and installed alongside it. (Note: this won't work with portable application packages that aren't installed as root, such as `AppImage`s.)

## Opening your hApp's GUI in Ubuntu on WSL2 (Windows Subsystem for Linux)

There are two dev tools, `hc launch` and `hc spin`, which start your app's back end and open its GUI in Tauri or Electron webviews. 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:

Check warning on line 296 in src/pages/get-started/install-advanced.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (webviews)

Check warning on line 296 in src/pages/get-started/install-advanced.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (webviews)

```shell
sudo apt install -y libnss3 libatk1.0-0 libatk-bridge2.0-0 libcups2 libgtk-3-dev libasound2 adwaita-icon-theme

Check warning on line 299 in src/pages/get-started/install-advanced.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (libnss)

Check warning on line 299 in src/pages/get-started/install-advanced.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (libnss)
```

0 comments on commit 0c3159f

Please sign in to comment.