install.fairie/.config/docs/readme-playbook/quick-start.md

35 lines
2 KiB
Markdown
Raw Normal View History

2022-12-24 12:04:59 -08:00
## Quick Start
The easiest way to run the entire playbook, outlined in the `main.yml` file, is to run the appropriate command listed below. These commands will run the playbook on the machine you run the command on. This is probably the best way to get your feet wet before you decide to give us a ⭐ and customize the playbook for your own needs. Ideally, this command should be run on the machine that you plan on running Ansible with to provision the other computers on your network. It is only guaranteed to work on fresh installs so testing it out with [Vagrant](https://www.vagrantup.com/) is highly encouraged.
### Vagrant (Recommended)
To test it out with Vagrant, you can run the following commands which will open up an interactive dialog where you can pick which operating system and virtualization provider you wish to test the installation with:
```shell
bash start.sh && task ansible:test:vagrant
```
### macOS/Linux
```shell
curl -sSL https://install.doctor/quickstart > ./setup.sh && bash ./setup.sh
```
### Windows
In an administrative PowerShell session, run:
```powershell
iex ((New-Object System.Net.WebClient).DownloadString('https://install.doctor/windows-quickstart'))
```
### Qubes
Our playbooks include a specially crafted playbook for Qubes. It will load your VMs with sensible defaults. For more details, check out the [Qubes playbook](https://gitlab.com/megabyte-labs/gas-station/-/blob/master/playbooks/qubes.yml) and [Qubes variables](https://gitlab.com/megabyte-labs/gas-station/-/blob/master/environments/prod/group_vars/qubes). Perhaps most importantly, the "quickstart" [the inventory file](https://gitlab.com/megabyte-labs/gas-station/-/blob/master/environments/prod/inventories/quickstart.yml) details the VM structure that the provisioning script adds to the target system.
To setup Qubes, run the following on a fresh install in dom0:
```shell
qvm-run --pass-io sys-firewall "curl -sSL https://install.doctor/qubes" > ./setup.sh && bash ./setup.sh
```