<commit_before># DIM

DIM is a Docker Image Management utility. It's the perfect companion for your self-hosted private registry and provides useful commands to manage your docker images :
- [Advanced search](#advanced-searches) 
- Image labels add / removal
- Image deletion (both locally and on your private registry)
- Show image details

DIM works in two ways that are complementary :
- server mode :  provides search feature for both the `docker` command line and `dim` client mode
- client mode : to manage images locally and on your private registry and to run advanced searches (only with dim server enabled)


# Installation

DIM is written in go so it is easy to install. Moreover a docker image is available to easily setup the server mode.

## Client installation

To run dim in client mode, simply download the binary and give it execution permission.
```bash
curl -L https://github.com/nhurel/dim/releases/download/latest/dim-linux-x64 -o dim
chmod a+x dim
./dim help
```

## Server installation

The easiest way to run dim server side is to run the private registry and dim with a docker-compose file like this :

```yml
# docker-compose.yml
version: '2'
services:
 docker-registry:
  container_name: registry
  restart: always
  image: registry:2.4.1
  ports:
    - 5000:5000
    - 5001:5001
  volumes:
    - registry.yml:/etc/docker/registry/config.yml
  networks:
     - registry
 dim:
  container_name: dim
  restart: always
  image: nhurel/dim
  ports:
    - 6000:6000
  networks:
    - registry<commit_msg>Fixing installation documentation #patch<commit_after># DIM

DIM is a Docker Image Management utility. It's the perfect companion for your self-hosted private registry and provides useful commands to manage your docker images :
- [Advanced search](#advanced-searches) 
- Image labels add / removal
- Image deletion (both locally and on your private registry)
- Show image details

DIM works in two ways that are complementary :
- server mode :  provides search feature for both the `docker` command line and `dim` client mode
- client mode : to manage images locally and on your private registry and to run advanced searches (only with dim server enabled)


# Installation

DIM is written in go so it is easy to install. Moreover a docker image is available to easily setup the server mode.

## Client installation

To run dim in client mode, simply download the latest binary from the [release page](https://github.com/nhurel/dim/releases) and give it execution permission.
```bash
curl -L https://github.com/nhurel/dim/releases/download/<version>/dim-linux-x64 -o dim
chmod a+x dim
./dim help
```

## Server installation

The easiest way to run dim server side is to run the private registry and dim with a docker-compose file like this :

```yml
# docker-compose.yml
version: '2'
services:
 docker-registry:
  container_name: registry
  restart: always
  image: registry:2.4.1
  ports:
    - 5000:5000
    - 5001:5001
  volumes:
    - registry.yml:/etc/docker/registry/config.yml
  networks:
     - registry
 dim:
  container_name: dim
  restart: always
  image: nhurel/dim
  ports:
    - 6000:6000
  networks:
    - registry
{'fraction_non_alphanumeric': 0.07416798732171156, 'fraction_numerical': 0.01901743264659271, 'mean_word_length': 3.745864661654135, 'pattern_counts': {'":': 0, '<': 4, '<?xml version=': 0, '>': 4, 'https://': 3, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 4, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1388813', 'n_tokens_mistral': 964, 'n_tokens_neox': 872, 'n_words': 397}