summaryrefslogtreecommitdiff
path: root/Makefile.example
blob: 93212ed484856bd35d2c15b096eefe13aa6592b8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
PY?=python3
PELICAN?=pelican
PELICANOPTS=

BASEDIR=$(CURDIR)
INPUTDIR=$(BASEDIR)/content
OUTPUTDIR=$(BASEDIR)/output
CONFFILE=$(BASEDIR)/pelicanconf.py
PUBLISHCONF=$(BASEDIR)/publishconf.py

FTP_HOST=********
FTP_USER=********
FTP_TARGET_DIR=********

SSH_HOST=localhost
SSH_PORT=22
SSH_USER=root
SSH_TARGET_DIR=/var/www

DEBUG ?= 0
ifeq ($(DEBUG), 1)
	PELICANOPTS += -D
endif

RELATIVE ?= 0
ifeq ($(RELATIVE), 1)
	PELICANOPTS += --relative-urls
endif

help:
	@echo 'Makefile for a pelican Web site                                                '
	@echo '                                                                               '
	@echo 'Usage:                                                                         '
	@echo '   make html                           (re)generate the web site               '
	@echo '   make clean                          remove the generated files              '
	@echo '   make regenerate                     regenerate files upon modification      '
	@echo '   make hashover_backup                backup of hashover                      '
	@echo '   make publish                        generate using production settings      '
	@echo '   make serve [PORT=8000]              serve site at http://localhost:8000     '
	@echo '   make serve-global [SERVER=0.0.0.0]  serve (as root) to $(SERVER):80         '
	@echo '   make devserver [PORT=8000]          serve and regenerate together           '
	@echo '   make ssh_upload                     upload the web site via SSH             '
	@echo '   make rsync_upload                   upload the web site via rsync+ssh       '
	@echo '   make ftp_upload                     upload the web site via FTP             '
	@echo '   make validate                       validate the web site via html5validator'
	@echo '                                                                               '
	@echo 'Set the DEBUG variable to 1 to enable debugging, e.g. make DEBUG=1 html        '
	@echo 'Set the RELATIVE variable to 1 to enable relative urls                         '
	@echo '                                                                               '

generate:
	$(PELICAN) $(INPUTDIR) -o $(OUTPUTDIR) -s $(CONFFILE) $(PELICANOPTS)

html: clean generate vendor

clean:
	[ ! -d $(OUTPUTDIR) ] || rm -rf $(OUTPUTDIR)

regenerate:
	$(PELICAN) -r $(INPUTDIR) -o $(OUTPUTDIR) -s $(CONFFILE) $(PELICANOPTS)

serve:
ifdef PORT
	$(PELICAN) -l $(INPUTDIR) -o $(OUTPUTDIR) -s $(CONFFILE) $(PELICANOPTS) -p $(PORT)
else
	$(PELICAN) -l $(INPUTDIR) -o $(OUTPUTDIR) -s $(CONFFILE) $(PELICANOPTS)
endif

serve-global:
ifdef SERVER
	$(PELICAN) -l $(INPUTDIR) -o $(OUTPUTDIR) -s $(CONFFILE) $(PELICANOPTS) -p $(PORT) -b $(SERVER)
else
	$(PELICAN) -l $(INPUTDIR) -o $(OUTPUTDIR) -s $(CONFFILE) $(PELICANOPTS) -p $(PORT) -b 0.0.0.0
endif

devserver:
ifdef PORT
	$(PELICAN) -lr $(INPUTDIR) -o $(OUTPUTDIR) -s $(CONFFILE) $(PELICANOPTS) -p $(PORT)
else
	$(PELICAN) -lr $(INPUTDIR) -o $(OUTPUTDIR) -s $(CONFFILE) $(PELICANOPTS)
endif

vendor:
	@bash $(BASEDIR)/scripts/vendor.sh

publishconf:
	$(PELICAN) $(INPUTDIR) -o $(OUTPUTDIR) -s $(PUBLISHCONF) $(PELICANOPTS)

publish: publishconf vendor

ssh_upload: publish
	scp -P $(SSH_PORT) -r $(OUTPUTDIR)/* $(SSH_USER)@$(SSH_HOST):$(SSH_TARGET_DIR)

hashover_backup:
	rsync -rvzc $(SSH_USER)@$(SSH_HOST):$(SSH_TARGET_DIR)/hashover-next $(BASEDIR)/local.env/

rsync_upload: publish
	rsync -e "ssh -p $(SSH_PORT)" -P -rvzc --delete $(OUTPUTDIR)/ $(SSH_USER)@$(SSH_HOST):$(SSH_TARGET_DIR)/

ftp_upload: publish
	lftp ftp://$(FTP_USER)@$(FTP_HOST) -e "mirror -R $(OUTPUTDIR) $(FTP_TARGET_DIR) ; quit"

validate: publishconf
	html5validator --root $(OUTPUTDIR) || html5validator -l --root $(OUTPUTDIR)

.PHONY: html help clean regenerate serve serve-global devserver publish ssh_upload rsync_upload ftp_upload