Download the PHP package foorschtbar/dovecot_client_ip without Composer

On this page you can find all versions of the php package foorschtbar/dovecot_client_ip. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of foorschtbar/dovecot_client_ip

Informations about the package dovecot_client_ip

Dovecot Client IP for Roundcube

Provides the HTTP client IP during IMAP connect to Dovecot in the form of an IMAP identifier for proper authentication penalty processing.

In reverse proxy configurations the actual client IP is resolved if the request originates from a trusted proxy.

Installation

The plugin can either be installed via Composer or manually. If the webmail server allows outgoing requests, Composer is the more comfortable option as it automatically resolves dependencies and simplifies updates.

Using Composer

⚠️ Note that it is not recommended to run Composer as root. Plugin installation requires script support enabled, as the RoundCube installer needs to move the downloaded plugin to the plugins directory and optionally can enable the plugin automatically.

  1. Get [Composer][getcomposer].

  2. Within the RoundCube webmail root directory, add a new dependency to the plugin.

  3. Composer may ask whether to enable the plugin. Confirm with y.

To update the installed plugin to the latest version, simply run:

Manual

  1. Download the latest release archive or checkout the latest release branch.
  2. Extract the contents into a folder named dovecot_client_ip within the plugins directory of your RoundCube installation.

There are no external dependencies.

Repeat manual installation for updates. It may be advisable to keep multiple versions of the plugin in separate folders and use a symlink named dovecot_client_ip from within the plugins directory to the latest version folder instead.

Configuration

To enable the plugin, add dovecot_client_ip to the $config['plugins'] array in the RoundCube configuration file.
When using Composer, the installation routine will ask whether to automatically enable the plugin.

Options

Copy the configuration variables from config.inc.php.dist to your global config.inc.php or create a new file named config.inc.php in the plugin directory and adjust the settings to your needs.

Environment Variables

Configuration can also be overridden using environment variables:

Environment variables take precedence over settings in the config files.

Dovecot IMAP

The following settings need to be applied to the Dovecot IMAP server:

  1. Add the IP addresses or networks of your RoundCube webmail servers to the login_trusted_networks setting in your Dovecot IMAP configuration. This disables authentication penalty processing for the configured webmail server IPs and enables processing of the X-Originating-IP ident value with the actual client IP provided by this plugin.
  2. Restart Dovecot IMAP.

Afterwards, Dovecot connection logs should show the actual client IP of users instead of the webmail server IP in the rip (remote IP) field.

Credits

The original plugin was created by Michael Maier and is licensed under the GNU General Public License v3 or higher. I added the network (CIDR) support for the trusted proxies, renamed the plugin to remove the unnecessary roundcube- prefix and moved the project to GitHub.

All versions of dovecot_client_ip with dependencies

PHP Build Version
Package Version
Requires php Version >=5.6.0
roundcube/plugin-installer Version >=0.3.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package foorschtbar/dovecot_client_ip contains the following files

Loading the files please wait ....