| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| manuals:vps:userdata [2025/03/16 14:08] – [NixOS Flake URI] fix nixos-rebuild aither | manuals:vps:userdata [2026/07/12 20:30] (current) – Annotate vpsAdmin navigation paths and update interface labels aither |
|---|
| ====== User Data ====== | ====== User Data ====== |
| When creating or reinstalling a VPS, vpsAdmin can upload a script or configuration for [[https://cloud-init.io/|cloud-init]] into the VPS. This script or configuration is applied on the first startup of the VPS. We support three formats for the initial configuration: | When creating or reinstalling a VPS, vpsAdmin can upload a script or configuration for [[https://cloud-init.io/|cloud-init]] into the VPS. This script or configuration is applied on the first startup of the VPS. We support these formats for the initial configuration: |
| |
| * [[#script|script]] | * [[#script|script]] |
| * [[#nixos_flake_uri|NixOS flake URI]] | * [[#nixos_flake_uri|NixOS flake URI]] |
| |
| Scripts and configurations can be stored in vpsAdmin, and you can select the configuration method when creating/reinstalling a VPS. You can manage stored configurations in vpsAdmin under **VPS** -> **User data**, or **Edit profile** -> **User data**. Alternatively, you can provide a configuration directly during the creation/reinstallation of a VPS without saving it in vpsAdmin. Saving configurations is optional but can simplify repeated use of unchanged configurations. | Scripts and configurations can be stored in vpsAdmin, and you can select the configuration method when creating/reinstalling a VPS. You can manage stored configurations in vpsAdmin under <vpsadmin-nav id="userdata.manage-vps.open">**VPS** -> **User data**</vpsadmin-nav>, or <vpsadmin-nav id="userdata.manage-profile.open">**Edit profile** -> **User data**</vpsadmin-nav>. Alternatively, you can provide a configuration directly during the creation/reinstallation of a VPS without saving it in vpsAdmin. Saving configurations is optional but can simplify repeated use of unchanged configurations. |
| |
| For development and testing, you can deploy a stored configuration to a VPS at any time: | For development and testing, you can deploy a stored configuration to a VPS at any time: |
| **vpsAdmin** -> **VPS** -> **User data** -> Edit an entry from the list, then use the **Deploy to VPS** form. | <vpsadmin-nav id="userdata.deploy.open">**vpsAdmin** -> **VPS** -> **User data** -> Edit an entry from the list, then use the **Deploy to VPS** form</vpsadmin-nav>. This action will only create the script/configuration files inside the VPS, it will not run/apply |
| | it. |
| |
| ===== Configuration Formats ===== | ===== Configuration Formats ===== |