pg2hugo

PG2HUGO

This project was created to attempt provide a way to hugo generate static sites querying a postgres database.

Building

Execute make or go build ./cmd/pg2hugo to build the program.

Preparing

You need two tables (or views) on your database to use with pg2hugo. Follow example below:

Database views

I had these tables:

CREATE TABLE IF NOT EXISTS posts (
    id SERIAL PRIMARY KEY,
    title VARCHAR NOT NULL,
    body TEXT,
    date TIMESTAMPTZ(0) DEFAULT CURRENT_TIMESTAMP,
    "publishedAt" TIMESTAMPTZ(0) DEFAULT CURRENT_TIMESTAMP,
    "expiredAt" TIMESTAMPTZ(0),
    "updatedAt" TIMESTAMPTZ(0) DEFAULT CURRENT_TIMESTAMP,
    author VARCHAR,
    tags JSONB,
    draft boolean NOT NULL DEFAULT false
);
CREATE TABLE IF NOT EXISTS attachs (
    id SERIAL PRIMARY KEY,
    filename VARCHAR NOT NULL UNIQUE,
    title VARCHAR,
    "sortPosition" SMALLINT,
    source VARCHAR,
    "updatedAt" TIMESTAMPTZ(0) DEFAULT CURRENT_TIMESTAMP,
    bs BYTEA,
    post_id INT NOT NULL
        REFERENCES posts(id)
        ON UPDATE RESTRICT
        ON DELETE RESTRICT
);

I created a view "contents" returning these fields:

path, title, body, date, publishdate, expirydate, lastmod, author, tags, draft

And a view "resources" returning these fields:

parent, title, params, lastmod, bs, length

Example:

CREATE OR REPLACE VIEW contents AS
    SELECT
        posts.id::VARCHAR AS path,
        title,
        body,
        date,
        "publishedAt" AS publishdate,
        "expiredAt" AS expirydate,
        "updatedAt" AS lastmod,
        author,
        tags,
        draft
    FROM posts
    ORDER BY id;
CREATE OR REPLACE VIEW resources AS
    SELECT
        filename AS src,
        post_id::VARCHAR AS parent,
        title,
        CASE source
            WHEN '' THEN NULL
            ELSE (('{"source": "' || source) || '"}')::JSONB
        END AS params,
        "updatedAt" AS lastmod,
        bs,
        LENGTH(bs) AS length
   FROM attachs
   ORDER BY "sortPosition", src;

Configuring

To run pg2hugo you need to define some environment variables:

• DSN - a connection string to postgres
• PRELOAD - a boolean to set preloading binary content of resources on starting application (optional default false)

If you prefer, copy env_example and rename to .env. Save this file on same folder that will run pg2hugo. You also can use -p to set preloading.

Running

Run ./pg2hugo mountpoint. Where "mountpoint" is a content folder (or subfolder) of your site project that will be built with hugo.

Credits

This project is based on pgfs and make intensive use of libfuse through of lib bazil.org/fuse.

Thanks to @crgimenes for the idea and incentive.