google-webfonts-helper README

The project's README from github.com/majodev/google-webfonts-helper. As one markdown file: README.md.

google-webfonts-helper Uptime Robot status Uptime Robot ratio (30 days) GitHub Sponsors

A Hassle-Free Way to Self-Host Google Fonts

✅ https://gwfh.mranftl.com

Current Sponsors

Help me keep this service alive by sponsoring me. Thank you. ❤️

ToC

Give it a try: https://gwfh.mranftl.com

This service might be handy if you want to host a specific Google font on your own server:

pic running

Running gwfh on your own server

I provide prebuilt Docker images via GitHub Packages. You can use them as follows:

# See https://developers.google.com/fonts/docs/developer_api for creating your own API-Key.

docker run -e GOOGLE_FONTS_API_KEY=<YOUR-API-KEY> -p 8080:8080 ghcr.io/majodev/google-webfonts-helper:<TAG>
# Express server listening on 8080, in production mode

Development

Quickstart

Do this to setup a development environment:

# Ensure to set the GOOGLE_FONTS_API_KEY env var inside your own gitignored .env file
# See https://developers.google.com/fonts/docs/developer_api for creating your own API-Key.
echo "GOOGLE_FONTS_API_KEY=<YOUR-API-KEY>" > .env

# Start up the development docker container (multistage Dockerfile, stage 1 only)
./docker-helper.sh --up
# [+] Running 1/0
#  ⠿ Container gwfh-service-1  Running
# node@3b506a285f7f:/app$

# within this development container:
node$ yarn --pure-lockfile
node$ ./node_modules/.bin/bower install

# start development server
node$ grunt serve
# [...]
# Express server listening on 9000, in development mode

# The application is now available at http://127.0.0.1:9000 (watching for code changes)

# start production server (same command as within the final docker multistage build)
node$ grunt build
node$ NODE_ENV=production node dist/server/app.js
# Express server listening on 8080, in production mode

Production build

If you want to build and run your own production container locally:

# Build the production docker container (final stage)
docker build . -t <your-image-tag>

# Run it (if you have previously started the development container, halt it!)
./docker-helper.sh --halt
docker run -e GOOGLE_FONTS_API_KEY=<YOUR-API-KEY> -p 8080:8080 <your-image-tag>
# Express server listening on 8080, in production mode

To mitigate security issues especially with the projects' deprecated dependencies, the final image is based on a minimal container image. It runs rootless and has no development dependencies.

JSON API

The API is public, feel free to use it directly (rate-limits may apply).

GET /api/fonts

Returns a list of all fonts, sorted by popularity. E.g. curl https://gwfh.mranftl.com/api/fonts:

[{
  "id": "open-sans",
  "family": "Open Sans",
  "variants": ["300", "300italic", "regular", "italic", "600", "600italic", "700", "700italic", "800", "800italic"],
  "subsets": ["devanagari", "greek", "latin", "cyrillic-ext", "cyrillic", "greek-ext", "vietnamese", "latin-ext"],
  "category": "sans-serif",
  "version": "v10",
  "lastModified": "2014-10-17",
  "popularity": 1,
  "defSubset": "latin",
  "defVariant": "regular"
} [...]
]

GET /api/fonts/[id]?subsets=latin,latin-ext

Returns a font with urls to the actual font files google's servers. subsets is optional (will serve the defSubset if unspecified). E.g. curl "https://gwfh.mranftl.com/api/fonts/modern-antiqua?subsets=latin,latin-ext" (the double quotes are important as query parameters may else be stripped!):

{
  "id": "modern-antiqua",
  "family": "Modern Antiqua",
  "variants": [{
    "id": "regular",
    "eot": "https://fonts.gstatic.com/s/modernantiqua/v6/8qX_tr6Xzy4t9fvZDXPkhzThM-TJeMvVB0dIsYy4U7E.eot",
    "fontFamily": "'Modern Antiqua'",
    "fontStyle": "normal",
    "fontWeight": "400",
    "woff": "https://fonts.gstatic.com/s/modernantiqua/v6/8qX_tr6Xzy4t9fvZDXPkh1bbnkJREviNM815YSrb1io.woff",
    "local": ["Modern Antiqua Regular", "ModernAntiqua-Regular"],
    "ttf": "https://fonts.gstatic.com/s/modernantiqua/v6/8qX_tr6Xzy4t9fvZDXPkhxr_S_FdaWWVbb1LgBbjq4o.ttf",
    "svg": "https://fonts.gstatic.com/l/font?kit=8qX_tr6Xzy4t9fvZDXPkh0sAoW0rAsWAgyWthbXBUKs#ModernAntiqua",
    "woff2": "https://fonts.gstatic.com/s/modernantiqua/v6/8qX_tr6Xzy4t9fvZDXPkh08GHjg64nS_BBLu6wRo0k8.woff2"
  }],
  "subsets": ["latin", "latin-ext"],
  "category": "display",
  "version": "v6",
  "lastModified": "2014-08-28",
  "popularity": 522,
  "defSubset": "latin",
  "defVariant": "regular",
  "subsetMap": {
    "latin": true,
    "latin-ext": true
  },
  "storeID": "latin-ext_latin"
}

