Knowledge base

Information about vpsFree.org, manuals and FAQs.

User Tools

Site Tools

You are here: vpsFree.org knowledge base » manuals » vps » User Data
Trace:
manuals:vps:userdata

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
manuals:vps:userdata [2025/03/16 12:53] – Example flake URI aithermanuals:vps:userdata [2026/07/12 20:30] (current) – Annotate vpsAdmin navigation paths and update interface labels aither
Line 1: Line 1:
 ====== 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]]
Line 9: Line 9:
   * [[#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 =====
Line 154: Line 155:
  
 ==== NixOS Flake URI ==== ==== NixOS Flake URI ====
-Upon VPS startup, the command ''nixos-rebuild --flake $flake_uri'' is executed. This allows you to easily deploy a configuration that is publicly available, for example, on GitHub.+Upon VPS startup, the command ''nixos-rebuild switch --flake $flake_uri'' is executed. This allows you to easily deploy a configuration that is publicly available, for example, on GitHub.
  
 Example configuration: Example configuration:
manuals/vps/userdata.1742129606.txt.gz · Last modified: by aither

Page Tools

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki