Logo

Administrator Documentation

  • Install Ravada
    • Requirements
    • OS
    • Hardware
      • Memory
      • Disks
    • Install Ravada
    • Client
    • Run
    • Help
  • Install Ravada in Ubuntu
    • Upgrade Ravada
    • Ubuntu
    • Mysql Database
      • MySQL server
      • MySQL database and user
      • Config file
    • Ravada web user
    • Client
    • Run
    • Help
  • Install Ravada in Debian
    • Upgrade Ravada
    • Debian
      • Debian KVM
    • Mysql/MariaDB Database
      • MariaDB server
      • MariaDB database and user
      • Config file
    • Ravada web user
    • Client
    • Run
    • Help
  • Install on a Debian
  • Install Ravada on Fedora
    • Requirements
    • OS
    • Hardware
      • Memory
      • Disks
    • Install Ravada
    • Fedora and EPEL7
      • Add link to kvm-spice
      • MySQL server
      • MySQL database and user
      • Config file
    • Ravada web user
    • Firewall (Optional)
    • Client
    • Run
    • Help
  • Install Ravada on Rocky Linux 9 or RHEL9
    • Add Pre-Requisite Software
      • MySQL database and user
    • Add Another Pre-Requisite Software
    • Requirements
    • OS
    • Hardware
      • Memory
      • Disks
    • Make sure you are in root folder
    • Download Ravada from Git Repo
    • Install Ravada
      • Add link to kvm-spice
  • Install Ravada - Ubuntu Xenial
    • Packages
    • Perl Modules
    • Database and configuration
  • Install Ravada from dockers
    • Requirements
    • OS
    • Hardware
      • Memory
      • Disks
    • Install Ravada from dockers
    • Ravada web user
    • Client
    • Run
    • Dockers troubleshoots
    • Help
  • Running Ravada in production
    • System services
      • Configuration for boot start
      • Start
      • Status
      • Stop
    • Qemu
    • SPICE-TLS
    • Apache
    • Firewall
    • Help
  • log file
    • Frontend log file
    • Security Logs
  • Post Install Recomendations
    • Firewall
    • Configuration
  • Development release
    • Possible development scenarios where to deploy
    • Ubuntu required packages
    • Mysql Database
      • MySQL server
      • MySQL database and user
    • Config file
    • Ravada web user
    • Firewall(Optional)
    • Client
    • Daemons
    • Start/Shutdown scripts
  • Add KVM storage pool
    • Add the drive to the system
    • Mount the new partition
    • Add the drive to the Virtual Manager
    • Using the storage pool
  • Apache
    • Upgrading
    • Configure Hypnotoad proxy
    • Install Apache
    • Enable apache modules
    • Apache Proxy Configuration
    • Apache redirect to https
  • Nginx as reverse proxy
    • Remark
    • Install nginx (fast way)
    • Install nginx (recommended way)
    • Configure Hypnotoad proxy
    • Create Diffie-Hellman key
    • Configure nginx
    • Final check
    • Start nginx
    • Superfinal check
    • Last advice
  • How to import a Virtualbox image
    • Create an empty Virtual Machine
    • Convert the image file
      • DIRECTLY VDI TO QCOW2
      • OR IN TWO STEPS
      • 1. Convert to raw
      • 2. Convert to qcow2
  • How to create a Virtual Machine
    • Steps
  • How to dump a hard drive to Ravada
    • Introduction
    • Tools
    • Procedure
  • How to Install a LDAP Server
    • Install 389-ds
    • Configure directory server
      • Release 1.3 [old]
      • Release 1.4 [new]
      • Enable and Start the service
    • Add a LDAP section in the config file
    • Insert one test user
  • How to add a KVM template
    • Placing your own ISO image
    • XML file
    • XML Volume file
    • URL based ISO (simplified)
    • Windows specifics
  • New ISO image
  • Localized ISO downloads
    • Enabling localized distributions
      • Enabling localized distributions logging in
      • Enabling localized distributions from CLI
    • Adding more localized distributions
  • How to import a OpenGnsys image
  • Integrating Ravada and OpenGnsys
    • DHCP boot options
    • Create and empty virtual machine
    • NAT adaptation
    • Create the virtual machine in the Opengnsys console
    • Special script adaptation
  • Operation
    • Create users
    • Import KVM virtual machines
    • View all rvd_back options
    • Admin
      • Create Virtual Machine
      • ISO MD5 missmatch
      • Option 1: clean ISO and MD5
      • Option 2: refresh the ISO table
    • Create base of a Virtual Machine
      • 1st Base
      • 2nd base or more
  • Swap Partition
    • Swap Volume
    • Partitioning
    • Linux
  • Troubleshooting frequent problems
    • Could not access KVM kernel module:
    • Dealing with permissions
      • On Screnshots ( requires review )
        • Apparmor
    • Error with MySQL version < 5.6
    • MySQL binlogs fill the disk
    • Spice-Warning Error in certificate chain verification
    • Network is already in use
    • Copy & paste integration does not work
    • Resizing the viewer window does not change the guest display resolution
    • Windows 10 perfomance issues
    • Problems with the time of the VM guest
    • Content is empty after upgrade
    • Error: Web Service connection failed
    • Virtual machines won’t complete the shutdown
    • internal error: cannot load AppArmor profile libvirt
    • Cloned Ubuntu Server VMs assigned same IP
  • Upgrade Ravada
    • Steps for a clean update
      • Step 1
      • Step 2
      • Step 3
      • Step 4
      • Step 5
      • Problems upgrading
  • Upgrade Ravada with Rollback
    • Step 1: Shutdown the services
    • Step 2: Keep the package and data
      • Step 2.1: Keep the package file
      • Step 2.2: Save Current Data
    • Step 4: Upgrade
      • Step 4.1: Fetch the new package
      • Step 4.2: Install
      • Step 4.3: systemd
      • Step 4.4: apache config
      • Step 4.5: start
    • Rollback
  • Rollback Ravada Version
    • Restore Database
    • Install previous version
    • Restart the services
  • SPICE client setup for Windows
    • Download Virt Viewer
    • Fix Windows registry
  • SPICE client setup for MacOS
    • Virt-Viewer
  • Associate SPICE files with remote viewer
  • Problems
  • SPICE client setup for GNU/Linux
    • Virt-Viewer
      • Firefox
  • How to allow RDP connections
    • Steps to open RDP
    • Configure exposed port
    • Open the Virtual Machine with a RDP client
  • How to change the controller driver of a Windows VM to VirtIO
  • Backup Virtual Machines
    • Synopsis
    • Backup
      • Clones and bases
      • Owner
    • Restore
    • Migration to another server
    • Backup directory
  • Virtual Machine Manual Migration
    • Check the storage pools directories
    • Import the Base
      • Copy the Base definition
      • Copy the volumes
      • Define the base on destination
      • Import the base to Ravada on destination
    • Importing clones
      • Create a clone
      • Copy the clone volumes
      • Start the clone on destination
    • Importing Standalone Machine
      • Dumping data
      • XML file
      • Volume Files
      • Importing data
  • Kiosk Mode
    • Setting
    • Define a Network
    • Allow anonymous mode
    • Auto remove anonymous machines
    • Access
  • How to do a volatile Virtual Machine
    • Enable/disable this option
  • Ravada Cluster
    • Adding support for multiple Ravada nodes
      • Description
      • Nodes
      • Storage
      • New node
        • Requirements
        • Configuration
        • Security
      • Networking and Firewall
        • Master
        • Nodes
      • Operation
      • TroubleShooting
      • Balance algorithm
      • Selection algorithm
      • TODO
  • How to make a virtual machine disk sparse
    • Steps
  • Server Hardware
    • Shared Storage
    • Initial Hardware Setup
      • Memory
      • Network
      • Disk Drives
        • Operative System Disk drives
        • Bases Volumes
        • Clones Volumes
        • Configuration Examples
    • Growing and Scaling
    • Backup
  • Cluster Hardware
    • Shared Storage
    • Recommendations
  • Ravada CLI
    • Help
    • LDAP
      • Test LDAP connection
      • Create LDAP user
      • Create LDAP group
      • Add users to LDAP groups
    • Daily Hibernating and Stopping
  • Automatic Daily Operations
    • Cron
    • Usage
    • Examples
      • Hibernate disconnected
      • Hibernate active
      • Shutdown or Hibernate
    • Other usage
  • Single Sign On
    • Configuration
    • External libraries
    • Cookie key certificate
    • How it works
  • Auth OpenID
    • Apache Module
      • Install modules
      • Configure module
      • Restart Apache
      • Other Options
    • Login page
      • Your Server URL
      • Enable OpenID
      • Configure Custom Login page
  • AppAmor troubles
    • Symptoms
    • Possible workaround
  • Service Status
    • Configuration
  • Compact Virtual Machines
    • How to compact
    • Bases
    • Backup
    • Why compact
    • See also
  • Install TPM ( Trusted Platform Module )
    • Ubuntu
      • Ubuntu 20.04 - Focal Fossa
      • Ubuntu 22.04
    • Debian
    • Redhat and derivatives
    • Troubleshooting
  • Need read/write rights on statedir
    • References
  • Mount Virtual Volumes
    • Use cases
    • Mount volume
    • Check a filesystem
    • Restablish the volume
      • Umount volume
      • Disconnect NBD
  • Replace Server
    • Warning
    • Packages
    • Data Base
    • KVM
      • Storage Pools
      • Virtual Machine definitions
    • Ravada
  • Users Batch Uploading
    • Plain users and password
    • Delegated login
  • Groups
    • Uploading with web browser
  • File Formats
    • Text Files
      • Example: local users with password:
      • Example: local group
    • JSON Files
      • Example: json users
      • Example: json groups
      • Example: json groups and users
      • Example: json group members
      • Example: flushing group members
      • Example: removing empty groups
    • CLI
      • Add members to one group
      • Add members to many groups
  • Checking volume disk differences
    • Check volume size
    • Compare volume changes
    • Temporay disk volumes
  • Current Status
  • Releases
    • v0.2
    • v0.3
    • v0.4
    • v0.5
    • v0.6

