https://github.com/adunkman/dunkman.me
This repository holds the application code and infrastructure for my personal site and blog.
https://github.com/adunkman/dunkman.me
circleci docker hugo
Last synced: 3 months ago
JSON representation
This repository holds the application code and infrastructure for my personal site and blog.
- Host: GitHub
- URL: https://github.com/adunkman/dunkman.me
- Owner: adunkman
- License: mit
- Created: 2013-08-01T13:08:35.000Z (almost 12 years ago)
- Default Branch: main
- Last Pushed: 2025-04-07T17:15:56.000Z (3 months ago)
- Last Synced: 2025-04-11T01:12:56.041Z (3 months ago)
- Topics: circleci, docker, hugo
- Language: SCSS
- Homepage: https://www.dunkman.me
- Size: 57.3 MB
- Stars: 3
- Watchers: 2
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Security: SECURITY.md
Awesome Lists containing this project
README
This repository holds the application code and infrastructure for [dunkman.me](https://www.dunkman.me).
## Architecture
### Runtime environment
The site is a static site that runs on [Amazon Web Services (AWS)](https://aws.amazon.com/).
- The files are stored in an [S3 bucket](https://aws.amazon.com/s3/) configured for [static web hosting](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html).
- They are presented to you via [CloudFront](https://aws.amazon.com/cloudfront/), which uses a TLS certificate for https generated and auto-renewed by [AWS Certificate Manager](https://aws.amazon.com/certificate-manager/).
- DNS which points the domain to the appropriate CloudFront distribution is managed by [Route 53](https://aws.amazon.com/route53/).
The domain is purchased through [Namecheap](https://www.namecheap.com/).
- Namecheap’s nameservers are overridden manually to point to Route53’s nameservers as configured in this repository.
### Deployment process
- The site is built with [Hugo](https://gohugo.io/).
- All infrastructure changes are automated with [Terraform](https://www.terraform.io/).
- On code changes [GitHub Actions](https://github.com/features/actions) uses [Docker](https://www.docker.com/) to apply any infrastructure changes, build the site, and upload it.
## Running locally
To get started in development, you’ll need [Docker](https://www.docker.com/) installed. Then, run the following command in the project directory after it’s been cloned:
```bash
make start
```
- The website will be accessible at [localhost:1313](http://localhost:1313/).
- The site will live reload on updates to the source files.
To quit the command, hit Ctrl+C.
### Running without Docker
Running the application without Docker is not recommended. If you must, review the [app Dockerfile](app/Dockerfile) to see what dependencies are needed, manually install those specific versions locally, and run the application as the Dockerfile describes.
### Encrypted pages
This site includes a number of pages which are protected behind a "friends and family" passcode. The pages are [present in this repository](./app/content/christmas-letters/), encrypted using [SOPS](https://github.com/getsops/sops).
The site will build without these pages by default. To build the protected pages locally, decrypt their contents using the below command and re-run the build.
```bash
make decrypt
```
SOPS uses an encryption key configured through Terraform, specified through the environmental variable `SOPS_KMS_ARN`. To get the value of this variable, run `docker compose run terraform output sops_kms_arn`.
During deploy, these pages are decrypted, built, deployed, and protected by a [simple authenticator](./terraform/auth.js) [AWS Lambda](https://aws.amazon.com/lambda/) function.
## Deploying
The site deploys automatically in GitHub Actions. To preview changes made by Terraform, use Docker.
```bash
make terraform-plan
```
**Note:** This command requires access to the application’s AWS account. Credentials are configured through `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, and `AWS_DEFAULT_REGION` environment variables.
To make things simpler for routine use, these variables are also read out of a `.env` file in the project root directory (which is git ignored) [automatically by docker-compose](https://docs.docker.com/compose/env-file/).
```bash
AWS_ACCESS_KEY_ID=[Your key]
AWS_SECRET_ACCESS_KEY=[Your secret]
AWS_DEFAULT_REGION=us-east-1
```
## Rebuilding the Docker images
Rebuild the Docker images when versions of installed dependencies change:
```bash
make docker-rebuild-[image]
```
To see available commands, run `make` without any arguments.
## Contributing
Yes please! I’d love to have your contributions to this project — including typo fixes, infrastructure changes, and everything in-between.
- For larger changes, feel free to [open an issue](https://github.com/adunkman/dunkman.me/issues/new/choose) to discuss the changes if you’d like to discuss before investing time in it.
Continue reading in [CONTRIBUTING](CONTRIBUTING.md).