https://github.com/maxkratz/docker_offlineimap

Offlineimap dockerfile.
https://github.com/maxkratz/docker_offlineimap

docker docker-image dockerfile imap imap-client offlineimap

Last synced: about 1 month ago
JSON representation

Offlineimap dockerfile.

• Host: GitHub
• URL: https://github.com/maxkratz/docker_offlineimap
• Owner: maxkratz
• License: apache-2.0
• Created: 2020-01-25T14:43:56.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2024-06-15T07:10:12.000Z (6 months ago)
• Last Synced: 2024-06-16T07:45:41.863Z (6 months ago)
• Topics: docker, docker-image, dockerfile, imap, imap-client, offlineimap
• Language: Dockerfile
• Homepage:
• Size: 21.5 KB
• Stars: 6
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# docker_offlineimap

[![Build Docker images (tag)](https://github.com/maxkratz/docker_offlineimap/actions/workflows/build-tag.yml/badge.svg)](https://github.com/maxkratz/docker_offlineimap/actions/workflows/build-tag.yml)

[![Build Docker images (main)](https://github.com/maxkratz/docker_offlineimap/actions/workflows/build-dev.yml/badge.svg)](https://github.com/maxkratz/docker_offlineimap/actions/workflows/build-dev.yml)

*Unofficial* OfflineIMAP Dockerfile for backing up all folders of an imap server.

## Quickstart

After installing docker, just run the following command:

```sh

docker pull maxkratz/offlineimap:latest

```

## Environment variables

You can use the following environment variables for customization of this container:

```sh

MAILLOG # If set to true, container will create a log instead of using console output

```

## Mount volumes or bind folders

One may mount a folder of the host to **/mnt/mail** within the container to enable persistent backups of imap servers.

* **/mnt/mail** may be used as backup target.

* **/mnt/config** will be used as config. Be sure to place a file named **offlineimap.conf** with a valid configuration in here.

* **/mnt/secret** may be used as folder to get secrets from. You can e.g. place password files in this folder and use them in your config file.

* **/mnt/log** will be used as log target (if environment variable is set).

## Full example command

```sh

docker run -it -v ~/email-backups/offlineimap-config:/mnt/config -v ~/email-backups/offlineimap-secret:/mnt/secret -v ~/email-backups/offlineimap-mail:/mnt/mail -v ~/email-backups/offlineimap-log:/mnt/log -e MAILLOG=TRUE maxkratz/offlineimap:latest

```

**offlineimap.conf**

```sh

[general]

accounts = personal-mail

[Account personal-mail]

localrepository = local-personal-mail

remoterepository = remote-personal-mail

[Repository local-personal-mail]

type = Maildir

localfolders = /mnt/mail

[Repository remote-personal-mail]

type = IMAP

remotehost = imap.example.com

remoteuser = user123

remotepassfile = /mnt/secret/password.conf

sslcacertfile = /etc/ssl/certs/ca-certificates.crt

```

**password.conf**

```sh

MyPassword123

```

Please notice that this container provides validated CAs in folder shown above.

## Dockerfile

The Dockerfile can be found at:

[https://github.com/maxkratz/docker_offlineimap/blob/main/Dockerfile](https://github.com/maxkratz/docker_offlineimap/blob/main/Dockerfile)

## What gets installed in this container?

The following packages are installed within this docker container:

* Some utility packages like locales, bash-completion, ca-certificates etc.

* [OfflineIMAP](http://www.offlineimap.org/about/) (thats the whole point ...)