oslabs-beta / port-navigator

A Docker networking management and visualization tool to configure and maintain Docker container network settings.

PortNavigator

A Docker Desktop Networking Tool

Table of Contents

1. About PortNavigator
2. Features
3. Installation
4. Contributing
5. Authors
6. License

About PortNavigator

PortNavigator supports users with Docker networking configurations through a Docker Desktop GUI that enables modification of gateways, subnets, IP addresses, and container port mappings. The GUI also minimizes the need for command line interactions and provides visualizations of existing networks and containers.

https://portnavigatornet.firebaseapp.com/

Features

Container Networking Visuals

View your networks and their attached containers through the network management GUI, or visualize your networks and containers in an Arc, Force, or Sankey display.

Create & remove networks

Add user-created bridge networks for your containers directly from the user interface and remove any unused networks.

Connect & disconnect containers to networks

Connect your containers to any default or user-created network configurations and disconnect containers from any network.

Adjust port exposure

View published and private ports on containers and configure which ports are published.

Installation Instructions

Installation through the Docker Desktop Extension Marketplace (Recommended)

PortNavigator is a published extension of the Docker Desktop Extension Marketplace. To install PortNavigator this way, you can

1. Install the Docker Destkop Client
2. Click 'Add Extensions'
3. Use the search bar to search for 'PortNavigator'
4. Click the 'Install' button

Installation through the command line

You can also install PortNavigator directly through the command line. To install PortNavigator this way, you can

1. Fork and clone this repository
2. Install the Docker Destkop Client
3. Build the extension image

docker build --tag=portnavigator/port-navigator:1.0.0 .

4. Install the extension

docker extension install portnavigator/port-navigator:latest

Contributing

Contributing to an Open Source Product helps

If you would like to contribute, please follow the steps below, check out some useful development commands and take a look at some of the features in development:

1. Fork and Clone this Repository
2. Create a new Feature Branch

git checkout -b <Branch Name>

3. Commit and push your changes up to GitHub

git commit -m "<Your commit message>"
git push origin <Branch Name>

4. Create a pull request into the 'dev' branch of this Repository

Features in Development

• IP address log
• Container port log
• Container page

Useful Development Commands

Update the extension

docker extension update portnavigator/port-navigator:latest

Enable Chrome dev tools

docker extension dev debug portnavigator/port-navigator

Enable hot reloading

1. Navigating to the /ui folder

2. Execute in command line

npm start

3. In a separate terminal, execute in command line

docker extension dev ui-source portnavigator/port-navigator http://localhost:3000

Authors

Adrian Zywno

Brandon Gregoire

Clayton Stewart

Wes Phipps

License

This project is licensed under the terms of the MIT LICENSE.