Quality of Life Tweaks¶

This page documents lots of little things that don’t really need their own page but when implemented will improve your quality of life whilst administering the system.

Bash Aliases¶

Bash aliases enable complex commands to be shortned to a few characters. For example docker-compose -f ~/docker-compose.yml up -d can be shortned to dcp up -d with a the following alias:

1

alias
 
dcp
=
'docker-compose -f ~/docker-compose.yml '

Here are some more docker / docker-compose related ones.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

# /etc/bash_aliases
# Aliases in this file are available to all users
# To install for one user place in ~/.bash_aliases

# Tail last 50 lines of docker logs
alias
 
dtail
=
'docker logs -tf --tail='
50
' '

# Remove unused images (useful after an upgrade)
alias
 
dprune
=
'docker image prune'

# Remove unused images, unused networks *and data* (use with care)
alias
 
dprunesys
=
'docker system prune --all'

Making aliases persistent¶

Aliases created using the alias command in the terminal will only be available for the current session. To make an alias persist across sessions it must be added the shell’s initialization file. Here are some examples for popular shells:

• Bash: ~/.bashrc, this is typically the default shell.
• ZSH: ~/.zshrc
• Fish: ~/.config/fish/config.fish

Info

If you have a useful alias you think would benefit PMS users please submit a PR via GitHub for inclusion in this site following the format below. One alias or a group of related aliases showing example output.

Alias – Get container IPs¶

This alias prints the IP, network and listening ports for each container.

1
2
3
4
5
6
7

alias dcips=$'docker inspect -f \'{{.Name}}-{{range  $k, $v := .NetworkSettings.Networks}}{{$k}}-{{.IPAddress}} {{end}}-{{range $k, $v := .NetworkSettings.Ports}}{{ if not $v }}{{$k}} {{end}}{{end}} -{{range $k, $v := .NetworkSettings.Ports}}{{ if $v }}{{$k}} => {{range . }}{{ .HostIp}}:{{.HostPort}}{{end}}{{end}} {{end}}\' $(docker ps -aq) | column -t -s-'

$ [email protected]:~$ dcips
/tautulli      backend  172.18.0.3    8181/tcp
/lychee        backend  172.18.0.16   80/tcp
/tr            internet  172.18.0.4                      443/tcp => 0.0.0.0:443 80/tcp => 0.0.0.0:80 8080/tcp => 0.0.0.0:8080
/chowdown      backend  172.18.0.24                     4000/tcp => 0.0.0.0:4000

Last update: 2022-05-04