SFML Website

This repository contains the source code of the SFML website.

The main goal here is to provide a place to easily report or even fix issues with the website. For longer discussions however one should still use the dedicated sub-forum on the SFML forum.

Development

As we're slowly migrating the old HTML + PHP based site over to Markdown + MkDocs, you can currently find both old and new world in this repository.

All primary pages and SFML 3 tutorials & documentation live in the pages/ directory, while all the old parts like SFML 2 tutorials are in the root directory.

MkDocs - Pre-Requisite

As MkDocs is Python based, make sure you have Python 3.x installed on your OS, which should also come with pip.

Note

You may want to set up a virtual environment as to not contaminate the rest of your system.

Use the following command to install all the necessary packages including MkDocs:

pip install -r ./requirements.txt --upgrade

Host & Build

For local development you usually want to directly serve the site, which MkDocs supports out of the box, including hot-reload:

mkdocs serve

This can take a few seconds. Once ready, you should see a localhost link in the terminal pointing you to website.

If you just want the output of the site, you can also just build site:

mkdocs build

Which puts all the generated HTML into the site/ directory.

PHP - Pre-Requisite

Warning

We don't really want to continue maintaining the PHP base site, so it's recommended to not make any changes to those sites.

Windows

It's highly recommended to use WSL2, as setting up Apache or Nginx is a lot more straight forward on a Linux subsystem.
If you don't want to do this, there are common packages such as XAMPP, WampServer, or AMPPS.

After WSL2 has been installed and you opened an Linux shell in the Windows Terminal, follow the Linux steps below.

macOS

Ensure brew is installed.

brew install php

brew install nginx
# OR
brew install httpd

Additional References:

• https://pimylifeup.com/install-nginx-on-macos/
• https://pimylifeup.com/install-php-on-macos/

Linux

On Linux, we'll provide commands for Debian/Ubuntu-like package managers. If you use a different distro, you'll have to look up the equivalent commands.

sudo apt install php8.1-fpm

sudo apt install nginx
# OR
sudo apt install apache2

In case php8.1-fpm doesn't exist, add the PPA:

sudo apt install software-properties-common
sudo add-apt-repository ppa:ondrej/php
sudo apt update

Configurations

General Notes:

• In case port 80 is already in use, change the port to something else. If you for example pick 1337, the website will then be accessible at http://sfml.localhost:1337
• On Windows, *.localhost DNS are automatically mapped to 127.0.0.1. If you want to use another custom domain, make sure to put a resolving DNS entry in your hosts file.
• On Windows with WSL2, you can use /mnt/c/... to access the C:\ drive.

Nginx

• On Linux:
  • Create a new config file at /etc/nginx/sites-available
  • Create a link to the sites-enabled directory, to enable the new config: sudo ln -s /etc/nginx/sites-available/sfml /etc/nginx/sites-enabled/sfml
  • Test the Nginx config: sudo /sbin/nginx -t
  • Reload the config: sudo service nginx reload or sudo systemctl reload nginx
• On macOS:
  • Start Nginx: brew services start nginx
  • Start php as service for Nginx: brew services start php
  • Edit: /usr/local/etc/nginx/nginx.conf or /opt/homebrew/etc/nginx/nginx.conf
  • Test the Nginx config: nginx -t
  • Reload the config: brew services reload nginx

server {
        listen 80;
        listen [::]:80;

        server_name sfml.localhost;
        root /path/to/the/cloned/SFML-website/repository;

        index index.php index.html;

        location / {
                try_files $uri $uri/ /index.php$is_args$args;
        }

        location ~* \.php$ {
                try_files $uri =404;
                fastcgi_split_path_info ^(.+\.php)(/.+)$;

                # Uncomment for Linux
                #fastcgi_pass unix:/run/php/php8.1-fpm.sock;

                # Uncomment for macOS
                #fastcgi_pass 127.0.0.1:9000;

                fastcgi_index index.php;
                fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
                include fastcgi_params;
        }
}

Apache

• On Linux:
  • Create a new config file at /etc/apache2/sites-available
  • Create a link to the sites-enabled directory, to enable the new config: sudo ln -s /etc/apache2/sites-available/sfml /etc/apache2/sites-enabled/sfml
  • Test the Nginx config: sudo /sbin/apache2 -t
  • Reload the config: sudo service apache2 reload or sudo systemctl reload apache2
• On macOS:
  • Edit: /usr/local/etc/httpd/httpd.conf or /opt/homebrew/etc/httpd/httpd.conf
  • Reload the config: brew services reload httpd

<VirtualHost *:80>
        ServerName sfml.localhost

        DocumentRoot /path/to/the/cloned/SFML-website/repository
        DirectoryIndex index.php index.html
</VirtualHost>

License

See the LICENSE file.