diff --git a/README.md b/README.md index 9e390186..c81802dc 100644 --- a/README.md +++ b/README.md @@ -79,6 +79,51 @@ server: ## Installation +The ytdl-sub docker image uses +[LinuxServer's](https://www.linuxserver.io/) +[base alpine image](https://github.com/linuxserver/docker-baseimage-alpine). +It looks, feels, and operates like other LinuxServer images. This is the +recommended way to use ytdl-sub. + +### Docker Compose +```yaml +version: "2.1" +services: + ytdl-sub: + image: ghcr.io/jmbannon/ytdl-sub:latest + container_name: ytdl-sub + environment: + - PUID=1000 + - PGID=1000 + - TZ=America/Los_Angeles + volumes: + - :/config + - :/tv_shows # optional + - :/movies # optional + - :/music_videos # optional + - :/music # optional + restart: unless-stopped +``` +### Docker CLI +```commandline +docker run -d \ + --name=ytdl-sub \ + -e PUID=1000 \ + -e PGID=1000 \ + -e TZ=America/Los_Angeles \ + -v :/config \ + -v :/tv_shows \ + -v :/movies \ + -v :/music_videos \ + -v :/music \ + --restart unless-stopped \ + ghcr.io/jmbannon/ytdl-sub:latest +``` + +### Building Docker Image Locally +Run `make docker` in the root directory of this repo to build the image. This +will build the python wheel and install it in the Dockerfile. + ### Virtualenv With a Python 3.10 virtual environment, you can clone and install the repo using ```commandline @@ -88,14 +133,6 @@ cd ytdl-sub pip install -e . ``` -### Local Docker -If you are familiar with -[LinuxServer.io](https://www.linuxserver.io/), -you will be happy to hear that we use their base image for our docker image. -Documentation on how to build the image locally can be found in the -[docker readme](https://github.com/jmbannon/ytdl-sub/tree/master/docker#running-ytdl-sub-in-docker). - - ## Contributing There are many ways to contribute, even without coding. Please take a look in our [Github Issues](https://github.com/jmbannon/ytdl-sub/issues) to ask diff --git a/docker/README.md b/docker/README.md deleted file mode 100644 index 2b4978ce..00000000 --- a/docker/README.md +++ /dev/null @@ -1,48 +0,0 @@ -# Running ytdl-sub in Docker -The ytdl-sub docker image uses -[LinuxServer's](https://www.linuxserver.io/) -[base alpine image](https://github.com/linuxserver/docker-baseimage-alpine). -It looks, feels, and operates like other LinuxServer.io images. - -The image will install ytdl-sub as a python package, and can be used -via command line with `ytdl-sub`. - -## Building Locally -Run `make docker` in the root directory of this repo to build the image. This -will build the python wheel and install it in the Dockerfile. - -## Usage -### docker-compose -```yaml -version: "2.1" -services: - ytdl-sub: - image: ytdl-sub:latest - container_name: ytdl-sub - environment: - - PUID=1000 - - PGID=1000 - - TZ=America/Los_Angeles - volumes: - - :/config - - :/tv_shows # optional - - :/movies # optional - - :/music_videos # optional - - :/music # optional - restart: unless-stopped -``` -### docker cli -```commandline -docker run -d \ - --name=ytdl-sub \ - -e PUID=1000 \ - -e PGID=1000 \ - -e TZ=America/Los_Angeles \ - -v :/config \ - -v :/tv_shows \ - -v :/movies \ - -v :/music_videos \ - -v :/music \ - --restart unless-stopped \ - ytdl-sub:latest -``` \ No newline at end of file diff --git a/docs/getting_started.rst b/docs/getting_started.rst index 0d556ca3..09d9d48f 100644 --- a/docs/getting_started.rst +++ b/docs/getting_started.rst @@ -42,23 +42,67 @@ If you want to jump the gun to see how ytdl-sub can be configured to do these th Install ------- +The ytdl-sub docker image uses +`LinuxServer's `_ +`base alpine image `_. +It looks, feels, and operates like other LinuxServer images. This is the +recommended way to use ytdl-sub. + +Docker Compose +______________ + +.. code-block:: yaml + + version: "2.1" + services: + ytdl-sub: + image: ghcr.io/jmbannon/ytdl-sub:latest + container_name: ytdl-sub + environment: + - PUID=1000 + - PGID=1000 + - TZ=America/Los_Angeles + volumes: + - :/config + - :/tv_shows # optional + - :/movies # optional + - :/music_videos # optional + - :/music # optional + restart: unless-stopped + +Docker CLI +__________ + +.. code-block:: bash + + docker run -d \ + --name=ytdl-sub \ + -e PUID=1000 \ + -e PGID=1000 \ + -e TZ=America/Los_Angeles \ + -v :/config \ + -v :/tv_shows \ + -v :/movies \ + -v :/music_videos \ + -v :/music \ + --restart unless-stopped \ + ghcr.io/jmbannon/ytdl-sub:latest + + +Building Docker Image Locally +_____________________________ + +Run `make docker` in the root directory of this repo to build the image. This +will build the python wheel and install it in the Dockerfile. + Virtualenv __________ + With a Python 3.10 virtual environment, you can clone and install the repo using -.. code-block:: shell - - git clone https://github.com/jmbannon/ytdl-sub.git - cd ytdl-sub - - pip install -e . - -Local Docker -____________ -If you are familiar with -`LinuxServer.io `_, -you will be happy to hear that we use their base image for our docker image. -Documentation on how to build the image locally can be found in the repo's -`docker readme `_. +.. code-block:: bash + git clone https://github.com/jmbannon/ytdl-sub.git + cd ytdl-sub + pip install -e .