Guide and scripts to locally build the FSFE website or single files of it
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Michael Weimann 294a2ff8b0 Removes less from docker (#5) 4 月之前
status change ignoring and keeping of folders to prevent dirty directories when dealing with the fsfe-website git and its .gitignore 10 月之前
.gitignore Add a docker dev setup (#3) 5 月之前
Dockerfile Removes less from docker (#5) 4 月之前
LICENSE adding README and license 2 年之前
README.md Add a docker dev setup (#3) 5 月之前
config.cfg.docker Add a docker dev setup (#3) 5 月之前
config.cfg.sample fix paths 10 月之前
create-mime.assign.pl initial commit 2 年之前
docker-cmd.sh Removes less from docker (#5) 4 月之前
docker-compose.yml Add a docker dev setup (#3) 5 月之前
docker-setup.sh Replace /bin/bash with /usr/bin/env bash (#4) 4 月之前
fsfe-preview.sh Link instead of copy static files 4 月之前
lighttpd-fsfe.conf.sample fix paths 10 月之前
pywebserver-fsfe.py adding option to use python simplehttp webserver module which doesn't require users to install lighttpd 2 年之前

README.md

FSFE Website Local Build

This is a collection of scripts, tools and configuration files necessary to build fsfe.org websites locally.

Full instructions can be found in FSFE’s wiki: https://wiki.fsfe.org/TechDocs/Mainpage/BuildLocally

Docker based development environment

For convenience local development you may want to use the docker contaienr provided by this repo.

The container contains everything you need to work on the website including serving a preview, building the static pages and the CSS files.

Requirements

Website Dev Instructions

Initial set up

Just run the following command for the initial setup:

./docker-setup.sh

⚠ The command may run some hours, since it does the initial full build of the website.

Development

Spin up the container (⚠ takes some minutes):

docker-compose up

The website should now be available on your machine under http://127.0.0.1:8000/.

Build a single page after changes (e.g. index.de.xhtml):

docker exec \
    --workdir /fsfe-local-build/fsfe.org \
    fsfe-local-build \
    bash ../fsfe-preview.sh ../fsfe-website/index.de.xhtml

Style modifications in fsfe-website/look trigger a re build of the styles. After modifications a page reload shoud show the changes.