From 82aa8035c2b058b4574cba3950670ff835525351 Mon Sep 17 00:00:00 2001 From: Dave Page Date: Fri, 12 Jan 2018 13:37:59 +0000 Subject: [PATCH] Refer users who want to build themselves from scratch to the README. --- docs/en_US/desktop_deployment.rst | 25 +++++++++------ docs/en_US/getting_started.rst | 52 +++++++++++++++++++++++++------ docs/en_US/server_deployment.rst | 9 +++++- 3 files changed, 66 insertions(+), 20 deletions(-) diff --git a/docs/en_US/desktop_deployment.rst b/docs/en_US/desktop_deployment.rst index 036450f81..49aafe0c4 100644 --- a/docs/en_US/desktop_deployment.rst +++ b/docs/en_US/desktop_deployment.rst @@ -8,10 +8,17 @@ pgAdmin may be deployed as a desktop application by configuring the application to run in desktop mode and then utilising the desktop runtime to host and display the program on a supported Windows, Mac OS X or Linux installation. -**Note: Pre-compiled and configured installation packages are available for -a number of platforms. These packages should be used by end-users whereever -possible - the following information is useful for the maintainers of those -packages and users interested in understanding how pgAdmin works.** +.. note:: Pre-compiled and configured installation packages are available for + a number of platforms. These packages should be used by end-users whereever + possible - the following information is useful for the maintainers of those + packages and users interested in understanding how pgAdmin works. + +.. seealso:: For detailed instructions on building and configuring pgAdmin from + scratch, please see the README file in the top level directory of the source code. + For convenience, you can find the latest version of the file + `here `_, + but be aware that this may differ from the version included with the source code + for a specific version of pgAdmin. Configuration ************* @@ -36,10 +43,10 @@ are as follows: for end users to change any default or packaging specific settings that they may wish to adjust to meet local preferences or standards. -NOTE: If the SERVER_MODE setting is changed in ``config_distro.py`` or ``config_local.py``, -you will most likely need to re-set the LOG_FILE, SQLITE_PATH, SESSION_DB_PATH -and STORAGE_DIR values as well as they will have been set based on the default -configuration or overridden by the runtime. +.. note:: If the SERVER_MODE setting is changed in ``config_distro.py`` or ``config_local.py``, + you will most likely need to re-set the LOG_FILE, SQLITE_PATH, SESSION_DB_PATH + and STORAGE_DIR values as well as they will have been set based on the default + configuration or overridden by the runtime. Runtime ------- @@ -75,4 +82,4 @@ The configuration settings: | Browser/WindowState | Binary | The runtime window's state | +--------------------------+--------------------+---------------------------------------------------------------+ | Browser/Zoom | String | The runtime window's zoom level (zoom % / 100) | -+--------------------------+--------------------+---------------------------------------------------------------+ \ No newline at end of file ++--------------------------+--------------------+---------------------------------------------------------------+ diff --git a/docs/en_US/getting_started.rst b/docs/en_US/getting_started.rst index 52c3dacc0..7f1b17bad 100644 --- a/docs/en_US/getting_started.rst +++ b/docs/en_US/getting_started.rst @@ -4,10 +4,19 @@ Getting Started *************** -Pre-compiled and configured installation packages for pgAdmin 4 are available for a number of desktop environments; we recommend using an installer whenever possible. A standard installation using the pgAdmin installer is a server deployment. +Pre-compiled and configured installation packages for pgAdmin 4 are available +for a number of desktop environments; we recommend using an installer +whenever possible. -In a Server Deployment, the pgAdmin application is deployed behind a webserver or with the WSGI interface. -If you install pgAdmin in server mode, you will be prompted to provide a role name and pgAdmin password when you initially connect to pgAdmin. The first role registered with pgAdmin will be an administrative user; the administrative role can use the pgAdmin *User Management* dialog to create and manage additional pgAdmin user accounts. When a user authenticates with pgAdmin, the pgAdmin tree control displays the server definitions associated with that login role. +In a Server Deployment, the pgAdmin application is deployed behind a webserver +or with the WSGI interface. +If you install pgAdmin in server mode, you will be prompted to provide a role +name and pgAdmin password when you initially connect to pgAdmin. The first +role registered with pgAdmin will be an administrative user; the +administrative role can use the pgAdmin *User Management* dialog to create +and manage additional pgAdmin user accounts. When a user authenticates +with pgAdmin, the pgAdmin tree control displays the server definitions +associated with that login role. Contents: @@ -18,7 +27,12 @@ Contents: pgadmin_user change_user_password -In a Desktop Deployment, the pgAdmin application is configured to use the desktop runtime environment to host and display the program on a supported platform. Typically, users will install a pre-built package to run pgAdmin in desktop mode, but a manual desktop deployment can be installed and though it is more difficult to setup, it may be useful for developers interested in understanding how pgAdmin works. +In a Desktop Deployment, the pgAdmin application is configured to use the +desktop runtime environment to host and display the program on a supported +platform. Typically, users will install a pre-built package to run pgAdmin +in desktop mode, but a manual desktop deployment can be installed and though +it is more difficult to setup, it may be useful for developers interested +in understanding how pgAdmin works. Contents: @@ -27,15 +41,32 @@ Contents: desktop_deployment -The pgAdmin 4 client features a highly-customizable display that features drag-and-drop panels that you can arrange to make the best use of your desktop environment. +.. note:: Pre-compiled and configured installation packages are available for + a number of platforms. These packages should be used by end-users whereever + possible - the following information is useful for the maintainers of those + packages and users interested in understanding how pgAdmin works. -The tree control provides an elegant overview of the managed servers, and the objects that reside on each server. Right-click on a node within the tree control to access context-sensitive menus that provide quick access to management tasks for the selected object. +The pgAdmin 4 client features a highly-customizable display that features +drag-and-drop panels that you can arrange to make the best use of your desktop +environment. -The tabbed browser provide quick access to statistical information about each object in the tree control, and pgAdmin tools and utilities (such as the Query tool and the debugger). pgAdmin opens additional feature tabs each time you access the extended functionality offered by pgAdmin tools; you can open, close, and re-arrange feature tabs as needed. +The tree control provides an elegant overview of the managed servers, and the +objects that reside on each server. Right-click on a node within the tree control +to access context-sensitive menus that provide quick access to management tasks +for the selected object. -Use the *Preferences* dialog to customize the content and colors of the pgAdmin display. To open the *Preferences* dialog, select *Preferences* from the *File* menu. +The tabbed browser provide quick access to statistical information about each +object in the tree control, and pgAdmin tools and utilities (such as the Query +tool and the debugger). pgAdmin opens additional feature tabs each time you +access the extended functionality offered by pgAdmin tools; you can open, close, +and re-arrange feature tabs as needed. -*Help* buttons in the lower-left corner of each dialog will open the online help for the dialog. You can access additional Postgres help by navigating through the *Help* menu, and selecting the name of the resource that you wish to open. +Use the *Preferences* dialog to customize the content and colors of the pgAdmin +display. To open the *Preferences* dialog, select *Preferences* from the *File* menu. + +*Help* buttons in the lower-left corner of each dialog will open the online help +for the dialog. You can access additional Postgres help by navigating through +the *Help* menu, and selecting the name of the resource that you wish to open. Contents: @@ -48,7 +79,8 @@ Contents: preferences keyboard_shortcuts -Before using pgAdmin to manage objects that reside on a server, you must define a connection to the server; for more information please see *Connecting to a Server*: +Before using pgAdmin to manage objects that reside on a server, you must define a +connection to the server; for more information please see *Connecting to a Server*: Contents: diff --git a/docs/en_US/server_deployment.rst b/docs/en_US/server_deployment.rst index eb7bd3841..b256ed0ec 100644 --- a/docs/en_US/server_deployment.rst +++ b/docs/en_US/server_deployment.rst @@ -11,6 +11,13 @@ proxy, or using the WSGI interface. The following instructions demonstrate how pgAdmin may be run as a WSGI application under ``Apache HTTP``, using ``mod_wsgi``. +.. seealso:: For detailed instructions on building and configuring pgAdmin from + scratch, please see the README file in the top level directory of the source code. + For convenience, you can find the latest version of the file + `here `_, + but be aware that this may differ from the version included with the source code + for a specific version of pgAdmin. + Requirements ************ @@ -166,4 +173,4 @@ with: Require all granted -Adjust as needed to suit your access control requirements. \ No newline at end of file +Adjust as needed to suit your access control requirements.