GET /api/fonts/[id]?download=zip&subsets=latin&formats=woff,woff2&variants=regular

Download a zipped archive with all .eot, .woff, .woff2, .svg, .ttf files of a specified font. The query parameters formats and variants are optional (includes everything if no filtering is applied). is E.g. curl -o fontfiles.zip "https://gwfh.mranftl.com/api/fonts/lato?download=zip&subsets=latin,latin-ext&variants=regular,700&formats=woff" (the double quotes are important as query parameters may else be stripped!)

History

2025:

2024:

2023:

2022:

This service was mostly on life-support, most of its code and dependencies can be considered deprecated. The current docker image wrapping [email protected] runs rootless and is hopefully enough to keep the bandits out. API attack surface should be minimal anyways.

2014:

This service was originally a prototype I've created to get familiar with Angular and Express. All magic by generator-angular-fullstack. See my note here.

Idea originally by Clemens Lang who created an awesome bash script to download Google fonts in all formats.

License

(c) Mario Ranftl MIT License

Google Fonts Open Source Font Attribution

google-webfonts-helper (majodev/google-webfonts-helper)

Searching Database…

13.1K ·GitHub
Google-webfonts-helper
Что это?google-webfonts-helper — это самостоятельно размещаемый сервис, который позволяет скачивать файлы шрифтов Google (eot, ttf, svg, woff, woff2) и готовые фрагменты CSS, чтобы отдавать шрифты со своего сервера, а не с CDN Google.
Это веб-приложение, которым я пользуюсь напрямую, или сервер, который я запускаю сам?Это веб-сервер/приложение с JSON API: можно либо пользоваться публично размещённым экземпляром, либо запустить собственную копию через Docker, чтобы генерировать файлы шрифтов и CSS.
Как запустить собственный экземпляр?Проект предоставляет готовые Docker-образы через GitHub Packages, которые можно сразу загрузить и запустить, либо можно настроить локальную среду разработки с помощью входящих в проект скриптов (ts-node, grunt build/serve).
Что нужно для сборки или локального запуска?Node.js (продакшен-образ работает на node:22) и стандартные npm-зависимости из package.json (express, axios, jszip и др.) для среды разработки; Docker нужен, если вы хотите просто запустить готовый образ.
Можно ли пользоваться этим без собственного хостинга?Да, публичный API на размещённом экземпляре можно вызывать напрямую и бесплатно, хотя могут действовать ограничения по частоте запросов.
Как получить файлы конкретного шрифта через API?GET /api/fonts/[id]?subsets=latin,latin-ext возвращает ссылки на сами файлы шрифтов; также можно скачать zip-архив с помощью GET /api/fonts/[id]?download=zip&subsets=latin&formats=woff,woff2&variants=regular.
Как получить список всех доступных шрифтов?GET /api/fonts возвращает все шрифты, отсортированные по популярности.
Откуда взялась идея этого инструмента?Он начинался в 2014 году как прототип для изучения Angular и Express и был вдохновлён bash-скриптом Клеменса Ланга для загрузки шрифтов Google во всех форматах.
Безопасен ли продакшен-образ Docker?Да, итоговый образ работает без прав root, построен на минимальной базе контейнера и не содержит зависимостей для разработки, чтобы уменьшить поверхность атаки.
What are similar projects?3d-asset-server, kutt, habitica, rankme.fast, Instatic, trpc, linksift, parse-server
Which topics is it in?fonts, static-site-generator, express, downloader, css, rest-api, api, server, nodejs, docker, typescript, self-hosted
Creator
majodev
Size
0.8 MB
Stars
13.1K
Updated
CommitOct 01Releasev1.7.2Oct 01
Age
11y
Commits · 90 Days