Building the site

Rspamd site build/contribute instructions

This repository hosts the content of rspamd.com, a static website generated with the Jekyll template system, similar to GitHub Pages. The site is built from a mix of static pages in markdown, plain html and posts from the _posts directory.

Build (self-host) instructions

To test the website locally, you will need git and jekyll. Jekyll, being a Ruby library, can be installed using the gem tool included with the ruby package.

Example setup on macOS with Homebrew

$ brew install git ruby
$ gem install jekyll jekyll-paginate rouge jekyll-seo-tag jekyll-sitemap

If gem install fails, there may be a system misconfiguration. Linux systems may work with sudo, but macOS requires specific setup. Refer to this document for instructions on configuring Ruby and gem via Homebrew.

Cloning the repository and running the site

After installing the dependencies, clone the repository and run the site:

$ git clone https://github.com/rspamd/rspamd.com
$ cd rspamd.com
$ jekyll serve -w

If successful, you should see output like this:

❯ jekyll serve -w
7.6s  Thu 15 Aug 22:23:13 2024
Configuration file: /Users/vstakhov/rspamd.com/_config.yml
            Source: /Users/vstakhov/rspamd.com
       Destination: /Users/vstakhov/rspamd.com/_site
 Incremental build: disabled. Enable with --incremental
      Generating...
                    done in 3.301 seconds.
 Auto-regeneration: enabled for '/Users/vstakhov/rspamd.com'
    Server address: http://127.0.0.1:4000
  Server running... press ctrl-c to stop.

The site will be accessible at http://127.0.0.1:4000.

Contribution

To contribute, follow the standard GitHub workflow: fork the repository, make your changes, test them locally and submit a pull request. For minor changes (e.g. typos or small corrections), you can use the GitHub edit button.

For detailed information on creating local links and testing website changes, refer to the contributing to rspamd.com website article.