Skip to content

Commit

Permalink
docs: Add note about server host name
Browse files Browse the repository at this point in the history
  • Loading branch information
jaydrogers committed Aug 20, 2024
1 parent b2bf79c commit 79de2e0
Showing 1 changed file with 4 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -99,8 +99,10 @@ apt -y update && apt -y upgrade && apt -y autoremove && apt -y autoclean && rebo
```
::


## Configure server inventory and settings
::note
If your files are encrypted, you need to use the [`spin vault edit`](/docs/command-reference/vault) command to edit the file. This will decrypt the file, open it in your default editor, and then re-encrypt it when you save and close the file.
::
Assuming you've already ran [`spin new`](/docs/command-reference/new) or [`spin init`](/docs/command-reference/init) in your project, there are two files that will need to be configured:
- `.spin-inventory.ini`
- `.spin.yml`
Expand All @@ -109,7 +111,7 @@ Assuming you've already ran [`spin new`](/docs/command-reference/new) or [`spin
We call the list of our servers "inventory". This follows the [Ansible Inventory format](https://docs.ansible.com/ansible/latest/inventory_guide/intro_inventory.html). For example, if you wanted to add `server01.example.com` as the production server, we would configure our file to look like this and add this server to go underneath the `production_manager_servers` group:

::note
If your files are encrypted, you need to use the [`spin vault edit`](/docs/command-reference/vault) command to edit the file. This will decrypt the file, open it in your default editor, and then re-encrypt it when you save and close the file.
Be sure to use your **server's hostname** (NOT your application's **domain name**) in the inventory file. This will ensure we have a dedicated DNS entry for managing your server.
::

::code-panel
Expand Down

0 comments on commit 79de2e0

Please sign in to comment.