Feature Documentation

  • Adding Custom Messages
    • Configuration
  • Create a custom login template
    • Custom login template contents
    • Configuration
    • Path for CSS, js and images
    • Restart frontend
  • Create a custom footer template
    • Configuration
    • Path for CSS, js and images
    • Restart frontend
  • Disable Spice Password
    • Define the network
    • Applying settings
    • Default setting
    • Why is that ?
  • Ravada advanced settings
    • Display IP
    • NAT
    • Auto Start
    • Choosing Storage Pool
      • Default Storage Pool
      • Specific Storage Pools
    • Chek free memory ( from v0.3 )
  • New documentation
    • Procedure
    • Sidebar
    • Convert POD files
    • Step-by-step contributing to docs
  • Configure LDAP Authentication
    • Configuration
    • Example: All users
    • Example: Group of users
    • Advanced Options
    • Example: Field
    • Example: Posix Group
    • Example: Attribute Filter
  • Authentication with Active Directory
    • Configure Ravada
      • Alternative login field
      • Filter
    • Group restriction
    • Run
  • Single Sign On
    • Configuration
    • External libraries
    • Cookie key certificate
    • How it works
  • Set access restrictions to Virtual Machines
    • Access restrictions
    • Configuration
      • Grant access
    • Examples
      • Example 1: grant access
      • Example 2: deny access
      • Example 3: remove an access restriction
  • Test Active Directory
    • Ravada Conf
    • Auth data
    • Run the tests
  • Tuning Ravada
    • IP Conflict
  • Server Monitoring
    • Install my-netdata.io
    • Apache config for netdata with SSL
    • Enable monitoring
    • Tunning netdata
      • Disable mail alarms
    • Monitoring Architecture
    • Graphite backend
    • Graphana
  • Guide button step-by-step
    • Enable guide
    • Custom guide
  • Offline libraries in frontend
  • Exposing a Virtual Machine
    • Setting a public IP
    • IPTables redirection
    • HTTP Forwarding
    • Expose Ports
  • Exposing Ports from a Virtual Machine
    • Requirements
    • Configure Expose
      • Fields
    • Run
    • Settings
    • TroubleShooting
  • Keeping the Base updated
    • Base volumes
    • Rebasing
    • Virtual Machine Volumes
      • Restoring clones
      • Volume Types
    • Rebase requirements
  • Spinoff Clone
    • Clones
    • Proceed to Spinoff
    • What happened behind the scenes ?
  • Live web Chatwoot
    • Create a JS widget
    • Configuration
      • Content Security Policy
      • Apply
      • Check headers
  • PCI GPU Device Passthrough
    • Status
    • Requirements
    • Hardware Identification
    • OS Configuration
      • Grub
      • Modules
      • GPUs with embedded USB
      • Make drivers use vfio
    • Checks
      • Modules
      • IOMMU
    • Ravada Setup
      • Configure the Node Host Device
    • Virtual Machine GPU Ubuntu setup
      • Packages
      • Choose the Display VGA
    • CUDA
    • Common Problems
      • Error: enable unsafe interrupts
      • Error: iommu group is not viable
    • PCI Templates
    • References
  • PCI Passthrough Templates
    • nVidia virtual GPUs and Ubuntu 24.04
      • 1. Find out host device id
      • 2. Find the HostDev Template
      • 3. Change the Template
  • Network Bridge
    • Host Configuration
      • Network interface
      • Configure network bridge
      • Assign the bridge to the virtual machine
  • VirtioFS
    • Usage Examples
      • Shared Space
      • Private Space
    • Requirements
    • Virtual Machine Configuration
    • Linux
      • Mount in the Virtual Machine
      • Mount read-only
    • Mount in Windows
    • Changing the owner of the directory
      • Set the user id
      • Mount Subdirectory in the base
    • Subdirectory Mode
      • Create Subdirectory filesystem
      • Set the owner
      • Prepare the Base
      • How the clones see it
      • How is it stored in the server
    • Read More
  • Firewall
    • Chains
    • Steps to reload the iptables
      • Step 1: Save the Ravada rules
      • Step 2: Apply your own rules
      • Step 3: Restore the Ravada rules

