diff --git a/docs/source/pgservice.rst b/docs/source/pgservice.rst new file mode 100644 index 0000000..60f7382 --- /dev/null +++ b/docs/source/pgservice.rst @@ -0,0 +1,50 @@ +************************* +The pg_service.conf File +************************* + +Throughout the documentation, we reference pg_service.conf files. If you are not already familiar with the pg_service.conf file, be sure to read below. + + +.. contents:: Table of Contents + + +About the pg_service.conf File +==================================== + +The pg_service.conf file is used to connect your QGIS project to a PostGIS database using only a Service Name. + +It is important to use a pg_service.conf file rather than storing/saving your password inside of your QGIS Project file. + + +Contents of the pg_service.conf File +=================================== + +The form of the pg_service.conf file is like below. The Service Name is in brackets ([beeedatabse] below) + +The pg_service.conf file can have multiple entries. + +.. code-block:: console + + [beedatabase] + host=localhost + port=5432 + dbname=beedatabase + user=admin1 + password=DfBJdQTtQv + +When you add a Data Source in your control panel, it automatically adds an entry to the pg_service.conf file located at: + +.. code-block:: console + + /var/www/data/qgis + +The same pg_service.conf entry is used on your local computer, but with the hostname pointed at your server. For example: + +.. code-block:: console + + [beedatabase] + host=myserver.com + port=5432 + dbname=beedatabase + user=admin1 + password=DfBJdQTtQv \ No newline at end of file