pogo/README.md

# Pogo
Podcast RSS feed generator and CMS in Go.
--- 

[![Build Status](https://travis-ci.org/gmemstr/pogo.svg?branch=master)](https://travis-ci.org/gmemstr/pogo) [![gitgalaxy](https://img.shields.io/badge/website-gitgalaxy.com-blue.svg)](https://gitgalaxy.com) [![shield](https://img.shields.io/badge/live-podcast.gitgalaxy.com-green.svg)](https://podcast.gitgalaxy.com) [![follow](https://img.shields.io/twitter/follow/gitgalaxy.svg?style=social&label=Follow)](https://twitter.com/gitgalaxy)

## Goal

To produce a product that is easy to deploy and easier to use when hosting a podcast from ones own servers. 

## Features

 * Auto-generate rss feed
 * Basic frontend for listening to episodes
 * Flat-file directory structure
 * Human readable files
 * Self publishing interface w/ password protection
 * Custom CSS and themeing capabilities
 * JSON feed generation for easier parsing
 * Docker support

## Requirements

[github.com/gmemstr/feeds](https://github.com/gmemstr/feeds) _this branch contains some fixes for "podcast specific" tags_

[github.com/fsnotify/fsnotify](https://github.com/fsnotify/fsnotify)

[github.com/gorilla/mux](https://github.com/gorilla/mux)

## Building

```
make install
make
./webserver
```

### Makefile

There are several commands in the Makefile, for various reasons (commands are preceded by the `make` command).

 * `all` - also works by just running `make`, compiles go code to executable
 * `windows` - creates named compiled .exe (pogoapp.exe)
 * `linux` - creates named compiled binary (pogoapp)
 * `install` - installs go dependencies 
 * `docker` - build docker image for running elsewhere
 * `and run` - build and run the executable (remove .exe in file for \*nix)

**non-make**
```
go get github.com/gmemstr/feeds
go get github.com/fsnotify/fsnotify
go get github.com/gorilla/mux
go build webserver.go generate_rss.go admin.go
./webserver
```

## File format

Pogo uses a flat file structure for managing podcast episodes. as such, files have a special naming convention.

For podcast audio files, filenames take the form of YEAR-MONTH-DAY followed by the title. The two values are
seperated by underscores (`YYYY-MM-DD_TITLE.mp3`).

Shownote fils are markdown formatted and simply append `_SHOWNOTES.md` to the existing filename (sans .mp3 of course).