Skip to content

Commit

Permalink
Minor improvements to the guide submitted by @ctkcoding
Browse files Browse the repository at this point in the history
  • Loading branch information
ben-xo committed Jul 29, 2023
1 parent 36a50de commit 163883b
Showing 1 changed file with 36 additions and 15 deletions.
51 changes: 36 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Features:
* You can set a per-file iTunes Summary by creating a text file with the same
name as the media file (e.g. for file.mp3, create file.txt).

* You can deploy a container the babyraptor/dir2cast Docker image
* You can deploy a container using the babyraptor/dir2cast Docker image.


QUICK HOW TO GUIDES
Expand Down Expand Up @@ -102,25 +102,46 @@ podcast that it generates uses the tags from your files.

DOCKER SETUP
================================================================================
Note: I did not create the image that I've deployed (project is in the works there), so this is a product of trial and error. There are settings in dir2cast or swag that are not covered in this
Note: There are many ways to get dir2cast working under docker, and this guide
is a product of trial and error. There are settings in dir2cast and SWAG that are
not covered in this guide.

Local setup
1. Make sure to pull the image, even with the weird tag babyraptor/dir2cast:69adefa
2. Map the container's port 80 to whatever port you want to access it with on your local network (i.e. port 8080)
3. Create a volume to map with /var/www/html
4. If desired, you can bind the /var/www/html/<episode folder> to a location on some shared drive that you drop files into from your PC instead of in a docker volume
5. Combine these into something like `docker run --name dir2cast -d -p 8080:80 -v podcast_volume:/var/www/html babyraptor/dir2cast:69adefa`
6. Once you add mp3 files, your podcast feed should now exist at <docker server ip>:<container port>/dir2cast.php

Remote w SWAG
1. Install SWAG and test that you can remotely access your docker server. Here's a guide https://docs.linuxserver.io/general/swag
2. Create a <name>.subdomain.conf file for your podcast server container as specified in the swag guide
-----------
1. `docker pull babyraptor/dir2cast:69adefa`
2. Map the container's port 80 to whatever port you want to access it with on your
local network (e.g. port 8080)
3. Create a volume to map under `/var/www/html`, or alternatively bind the
`/var/www/html/<episode folder>` to a location on your file system such as a
shared drive full of episodes.
4. To start the container, try something like:
`docker run --name dir2cast -d -p 8080:80 -v podcast_volume:/var/www/html babyraptor/dir2cast:69adefa`
5. Once you add media files to the podcast_volume (or local folder), your podcast
feed should now exist at `<docker server ip>:<container port>/dir2cast.php`

Remote using SWAG
-----------------
1. Install SWAG and test that you can remotely access your docker server. Here's
a guide https://docs.linuxserver.io/general/swag
2. Create a `<name>.subdomain.conf` file for your podcast server container as
specified in the SWAG guide
3. Add your dir2cast container to the network that you created with SWAG
4. Check that podcasts can be played/downloaded. If your feed exists and can be subscribed to, but files aren't available, update MP3_URL in the dir2cast.ini file for https (see comment in that file)
4. Check that podcasts can be played/downloaded. If your feed exists and can be
subscribed to, but files aren't available, try setting `MP3_URL` in the
`dir2cast.ini` file with an https:// URL rather than http://. (see comment in
that file)

Notes
* if you have shared folders that are accessible from your PC, a bind mount can make it easier to drag and drop. if you see '.\_' prefixed junk files in your feed, that is a mac issue (not dir2cast)
* 502 errors are likely swag configuration problems. Check container name, port mapping, etc
-----
* If you have shared folders that are accessible from your computer, using a bind mount
(rather than a docker volume) is an easy way to enable a simple workflow for you to
drag and drop content into the podcast feed.
* If you see '.\_' prefixed junk files in your feed, that is an unfortunate side-effect
of using network shares from macOS, and not dir2cast's fault.
* 502 errors are likely SWAG configuration problems. Check container name, port mapping, etc.

Thank you to @ctkcoding for the contribution of this guide.


UNDERSTANDING HOW THE CACHING WORKS
================================================================================
Expand Down

0 comments on commit 163883b

Please sign in to comment.