The Qubes OS Project Official Website
CSS HTML Shell JavaScript Python Ruby
Clone or download
marmarek autoupdate: _doc
_doc:
    gpg: Good signature from "Andrew David Wong (Qubes Documentation Signing Key)" [ultimate]
    object a7a48fb2f7df72ddb1152aeca801e2ec25b11057
    type commit
    tag adw_a7a48fb2
    tagger Andrew David Wong <adw@andrewdavidwong.com> 1534108720 -0500

    Tag for commit a7a48fb2f7df72ddb1152aeca801e2ec25b11057

    a7a48fb Fix headings
    dcd9552 Separate warnings into sections by version
Latest commit 98a24f4 Aug 12, 2018
Permalink
Failed to load latest commit information.
_data Add XSA-274 Jul 26, 2018
_doc @ a7a48fb autoupdate: _doc Aug 12, 2018
_drafts Updated README with docs, commented out Donate items, changed draft t… Dec 7, 2015
_hcl @ 02f17a4 autoupdate: _hcl Jun 7, 2018
_includes Remove Cookie Consent Jul 22, 2018
_layouts Improve use of space on small screens May 13, 2018
_posts @ f3ec8d2 Update _posts submodule Aug 8, 2018
_sass Improve use of space on small screens May 13, 2018
_utils Create manpage script for Qubes 4.0 Mar 18, 2018
attachment @ 1a346f5 autoupdate: _doc attachment May 25, 2018
css Remove Cookie Consent Jul 22, 2018
fonts upgraded FontAwesome lib QubesOS/qubes-issues#1460 Dec 7, 2015
js Remove Cookie Consent Jul 22, 2018
news Remove ineffectual URL prepends Mar 7, 2017
pages Add mirrors.gigenet.com to download mirror list Aug 9, 2018
.gitignore Revert "Remove Gemfile and add to .gitignore" Jun 14, 2018
.gitmodules updating modules May 5, 2015
.travis.yml autoupdate: _doc Mar 18, 2018
404.md Create custom 404 page Mar 9, 2016
CNAME Create CNAME Jul 22, 2018
CONTRIBUTING.md Create CONTRIBUTING.md May 27, 2017
Gemfile Revert "Remove Gemfile and add to .gitignore" Jun 14, 2018
Makefile Update Makefile to remove Gemfile; update instructions to use Makefile Nov 15, 2017
README.md Update links from /mailing-lists/ to /support/ Apr 2, 2018
_config.yml Replace manual sitemap with jekyll-sitemap plugin Feb 3, 2018
android-chrome-192x192.png Generate favicons for all browsers and platforms Oct 24, 2016
android-chrome-512x512.png Generate favicons for all browsers and platforms Oct 24, 2016
apple-touch-icon.png Generate favicons for all browsers and platforms Oct 24, 2016
browserconfig.xml Generate favicons for all browsers and platforms Oct 24, 2016
docker-compose.yml Add docker-compose file Jun 24, 2017
favicon-16x16.png Generate favicons for all browsers and platforms Oct 24, 2016
favicon-32x32.png Generate favicons for all browsers and platforms Oct 24, 2016
favicon.ico Generate favicons for all browsers and platforms Oct 24, 2016
feed.xml Include project_url in feed links Mar 7, 2017
manifest.json Generate favicons for all browsers and platforms Oct 24, 2016
mstile-150x150.png Generate favicons for all browsers and platforms Oct 24, 2016
robots.txt Create robots.txt and specify path to sitemap.xml Oct 28, 2016
safari-pinned-tab.svg Generate favicons for all browsers and platforms Oct 24, 2016

README.md

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.

Backers

Support us with a monthly donation and help us continue our activities. [Become a backer]

Supporters

Is your organization using Qubes? Ask your manager to support us. Your organization's logo will show up on our Partners page. [Become a supporter]


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

Docker Compose

  1. Install the Docker Engine and Docker Compose.

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

     $ sudo systemctl start docker
    
  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/
    

Jekyll on Fedora

  1. Install dependencies:

     $ sudo dnf install redhat-rpm-config ruby ruby-devel zlib-devel nodejs
    
  2. Clone this repo, including all submodules, and enter it:

     $ git clone --recursive https://github.com/QubesOS/qubesos.github.io.git
     $ cd qubesos.github.io/
    
  3. Update RubyGems:

     $ sudo gem update --system
    
  4. Install required Gems:

     $ gem install jekyll bundler github-pages
    
  5. Serve the website:

     $ bundle exec jekyll serve
    
  6. 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 Guidelines

Our Documentation Guidelines include:

  • How to Report Issues
  • How to Contribute
  • Contribution Suggestions
  • Style Guidelines
  • Markdown Conventions
  • Git Conventions

Please carefully read these guidelines before submitting a pull request.

Dependencies & Third Party Docs