Home
Blog
Features
Contribute
Docs
Github
Release
latest
v5
v4
v3
v3 (old)
v2 and v1
Photon OS Documentation
Quick Start Links
What is New in Photon 5
Overview
Introduction to Photon OS
Flavours
Installation Guide
Downloading Photon OS
Upgrading Photon OS 4.0 system to Photon OS 5.0
Building Images
Folder Layout
Build Prerequisites
Build an ISO from the Source Code for Photon OS
Building the ISO
Build Other Images for Photon OS
Building Cloud Images
Building OVA image
Use the Cached Toolchain and RPMS
Use Cached Sources
View Build Logs
Build a Custom ISO from the Source Code of Photon OS Installer
Building Package or Kernel Modules Using a Script
Hello World Kernel Module
Hello World Binary
Manage a Dependent package
Include a patch file
Refer an External Source
Running Photon OS on vSphere
Prerequisites for Running Photon OS on vSphere
Importing the OVA for Photon OS
Installing the ISO Image for Photon OS
Running Photon OS on Fusion
Prerequisites for Running Photon OS on Fusion
Importing the OVA for Photon OS
Installing the ISO Image for Photon OS
Running Photon OS on Workstation
Prerequisites for Photon on Workstation
Importing the OVA for Photon OS
Installing the ISO Image for Photon OS
Running Photon OS on Amazon Elastic Cloud Compute
Prerequisites for Running Photon OS on AWS EC2
Set Up Photon OS on EC2
Deploy a Containerized Application in Photon OS
Launch the Web Server with Cloud-Init
Terminate the AMI Instance
Running Photon OS on Microsoft Azure
Prerequisites for Running Photon OS on Azure
Set Up Azure Storage and Uploading the VHD
Remove Photon OS From Azure
Running Photon OS on Google Compute Engine
Prerequisites for Running Photon OS on GCE
Installing Photon OS on Google Compute Engine
Running Photon OS on Raspberry Pi
Prerequisites for Running Photon OS on Raspberry Pi
Installing Photon OS on Raspberry Pi
Enabling Raspberry Pi Interfaces using Device Tree
Deploying a Containerized Application in Photon OS
Compatible Cloud Images
Administration Guide
Photon OS Packages
Examining the Packages in the SPECS Directory on Github
Looking at the Differences Between the Minimal and the Full Version
The Root Account and the 'sudo' and 'su' Commands
Examining Signed Packages
Photon OS Package Repositories
Building a Package from a Source RPM
Compiling C++ Code on the Minimal Version of Photon OS
Package Management in Photon OS with 'tdnf'
Introduction to 'tdnf'
Configuration Files and Repositories
Adding a New Repository
Mount the Photon ISO Image for the Photon-ISO Repository
Adding the Dev Repository to Get New Packages from the GitHub Dev Branch
tdnf-automatic
Install Packages from CLI
SSL Options
Standard Syntax for tdnf Commands
tdnf Commands
tdnf Command Options
Configuration Options
Managing Services with 'systemd'
Viewing Services
Controlling Services
Creating a Startup Service
Disabling the Photon OS httpd.service
Installing Sendmail
Auditing System Events with auditd
Analyzing systemd Logs with journalctl
Migrating Scripts to systemd
Configure Wireless Networking
Managing the Network Configuration
Commands to Manage Network Service
Using the Network Configuration Manager
Use 'ip' and 'ss' Commands
Configuring Network Interfaces
Setting a Static IP Address
Turning Off DHCP
Adding a DNS Server
Setting Up Networking for Multiple NICs
Combining DHCP and Static IP Addresses with IPv4 and IPv6
Clearing the Machine ID of a Cloned Instance for DHCP
Using Predictable Network Interface Names
Inspecting the Status of Network Links with 'networkctl'
Turning On Network Debugging
Installing packages for 'tcpdump' and 'netcat'
Mounting a Network File System
Configuring a Secondary Network Interface using Cloud-Network
Using Network Event Broker
Configuring a Network Using Network Configuration Manager
Prioritize eth0 Route Over WLAN
Configuring Photon Real-Time Operating System for Real-Time Applications
Containers
Docker Containers
Docker Rootless Support
Kubernetes
Support for distributed builds using Kubernetes
Changing the Locale
Cloud-Init on Photon OS
Cloud-Init Overview
Deploy Photon OS With 'cloud-init'
Customizing Guest OS using Cloud-Init
Creating a Stand-Alone Photon Machine With cloud-init
Customizing a Photon OS Machine on EC2
Running a Photon OS Machine on GCE
Security Policy
Default Firewall Settings
Default Permissions and umask
Disabling TLS 1.0 to Improve Transport Layer Security
Support for zstd Compression
Photon RPM OSTree: a simple guide
Introduction
Installing a host against default server repository
Concepts in Action
Querying for Commit File and Package Metadata
Host Updating Operations
Creating a Server
Installing a Photon RPM-OStree host against a custom server repository
Automatic Updates
File Oriented Server Operations
Package Oriented Server Operations
Remotes
Running container applications between bootable images
Install or rebase to Photon OS
Support for SELinux
pmd-nextgen Overview
Features
Installing photon-mgmtd
Configuration
photon-mgmtd API
Service Management
System Management
Network Management
User, Group, and Host Management
Package Management
Firewall nftables Management
Process Details and Configuration Management
Writing a Plugin
Photon OS Installer Overview
User Guide
Setting Up Network PXE Boot
Kickstart Support in Photon OS
Packer Examples for Photon OS
Kubernetes on Photon OS
Prerequisites
Running Kubernetes on Photon OS
System Information
Prepare the Hosts
Configure Kubernetes Services on the Master
Configure the Kubernetes services on Node
Kubernetes-Kubeadm Cluster on Photon OS
Configuring a Master Node
Configure a Worker Node
Run a Hello-World Application
Photon NFS Utilities for Mounting Remote File Systems
Seamless Update with A/B Partition System
Configuring A/B Partition System
Executing Update and Rollback Using A/B Partition System
Commands for Operations
Command-Line Reference
Command-line Interfaces
Photon Network Config Manager Command-line Interface (nmctl)
Configuring WireGuard using Network Configuration Manager
Configure SR-IOV using Network Configuration Manager
Photon Real-Time Operating System Command-line Interface
Troubleshooting Guide
Introduction
Systemd and TDNF
The Root Account and the `sudo` and `su` Commands
Checking the Version and Build Number
General Best Practices
Photon OS Logs
Troubleshooting Progression
Solutions to Common Problems
Boot in Emergency Mode
Resetting a Lost Root Password
Fixing Permissions on Network Config Files
Permitting Root Login with SSH
Fixing Sendmail
Photon OS General Troubleshooting
Photon Code
Package Management
Network Configuration
Cloud-init
Open-vm-tools/Vmtoolsd
Troubleshooting Tools
Common Tools
Troubleshooting Tools Installed by Default
Installing Tools from Repositories
Linux Troubleshooting Tools
Systemd
Enabling 'systemd' Debug Shell During Boot
Troubleshooting Services With 'systemctl'
Analyzing System Logs with 'journalctl'
Inspecting Services with 'systemd-analyze'
Inspecting Services with 'systemd-analyze'
Network Troubleshooting
Managing the Network Configuration
Inspecting IP Addresses
Inspecting the Status of Network Links with 'networkctl'
Network Debugging
Checking Firewall Rules
Inspect Network Settings with 'netmgr'
File System Troubleshooting
Checking Disk Space
Adding a Disk and Partitioning It
Expanding Disk Partition
List Disk Partitions with 'fdisk'
File System Consistency Check Tool
Fixing File System Errors When fsck Fails
Troubleshooting Packages
Kernel Problems and Boot and Login Errors
Kernel Overview
Boot Process Overview
Blank Screen on Reboot
Investigating Unexpected Behavior
Investigating the Guest Kernel
Kernel Log Replication with VProbes
Linux Kernel
Performance Issues
General Performance Guidelines
Throughput Performance
Photon 4.0 to Photon 5.0 Migration and PostgreSQL Upgrade
Photon OS Installation Issue
Security Advisories
Edit this page
Create child page
Create docs issue
Create project issue
Print entire section
Photon OS Documentation
Command-Line Reference
Command-line Interfaces
Command-line Interfaces
Photon OS includes the following command-line utilities:
Photon Network Config Manager Command-line Interface (nmctl)
Photon Real-Time Operating System Command-line Interface
Last modified July 24, 2023:
trivial change to show what's up (911b3fb)