<commit_before>*<div align=right>Pipework reference:* ***[`jpetazzo/pipework`](https://github.com/jpetazzo/pipework/blob/master/README.md)</div>***
**[`Readme`](README.md)** / **[`Install`](1. Install.md)** / **[`Usage`](2. Usage.md)** / **[`Examples`](3. Examples.md)** / **[`Config`](4. Config.md)**

## Docker-Pipework
**_A docker image which runs jpetazzo's pipework_**

Recommended with the `crane` orchestration tool. [See here for an example](3. Examples.md#crane).

This docker image encapsulates the awesome [jpetazzo/pipework](https://github.com/jpetazzo/pipework) networking configuration script. You can now run pipework as a docker container. The configurable [run modes](2. Usage.md#run-modes) determine how the pipework command is invoked on your docker containers.

By setting an environment variable named with the substring [`pipework_cmd`](4. Config.md#pipework_cmd) on a container. That it will tell the `dreamcat4/pipework` image how to run jpetazzo's `pipework` script, and with which specified command line arguments.

The intention may be to give your container an external IP address, or a macvlan L2 ethernet bridge, a particular [MAC address](https://github.com/jpetazzo/pipework/blob/master/README.md#custom_mac), a dynamic or a static [DHCP lease](https://github.com/jpetazzo/pipework/blob/master/README.md#dhcp). To be able to [manually configure the IP address](https://github.com/jpetazzo/pipework/blob/master/README.md#no_ip) from inside the container. To set up [host routes](4. Config.md#host_routes) so that those IPs are reachable / visible on the docker host. Or to [create a private bridge](https://github.com/jpetazzo/pipework/blob/master/README.md#lamp) between N other containers].

Or perhaps all of those things! As you may run multiple pipework commands on the same container. Using the [`.*pipework_cmd.*` pattern globbing](4. Config.md#globbing).

Requires privileged mode, access to the host PID namespace, and the host's networking stack. ~ But only on the `dreamcat4/pipework` container, not on any of your application containers.

## Readme
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 

- [Status](#status)
- [Support](#support)
- [Credit](#credit)
- [Future](#future)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

<a name="status"/>
### Status <commit_msg>Documentation update<commit_after>*<div align=right>Pipework reference:* ***[`jpetazzo/pipework`](https://github.com/jpetazzo/pipework/blob/master/README.md)</div>***
**[`Readme`](README.md)** / **[`Install`](1. Install.md)** / **[`Usage`](2. Usage.md)** / **[`Examples`](3. Examples.md)** / **[`Config`](4. Config.md)**

## Docker-Pipework
**_A docker image of jpetazzo's pipework_**

Recommended with the `crane` orchestration tool. [See here for an example](3. Examples.md#crane).

This docker image encapsulates the awesome [jpetazzo/pipework](https://github.com/jpetazzo/pipework) networking configuration script. You can now run pipework as a docker container. The configurable [run modes](2. Usage.md#run-modes) determine how the pipework command is invoked on your docker containers.

By setting an environment variable named with the substring [`pipework_cmd`](4. Config.md#pipework_cmd) on a container. That it will tell the `dreamcat4/pipework` image how to run jpetazzo's `pipework` script, and with which specified command line arguments.

The intention may be to give your container an external IP address, or a macvlan L2 ethernet bridge, a particular [MAC address](https://github.com/jpetazzo/pipework/blob/master/README.md#custom_mac), a dynamic or a static [DHCP lease](https://github.com/jpetazzo/pipework/blob/master/README.md#dhcp). To be able to [manually configure the IP address](https://github.com/jpetazzo/pipework/blob/master/README.md#no_ip) from inside the container. To set up [host routes](4. Config.md#host_routes) so that those IPs are reachable / visible on the docker host. Or to [create a private bridge](https://github.com/jpetazzo/pipework/blob/master/README.md#lamp) between N other containers].

Or perhaps all of those things! As you may run multiple pipework commands on the same container. Using the [`.*pipework_cmd.*` pattern globbing](4. Config.md#globbing).

Requires privileged mode, access to the host PID namespace, and the host's networking stack. ~ But only on the `dreamcat4/pipework` container, not on any of your application containers.

## Readme
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 

- [Status](#status)
- [Support](#support)
- [Credit](#credit)
- [Future](#future)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

<a name="status"/>
### Status 
{'fraction_non_alphanumeric': 0.1298754339391464, 'fraction_numerical': 0.004900959771288544, 'mean_word_length': 4.965895249695493, 'pattern_counts': {'":': 0, '<': 15, '<?xml version=': 0, '>': 15, 'https://': 12, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5587092', 'n_tokens_mistral': 1507, 'n_tokens_neox': 1424, 'n_words': 524}