Skip to content

Enhance comments in docker-compose.yml for headless usage#1081

Merged
DrewThomasson merged 17 commits intov25from
DrewThomasson-Docker-compose-patch-1
Oct 12, 2025
Merged

Enhance comments in docker-compose.yml for headless usage#1081
DrewThomasson merged 17 commits intov25from
DrewThomasson-Docker-compose-patch-1

Conversation

@DrewThomasson
Copy link
Owner

Added comments to clarify usage of docker-composenf or headless usage

There was one comma replaced with a less than (,<) so I fixed it.
Added comments to clarify usage of docker-composenf or headless usage
Added a section for Compose headless setup in the README.
Clarify the purpose of the docker-compose.yml file.
Added comments to clarify usage of podman-compose.yml.
@DrewThomasson
Copy link
Owner Author

@ROBERT-MCDOWELL 👍 ?

@ROBERT-MCDOWELL
Copy link
Collaborator

ROBERT-MCDOWELL commented Oct 11, 2025

I'm not sure to understand what do you mean by

The docker-compose.yml file will act as the base dir for any headless commands added

is it the same as "in headless mode, The docker-compose.yml file will act as the base dir" ???

a file becoming a base directory? or the docker-compose.yml parent directory?

@DrewThomasson
Copy link
Owner Author

DrewThomasson commented Oct 11, 2025

@ROBERT-MCDOWELL HM Good catch, that was poorly worded.

The directory containing docker-compose.yml becomes the base for file paths because the volumes: - ./:/app directive maps the host's project directory (.) to the container's /app working directory.

This means any file in the project root on your local machine is accessible inside the container. To illustrate, here's how the paths for the same file look:

  • Path on Host: ~/ebook2audiobook/test.epub
  • Path in Container: /app/test.epub

So, to process a local file like test.epub, you just place it in the project root and reference it in the command as ./test.epub.

About the "in headless mode"

Ignore the "in headless mode" Phrasing.... I just wanted to give an example of if someone wanted to use the compose with a headless command is all

@DrewThomasson
Copy link
Owner Author

Should I remove this from the readme then?

"The docker-compose.yml file will act as the base dir for any headless commands added."

@ROBERT-MCDOWELL
Copy link
Collaborator

ok more clear! so if I move docker-compose.yml out of E2A folder. will it be the parent folder of the yml?

@DrewThomasson
Copy link
Owner Author

Yes!

@DrewThomasson
Copy link
Owner Author

Perhaps I should try creating a wiki page for this or something

@DrewThomasson
Copy link
Owner Author

Hows this?
https://github.com/DrewThomasson/ebook2audiobook/wiki/Docker-Compose-Headless-guide

Should I re-word the comments made in the docker-compose and podman-compose files?
@ROBERT-MCDOWELL

@ROBERT-MCDOWELL
Copy link
Collaborator

👌👍

Changed when copy application files to before the launch

This makes it so that the compose user does not have to re-build the unidic step every time the compose is launched
@DrewThomasson
Copy link
Owner Author

Hopefully that dockerfile optomization works too,

That should stop the compose from re-building the last unidict/pip install step everything its launched

Because it should just launch the dockerfile you built before instead of re-building partly every time ✨

Updated comments for clarity regarding the base directory and headless command usage.
Updated comments for clarity and improved instructions.
Added a link to the Headless Wiki for more information.
@ROBERT-MCDOWELL
Copy link
Collaborator

indeed!

@DrewThomasson
Copy link
Owner Author

So that updated wording looks good to you? :D

@ROBERT-MCDOWELL
Copy link
Collaborator

LGTM!

Updated instructions for starting services with Docker and Podman to clarify the use of the --build flag.
@DrewThomasson
Copy link
Owner Author

DrewThomasson commented Oct 11, 2025

kk ill merge once the tests go through

Updated example headless command in podman-compose.yml for clarity.
@DrewThomasson DrewThomasson changed the base branch from main to v25 October 11, 2025 21:45
@DrewThomasson DrewThomasson merged commit e21dc54 into v25 Oct 12, 2025
1 check passed
@DrewThomasson DrewThomasson deleted the DrewThomasson-Docker-compose-patch-1 branch October 12, 2025 00:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants