You've already forked postfixadmin-fetchmail-docker
fix(ci): replace drone with gitea actions
All checks were successful
All checks were successful
This commit is contained in:
51
README.md
51
README.md
@ -2,21 +2,17 @@
|
||||
|
||||
[](https://hub.docker.com/r/volkerraschek/postfixadmin-fetchmail)
|
||||
|
||||
This project contains all sources to build the container image
|
||||
`docker.io/volkerraschek/postfixadmin-fetchmail`. The primary goal of the image
|
||||
is to fetch mails from external servers and forward them to on local running
|
||||
mail server.
|
||||
This project contains all sources to build the container image `docker.io/volkerraschek/postfixadmin-fetchmail`. The
|
||||
primary goal of the image is to fetch mails from external servers and forward them to on local running mail server.
|
||||
|
||||
The configuration file will be automatically generated based on information from
|
||||
a supported database backend of
|
||||
[postfixadmin](https://github.com/postfixadmin/postfixadmin). The information
|
||||
are stored in the table `fetchmail` of the database scheme of PostfixAdmin.
|
||||
The configuration file will be automatically generated based on information from a supported database backend of
|
||||
[postfixadmin](https://github.com/postfixadmin/postfixadmin). The information are stored in the table `fetchmail` of the
|
||||
database scheme of PostfixAdmin.
|
||||
|
||||
## Usage
|
||||
|
||||
Possible database types are `my` for MySQL and `Pg` for postgres. Make sure that
|
||||
the database and the SMTP server are accessible. Otherwise, adjust the enclosed
|
||||
docker-compose or docker command accordingly. Alternatively you can use
|
||||
Possible database types are `my` for MySQL and `Pg` for postgres. Make sure that the database and the SMTP server are
|
||||
accessible. Otherwise, adjust the enclosed docker-compose or docker command accordingly. Alternatively you can use
|
||||
docker-compose in addition to the docker commands.
|
||||
|
||||
### PostgreSQL
|
||||
@ -51,11 +47,9 @@ $ docker run \
|
||||
|
||||
### docker-compose
|
||||
|
||||
The repository contains a default `docker-compose.yml` file, which can be used
|
||||
to start the container. To set the environment variables you need a `.env` file.
|
||||
The `.dev_env` from this repository can be used for this. This must be located
|
||||
exclusively in the same directory as the `docker-compose.yml` file and must be
|
||||
renamed as `.env`.
|
||||
The repository contains a default `docker-compose.yml` file, which can be used to start the container. To set the
|
||||
environment variables you need a `.env` file. The `.dev_env` from this repository can be used for this. This must be
|
||||
located exclusively in the same directory as the `docker-compose.yml` file and must be renamed as `.env`.
|
||||
|
||||
```yml
|
||||
version: "3"
|
||||
@ -76,9 +70,8 @@ services:
|
||||
|
||||
### DATABASE_TYPE
|
||||
|
||||
Currently will be only postgres, mysql and mariadb supported. About the
|
||||
environment variable `DATABASE_TYPE` can the backend type defined. The value is
|
||||
required.
|
||||
Currently will be only postgres, mysql and mariadb supported. About the environment variable `DATABASE_TYPE` can the
|
||||
backend type defined. The value is required.
|
||||
|
||||
| database type | value |
|
||||
| ------------- | ----- |
|
||||
@ -87,25 +80,25 @@ required.
|
||||
|
||||
### DATABASE_USER
|
||||
|
||||
The environment variable `DATABASE_USER` is undefined and required. The value
|
||||
contains the database user which one fetchmail use to login.
|
||||
The environment variable `DATABASE_USER` is undefined and required. The value contains the database user which one
|
||||
fetchmail use to login.
|
||||
|
||||
### DATABASE_PASSWORD
|
||||
|
||||
The environment variable `DATABASE_PASSWORD` is undefined and required. The value
|
||||
contains the password of the database user which one fetchmail use to login.
|
||||
The environment variable `DATABASE_PASSWORD` is undefined and required. The value contains the password of the database
|
||||
user which one fetchmail use to login.
|
||||
|
||||
### DATABASE_HOST
|
||||
|
||||
The environment variable `DATABASE_HOST` is undefined and required. The value
|
||||
contains the DNS name or IP address of the host, where the database is hosted.
|
||||
The environment variable `DATABASE_HOST` is undefined and required. The value contains the DNS name or IP address of the
|
||||
host, where the database is hosted.
|
||||
|
||||
### DATABASE_PORT
|
||||
|
||||
The environment variable `DATABASE_PORT` is undefined and required. The value
|
||||
contains the port of the host, where the database is listen on.
|
||||
The environment variable `DATABASE_PORT` is undefined and required. The value contains the port of the host, where the
|
||||
database is listen on.
|
||||
|
||||
### DATABASE_NAME
|
||||
|
||||
The environment variable `DATABASE_NAME` is undefined and required. The value
|
||||
contains the name of the database against which should be logged in.
|
||||
The environment variable `DATABASE_NAME` is undefined and required. The value contains the name of the database against
|
||||
which should be logged in.
|
||||
|
Reference in New Issue
Block a user