https://github.com/maxkratz/docker_offlineimap
Offlineimap dockerfile.
https://github.com/maxkratz/docker_offlineimap
docker docker-image dockerfile imap imap-client offlineimap
Last synced: 8 months 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 (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-10-09T06:04:41.000Z (over 1 year ago)
- Last Synced: 2025-04-09T08:05:58.129Z (about 1 year ago)
- Topics: docker, docker-image, dockerfile, imap, imap-client, offlineimap
- Language: Dockerfile
- Homepage:
- Size: 21.5 KB
- Stars: 11
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# docker_offlineimap
[](https://github.com/maxkratz/docker_offlineimap/actions/workflows/build-tag.yml)
[](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 ...)