You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
qubesos.github.io/README.md

7.7 KiB

Build Status

Qubes OS Official Website

Canonical URL: https://www.qubes-os.org

This is the main repository for the Qubes OS Project website. Qubes is a security-oriented, open-source operating system for personal computers. It uses virtualization to implement security by compartmentalization and supports both Linux and Windows virtual environments.

Your support counts!

Qubes OS is free and open-source software. If you rely on Qubes for secure computing in your work or personal life, or see the value in our efforts, please consider making a donation today.


Contents

This repository consists of a Jekyll site and several Git submodules for content:

  • qubes-doc (official documentation)
  • qubes-attachment (binary files such as images)
  • qubes-hcl (Hardware Compatibility List (HCL) reports generated by a YAML version of qubes-hcl-report)
  • qubes-posts (news and blog posts)

Instructions

Podman Compose

These instructions have been tested on a Fedora 33 qube. Podman is not available in Debian 10. You must use a Fedora-based machine or Debian 11.

  1. Install podman and podman-compose.

  2. Start the Podman daemon, e.g.:

     $ sudo systemctl start podman
    
  3. Clone this repo, including all submodules, and enter it:

     $ git clone --recursive https://github.com/QubesOS/qubesos.github.io.git
     $ cd qubesos.github.io/
    
  4. Start and run the website:

     $ sudo make
    
  5. Open your browser and navigate to:

     http://127.0.0.1:4000/
    

Notes

  • To update the submodules, use git submodule foreach git pull --tags.

  • For troubleshooting with RubyGems, see: http://guides.rubygems.org/

  • For troubleshooting with Jekyll, see: https://jekyllrb.com/docs/home/

  • For troubleshooting with GitHub pages and Jekyll, see: https://help.github.com/articles/using-jekyll-as-a-static-site-generator-with-github-pages/

  • To run on a Git post-receive hook, use:

     GIT_REPO=/usr/home/git/repositories/www.qubes-os.org.git
     GIT_CLONE=/usr/home/git/tmp/www.qubes-os.org
     PUBLIC_WWW=/usr/local/www/qubes-os.org/www/
    
     if [ ! -d "$GIT_CLONE" ]; then
         git clone --recursive $GIT_REPO $GIT_CLONE
     else
         git --work-tree=$GIT_CLONE --git-dir=$GIT_CLONE/.git pull
     fi
     cd $GIT_CLONE && jekyll build -s $GIT_CLONE -d $PUBLIC_WWW
    
     find $PUBLIC_WWW -type f -print0 | xargs -0 chmod 666
     find $PUBLIC_WWW -type d -print0 | xargs -0 chmod 777
    
     exit
    

Documentation

To contribute to the documentation, please see how to edit the documentation.

Dependencies & Third Party Docs

Deprecated Documentation