Guest VM section

  • Best practices to install Linux Guests in Ravada
    • Disk volumes
      • Installing software
    • Energy setup
    • Automatic or unattended upgrades
    • Limit systemd log size
  • Install Alpine Linux
    • Base Guest
    • Login
    • Setup
      • Keyboard
      • Hostname
      • Networking
      • Password
      • Timezone
      • Proxy
      • Mirror
      • SSH Server
      • Partitioning
      • Reboot
      • Installing more software
    • Shutdown and restart
    • Advanced Settings
      • Add a swap partition
        • Define de partition
        • Create the swap
        • Test it
        • Add it to the system
  • Install Windows 10
    • Requirements
      • Installation sources
      • Virtual Machine features
    • Create the Virtual Machine
    • Setup
      • Windows drivers
      • Windows Post Install
    • Use a swap partition for pagefiles
  • Install Windows 11
    • Requirements
      • Installation sources
      • Virtual Machine features
    • Create the Virtual Machine
    • Install The Operative System
      • Boot from CD
      • Install Windows 11
      • Windows drivers
      • Choose Destination Drive
    • Setup
      • Windows Post Install
    • Use a swap partition for pagefiles
  • How to extend a Ravada Windows guest’s disk space
    • Shutdown
    • Backup
    • Expand the volume
    • Remove and create the partition again
      • Connect the disk volume as a device
      • Remove and create the partition
    • Fix the new partition
      • ntfsfix
      • chkdsk
    • Check the new size
  • How to extend a Ravada Linux guest’s disk space
    • Shutdown
    • Backup
    • Expand the volume
    • Remove and create the partition again
      • Connect the disk volume as a device
      • Remove and create the partition
    • Fix the new partition
    • Start
    • Check the new size
  • How to extend a Linux LVM guest disk space
    • Shutdown
    • Backup
    • Running in Ravada host root
    • Restart VM, resize LVM inside of VM
    • Start
    • Connect to VM
    • Verify /dev/vda
    • Grow /dev/vda3
    • Now run the pvs resize command
    • Run the lvextend and resize2fs commands on /dev/mapper/ubuntu–vg-ubuntu–lv
    • Verify that the LVM is now running at 150G
  • How to enable KVM virsh console access
    • Requirements
      • From KVM Server
    • From Debian / Ubuntu guest
      • Option 1: Enable Serial Service
      • Option 2: Add console to grub
    • From KVM server
  • Reduce the image size after cloning a physical PC
    • Check the image format
    • STEPS TO FOLLOW
  • Qemu Guest Agent
    • Host Qemu Agent Prerequisits
    • Guest Agent Installation (VM)
      • Ubuntu and Debian
      • Fedora
      • RedHat and CentOS
      • Windows
    • For VM’s older than this functionality
  • Set Hostname
    • Requirements
      • Packages
      • Distributions
    • Linux
      • systemd
      • rc.local
    • Windows

