Skip to content
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
3 changes: 3 additions & 0 deletions docs/.sphinx/.valeignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
*.svg
*.png
*.mp4
9 changes: 8 additions & 1 deletion docs/contribute-to-multipass-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,14 @@ At Canonical, we have embarked on a comprehensive, long-term project to transfor

Multipass documentation is maintained on our Discourse forum. Every documentation page has an equivalent topic on the forum, that can be accessed by clicking the "Help improve this document in the forum" link at the bottom of the page.

```{figure} /images/contribute-to-discourse-docs.png
:width: 540px
:alt: Contribute to Discourse
```

<!-- Original image on the Asset Manager
![Contribute to Discourse|540x103](https://assets.ubuntu.com/v1/e099e5dc-contribute-to-discourse-docs.png)
-->

To contribute to the documentation, you can leave a comment on the relevant forum topic, or edit content directly if your *Trust level* allows it. However, if your intervention is bigger than fixing a typo, it’s a good idea to comment on the page to discuss first.

Expand Down Expand Up @@ -45,7 +52,7 @@ The [Canonical Open Documentation Academy](https://canonical.com/documentation/o

If you want to contribute to Multipass documentation, you can also check if there are any outstanding tasks on the [Open Documentation Academy GitHub](https://github.com/canonical/open-documentation-academy/issues?q=is%3Aissue+is%3Aopen+multipass+). This could be a great opportunity to improve your documentation practice, receive guidance and mentorship and publicly contribute to an open-source project, if that's something that interests you.

Everyone is invited join the Academy's [weekly office hours](https://discourse.ubuntu.com/t/documentation-office-hours/42771), listen in to presentations and participate in discussions. Live sessions are also recorded and made available on the[ Ubuntu on Air YouTube channel](https://www.youtube.com/@UbuntuOnAir), in the[ Documentation Academy playlist](https://www.youtube.com/watch?v=GT03aSdabJE&list=PL-qBHd6_LXWYefHij0dJ7c9X-Q9QfFFFa&pp=iAQB).
Everyone is invited join the Academy's [weekly office hours](https://discourse.ubuntu.com/t/documentation-office-hours/42771), listen in to presentations and participate in discussions. Live sessions are also recorded and made available on the [Ubuntu on Air YouTube channel](https://www.youtube.com/@UbuntuOnAir), in the [Documentation Academy playlist](https://www.youtube.com/watch?v=GT03aSdabJE&list=PL-qBHd6_LXWYefHij0dJ7c9X-Q9QfFFFa&pp=iAQB).


## Feedback and issues
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,14 @@ If you are on Windows and you want to use [Windows Terminal](https://aka.ms/term

Currently, Multipass can add a profile to Windows Terminal for the {ref}`primary-instance`. When you open a Windows Terminal tab with this profile, you'll automatically find yourself in a primary instance shell. Multipass automatically starts or launches the primary instance if needed.

```{figure} /images/multipass-windows-terminal-1.png
:width: 680px
:alt: Screenshot: primary shell
```

<!-- Original image on the Asset Manager
![Screenshot: primary shell|800x490, 85%](https://assets.ubuntu.com/v1/f875c1d3-multipass-windows-terminal-1.png)
-->

## Install Windows Terminal

Expand All @@ -27,7 +34,14 @@ For more information on this setting, see: [`client.apps.windows-terminal.profil

You can now open a "Multipass" tab to get a shell in the primary instance. That can be achieved by clicking the new-tab drop-down and selecting the Multipass profile:

```{figure} /images/multipass-windows-terminal-2.jpeg
:width: 680px
:alt: Screenshot: drop-down menu
```

<!-- Original image on the Asset Manager
![Screenshot: drop-down menu|800x490, 85%](https://assets.ubuntu.com/v1/d14d32d6-multipass-windows-terminal-2.jpeg)
-->

That's it!

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,14 @@ remmina -c rdp://10.49.93.209

The system will ask for a username (`ubuntu`) and the password set above, and then the Ubuntu desktop on the instance will be displayed.

```{figure} /images/multipass-remmina.png
:width: 690px
:alt: Logging in to the RDP server with Remmina
```

<!-- Original image on the Asset Manager
![Logging in to the RDP server with Remmina|690x567](https://assets.ubuntu.com/v1/83c7e6d7-multipass-remmina.png)
-->

````

Expand Down Expand Up @@ -149,7 +156,14 @@ sudo apt -y install x11-apps
xlogo &
```

```{figure} /images/multipass-xlogo.png
:width: 420px
:alt: Xlogo on Linux
```

<!-- Original image on the Asset Manager
![Xlogo on Linux|420x455](https://assets.ubuntu.com/v1/657475f0-multipass-xlogo.png)
-->

A small window containing the X logo will show up. Done!

Expand Down Expand Up @@ -190,7 +204,14 @@ sudo snap install firefox
firefox &
```

```{figure} /images/multipass-windows-desktop-firefox.jpeg
:width: 690px
:alt: Firefox running on a Multipass instance
```

<!-- Original image on the Asset Manager
![Firefox running on a Multipass instance|690x388](https://assets.ubuntu.com/v1/82019ef0-multipass-windows-desktop-firefox.jpeg)
-->

````

Expand Down
21 changes: 21 additions & 0 deletions docs/how-to-guides/customise-multipass/set-up-the-driver.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,14 @@ The output will be similar to the following:
```
Alternatively, to use the `virt-manager` GUI, ...

```{figure} /images/multipass-virt-manager-gui.png
:width: 584px
:alt: Virtual Machine Manager GUI
```

<!-- Original image on the Asset Manager
![Virtual Machine Manager GUI|584x344](https://assets.ubuntu.com/v1/51cf2c57-multipass-virt-manager-gui.png)
-->

````

Expand All @@ -135,7 +142,14 @@ Multipass runs as the `root` user, so to see the instances in VirtualBox, or th
sudo VirtualBox
```

```{figure} /images/multipass-macos-virtualbox-manager.png
:width: 720px
:alt: Multipass instances in VirtualBox
```

<!-- Original image on the Asset Manager
![Multipass instances in VirtualBox](https://assets.ubuntu.com/v1/9c959eed-multipass-macos-virtualbox-manager.png)
-->

And, to list the instances on the command line, run:

Expand All @@ -162,7 +176,14 @@ Multipass runs as the _System_ account, so to see the instances in VirtualBox, o
& $env:USERPROFILE\Downloads\PSTools\PsExec.exe -s -i $env:VBOX_MSI_INSTALL_PATH\VirtualBox.exe
```

```{figure} /images/multipass-windows-virtualbox-manager.png
:width: 720px
:alt: Multipass instances in VirtualBox
```

<!-- Original image on the Asset Manager
![Multipass instances in VirtualBox](https://assets.ubuntu.com/v1/edce2443-multipass-windows-virtualbox-manager.png)
-->

To list the instances on the command line:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,14 @@ duti -s com.googlecode.iTerm2 com.apple.terminal.shell-script shell

Create an empty file with a `.command` extension and find it in Finder. Select the file and press `⌘I`. You should be presented with an information pane like this:

```{figure} /images/multipass-file-command-info.png
:width: 289px
:alt: file.command info
```

<!-- Original image on the Asset Manager
![file.command info|289x366](https://assets.ubuntu.com/v1/1ce425a9-multipass-file-command-info.png)
-->

Expand the "Open with:" section, select your preferred terminal application and click on "Change All...".

Expand Down
7 changes: 7 additions & 0 deletions docs/how-to-guides/install-multipass.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,14 @@ Download the latest installer from [our download page](https://canonical.com/mul

Run the downloaded installer and follow the guided procedure.

```{figure} /images/multipass-installer-macos.png
:width: 658px
:alt: Multipass installer on macOS
```

<!-- Original image on the Asset Manager
![Multipass installer on macOS|658x475](https://assets.ubuntu.com/v1/ac6f638d-multipass-installer-macos.png)
-->

````

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,9 @@ In this tutorial, you will see how to get started with the Docker blueprint by c

Let's start by installing Multipass on your machine, following the steps in [How to install Multipass](/how-to-guides/install-multipass).

<!-- Out of date and unnecessary
![|720x643](https://assets.ubuntu.com/v1/25ca03d0-mp-docker.png)
-->

## Launch a Docker VM

Expand All @@ -51,10 +53,17 @@ multipass launch docker
This command will create a virtual machine running the latest version of Ubuntu, with Docker and Portainer installed. You can now use Docker already! Try the command below to see for yourself!

```{code-block} text
multipass exec docker docker`
multipass exec docker docker
```

```{figure} /images/run-a-docker-container-in-multipass/mp-docker-2.png
:width: 720px
:alt: Screenshot of terminal output
```

<!-- Original image on the Asset Manager
![|720x540](https://assets.ubuntu.com/v1/29e87039-mp-docker-2.png)
-->

## Alias of the Docker commands

Expand All @@ -68,7 +77,9 @@ In order for these to work, you just need to add them to the path so that you ca
PATH="$PATH:/home/<user>/snap/multipass/common/bin"
```

<!--![|720x239](https://assets.ubuntu.com/v1/2eec7028-mp-docker-3.png)-->
<!--
![|720x239](https://assets.ubuntu.com/v1/2eec7028-mp-docker-3.png)
-->

Run the command:

Expand Down Expand Up @@ -101,17 +112,38 @@ Let's now go one step further, with Portainer. The Docker blueprint comes with P
multipass list
```

```{figure} /images/run-a-docker-container-in-multipass/mp-docker-4.png
:width: 720px
:alt: Screenshot of terminal output
```

<!-- Original image on the Asset Manager
![|720x188](https://assets.ubuntu.com/v1/1e998c4e-mp-docker-4.png)
-->

There should be two IP addresses listed, one for the Docker instance, the other for Portainer. The Portainer IP should start with a 10.

In a web browser, enter the Portainer IP address from the previous step followed by the Portainer port, 9000, like this: “<IP address>:9000”. Set up a username and password at the prompt, then select the option for managing a *local* Docker environment and click *connect*.

```{figure} /images/run-a-docker-container-in-multipass/mp-docker-5.png
:width: 720px
:alt: Portainer - Connect to the local Docker environment
```

<!-- Original image on the Asset Manager
![|720x596](https://assets.ubuntu.com/v1/0f980233-mp-docker-5.png)
-->

Click on the newly created “Local” environment to manage the Docker instance on your local VM.

```{figure} /images/run-a-docker-container-in-multipass/mp-docker-6.png
:width: 720px
:alt: Portainer - Local Docker environment
```

<!-- Original image on the Asset Manager
![|720x459](https://assets.ubuntu.com/v1/3a7af624-mp-docker-6.png)
-->

## Launching a container

Expand All @@ -121,19 +153,47 @@ For this tutorial, you will be creating a blog using the Ghost template in Porta

Inside Portainer, click on **App Templates** in the left toolbar, and scroll down to the **Ghost** template.

```{figure} /images/run-a-docker-container-in-multipass/mp-docker-7.png
:width: 720px
:alt: Portainer - App Templates
```

<!-- Original image on the Asset Manager
![|720x461](https://assets.ubuntu.com/v1/b80ef240-mp-docker-7.png)
-->

Now, you can configure and deploy the template. Enter a name and click deploy. The **bridge** network is the default and correct option.

```{figure} /images/run-a-docker-container-in-multipass/mp-docker-8.png
:width: 720px
:alt: Portainer - App Templates - Configuration
```

<!-- Original image on the Asset Manager
![|720x541](https://assets.ubuntu.com/v1/1ade4cfc-mp-docker-8.png)
-->

On the **Containers** page, you should now see two containers running. One containing Ghost, and the other containing Portainer itself.

```{figure} /images/run-a-docker-container-in-multipass/mp-docker-9.png
:width: 720px
:alt: Portainer - Container list
```

<!-- Original image on the Asset Manager
![|720x373](https://assets.ubuntu.com/v1/0e720c25-mp-docker-9.png)
-->

You can now access your Ghost blog by going to the published port indicated in the Containers page, i.e., **\<VM IP Address\>:\<Ghost Port\>**.

```{figure} /images/run-a-docker-container-in-multipass/mp-docker-10.png
:width: 720px
:alt: Ghost homepage
```

<!-- Original image on the Asset Manager
![|720x603](https://assets.ubuntu.com/v1/357843ef-mp-docker-10.png)
-->

There it is, your blog running within a Docker container inside Multipass!

Expand Down
7 changes: 7 additions & 0 deletions docs/how-to-guides/troubleshoot/troubleshoot-networking.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,14 @@ PING 1.1.1.1 (1.1.1.1) 56(84) bytes of data.

Note that macOS's firewall can block the ICMP packets that `ping` uses, which will interfere with this test. Make sure you disable **Stealth Mode** in **System Preferences > Security & Privacy > Firewall** just for this test.

```{figure} /images/multipass-security-privacy.jpg
:width: 690px
:alt: Security & Privacy
```

<!-- Original image on the Asset Manager
![Security & Privacy|690x605](https://assets.ubuntu.com/v1/a4c00e5f-multipass-security-privacy.jpg)
-->

If you try again, it should work:

Expand Down
Binary file added docs/images/contribute-to-discourse-docs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/multipass-file-command-info.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/multipass-installer-macos.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/multipass-remmina.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/multipass-security-privacy.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/multipass-virt-manager-gui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/multipass-windows-terminal-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/multipass-windows-terminal-2.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/multipass-xlogo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/tutorial/mp-linux-1.png
Binary file added docs/images/tutorial/mp-linux-2.png
Binary file added docs/images/tutorial/mp-linux-2a.png
Binary file added docs/images/tutorial/mp-linux-3.png
Binary file added docs/images/tutorial/mp-linux-4.png
Binary file added docs/images/tutorial/mp-linux-5.png
Binary file added docs/images/tutorial/mp-linux-6.png
Binary file added docs/images/tutorial/mp-linux-7.png
Binary file added docs/images/tutorial/mp-linux-8.png
Binary file added docs/images/tutorial/mp-macos-1.png
Binary file added docs/images/tutorial/mp-macos-2.png
Binary file added docs/images/tutorial/mp-macos-3.png
Binary file added docs/images/tutorial/mp-macos-4.png
Binary file added docs/images/tutorial/mp-macos-5.png
Binary file added docs/images/tutorial/mp-macos-6.png
Binary file added docs/images/tutorial/mp-macos-7.png
Binary file added docs/images/tutorial/mp-macos-8.png
Binary file added docs/images/tutorial/mp-macos-9.png
Binary file added docs/images/tutorial/mp-windows-1.png
Binary file added docs/images/tutorial/mp-windows-12.png
Binary file added docs/images/tutorial/mp-windows-14.png
Binary file added docs/images/tutorial/mp-windows-15.png
Binary file added docs/images/tutorial/mp-windows-16.png
Binary file added docs/images/tutorial/mp-windows-17.png
Binary file added docs/images/tutorial/mp-windows-2.png
Binary file added docs/images/tutorial/mp-windows-3.png
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ We value your input and contributions! Here are some ways you can join our commu

* Read our [Code of Conduct](https://ubuntu.com/community/code-of-conduct)
* Read our quick guide: [Contribute to Multipass docs](./contribute-to-multipass-docs)
* Join the [Discourse forum](https://discourse.ubuntu.com/c/multipass/21)
* Join the [Discourse forum](https://discourse.ubuntu.com/c/project/multipass/21/)
* Report an issue or contribute to the code on [GitHub](https://github.com/canonical/multipass/issues)


Expand Down
Loading
Loading