1
0
mirror of https://git.fsfe.org/FSFE/fsfe-local-build.git synced 2026-04-20 19:33:05 +02:00

6 Commits

Author SHA1 Message Date
Michael Weimann
2505f2be63 Removes less from docker 2019-06-11 20:28:27 +02:00
Reinhard Müller
a67c7aee6d Merge branch 'master' of git.fsfe.org:FSFE/fsfe-local-build 2019-06-04 10:12:37 +02:00
Reinhard Müller
4489cc1537 Symlink instead of copy static files to destination 2019-06-03 20:20:46 +02:00
Reinhard Müller
736a24329e Link instead of copy static files 2019-06-03 20:19:22 +02:00
ulf
ab1d56dd2d Replace /bin/bash with /usr/bin/env bash (#4) 2019-05-26 11:05:49 +02:00
Michael Weimann
47dbbc76a8 Add a docker dev setup (#3) 2019-04-29 18:18:59 +02:00
9 changed files with 199 additions and 5 deletions

3
.gitignore vendored
View File

@@ -1,6 +1,9 @@
config.cfg
lighttpd-fsfe.conf
pywebserver-fsfe.log
fsfe.org
fsfe-website
lighttpd-fsfe*.log
# ignore everything in fsfe.org/ and status/ but keep the folders

22
Dockerfile Normal file
View File

@@ -0,0 +1,22 @@
FROM alpine:3.9
RUN apk add --no-cache \
bash \
bash-completion \
coreutils \
diffutils \
findutils \
inotify-tools \
libxml2-utils \
libxslt \
make \
procps \
python3 \
rsync
RUN mkdir -p /fsfe-local-build/fsfe.org
EXPOSE 8000
CMD sh /fsfe-local-build/docker-cmd.sh

View File

@@ -1,5 +1,49 @@
# FSFE Local Build
# FSFE Website Local Build
This is a collection of scripts and configuration files necessary to build fsfe.org websites locally.
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
* Docker https://docs.docker.com/install/
* Docker Compose https://docs.docker.com/compose/install/
* Patience (for the website build)
### 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.

32
config.cfg.docker Normal file
View File

@@ -0,0 +1,32 @@
### BUILD DIRECTORIES ###
# Cloned Git directory (repository with XHTML source files)
LOC_trunk=/fsfe-local-build/fsfe-website
# Directory in which the result of the build process (html files) will be saved
LOC_out=/fsfe-local-build/fsfe.org
### LOCAL WEBSERVER ###
# Choose your local webserver.
# Default is "python" which is python3's built-in http.server module (SimpleHTTP) that is available on most distributions
# Use "lighttpd" if you want to use the Lighttpd webserver. This has to be configured manually (see guide)
HTTPD=lighttpd
### ADVANCED ###
# Directory of the secondary Git directory with which you made a first full build.
# Avoids having some generated files in your clean trunk.
# Default: Leave empty if you just want to use one Git source directory (recommended)
LOC_trunk_dev=
# Choose on which port the webserver runs. This has no effect for "lighttpd".
HTTPD_port=5080
# If you use other webservers like "lighttpd", this is the path to its config file
# Default: points to a lighttpd config file in the same directory as the script
# Has no effect if you use the "python" webserver
HTTPD_conf=$ROOT/lighttpd-fsfe.conf

28
docker-cmd.sh Executable file
View File

@@ -0,0 +1,28 @@
#!/usr/bin/env bash
########################################################################
# Copyright (C) 2019 Michael Weimann <mweimann@fsfe.org>
########################################################################
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
########################################################################
#
# This script is executed in docker CMD.
#
#######################################################################
# Run the preview server
cd /fsfe-local-build/fsfe.org
python3 -m http.server

12
docker-compose.yml Normal file
View File

@@ -0,0 +1,12 @@
version: '3'
services:
fsfe-local-build:
build: .
image: fsfe/local-build:1.0
container_name: fsfe-local-build
ports:
- 8000:8000
volumes:
- .:/fsfe-local-build

53
docker-setup.sh Executable file
View File

@@ -0,0 +1,53 @@
#!/usr/bin/env bash
########################################################################
# Copyright (C) 2019 Michael Weimann <mweimann@fsfe.org>
########################################################################
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
########################################################################
#
# This script runs the docker dev setup.
#
#######################################################################
echo -e "\e[96m→ Cloning the website repo\e[0m"
git clone git@git.fsfe.org:FSFE/fsfe-website.git
echo ""
echo -e "\e[96m→ Setting up the config file\e[0m"
cp config.cfg.docker config.cfg
echo ""
echo -e "\e[96m→ Linking the look directory\e[0m"
ln -s ../fsfe-website/look fsfe.org/look
echo ""
echo -e "\e[96m→ Starting the container\e[0m"
docker-compose up --build -d
echo ""
echo -e "\e[96m→ Initial full build\e[0m"
echo -e "\e[33m⚠ This may take some hours\e[0m"
docker exec fsfe-local-build \
bash /fsfe-local-build/fsfe-website/build/build_main.sh \
build_into /fsfe-local-build/fsfe.org/ \
--statusdir /fsfe-local-build/status/ \
|| true
echo ""
echo -e "\e[96m→ Stopping the container\e[0m"
docker-compose stop
echo ""

View File

@@ -1,4 +1,4 @@
#!/bin/bash
#!/usr/bin/env bash
########################################################################
# Copyright (C) 2016 Max Mehl <max.mehl@fsfe.org>
########################################################################
@@ -159,8 +159,8 @@ for ((i=1; i <= $numargs; i++)); do
$LOC_trunk/build/build_main.sh process_file $SRC_full > $DST_full
else # just copy file
echo_INFO "File type ($ftype) is detected as not to be built. Just copying it to $DST_full ..."
cp $SRC_full $DST_full
echo_INFO "File type ($ftype) is detected as not to be built. Just linking it to $DST_full ..."
ln -sf $SRC_full $DST_full
fi

View File