Metadata-Version: 2.1
Name: parallels-docker-port-forwarding
Version: 0.1.3
Summary: A Docker container port forwarding service for Parallels
Home-page: https://github.com/imtpot/parallels-docker-port-forwarding
License: MIT
Author: imtpot
Author-email: muse-buzz.0@icloud.com
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: docker (>=7.1.0,<8.0.0)
Project-URL: Repository, https://github.com/imtpot/parallels-docker-port-forwarding
Description-Content-Type: text/markdown


# Parallels Docker Port Forwarding

Parallels Docker Port Forwarding is a service that automatically manages port forwarding for Docker containers running inside a Parallels VM.

## Features

- Automatically detects running Docker containers and their exposed ports.
- Sets up port forwarding rules from the host to the Parallels VM.
- Monitors Docker events and updates port forwarding rules dynamically.

## Requirements

- Python 3.8+
- [Poetry](https://python-poetry.org/docs/#installation)
- [Docker SDK for Python](https://docker-py.readthedocs.io/en/stable/)
- Parallels Desktop with `prlctl` and `prlsrvctl` command-line tools
- Docker configured to accept TCP connections on the VM

## Setting up Docker to accept TCP connections on the VM

1. **Edit the Docker service configuration file**:

   Open the Docker service configuration file in your VM. This is usually located at `/lib/systemd/system/docker.service`.

   ```bash
   sudo nano /lib/systemd/system/docker.service
   ```

2. **Modify the `ExecStart` line**:

   Find the line that starts with `ExecStart` and modify it to include the `-H tcp://0.0.0.0:2375` option. It should look something like this:

   ```bash
   ExecStart=/usr/bin/dockerd -H fd:// -H tcp://0.0.0.0:2375
   ```

3. **Reload the systemd configuration and restart Docker**:

   ```bash
   sudo systemctl daemon-reload
   sudo systemctl restart docker
   ```

4. **Verify that Docker is listening on TCP port 2375**:

   ```bash
   sudo netstat -tlpn | grep dockerd
   ```

## Installation

You can install the package using pip:

```bash
pip install parallels-docker-port-forwarding
```

## Usage

To start the port forwarding service, run:

```bash
parallels-docker-port-forwarding --vm-name "Your VM Name"
```

If the VM name is not provided, the default VM name `'Ubuntu 22.04.2 (x86_64 emulation)'` will be used.

## Development

To set up the development environment:

1. Clone the repository:

```bash
git clone https://github.com/imtpot/parallels-docker-port-forwarding.git
cd parallels-docker-port-forwarding
```

2. Install dependencies using Poetry:

```bash
poetry install
```

3. Run the service:

```bash
poetry run parallels-docker-port-forwarding --vm-name "Your VM Name"
```

## Contributing

Contributions are welcome! Please open an issue or submit a pull request.

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

