You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
155 lines
4.4 KiB
155 lines
4.4 KiB
<!--
|
|
*** Thanks for checking out this README Template. If you have a suggestion that would
|
|
*** make this better, please fork the repo and create a pull request or simply open
|
|
*** an issue with the tag "enhancement".
|
|
*** Thanks again! Now go create something AMAZING! :D
|
|
***
|
|
***
|
|
***
|
|
*** To avoid retyping too much info. Do a search and replace for the following:
|
|
*** akhilrex, podgrab, akhilrex, email
|
|
-->
|
|
|
|
|
|
|
|
|
|
|
|
<!-- PROJECT SHIELDS -->
|
|
<!--
|
|
*** I'm using markdown "reference style" links for readability.
|
|
*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
|
|
*** See the bottom of this document for the declaration of the reference variables
|
|
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
|
|
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
|
|
-->
|
|
[![Contributors][contributors-shield]][contributors-url]
|
|
[![Forks][forks-shield]][forks-url]
|
|
[![Stargazers][stars-shield]][stars-url]
|
|
[![Issues][issues-shield]][issues-url]
|
|
[![MIT License][license-shield]][license-url]
|
|
[![LinkedIn][linkedin-shield]][linkedin-url]
|
|
|
|
|
|
|
|
<!-- PROJECT LOGO -->
|
|
<br />
|
|
<p align="center">
|
|
<!-- <a href="https://github.com/akhilrex/podgrab">
|
|
<img src="images/logo.png" alt="Logo" width="80" height="80">
|
|
</a> -->
|
|
|
|
<h1 align="center">Podgrab</h1>
|
|
|
|
<p align="center">
|
|
A self-hosted tool to download latest podcast episodes as soon as they become live
|
|
<br />
|
|
<a href="https://github.com/akhilrex/podgrab"><strong>Explore the docs »</strong></a>
|
|
<br />
|
|
<br />
|
|
<a href="https://github.com/akhilrex/podgrab">View Demo</a>
|
|
·
|
|
<a href="https://github.com/akhilrex/podgrab/issues">Report Bug</a>
|
|
·
|
|
<a href="https://github.com/akhilrex/podgrab/issues">Request Feature</a>
|
|
</p>
|
|
</p>
|
|
|
|
|
|
|
|
<!-- TABLE OF CONTENTS -->
|
|
## Table of Contents
|
|
|
|
* [About the Project](#about-the-project)
|
|
* [Built With](#built-with)
|
|
* [Installation](#installation)
|
|
* [License](#license)
|
|
* [Contact](#contact)
|
|
|
|
|
|
<!-- ABOUT THE PROJECT -->
|
|
## About The Project
|
|
|
|
![Product Name Screen Shot][product-screenshot]
|
|
|
|
|
|
### Built With
|
|
|
|
* [Go](https://golang.org/)
|
|
* [Go-Gin](https://github.com/gin-gonic/gin)
|
|
* [GORM](https://github.com/go-gorm/gorm)
|
|
* [SQLite](https://www.sqlite.org/index.html)
|
|
|
|
|
|
## Installation
|
|
|
|
The easiest way to run Podgrab is to run it as a container.
|
|
|
|
### Using Docker
|
|
|
|
Simple setup without mounted volumes (for testing and evaluation)
|
|
```sh
|
|
docker run -d -p 8080:8080 --name=podgrab akhilrex/podgrab
|
|
```
|
|
|
|
Binding local volumes to the container
|
|
```sh
|
|
docker run -d -p 8080:8080 --name=podgrab -v "/host/path/to/assets:/assets" -v "/host/path/to/config:/config" akhilrex/podgrab
|
|
```
|
|
|
|
### Using Docker-Compose
|
|
|
|
Modify the docker compose file provided [here]() to update the volume and port binding and run the following command
|
|
```yaml
|
|
version: "2.1"
|
|
services:
|
|
podgrab:
|
|
image: akhilrex/podgrab
|
|
container_name: podgrab
|
|
environment:
|
|
- CHECK_FREQUENCY=20
|
|
volumes:
|
|
- /path/to/config:/config
|
|
- /path/to/data:/data
|
|
ports:
|
|
- 8080:8080
|
|
restart: unless-stopped
|
|
```
|
|
|
|
```sh
|
|
docker-compose up -d
|
|
```
|
|
|
|
|
|
<!-- LICENSE -->
|
|
## License
|
|
|
|
Distributed under the MIT License. See `LICENSE` for more information.
|
|
|
|
|
|
|
|
<!-- CONTACT -->
|
|
## Contact
|
|
|
|
Akhil Gupta - [@akhilrex](https://twitter.com/akhilrex)
|
|
|
|
Project Link: [https://github.com/akhilrex/podgrab](https://github.com/akhilrex/podgrab)
|
|
|
|
|
|
|
|
|
|
|
|
<!-- MARKDOWN LINKS & IMAGES -->
|
|
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
|
|
[contributors-shield]: https://img.shields.io/github/contributors/akhilrex/podgrab.svg?style=flat-square
|
|
[contributors-url]: https://github.com/akhilrex/podgrab/graphs/contributors
|
|
[forks-shield]: https://img.shields.io/github/forks/akhilrex/podgrab.svg?style=flat-square
|
|
[forks-url]: https://github.com/akhilrex/podgrab/network/members
|
|
[stars-shield]: https://img.shields.io/github/stars/akhilrex/podgrab.svg?style=flat-square
|
|
[stars-url]: https://github.com/akhilrex/podgrab/stargazers
|
|
[issues-shield]: https://img.shields.io/github/issues/akhilrex/podgrab.svg?style=flat-square
|
|
[issues-url]: https://github.com/akhilrex/podgrab/issues
|
|
[license-shield]: https://img.shields.io/github/license/akhilrex/podgrab.svg?style=flat-square
|
|
[license-url]: https://github.com/akhilrex/podgrab/blob/master/LICENSE.txt
|
|
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square&logo=linkedin&colorB=555
|
|
[linkedin-url]: https://linkedin.com/in/akhilrex
|
|
[product-screenshot]: images/screenshot.jpg |