Difference between revisions of "Phplist"

From SME Server
Jump to navigationJump to search
 
(37 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 +
{{Languages}}
 +
<!-- here we define the contrib name variable -->
 +
<!-- we get the page title, remove suffix for translated version; if needed you can define there with the value you want-->
 +
{{#vardefine:contribname| {{lc: {{#titleparts:  {{BASEPAGENAME}} |1}} }} }}
 +
{{#vardefine:smecontribname| smeserver-{{lc: {{#titleparts:  {{BASEPAGENAME}} |1}} }} }}
 +
<!-- we define the language -->
 +
{{#vardefine:lang| {{lc:  {{#titleparts:    {{PAGENAME}} | | -1}}  }} |en }}
 +
 +
 +
{{Infobox contribs
 +
|name={{#var:contribname}}
 +
|image={{#var:contribname}}.png
 +
|description_image= {{#var:contribname}} logo
 +
|maintainer=
 +
|licence=
 +
|url= https://discuss.phplist.org
 +
|category= mailinglist
 +
|tags=mailinglist
 +
}}
 +
 
== Phplist Contribs ==
 
== Phplist Contribs ==
  
 
===Maintainer===
 
===Maintainer===
−
[mailto:pierre@firewall-services.com[[User:pierre|Pierre B.]]] from [http://www.firewall-services.com Firewall Services]
+
 
 +
[mailto:daniel@firewall-services.com[[User:VIP-ire|Daniel B.]]] from [http://www.firewall-services.com Firewall Services]
 +
===Version===
 +
{{#smeversion: smeserver-phplist }}
 +
{{#smeversion: phplist }}
 +
[[Version::Contrib9| fws]] [[Has SME9::true| ]]
  
 
=== Description ===
 
=== Description ===
−
Phplist is an OpenSources Mailing List tool. It's a web application who is using Php and Mysql to work.
+
[https://www.phplist.com/ '''phpList'''] is an open source software for managing mailing lists. It is designed for the dissemination of information, such as newsletters, news, advertising to list of subscribers. It is written in PHP and uses a MySQL database to store the information.
  
−
It can be setup on SmeServer with the contrib smeserver-phplist.
+
=== Requirements ===
 +
You need the [[Fws|firewall-services]] repo to install this contribs
  
 
=== Installation ===
 
=== Installation ===
 +
<tabs container><tab name="For SME 10">
 +
yum install --enablerepo=smecontribs smeserver-phplist
 +
</tab><tab name="For SME 8.x 9.x">
 +
{{Warning box|Versions of PHPList above 3.2.x will no longer run on the PHP version included in the stock version of SME v9. See: https://sourceforge.net/p/phplist/mailman/message/35670118/. Please refer to [[PHP_Software_Collections]] on how to install PHP 5.6 or higher.}}
  
−
{{Note box| To begin, be sure you have the right repository setup on your system.
+
This contrib is currently held in the fws repository, so the following commands will install on your smeserver.
−
In my example, I will use the firewall-Services repository.}}
 
−
 
 
−
First, install the smeserver-phplist package. The dependencies will do the others tasks.
 
−
 
 
−
This will install two packages, on for Phplist, and the second to adapt Phplist for SmeServer.
 
−
 
 
−
  [root@sme8 ~]# yum install --enablerepo=fws smeserver-phplist
 
−
 
 
−
=== Configuration ===
 
−
 
 
−
You need to update your httpd.conf to define the alias in Apache.
 
−
 
 
−
  [root@sme8 ~]# expand-template /etc/httpd/conf/httpd.conf
 
−
 
 
−
Then restart Apache.
 
−
 
 
−
  [root@sme8 ~]# sv t /service/httpd-e-smith/
 
−
 
 
−
Initialise the Mysql template database
 
−
 
 
−
  [root@sme8 ~]# expand-template /etc/e-smith/sql/init/phplistdb
 
−
 
 
−
Then execute the script.
 
−
 
 
−
  [root@sme8 ~]# sh /etc/e-smith/sql/init/phplistdb
 
  
−
In the last time, you need to set up the config.php of phplist.
+
yum install --enablerepo=fws smeserver-phplist
  
−
  [root@sme8 ~]# expand-template /usr/share/phplist/www/lists/config/config.php
+
You will then need to activate the database changes etc.
 +
The 'official' way is to perform
  
 +
signal-event post-upgrade;  signal-event reboot
  
 +
or if you do not want to restart your computer
  
−
'''OR
+
signal-event webapps-update
−
'''
+
</tab>
−
  [root@sme8 ~]# signal-event webapps-update
+
</tabs>
  
−
=== Other thing to do ===
 
  
−
== The bounces account ==
+
There is no panel in the server-manager, you can go to https://sme-ip/lists/admin and login as SME Server admin and its password.
  
−
We need, to have Phplist working well, to create an account "bounces@youdomain.tld".
+
==== Configuration ====
 +
{| class="wikitable"
 +
|+
 +
!db
 +
!key
 +
!property
 +
!default
 +
!accepted
 +
!information
 +
|-
 +
| rowspan="7" |configuration
 +
| rowspan="7" |phplist
 +
|status
 +
|enabled
 +
|<nowiki>enabled|disabled</nowiki>
 +
|
 +
|-
 +
|access
 +
|private
 +
|<nowiki>public|private</nowiki>
 +
|public for all web. private for local + httpd-admin ValidFrom
 +
|-
 +
|Authentication
 +
|http
 +
|<nowiki>http|</nowiki>
 +
|use http auth to login (broken)
 +
|-
 +
|AliasOnPrimary
 +
|enabled
 +
|<nowiki>enabled|disabled</nowiki>
 +
|create an alias lists. might disable if you use a dedicated domain using webapp virtualhost
 +
|-
 +
|AdminPass
 +
|
 +
|
 +
|password to access as primary "admin" to phplist
 +
|-
 +
|DbName
 +
|
 +
|
 +
|
 +
|-
 +
|DbUser
 +
|
 +
|
 +
|
 +
|}
  
−
We have to setup a password for this account.
+
==== Administration ====
  
−
To configure the Bounces account in Phplist :
+
To access the installation you have to go https://yourserver.tld/lists/admin. Use user admin with password
 +
config getprop  phplist AdminPass
  
−
  [root@sme8 ~]# db configuration setprop phplist BouncesPassword the_password
+
You will then be able to configure your phplist organization, plugins and so on.
−
  [root@sme8 ~]# signal-event webapps-update
 
  
−
== Access to the Administrator Panel ==
 
  
−
By default, only '''admin''' user can access to the administrotor panel.
+
The administrator interface is at https://yourserver.tld/lists/admin
  
−
To add new users, you can add login in the DB :
+
The user interface is at https://yourserver.tld/lists
  
−
  [root@sme8 ~]# db configuration setprop phplist AdminUsers user1,user2,user3,fws,admin
+
you can also use the cli to set some elements
−
  [root@sme8 ~]# signal-event webapps-update
 
  
 +
phplist -pdbcheck
  
−
=== Administrate ===
+
here is the list of options
 +
    initialise
 +
    dbcheck
 +
    send
 +
    processqueue
 +
    processbounces
 +
    import
 +
    upgrade
 +
    convertstats
 +
    reindex
 +
    blacklistemail
 +
    systemstats
 +
    converttoutf8
 +
    initlanguages
 +
    cron
 +
    updatetlds
 +
    export
 +
    runcommand
  
−
Now you can access Phplist, you have just to go https://yourserver.tld/lists
+
==== Uninstall ====
 +
yum remove smeserver-phplist
 +
signal-event post-upgrade;  signal-event reboot
 +
==== Bugs ====
 +
Please raise bugs under the SME-Contribs section in {{BugzillaFileBug|product=|component=|title= bugzilla}}
 +
and select the {{#var:smecontribname}} component or use {{BugzillaFileBug|product=SME%20Contribs|component={{#var:smecontribname}}|title=this link}}
  
−
The administrator interface was at https://yourserver.tld/lists/admin
+
Below is an overview of the current issues for this contrib:{{#bugzilla:columns=id,product,version,status,summary|sort=id|order=desc|component={{#var:smecontribname}} |noresultsmessage=No open bugs found.}}
  
−
The last step is to populate the database.
+
===Changelog===
 +
Only released version in smecontrib are listed here.
  
−
Go in the administation panel, and follow the Phplist instruction.
+
{{ #smechangelog: {{#var:smecontribname}} }}
  
 
[[Category:Contrib]]
 
[[Category:Contrib]]
 +
[[Category:Mail]]
 +
[[Category:Mail:Mailinglists]]

Latest revision as of 06:53, 3 August 2022

Geographylogo.png Languages: 

English






phplist
NeedImage.svg
phplist logo
Urlhttps://discuss.phplist.org
Category

mailinglist

Tags mailinglist


Phplist Contribs

Maintainer

Daniel B. from Firewall Services

Version

Contrib 10:
smeserver-phplist
The latest version of smeserver-phplist is available in the SME repository, click on the version number(s) for more information.


Contrib 10:
phplist
The latest version of phplist is available in the SME repository, click on the version number(s) for more information.


fws

Description

phpList is an open source software for managing mailing lists. It is designed for the dissemination of information, such as newsletters, news, advertising to list of subscribers. It is written in PHP and uses a MySQL database to store the information.

Requirements

You need the firewall-services repo to install this contribs

Installation

yum install --enablerepo=smecontribs smeserver-phplist
Warning.png Warning:
Versions of PHPList above 3.2.x will no longer run on the PHP version included in the stock version of SME v9. See: https://sourceforge.net/p/phplist/mailman/message/35670118/. Please refer to PHP_Software_Collections on how to install PHP 5.6 or higher.

This contrib is currently held in the fws repository, so the following commands will install on your smeserver. 

yum install --enablerepo=fws smeserver-phplist

You will then need to activate the database changes etc. The 'official' way is to perform 

signal-event post-upgrade;  signal-event reboot

or if you do not want to restart your computer 

signal-event webapps-update


There is no panel in the server-manager, you can go to https://sme-ip/lists/admin and login as SME Server admin and its password.

Configuration

db key property default accepted information
configuration phplist status enabled enabled|disabled
access private public|private public for all web. private for local + httpd-admin ValidFrom
Authentication http http| use http auth to login (broken)
AliasOnPrimary enabled enabled|disabled create an alias lists. might disable if you use a dedicated domain using webapp virtualhost
AdminPass password to access as primary "admin" to phplist
DbName
DbUser

Administration

To access the installation you have to go https://yourserver.tld/lists/admin. Use user admin with password 

config getprop  phplist AdminPass

You will then be able to configure your phplist organization, plugins and so on.


The administrator interface is at https://yourserver.tld/lists/admin

The user interface is at https://yourserver.tld/lists

you can also use the cli to set some elements 

phplist -pdbcheck

here is the list of options 

    initialise
    dbcheck
    send
    processqueue
    processbounces
    import
    upgrade
    convertstats
    reindex
    blacklistemail
    systemstats
    converttoutf8
    initlanguages
    cron
    updatetlds
    export
    runcommand

Uninstall

yum remove smeserver-phplist
signal-event post-upgrade;  signal-event reboot

Bugs

Please raise bugs under the SME-Contribs section in bugzilla

and select the smeserver-phplist component or use this link


Below is an overview of the current issues for this contrib:

IDProductVersionStatusSummary (2 tasks) ⇒
12138SME Contribs10.0CONFIRMEDNFR ldap access
12137SME Contribs10.0CONFIRMEDwhen login with http auth login is asked again in app

Changelog

Only released version in smecontrib are listed here.

smeserver-phplist Changelog: SME 10 (smecontribs)
2022/08/03 Jean-Philippe Pialasse 0.2.1-3.sme
- make http auth not the default.
2022/08/02 Jean-Philippe Pialasse 0.2.1-2.sme
- ported to SME10
2020/03/18 Daniel Berteaud 0.2.1-1
- new package built with tito

2014/07/30 Daniel Berteaud 0.2.0-1
- Nearly complete rewrite
- Change the way bounces are processed
- Add a daemon to process the queue and the bounces

- Requires phplist 3.0.6
2010/12/31 Daniel Berteaud 0.1-3
- Fix typo in BouncesPassword prop name
Retrieved from "https://wiki.koozali.org/index.php?title=Phplist&oldid=41532"