https://github.com/idea2app/ows-cache
https://github.com/idea2app/ows-cache
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/idea2app/ows-cache
- Owner: idea2app
- License: agpl-3.0
- Created: 2024-12-14T18:01:53.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-12-28T01:28:24.000Z (6 months ago)
- Last Synced: 2025-12-30T04:17:47.219Z (6 months ago)
- Size: 123 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OWS-cache
Web file cache service based on [GitHub actions][1]
[][2]
## Technologies
- Crawler: [`web-fetch`][3] ([Puppeteer][4] based)
- OSS service: [Cloudflare R2][5]
## Usage
### Setup repository
1. Install GitHub apps in your organization or account:
1. [Probot settings][6]: set up Issue labels & Pull Request rules
2. Click the **[Use this template][7] button** on the top of this GitHub repository's home page, then create your own repository in the app-installed namespace above
3. Set Cloudflare variables is [`.github/workflows/crawler.yml`][8] as [Repository secrets][9]
### Manual cache
https://github.com/idea2app/OWS-cache/issues/new?template=crawler.yml
### Automatic cache
```shell
$URL = "https://example.com/test.html"
curl -L \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer " \
-d '{"title":"File title","body":"### URL\n\n$URL","labels":["crawler"]}' \
https://api.github.com/repos/idea2app/OWS-cache/issues
```
[1]: https://github.com/features/actions
[2]: https://github.com/idea2app/OWS-cache/actions/workflows/crawler.yml
[3]: https://github.com/TechQuery/Web-fetch
[4]: https://pptr.dev/
[5]: https://www.cloudflare.com/developer-platform/products/r2/
[6]: https://github.com/apps/settings
[7]: https://github.com/new?template_name=Web-file-cache&template_owner=idea2app
[8]: .github/workflows/crawler.yml
[9]: https://github.com/idea2app/OWS-cache/settings/secrets/actions