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.

Sign up for GitHub

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

Jump to bottom

add note about installing ubuntu packages for WSL2 #457

Merged
merged 5 commits into from
Jun 24, 2024
Merged

add note about installing ubuntu packages for WSL2 #457

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0c3159f
add note about installing ubuntu packages for WSL2
pdaoust Jun 24, 2024
b42e628
clarify what packages are for which webview container
pdaoust Jun 24, 2024
eae5b32
fix spelling/broken URL
pdaoust Jun 24, 2024
936d9d7
one more word to dict
pdaoust Jun 24, 2024
005ee59
fix spelling mistake
pdaoust Jun 24, 2024
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
6 changes: 6 additions & 0 deletions src/pages/get-started/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,12 @@

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)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are only needed for hc-launch. I never had problems with Tauri needing libraries.

adwaita-icon-theme solves a Tauri specific problem that Electron doesn't seem to have.

I get grouping them together to get people set up quickly. I wonder if it's worth keeping a note somewhere for ourselves about why we're recommending which libraries? I don't know if we can comment in the markdown here without it showing up in the generated page?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, and I can clarify in the advanced install guide.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sweet, yeah that's exactly the kind of information I'd be after - thank you!


```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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -290,3 +290,11 @@
### 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)
```
Loading