Example of served JSON:
{ "api": "0.13", "space": "FUZ", "logo": "https://fuz.re/WWW.FUZ.RE_fichiers/5c02b2a84373a.png", "url": "https://fuz.re/", "location": { "address": "11-15 rue de la Réunion, Paris 75020, FRANCE", "lon": 2.40308, "lat": 48.85343 }, "contact": { "email": "", "irc": "", "ml": "fuz@fuz.re", "twitter": "@fuz_re", "matrix": "https://matrix.to/#/#fuz_general:matrix.fuz.re" }, "issue_report_channels": [ "ml", "twitter" ], "state": { "icon": { "open": "https://presence.fuz.re/img", "closed": "https://presence.fuz.re/img" }, "open": false, "message": "open under conditions: https://wiki.fuz.re/doku.php?id=map", "lastchange": 1602942506 }, "projects": [ "https://wiki.fuz.re/doku.php?id=projets:fuz:start" ] }
On sonic, following what was also done during Online Fuzturday #1 for the presence button API.
sudo adduser spaceapi sudo passwd -d spaceapi # just in case cat << EOF | sudo tee /etc/systemd/system/spaceapi.service >/dev/null [Unit] Description=SpaceAPI After=network-online.target [Service] Type=simple User=spaceapi Group=spaceapi WorkingDirectory=/home/spaceapi/ Environment="PORT=3001" Environment="PRESENCEAPI=https://presence.fuz.re/api" Environment='SPACEAPI={"api":"0.13","space":"FUZ","logo":"https://fuz.re/WWW.FUZ.RE_fichiers/5c02b2a84373a.png","url":"https://fuz.re/","location":{"address":"11-15 rue dela Réunion, Paris 75020, FRANCE","lon":2.40308,"lat":48.85343},"contact":{"email":"","irc":"","ml":"fuz@fuz.re","twitter":"@fuz_re","matrix":"https://matrix.to/#/#fuz_general:matrix.fuz.re"},"issue_report_channels":["ml","twitter"],"state":{"icon":{"open":"https://presence.fuz.re/img","closed":"https://presence.fuz.re/img"},"message":"open under conditions: https://wiki.fuz.re/doku.php?id=map"},"projects":["https://wiki.fuz.re/doku.php?id=projets:fuz:start"]}' ExecStart=/home/spaceapi/spaceapi Restart=on-failure TimeoutStopSec=300 [Install] WantedBy=multi-user.target EOF sudo systemctl enable --now spaceapi.service curl localhost:3001 sudo mkdir -p /var/www/fuz.re/spaceapi/site sudo certbot certonly --webroot -w /var/www/fuz.re/spaceapi/site -d spaceapi.fuz.re --deploy-hook '/usr/sbin/lighttpd -t -f /etc/lighttpd/lighttpd.conf && service lighttpd reload'
No need to mess with anything else, certbot is already called every ~12 hours (see /etc/cron.d/certbot) as it was installed from Debian repos https://certbot.eff.org/docs/using.html#automated-renewals and lighttpd is reloaded after a successful renewal. This config is persistent in /etc/letsencrypt/renewal/spaceapi.fuz.re.conf (automatically created by the previous certbot command), see its doc here.
(To note: the certbot command was originally sudo certbot certonly --webroot -w /var/www/fuz.re/spaceapi/site -d spaceapi.fuz.re --deploy-hook 'cat "$RENEWED_LINEAGE/privkey.pem" "$RENEWED_LINEAGE/cert.pem" > "$RENEWED_LINEAGE/combined.pem"' --post-hook '/usr/sbin/lighttpd -t -f /etc/lighttpd/lighttpd.conf && service lighttpd reload' but combining certs is not useful anymore in lighttpd, see certbot/certbot#94)
Corresponding lighttpd vhost config
$HTTP["host"] == "spaceapi.fuz.re" { # added by Lomanic 20201017
$HTTP["scheme"] == "http" {
server.document-root = "/var/www/fuz.re/spaceapi/site"
$HTTP["url"] !~ "^/.well-known/acme-challenge/" {
url.redirect = (".*" => "https://${url.authority}${url.path}${qsa}")
}
}
$SERVER["socket"] == ":443" {
ssl.engine = "enable"
proxy.server = ( "" => (("host" => "127.0.0.1", "port" => 3001)) )
ssl.pemfile = "/etc/letsencrypt/live/spaceapi.fuz.re/fullchain.pem"
ssl.privkey = "/etc/letsencrypt/live/spaceapi.fuz.re/privkey.pem"
}
}
To be run with
SPACEAPI='{"api":"0.13","space":"FUZ","logo":"https://fuz.re/WWW.FUZ.RE_fichiers/5c02b2a84373a.png","url":"https://fuz.re/","location":{"address":"11-15 rue dela Réunion, Paris 75020, FRANCE","lon":2.40308,"lat":48.85343},"contact":{"email":"","irc":"","ml":"fuz@fuz.re","twitter":"@fuz_re","matrix":"https://matrix.to/#/#fuz_general:matrix.fuz.re"},"issue_report_channels":["ml","twitter"],"state":{"icon":{"open":"https://presence.fuz.re/img","closed":"https://presence.fuz.re/img"},"message":"open under conditions: https://wiki.fuz.re/doku.php?id=map"},"projects":["https://wiki.fuz.re/doku.php?id=projets:fuz:start"]}' PRESENCEAPI=https://presence.fuz.re/api go run main.go
Functional and valid (curl -X POST -H "Content-Type: application/json" https://validator.spaceapi.io/v2/validateJSON -d "$(curl -s localhost:8080)") API in Go, to be published on Github
Pushed to GH, made the app fully configurable via env variable, deployed on sonic by following what I (Lomanic) did during the Online Fuzturday #1. Implemented certbot properly for this domain (see Deployment).
Pull request opened https://github.com/SpaceApi/directory/pull/157 and merged! The hackerspace is now on https://api.spaceapi.io/!
Redeployed on the new “octo” server, following the previous documentation but with the following configuration in /etc/systemd/system/spaceapi.service
Environment='SPACEAPI={"api":"0.14","api_compatibility":["14"],"space":"FUZ","logo":"https://wiki.fuz.re/lib/exe/fetch.php?media=wiki:logo.png","url":"https://fuz.re/","location":{"address":"57-59 Rue Étienne Marcel, 93100 Montreuil, FRANCE","lon":2.430790,"lat":48.858110},"contact":{"email":"","irc":"","ml":"fuz@fuz.re","twitter":"@fuz_re","matrix":"https://matrix.to/#/#fuz_general:matrix.fuz.re"},"issue_report_channels":["ml","twitter"],"state":{"icon":{"open":"https://presence.fuz.re/img","closed":"https://presence.fuz.re/img"},"message":"we are still moving in"},"projects":["https://wiki.fuz.re/doku.php?id=projets:fuz:start"]}'
With the following branch, making our endpoint up to the 0.14 spec and not completely broken when there's no (like currently) presence API available