Skip to content

Update README.md #35

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MickMorley wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md #35

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,20 @@
# compose_plugin
# Docker Compose Manager for Unraid (compose_plugin)
This plugin installs Docker Compose v2 on unRAID. WebGUI integration is still a work in progress.

## Settings

**Compose Project Directory**: Choose the folder in which compose.manager will store your stacks.
- WARNING: Changing this path will not automatically move your existing project folders.

**Compose Command Progress Display**: Choose the style of output for plugin commands.
- When set to `basic` the output will be simple text as elsewhere in the webui.
- When set to `ttyd` the output will be a terminal window with colored text.

**Debug Logging**: Enable debug logging.

**Recreate During Autostart**: Use the --force-recreate option when autostarting stacks.
- This will recreate each stack container on startup.
- This can work around an issue where containers refuse to autostart because the network they are attached to no longer exists.

**Show Compose in Header Menu**: This will move the Compose Manager page to a separate tab in the Unraid Header menu.