{"id":29480997,"url":"https://github.com/tamper000/caching-proxy","last_synced_at":"2025-07-14T23:55:15.976Z","repository":{"id":304379578,"uuid":"1016187010","full_name":"tamper000/caching-proxy","owner":"tamper000","description":"Simple caching server to reduce the load on your APIs","archived":false,"fork":false,"pushed_at":"2025-07-12T17:19:21.000Z","size":18,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-07-12T19:23:57.813Z","etag":null,"topics":["cache","caching-proxy","go","golang"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tamper000.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-07-08T16:06:50.000Z","updated_at":"2025-07-12T17:19:24.000Z","dependencies_parsed_at":"2025-07-12T19:37:07.395Z","dependency_job_id":null,"html_url":"https://github.com/tamper000/caching-proxy","commit_stats":null,"previous_names":["tamper000/caching-proxy"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/tamper000/caching-proxy","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tamper000%2Fcaching-proxy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tamper000%2Fcaching-proxy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tamper000%2Fcaching-proxy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tamper000%2Fcaching-proxy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tamper000","download_url":"https://codeload.github.com/tamper000/caching-proxy/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tamper000%2Fcaching-proxy/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265129606,"owners_count":23715674,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cache","caching-proxy","go","golang"],"created_at":"2025-07-14T23:55:14.263Z","updated_at":"2025-07-14T23:55:15.969Z","avatar_url":"https://github.com/tamper000.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🧠 Caching Proxy\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n\n[English](README-en.md)\n\n**Caching HTTP proxy server written in Go**  \nПростой кеширующий прокси-сервер, который перенаправляет запросы на удалённый сервер и кэширует результат.\n\n\u003e Идеально подходит для уменьшения нагрузки на внешние API путём кэширования ответов с возможностью гибкой настройки через YAML-конфигурацию.\n\n---\n\n## 📌 Особенности\n\n- Прозрачное кэширование HTTP-запросов\n- Поддержка Redis в качестве хранилища кэша\n- Гибкая настройка через YAML-файл\n- Возможность указать blacklist URL-путей, которые не нужно кэшировать\n- Очистка кэша по секретному ключу\n\n---\n\n## ⚙️ Установка и запуск\n\n### 1. Локальный запуск\n\n```bash\ngo run cmd/main.go\n```\n\nУбедись, что конфигурационный файл `config.yaml` находится в корне проекта и имеет правильную конфигурацию.\n\n### 2. Запуск через Docker\n\nСобери образ (если нужно):\n\n```bash\ndocker build -t caching-proxy .\n```\n\nЗапусти контейнер:\n\n```bash\ndocker run -p 8080:8080 -v $(pwd)/config.yaml:/app/config.yaml caching-proxy\n```\n\n---\n\n## 📄 Конфигурация\n\nКонфигурация осуществляется через файл `config.yaml`.\n\n### Пример конфигурации:\n\n```yaml\nserver:\n  origin: https://httpbin.org/   # Базовый URL, куда будут перенаправляться запросы\n  # port: 1323                   # Порт (по умолчанию: 8080)\n  secret: pls_delete_cache_maboy # Секрет для очистки кэша\n\nredis:\n  addr: localhost                # Адрес Redis\n  port: 6379                     # Порт Redis\n  password:                      # Пароль (если используется)\n  db:                            # Номер базы данных\n  TTL: 5                         # Время жизни кэша в минутах\n\nblacklist:\n  - /uuid                        # Эти пути не будут кэшироваться\n  - /delay/(.+)                  # Поддерживает regexp\n\nlogger:\n  level: DEBUG                    # Сейчас поддерживает только DEBUG и INFO\n  file: app.log\n```\n\n---\n\n## 🧪 Использование\n\nПосле запуска сервис доступен по адресу:\n\n```\nhttp://localhost:8080/\n```\n\nВсе запросы перенаправляются на указанный `origin` (`https://httpbin.org/` в данном случае), а результаты кэшируются.\n\n### Пример использования:\n\n```bash\ncurl http://localhost:8080/ip\n```\n\n### Очистка кэша\n\nДля очистки кэша отправь POST-запрос с секретным ключом:\n\n```bash\ncurl -X POST http://localhost:8080/clear?secret=pls_delete_cache_maboy\n```\n\n---\n\n## 📁 Формат черного списка (Blacklist)\n\nПоддерживаются простые строки и регулярные выражения:\n\n```yaml\nblacklist:\n  - /uuid\n  - /delay/(.+)\n```\n\n---\n\n## 🏷 Статус кэширования (X-Cache)\n\nПри каждом ответе добавляется заголовок `X-Cache`, показывающий статус кэширования:\n\n| Значение     | Описание                                      |\n|--------------|-----------------------------------------------|\n| `MISS`       | Данные не были закэшированы, запрос выполнен напрямую |\n| `HIT`        | Ответ взят из кэша                             |\n| `BYPASS`     | Запрос был исключен из кэширования (через blacklist) |\n\n\n---\n\n## 📦 Технологии\n\n- Golang\n- Redis\n- YAML для конфигурации\n- Docker\n\n---\n\n## 🧾 Лицензия\n\nMIT License — см. [LICENSE](LICENSE) для деталей.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftamper000%2Fcaching-proxy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftamper000%2Fcaching-proxy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftamper000%2Fcaching-proxy/lists"}