Developer Documentation

  • Development Tools
  • Commit Rules
    • Main Branches
    • Issues
    • Commit Message
    • Show the branch in the message
    • Testing
    • Contribution Guide
  • Database Changes
    • SQL tables
    • Data
    • SQLite
    • Runtime upgrade
  • How to create a new grants
    • Grant user permissions by default
    • Defaults and upgrading
    • Testing
  • Profiling Ravada
    • Services
    • Request
    • Run rvd_back
    • Profile files
    • More info
  • Editor configuration rules
    • Highlight unwanted spaces
    • Vim Example
  • Local ISO server
    • ISO Web Server
      • Copy the ISO files
    • Apache
      • Install Apache
      • Config apache
      • Restart apache
    • Change the ISO locations
      • From localhost
      • From Virtual Machines
    • Try it
      • Remove from the VM storage pool
      • Remove the device name from the table
  • Run Ravada in development mode
    • Run scripts
    • Stop system Ravada
    • Run in fish
  • Testing environment
    • Run a single test
    • Advanced Features tests
      • LDAP
      • Nodes
      • Base Test machine
  • How to create tests
    • Test Requirements
    • Test Directory
    • Test File Template
    • Run
    • Trying the Virtual Managers
    • Test Example: check machine removal
  • Localization and translation
    • New entries
  • Ravada Documentation
    • MarkDown
    • reStructuredText
  • Frontend Libraries
    • Packages.json
    • Scripts
    • Fallback
      • Enable Fallback
      • Fetch the fallback
  • Hardening Spice security with TLS
    • Change libvirtd configuration
    • Add path in Apparmor
    • Create self signed certificate
    • Disable Spice Password
    • Debug and check TLS connection
    • Updating the certificate
RavadaVDI
  • Create a custom footer template
  • View page source

Create a custom footer template

If you need custom footer template create one and save it in /usr/share/ravada/templates/main/custom/, e.g. custom/custom_footer.html.ep

Configuration

Add your template in /etc/rvd_front.conf

Warning

Check that rvd_front.conf exists. If you work on a Development release you have an example here /etc/rvd_front.conf.example.

Warning

Do not include the extension file .html.ep in the path. E.g. custom_footer.html.ep -> custom_footer

,footer => 'main/custom/custom_footer'

Path for CSS, js and images

If CSS, js or images are needed save in: public/css/custom, public/js/custom or public/img/custom respectively.

Note

Make sure your CSS, JS or images in custom template refers to those paths.

Restart frontend

Finally restart rvd_front:

sudo systemctl restart rvd_front
Previous Next

© Copyright 2018-2023, RavadaVDI.

Built with Sphinx using a theme provided by Read the Docs.