# 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](https://doc.celantur.com/container/benchmarks)).

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

## Requirements and Installation

* [System Requirements](https://doc.celantur.com/container/requirements-and-installation/requirements) and [Licensing](https://doc.celantur.com/requirements-and-installation/requirements#licensing)
* [Installation on Linux](https://doc.celantur.com/container/requirements-and-installation/installation-on-linux)
* [Installation on Windows](https://doc.celantur.com/container/requirements-and-installation/installation-on-windows)&#x20;

## Modes and Features

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

## Anonymize Images and Videos

{% hint style="success" %}

* Install Celantur Container according to the [installation guide](https://doc.celantur.com/container/requirements-and-installation/installation-on-linux).&#x20;
* `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.&#x20;

For different image types and resolutions, e.g. panoramas, drone images, check out [recommended-parameters](https://doc.celantur.com/container/usage/recommended-parameters "mention").

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

## What's New&#x20;

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


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://doc.celantur.com/container/getting-started.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
