Quickstart

This page takes you from the appliance file to a running device with an open console. The same download serves Community and Lite; see Community or Lite: one download.

Before you start#

• A hypervisor: Proxmox VE, VMware Workstation or VirtualBox.
• Enough CPU, memory and disk for the appliance, which ships with a thin-provisioned system disk. See Requirements and sizing.
• A CPU with Intel VT-x or AMD-V, and nested virtualization available on the host.
• One network interface on your LAN. DHCP is fine.
• Internet access from the appliance, for the first build of a Content Hub card and for Discover downloads.

1. Import the appliance#

1. Import the .ovaFollow Install from the OVA, for Proxmox VE, VMware Workstation or VirtualBox. Choose your format explains the download format.
2. Turn on nested virtualization before the first bootOn Proxmox VE, set the CPU type to host. On VMware Workstation, expose hardware-assisted virtualization to the guest. On VirtualBox, tick Enable Nested VT-x/AMD-V. ONEP runs its own virtual machines inside the appliance, and without this no virtual machine device will start. Without it, virtual machine devices do not start (routers and containers still do). The console banner and Settings › Status both say when it is missing.
3. Start the virtual machineWait until the web interface answers. When the platform is up, the console shows the ONEP banner with the address to open in a browser.

2. First sign-in#

1. Open the addressGo to https://<address shown on the console>/. Your browser warns about the certificate: the appliance creates its own certificate on first boot, so this is expected. Continue to the site.
2. Create the administrator passwordThe first time you open the address, ONEP shows Create the administrator password before anything else. Enter a password of at least 12 characters, confirm it and choose Create and sign in. ONEP does not generate one, and nothing is shown on the console. You are signed in as admin.
3. Work through the first-time setupAccept the agreement. Then the setup offers License, Network and ONEP Assistant, and each of these can be skipped. The appliance starts as Community. For Lite, choose your onep.lic file in the License step, or later in Settings › Licensing with Install license file…. Community needs no license file. Choose Open ONEP on the last step. See The first-time setup.
4. Turn on two-factor authentication, if you want itIn Settings › Account, choose Set up two-factor.

3. Check the appliance is healthy#

Open Settings › Status. Virtualization should read Ready. Under Service health, Database, Cache and Background tasks should read Online. The ONEP Assistant reads Not connected until you set up an AI source, which is optional (see AI Generator). The Network card lists the network checks, such as the virtual switch service, the virtual machine service and the management network; all should read Healthy.

4. Run a first environment#

From the Content Hub#

1. Pick a single-device cardOpen Content Hub and choose a card that shows one device. Before you start, the Content Hub tells you if the appliance has too little memory for it.
2. Walk through the wizardChoose a new environment, confirm the variant, review the plan with the real CPU, memory and disk per device, then choose Deploy environment.
3. Watch the build logA green line means the step reported success. The first build of a card downloads its parts from the vendor, so it takes a while and needs internet.
4. Open the consoleWhen the device reads Powered on, open it from the canvas. A text console can stay blank until you press Enter.

From the canvas#

1. Get an imageOpen Centrum › Discover and add an image, for example a Linux server, to your library.
2. Create an environmentChoose New environment, then choose Add device (shortcut: A) on the canvas to add two devices and a switch. The built-in native switch needs no image.
3. Cable and startConnect each device to the switch, then choose Power on for the environment.
4. Open a consoleRight-click a device and choose Open console.

5. Clean up#

When you are done, power the environment off and delete it from the Environments list. Delete removes every device, disk, virtual switch and network rule the environment created, and it cannot be undone. Shut the virtual machine down from the hypervisor: the appliance powers off running devices and stops its services before the system halts.

Next steps#

• Learn the canvas and the environment actions.
• Set the management address you want to keep: First boot and network.
• Read Troubleshooting before building something large. Several "is this broken?" moments have simple explanations.