Skip to content

Commit

Permalink
TASK: improve docs a bit, remove docker plugin mode
Browse files Browse the repository at this point in the history
  • Loading branch information
skurfuerst committed Dec 29, 2022
1 parent 6b529de commit 0854ddb
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 45 deletions.
28 changes: 0 additions & 28 deletions .goreleaser.yml
Original file line number Diff line number Diff line change
Expand Up @@ -64,34 +64,6 @@ brews:
# Default is empty.
description: "Drydock - Docker Debug Tools"

custom_block: |
def caveats
caveats =
<<~EOS
You can use "drydock" as standalone executable. If you find it more convenient as docker subcommands (i.e.
"docker execroot" instead of "drydock execroot", you can run the following commands to set up
docker plugin symlinks:
---------------------------------------------------------------------------------
mkdir -p ~/.docker/cli-plugins
rm -f ~/.docker/cli-plugins/docker-execroot
ln -s #{pkgshare}/drydock ~/.docker/cli-plugins/docker-execroot
rm -f ~/.docker/cli-plugins/docker-vscode
ln -s #{pkgshare}/drydock ~/.docker/cli-plugins/docker-vscode
rm -f ~/.docker/cli-plugins/docker-phpprofiler
ln -s #{pkgshare}/drydock ~/.docker/cli-plugins/docker-phpprofiler
rm -f ~/.docker/cli-plugins/docker-xdebug
ln -s #{pkgshare}/drydock ~/.docker/cli-plugins/docker-xdebug
---------------------------------------------------------------------------------
EOS
caveats
end
install: |
libexec.install Dir["*"]
bin.write_exec_script libexec/"drydock"
19 changes: 2 additions & 17 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,25 +26,10 @@ We have tested the tools in OSX. They also can work on other platforms, but were
brew install sandstorm/tap/drydock
```

2. (Optional) Register as Docker plugin.

You can use `drydock` as standalone executable. If you find it more convenient as `docker` subcommands (i.e.
`docker execroot` instead of `drydock execroot`, you can run the following commands to set up docker plugin symlinks:
2. Done :)

```bash
mkdir -p ~/.docker/cli-plugins
rm -f ~/.docker/cli-plugins/docker-execroot
ln -s $(brew --prefix)/opt/drydock/share/drydock/drydock ~/.docker/cli-plugins/docker-execroot

rm -f ~/.docker/cli-plugins/docker-vscode
ln -s $(brew --prefix)/opt/drydock/share/drydock/drydock ~/.docker/cli-plugins/docker-vscode

rm -f ~/.docker/cli-plugins/docker-phpprofiler
ln -s $(brew --prefix)/opt/drydock/share/drydock/drydock ~/.docker/cli-plugins/docker-phpprofiler

rm -f ~/.docker/cli-plugins/docker-xdebug
ln -s $(brew --prefix)/opt/drydock/share/drydock/drydock ~/.docker/cli-plugins/docker-xdebug

drydock --help
```

## Documentation
Expand Down

0 comments on commit 0854ddb

Please sign in to comment.