pogo/README.md

## ![Pogo Logo](https://cdn.rawgit.com/gmemstr/pogo/users/assets/web/static/logo-xs.png) 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) [![live branch](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/gorilla/feeds](https://github.com/gorilla/feeds)

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

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

## Building

```
godep restore
go build
# Set environment variable
export POGO_SECRET=secret
# Windows
# set POGO_SECRET=secret
./podcast
```

## 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
separated by underscores (`YYYY-MM-DD_TITLE.mp3`).

"Shownote" files are markdown formatted and simply append `_SHOWNOTES.md` to the existing filename (sans .mp3 of course).
Use XS logo 2017-11-19 04:26:16 +00:00			`## ![Pogo Logo](https://cdn.rawgit.com/gmemstr/pogo/users/assets/web/static/logo-xs.png) Podcast RSS feed generator and CMS in Go.`
Update README with some more information + links 2017-07-19 22:01:46 +01:00
Removed configreader.go and renamed ishanjain28/pogo -> gmemstr/pogo Configreader was largely unused in new refactor so removed it altogether. 2017-10-05 20:27:55 +01:00			`[![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) [![live branch](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)`
Update README with some more information + links 2017-07-19 22:01:46 +01:00
Change of name! + better skeleton custom.css 2017-09-11 19:36:40 +01:00			`## Goal`
Update README with some more information + links 2017-07-19 22:01:46 +01:00
Change of name! + better skeleton custom.css 2017-09-11 19:36:40 +01:00			`To produce a product that is easy to deploy and easier to use when hosting a podcast from ones own servers.`
Update README with some more information + links 2017-07-19 22:01:46 +01:00
Change of name! + better skeleton custom.css 2017-09-11 19:36:40 +01:00			`## Features`
Update README with some more information + links 2017-07-19 22:01:46 +01:00
Change of name! + better skeleton custom.css 2017-09-11 19:36:40 +01:00			`* 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`
Update README with some more information + links 2017-07-19 22:01:46 +01:00
Change of name! + better skeleton custom.css 2017-09-11 19:36:40 +01:00			`## Requirements`
Add requirements to README 2017-07-05 08:31:01 +01:00
Admin: Added user editing Added user editing route both backend and frontend, fully functional. Currently working on new user frontend route, then setup process. Also changed to use gorilla/feeds now that code has been upstreamed, so please update your dependencies. 2017-11-17 21:59:53 +00:00			`[github.com/gorilla/feeds](https://github.com/gorilla/feeds)`
Newline 2017-07-05 08:32:04 +01:00
Add requirements to README 2017-07-05 08:31:01 +01:00			`[github.com/fsnotify/fsnotify](https://github.com/fsnotify/fsnotify)`
Newline 2017-07-05 08:32:04 +01:00
Add requirements to README 2017-07-05 08:31:01 +01:00			`[github.com/gorilla/mux](https://github.com/gorilla/mux)`

Change of name! + better skeleton custom.css 2017-09-11 19:36:40 +01:00			`## Building`
Add build instructions 2017-06-15 17:23:09 +01:00
Add instructions to README for makefile 2017-07-25 16:02:48 +01:00			```
Removed configreader.go and renamed ishanjain28/pogo -> gmemstr/pogo Configreader was largely unused in new refactor so removed it altogether. 2017-10-05 20:27:55 +01:00			`godep restore`
			`go build`
Fix some typos 2017-10-07 23:02:57 +01:00			`# Set environment variable`
Update godeps & add env variable for cookie secret 2017-10-06 05:16:03 +01:00			`export POGO_SECRET=secret`
			`# Windows`
			`# set POGO_SECRET=secret`
Removed configreader.go and renamed ishanjain28/pogo -> gmemstr/pogo Configreader was largely unused in new refactor so removed it altogether. 2017-10-05 20:27:55 +01:00			`./podcast`
Add requirements to README 2017-07-05 08:31:01 +01:00			```
Explain maikefile 2017-09-07 21:45:31 +01:00
Change of name! + better skeleton custom.css 2017-09-11 19:36:40 +01:00			`## File format`
Some code cleanup. 2017-09-11 18:10:35 +01:00
Removed configreader.go and renamed ishanjain28/pogo -> gmemstr/pogo Configreader was largely unused in new refactor so removed it altogether. 2017-10-05 20:27:55 +01:00			`Pogo uses a flat file structure for managing podcast episodes. As such, files have a special naming convention.`
Some code cleanup. 2017-09-11 18:10:35 +01:00
Change of name! + better skeleton custom.css 2017-09-11 19:36:40 +01:00			`For podcast audio files, filenames take the form of YEAR-MONTH-DAY followed by the title. The two values are`
Fix some typos 2017-10-07 23:02:57 +01:00			separated by underscores (`YYYY-MM-DD_TITLE.mp3`).
Explain maikefile 2017-09-07 21:45:31 +01:00
Fix some typos 2017-10-07 23:02:57 +01:00			"Shownote" files are markdown formatted and simply append `_SHOWNOTES.md` to the existing filename (sans .mp3 of course).