diff --git a/README.md b/README.md index 2c16c7e..be7a82c 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,30 @@ Pinchflat is a lightweight self-contained app for downloading YouTube content. F I have plans for more to come, but for now this is the focus. Think of Pinchflat as nothing more than an automated way to get content from YouTube to your disk. +## Installation + +Pinchflat is designed to be self-hosted. I'm building it for my own needs which means it's designed to work well with Unraid, but it should work on any computer/server that can run Docker images. + +I'll update with Unraid instructions once I get something in the Community Apps store. Until then, here's how you build it with Docker: + +```bash +docker build . --file selfhosted.Dockerfile -t pinchflat:dev + +docker run \ + -p 8945:8945 \ + -v /Users/work/Desktop/test_volumes/config:/config \ + -v /Users/work/Desktop/test_volumes/downloads:/downloads \ + pinchflat:dev +``` + +## Authentication + +Currently HTTP basic auth is optionally supported. To use it, set the `AUTH_USERNAME` and `AUTH_PASSWORD` environment variables when starting the container. If you don't set both of these, no authentication will be required. + ## License See `LICENSE` file + +``` + +``` diff --git a/test/pinchflat/utils/filesystem_utils/file_follower_server_test.exs b/test/pinchflat/utils/filesystem_utils/file_follower_server_test.exs index eb5aafc..34cb671 100644 --- a/test/pinchflat/utils/filesystem_utils/file_follower_server_test.exs +++ b/test/pinchflat/utils/filesystem_utils/file_follower_server_test.exs @@ -45,7 +45,7 @@ defmodule Pinchflat.Utils.FilesystemUtils.FileFollowerServerTest do refute is_nil(Process.info(pid)) FileFollowerServer.stop(pid) # Gotta wait for the server to stop async - :timer.sleep(10) + :timer.sleep(50) assert is_nil(Process.info(pid)) end end