-
Notifications
You must be signed in to change notification settings - Fork 48
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
32 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,33 +1,45 @@ | ||
# Persistent Login (Roundcube) | ||
This server-side plugin is useful for all Roundcube users who don’t like to log into their mail account each time they open their browser. The plugin stores a persistent login cookie which automatically logs the user in the next time he or she visits the [Roundcube](http://roundcube.net/) web mailer. | ||
This server-side plugin is useful for all Roundcube users who don’t | ||
like to log into their mail account each time they open their browser. | ||
The plugin stores a persistent login cookie which automatically logs | ||
the user in the next time he or she visits the [Roundcube][roundcube] web mailer. | ||
|
||
## Screenshots | ||
![Login](docs/screen-001.jpg) | ||
![Login with Larry Skin](docs/login_larry.png) | ||
|
||
## Download | ||
You can download the plugin from the [Sourceforge project page.](https://sourceforge.net/projects/rcmailifpl/files/) | ||
|
||
Sources from [GitHub.](https://github.com/mfreiholz/Roundcube-Persistent-Login-Plugin) | ||
You can download the plugin from the latest [release tags][github-release] on GitHub. | ||
|
||
## Installation | ||
__Step 1:__ Extract the “persistent_login” folder into roundcube’s plugin directory `<roundcube>/plugins/`. | ||
|
||
__Step 2:__ Open the Roundcube main configuration file `<roundcube>/config/main.inc.php` and add the plugin’s name to the active plugins array (See screenshot): | ||
- Extract the downloaded archive into Roundcube’s plugin directory | ||
`<roundcube>/plugins/` and rename it to `persistent_login`. | ||
|
||
![Config file](docs/ifpl_main_config.png) | ||
- Open the Roundcube's main configuration file `<roundcube>/config/main.inc.php` | ||
and add the plugin’s name to the active plugins array, e.g.: | ||
|
||
### Update to version 2.0 (from all < 2.0) | ||
If you use the AuthToken based authentication, than you have to open the \*.sql script in the plugin’s `sql/` folder and execute each statement which is listed under the “Update Version 2.0″ section. | ||
|
||
That’s all! | ||
```php | ||
// List of active plugins (in plugins/ directory) | ||
$config['plugins'] = array('persistent_login'); | ||
``` | ||
|
||
## Configuration | ||
The plugin provides two different ways of usage. User-Data cookie or AuthToken cookie based. | ||
Persistent Login provides two different ways of usage. | ||
User-Data cookie or AuthToken cookie based. | ||
|
||
### UserData cookie (No database extension required) | ||
This method doesn’t require any configuration, it is enabled by default. It stores the user’s login information encrypted in a cookie. | ||
This method doesn’t require any configuration, it is enabled by default. | ||
It stores the user’s login information encrypted in a cookie. | ||
|
||
### AuthToken cookie (more secure, recommended) | ||
This method have to be enabled in the plugins configuration file. It requires the creation of a table in your __roundcubemail’s database__ as well. The table can be created by the SQL script in the `sql/` directory of the plugin. Execute ALL statements from the SQL file. | ||
|
||
![Config file AuthToken](docs/ifpl_plugin_config_authtoken.png) | ||
This method have to be enabled in the plugins configuration file. | ||
It requires the creation of a table in your __roundcubemail’s database__ as well. | ||
The table can be created by the SQL script in the `sql/` directory of the plugin. | ||
Execute ALL statements from the SQL file. | ||
|
||
Enable it in config: `persistent_login/config.inc.php` | ||
```php | ||
// Turn on feature to use tokens. | ||
$rcmail_config['ifpl_use_auth_tokens'] = true; | ||
``` | ||
|
||
[roundcube]: http://roundcube.net/ | ||
[github-release]: https://github.com/mfreiholz/Roundcube-Persistent-Login-Plugin/releases |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.