Skip to content

Latest commit

 

History

History
173 lines (130 loc) · 6.76 KB

README.md

File metadata and controls

173 lines (130 loc) · 6.76 KB
Raw

blog.iscsc.fr: a blog built with HUGO framework

Table of content:

Deployment

Production

TL;DR

  • create SSL certificates (needed for HTTPS)
  • create the build directory with the right permissions
  • start the nginx web server with a docker command
  • build the website with a docker command
  • enjoy the website!

Create SSL certificates

To set up HTTPS, you will need valid SSL certificates. If you deploy the app for the first time, follow these instructions:

  • Comment or delete the whole server section about port 443 in the nginx.conf file.
- server {
- listen 443 default_server ssl http2;
- ...
- }

This step is required because the certificates don't exist yet, so they cannot be loaded in the nginx configuration.
The website has to run with http to respond to certbot challenge

  • (Re)Start the blog container:
docker compose up --detach --build blog
  • Create the certificates with the certbot container:
docker compose run --rm certbot certonly --webroot --webroot-path /var/www/certbot/ -d yourdomainname.com
  • Restore the original nginx.conf (with git restore nginx.conf for example)
  • Stop the blog container:
docker compose down

The certificates should have been generated in certbot/conf/live/yourdomainname.com/.

Renew SSL certificates

If you just want to renew existing certificates you should use the designed script:

./scripts/renewssl.sh

Note that this script uses hardcoded absolute path designed for the iScsc VPS

If you want to here are the detailed steps:

# List existing certificates
docker compose run certbot certificates
# Renew certificates
docker compose run --rm certbot renew
# Restart blog
docker compose stop blog
docker compose up --detach blog

Deploy the website itself

  • Create the ./build/blog/prod and ./build/blog/dev directory, they must be writable by the user/group that will write to it: you, builder target, CI user...
mkdir -p build/blog/prod
mkdir -p build/blog/dev
sudo chown -R <user>:<group> build/blog
sudo chmod -R g+w build/blog

you should check first the consistency of the server name (iscsc.fr/localhost) in those files: nginx.conf, docker-compose.yml, workflows in .github/workflows ...

  • Start the nginx container to serve requests:
docker compose build blog
docker compose up --detach blog

Note:
Before the next step make sure that when cloning the repository you also fetched the git submodule!

  • Build the static website, ./build/blog/prod is a volume shared with both containers so building the website will automatically "update" it for nginx.
docker compose up builder

After doing this last step, files might have been created with the wrong permissions/owners (it depends if you use the setgid bit, modify the builder container, and even what YOU consider being the right permissions/owners). If needed you might re-do what we've previously:

sudo chown -R <user>:<group> build/blog
sudo chmod -R g+w build/blog

Automatic deployment

The repository contains a GitHub Action which automatically:

  1. builds the website: allow to check that nothing is broken, publish an artifact which can be downloaded or reused
  2. IF push to main AND src/* modified, deploys the build: download the artifact, create and setup ssh key, send build to server through ssh (with rsync)

This requires a server ready to receive the build (to be useful, it must be running an http server serving this build), and to set some mandatory GitHub secrets (see build_and_deploy.yml):

  • SSH_KNOWN_HOSTS
  • PRIVATE_SSH_KEY
  • CI_USER_NAME
  • REPO_PATH_ON_REMOTE

Sources I used:

Development

it requires hugo installed locally!

cd src
hugo server --buildFuture --buildDrafts --disableFastRender
  • --buildFuture is also used in production, --buildDrafts only in development
  • --buildExpired can be used too
  • --disableFastRender will avoid you headaches trying to debug what is really a HUGO cache problem

This will build sources and start a basic development server that listens on http://localhost:1313.

The HUGO server automatically watches sources, so if you create a new post while it's running it will automatically rebuild the website and serve the new post.

Features

  • articles about various subjects around computer science: security, development, network, operating systems...
  • numerous useful resources, tools, guides, tutorials
  • an event page to gather all relevant information about CTFs, conferences, forums...
  • everyone can contribute through GitHub PRs, see our tutorial
  • renders emojis
  • automatic build and deployment of the website on every merge

Incoming

Incoming features:

Contributing

See CONTRIBUTING.md for a complete guide to contributing and guidelines.

To contribute to the website with new features, improvements or UX/UI changes feel free to open an Issue.
You can fix bugs or typos by submiting a Pull Request.

To add or update content gathered on this website give a look at our tutorial for new contributors 🙂
...or directly open a Pull Request if you already know how these things work 😉

Content is placed under ./src/content.