Skip to content

Add build files to enable simple mirroring of the site

Anonymous Planet requested to merge github/fork/pterocles/site-build into master

Created by: pterocles

someone brought up an interesting point in #87 (closed): mirroring should be documented.

This is a placeholder/draft for after the v1.1.5 release/tag. It details and adds configuration for the mirror and build instructions.

  • install git: sudo apt install git
  • clone the repo: git clone https://github.com/Anon-Planet/thgtoa.git
  • install ruby-dev: sudo apt install ruby ruby-dev or use RVM - curl -sSL https://get.rvm.io | bash
  • update gems: gem update
  • add Gemfile: bundle init
  • install the gems in the Gemfile: bundle install

Serve the site (requires root/sudo):

  • test the site using: sudo bundle exec jekyll serve
  • build the site inside the _site folder using: sudo bundle exec jekyll build

_config.yml:

markdown: kramdown
kramdown:
  hard_wrap: false
plugins:
  - jekyll-relative-links
  - jekyll-sitemap
  - jekyll-seo-tag
relative_links:
  enabled: true
  collections: true
title: The Hitchhiker's Guide to Online Anonymity
description: The Hitchhiker's Guide to Online Anonymity
tagline: The Hitchhiker's Guide to Online Anonymity
author: AnonymousPlanet
theme: jekyll-theme-hacker
github:
  home_url: index.html
  pdf_url: export/guide.pdf
  odt_url: export/guide.odt
  guide_url: guide.html
  donations_url: donations.html
  changelog_url: CHANGELOG.html
  license_url: LICENSE.html
  about_url: about.html
  minisign_url: minisign.pub
  links_url: links.html
  twitter_url: https://twitter.com/AnonyPla
  mastodon_url: https://mastodon.social/@anonymousplanet
  tor_mirror_url: http://thgtoallkcxrdv37u6knsc3pumk6cq6lqmcqlw3j5vkmyahkxive4jyd.onion
defaults:
  -
    scope:
      path: ""
    values:
      layout: default
      sitemap: true
locale: "en-US"
author:
  name: AnonymousPlanet
  twitter: AnonyPla
social:
  name: AnonymousPlanet
  links:
    - https://github.com/Anon-Planet/thgtoa
include:
    - export/

Gemfile:

# frozen_string_literal: true

source "https://rubygems.org"

# gem "rails"

# gem "jekyll", "~> 4.2"
gem "github-pages", group: :jekyll_plugins
gem "webrick", "~> 1.7"

Originally posted: https://github.com/Anon-Planet/thgtoa/issues/87#issuecomment-1174733766

Merge request reports