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 ofqubes-hcl-report
)qubes-posts
(news and blog posts)
Instructions
Docker Compose
-
Install the Docker Engine and Docker Compose.
-
Start the Docker daemon, e.g.:
$ sudo systemctl start docker
-
Clone this repo, including all submodules, and enter it:
$ git clone --recursive https://github.com/QubesOS/qubesos.github.io.git $ cd qubesos.github.io/
-
Start and run the website:
$ sudo make
-
Open your browser and navigate to:
http://127.0.0.1:4000/
Jekyll on Fedora
-
Install dependencies:
$ sudo dnf install redhat-rpm-config ruby ruby-devel zlib-devel nodejs
-
Clone this repo, including all submodules, and enter it:
$ git clone --recursive https://github.com/QubesOS/qubesos.github.io.git $ cd qubesos.github.io/
-
Update RubyGems:
$ sudo gem update --system
-
Install required Gems:
$ gem install jekyll bundler github-pages
-
Serve the website:
$ bundle exec jekyll serve
-
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
- Jekyll Documentation - template rendering engine
- Bootstrap 3 - styling and CSS structure
- FontAwesome - the icon font throughout the site
- jQuery 1.7 - javascript helper library
- jQuery ToC MD Generator - renders header menu on documentation section