https://github.com/peterroe/ogimg
A simple OG image capture service.
https://github.com/peterroe/ogimg
Last synced: 11 months ago
JSON representation
A simple OG image capture service.
- Host: GitHub
- URL: https://github.com/peterroe/ogimg
- Owner: peterroe
- License: mit
- Created: 2024-11-16T15:33:57.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-29T16:12:10.000Z (over 1 year ago)
- Last Synced: 2024-11-29T17:23:11.329Z (over 1 year ago)
- Language: Go
- Size: 96.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Roadmap: roadmap.md
Awesome Lists containing this project
README
## OGIMG
A simple OG image capture service(cache with redis).
## Usage
**Basic usage**
`https://ogimg.peterroe.me?url=`
A few examples:
* GitHub: https://ogimg.peterroe.me?url=https%3A%2F%2Fgithub.com
* YouTube: https://ogimg.peterroe.me/?url=https%3A%2F%2Fyoutube.com
* Instagram: https://ogimg.peterroe.me/?url=https%3A%2F%2Finstagram.com
**Description**
`https://ogimg.peterroe.me/desc?url=`
Return the description of the website. Include `title`, `description` and `logo`.
A few examples:
* GitHub: https://ogimg.peterroe.me/desc?url=https%3A%2F%2Fgithub.com
* YouTube: https://ogimg.peterroe.me/desc?url=https%3A%2F%2Fyoutube.com
* Instagram: https://ogimg.peterroe.me/desc?url=https%3A%2F%2Finstagram.com
## Self-hosted
Easy to self-host, just run the following command:
```bash
$ wget -O docker-compose.yml https://raw.githubusercontent.com/peterroe/ogimg/main/docker-compose.yml
$ docker-compose up -d
```
Then visit http://localhost:8888?url=https%3A%2F%2Fgithub.com