https://github.com/stashapp/scrapers-repo-template
Template for creating Stash scrapers source index
https://github.com/stashapp/scrapers-repo-template
scrapers stash stashapp template
Last synced: 10 months ago
JSON representation
Template for creating Stash scrapers source index
- Host: GitHub
- URL: https://github.com/stashapp/scrapers-repo-template
- Owner: stashapp
- License: agpl-3.0
- Created: 2025-06-27T01:50:04.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-09-20T06:12:20.000Z (11 months ago)
- Last Synced: 2025-09-20T08:26:23.224Z (11 months ago)
- Topics: scrapers, stash, stashapp, template
- Language: Shell
- Homepage:
- Size: 14.6 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Template for creating Stash scrapers source index
This template allows you to create a new repository with a few clicks with preconfigured GitHub action to publish your scrapers source index.
_This assumes you already know how to create scrapers for Stash. If you don't, first read [this](https://docs.stashapp.cc/in-app-manual/scraping/scraperdevelopment/)._
## How to use it?
1. Click **Use this template** > **Create a new repository**.
1. Choose a repository name and click **Create repository**.
1. Open **Settings** and head to **Pages**.
1. Under Build and deployment select the Source as GitHub Actions.
Now add your scrapers to [scrapers](/scrapers) directory and they will be automatically published to the source index.
Source index URL: [`https://.github.io//main/index.yml`](https://.github.io//main/index.yml)
## Share your scrapers
- [Create a new topic](https://discourse.stashapp.cc/t/-/146) for your scraper on the community forum.
- [Add your source index to the list](https://discourse.stashapp.cc/t/-/834) on the Stash community forum.
## License
The default license is set to [AGPL-3.0](/LICENCE). Before publishing any scrapers you can change it.