Skip to content

Solution for building qubes-os.org website locally on Fedora 38/39/40/41 and Debian 12 #237

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Dec 15, 2024
Merged
1 change: 1 addition & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
source 'https://rubygems.org'
gem 'github-pages', group: :jekyll_plugins
gem 'json', '~> 2.0'
gem 'webrick'
8 changes: 7 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,10 @@ all:
clean:
$(RM) -r _site

.PHONY: all clean
rootless:
jekyll serve

rootless-setup:
gem install --user-install github-pages webrick

.PHONY: all clean rootless rootless-setup
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,36 @@ Git submodules for content:

## Instructions

### Ruby Gems

These instructions have been tested on a Fedora 38 qube on QubesOS 4.1 and on the following qubes on QubesOS 4.2: `debian-12-xfce`, `debian-12`, `fedora-40-xfce`, `fedora-40`, `fedora-39-xfce`, `fedora-39`, `fedora-38-xfce`, `fedora-38`.

1. Install in your template (or standalone): `ruby-devel` (if Fedora-based) or `ruby-all-dev`, `make`, `g++` (if Debian-based)

2. In your AppVM based on that template (or the same standalone), clone this repo, incl. all submodules, and enter it:

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

3. Finish setup in the repo folder (requires internet connection):

$ make rootless-setup
On Debian-based AppVMs / Standalones, you need to also put the gems on your PATH:

$ echo "PATH=\$PATH:$(find ~/.local/share/gem/ruby -type d -name bin | tail -n1)" >> ~/.bashrc
$ . ~/.bashrc

4. This concludes setup; when you want to start the local server which runs the website (offline):

$ make rootless

5. Then open your browser and navigate to:

http://127.0.0.1:4000/
or

http://localhost:4000/

### Podman Compose

These instructions have been tested on a Fedora 33 qube. Podman is not
Expand Down