Generate static HTML files for custom ghost hosting and publish them on AWS S3 as static website. To host the static blog site under a path /blog (https://yourdomain.com/blog), the ghost needs to be hosted with the same path like https://content.yourdomain.com/blog.

If your blog is hosted under https://content.yourdomain.com and you want to host the static site under https://yourdomain.com/blog, this is not possible. Same applies for the other way around.

You can also replace certain text from the generated static files by passing the following arguments custom_replace_keys and custom_replace_values. For more details, refer Inputs and Example usage section. It doesn't support the multiline replacement as of now.

Additionally, it also provides the functionality to upload the static HTML files to S3 bucket. To access these files publicly, make it as a public bucket and enable static website hosting.

Required Ghost hosted URL endpoint. (ex: https://content.yourdomain.com/blog)

Required URL endpoint where static files needs to be hosted. (ex: https://yourdomain.com/blog)

Optional Comma separated list of items that needs to be replaced from the items in custom_replace_values at the same index.

Optional Comma separated associated values for the item in custom_replace_keys.

Optional ld+json data for the root index file.

Optional S3 bucket name to upload static HTML files.

Optional AWS access key Id.

Optional AWS secret access key.

Optional AWS region.

name: Generate Static HTML files
uses: PLG-Works/ghost-static-site-generator@v1
with:
  ghost_hosted_url: "https://content.yourdomain.com/blog"
  ghost_static_host_url: "https://yourdomain.com/blog"
  s3_bucket_name: "your-s3-bucket-name"
  aws_access_key_id: ${{ secrets.AWS_ACCESS_KEY_ID }} # Accessing it from the gihub secrets
  aws_secret_access_key: ${{ secrets.AWS_SECRET_ACCESS_KEY }} # Accessing it from the gihub secrets
  aws_region: "us-east-1"
  custom_replace_keys: "key_1, key_2, key_n"
  custom_replace_values: "value_1, value_2, value_n"

docker build -t ghost-ssg .
docker run -it --env-file .env.sample ghost-ssg

Make appropriate changes to the .env.sample file. To Persist the generated HTML files in local (host system) directory, use bind mount option with docker run command, For example: -v /path/to/local/dir:/src/content