Gauguin (pronounced /หษกoสษกรฆฬ/) is an high performances Golang server that generates dynamic opengraph images at runtime.
Sponsors
Gauguin in 6 easy steps
- Create a configuration file called
gauguin.yaml
version: 0.0.1
routes:
- path: /articles/opengraph
params:
- title
- author
- imgUrl
size: 1200x630
template: ./templates/article.tmpl
- path: /author/opengraph
params:
- username
- imgUrl
size: 1200x630
template: ./templates/user.tmpl- For each route, create a Golang
tmplfile (named the same way you named it inside the configuration file):
<!DOCTYPE html>
<html>
<head>
<style>
body {
margin: 0;
font-family: Arial;
color: #fff;
}
.article-template {
display: flex;
justify-content: center;
align-items: center;
flex-direction: column;
width: 1200px;
height: 630px;
background: #001f1c;
}
h1 {
margin: 0;
font-size: 32px;
}
img {
width: 200px;
height: 200px;
object-fit: cover;
border-radius: 15px;
margin-bottom: 25px;
}
</style>
</head>
<body>
<div class="article-template">
<img src="{{.imgUrl}}" />
<h1>{{.title}}</h1>
<p>Written by <b>{{.author}}</b></p>
</div>
</body>
</html>- Copy this docker-compose file locally and run
docker-compose up -d - Choose a title, an author and an image for your article opengraph image. Pass them via querystrng to the route you defined in your configuration file.
- Go to
http://localhost:5491/articles/opengraph?author=Bojack%20Horseman&title=A%20Post%20About%20my%20Garden&imgUrl=https%3A%2F%2Fimages.unsplash.com%2Fphoto-1525498128493-380d1990a112%3Fixlib%3Drb-1.2.1%26ixid%3DeyJhcHBfaWQiOjEyMDd9%26auto%3Dformat%26fit%3Dcrop%26w%3D300%26q%3D80 - Admire the following image:
Documentation
I'm currently writing more documentation, it will be available on Gitbook: http://micheleriva.gitbook.io/gauguin
Env Variables
PORT=<number> # HTTPS Port
DOCKERIZED=<boolean> # Set to true if running Gauguin in Docker
CHROME_URL=<string> # Optional, the URL of the Chrome REST Debugging APIs License
Gauguin is distributed under the GPLv3 open source license.