iImprovements to the documentation - potcasse - Podcast publication made easy Err bitreich.org 70
hgit clone git://bitreich.org/potcasse git://hg6vgqziawt5s4dj.onion/potcasse URL:git://bitreich.org/potcasse git://hg6vgqziawt5s4dj.onion/potcasse bitreich.org 70
1Log /scm/potcasse/log.gph bitreich.org 70
1Files /scm/potcasse/files.gph bitreich.org 70
1Refs /scm/potcasse/refs.gph bitreich.org 70
1Tags /scm/potcasse/tag bitreich.org 70
1README /scm/potcasse/file/README.md.gph bitreich.org 70
1LICENSE /scm/potcasse/file/LICENSE.gph bitreich.org 70
i--- Err bitreich.org 70
1commit 9d5d1f5f68edcdf72758276baea7306d1411a2ec /scm/potcasse/commit/9d5d1f5f68edcdf72758276baea7306d1411a2ec.gph bitreich.org 70
1parent 221fd26a5690531a02f9edd4a53d719bbd25a36b /scm/potcasse/commit/221fd26a5690531a02f9edd4a53d719bbd25a36b.gph bitreich.org 70
hAuthor: Solene Rapenne <solene@perso.pw> URL:mailto:solene@perso.pw bitreich.org 70
iDate: Tue, 20 Jul 2021 22:55:12 +0200 Err bitreich.org 70
i Err bitreich.org 70
iImprovements to the documentation Err bitreich.org 70
i Err bitreich.org 70
iDiffstat: Err bitreich.org 70
i M README.md | 34 +++++++++++++++++++++++++++++-- Err bitreich.org 70
i Err bitreich.org 70
i1 file changed, 32 insertions(+), 2 deletions(-) Err bitreich.org 70
i--- Err bitreich.org 70
1diff --git a/README.md b/README.md /scm/potcasse/file/README.md.gph bitreich.org 70
i@@ -4,10 +4,12 @@ potcasse is meant to help people to publish and self host a podcast easily witho Err bitreich.org 70
i Err bitreich.org 70
i # Dependencies Err bitreich.org 70
i Err bitreich.org 70
i-* rsync Err bitreich.org 70
i+* rsync (could use cp but avoid recopying audio files locally) Err bitreich.org 70
i+* a posix compatible OS (Linux, *BSD, Solaris) Err bitreich.org 70
i Err bitreich.org 70
i # How to use Err bitreich.org 70
i Err bitreich.org 70
i+The idea is to regroup audio files with their metadata in a directory and generate the structure that you will publish on a web server. Err bitreich.org 70
i Err bitreich.org 70
i ## First time Err bitreich.org 70
i Err bitreich.org 70
i@@ -15,6 +17,18 @@ potcasse is meant to help people to publish and self host a podcast easily witho Err bitreich.org 70
i potcasse init Err bitreich.org 70
i ``` Err bitreich.org 70
i Err bitreich.org 70
i+This will create a file `metadata.sh` that you need to edit accordingly to your setup. Err bitreich.org 70
i+ Err bitreich.org 70
i+It has the following variables: Err bitreich.org 70
i+ Err bitreich.org 70
i++ TITLE: this is the podcast title Err bitreich.org 70
i++ AUTHOR: this is the podcast author (doesn't support multiples authors yet) Err bitreich.org 70
i++ SITE: base HTTP URL where your podcast will be available (for example `https://tilde.example/myname/podcast/` Err bitreich.org 70
i++ RSSLINK: name of the RSS feed Err bitreich.org 70
i++ IMAGE: if value is not empty, potcasse will use the file `logo.png` Err bitreich.org 70
i+ Err bitreich.org 70
i+You will share the link `$SITE/$RSSLINK` to your listeners. Err bitreich.org 70
i+ Err bitreich.org 70
i ## New episode Err bitreich.org 70
i Err bitreich.org 70
i ``` Err bitreich.org 70
i@@ -35,4 +49,20 @@ potcasse episode "Episode XX: trying something weird" /path/to/audio/file this_i Err bitreich.org 70
i potcasse gen Err bitreich.org 70
i ``` Err bitreich.org 70
i Err bitreich.org 70
i-this will create a `output_html` directory with your audio files, the RSS file and potentially a logo file if any. Err bitreich.org 70
i+this will create or update the `output_html` directory with your audio files, the RSS file and the logo file if any. Err bitreich.org 70
i+ Err bitreich.org 70
i+# Real world example Err bitreich.org 70
i+ Err bitreich.org 70
i+My podcast feed is available at `https://perso.pw/lambda/feed.xml` which is on server `perso.pw` in `/var/www/htdocs/lambda/`. Err bitreich.org 70
i+ Err bitreich.org 70
i+I add new episodes with `potcasse episode "A made something nice" ~/Podcast/episodeXX/file.ogg` then I use `potcasse gen` that will refresh the directory `public_html` with metadata and episodes, finally I put it online with `rsync -av public_html/ perso.pw:/var/www/htdocs/lamda/`. Err bitreich.org 70
i+ Err bitreich.org 70
i+My `metadata.sh` looks like this: Err bitreich.org 70
i+ Err bitreich.org 70
i+``` Err bitreich.org 70
i+TITLE="Lambda Solene" Err bitreich.org 70
i+AUTHOR=Solene Err bitreich.org 70
i+SITE=https://perso.pw/lambda/ Err bitreich.org 70
i+RSSLINK=feed.xml Err bitreich.org 70
i+IMAGE=YES Err bitreich.org 70
i+``` Err bitreich.org 70
.
Response:
text/plain