Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adrianmo/powerline-docker
A Powerline segment for showing the status of your Docker containers
https://github.com/adrianmo/powerline-docker
Last synced: about 2 months ago
JSON representation
A Powerline segment for showing the status of your Docker containers
- Host: GitHub
- URL: https://github.com/adrianmo/powerline-docker
- Owner: adrianmo
- License: mit
- Created: 2016-04-23T15:47:49.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-06-30T09:11:44.000Z (over 7 years ago)
- Last Synced: 2024-04-28T05:38:43.372Z (8 months ago)
- Language: Python
- Homepage:
- Size: 35.2 KB
- Stars: 60
- Watchers: 5
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-docker - Powerline-Docker - A Powerline segment for showing the status of Docker containers by [@adrianmo](https://github.com/adrianmo) (Container Operations / User Interface)
- awesome-docker - Powerline-Docker - A Powerline segment for showing the status of Docker containers by [@adrianmo](https://github.com/adrianmo) (Container Operations / User Interface)
README
# Powerline Docker [](https://badge.fury.io/py/powerline-docker)
A [Powerline](https://github.com/powerline/powerline) segment for showing the status of your Docker containers.
This segment shows the number of running, paused, exited, and restarting containers together with a nice looking whale. Please feel free to propose more features and give me ideas on how to improve it.
## Glossary
- `●`: n containers running
- `~`: n containers paused
- `✖`: n containers exited
- `↻`: n containers restarting
## Requirements
The Docker segment requires [docker](https://docs.docker.com/engine/installation/) and [docker-py](https://docker-py.readthedocs.org).
## Installation
Installing the Docker segment can be done with `pip`:
```
$ pip install powerline-docker
```
The Docker segment uses a couple of custom highlight groups. You'll need to define those groups in your colorscheme, for example in `.config/powerline/colorschemes/default.json`:
```json
{
"groups": {
"docker": { "fg": "gray8", "bg": "darkestblue", "attrs": [] },
"docker_running": { "fg": "green", "bg": "darkestblue", "attrs": [] },
"docker_paused": { "fg": "brightestorange", "bg": "darkestblue", "attrs": [] },
"docker_exited": { "fg": "brightred", "bg": "darkestblue", "attrs": [] },
"docker_restarting": { "fg": "gray10", "bg": "darkestblue", "attrs": [] },
"docker:divider": { "fg": "gray4", "bg": "darkestblue", "attrs": [] }
}
}
```
Then you can activate the Docker segment by adding it to your segment configuration, for example in `.config/powerline/themes/shell/default.json`:
```json
{
"function": "powerline_docker.docker",
"priority": 30
}
```
By default the segment tries to connect to the Docker engine at `unix://var/run/docker.sock`, which is where it lives on most Unix systems. If your Docker engine is not living there, you can change the URL with the `base_url` argument. You can also change the `timeout` for API calls, which is set to 2 seconds by default.
The following configuration enables TLS and works with [Docker Machine](https://docs.docker.com/machine/).
```json
{
"function": "powerline_docker.docker",
"priority": 30,
"args": {
"base_url": "tcp://192.168.99.100:2376",
"timeout": 2,
"use_tls": true,
"ca_cert": "/path/to/ca.pem",
"client_cert": "/path/to/cert.pem",
"client_key": "/path/to/key.pem"
}
}
```
## License
Licensed under the [MIT License](LICENSE).
---
Inspired by [powerline-gitstatus](https://github.com/jaspernbrouwer/powerline-gitstatus).