diff options
author | Felipe Figueroa <amenadiel@gmail.com> | 2018-04-23 21:19:40 +0300 |
---|---|---|
committer | Felipe Figueroa <amenadiel@gmail.com> | 2018-04-23 21:19:40 +0300 |
commit | 03f07639b90743d6c664a5a244f12b86aaafb1ac (patch) | |
tree | 0857d147061ad882f7679a0a70775490c167a0bf /docs | |
parent | 62218e3d0e78780a460819f6b4ccc45fc8c972a7 (diff) |
moving docs to their own folder
Diffstat (limited to 'docs')
-rw-r--r-- | docs/BUGS.md | 7 | ||||
-rw-r--r-- | docs/CHANGELOG.md | 30 | ||||
-rw-r--r-- | docs/CREDITS.md | 108 | ||||
-rw-r--r-- | docs/DEVELOPERS.md | 132 | ||||
-rw-r--r-- | docs/FAQ.md | 217 | ||||
-rw-r--r-- | docs/HISTORY.md | 849 | ||||
-rw-r--r-- | docs/INSTALL.md | 73 | ||||
-rw-r--r-- | docs/TODO.md | 7 | ||||
-rw-r--r-- | docs/TRANSLATORS.md | 55 |
9 files changed, 1478 insertions, 0 deletions
diff --git a/docs/BUGS.md b/docs/BUGS.md new file mode 100644 index 00000000..76e3006e --- /dev/null +++ b/docs/BUGS.md @@ -0,0 +1,7 @@ +Bugs List +------------------ + +Please submit any bugs or feature requests to the github repository: + +https://github.com/HuasoFoundries/phpPgAdmin6 + diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md new file mode 100644 index 00000000..d3aed1bf --- /dev/null +++ b/docs/CHANGELOG.md @@ -0,0 +1,30 @@ +# Changelog + +This section is incomplete. I hope some day it will be up to date. + +### v6.0.0-alpha1 + +- the app was fully refactored adding: + - namespaces + - proper (yet arbitrary :sad:) folder hierarchy + - separate files for separate classes +- strips the use of require and include to the bare minimum +- drops support for PHP < 5.4. +- provides full composer compatibility +- PSR-4 autoloading +- makes requirement checks for PHP version and ext-pgsql + + +### v6.0.0-alpha2 + +- most entrypoints were moved to `src/views` and do now instance a controller, then call one of its methods depending on the `action` parameter +- due to this, entrypoint logic was moved into controller classes in `src/controllers` +- usage of global variables is being replaced by member properties and usage of `use` where is due. +- usage of global functions is being replaced by anonymous fuctions +- usage of explicit includes/requires is being replaced by composer's autoloader (except for `src/lib.inc.php`) +- global decorator functions are being replaced by static methods of the Decorator class. + +### v6.0.0-beta2 + +- moves HTML printing methods to their own class, which is in turn used by controllers +- this is the last release that will support the "processes" view for Postgres 9.5, b/c *pg_stat_activity* has changed its structure in PG 9.6.
\ No newline at end of file diff --git a/docs/CREDITS.md b/docs/CREDITS.md new file mode 100644 index 00000000..9c1ac136 --- /dev/null +++ b/docs/CREDITS.md @@ -0,0 +1,108 @@ +CREDITS +------- + +Project Administration & Major Projects + +- Robert Treat (xzilla) +- Jehan-Guillaume (ioguix) De Rorthais + +Translators + +- Kuo Chaoyi (Chinese Utf8) +- Angelo Rigo (Brazilan Portuguese) +- Chan Min Wai (Chinese) +- He Wei Ping (Chinese) +- Chih-Hsin Lee (Trad. Chinese) +- Hugo Jonker (Dutch) +- Pascal Peyre (French) +- Guillaume Lelarge (French) +- ioguix (French) +- H. Etzel, Markus Bertheau (German) +- Kalef (Italian) +- Tadashi Jokagi (Japanese) +- Rafal Slubowski (Polish) +- Alexander Khodorisky (Russian) +- Martin Marqués (Spanish) +- Andrej Misovic (Slovak) +- Devrim Gunduz (Turkish) +- Libor Vanek (Czech) +- Marek Cernocký (Czech) +- Stefan Malmqvist (Swedish) +- Nicola Soranzo (Italian) +- Petri Jooste (Afrikaans) +- Sulyok Péter (Hungarian) +- Zaki Almuallim (Arabic) +- Erdenemandal Bat-Erdene (Mongolian) +- Alex Rootoff (Ukrainian) +- Jonatan (Hebrew) +- Alin Vaida (Romanian) +- Arne Eckmann (Danish) +- Francisco Cabrita (Portuguese) +- Bernat Pegueroles (Catalan) +- Fernando Wendt (Brazilan Portuguese) +- Adamantios Diamantidis (Greek) +- Marek ¿ernocký (Czech) +- Alexey Baturin (Russian UTF8) +- Adrián Chaves Fernández (Galician) + +Look & Feel + +- Davey (CSS) +- ioguix (Cappuccino theme) +- Tomasz Pala (Gotar theme) +- Felipe Figueroa (Bootstrap theme) + +Contributors + +- Dan Wilson +- Christopher Kings-Lynne +- Felix Meinhold +- Jean-Michel Poure +- Rafal Slubowski +- Brett Toolin +- Mark Gibson (Pop-up SQL window) +- Nicola Soranzo +- Oliver Meyer & Sven Kiera (Table icons link to browse table) +- Bryan Encina (SQL window improvements, bug fixes, admin) +- Dan Boren (Object comments) +- Adrian Nida (Fix time outs) +- Russell Smith +- Guillaume Lelarge +- Ian Barwick +- Javier Carlos +- Eric Kinolik +- John Jawed +- Karl O. Pinc +- Tomasz Pala +- Ivan Zolotukhin +- Kristoffer `spq` Janke +- Leonardo Augusto Sapiras (Improve phpPgAdmin ergonomy during the GSoC 2010, with ioguix as mentor) +- Julien Rouhaud, aka. rjuju (nested groups) +- Felipe Figueroa aka. amenadiel + +Third Party Libraries + +- Highlight.php (Jacob D. Cohen of rafb.net) +- XLoadTree2 (Erik Arvidsson & Emil A Eklund of webfx.eae.net) +- jQuery (http://jquery.com/) + +Corporate Sponsors + +Project resources: + +- Sourceforge.net - Hosting, source package provider, Bug and Feature request tracker, hosting mailing lists (and ex code repository) +- github.com - Official GIT repository hosting +- Kattare Internet (http://www.kattare.com/) - Hosting the demo server + +Ongoing contributors: + +- OmniTI ( http://omniti.com/ ) - sponsors developpment as Robert Treat employer +- Dalibo ( http://dalibo.com ) - sponsors developpment as Jehan-Guillaume (ioguix) de Rorthais employer + +Feature contributors: + +- SpikeSource (www.spikesource.com) - Slony support +- Google Summer of Code (http://code.google.com/soc/2006/pgsql/appinfo.html?csaid=DB096D908B948D89) - phpPgAdmin Improvements +- Google Summer of Code (http://code.google.com/soc/2007/postgres/appinfo.html?csaid=E89B3D5E2DC4170A) - Full Text Search in PostgreSQL GUI Tools +- Google Summer of Code (http://code.google.com/p/google-summer-of-code-2010-postgres/downloads/detail?name=Leonardo_Augusto_Sapiras.tar.gz) - Improve phpPgAdmin ergonomy + diff --git a/docs/DEVELOPERS.md b/docs/DEVELOPERS.md new file mode 100644 index 00000000..16fc2ac7 --- /dev/null +++ b/docs/DEVELOPERS.md @@ -0,0 +1,132 @@ +## DEVELOPER INFO +-------------- + +phpPgAdmin6 is Free/Open Source software and contributions are welcome. + +It is a hard fork of phpPgAdmin: + https://github.com/phppgadmin/phppgadmin + http://phppgadmin.sourceforge.net/doku.php + +The main focus / need addressed by this fork was to move the project from an out-dated code-base to modern, standards compliant and namespaced code. + +## SOURCE REPOSITORY +----------------- + +phpPgAdmin6 uses git for source control management. The phpPgAdmin6 git repository +is hosted at github: + + https://github.com/HuasoFoundries/phpPgAdmin6 + +To clone the phpPgAdmin source to your development system, execute the following +command: + + git clone git://github.com/HuasoFoundries/phpPgAdmin6.git + +After making changes, you can clone the phppgadmin repository on github and make a pull +request. For details on how to make pull requests, see: + + https://help.github.com/articles/using-pull-requests + +Please note that submitting code is considered a transfer of copyright to the +phpPgAdmin6 project. phpPgAdmin6 is made available under the GPL v2 license. + +Push access to the main phpPgAdmin6 git repository can be granted to developers +with a track record of useful contributions to phpPgAdmin6 at the discretion +of the phpPgAdmin6 development team. + +## TIPS FOR DEVELOPERS +------------------- + +When you submit code to phpPgAdmin6, format to PSR/2 Coding Style Guide. + +http://www.php-fig.org/psr/psr-2/ + +Test your code properly! For example, if you are developing a feature to create +domains, try naming your domain all of the following: + + * " + * ' + * \ + * words with spaces + * <br><br><br> + +Don't forget to make sure your changes still pass the existing Selenium test +suite. Additionally, you should add or update the test suite as needed to +cover your new features. + +If you are adding a new class function, be sure to use the "clean", +"fieldClean", "arrayClean" and "fieldArrayClean" functions to properly escape +odd characters in user input. Examine existing functions that do similar +things to yours to get yours right. + +When writing data to the display, you should always urlencode() variables in +HREFs and htmlspecialchars() variables in forms. Rather than use action="" +attributes in HTML form elements use action="thisformname.php". This +ensures that browsers remove query strings when expanding the given +relative URL into a full URL. + +When working on database classes, always schema qualifing your SQL where it is +possible with the current schema *$data->_schema* for pg73+ classes. Then don't +forget to write your method for older classes which doesn't suppport schemas. +When working with git, always make sure to do a 'git pull' both before you +start; so you have the latest code to work with; and also again before you +create your patch; to minimize the chance of having conflicts. If you plan to +submit your code via github pull requests, we strongly recommend doing your +work in a feature specific branch. If you want to submit multiple patches, +they should all live in thier own branch. Remeber, smaller changes are easier +to review, approve, and merge. + + +## COMMON VARIABLES +---------------- + +$data - A data connection to the current or default database. +$misc - Contains miscellaneous functions. eg. printing headers & footers, etc. +$lang - Global array containing translated strings. The strings in this array + have already been converted to HTML, so you should not + htmlspecialchars() them. +$conf - Global array of configuration options. + +## WORKING WITH RECORDSETS +----------------------- + +phpPgAdmin uses the ADODB database library for all its database access. We have +also written our own wrapper around the ADODB library to make it more object +oriented (ADODB_base.pclass). + +This is the general form for looping over a recordset: + +$rs = $class->getResults(); +if (is_object($rs) && $rs->recordCount() > 0) { + while (!$rs->EOF) { + echo $rs->fields['field']; + $rs->moveNext(); + } +} +else echo "No results."; + +## UPDATING LANGUAGE FILES FOR THE MONO-LINGUAL +-------------------------------------------- + +If you need to add or modify language strings for a new feature, the preferred +method is: + +* cd into lang/ subdirectory +* modify english.php file only! + +If you've done it correctly, when you create your patch, it should only have +diffs of the lang/english.php file. For more information on how the language +system works, please see the TRANSLATORS file. + + +## UNDERSTANDING THE WORK/BRANCH/TAG/RELEASE PROCESS +------------------------------------------------- + +All new work for phpPgAdmin6 is done against the git develop branch. When we release a new revision, we tag that at release time using semantic versioning. + +## GETTING HELP +------------ + +Use github issues to discuss development, such as proposing new features. + +https://github.com/HuasoFoundries/phpPgAdmin6/issues
\ No newline at end of file diff --git a/docs/FAQ.md b/docs/FAQ.md new file mode 100644 index 00000000..20d17d8e --- /dev/null +++ b/docs/FAQ.md @@ -0,0 +1,217 @@ +phpPgAdmin6 Frequently Asked Questions +------------------------------------- + +Installation errors +------------------- + +Q: I've installed phpPgAdmin6 but when I try to use it I get an error message + telling me that I have not compiled proper database support into my + PHP installation. + +A: This means that you have not properly compiled Postgres support into + your PHP. The correct configure flag to use is '--with-pgsql'. Read the + PHP manual and website for more help with this. + + Postgres support can be also compiled into PHP as a dynamic extension, + so if you have precompiled version (Linux RPM, or Windows binary), there + are still chances, that only thing you should do is to enable loading it + automagically. + + It can be done by editing your php.ini file (under Windows, usually in + C:\WINDOWS or C:\WINNT, under Linux /etc/php.ini) and uncommenting this + line: + + ;extension=php_pgsql.dll ;under Windows + ;extension=pgsql.so ;under Linux + + so it would look like that: + + extension=php_pgsql.dll ;under Windows + extension=pgsql.so ;under Linux + + In Linux distributions based on Red Hat or Fedora, PHP extensions are + automatically configured in /etc/php.d/pgsql.ini, simply install the + php-pgsql package. + + See http://www.php.net/manual/en/pgsql.setup.php for more information + on setting up Postgres support in PHP. + +Q: I get a warning like this when using phpPgAdmin6 on Windows: + + "Warning: session_start() [function.session-start]: + open(/tmp\sess_5a401ef1e67fb7a176a95236116fe348, O_RDWR) failed" + +A: You need to edit your PHP.INI file (usually in c:\windows) and change this + line: + + session.save_path = "/tmp" + + to: + + session.save_path = "c:\windows\temp" + + And make sure that the folder c:\windows\temp actually exists. + + +Login errors +------------ + +Q: I always get "Login failed" even though I'm _sure_ I'm using the right + username and password. + +A: There are a number of reasons why you might not be able to connect, typically + having nothing to do with phpPgAdmin6 itself. First check the Postgres log + on your server, it should contain a FATAL error message detailing the exact + reason why the login is failing. You will probably need to either adjust the + username or password, add LOGIN permissions to the role, or adjust your + pg_hba.conf file in your Postgres data dir; so follow the directions laid + out in the FATAL message. + + If you do not have any FATAL error messages, and you have verified that you + are looking at the properly configured logfile, then this means you are not + connecting to your database. If you are connecting via TCP/IP sockets (for + example if you have installed phpPgAdmin6 on a different computer than your + database) make sure that Postgres is accepting connection over TCP/IP. On + older versions of Postgres, you need to change this line in your + postgresql.conf file: + + #tcpip_socket = false + + to: + + tcpip_socket = true + + on newer versions of Postgres, this setting has been replaced by the + listen_addresses setting, so you will need to change that setting instead + (likely changing it to "*"). Be sure to restart Postgres after changing + either of these settings! + + If that still doesn't get you connected, then there is likely something + interfering between PHP and Postgres. Check to make sure that you don't have + a firewall preventing connectivity, or that you don't have some other + security setup (ie. SELinux policy) that prevents PHP from connecting. + +Q: For some users I get a "Login disallowed for security" message. + +A: Logins via phpPgAdmin6 with no password or certain usernames (pgsql, + postgres, root, administrator) are denied by default. Before changing this + behaviour (setting $conf['extra_login_security'] to false in the + config.inc.php file) please read the Postgres documentation about client + authentication and understand how to change Postgres's pg_hba.conf to + enable passworded local connections. + +Q: I can use any password to log in! + +A: Postgres, by default, runs in trust mode. That means that it doesn't + ask for passwords for local connections. We highly recommend that you + edit your pg_hba.conf file, and change the login type to 'md5'. Note + that if you change the 'local' login type to 'md5', then you might need + to enter a password to start Postgres. Get around this by using a + .pgpass file - explained in the Postgres documentation. + + +Other errors +------------ + +Q: When I enter non-ASCII data into the database via a form, it's inserted + as hexadecimal or Ӓ format! + +A: You have not created your database in the correct encoding. This problem + will occur when you try to enter an umlaut into an SQL_ASCII database, or + SJIS Japanese into an EUC-JP database, etc. + +Q: When I drop and re-create a table with the same name, it fails. + +A: You need to drop the sequence attached to the SERIAL column of the table + as well. Postgres 7.3 and above do this automatically. If you have + upgraded to Postgres 7.3 from an earlier version, you need to run the + contrib/adddepend script to record all dependencies. + +Q: When browsing a table, the 'edit' and 'delete' links do not appear. + +A: In order, phpPgAdmin6 will prefer the following as unique row identifiers: + + 1. Primary keys + 2. Unique keys (cannot be parital or expressional indexes) + 3. OID column (will require a sequential scan to update, unless you + index the OID column) + + Furthermore, any NULL values in the unique index will mean that that row + will be uneditable. Also, since OIDs can become duplicated in a table, + phpPgAdmin6 will alter the row, and then check to ensure that exactly one + row has been modified - otherwise rollback will occur. + + +Questions on dumps +------------------ + +Q: What happened to the database dump feature? + +A: You need to configure phpPgAdmin6 (in the config.inc.php file) to point + to the location of the pg_dump and pg_dumpall utilities on your web server. + Once you have done that, the database export feature will appear. + +Q: I would like to use the pg_dump integration for database and table + dumps on Windows. How do I get pg_dump.exe on Windows? + +A: To get the pg_dump utilities on Windows, you need to install Postgres 8.0 + or higher (we recommend the latest release) for Windows, available for + download from the + <a href="http://www.postgresql.org/download/windows">Postgres web site</a>. + Once you have installed that, set the pg_dump and pg_dumpall locations + in the config.inc.php file to + 'C:\\Program Files\\Postgres\\8.0\\bin\\pg_dump.exe' and + 'C:\\Program Files\\Postgres\\8.0\\bin\\pg_dumpall.exe', or wherever you + installed them. + +Q: Why can't I reload the SQL script I dumped in the SQL window? + +A: The following limitations currently exist in SQL script execution: + + * Only uploaded SQL scripts can contain COPY commands and for + this to work, you must have PHP 4.2 or higher. + + * 'psql' commands such as '\connect' will not work at all. + + * Multiline SQL statements will not work, eg: + + CREATE TABLE example ( + a INTEGER + ); + + * You cannot change the current database or current user during + the execution of the script. + + We do intend to work on some of these limitations in the future, but + some of them are Postgres restrictions and we recommend using the + 'psql' utility to restore your full SQL dumps. + + +Other questions +--------------- + +Q: When inserting a row, what does the 'Value' or 'Expression' box mean? + +A: Choosing 'Expression' means that you can use functions, operators, other + field names, etc. in your value - you need to properly quote any literal + values yourself. 'Value' on the other hand, means that no matter what you + enter as the value, it will be inserted as-is into the database. + +Q: Why is there never any information on the 'Info' page of a table? + +A: The Info page will show you what other tables have foreign keys to the + current table and some data from the Postgres statistics collector. + In older versions of Postgres, the stats collector is not enabled by default. + To enable it, look in your postgresql.conf file for the stats_* options. + Just make them all 'true' and restart Postgres. + +Q: Why can't I download data from queries executed in the SQL window? + +A: You need to check the 'Paginate results' option to allow downloads. + +Q: I would like to help out with the development of phpPgAdmin6. How should I + proceed? + +A: We really would like your help! Please read the DEVELOPERS and TRANSLATORS + files. + diff --git a/docs/HISTORY.md b/docs/HISTORY.md new file mode 100644 index 00000000..4347737c --- /dev/null +++ b/docs/HISTORY.md @@ -0,0 +1,849 @@ +phpPgAdmin / phpPgAdmin6 History +------------------ + +July 28 2017 + +The project was 'hard forked' to become an independent repository, phpPgAdmin6 + +v6.0.0-alpha1 +------------- + +Released 27 July 2017 + +The app was fully refactored adding: +* namespaces +* proper (yet arbitrary :sad:) folder hierarchy +* separate files for separate classes +* strips the use of require and include to the bare minimum +* drops support for PHP < 5.4. +* provides full composer compatibility +* PSR-4 autoloading +* makes requirement checks for PHP version and ext-pgsql + +v6.0.0-alpha2 + +* most entrypoints were moved to src/views and do now instance a controller, then call one of its methods depending on the action parameter +* due to this, entrypoint logic was moved into controller classes in src/controllers +* usage of global variables is being replaced by member properties and usage of use where is due. +* usage of global functions is being replaced by anonymous fuctions +* usage of explicit includes/requires is being replaced by composer's autoloader (except for src/lib.inc.php) +* global decorator functions are being replaced by static methods of the Decorator class. + +v6.0.0-beta2 + +* moves HTML printing methods to their own class, which is in turn used by controllers +* this is the last release that will support the "processes" view for Postgres 9.5, b/c pg_stat_activity has changed its structure in PG 9.6. + +Version 5.2 +----------- + +Released: January 2015? + +Features +* Full support for PostgreSQL 9.3 and 9.4 +* Improved Spanish translation support +* Add support for brows/select navigation tabs (firzen) +* Add new theme, "bootstrap" (amenadiel) +* Improved support for json/jsonb + +Bugs +* Fix bug in Turkish translation which caused failed ajax responses +* Account for Blocked field in admin processes Selenium test +* Properly handle column comments + +Incompatabilities +* Dropped testing of 8.4, which is now EOL + + +Version 5.1 +----------- + +Released: 14th April 2013 + +Features +* Full support for PostgreSQL 9.1 and 9.2 +* New plugin architecture, including addition of several new hooks (asleonardo, ioguix) +* Support nested groups of servers (Julien Rouhaud & ioguix) +* Expanded test coverage in Selenium test suite +* Highlight referencing fields on hovering Foriegn Key values when browsing tables (asleonardo) +* Simplified translation system implementation (ioguix) +* Don't show cancel/kill options in process page to non-superusers +* Add download ability from the History window (ioguix) +* User queries now paginate by default + +Bugs +* Fix several bugs with bytea support, including possible data corruption bugs when updating rows that have bytea fields +* Numeruous fixes for running under PHP Strict Standards +* Fix an issue with autocompletion of text based Foreign Keys +* Fix a bug when browsing tables with no unique key + +Translations +* Lithuanian (artvras) + +Incompatabilities +* We have stopped testing against Postgres versions < 8.4, which are EOL +* phpPgAdmin core is now UTF-8 only + + +Version 5.0 +----------- + +Released: 29th November 2010 + +Features +* Support for PostgreSQL 8.4 and 9.0 +* Support for database level collation for 8.4+ +* Support for schema level export +* Add ability to alter schema ownership +* Clean up domain support and improve interface +* Add support for commenting on functions +* Allow user to rename role/users and set new passwords at the same time +* Greatly enhanced Full-Text-Search capabilities (ioguix, Loomis_K) +* Overhauled Selenium Test suite to support multiple database versions +* Optimized application graphics (Limo Driver) +* Support for Column Level Privileges +* Allow users to specify a template database at database creation time +* Support killing processes +* Add ability to create indexes concurrently +* Much better support of autovacuum configuration +* Add an admin page for table level +* Refactored autocompletion: + * fix support for cross-schema objects + * support multi-field FK + * support for pagination of values in the auto-complete list +* Allow user to logicaly group their server under custom named node in the browser tree +* New themes (Cappuccino and Gotar) and a theme switcher on the introduction page +* Auto refresh Locks page +* Auto refresh Processes page +* Link in the bottom of the page to go to top of page +* Browsing on Foreign Keys (When browsing a table, clicking on a FK value, jump to the PK row) + + +Bugs +* Fix problems with query tracking on overly long queries +* Ensure pg_dump paths are valid +* Fix multiple bugs about quoting and escaping database objects names with special chars +* Fix multiple bugs in the browser tree +* Fix multiple bugs on the SQL and script file import form +* Three security fix about code injection +* Don't allow inserting on a table without fields +* Some fix about commenting databases +* removed deprecated functions from PHP 5.3 +* Lot of code cleanup +* Many other small minor bugs found on our way +* Fix the operator property page + +Translations +* Czech (Marek Cernocky) +* Greek (Adamantios Diamantidis) +* Brazillian Portuguese (Fernando Wendt) +* Galician (Adri�n Chaves Fern�ndez) + +Incompatabilities +* No longer support PHP < 5.0 +* No longer support Postgres < 7.4 + + +Version 4.2 +----------- + +Features +* Add Analyze to Table Level Actions (ioguix) +* Add support for multiple actions on main pages (ioguix, Robert Treat) +* Added favicon for Mozilla and a backwards compatible version for IE. +* Allow browsers to save different usernames and passwords for different servers. +* Pagination selection available for reports +* You can configure reports db, schema and table names +* Add support for creating a table using an exsting one (ioguix) +* Auto-expand a node in the tree browser if there are no other nodes (Tomasz Pala) +* Add column about fields constraints type + links in table properties page (ioguix) +* Support for built-in Full Text Search (Ivan Zolotukhin) +* Add alter name, owner & comment on views (ioguix) +* Add column about called procedure + links to their definition in the triggers + properties page (ioguix) +* Add Support for Enum type creation (ioguix,xzilla) +* Add alter name, owner, comment and properties for sequences (ioguix) +* Add function costing options (xzilla) +* Add alter owner & schema on function (xzilla) +* Add a popup window for the session requests history (karl, ioguix) +* Add alter table, view, sequence schema (ioguix) + +Bugs +* Fix inability to assign a field type/domain of a different schema +* Can't edit a report and set its comment to empty +* Fix PHP5 Strict mode complaints +* Fix IN/NOT IN to accept text input lists 'a','b' +* Fix bytea doesn't display as NULL when NULL +* Schema qualifing every object to avoid non wanted behaviour about users' rights + and schema_path +* Remove shared credentials when logging out of single server, to prevent automatic re-login +* Improved SSL connection handling, fix problems with connections from older php builds +* Fix bug with long role name truncation +* Fix bug with DELETE FROM when dropping a row (spq) +* Fix problems when deleteing PUBLIC schema +* Fix several bugs in aggregate support +* Improve autocompletion support +* Tighten up use of global scope variables + +Translations +* utf traditional chinese (Kuo Chaoyi) +* utf simplified chinese (Kuo Chaoyi) +* Italian (Nicola Soranzo) +* Catalan (Bernat Pegueroles) +* French (ioguix) +* German (Albe Laurenz, spq) +* Japanese (Tadashi Jokagi) +* Hungarian (Sulyok Peti) + +Version 4.1.3 +------------- + +Bugs +* Eliminate use of $_SERVER['PHP_SELF']. This fixes a regression in 4.1.2 for + non-mainstream locales (including SQL_ASCII) +* Validate client supplied server against entries in config.inc.php +* Fix undefined variable when altering a field in a table on PostgreSQL < 8.0 + +Version 4.1.2 +------------- + +Bugs +* Fix inability to assign a field type/domain of a different schema +* Fix PHP5 Strict mode complaints +* Fix IN/NOT IN to accept text input lists 'a','b'. +* Fix bytea doesn't display as NULL when NULL +* Fix bug in view creation wizard +* Fix XSS vulnerability: + http://www.securityfocus.com/bid/24115/ + Escape HTML special characters before using $_SERVER['PHP_SELF'] + +Version 4.1.1 +------------- + +Bugs +* Fix problem where failed update would report as duplicate update error and + fail to return edit screen +* Fix error when using $conf[owned_only] on 8.1 & 8.2 +* Fix error displaying schema names for parents of inherited tables +* Clean up non-standard escape warnings for PostgreSQL 8.2 +* Fix improper text quoting for droping roles and aggregates +* Fix bug when dumping mixed case table names in PostgreSQL 8.2 + +Version 4.1 +----------- + +Features +* New icons by Niko <ennixo@free.fr>, from the graphics repository on pgFoundry. +* Added icons to bread crumb trail and tabs. +* Send encrypted passwords over the wire wherever possible. +* Alter sequence, nextval and setval (Guillaume) +* Auto-select 'WITHOUT OIDS' if 'default_with_oids' setting is false (Guillaume) +* Autovacuum configuration support (Robert Treat) +* Basic ROLE support (Chris Kings-Lynne, Javier Carlos) +* Add support for SSL connections (Eric Kinolik) +* Display content of pg_locks view (Javier Carlos) +* Add labels for checkboxes/radio buttons for improved usability (Guillaume) +* Display Prepared Transactions (Javier Carlos) +* Re-enable table browsing from tree icons (ioguix) +* Add Support For IN/OUT Parameters (John Jawed) +* Add column level information into the tree browser (ioguix) +* Promote column level interaction into its own page (ioguix) +* Add automatic lookup of foreign key values in insert/update fields (John Jawed) +* Add ability to create/drop/alter custom aggregates (Javier Carlos) +* Add enable/disable trigger (John Jawed) +* Add global comments for databases and tablespaces + +Translations +* Catalan from Bernat +* Romanian from Alin Vaida + +Version 4.0 +----------- + +Features +* Slony replication support (Thanks to sponsorship from SpikeSource) +* Allow current database to be at the top +* Allow base URL of PostgreSQL documentation to be configured +* Allow variable size textarea when editing values (Juergen Weigert) +* Allow SQL script upload to parse arbitrary SQL, including multiline + SQL statements. Improve output to show every command as its executed + and SELECT results. +* Add rudimentary support for PostgreSQL 8.1 and 8.2 +* primary key and unique key at table creation (Andreas Huber) +* Add row|statement level options to create trigger for >= 7.4 (Robert Treat) +* Allow altering name (for >= 7.4) and owner (for >= 8.0) of a database (Bryan Encina) +* Allow login to several servers simultaneously +* Rearrange frame layout to suit multi-server support +* New browser tree with dynamically loading branches + (Using XLoadTree2 from http://webfx.eae.net/) +* Allow language change from the intro page at any time +* Avoid getting and setting encoding queries if possible +* Avoid version query in PHP 5 / PostgreSQL 7.4+ +* Avoid query for superuser status in PHP 5 / PostgreSQL 7.4+ +* Put PostgreSQL 7.4+ in read only mode for pagination of results + to avoid executing selects that have write side effects. +* Allow re-using username and password for all servers - saves re-entering + username and password for every server in a pool. +* Make default language 'auto' indicating auto detect. If a language is + deliberately specifed, then that will always be used and no detection will + occur. +* ADOdb library updated to version 4.65 + +Bugs +* Tree Icons are displayed middle instead of top +* Ensure login frame is always at top level (Russell Smith) +* Fix non-ASCII characters inserted in Unicode databases as HTML entities with + non-UTF8 web servers (Markus Bertheau) +* Fix export to work with release candidates and beta releases as well as finals + (Russell Smith) +* Fix port selection for local connections +* Fix timeouts on long running operations (Adrian Nida) +* Allow Multiline character and character varying editing and inserting +* Add automatic browser language selection for all languages +* Stop duplicate insert on re-POST of data +* Fix bug with exporting schema for servers < 7.3 +* Fix opclasses on 7.2 and below +* Fix listing of opaque functions in 7.2 +* Actually fix PHP 4.4.0's new strict references + +Translations +* Japanese from Tadashi Jokagi +* Danish from Arne Eckmann +* Arabic from Zaki +* Romanian from Alin +* Afrikaans from Petri +* Polish from Rafal (utf-8 encoding) +* Slovak from Andrej +* German from Markus +* Spanish From Martin +* Hungarian from Sulyok +* Turkish from Devrim + +Version 3.5.6 +------------- + +Bugs +* Actually fix PHP 4.4.0's new strict references + +Version 3.5.5 +------------- + +Bugs +* Fix for PHP 4.4.0's new strict references +* Small improvement to Opera browser detection in the tree +* Fix listing of opaque functions in 7.2 +* Fix listing of opclasses and functions pre 7.3 + +Version 3.5.4 +------------- + +Bugs +* Fix security hole in include() of language file: + http://secunia.com/advisories/15941/ + Check now requires that the language filename be in the list + of known allowed filenames. +* Fix that functions returning cstring were not being listed +* Make parsing of PostgreSQL 1-dimensional arrays correct. Makes + named function parameter use more reliable. +* Fix downloading of the results of multiline queries. + +Version 3.5.3 +------------- + +Bugs +* Fix using schema enabled dump on non-schema enabled backend +* Don't try setting no timeout when in safe mode +* Reload browser after executing arbitrary SQL +* Fix browser in RTL languages +* Fix inability to drop database using the drop link +* Fix last internal oid value for PostgreSQL 8.0 +* Fix (again) dumping on v8 for windows, exclude dumping some objects. + +Translations +* Portuguese from Francisco + +Version 3.5.2 +------------- + +Bugs +* Fix export to work with release candidates and beta releases as well as finals + (Russell Smith) +* Fix port selection for local connections (Russell Smith) +* Fix timeouts on long running operations (Adrian Nida) +* Allow Multiline character and character varying editing and inserting +* Do browser language detection for all languages + +Translations +* Japanese from Tadashi +* Danish from Arne + +Version 3.5.1 +------------- + +Bugs +* Support 8.0beta5 schema tablespace changes +* Help link fixes +* Estimated row count in 7.0 and 7.1 fixes +* Priviliges nav fix +* Function privileges fix +* Search path fix +* pg_dump on win32 8.0 native fix + +Translations +* Romanian from Alin +* Italian updates from Nicola + +Version 3.5 +----------- + +Features +* Context-sensitive online help system +* Use language preferencies from browser (Markus Bertheau, Nicola Soranzo) +* Tablespace support for 8.0 +* Support cancelling backend processes in 8.0 +* Allow setting privileges on databases +* Allow setting schema search path in SQL window +* Allow filtering find results by object type +* Show function arguments in find results +* Support 8.0's named function arguments +* "Sticky" navigation. phpPgAdmin will now remember while tab you are + looking at (eg. 'Indexes') when you change which table you are viewing. +* New fast navigation bar. A breadcrumb style navigation bar for fast + jumping between areas. +* Much improved grant/revoke feature +* Allow creating and viewing composite types +* pg_dumpall integration. Now you can download the entire cluster via + phpPgAdmin. +* Show line numbers when viewing functions +* Syntax highlighting for PL/SQL, PL/PgSQL, PL/PHP, PL/Ruby, PL/Java, + PL/J, PL/Python and PL/Perl functions, thanks to Jacob D. Cohen's + BSD-licensed highlighting code on rafb.net +* Add page navigation links at the bottom as well as the top of the page + when browsing results. +* Support for 8.0's alter column type +* Support for 8.0's add columns with defaults and not null + +Translations +* Romanian from Alin +* Arabic from Zaki +* Japanese from Tadashi +* Spanish from Robert & Martin +* Mongolian from Erdenemandal +* Ukrainian from Alex Rootoff +* Hebrew from jonatan +* Hungarian from Sulyok +* French from Pascal +* Afrikaans from Petri +* Turkish from Devrim +* Slovak from Andrej +* German from Markus +* Italian from Nicola +* Polish from Rafal + +Bugs +* Fix that non-Auto mode import didn't work (Adrian Nida) +* Fix inability to drop constraints when using a non-english translation +* Work around MSIE's failure to handle downloads in SSL mode +* Allow insert, update, delete, references and trigger to be granted + and revoked on views. + +Version 3.4.1 +------------- + +Bugs +* Fix export of mixed case tables pre 7.4 +* Fix table export problems pre 7.3 +* Fix join clause created by view wizard for pre 7.3 +* Fix reindex of mixed case indexes +* Show domains in type lists in appropriate places +* Fix for multiline CDATA parsing in XML import +* Fix missing _schema notice in reports + +Version 3.4 +----------- + +Features +* Add CACHE and CYCLE parameters in sequence creation +* View, add, edit and delete comments on tables, views, schemas, + aggregates, conversions, operators, functions, types, + opclasses, sequences and columns (Dan Boren & ChrisKL) +* Add config file option for turning off the display of comments +* Allow creating array columns in tables +* Allow adding array columns to tables +* Allow creating domains with type length and arrays +* Show domain base type and comment in domains list +* Allow import of CSV, Tabbed and XML data. "Auto" mode chooses + import mode based on the file extension. +* Allow upload and execution of _basic_ SQL scripts +* More admin features available: vacuum, analyze, cluster all and reindex + (with all options) (Bryan Encina) +* Fix SQL popup window to reload when the database is changed so + that the correct page encoding is used. +* Create view wizard (Bryan Encina) +* Allow specification of MATCH, DEFERRABLE and INITIALLY DEFERRED on + foreign keys. +* Automatically uncheck the NULL checkbox when data is typed in the value + field while editing data. +* Show query runtime when executing arbitrary SQL +* Allow renaming functions when backend supports it +* Views are now more like tables. They are listed in the browser, + you can view the virtual columns of the view and its column defaults. + Columns in view can also be renamed and have defaults set. +* Allow viewing, dropping and creation of rules on views. +* Support for 8.0-dev ALTER COLUMN TYPE, adding of SERIAL and BIGSERIAL + columns, adding NOT NULL columns and adding columns with defaults. + +Bugs +* Fix pg_dump output for PostgreSQL 7.0.x and 7.1.x +* In 7.4 pg_dump, specify schema when dumping tables +* Fix bug in displaying array types in 7.0.x +* Fix bug where views appeared as tables in 7.0.x search results +* Fix bug where find object SQL on < 7.2 was broken +* Fix Find for domain constraints +* Fix popup SQL window so that two different phpPgAdmin instances should + not want to use the same pop-up. +* Fix create table if you don't supply as many fields as you originally + specified. +* Fix schema support for views + +Translations +* Trad. Chinese from Chih-Hsin Lee +* Italian from Nicola +* Spanish from Martin +* Slovak from Andrej +* German from Markus +* Turkish from Devrim +* Hungarian from Sulyok +* French from Pascal +* Polish from Rafal +* Russian from Alex + +Version 3.3.1 +------------- + +Bugs +* Fix table stats for <= 7.2 + +Translations +* Spanish from Martin + +Version 3.3 +----------- + +Features +* Database dump feature, which uses pg_dump +* Large speed improvements by reducing number of database + connections and using external style sheet. +* SQL pop-up window now defaults to the current database +* Display aggregates and operator classes +* Integration with the PostgreSQL statistics collector. See + table and index performance and usage information. +* Display user session defaults for PostgreSQL >= 7.3 +* Rename user feature for PostgreSQL >= 7.4 +* Create functions returning arrays and table types +* Allow editing Select results by oid +* Allow pagination of queries entered in the SQL box +* Allow EXPLAIN ANALYZE of SQL queries (in both SQL boxes) +* Default cursor conveniently in SQL box and Find + +Bugs +* Object browser fixed for databases with no schemas +* Properly detect that reports database is missing +* Fix for alter column on PostgreSQL 7.1 +* phpPgAdmin now works without '.' in the include_path +* Can now remove expire dates on user accounts +* Properties of mixed case named views work in 7.4 + +Translations +* Spanish from Martin Marques +* Japanese from Tadashi Jokagi +* Swedish from Stefan Malmqvist +* Slovak from Andrej Misovik +* Hungarian from Sulyok Peter +* Trad. Chinese from Chih-Hsin Lee +* Italian from Nicola Soranzo +* Afrikaans from Petri Jooste +* Turkish from Devrim Gunduz +* German from Markus Bertheau +* Czech from Libor Vanek +* Russian from Alex Khodorivsky + +Version 3.2.1 +------------- + +Bugs +* Trailing newline problem in chinese-sim translation fixed + +Translations +* French from Pascal +* Russian from Step + +Version 3.2 +----------- + +Features +* PostgreSQL 8.0 CVS support +* Option to dump table structure, data or structure and data +* Set datestyle and extra_float_digits when dumping data +* Results of table browse, table select, view browsing and report browsing + can now ALL be sorted by column +* Result rows of table selects can now be edited and deleted +* Extra login security to prevent logging into servers as postgres and + no password - a VERY common newbie error. +* Cluster indexes and indexed constraints (with analyze) +* Display clustered status of indexes and indexed constraints +* Table info - shows tables that reference the table, parent tables, + and child tables. +* Choice of operator when performing a Select +* 'Select All' feature of table selects now available on view + selects. +* Removed any trace of MySQL support +* Show casts +* Show conversions +* Show languages +* Make table icon link to browse table +* New show_advanced option that allows the hiding or display of + "advanced" objects such as conversions, types, operators, casts and + languages. +* Find Object feature can now find conversions, languages, domains, + constraints, indexes, rules and triggers. +* Better language Makefile for translators +* The SQL box now remembers your query when you click 'Back'. + +Bugs +* Added legal DOCTYPE +* Allow creating foreign keys to tables not in current schema +* Always add brackets around CHECK () constraints +* Never display an index in both Indexes and Constraints +* BIGSERIAL missing from PostgreSQL 7.2 +* Types lengths (eg. varchar(255)) weren't being displayed properly + in PostgreSQL 7.0.x +* Resetting sequence on 7.1+ now restarts at 1, not 2 +* Remove deprecated column default 'now' from SQL script +* Properly escape pg_ in internal queries + +Translations +* Afrikaans from Petri Jooste +* Hungarian from Sulyok P�ter +* German update from Markus Bertheau +* Trad. Chinese from Chih-Hsin Lee +* Hungarian from Peti +* Spanish update from Martin Marques +* Slovak update from Andrej Misovic +* Turkish update from Devrim +* Swedish update from Stefan +* Italian update from Nicola + +Version 3.1 +----------- + +Bug Fixes: +* Table browsing for 7.4 fixed +* Synch script for translators disabled due to bugginess. If you want + to use it, just comment out the warning lines from the script itself. +* Change HTML download to XHTML and make it a 100% conforming document, with DTD +* Alter XML format to allow future features + +Translations: +* Trad. Chinese +* Dutch +* Spanish +* Swedish +* Turkish +* French +* Japanese + +Version 3.1-rc-1 +---------------- + +Bug Fixes +* Table browsing for != 7.3 +* SQL window improvements +* Translation improvements + +Version 3.1-beta-1 +------------------ + +Features: +* Add first & last links to nav. Double number of pages shown. +* Allow granting privileges WITH GRANT OPTION for 7.4 +* Allow revoking GRANT OPTION with CASCADE option for 7.4 +* Display new PostgreSQL 7.4 grant options and grantor in privileges +* Find object feature +* Support for domains in 7.3 and domain constraints and alter domain in 7.4 +* Add/drop users to/from groups +* Alter (rename) triggers +* Pop-up SQL window from Mark Gibson +* Superusers can always see all databases +* Default database encoding for languages +* Convert our images to PNG format +* Allow creating tables WITHOUT OIDS +* Show boolean values as TRUE or FALSE when viewing data +* Allow renaming table and changing table owner +* Refresh feature on table browse +* Support better formatted view dumps in 7.4 +* When browsing data, numeric types are aligned right +* Ability to create unique and partial indexes +* View and edit table comments +* Changed XML format significantly. Now doesn't use field names as + tag names, outputs column type information, and is in correct XML format! +* Save result sets as views and reports in most cases +* Download the results of selects and reports +* Tick all box on Select feature +* Export in HTML format +* Allow listing of operators +* Add a robots.txt file to prevent search engine indexation +* Can now safely edit row based on OID. Guards are in place against duplicate OIDs. +* Works properly if you have cookies disabled + +Bug Fixes: +* Lots of NULL value in table dump fixes (XML format changed slightly) +* Boolean default values and general boolean field handling fixes +* Support zero column tables +* Correctly display the contents of bytea fields +* Consider information_schema to be a system object +* Remember fields if index creation fails +* Fix saving and loading function volatility +* Don't list domains under types +* Lots of reports fixes (titles, page reloads, etc.) +* Selecting for NULL values in Select feature + +Translations: +* Italian translation update from Nicola Soranzo +* German update from Markus Bertheau +* Spanish update from Martin Marques +* Trad. Chinese update from Chih-Hsin Lee +* Russian update from Step +* Slovak update from Andrej +* Polish update from Rafal +* Swedish translation from Stefan Malqvist +* Turkish update from Devrim Gunduz +* German update from Markus Bertheau +* Traditional Chinese update from Chih-Hsin Lee +* Spanish update from Martin + +Version 3.0.1 +------------- + +Bug Fixes +* Lots of NULL value in table dump fixes (XML format changed slightly) +* Support zero column tables +* Correctly display the contents of bytea fields +* Error in ADODB_base.php +* Fix saving and loading function volatility +* Don't list domains under types + +Version 3.0 +----------- + +* German update from Markus Bertheau +* Russian update from Alexander Khodorivsky + +Version 3.0-rc-2 +---------------- + +* Slovak update from Andrej Misovic +* Japanese update from Tadashi Jokagi +* Added 'defaultdb' per-connection variable + for installations where connection to template1 + is disabled. +* Removed uses of call time pass by reference, + since it is a deprecated feature of PHP. + +Version 3.0-rc-1 +---------------- + +* Fix drop database reload browser bug +* Look & Feel upgrade from Davey +* Value & expression on edit row +* Chinese update from Chih-Hsin Lee +* Fixed support for functions and sequences + containing bizarre characters + +Version 3.0-beta-1 +------------------- + +* Cascade drop on columns and constraints +* Czech translation +* Preserve spaces when displaying data +* Greatly improved PostgreSQL 7.2, 7.1 and 7.0 support +* Italian translation +* Show database version in top bar +* Many features useful for PostgreSQL hosting: + - Hide reports + - Filter for owned reports + - Hide admin for non-super users + - Easy for a user to change their own password + - Enforceable minimum password length +* Switched to PEAR's HTML_TreeMenu to avoid license issue +* Function editor can handle setof functions, and all + function properties for volatility, etc. +* Manage permissions on functions +* Massive table browsing improvements: + - Sort ascending and descending by clicking + on field name + - Trim long strings. Use 'expand' and 'collapse' to + see full strings or trimmed strings. +* Revoke on objects. Grant or revoke to multiple groups + and users at once. +* Brazilian Portuguese translation from Angelo Rigo + +Version 3.0.0-dev-4 +------------------- + +* Sort on a column when browsing a table +* Slovak translation +* Turkish translation +* German translation +* Reload browser after create/drop of database, schemas and tables +* Select on views +* Add foreign key constraint, with actions +* Cascade drop on all objects + +Version 3.0.0-dev-3 +------------------- + +* French translation +* Russian translations +* Japanese translations +* Trigger definitions +* ADODB upgrade +* Allow editing of non-null unique + +Version 3.0.0-dev-2 +------------------- + +* Language files now use an array of strings +* Almost complete Chinese translation +* Create sequence +* Create trigger +* Create index +* Add check constraint +* Lots of small fixes +* Add column + +Version 3.0.0-dev-1 +------------------- + +* Renamed to phpPgAdmin from WebDB +* Heaps of other stuff + +Version 0.6 - 24-Dec-2002 +------------------------- + +* Support short_tags off +* Fix browsing tables, pagination, etc. +* Fix all error handling +* Fix problems with apostrophes in database, usernames or passwords + +Version 0.5 - 20-Dec-2002 +------------------------- + +* Initial public release +* Still many problems making it unsuitable for production. + +Version 0.1 - Early 2002 +------------------------ + +* Initial development version + diff --git a/docs/INSTALL.md b/docs/INSTALL.md new file mode 100644 index 00000000..7cf283cf --- /dev/null +++ b/docs/INSTALL.md @@ -0,0 +1,73 @@ +phpPgAdmin6 Installation Guide +----------------------------- + +1. Unpack your download + + If you've downloaded a tar.gz package, execute from a terminal: + + gunzip phpPgAdmin6-*.tar.gz + tar -xvf phpPgAdmin6-*.tar + + Else, if you've downloaded a tar.bz2 package, execute from a terminal: + + bunzip2 phpPgAdmin6-*.tar.bz2 + tar -xvf phpPgAdmin6-*.tar + + Else, if you've downloaded a zip package, execute from a terminal: + + unzip phpPgAdmin6-*.zip + +2. Configure phpPgAdmin6 + + edit phpPgAdmin6/conf/config.inc.php + + If you mess up the configuration file, you can recover it from the + config.inc.php-dist file. + +3. If you run your PHP installation in safe mode, in order that the database + dump feature can work correctly, you need to set the 'safe_mode_allowed_env_vars' + php.ini variable to include the PGPASSWORD and PGUSER environmental variables + and the safe_mode_exec_dir to include /usr/bin (or wherever the pg_dump + binaries are found). + + eg. safe_mode_allowed_env_vars = PHP_,PG + safe_mode_exec_dir = /usr/bin + + Given that you usually don't want to allow everything in /usr/bin to + be executed, you might want to copy the pg_dump and pg_dumpall utilities + to a directory by themselves. + + Also, you will need to ensure that your 'pg_dump' and 'pg_dumpall' utilities + are executable by the PHP process, if you want dump support in phpPgAdmin6. + + Lastly, if you run phpPgAdmin6 in safe mode, very long running imports, + exports and transactions may time out and be aborted. + +4. Ensure the statistics collector is enabled in PostgreSQL. phpPgAdmin6 will + display table, index performance, and usage statistics if you have enabled + the PostgreSQL statistics collector. While this is normally enabled by + default, to ensure it is running, make sure the following lines in your + postgresql.conf are uncommented: + + track_activities + track_counts + +5. Browse to the phpPgAdmin6 installation using a web browser. You might + need cookies enabled for phpPgAdmin6 to work. + +6. IMPORTANT - SECURITY + + PostgreSQL by default does not require you to use a password to log in. + We STRONGLY recommend that you enable md5 passwords for local connections + in your pg_hba.conf, and set a password for the default superuser account. + + Due to the large number of phpPgAdmin6 installations that have not set + passwords on local connections, there is now a configuration file + option called 'extra_login_security', which is TRUE by default. While + this option is enabled, you will be unable to log in to phpPgAdmin6 as + the 'root', 'administrator', 'pgsql' or 'postgres' users and empty passwords + will not work. + + Once you are certain you have properly secured your database server, you + can then disable 'extra_login_security' so that you can log in as your + database administrator using the administrator password. diff --git a/docs/TODO.md b/docs/TODO.md new file mode 100644 index 00000000..54d9b53f --- /dev/null +++ b/docs/TODO.md @@ -0,0 +1,7 @@ +PHPPGADMIN TODO LIST FOR DEVELOPERS +----------------------------------- + +Please see: + +https://github.com/HuasoFoundries/phpPgAdmin6/issues + diff --git a/docs/TRANSLATORS.md b/docs/TRANSLATORS.md new file mode 100644 index 00000000..8571ada8 --- /dev/null +++ b/docs/TRANSLATORS.md @@ -0,0 +1,55 @@ +Translator Info +--------------- + +If you like phpPgAdmin6, then why not translate it into your native language? + +There are quite a large number of strings to be translated. Partial +translations are better than no translations at all, and a rough guide is that +the strings are in the order from most important to least important in the +language file. You can ask the developers list if you don't know what a +certain string means. + +We tried keeping translation easy in phpPgAdmin6 by using ONLY the UTF-8 charset. +Make sure to always work on UTF-8 files when creating a new translation or +editing an existing one. + +To Create a new translation: + +1. Go to the lang/ subdirectory + +2. Copy english.php to yourlanguage.php + +3. Update the comment at the top of the file. Put yourself as the language + maintainer. Edit the 'applang' variable and put your language's name in it, + in your language. + Edit the 'applocale' and put your language code according to the standart: + http://www.ietf.org/rfc/rfc1766.txt + + Basicaly, you just need to put your language code [1] and optionnaly country + code [2] separated by a '-'. As instance for french canadian, it is: fr-CA + [1]: http://www.w3.org/WAI/ER/IG/ert/iso639.htm + [2]: http://www.iso.org/iso/country_codes/iso_3166_code_lists/country_names_and_code_elements.htm + +4. Go through as much of the rest of the file as you wish, replacing the + English strings with strings in your native language. + +At this point, you can send the yourlanguage.php file to us and we will take +care of testing and recoding the translation. Please only do that if you +find the rest of these steps too difficult. + +5. To add your language to phpPgAdmin6, edit the lang/translations.php file + and add your language to the $appLangFiles array. + Also, add your language to the $availableLanguages array for + browser auto detection. + +6. Send your contribution to us. We need the lang/translations.php entry as + well as the lang/yourlanguage.php file. Email to the developers list: + phpPgAdmin6-devel@lists.sourceforge.net + +7. There exists a tool named 'langcheck' in the lang/ directory. To run it, + just type 'php langcheck <language>'. It will give you a report about + which strings are missing from your language file and which need to be + deleted. + +Thank you for your contribution! You have just made phpPgAdmin6 accessible +to thousands more users! |