File: docker.md

package info (click to toggle)
organize 3.3.0-1.1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,540 kB
  • sloc: python: 5,837; makefile: 4
file content (52 lines) | stat: -rw-r--r-- 1,339 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
# Using the organize docker image

The organize docker image comes preinstalled with `exiftool` and `pdftotext` as well as
all the python dependencies set up and ready to go.

!!! danger

    As organize is mainly used for moving files around you have to be careful about your
    volume mounts and paths. **If you move a file to a folder which is not persisted
    it is gone as soon as the container is stopped!**

## Building the image

`cd` into the organize folder (containing the `Dockerfile`) and build the image:

```sh
docker build -t organize .
```

The image is now tagged as `organize`. Now you can test the image by running

```sh
docker run organize
```

This will show the organize usage help text.

## Running

Let's create a basic config file `docker-conf.yml`:

```yml
rules:
  - locations: /data
    actions:
      - echo: "Found file: {path}"
```

We can now run mount the config file to the container path `/config/config.yml`. The current directory is mounted to `/data` so we have some files present.
We can now start the container:

```sh
docker run -v ./docker-conf.yml:/config/config.yml -v .:/data organize run
```

### Passing the config file from stdin

Instead of mounting the config file into the container you can also pass it from stdin:

```sh
docker run -i organize check --stdin < ./docker-conf.yml
```