> For the complete documentation index, see [llms.txt](https://doc.celantur.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.celantur.com/container/getting-started.md).

# Getting Started

## Overview

**Celantur Container** is a [Docker](https://www.docker.com/)-based container image to automatically anonymize **faces, persons, license plates and vehicles** on images and videos.

It's built to deliver high-quality anonymization and high throughput (see [benchmarks](/container/benchmarks.md)).

{% embed url="<https://www.youtube.com/watch?v=eFwkK1XSoB0>" %}
How to run Celantur Container in Batch Mode.
{% endembed %}

## Requirements and Installation

* [System Requirements](/container/requirements-and-installation/requirements.md) and [Licensing](/container/requirements-and-installation/requirements.md#licensing)
* [Installation on Linux](/container/requirements-and-installation/installation-on-linux.md)
* [Installation on Windows](/container/requirements-and-installation/installation-on-windows.md)

## Modes and Features

* Celantur Container offers different data **input/output modes**:
  * [Batch and Stream Mode](/container/usage/batch-and-stream-mode.md) (read/write from file system)
  * [REST API Mode](/container/usage/rest-api-v1-mode.md) ([sync](/container/usage/rest-api-v1-mode.md#sychronous-processing) and [async](/container/usage/rest-api-v1-mode.md#asynchronous-processing))
  * [TCP Mode](/container/usage/tcp-mode.md)
* [Extract Segmentation Masks and Metadata](/container/usage/segmentation-masks-and-metadata.md)
* [Customize Blurring](/container/usage/customize-blurring.md) appearance
* [CPU mode](/container/usage/using-cpu-only.md)

## Anonymize Images and Videos

{% hint style="success" %}

* Install Celantur Container according to the [installation guide](/container/requirements-and-installation/installation-on-linux.md).
* `celantur.sh` script is used to start the Docker Container.
  {% endhint %}

### Quickstart

* Run `mkdir input`
* Copy some images into the `input` directory.
* Run `bash celantur.sh -a person -a license-plate`
* Check the anonymized in the `output` directory.

For different image types and resolutions, e.g. panoramas, drone images, check out [Recommended Parameters](/container/usage/recommended-parameters.md).

{% hint style="success" %}
When starting with a demo of Celantur Container, our team will send you a customized code sample.
{% endhint %}

## What's New

Celantur Container receives continuous improvements and new features. Read more about past and recent releases in the [Release Notes](/container/release-notes.md).
