doc/vendors.rst

   1 Distributing and packaging phpMyAdmin
   2 =====================================
   3
   4 This document is intended to give pieces of advice to people who want to
   5 redistribute phpMyAdmin inside other software packages such as Linux
   6 distribution or some all in one package including web server and MySQL
   7 server.
   8
   9 Generally, you can customize some basic aspects (paths to some files and
  10 behavior) in :file:`libraries/vendor_config.php`.
  11
  12 For example, if you want setup script to generate a config file in var, change
  13 ``SETUP_CONFIG_FILE`` to :file:`/var/lib/phpmyadmin/config.inc.php` and you
  14 will also probably want to skip directory writable check, so set
  15 ``SETUP_DIR_WRITABLE`` to false.
  16
  17 External libraries
  18 ------------------
  19
  20 phpMyAdmin includes several external libraries, you might want to
  21 replace them with system ones if they are available, but please note
  22 that you should test whether the version you provide is compatible with the
  23 one we ship.
  24
  25 Currently known list of external libraries:
  26
  27 js/vendor
  28     jQuery js framework libraries and various js libraries.
  29
  30 vendor/
  31     The download kit includes various Composer packages as
  32     dependencies.
  33
  34 Specific files LICENSES
  35 -----------------------
  36
  37 phpMyAdmin distributed themes contain some content that is under licenses.
  38
  39 - The icons of the `Original` and `pmahomme` themes are from the `Silk Icons <http://www.famfamfam.com/lab/icons/silk/>`_.
  40 - Some icons of the `Metro` theme are from the `Silk Icons <http://www.famfamfam.com/lab/icons/silk/>`_.
  41 - `themes/*/img/b_rename.svg` Is a `Icons8 <https://thenounproject.com/Icons8/>`_, icon from the `Android L Icon Pack Collection <https://thenounproject.com/Icons8/collection/android-l-icon-pack/>`_. The icon `rename <https://thenounproject.com/term/rename/61456/>`_.
  42 - `themes/metro/img/user.svg` Is a IcoMoon the `user <https://github.com/Keyamoon/IcoMoon-Free/blob/master/SVG/114-user.svg>`_
  43
  44 CC BY 4.0 or GPL
  45
  46 Licenses for vendors
  47 --------------------
  48
  49 - Silk Icons are under the `CC BY 2.5 or CC BY 3.0 <http://www.famfamfam.com/lab/icons/silk/>`_ licenses.
  50 - `rename` from `Icons8` is under the `"public domain" <https://creativecommons.org/publicdomain/zero/1.0/>`_ (CC0 1.0) license.
  51 - IcoMoon Free is under `"CC BY 4.0 or GPL" <https://github.com/Keyamoon/IcoMoon-Free/blob/master/License.txt>`_.