yadunut/clan-core
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Improve documentation

Browse Source
This commit is contained in:
Qubasa
2024-04-06 11:54:34 +02:00
parent 2e29c031ef
commit a520116584
6 changed files with 62 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
docs/admins/machines.md
View File

@@ -2,37 +2,6 @@
Begin your journey in machine management by introducing a new machine into your Clan environment. Follow these streamlined steps to get started:
## Adding Your First Machine
Begin your journey in machine management by introducing a new machine into your Clan environment. Follow these streamlined steps to get started:
1. **Create Your Machine**: Generate a new machine configuration using the Clan CLI with the command below:
```bash
clan machines create my-machine
```
2. **List Available Machines**: Verify the successful addition of your new machine and view any existing machines in your configuration:
```bash
clan machines list
```
_Note: The `$(mkpasswd)` command generates a hashed password. Ensure you have the `mkpasswd` utility installed or use an alternative method to generate a secure hashed password._
## Test Your Machine Configuration Inside a VM
Before deploying your configuration to a live environment, you can run a virtual machine (VM) to test the settings:
```shellSession
$ clan vms run my-machine
```
This command run a VM based on the configuration of `my-machine`, allowing you to verify changes in a controlled environment.
## Installing a New Machine